• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2022, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *   This file includes the definitions of the radio spinel metrics.
33  */
34 
35 #ifndef RADIO_SPINEL_METRICS_H_
36 #define RADIO_SPINEL_METRICS_H_
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /**
43  * Represents the radio spinel metrics.
44  */
45 typedef struct otRadioSpinelMetrics
46 {
47     uint32_t mRcpTimeoutCount;         ///< The number of RCP timeouts.
48     uint32_t mRcpUnexpectedResetCount; ///< The number of RCP unexpected resets.
49     uint32_t mRcpRestorationCount;     ///< The number of RCP restorations.
50     uint32_t mSpinelParseErrorCount;   ///< The number of spinel frame parse errors.
51 } otRadioSpinelMetrics;
52 
53 /**
54  * Represents RCP interface metrics.
55  */
56 typedef struct otRcpInterfaceMetrics
57 {
58     uint8_t  mRcpInterfaceType;             ///< The RCP interface type.
59     uint64_t mTransferredFrameCount;        ///< The number of transferred frames.
60     uint64_t mTransferredValidFrameCount;   ///< The number of transferred valid frames.
61     uint64_t mTransferredGarbageFrameCount; ///< The number of transferred garbage frames.
62     uint64_t mRxFrameCount;                 ///< The number of received frames.
63     uint64_t mRxFrameByteCount;             ///< The number of received bytes.
64     uint64_t mTxFrameCount;                 ///< The number of transmitted frames.
65     uint64_t mTxFrameByteCount;             ///< The number of transmitted bytes.
66 } otRcpInterfaceMetrics;
67 
68 #ifdef __cplusplus
69 } // end of extern "C"
70 #endif
71 
72 #endif // RADIO_SPINEL_METRICS_H_
73