| /* |
| * 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 includes the platform-specific initializers. |
| */ |
| |
| #ifndef PLATFORM_POSIX_H_ |
| #define PLATFORM_POSIX_H_ |
| |
| #include <errno.h> |
| #include <stdio.h> |
| #include <string.h> |
| #include <sys/select.h> |
| #include <sys/time.h> |
| |
| #include <openthread-system.h> |
| #include <openthread/error.h> |
| #include <openthread/instance.h> |
| |
| #include "platform-config.h" |
| #include "common/logging.hpp" |
| |
| /** |
| * This is the socket name used by daemon mode. |
| * |
| */ |
| #define OPENTHREAD_POSIX_APP_SOCKET_NAME OPENTHREAD_POSIX_APP_SOCKET_BASENAME ".sock" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| enum |
| { |
| OT_SIM_EVENT_ALARM_FIRED = 0, |
| OT_SIM_EVENT_RADIO_RECEIVED = 1, |
| OT_SIM_EVENT_UART_WRITE = 2, |
| OT_SIM_EVENT_RADIO_SPINEL_WRITE = 3, |
| OT_EVENT_DATA_MAX_SIZE = 1024, |
| }; |
| |
| OT_TOOL_PACKED_BEGIN |
| struct Event |
| { |
| uint64_t mDelay; |
| uint8_t mEvent; |
| uint16_t mDataLength; |
| uint8_t mData[OT_EVENT_DATA_MAX_SIZE]; |
| } OT_TOOL_PACKED_END; |
| |
| /** |
| * This function converts an exit code into a string. |
| * |
| * @param[in] aExitCode An exit code. |
| * |
| * @returns A string representation of an exit code. |
| * |
| */ |
| const char *otExitCodeToString(uint8_t aExitCode); |
| |
| /** |
| * This macro checks for the specified condition, which is expected to commonly be true, |
| * and both records exit status and terminates the program if the condition is false. |
| * |
| * @param[in] aCondition The condition to verify |
| * @param[in] aExitCode The exit code. |
| * |
| */ |
| #define VerifyOrDie(aCondition, aExitCode) \ |
| do \ |
| { \ |
| if (!(aCondition)) \ |
| { \ |
| otLogCritPlat("%s() at %s:%d: %s", __func__, __FILE__, __LINE__, otExitCodeToString(aExitCode)); \ |
| exit(aExitCode); \ |
| } \ |
| } while (false) |
| |
| /** |
| * This macro checks for the specified error code, which is expected to commonly be successful, |
| * and both records exit status and terminates the program if the error code is unsuccessful. |
| * |
| * @param[in] aError An error code to be evaluated against OT_ERROR_NONE. |
| * |
| */ |
| #define SuccessOrDie(aError) \ |
| VerifyOrDie(aError == OT_ERROR_NONE, \ |
| (aError == OT_ERROR_INVALID_ARGS ? OT_EXIT_INVALID_ARGUMENTS : OT_EXIT_FAILURE)) |
| |
| /** |
| * This macro unconditionally both records exit status and terminates the program. |
| * |
| * @param[in] aExitCode The exit code. |
| * |
| */ |
| #define DieNow(aExitCode) VerifyOrDie(false, aExitCode) |
| |
| /** |
| * This macro unconditionally both records exit status and exit message and terminates the program. |
| * |
| * @param[in] aMessage The exit message. |
| * @param[in] aExitCode The exit code. |
| * |
| */ |
| #define DieNowWithMessage(aMessage, aExitCode) \ |
| do \ |
| { \ |
| fprintf(stderr, "exit(%d): %s line %d, %s, %s\r\n", aExitCode, __func__, __LINE__, aMessage, \ |
| otExitCodeToString(aExitCode)); \ |
| otLogCritPlat("exit(%d): %s line %d, %s, %s", aExitCode, __func__, __LINE__, aMessage, \ |
| otExitCodeToString(aExitCode)); \ |
| exit(aExitCode); \ |
| } while (false) |
| |
| /** |
| * Unique node ID. |
| * |
| */ |
| extern uint64_t gNodeId; |
| |
| /** |
| * This function initializes the alarm service used by OpenThread. |
| * |
| */ |
| void platformAlarmInit(uint32_t aSpeedUpFactor); |
| |
| /** |
| * This function retrieves the time remaining until the alarm fires. |
| * |
| * @param[out] aTimeval A pointer to the timeval struct. |
| * |
| */ |
| void platformAlarmUpdateTimeout(struct timeval *tv); |
| |
| /** |
| * This function performs alarm driver processing. |
| * |
| * @param[in] aInstance The OpenThread instance structure. |
| * |
| */ |
| void platformAlarmProcess(otInstance *aInstance); |
| |
| /** |
| * This function returns the next alarm event time. |
| * |
| * @returns The next alarm fire time. |
| * |
| */ |
| int32_t platformAlarmGetNext(void); |
| |
| #define MS_PER_S 1000 |
| #define US_PER_MS 1000 |
| #define US_PER_S 1000000 |
| #define NS_PER_US 1000 |
| |
| /** |
| * This function advances the alarm time by @p aDelta. |
| * |
| * @param[in] aDelta The amount of time to advance. |
| * |
| */ |
| void platformAlarmAdvanceNow(uint64_t aDelta); |
| |
| /** |
| * This function initializes the radio service used by OpenThread. |
| * |
| * @note Even when @p aPlatformConfig->mResetRadio is false, a reset event (i.e. a PROP_LAST_STATUS between |
| * [SPINEL_STATUS_RESET__BEGIN, SPINEL_STATUS_RESET__END]) is still expected from RCP. |
| * |
| * @param[in] aPlatformConfig Platform configuration structure. |
| * |
| */ |
| void platformRadioInit(const otPlatformConfig *aPlatformConfig); |
| |
| /** |
| * This function shuts down the radio service used by OpenThread. |
| * |
| */ |
| void platformRadioDeinit(void); |
| |
| /** |
| * This function inputs a received radio frame. |
| * |
| * @param[in] aInstance A pointer to the OpenThread instance. |
| * @param[in] aBuf A pointer to the received radio frame. |
| * @param[in] aBufLength The size of the received radio frame. |
| * |
| */ |
| void platformRadioReceive(otInstance *aInstance, uint8_t *aBuf, uint16_t aBufLength); |
| |
| /** |
| * This function updates the file descriptor sets with file descriptors used by the radio driver. |
| * |
| * @param[inout] aReadFdSet A pointer to the read file descriptors. |
| * @param[inout] aWriteFdSet A pointer to the write file descriptors. |
| * @param[inout] aMaxFd A pointer to the max file descriptor. |
| * @param[inout] aTimeout A pointer to the timeout. |
| * |
| */ |
| void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, int *aMaxFd, struct timeval *aTimeout); |
| |
| /** |
| * This function performs radio driver processing. |
| * |
| * @param[in] aInstance A pointer to the OpenThread instance. |
| * @param[in] aReadFdSet A pointer to the read file descriptors. |
| * @param[in] aWriteFdSet A pointer to the write file descriptors. |
| * |
| */ |
| void platformRadioProcess(otInstance *aInstance, const fd_set *aReadFdSet, const fd_set *aWriteFdSet); |
| |
| /** |
| * This function initializes the random number service used by OpenThread. |
| * |
| */ |
| void platformRandomInit(void); |
| |
| /** |
| * This function initializes the logging service used by OpenThread. |
| * |
| * @param[in] aName A name string which will be prefixed to each log line. |
| * |
| */ |
| void platformLoggingInit(const char *aName); |
| |
| /** |
| * This function updates the file descriptor sets with file descriptors used by the UART driver. |
| * |
| * @param[inout] aReadFdSet A pointer to the read file descriptors. |
| * @param[inout] aWriteFdSet A pointer to the write file descriptors. |
| * @param[inout] aMaxFd A pointer to the max file descriptor. |
| * |
| */ |
| void platformUartUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd); |
| |
| /** |
| * This function performs radio driver processing. |
| * |
| * @param[in] aReadFdSet A pointer to the read file descriptors. |
| * @param[in] aWriteFdSet A pointer to the write file descriptors. |
| * @param[in] aErrorFdSet A pointer to the error file descriptors. |
| * |
| */ |
| void platformUartProcess(const fd_set *aReadFdSet, const fd_set *aWriteFdSet, const fd_set *aErrorFdSet); |
| |
| /** |
| * This function initializes platform netif. |
| * |
| * @param[in] aInstance A pointer to the OpenThread instance. |
| * |
| */ |
| void platformNetifInit(otInstance *aInstance); |
| |
| /** |
| * This function updates the file descriptor sets with file descriptors used by platform netif module. |
| * |
| * @param[inout] aReadFdSet A pointer to the read file descriptors. |
| * @param[inout] aWriteFdSet A pointer to the write file descriptors. |
| * @param[inout] aErrorFdSet A pointer to the error file descriptors. |
| * @param[inout] aMaxFd A pointer to the max file descriptor. |
| * |
| */ |
| void platformNetifUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd); |
| |
| /** |
| * This function performs platform netif processing. |
| * |
| * @param[in] aReadFdSet A pointer to the read file descriptors. |
| * @param[in] aWriteFdSet A pointer to the write file descriptors. |
| * @param[in] aErrorFdSet A pointer to the error file descriptors. |
| * |
| */ |
| void platformNetifProcess(const fd_set *aReadFdSet, const fd_set *aWriteFdSet, const fd_set *aErrorFdSet); |
| |
| /** |
| * This function initialize virtual time simulation. |
| * |
| */ |
| void platformSimInit(void); |
| |
| /** |
| * This function deinitialize virtual time simulation. |
| * |
| */ |
| void platformSimDeinit(void); |
| |
| /** |
| * This function performs virtual time simulation processing. |
| * |
| * @param[in] aInstance A pointer to the OpenThread instance. |
| * @param[in] aReadFdSet A pointer to the read file descriptors. |
| * @param[in] aWriteFdSet A pointer to the write file descriptors. |
| * |
| */ |
| void platformSimProcess(otInstance * aInstance, |
| const fd_set *aReadFdSet, |
| const fd_set *aWriteFdSet, |
| const fd_set *aErrorFdSet); |
| |
| /** |
| * This function updates the file descriptor sets with file descriptors |
| * used by the virtual time simulation. |
| * |
| * @param[inout] aReadFdSet A pointer to the read file descriptors. |
| * @param[inout] aWriteFdSet A pointer to the write file descriptors. |
| * @param[inout] aErrorFdSet A pointer to the error file descriptors. |
| * @param[inout] aMaxFd A pointer to the max file descriptor. |
| * @param[inout] aTimeout A pointer to the timeout. |
| * |
| */ |
| void platformSimUpdateFdSet(fd_set * aReadFdSet, |
| fd_set * aWriteFdSet, |
| fd_set * aErrorFdSet, |
| int * aMaxFd, |
| struct timeval *aTimeout); |
| |
| /** |
| * This function sends radio spinel event of virtual time simulation. |
| * |
| * @param[in] aData A pointer to the spinel frame. |
| * @param[in] aLength Length of the spinel frame. |
| * |
| */ |
| void platformSimSendRadioSpinelWriteEvent(const uint8_t *aData, uint16_t aLength); |
| |
| /** |
| * This function receives an event of virtual time simulation. |
| * |
| * @param[out] aEvent A pointer to the event receiving the event. |
| * |
| */ |
| void platformSimReceiveEvent(struct Event *aEvent); |
| |
| /** |
| * This function sends sleep event through virtual time simulation. |
| * |
| * @param[in] aTimeout A pointer to the time sleeping. |
| * |
| */ |
| void platformSimSendSleepEvent(const struct timeval *aTimeout); |
| |
| /** |
| * This function performs radio spinel processing of virtual time simulation. |
| * |
| * @param[in] aInstance A pointer to the OpenThread instance. |
| * @param[in] aEvent A pointer to the current event. |
| * |
| */ |
| void platformSimRadioSpinelProcess(otInstance *aInstance, const struct Event *aEvent); |
| |
| /** |
| * This function gets system time in microseconds without applying speed up factor. |
| * |
| * @returns System time in microseconds. |
| * |
| */ |
| uint64_t platformGetTime(void); |
| |
| /** |
| * This function initializes platform UDP driver. |
| * |
| * @param[in] aIfName The name of Thread's platform network interface. |
| * |
| */ |
| void platformUdpInit(const char *aIfName); |
| |
| /** |
| * This function performs platform UDP driver processing. |
| * |
| * @param[in] aInstance The OpenThread instance structure. |
| * @param[in] aReadFdSet A pointer to the read file descriptors. |
| * |
| */ |
| void platformUdpProcess(otInstance *aInstance, const fd_set *aReadSet); |
| |
| /** |
| * This function updates the file descriptor sets with file descriptors used by the platform UDP driver. |
| * |
| * @param[in] aInstance The OpenThread instance structure. |
| * @param[inout] aReadFdSet A pointer to the read file descriptors. |
| * @param[inout] aMaxFd A pointer to the max file descriptor. |
| */ |
| void platformUdpUpdateFdSet(otInstance *aInstance, fd_set *aReadFdSet, int *aMaxFd); |
| |
| /** |
| * This function creates a socket with SOCK_CLOEXEC flag set. |
| * |
| * @param[in] aDomain The communication domain. |
| * @param[in] aType The semantics of communication. |
| * @param[in] aProtocol The protocol to use. |
| * |
| * @returns The file descriptor of the created socket. |
| * |
| * @retval -1 Failed to create socket. |
| * |
| */ |
| int SocketWithCloseExec(int aDomain, int aType, int aProtocol); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| #endif // PLATFORM_POSIX_H_ |
