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 29 /** 30 * @file 31 * @brief 32 * This file defines the platform-specific functions needed by OpenThread's example applications. 33 */ 34 35 #ifndef OPENTHREAD_SYSTEM_H_ 36 #define OPENTHREAD_SYSTEM_H_ 37 38 #include <openthread/instance.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * This function performs all platform-specific initialization of OpenThread's drivers. 46 * 47 * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function 48 * when initialization of OpenThread's drivers is most appropriate. 49 * 50 * @param[in] argc Number of arguments in @p argv. 51 * @param[in] argv Argument vector. 52 * 53 */ 54 void otSysInit(int argc, char *argv[]); 55 56 /** 57 * This function performs all platform-specific deinitialization for OpenThread's drivers. 58 * 59 * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function 60 * when deinitialization of OpenThread's drivers is most appropriate. 61 * 62 */ 63 void otSysDeinit(void); 64 65 /** 66 * This function returns true if a pseudo-reset was requested. 67 * 68 * In such a case, the main loop should shut down and re-initialize the OpenThread instance. 69 * 70 * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function 71 * in the main loop to determine when to shut down and re-initialize the OpenThread instance. 72 * 73 */ 74 bool otSysPseudoResetWasRequested(void); 75 76 /** 77 * This function performs all platform-specific processing for OpenThread's example applications. 78 * 79 * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function 80 * in the main loop when processing OpenThread's drivers is most appropriate. 81 * 82 * @param[in] aInstance The OpenThread instance structure. 83 * 84 */ 85 void otSysProcessDrivers(otInstance *aInstance); 86 87 /** 88 * This function is called whenever platform drivers needs processing. 89 * 90 * @note This function is not handled by the OpenThread library. Instead, the system/RTOS should handle this function 91 * and schedule a call to `otSysProcessDrivers()`. 92 * 93 */ 94 extern void otSysEventSignalPending(void); 95 96 #ifdef __cplusplus 97 } // end of extern "C" 98 #endif 99 100 #endif // OPENTHREAD_SYSTEM_H_ 101
