mirror of
https://github.com/espressif/openthread.git
synced 2026-10-14 19:57:40 +00:00
[doxygen] remove empty line at end of block (#10748)
This commit is contained in:
Jonathan Hui
@@ -44,7 +44,6 @@
|
||||
|
||||
/**
|
||||
* Diagnostics mode variables.
|
||||
*
|
||||
*/
|
||||
static bool sDiagMode = false;
|
||||
|
||||
|
||||
@@ -29,7 +29,6 @@
|
||||
/**
|
||||
* @file
|
||||
* This file implements an entropy source based on /dev/urandom or pseudo-random generator.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "platform-simulation.h"
|
||||
|
||||
@@ -29,14 +29,12 @@
|
||||
/**
|
||||
* @file
|
||||
* This file includes the platform-specific configuration.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_SIMULATION_UART_BAUDRATE
|
||||
*
|
||||
* This setting configures the baud rate of the UART.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_SIMULATION_UART_BAUDRATE
|
||||
#define OPENTHREAD_SIMULATION_UART_BAUDRATE B115200
|
||||
@@ -46,7 +44,6 @@
|
||||
* @def OPENTHREAD_SIMULATION_VIRTUAL_TIME
|
||||
*
|
||||
* This setting configures whether to use virtual time (used for simulation) in simulation platform.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_SIMULATION_VIRTUAL_TIME
|
||||
#define OPENTHREAD_SIMULATION_VIRTUAL_TIME 0
|
||||
@@ -56,7 +53,6 @@
|
||||
* @def OPENTHREAD_SIMULATION_VIRTUAL_TIME_UART
|
||||
*
|
||||
* This setting configures whether to use virtual time for UART.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_SIMULATION_VIRTUAL_TIME_UART
|
||||
#define OPENTHREAD_SIMULATION_VIRTUAL_TIME_UART 0
|
||||
@@ -66,7 +62,6 @@
|
||||
* @def OPENTHREAD_PLATFORM_USE_PSEUDO_RESET
|
||||
*
|
||||
* Define as 1 to enable pseudo-reset.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_PLATFORM_USE_PSEUDO_RESET
|
||||
#define OPENTHREAD_PLATFORM_USE_PSEUDO_RESET 0
|
||||
@@ -76,7 +71,6 @@
|
||||
* @def OPENTHREAD_CONFIG_NCP_SPI_ENABLE
|
||||
*
|
||||
* Define as 1 to enable SPI NCP interface.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_NCP_SPI_ENABLE
|
||||
#define OPENTHREAD_CONFIG_NCP_SPI_ENABLE 0
|
||||
@@ -84,7 +78,6 @@
|
||||
|
||||
/**
|
||||
* Check OTNS configurations
|
||||
*
|
||||
*/
|
||||
#if OPENTHREAD_CONFIG_OTNS_ENABLE
|
||||
|
||||
@@ -98,7 +91,6 @@
|
||||
* @def OPENTHREAD_SIMULATION_MAX_NETWORK_SIZE
|
||||
*
|
||||
* This setting configures the maximum network size in simulation.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_SIMULATION_MAX_NETWORK_SIZE
|
||||
#define OPENTHREAD_SIMULATION_MAX_NETWORK_SIZE 33
|
||||
@@ -111,7 +103,6 @@
|
||||
* socket.
|
||||
*
|
||||
* This is intended for testing of the OpenThread Multicast DNS (mDNS) module.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_SIMULATION_MDNS_SOCKET_IMPLEMENT_POSIX
|
||||
#define OPENTHREAD_SIMULATION_MDNS_SOCKET_IMPLEMENT_POSIX 0
|
||||
@@ -121,7 +112,6 @@
|
||||
* @def OPENTHREAD_SIMULATION_IMPLMENT_INFRA_IF
|
||||
*
|
||||
* Define as 1 for the simulation platform to provide implementation of `otPlatInfra` APIs.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_SIMULATION_IMPLEMENT_INFRA_IF
|
||||
#define OPENTHREAD_SIMULATION_IMPLEMENT_INFRA_IF 1
|
||||
|
||||
@@ -86,13 +86,11 @@ enum
|
||||
|
||||
/**
|
||||
* Unique node ID.
|
||||
*
|
||||
*/
|
||||
extern uint32_t gNodeId;
|
||||
|
||||
/**
|
||||
* Initializes the alarm service used by OpenThread.
|
||||
*
|
||||
*/
|
||||
void platformAlarmInit(uint32_t aSpeedUpFactor);
|
||||
|
||||
@@ -100,7 +98,6 @@ void platformAlarmInit(uint32_t aSpeedUpFactor);
|
||||
* Retrieves the time remaining until the alarm fires.
|
||||
*
|
||||
* @param[out] aTimeout A pointer to the timeval struct.
|
||||
*
|
||||
*/
|
||||
void platformAlarmUpdateTimeout(struct timeval *aTimeout);
|
||||
|
||||
@@ -108,7 +105,6 @@ void platformAlarmUpdateTimeout(struct timeval *aTimeout);
|
||||
* Performs alarm driver processing.
|
||||
*
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
*
|
||||
*/
|
||||
void platformAlarmProcess(otInstance *aInstance);
|
||||
|
||||
@@ -116,7 +112,6 @@ void platformAlarmProcess(otInstance *aInstance);
|
||||
* Returns the duration to the next alarm event time (in micro seconds)
|
||||
*
|
||||
* @returns The duration (in micro seconds) to the next alarm event.
|
||||
*
|
||||
*/
|
||||
uint64_t platformAlarmGetNext(void);
|
||||
|
||||
@@ -124,7 +119,6 @@ uint64_t platformAlarmGetNext(void);
|
||||
* Returns the current alarm time.
|
||||
*
|
||||
* @returns The current alarm time.
|
||||
*
|
||||
*/
|
||||
uint64_t platformAlarmGetNow(void);
|
||||
|
||||
@@ -132,19 +126,16 @@ uint64_t platformAlarmGetNow(void);
|
||||
* Advances the alarm time by @p aDelta.
|
||||
*
|
||||
* @param[in] aDelta The amount of time to advance.
|
||||
*
|
||||
*/
|
||||
void platformAlarmAdvanceNow(uint64_t aDelta);
|
||||
|
||||
/**
|
||||
* Initializes the radio service used by OpenThread.
|
||||
*
|
||||
*/
|
||||
void platformRadioInit(void);
|
||||
|
||||
/**
|
||||
* Shuts down the radio service used by OpenThread.
|
||||
*
|
||||
*/
|
||||
void platformRadioDeinit(void);
|
||||
|
||||
@@ -154,7 +145,6 @@ void platformRadioDeinit(void);
|
||||
* @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);
|
||||
|
||||
@@ -165,7 +155,6 @@ void platformRadioReceive(otInstance *aInstance, uint8_t *aBuf, uint16_t aBufLen
|
||||
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
|
||||
* @param[in,out] aTimeout A pointer to the timeout.
|
||||
* @param[in,out] aMaxFd A pointer to the max file descriptor.
|
||||
*
|
||||
*/
|
||||
void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct timeval *aTimeout, int *aMaxFd);
|
||||
|
||||
@@ -175,13 +164,11 @@ void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct ti
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @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);
|
||||
|
||||
/**
|
||||
* Initializes the random number service used by OpenThread.
|
||||
*
|
||||
*/
|
||||
void platformRandomInit(void);
|
||||
|
||||
@@ -189,7 +176,6 @@ void platformRandomInit(void);
|
||||
* This functions set the file name to use for logging.
|
||||
*
|
||||
* @param[in] aName The file name.
|
||||
*
|
||||
*/
|
||||
void platformLoggingSetFileName(const char *aName);
|
||||
|
||||
@@ -197,13 +183,11 @@ void platformLoggingSetFileName(const char *aName);
|
||||
* Initializes the platform logging service.
|
||||
*
|
||||
* @param[in] aName The log module name to set with syslog.
|
||||
*
|
||||
*/
|
||||
void platformLoggingInit(const char *aName);
|
||||
|
||||
/**
|
||||
* Finalizes the platform logging service.
|
||||
*
|
||||
*/
|
||||
void platformLoggingDeinit(void);
|
||||
|
||||
@@ -213,19 +197,16 @@ void platformLoggingDeinit(void);
|
||||
* @param[in,out] aReadFdSet A pointer to the read file descriptors.
|
||||
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
|
||||
* @param[in,out] aMaxFd A pointer to the max file descriptor.
|
||||
*
|
||||
*/
|
||||
void platformUartUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd);
|
||||
|
||||
/**
|
||||
* Performs radio driver processing.
|
||||
*
|
||||
*/
|
||||
void platformUartProcess(void);
|
||||
|
||||
/**
|
||||
* Restores the Uart.
|
||||
*
|
||||
*/
|
||||
void platformUartRestore(void);
|
||||
|
||||
@@ -233,7 +214,6 @@ void platformUartRestore(void);
|
||||
* Sends a simulation event.
|
||||
*
|
||||
* @param[in] aEvent A pointer to the simulation event to send
|
||||
*
|
||||
*/
|
||||
void otSimSendEvent(const struct Event *aEvent);
|
||||
|
||||
@@ -242,7 +222,6 @@ void otSimSendEvent(const struct Event *aEvent);
|
||||
*
|
||||
* @param[in] aData A pointer to the UART data.
|
||||
* @param[in] aLength Length of UART data.
|
||||
*
|
||||
*/
|
||||
void otSimSendUartWriteEvent(const uint8_t *aData, uint16_t aLength);
|
||||
|
||||
@@ -250,7 +229,6 @@ void otSimSendUartWriteEvent(const uint8_t *aData, uint16_t aLength);
|
||||
* Checks if radio transmitting is pending.
|
||||
*
|
||||
* @returns Whether radio transmitting is pending.
|
||||
*
|
||||
*/
|
||||
bool platformRadioIsTransmitPending(void);
|
||||
|
||||
@@ -262,7 +240,6 @@ bool platformRadioIsTransmitPending(void);
|
||||
*
|
||||
* @param[in] aEnvName The name of the environment variable.
|
||||
* @param[out] aValue A pointer to the unsigned 16-bit integer.
|
||||
*
|
||||
*/
|
||||
void parseFromEnvAsUint16(const char *aEnvName, uint16_t *aValue);
|
||||
|
||||
@@ -272,13 +249,11 @@ void parseFromEnvAsUint16(const char *aEnvName, uint16_t *aValue);
|
||||
* Initializes the TREL service.
|
||||
*
|
||||
* @param[in] aSpeedUpFactor The time speed-up factor.
|
||||
*
|
||||
*/
|
||||
void platformTrelInit(uint32_t aSpeedUpFactor);
|
||||
|
||||
/**
|
||||
* Shuts down the TREL service.
|
||||
*
|
||||
*/
|
||||
void platformTrelDeinit(void);
|
||||
|
||||
@@ -289,7 +264,6 @@ void platformTrelDeinit(void);
|
||||
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
|
||||
* @param[in,out] aTimeout A pointer to the timeout.
|
||||
* @param[in,out] aMaxFd A pointer to the max file descriptor.
|
||||
*
|
||||
*/
|
||||
void platformTrelUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct timeval *aTimeout, int *aMaxFd);
|
||||
|
||||
@@ -299,7 +273,6 @@ void platformTrelUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct tim
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[in] aReadFdSet A pointer to the read file descriptors.
|
||||
* @param[in] aWriteFdSet A pointer to the write file descriptors.
|
||||
*
|
||||
*/
|
||||
void platformTrelProcess(otInstance *aInstance, const fd_set *aReadFdSet, const fd_set *aWriteFdSet);
|
||||
|
||||
@@ -309,13 +282,11 @@ void platformTrelProcess(otInstance *aInstance, const fd_set *aReadFdSet, const
|
||||
|
||||
/**
|
||||
* Initializes the platform infra-if module.
|
||||
*
|
||||
*/
|
||||
void platformInfraIfInit(void);
|
||||
|
||||
/**
|
||||
* Shuts down the platform infra-if module.
|
||||
*
|
||||
*/
|
||||
void platformInfraIfDeinit(void);
|
||||
|
||||
@@ -325,7 +296,6 @@ void platformInfraIfDeinit(void);
|
||||
* @param[in,out] aReadFdSet A pointer to the read file descriptors.
|
||||
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
|
||||
* @param[in,out] aMaxFd A pointer to the max file descriptor.
|
||||
*
|
||||
*/
|
||||
void platformInfraIfUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, int *aMaxFd);
|
||||
|
||||
@@ -335,7 +305,6 @@ void platformInfraIfUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, int *aM
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[in] aReadFdSet A pointer to the read file descriptors.
|
||||
* @param[in] aWriteFdSet A pointer to the write file descriptors.
|
||||
*
|
||||
*/
|
||||
void platformInfraIfProcess(otInstance *aInstance, const fd_set *aReadFdSet, const fd_set *aWriteFdSet);
|
||||
|
||||
@@ -348,7 +317,6 @@ void platformInfraIfProcess(otInstance *aInstance, const fd_set *aReadFdSet, con
|
||||
*
|
||||
* @param[in,out] aReadFdSet A pointer to the read file descriptors.
|
||||
* @param[in,out] aMaxFd A pointer to the max file descriptor.
|
||||
*
|
||||
*/
|
||||
void platformMdnsSocketUpdateFdSet(fd_set *aReadFdSet, int *aMaxFd);
|
||||
|
||||
@@ -357,7 +325,6 @@ void platformMdnsSocketUpdateFdSet(fd_set *aReadFdSet, int *aMaxFd);
|
||||
*
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[in] aReadFdSet A pointer to the read file descriptors.
|
||||
*
|
||||
*/
|
||||
void platformMdnsSocketProcess(otInstance *aInstance, const fd_set *aReadFdSet);
|
||||
|
||||
@@ -365,7 +332,6 @@ void platformMdnsSocketProcess(otInstance *aInstance, const fd_set *aReadFdSet);
|
||||
|
||||
/**
|
||||
* Shuts down the BLE service used by OpenThread.
|
||||
*
|
||||
*/
|
||||
void platformBleDeinit(void);
|
||||
|
||||
@@ -376,7 +342,6 @@ void platformBleDeinit(void);
|
||||
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
|
||||
* @param[in,out] aTimeout A pointer to the timeout.
|
||||
* @param[in,out] aMaxFd A pointer to the max file descriptor.
|
||||
*
|
||||
*/
|
||||
void platformBleUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct timeval *aTimeout, int *aMaxFd);
|
||||
|
||||
@@ -386,7 +351,6 @@ void platformBleUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct time
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[in] aReadFdSet A pointer to the read file descriptors.
|
||||
* @param[in] aWriteFdSet A pointer to the write file descriptors.
|
||||
*
|
||||
*/
|
||||
void platformBleProcess(otInstance *aInstance, const fd_set *aReadFdSet, const fd_set *aWriteFdSet);
|
||||
|
||||
|
||||
@@ -35,7 +35,6 @@
|
||||
* Represents a socket for communication with other simulation node.
|
||||
*
|
||||
* This is used for emulation of 15.4 radio or other interfaces.
|
||||
*
|
||||
*/
|
||||
typedef struct utilsSocket
|
||||
{
|
||||
@@ -60,7 +59,6 @@ extern const char *gLocalInterface; ///< Local interface name or address to use
|
||||
* @param[in] aFd The FD to add.
|
||||
* @param[in] aFdSet The FD set to add to.
|
||||
* @param[in] aMaxFd A pointer to track maximum FD in @p aFdSet (can be NULL).
|
||||
*
|
||||
*/
|
||||
void utilsAddFdToFdSet(int aFd, fd_set *aFdSet, int *aMaxFd);
|
||||
|
||||
@@ -69,7 +67,6 @@ void utilsAddFdToFdSet(int aFd, fd_set *aFdSet, int *aMaxFd);
|
||||
*
|
||||
* @param[in] aSocket The socket to initialize.
|
||||
* @param[in] aPortBase The base port number value. Nodes will determine their port as `aPortBased + gNodeId`.
|
||||
*
|
||||
*/
|
||||
void utilsInitSocket(utilsSocket *aSocket, uint16_t aPortBase);
|
||||
|
||||
@@ -77,7 +74,6 @@ void utilsInitSocket(utilsSocket *aSocket, uint16_t aPortBase);
|
||||
* De-initializes the socket.
|
||||
*
|
||||
* @param[in] aSocket The socket to de-initialize.
|
||||
*
|
||||
*/
|
||||
void utilsDeinitSocket(utilsSocket *aSocket);
|
||||
|
||||
@@ -87,7 +83,6 @@ void utilsDeinitSocket(utilsSocket *aSocket);
|
||||
* @param[in] aSocket The socket.
|
||||
* @param[in] aFdSet The (read) FD set to add to.
|
||||
* @param[in] aMaxFd A pointer to track maximum FD in @p aFdSet (can be NULL).
|
||||
*
|
||||
*/
|
||||
void utilsAddSocketRxFd(const utilsSocket *aSocket, fd_set *aFdSet, int *aMaxFd);
|
||||
|
||||
@@ -97,7 +92,6 @@ void utilsAddSocketRxFd(const utilsSocket *aSocket, fd_set *aFdSet, int *aMaxFd)
|
||||
* @param[in] aSocket The socket.
|
||||
* @param[in] aFdSet The (write) FD set to add to.
|
||||
* @param[in] aMaxFd A pointer to track maximum FD in @p aFdSet (can be NULL).
|
||||
*
|
||||
*/
|
||||
void utilsAddSocketTxFd(const utilsSocket *aSocket, fd_set *aFdSet, int *aMaxFd);
|
||||
|
||||
@@ -109,7 +103,6 @@ void utilsAddSocketTxFd(const utilsSocket *aSocket, fd_set *aFdSet, int *aMaxFd)
|
||||
*
|
||||
* @retval TRUE The socket RX FD is in @p aReadFdSet, and socket can receive.
|
||||
* @retval FALSE The socket RX FD is not in @p aReadFdSet. Socket is not ready to receive.
|
||||
*
|
||||
*/
|
||||
bool utilsCanSocketReceive(const utilsSocket *aSocket, const fd_set *aReadFdSet);
|
||||
|
||||
@@ -121,7 +114,6 @@ bool utilsCanSocketReceive(const utilsSocket *aSocket, const fd_set *aReadFdSet)
|
||||
*
|
||||
* @retval TRUE The socket TX FD is in @p aWriteFdSet, and socket can send.
|
||||
* @retval FALSE The socket TX FD is not in @p aWriteFdSet. Socket is not ready to send.
|
||||
*
|
||||
*/
|
||||
bool utilsCanSocketSend(const utilsSocket *aSocket, const fd_set *aWriteFdSet);
|
||||
|
||||
@@ -137,7 +129,6 @@ bool utilsCanSocketSend(const utilsSocket *aSocket, const fd_set *aWriteFdSet);
|
||||
* Can be NULL if not needed.
|
||||
*
|
||||
* @returns The number of received bytes written into @p aBuffer.
|
||||
*
|
||||
*/
|
||||
uint16_t utilsReceiveFromSocket(const utilsSocket *aSocket,
|
||||
void *aBuffer,
|
||||
@@ -150,7 +141,6 @@ uint16_t utilsReceiveFromSocket(const utilsSocket *aSocket,
|
||||
* @param[in] aSocket The socket.
|
||||
* @param[in] aBuffer The buffer containing the bytes to sent.
|
||||
* @param[in] aBufferSize Size of data in @p buffer in bytes.
|
||||
*
|
||||
*/
|
||||
void utilsSendOverSocket(const utilsSocket *aSocket, const void *aBuffer, uint16_t aBufferLength);
|
||||
|
||||
|
||||
@@ -70,7 +70,6 @@ static void handleSignal(int aSignal)
|
||||
|
||||
/**
|
||||
* Defines the argument return values.
|
||||
*
|
||||
*/
|
||||
enum
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user