1 /*
2  *  Copyright (c) 2023, 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 OpenThread API for radio stats module.
33  */
34 
35 #ifndef OPENTHREAD_RADIO_STATS_H_
36 #define OPENTHREAD_RADIO_STATS_H_
37 
38 #include <stdint.h>
39 
40 #include <openthread/error.h>
41 #include <openthread/instance.h>
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /**
48  * @addtogroup api-radio
49  *
50  * @brief
51  *   This module includes functions for radio statistics.
52  *
53  * @{
54  *
55  */
56 
57 /**
58  * Contains the statistics of radio.
59  *
60  */
61 typedef struct otRadioTimeStats
62 {
63     uint64_t mDisabledTime; ///< The total time that radio is in disabled state, in unit of microseconds.
64     uint64_t mSleepTime;    ///< The total time that radio is in sleep state, in unit of microseconds.
65     uint64_t mTxTime;       ///> The total time that radio is doing transmission, in unit of microseconds.
66     uint64_t mRxTime;       ///> The total time that radio is in receive state, in unit of microseconds.
67 } otRadioTimeStats;
68 
69 /**
70  * Gets the radio statistics.
71  *
72  * The radio statistics include the time when the radio is in TX/RX/Sleep state. These times are in units of
73  * microseconds. All times are calculated from the last reset of radio statistics.
74  *
75  * @param[in]  aInstance    A pointer to an OpenThread instance.
76  *
77  * @returns  A const pointer to the otRadioTimeStats struct that contains the data.
78  *
79  */
80 const otRadioTimeStats *otRadioTimeStatsGet(otInstance *aInstance);
81 
82 /**
83  * Resets the radio statistics.
84  *
85  * All times are reset to 0.
86  *
87  * @param[in]  aInstance    A pointer to an OpenThread instance.
88  *
89  *
90  */
91 void otRadioTimeStatsReset(otInstance *aInstance);
92 
93 /**
94  * @}
95  *
96  */
97 
98 #ifdef __cplusplus
99 } // extern "C"
100 #endif
101 
102 #endif // OPENTHREAD_RADIO_STATS_H_
103