| /* |
| * Copyright (c) 2016, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * @brief |
| * This file defines the platform-specific functions needed by OpenThread's example applications. |
| */ |
| |
| #ifndef OPENTHREAD_SYSTEM_H_ |
| #define OPENTHREAD_SYSTEM_H_ |
| |
| #include <openthread/instance.h> |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** |
| * This function performs all platform-specific initialization of OpenThread's drivers. |
| * |
| * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function |
| * when initialization of OpenThread's drivers is most appropriate. |
| * |
| * @param[in] argc Number of arguments in @p argv. |
| * @param[in] argv Argument vector. |
| * |
| */ |
| void otSysInit(int argc, char *argv[]); |
| |
| /** |
| * This function performs all platform-specific deinitialization for OpenThread's drivers. |
| * |
| * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function |
| * when deinitialization of OpenThread's drivers is most appropriate. |
| * |
| */ |
| void otSysDeinit(void); |
| |
| /** |
| * This function returns true if a pseudo-reset was requested. |
| * |
| * In such a case, the main loop should shut down and re-initialize the OpenThread instance. |
| * |
| * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function |
| * in the main loop to determine when to shut down and re-initialize the OpenThread instance. |
| * |
| */ |
| bool otSysPseudoResetWasRequested(void); |
| |
| /** |
| * This function performs all platform-specific processing for OpenThread's example applications. |
| * |
| * @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function |
| * in the main loop when processing OpenThread's drivers is most appropriate. |
| * |
| * @param[in] aInstance The OpenThread instance structure. |
| * |
| */ |
| void otSysProcessDrivers(otInstance *aInstance); |
| |
| /** |
| * This function is called whenever platform drivers needs processing. |
| * |
| * @note This function is not handled by the OpenThread library. Instead, the system/RTOS should handle this function |
| * and schedule a call to `otSysProcessDrivers()`. |
| * |
| */ |
| extern void otSysEventSignalPending(void); |
| |
| #ifdef __cplusplus |
| } // end of extern "C" |
| #endif |
| |
| #endif // OPENTHREAD_SYSTEM_H_ |