0.01.00
misc.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, 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 
35 #ifndef OT_PLATFORM_MISC_H
36 #define OT_PLATFORM_MISC_H 1
37 
38 #include <stdint.h>
39 
40 #include <openthread/types.h>
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
62 void otPlatReset(otInstance *aInstance);
63 
70 typedef enum
71 {
72  OT_PLAT_RESET_REASON_POWER_ON = 0,
73  OT_PLAT_RESET_REASON_EXTERNAL = 1,
74  OT_PLAT_RESET_REASON_SOFTWARE = 2,
75  OT_PLAT_RESET_REASON_FAULT = 3,
76  OT_PLAT_RESET_REASON_CRASH = 4,
77  OT_PLAT_RESET_REASON_ASSERT = 5,
78  OT_PLAT_RESET_REASON_OTHER = 6,
79  OT_PLAT_RESET_REASON_UNKNOWN = 7,
80  OT_PLAT_RESET_REASON_WATCHDOG = 8,
81 
82  OT_PLAT_RESET_REASON_COUNT,
84 
91 otPlatResetReason otPlatGetResetReason(otInstance *aInstance);
92 
100 void otPlatAssertFail(const char *aFilename, int aLineNumber);
101 
107 void otPlatWakeHost(void);
108 
114 #ifdef __cplusplus
115 } // extern "C"
116 #endif
117 
118 #endif // OT_PLATFORM_MISC_H
void otPlatAssertFail(const char *aFilename, int aLineNumber)
This function provides a platform specific implementation for assert.
This type represents all the static / global variables used by OpenThread allocated in one place...
Definition: openthread-instance.h:59
This file defines the types and structures used in the OpenThread library API.
void otPlatReset(otInstance *aInstance)
This function performs a software reset on the platform, if supported.
void otPlatWakeHost(void)
This function performs a platform specific operation to wake the host MCU.
otPlatResetReason
Enumeration of possible reset reason codes.
Definition: misc.h:70
otPlatResetReason otPlatGetResetReason(otInstance *aInstance)
This function returns the reason for the last platform reset.