我的书签
添加书签
移除书签Wifiiot
Since:
1.0
Version:
1.0
Summary
Files
Data Structures
Macros
Defines a module-level return value to indicate a successful operation. |
|
Defines a module-level return value to indicate an operation failure. |
|
WIFI_IOT_ERR_UART_INVALID_PARAMETER 0x80001000 |
|
Defines a UART error code to indicate an invalid pause operation. |
|
WIFI_IOT_ERR_UART_INVALID_PARITY 0x80001002 |
Defines a UART error code to indicate an invalid parity check. |
WIFI_IOT_ERR_UART_INVALID_STOP_BITS 0x80001004 |
|
WIFI_IOT_ERR_UART_INVALID_COM_PORT 0x80001006 |
Defines a UART error code to indicate an invalid port number. |
Defines a UART error code to indicate a non-support for DMA. |
|
WIFI_IOT_ERR_UART_NOT_BLOCK_MODE 0x80001008 |
|
WIFI_IOT_ERR_GPIO_REPEAT_INIT 0x80001041 |
Defines a GPIO error code to indicate repeated initialization. |
WIFI_IOT_ERR_GPIO_NOT_SUPPORT 0x80001043 |
|
WIFI_IOT_ERR_FLASH_INVALID_PARAM 0x800010C1 |
Defines a flash error code to indicate an invalid parameter. |
Defines a flash error code to indicate that the address is out of range. |
|
WIFI_IOT_ERR_FLASH_INVALID_PARAM_SIZE_ZERO 0x800010C3 |
Defines a flash error code to indicate that the parameter size is 0 |
Defines a flash error code to indicate that the erase size is not aligned. |
|
WIFI_IOT_ERR_FLASH_INVALID_PARAM_IOCTRL_DATA_NULL 0x800010C5 |
Defines a flash error code to indicate that the data of the I/O controller is empty. |
WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD1 0x800010C7 |
Defines a flash error code to indicate that pad1 is incorrect. |
Defines a flash error code to indicate that pad2 is incorrect. |
|
WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD3 0x800010C9 |
Defines a flash error code to indicate that pad3 is incorrect. |
Defines a flash error code to indicate that pad4 is incorrect. |
|
WIFI_IOT_ERR_FLASH_TIME_OUT_WAIT_READY 0x800010CB |
Defines a flash error code to indicate a timeout on waiting for ready. |
Defines a flash error code to indicate that an error occurs when reading register 1. |
|
WIFI_IOT_ERR_FLASH_QUAD_MODE_READ_REG2 0x800010CD |
Defines a flash error code to indicate that an error occurs when reading register 2. |
Defines a flash error code to indicate that an error occurs when comparing registers. |
|
WIFI_IOT_ERR_FLASH_NO_MATCH_FLASH 0x800010CF |
|
Defines a flash error code to indicate a failure in enabling write. |
|
WIFI_IOT_ERR_FLASH_NO_MATCH_ERASE_SIZE 0x800010D1 |
Defines a flash error code to indicate a mismatch in the size of data to erase. |
Defines a flash error code to indicate the maximum value of the SPI operation. |
|
WIFI_IOT_ERR_FLASH_NOT_SUPPORT_IOCTRL_ID 0x800010D3 |
Defines a flash error code to indicate an unsupported IO controller ID.. |
WIFI_IOT_ERR_FLASH_RE_INIT 0x800010D5 |
Defines a flash error code to indicate repeated initialization. |
Defines a flash error code to indicate a non-support for data erasure. |
|
WIFI_IOT_ERR_FLASH_WRITE_COMPARE_WRONG 0x800010D7 |
Defines a flash error code to indicate that an error occurs when comparing the data written. |
Defines a flash error code to indicate a timeout on waiting for a configuration to start. |
|
WIFI_IOT_ERR_FLASH_PATITION_INIT_FAIL 0x800010D9 |
Defines a flash error code to indicate a partition initialization failure. |
WIFI_IOT_ERR_FLASH_ERASE_NOT_4K_ALIGN 0x800010DB |
Defines a flash error code to indicate that the size of data to erase is not a multiple of 4K bytes. |
WIFI_IOT_ERR_FLASH_PROTECT_NOT_INIT 0x800010DD |
|
Defines a flash error code to indicate repeated initialization. |
|
WIFI_IOT_ERR_FLASH_PROTECT_NOT_FIND_CHIP 0x800010DF |
Defines a flash error code to indicate that no chip is found. |
Defines a flash error code to indicate an invalid parameter. |
|
WIFI_IOT_ERR_FLASH_CRYPTO_BEYOND_ADDR_SIZE 0x800010F1 |
Defines a flash error code to indicate that the address is out of range. |
Defines a flash error code to indicate a failure in applying for memory. |
|
WIFI_IOT_ERR_FLASH_CRYPTO_DATA_ENCRYPT_ERR 0x800001F3 |
|
WIFI_IOT_ERR_FLASH_CRYPTO_KEY_EMPTY_ERR 0x800001F5 |
|
WIFI_IOT_ERR_FLASH_CRYPTO_NOT_SUPPORT 0x800001F7 |
Defines a flash error code to indicate a non-support for encryption. |
Defines a flash error code to indicate an incorrect parameter during encryption. |
|
WIFI_IOT_ERR_FLASH_CRYPTO_KEY_INVALID_ERR 0x800001F9 |
|
Defines a flash error code to indicate a failure in saving the key. |
|
WIFI_IOT_ERR_FLASH_CRYPTO_KERNEL_ADDR_ERR 0x800001FB |
Defines a flash error code to indicate an incorrect kernel address.. |
WIFI_IOT_ERR_I2C_INVALID_PARAMETER 0x80001181 |
|
WIFI_IOT_ERR_I2C_TIMEOUT_WAIT 0x80001183 |
|
WIFI_IOT_ERR_I2C_TIMEOUT_RCV_BYTE 0x80001185 |
|
WIFI_IOT_ERR_I2C_WAIT_SEM_FAIL 0x80001187 |
|
WIFI_IOT_ERR_I2C_WAIT_ACK_ERR 0x80001189 |
Defines an I2C error code to indicate a failure in waiting for a response. |
WIFI_IOT_ERR_SPI_REINIT 0x800011C1 |
Defines an SPI error code to indicate repeated initialization. |
WIFI_IOT_ERR_SPI_BUSY 0x800011C3 |
|
WIFI_IOT_ERR_SPI_READ_TIMEOUT 0x800011C5 |
|
Defines an SPI error code to indicate a non-support for DMA. |
|
WIFI_IOT_ERR_SDIO_INVALID_PARAMETER 0x80001280 |
Defines an SDIO error code to indicate an invalid parameter. |
WIFI_IOT_ERR_ADC_INVALID_CHANNEL_ID 0x80001301 |
|
WIFI_IOT_ERR_ADC_NOT_INIT 0x80001303 |
|
WIFI_IOT_ERR_PWM_INITILIZATION_ALREADY 0x80001341 |
Defines a PWM error code to indicate an initialization error. |
WIFI_IOT_ERR_DMA_INVALID_PARA 0x80001380 |
|
WIFI_IOT_ERR_DMA_BUSY 0x80001382 |
|
Defines a DMA error code to indicate a transmission failure. |
|
WIFI_IOT_ERR_DMA_TRANSFER_TIMEOUT 0x80001384 |
Defines a DMA error code to indicate a transmission timeout. |
WIFI_IOT_ERR_DMA_LLI_NOT_CREATE 0x80001386 |
Defines a DMA error code to indicate that the LLI is not created. |
Defines a DMA error code to indicate a failure in enabling channel interrupt. |
|
WIFI_IOT_ERR_I2S_INVALID_PARAMETER 0x80001400 |
|
Defines an AT error code to indicate repeated function registration. |
|
Indicates the number of extended registers on an SDIO device. |
Typedefs
GpioIsrCallbackFunc) (char arg) |
|
|
Indicates the callback invoked when a device exception occurs. |
|
I2cPrepareFunc) (void) |
|
TickIdleKalCallback) (void) |
|
|
Indicates the callback invoked upon a message event on the host. |
|
Enumerations
Functions
(WifiIotAdcChannelIndex channel, unsigned short data, equModel, WifiIotAdcCurBais curBais, unsigned short rstCnt) |
Reads a piece of sampled data from a specified ADC channel based on the input parameters. |
(const AtCmdTbl cmdTbl, unsigned short cmdNum) |
|
AtPrintf (const char fmt,…) |
|
AtCheckUartBusy (unsigned char enable) |
Sets whether to check the UART busy status during low-power voting. |
(const unsigned int flashOffset, const unsigned int size, unsigned char ramData) |
|
FlashWrite (const unsigned int flashOffset, unsigned int size, const unsigned char ramData, unsigned char doErase) |
|
FlashInit (void) |
|
FlashIoctl (unsigned short cmd, char data) |
|
GpioDeinit (void) |
|
(WifiIotGpioIdx id, dir) |
|
GpioGetDir ( id, WifiIotGpioDir dir) |
|
(WifiIotGpioIdx id, val) |
|
GpioGetOutputVal ( id, WifiIotGpioValue val) |
|
(WifiIotGpioIdx id, val) |
|
GpioRegisterIsrFunc ( id, WifiIotGpioIntType intType, intPolarity, GpioIsrCallbackFunc func, char arg) |
|
(WifiIotGpioIdx id) |
|
(WifiIotGpioIdx id, unsigned char mask) |
|
(WifiIotGpioIdx id, intType, WifiIotGpioIntPolarity intPolarity) |
|
(WifiIotIoName id, val) |
|
IoSetFunc ( id, unsigned char val) |
|
IoGetPull ( id, WifiIotIoPull val) |
|
(WifiIotIoName id, unsigned char val) |
|
(WifiIotIoName id, val) |
|
IOSetDriverStrength ( id, WifiIotIoDriverStrength val) |
|
(WifiIotI2cIdx id, unsigned int baudrate) |
|
(WifiIotI2cIdx id) |
|
(WifiIotI2cIdx id, unsigned short deviceAddr, const i2cData) |
|
I2cRead ( id, unsigned short deviceAddr, const WifiIotI2cData i2cData) |
|
(WifiIotI2cIdx id, unsigned short deviceAddr, const i2cData) |
Sends data to and receives data responses from an I2C device. |
I2cRegisterResetBusFunc ( id, WifiIotI2cFunc pfn) |
|
(WifiIotI2cIdx id, unsigned int baudrate) |
|
(const WifiIotI2sAttribute i2sAttribute) |
|
I2sWrite (unsigned char wrData, unsigned int wrLen, unsigned int timeOutMs) |
|
(unsigned char rdData, unsigned int rdLen, unsigned int timeOutMs) |
|
KalTickRegisterCallback ( cb) |
|
FlashPartitionInit (void) |
|
(WifiIotPwmPort port) |
|
(WifiIotPwmPort port) |
|
(WifiIotPwmPort port, unsigned short duty, unsigned short freq) |
|
(WifiIotPwmPort port) |
|
SdioReinit (void) |
|
SdioRegisterCallback (const callbackFunc) |
|
SdioCompleteSend (unsigned char admaTable, unsigned int admaIndex) |
|
(unsigned int padlen, unsigned char admatable, unsigned int admaIndex) |
|
SdioWriteExtinfo ( extFunc) |
|
SdioSendData (unsigned int xferBytes) |
|
(unsigned char admatable, unsigned int admaIndex, const unsigned int dataAddr, unsigned int dataLen) |
|
SdioSchedMsg (void) |
|
SdioSendMsgAck (unsigned int msg) |
|
|
Clears a specified suspended message in the message queue, adds a new message to it, and sends the new message. |
|
SdioIsPendingMsg (unsigned int msg) |
|
SdioGetExtendInfo (void) |
|
SdioRegisterNotifyMessageCallback ( msgEventCallback) |
Registers the callback that will be invoked when the host sends a message or data. |
SdioSetPowerdownWhenDeepSleep (unsigned char powerDown) |
Sets whether the SDIO device is powered off in deep sleep mode. |
(WifiIotSpiIdx spiId, char writeData, unsigned int byteLen, unsigned int timeOutMs) |
|
(WifiIotSpiIdx spiId, char readData, unsigned int byteLen, unsigned int timeOutMs) |
|
(WifiIotSpiIdx spiId, char writeData, unsigned int byteLen) |
|
(WifiIotSpiIdx spiId, char readData, unsigned int byteLen) |
|
(WifiIotSpiIdx spiId, char writeData, char readData, unsigned int byteLen) |
|
(WifiIotSpiIdx spiId, const param) |
|
SpiInit ( spiId, WifiIotSpiCfgInitParam initParam, const param) |
|
SpiDeinit ( spiId) |
|
SpiSetIrqMode ( spiId, unsigned char irqEn) |
Sets whether to enable the interrupt request (IRQ) mode for an SPI device. |
SpiSetDmaMode ( spiId, unsigned char dmaEn) |
Sets whether to enable DMA to transfer data for an SPI device in slave mode. |
SpiRegisterUsrFunc ( spiId, SpiIsrFunc prepareF, restoreF) |
|
SpiSetLoopBackMode ( spiId, unsigned char lbEn) |
|
UartInit ( id, const WifiIotUartAttribute param, const extraAttr) |
|
UartRead ( id, unsigned char data, unsigned int dataLen) |
|
UartWrite ( id, const unsigned char data, unsigned int dataLen) |
|
UartDeinit ( id) |
|
UartSetFlowCtrl ( id, WifiIotFlowCtrl flowCtrl) |
|
(WifiIotUartIdx id, unsigned char empty) |
|
(WifiIotUartIdx id, const unsigned char data, unsigned int dataLen) |
|
(WifiIotUartIdx id, attr, WifiIotUartExtraAttr extraAttr) |
|
(WifiIotUartIdx id, unsigned char busy) |
|
WatchDogKick (void) |
|
Details
Macro Definition Documentation
WIFI_IOT_ERR_ADC_INVALID_CHANNEL_ID
Description:
WIFI_IOT_ERR_ADC_NOT_INIT
Description:
Defines an ADC error code to indicate non-initialization.
WIFI_IOT_ERR_ADC_PARAMETER_WRONG
#define WIFI_IOT_ERR_ADC_PARAMETER_WRONG 0x80001300
Description:
Defines an ADC error code to indicate a parameter error.
WIFI_IOT_ERR_ADC_TIMEOUT
#define WIFI_IOT_ERR_ADC_TIMEOUT 0x80001302
Description:
Defines an ADC error code to indicate a timeout.
WIFI_IOT_ERR_AT_INVALID_PARAMETER
#define WIFI_IOT_ERR_AT_INVALID_PARAMETER 0x80003281
Description:
Defines an AT error code to indicate an invalid parameter.
WIFI_IOT_ERR_AT_NAME_OR_FUNC_REPEAT_REGISTERED
#define WIFI_IOT_ERR_AT_NAME_OR_FUNC_REPEAT_REGISTERED 0x80003280
Description:
Defines an AT error code to indicate repeated function registration.
WIFI_IOT_ERR_DMA_BUSY
#define WIFI_IOT_ERR_DMA_BUSY 0x80001382
Description:
Defines a DMA error code to indicate the busy state.
WIFI_IOT_ERR_DMA_CH_IRQ_ENABLE_FAIL
#define WIFI_IOT_ERR_DMA_CH_IRQ_ENABLE_FAIL 0x80001387
Description:
Defines a DMA error code to indicate a failure in enabling channel interrupt.
WIFI_IOT_ERR_DMA_GET_NOTE_FAIL
#define WIFI_IOT_ERR_DMA_GET_NOTE_FAIL 0x80001385
Description:
Defines a DMA error code to indicate a retrieval failure.
WIFI_IOT_ERR_DMA_INVALID_PARA
#define WIFI_IOT_ERR_DMA_INVALID_PARA 0x80001380
Description:
Defines a DMA error code to indicate an invalid parameter.
WIFI_IOT_ERR_DMA_LLI_NOT_CREATE
#define WIFI_IOT_ERR_DMA_LLI_NOT_CREATE 0x80001386
Description:
Defines a DMA error code to indicate that the LLI is not created.
WIFI_IOT_ERR_DMA_NOT_INIT
#define WIFI_IOT_ERR_DMA_NOT_INIT 0x80001381
Description:
Defines a DMA error code to indicate non-initialization.
WIFI_IOT_ERR_DMA_TRANSFER_FAIL
#define WIFI_IOT_ERR_DMA_TRANSFER_FAIL 0x80001383
Description:
Defines a DMA error code to indicate a transmission failure.
WIFI_IOT_ERR_DMA_TRANSFER_TIMEOUT
#define WIFI_IOT_ERR_DMA_TRANSFER_TIMEOUT 0x80001384
Description:
Defines a DMA error code to indicate a transmission timeout.
WIFI_IOT_ERR_FLASH_CRYPTO_BEYOND_ADDR_SIZE
#define WIFI_IOT_ERR_FLASH_CRYPTO_BEYOND_ADDR_SIZE 0x800010F1
Description:
Defines a flash error code to indicate that the address is out of range.
WIFI_IOT_ERR_FLASH_CRYPTO_DATA_DECRYPT_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_DATA_DECRYPT_ERR 0x800001F4
Description:
Defines a flash error code to indicate a decryption error.
WIFI_IOT_ERR_FLASH_CRYPTO_DATA_ENCRYPT_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_DATA_ENCRYPT_ERR 0x800001F3
Description:
Defines a flash error code to indicate an encryption error.
WIFI_IOT_ERR_FLASH_CRYPTO_INVALID_PARAM
#define WIFI_IOT_ERR_FLASH_CRYPTO_INVALID_PARAM 0x800010F0
Description:
Defines a flash error code to indicate an invalid parameter.
WIFI_IOT_ERR_FLASH_CRYPTO_KERNEL_ADDR_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_KERNEL_ADDR_ERR 0x800001FB
Description:
Defines a flash error code to indicate an incorrect kernel address..
WIFI_IOT_ERR_FLASH_CRYPTO_KEY_EMPTY_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_KEY_EMPTY_ERR 0x800001F5
Description:
Defines a flash error code to indicate an empty key value.
WIFI_IOT_ERR_FLASH_CRYPTO_KEY_INVALID_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_KEY_INVALID_ERR 0x800001F9
Description:
Defines a flash error code to indicate an invalid key.
WIFI_IOT_ERR_FLASH_CRYPTO_KEY_SAVE_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_KEY_SAVE_ERR 0x800001FA
Description:
Defines a flash error code to indicate a failure in saving the key.
WIFI_IOT_ERR_FLASH_CRYPTO_MALLOC_FAIL
#define WIFI_IOT_ERR_FLASH_CRYPTO_MALLOC_FAIL 0x800001F2
Description:
Defines a flash error code to indicate a failure in applying for memory.
WIFI_IOT_ERR_FLASH_CRYPTO_MEMCPY_FAIL
#define WIFI_IOT_ERR_FLASH_CRYPTO_MEMCPY_FAIL 0x800001F6
Description:
Defines a flash error code to indicate a copy failure.
WIFI_IOT_ERR_FLASH_CRYPTO_NOT_SUPPORT
#define WIFI_IOT_ERR_FLASH_CRYPTO_NOT_SUPPORT 0x800001F7
Description:
Defines a flash error code to indicate a non-support for encryption.
WIFI_IOT_ERR_FLASH_CRYPTO_PREPARE_ERR
#define WIFI_IOT_ERR_FLASH_CRYPTO_PREPARE_ERR 0x800001F8
Description:
Defines a flash error code to indicate an incorrect parameter during encryption.
WIFI_IOT_ERR_FLASH_ERASE_NOT_4K_ALIGN
#define WIFI_IOT_ERR_FLASH_ERASE_NOT_4K_ALIGN 0x800010DB
Description:
Defines a flash error code to indicate that the size of data to erase is not a multiple of 4K bytes.
WIFI_IOT_ERR_FLASH_INITILIZATION
#define WIFI_IOT_ERR_FLASH_INITILIZATION 0x800010DA
Description:
Defines a flash error code to indicate initialization.
WIFI_IOT_ERR_FLASH_INVALID_CHIP_ID
#define WIFI_IOT_ERR_FLASH_INVALID_CHIP_ID 0x800010D4
Description:
Defines a flash error code to indicate an invalid chip ID.
WIFI_IOT_ERR_FLASH_INVALID_PARAM
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM 0x800010C1
Description:
Defines a flash error code to indicate an invalid parameter.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_BEYOND_ADDR
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_BEYOND_ADDR 0x800010C2
Description:
Defines a flash error code to indicate that the address is out of range.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_DATA_NULL
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_DATA_NULL 0x800010C6
Description:
Defines a flash error code to indicate empty data.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_ERASE_NOT_ALIGN
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_ERASE_NOT_ALIGN 0x800010C4
Description:
Defines a flash error code to indicate that the erase size is not aligned.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_IOCTRL_DATA_NULL
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_IOCTRL_DATA_NULL 0x800010C5
Description:
Defines a flash error code to indicate that the data of the I/O controller is empty.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD1
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD1 0x800010C7
Description:
Defines a flash error code to indicate that pad1 is incorrect.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD2
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD2 0x800010C8
Description:
Defines a flash error code to indicate that pad2 is incorrect.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD3
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD3 0x800010C9
Description:
Defines a flash error code to indicate that pad3 is incorrect.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD4
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_PAD4 0x800010CA
Description:
Defines a flash error code to indicate that pad4 is incorrect.
WIFI_IOT_ERR_FLASH_INVALID_PARAM_SIZE_ZERO
#define WIFI_IOT_ERR_FLASH_INVALID_PARAM_SIZE_ZERO 0x800010C3
Description:
Defines a flash error code to indicate that the parameter size is 0
WIFI_IOT_ERR_FLASH_MAX_SPI_OP
#define WIFI_IOT_ERR_FLASH_MAX_SPI_OP 0x800010D2
Description:
Defines a flash error code to indicate the maximum value of the SPI operation.
WIFI_IOT_ERR_FLASH_NO_MATCH_ERASE_SIZE
#define WIFI_IOT_ERR_FLASH_NO_MATCH_ERASE_SIZE 0x800010D1
Description:
Defines a flash error code to indicate a mismatch in the size of data to erase.
WIFI_IOT_ERR_FLASH_NO_MATCH_FLASH
#define WIFI_IOT_ERR_FLASH_NO_MATCH_FLASH 0x800010CF
Description:
Defines a flash error code to indicate a flash mismatch.
WIFI_IOT_ERR_FLASH_NOT_INIT
#define WIFI_IOT_ERR_FLASH_NOT_INIT 0x800010C0
Description:
Defines a flash error code to indicate non-initialization.
WIFI_IOT_ERR_FLASH_NOT_SUPPORT_IOCTRL_ID
#define WIFI_IOT_ERR_FLASH_NOT_SUPPORT_IOCTRL_ID 0x800010D3
Description:
Defines a flash error code to indicate an unsupported IO controller ID..
WIFI_IOT_ERR_FLASH_PATITION_INIT_FAIL
#define WIFI_IOT_ERR_FLASH_PATITION_INIT_FAIL 0x800010D9
Description:
Defines a flash error code to indicate a partition initialization failure.
WIFI_IOT_ERR_FLASH_PROTECT_NOT_FIND_CHIP
#define WIFI_IOT_ERR_FLASH_PROTECT_NOT_FIND_CHIP 0x800010DF
Description:
Defines a flash error code to indicate that no chip is found.
WIFI_IOT_ERR_FLASH_PROTECT_NOT_INIT
#define WIFI_IOT_ERR_FLASH_PROTECT_NOT_INIT 0x800010DD
Description:
Defines a flash error code to indicate non-initialization.
WIFI_IOT_ERR_FLASH_PROTECT_NOT_SUPPORT
#define WIFI_IOT_ERR_FLASH_PROTECT_NOT_SUPPORT 0x800010DC
Description:
Defines a flash error code to indicate a non-support.
WIFI_IOT_ERR_FLASH_PROTECT_RE_INIT
#define WIFI_IOT_ERR_FLASH_PROTECT_RE_INIT 0x800010DE
Description:
Defines a flash error code to indicate repeated initialization.
WIFI_IOT_ERR_FLASH_QUAD_MODE_COMPARE_REG
#define WIFI_IOT_ERR_FLASH_QUAD_MODE_COMPARE_REG 0x800010CE
Description:
Defines a flash error code to indicate that an error occurs when comparing registers.
WIFI_IOT_ERR_FLASH_QUAD_MODE_READ_REG1
#define WIFI_IOT_ERR_FLASH_QUAD_MODE_READ_REG1 0x800010CC
Description:
Defines a flash error code to indicate that an error occurs when reading register 1.
WIFI_IOT_ERR_FLASH_QUAD_MODE_READ_REG2
#define WIFI_IOT_ERR_FLASH_QUAD_MODE_READ_REG2 0x800010CD
Description:
Defines a flash error code to indicate that an error occurs when reading register 2.
WIFI_IOT_ERR_FLASH_RE_INIT
#define WIFI_IOT_ERR_FLASH_RE_INIT 0x800010D5
Description:
Defines a flash error code to indicate repeated initialization.
WIFI_IOT_ERR_FLASH_TIME_OUT_WAIT_READY
#define WIFI_IOT_ERR_FLASH_TIME_OUT_WAIT_READY 0x800010CB
Description:
Defines a flash error code to indicate a timeout on waiting for ready.
WIFI_IOT_ERR_FLASH_WAIT_CFG_START_TIME_OUT
#define WIFI_IOT_ERR_FLASH_WAIT_CFG_START_TIME_OUT 0x800010D8
Description:
Defines a flash error code to indicate a timeout on waiting for a configuration to start.
WIFI_IOT_ERR_FLASH_WRITE_COMPARE_WRONG
#define WIFI_IOT_ERR_FLASH_WRITE_COMPARE_WRONG 0x800010D7
Description:
Defines a flash error code to indicate that an error occurs when comparing the data written.
WIFI_IOT_ERR_FLASH_WRITE_ENABLE
#define WIFI_IOT_ERR_FLASH_WRITE_ENABLE 0x800010D0
Description:
Defines a flash error code to indicate a failure in enabling write.
WIFI_IOT_ERR_FLASH_WRITE_NOT_SUPPORT_ERASE
#define WIFI_IOT_ERR_FLASH_WRITE_NOT_SUPPORT_ERASE 0x800010D6
Description:
Defines a flash error code to indicate a non-support for data erasure.
WIFI_IOT_ERR_GPIO_INVALID_PARAMETER
#define WIFI_IOT_ERR_GPIO_INVALID_PARAMETER 0x80001040
Description:
Defines a GPIO error code to indicate an invalid parameter.
WIFI_IOT_ERR_GPIO_NOT_INIT
#define WIFI_IOT_ERR_GPIO_NOT_INIT 0x80001042
Description:
Defines a GPIO error code to indicate non-initialization.
WIFI_IOT_ERR_GPIO_NOT_SUPPORT
#define WIFI_IOT_ERR_GPIO_NOT_SUPPORT 0x80001043
Description:
Defines a GPIO error code to indicate a non-support.
WIFI_IOT_ERR_GPIO_REPEAT_INIT
#define WIFI_IOT_ERR_GPIO_REPEAT_INIT 0x80001041
Description:
Defines a GPIO error code to indicate repeated initialization.
WIFI_IOT_ERR_I2C_INVALID_PARAMETER
#define WIFI_IOT_ERR_I2C_INVALID_PARAMETER 0x80001181
Description:
Defines an I2C error code to indicate an invalid parameter.
WIFI_IOT_ERR_I2C_NOT_INIT
#define WIFI_IOT_ERR_I2C_NOT_INIT 0x80001180
Description:
Defines an I2C error code to indicate a non-support.
WIFI_IOT_ERR_I2C_START_ACK_ERR
#define WIFI_IOT_ERR_I2C_START_ACK_ERR 0x80001188
Description:
Defines an I2C error code to indicate a responding failure.
WIFI_IOT_ERR_I2C_TIMEOUT_RCV_BYTE
#define WIFI_IOT_ERR_I2C_TIMEOUT_RCV_BYTE 0x80001185
Description:
Defines an I2C error code to indicate a receive timeout.
WIFI_IOT_ERR_I2C_TIMEOUT_RCV_BYTE_PROC
#define WIFI_IOT_ERR_I2C_TIMEOUT_RCV_BYTE_PROC 0x80001186
Description:
Defines an I2C error code to indicate a processing timeout.
WIFI_IOT_ERR_I2C_TIMEOUT_START
#define WIFI_IOT_ERR_I2C_TIMEOUT_START 0x80001182
Description:
Defines an I2C error code to indicate a start timeout.
WIFI_IOT_ERR_I2C_TIMEOUT_STOP
#define WIFI_IOT_ERR_I2C_TIMEOUT_STOP 0x80001184
Description:
Defines an I2C error code to indicate a stop timeout.
WIFI_IOT_ERR_I2C_TIMEOUT_WAIT
#define WIFI_IOT_ERR_I2C_TIMEOUT_WAIT 0x80001183
Description:
Defines an I2C error code to indicate a wait timeout.
WIFI_IOT_ERR_I2C_WAIT_ACK_ERR
#define WIFI_IOT_ERR_I2C_WAIT_ACK_ERR 0x80001189
Description:
Defines an I2C error code to indicate a failure in waiting for a response.
WIFI_IOT_ERR_I2C_WAIT_SEM_FAIL
#define WIFI_IOT_ERR_I2C_WAIT_SEM_FAIL 0x80001187
Description:
Defines an I2C error code to indicate a waiting failure.
WIFI_IOT_ERR_I2S_INVALID_PARAMETER
Description:
Defines an I2S error code to indicate an invalid parameter.
#define WIFI_IOT_ERR_I2S_WRITE_TIMEOUT 0x80001401
Description:
Defines an I2S error code to indicate a write timeout.
WIFI_IOT_ERR_PWM_INITILIZATION_ALREADY
#define WIFI_IOT_ERR_PWM_INITILIZATION_ALREADY 0x80001341
Description:
Defines a PWM error code to indicate an initialization error.
WIFI_IOT_ERR_PWM_INVALID_PARAMETER
#define WIFI_IOT_ERR_PWM_INVALID_PARAMETER 0x80001342
Description:
Defines a PWM error code to indicate an invalid parameter.
WIFI_IOT_ERR_PWM_NO_INIT
#define WIFI_IOT_ERR_PWM_NO_INIT 0x80001340
Description:
Defines a PWM error code to indicate non-initialization.
WIFI_IOT_ERR_SDIO_INVALID_PARAMETER
#define WIFI_IOT_ERR_SDIO_INVALID_PARAMETER 0x80001280
Description:
Defines an SDIO error code to indicate an invalid parameter.
WIFI_IOT_ERR_SPI_BUSY
#define WIFI_IOT_ERR_SPI_BUSY 0x800011C3
Description:
Defines an SPI error code to indicate the busy state.
WIFI_IOT_ERR_SPI_NOT_INIT
Description:
Defines an SPI error code to indicate non-initialization.
WIFI_IOT_ERR_SPI_NOT_SUPPORT_DMA
Description:
Defines an SPI error code to indicate a non-support for DMA.
WIFI_IOT_ERR_SPI_PARAMETER_WRONG
#define WIFI_IOT_ERR_SPI_PARAMETER_WRONG 0x800011C2
Description:
Defines an SPI error code to indicate a parameter error.
WIFI_IOT_ERR_SPI_READ_TIMEOUT
#define WIFI_IOT_ERR_SPI_READ_TIMEOUT 0x800011C5
Description:
Defines an SPI error code to indicate a read timeout.
WIFI_IOT_ERR_SPI_REINIT
#define WIFI_IOT_ERR_SPI_REINIT 0x800011C1
Description:
Defines an SPI error code to indicate repeated initialization.
WIFI_IOT_ERR_SPI_WRITE_TIMEOUT
#define WIFI_IOT_ERR_SPI_WRITE_TIMEOUT 0x800011C4
Description:
Defines an SPI error code to indicate a write timeout.
WIFI_IOT_ERR_UART_INVALID_BAUD
#define WIFI_IOT_ERR_UART_INVALID_BAUD 0x80001005
Description:
Defines a UART error code to indicate an invalid baud rate.
WIFI_IOT_ERR_UART_INVALID_COM_PORT
#define WIFI_IOT_ERR_UART_INVALID_COM_PORT 0x80001006
Description:
Defines a UART error code to indicate an invalid port number.
WIFI_IOT_ERR_UART_INVALID_DATA_BITS
#define WIFI_IOT_ERR_UART_INVALID_DATA_BITS 0x80001003
Description:
Defines a UART error code to indicate an invalid data bit.
WIFI_IOT_ERR_UART_INVALID_PARAMETER
#define WIFI_IOT_ERR_UART_INVALID_PARAMETER 0x80001000
Description:
Defines a UART error code to indicate an invalid parameter.
WIFI_IOT_ERR_UART_INVALID_PARITY
#define WIFI_IOT_ERR_UART_INVALID_PARITY 0x80001002
Description:
Defines a UART error code to indicate an invalid parity check.
WIFI_IOT_ERR_UART_INVALID_STOP_BITS
#define WIFI_IOT_ERR_UART_INVALID_STOP_BITS 0x80001004
Description:
Defines a UART error code to indicate an invalid stop bit.
WIFI_IOT_ERR_UART_INVALID_SUSPEND
#define WIFI_IOT_ERR_UART_INVALID_SUSPEND 0x80001001
Description:
Defines a UART error code to indicate an invalid pause operation.
WIFI_IOT_ERR_UART_NOT_BLOCK_MODE
#define WIFI_IOT_ERR_UART_NOT_BLOCK_MODE 0x80001008
Description:
Defines a UART error code to indicate the non-block mode.
WIFI_IOT_ERR_UART_NOT_SUPPORT_DMA
#define WIFI_IOT_ERR_UART_NOT_SUPPORT_DMA 0x80001007
Description:
Defines a UART error code to indicate a non-support for DMA.
WIFI_IOT_FAILURE
#define WIFI_IOT_FAILURE (-1)
Description:
Defines a module-level return value to indicate an operation failure.
WIFI_IOT_SUCCESS
#define WIFI_IOT_SUCCESS 0
Description:
Defines a module-level return value to indicate a successful operation.
Typedef Documentation
GpioIsrCallbackFunc
typedef void(* GpioIsrCallbackFunc) (char *arg)
Description:
Indicates the GPIO interrupt callback.
I2cPrepareFunc
typedef void(* I2cPrepareFunc) (void)
Description:
Indicates the callback invoked for device preparation.
I2CResetFunc
typedef void(* I2CResetFunc) (void)
Description:
Indicates the callback invoked when a device exception occurs.
I2cRestoreFunc
typedef void(* I2cRestoreFunc) (void)
Description:
Indicates the callback invoked for device recovery.
TickIdleKalCallback
typedef void(* TickIdleKalCallback) (void)
Description:
Indicates the idle task and CPU tick callbacks.
Enumeration Type Documentation
WifiiIotIoFuncGpio1
enum [WifiiIotIoFuncGpio1]($api-api-LinkIoT-Wifiiot.md#gae9c6ae0f852d8701036823a6223adf7e)
Description:
Enumerates the functions of GPIO hardware pin 1.
| WIFI_IOT_IO_FUNC_GPIO_1_GPIO |
WifiIotAdcChannelIndex
enum [WifiIotAdcChannelIndex]($api-api-LinkIoT-Wifiiot.md#ga4c8b663163c7b23071914947a2bca73b)
Description:
Enumerates ADC channel indexes.
WifiIotAdcCurBais
enum [WifiIotAdcCurBais]($api-api-LinkIoT-Wifiiot.md#gaac161eb7075f815f6d39a63615bfa82d)
Description:
Enumerates analog power control modes.
| WIFI_IOT_ADC_CUR_BAIS_DEFAULT | |
| WIFI_IOT_ADC_CUR_BAIS_AUTO | |
| WIFI_IOT_ADC_CUR_BAIS_1P8V | |
| WIFI_IOT_ADC_CUR_BAIS_3P3V | |
| WIFI_IOT_ADC_CUR_BAIS_BUTT |
WifiIotAdcEquModelSel
enum [WifiIotAdcEquModelSel]($api-api-LinkIoT-Wifiiot.md#gafb9992ebf1655f994dc56883c8fe4b2e)
Description:
Enumerates equation models.
| WIFI_IOT_ADC_EQU_MODEL_1 | |
| WIFI_IOT_ADC_EQU_MODEL_2 | |
| WIFI_IOT_ADC_EQU_MODEL_4 | |
| WIFI_IOT_ADC_EQU_MODEL_8 | |
| WIFI_IOT_ADC_EQU_MODEL_BUTT |
WifiIotFlashPartitionTableId
enum [WifiIotFlashPartitionTableId]($api-api-LinkIoT-Wifiiot.md#ga2f287bbb40987fe6d1d7fa525574c00c)
Description:
Indicates the partition table ID.
WifiIotFlowCtrl
enum [WifiIotFlowCtrl]($api-api-LinkIoT-Wifiiot.md#gacf7ec5d973706e8239c7c6e4a470d8ab)
Description:
Enumerates hardware flow control modes.
| WIFI_IOT_FLOW_CTRL_NONE | |
| WIFI_IOT_FLOW_CTRL_RTS_CTS | |
| WIFI_IOT_FLOW_CTRL_RTS_ONLY | |
| WIFI_IOT_FLOW_CTRL_CTS_ONLY |
WifiIotGpioDir
enum [WifiIotGpioDir]($api-api-LinkIoT-Wifiiot.md#gab4b1fb50c758d491ba297a65e1c7a70a)
Description:
Enumerates GPIO directions.
| WIFI_IOT_GPIO_DIR_IN | |
| WIFI_IOT_GPIO_DIR_OUT |
WifiIotGpioIdx
enum [WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7)
Description:
Enumerates GPIO pin IDs.
WifiIotGpioIntPolarity
enum [WifiIotGpioIntPolarity]($api-api-LinkIoT-Wifiiot.md#gab81589838cedcc3933bb789c97ad3643)
Description:
Enumerates I/O interrupt polarities.
| WIFI_IOT_GPIO_EDGE_FALL_LEVEL_LOW | |
| WIFI_IOT_GPIO_EDGE_RISE_LEVEL_HIGH |
WifiIotGpioIntType
enum [WifiIotGpioIntType]($api-api-LinkIoT-Wifiiot.md#gac8eb8ad448903ed52c96ccc675e81f94)
Description:
Enumerates GPIO interrupt trigger modes.
| WIFI_IOT_INT_TYPE_LEVEL | |
| WIFI_IOT_INT_TYPE_EDGE |
WifiIotGpioValue
enum [WifiIotGpioValue]($api-api-LinkIoT-Wifiiot.md#gac9095d1db72e5046b2ec1895aaec0e6b)
Description:
Enumerates GPIO level values.
| WIFI_IOT_GPIO_VALUE0 | |
| WIFI_IOT_GPIO_VALUE1 |
WifiIotI2cIdx
enum [WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8)
Description:
Enumerates I2C hardware indexes.
| WIFI_IOT_I2C_IDX_0 | |
| WIFI_IOT_I2C_IDX_1 |
WifiIotI2sResolution
enum [WifiIotI2sResolution]($api-api-LinkIoT-Wifiiot.md#gac024b870d63e802d8119e88a82953807)
Description:
Enumerates I2S resolution.
| WIFI_IOT_I2S_RESOLUTION_16BIT | |
| WIFI_IOT_I2S_RESOLUTION_24BIT |
WifiIotI2sSampleRate
enum [WifiIotI2sSampleRate]($api-api-LinkIoT-Wifiiot.md#ga5e124d70b18cf4cff40bcce78445f689)
Description:
Enumerates I2S sampling rates.
| WIFI_IOT_I2S_SAMPLE_RATE_8K | |
| WIFI_IOT_I2S_SAMPLE_RATE_16K | |
| WIFI_IOT_I2S_SAMPLE_RATE_32K | |
| WIFI_IOT_I2S_SAMPLE_RATE_48K |
WifiIotIoDriverStrength
enum [WifiIotIoDriverStrength]($api-api-LinkIoT-Wifiiot.md#gae97ab4109f511ceeee889dba9e79a968)
Description:
Enumerates I/O driver strength levels.
WifiIotIoFuncGpio0
enum [WifiIotIoFuncGpio0]($api-api-LinkIoT-Wifiiot.md#ga2b08eb2a302e2c4fa216a1373bea4a01)
Description:
Enumerates the functions of GPIO hardware pin 0.
| WIFI_IOT_IO_FUNC_GPIO_0_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_0_UART1_TXD | |
| WIFI_IOT_IO_FUNC_GPIO_0_SPI1_CK | |
| WIFI_IOT_IO_FUNC_GPIO_0_JTAG_TDO | |
| WIFI_IOT_IO_FUNC_GPIO_0_PWM3_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_0_I2C1_SDA |
WifiIotIoFuncGpio10
enum [WifiIotIoFuncGpio10]($api-api-LinkIoT-Wifiiot.md#gad4670688ad729f40424bccfeb1afc3b2)
Description:
Enumerates the functions of GPIO hardware pin 10.
WifiIotIoFuncGpio11
enum [WifiIotIoFuncGpio11]($api-api-LinkIoT-Wifiiot.md#ga5099248aa82355e85ba5a6227f2ab1a7)
Description:
Enumerates the functions of GPIO hardware pin 11.
WifiIotIoFuncGpio12
enum [WifiIotIoFuncGpio12]($api-api-LinkIoT-Wifiiot.md#gaed0008f886fc864d90f6d1c2ae9677a0)
Description:
Enumerates the functions of GPIO hardware pin 12.
WifiIotIoFuncGpio13
enum [WifiIotIoFuncGpio13]($api-api-LinkIoT-Wifiiot.md#ga364b7c7cc88086ad40c4c3d2dd098648)
Description:
Enumerates the functions of GPIO hardware pin 13.
WifiIotIoFuncGpio14
enum [WifiIotIoFuncGpio14]($api-api-LinkIoT-Wifiiot.md#gafcf6d4cb0113b803d834bac89af8d9b8)
Description:
Enumerates the functions of GPIO hardware pin 14.
WifiIotIoFuncGpio2
enum [WifiIotIoFuncGpio2]($api-api-LinkIoT-Wifiiot.md#gac9d0974184776d35ca9b0f73829f317b)
Description:
Enumerates the functions of GPIO hardware pin 2.
| WIFI_IOT_IO_FUNC_GPIO_2_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_2_UART1_RTS_N | |
| WIFI_IOT_IO_FUNC_GPIO_2_SPI1_TXD | |
| WIFI_IOT_IO_FUNC_GPIO_2_JTAG_TRSTN | |
| WIFI_IOT_IO_FUNC_GPIO_2_PWM2_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_2_SSI_CLK |
WifiIotIoFuncGpio3
enum [WifiIotIoFuncGpio3]($api-api-LinkIoT-Wifiiot.md#gaca745c98fc2ef9994e67444c9aa53db8)
Description:
Enumerates the functions of GPIO hardware pin 3.
WifiIotIoFuncGpio4
enum [WifiIotIoFuncGpio4]($api-api-LinkIoT-Wifiiot.md#ga70218b6740d703737739ce4372e2f1e2)
Description:
Enumerates the functions of GPIO hardware pin 4.
| WIFI_IOT_IO_FUNC_GPIO_4_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_4_UART0_RXD | |
| WIFI_IOT_IO_FUNC_GPIO_4_JTAG_TMS | |
| WIFI_IOT_IO_FUNC_GPIO_4_PWM1_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_4_I2C1_SCL |
WifiIotIoFuncGpio5
enum [WifiIotIoFuncGpio5]($api-api-LinkIoT-Wifiiot.md#ga6cbed71f3a94f8e7513c4b91ae1e54ce)
Description:
Enumerates the functions of GPIO hardware pin 5.
| WIFI_IOT_IO_FUNC_GPIO_5_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_5_UART1_RXD | |
| WIFI_IOT_IO_FUNC_GPIO_5_SPI0_CSN | |
| WIFI_IOT_IO_FUNC_GPIO_5_PWM2_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_5_I2S0_MCLK | |
| WIFI_IOT_IO_FUNC_GPIO_5_BT_STATUS |
WifiIotIoFuncGpio6
enum [WifiIotIoFuncGpio6]($api-api-LinkIoT-Wifiiot.md#ga42008386d7791b97dbfa1fa6b6c4dc1d)
Description:
Enumerates the functions of GPIO hardware pin 6.
| WIFI_IOT_IO_FUNC_GPIO_6_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_6_UART1_TXD | |
| WIFI_IOT_IO_FUNC_GPIO_6_SPI0_CK | |
| WIFI_IOT_IO_FUNC_GPIO_6_PWM3_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_6_I2S0_TX | |
| WIFI_IOT_IO_FUNC_GPIO_6_COEX_SWITCH |
WifiIotIoFuncGpio7
enum [WifiIotIoFuncGpio7]($api-api-LinkIoT-Wifiiot.md#gac66dc390f39e0933c051790b20552b7c)
Description:
Enumerates the functions of GPIO hardware pin 7.
| WIFI_IOT_IO_FUNC_GPIO_7_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_7_UART1_CTS_N | |
| WIFI_IOT_IO_FUNC_GPIO_7_SPI0_RXD | |
| WIFI_IOT_IO_FUNC_GPIO_7_PWM0_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_7_I2S0_BCLK | |
| WIFI_IOT_IO_FUNC_GPIO_7_BT_ACTIVE |
WifiIotIoFuncGpio8
enum [WifiIotIoFuncGpio8]($api-api-LinkIoT-Wifiiot.md#gae63cd3d5c677fac3b01a3c67e8faf0fb)
Description:
Enumerates the functions of GPIO hardware pin 8.
| WIFI_IOT_IO_FUNC_GPIO_8_GPIO | |
| WIFI_IOT_IO_FUNC_GPIO_8_UART1_RTS_N | |
| WIFI_IOT_IO_FUNC_GPIO_8_SPI0_TXD | |
| WIFI_IOT_IO_FUNC_GPIO_8_PWM1_OUT | |
| WIFI_IOT_IO_FUNC_GPIO_8_I2S0_WS | |
| WIFI_IOT_IO_FUNC_GPIO_8_WLAN_ACTIVE |
WifiIotIoFuncGpio9
enum [WifiIotIoFuncGpio9]($api-api-LinkIoT-Wifiiot.md#ga641da9889bd5a8a758e1a4eb2a5a19e4)
Description:
Enumerates the functions of GPIO hardware pin 9.
WifiIotIoName
enum [WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415)
Description:
Enumerates GPIO hardware pin IDs.
WifiIotIoPull
enum [WifiIotIoPull]($api-api-LinkIoT-Wifiiot.md#gacc20a5c6456ec381ed931232c29d1c4f)
Description:
Enumerates GPIO pull-up or pull-down settings.
| WIFI_IOT_IO_PULL_NONE | |
| WIFI_IOT_IO_PULL_UP | |
| WIFI_IOT_IO_PULL_DOWN | |
| WIFI_IOT_IO_PULL_MAX |
WifiIotPwmClkSource
enum [WifiIotPwmClkSource]($api-api-LinkIoT-Wifiiot.md#ga2ecbd0ab9636fedd354de7447056df29)
Description:
Enumerates PWM clock sources.
| WIFI_IOT_PWM_CLK_160M | |
| WIFI_IOT_PWM_CLK_XTAL | |
| WIFI_IOT_PWM_CLK_MAX |
WifiIotPwmPort
enum [WifiIotPwmPort]($api-api-LinkIoT-Wifiiot.md#gab3518ce878df4a40d614e88a6f81dea7)
Description:
Enumerates PWM ports.
| WIFI_IOT_PWM_PORT_PWM0 | |
| WIFI_IOT_PWM_PORT_PWM1 | |
| WIFI_IOT_PWM_PORT_PWM2 | |
| WIFI_IOT_PWM_PORT_PWM3 | |
| WIFI_IOT_PWM_PORT_PWM4 | |
| WIFI_IOT_PWM_PORT_PWM5 | |
| WIFI_IOT_PWM_PORT_MAX |
WifiIotSpiCfgClockCpha
enum [WifiIotSpiCfgClockCpha]($api-api-LinkIoT-Wifiiot.md#ga1eb13cffbbdec9da1d57c766763b94e5)
Description:
Enumerates communication phases.
| WIFI_IOT_SPI_CFG_CLOCK_CPHA_0 | |
| WIFI_IOT_SPI_CFG_CLOCK_CPHA_1 |
WifiIotSpiCfgClockCpol
enum [WifiIotSpiCfgClockCpol]($api-api-LinkIoT-Wifiiot.md#gad6674c8b0989b6a329d5fd5ff0d5d750)
Description:
Enumerates communication polarities.
| WIFI_IOT_SPI_CFG_CLOCK_CPOL_0 | |
| WIFI_IOT_SPI_CFG_CLOCK_CPOL_1 |
WifiIotSpiCfgDataWidth
enum [WifiIotSpiCfgDataWidth]($api-api-LinkIoT-Wifiiot.md#ga6f2e44db2698c33b81bd6caa438a55ea)
Description:
Enumerates the communication data width, that is, the number of valid bits in each frame.
WifiIotSpiCfgEndian
enum [WifiIotSpiCfgEndian]($api-api-LinkIoT-Wifiiot.md#ga31924085df23a024413fa6e63e13c41e)
Description:
Enumerates the endian mode of each frame.
| WIFI_IOT_SPI_CFG_ENDIAN_LITTLE | |
| WIFI_IOT_SPI_CFG_ENDIAN_BIG |
WifiIotSpiCfgFramMode
enum [WifiIotSpiCfgFramMode]($api-api-LinkIoT-Wifiiot.md#gaef7c192e049db14e2326c0bfba181670)
Description:
Enumerates communication protocols.
| WIFI_IOT_SPI_CFG_FRAM_MODE_MOTOROLA | |
| WIFI_IOT_SPI_CFG_FRAM_MODE_TI | |
| WIFI_IOT_SPI_CFG_FRAM_MODE_MICROWIRE |
WifiIotSpiIdx
enum [WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b)
Description:
Enumerates SPI channel IDs.
| WIFI_IOT_SPI_ID_0 | |
| WIFI_IOT_SPI_ID_1 |
WifiIotUartBlockState
enum [WifiIotUartBlockState]($api-api-LinkIoT-Wifiiot.md#ga93f35a58dc54e29d4892d1e94179c72d)
Description:
Enumerates UART block states.
| WIFI_IOT_UART_BLOCK_STATE_NONE_BLOCK | |
| WIFI_IOT_UART_BLOCK_STATE_BLOCK |
WifiIotUartDmaState
enum [WifiIotUartDmaState]($api-api-LinkIoT-Wifiiot.md#gaf36ed6a640d85e79dfee020131e0d86f)
Description:
Enumerates UART DMA states.
| WIFI_IOT_UART_NONE_DMA | |
| WIFI_IOT_UART_USE_DMA |
WifiIotUartFifoLine
enum [WifiIotUartFifoLine]($api-api-LinkIoT-Wifiiot.md#ga1c15f86994b472d35bee5d6b57d42a49)
Description:
Enumerates UART FIFO interrupt thresholds.
| WIFI_IOT_FIFO_LINE_ONE_EIGHT | |
| WIFI_IOT_FIFO_LINE_ONE_QUARTER | |
| WIFI_IOT_FIFO_LINE_HALF | |
| WIFI_IOT_FIFO_LINE_THREE_QUARTERS | |
| WIFI_IOT_FIFO_LINE_SEVEN_EIGHTS |
WifiIotUartIdx
enum [WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44)
Description:
Enumerates the UART serial number.
| WIFI_IOT_UART_IDX_0 | |
| WIFI_IOT_UART_IDX_1 | |
| WIFI_IOT_UART_IDX_2 | |
| WIFI_IOT_UART_IDX_MAX |
WifiIotUartIdxDataBit
enum [WifiIotUartIdxDataBit]($api-api-LinkIoT-Wifiiot.md#gafdf1adfc0e0ed18282aa3006300b12b4)
Description:
Enumerates the number of UART data bits.
| WIFI_IOT_UART_DATA_BIT_5 | |
| WIFI_IOT_UART_DATA_BIT_6 | |
| WIFI_IOT_UART_DATA_BIT_7 | |
| WIFI_IOT_UART_DATA_BIT_8 |
WifiIotUartParity
enum [WifiIotUartParity]($api-api-LinkIoT-Wifiiot.md#ga9cee98ab295d2e42ab7f0fb614268602)
Description:
Enumerates the UART parity bit.
| WIFI_IOT_UART_PARITY_NONE | |
| WIFI_IOT_UART_PARITY_ODD | |
| WIFI_IOT_UART_PARITY_EVEN |
WifiIotUartStopBit
enum [WifiIotUartStopBit]($api-api-LinkIoT-Wifiiot.md#gab0a1b43e8e98b028717e6557003b3172)
Description:
Enumerates the number of UART stop bits.
| WIFI_IOT_UART_STOP_BIT_1 | |
| WIFI_IOT_UART_STOP_BIT_2 |
Function Documentation
AdcRead()
unsigned int AdcRead ([WifiIotAdcChannelIndex]($api-api-LinkIoT-Wifiiot.md#ga4c8b663163c7b23071914947a2bca73b) channel, unsigned short * data, [WifiIotAdcEquModelSel]($api-api-LinkIoT-Wifiiot.md#gafb9992ebf1655f994dc56883c8fe4b2e) equModel, [WifiIotAdcCurBais]($api-api-LinkIoT-Wifiiot.md#gaac161eb7075f815f6d39a63615bfa82d) curBais, unsigned short rstCnt )
Description:
Reads a piece of sampled data from a specified ADC channel based on the input parameters.
Parameters:
| channel | Indicates the ADC channel index. |
| data | Indicates the pointer to the address for storing the read data. |
| equModel | Indicates the equation model. |
| curBais | Indicates the analog power control mode. |
| rstCnt | Indicates the count of the time from reset to conversion start. One count is equal to 334 ns. The value must range from 0 to 0xFF0. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
AtCheckUartBusy()
void AtCheckUartBusy (unsigned char enable)
Description:
Sets whether to check the UART busy status during low-power voting.
This function determines whether to check the UART status before the device enters the low-power mode. If enable is set to 1 and the UART is found to be busy, the device does not enter the low-power mode. In other scenarios, the device enters the low-power mode.
Parameters:
| enable | Specifies whether to check the UART busy status. The value 1 means to check the UART busy status, and 0 means not to check the busy status. |
AtInit()
unsigned int AtInit (void )
Description:
Initializes an AT command task.
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
AtPrintf()
int AtPrintf (const char * fmt, ... )
Description:
Formats data and outputs it to the AT command terminal.
Parameters:
| fmt | Indicates the pointer to the control character string to format. |
| … | Represents a variable parameter list in the character string format. |
Returns:
Returns the number of bytes (excluding the end character) output to the AT command terminal if the operation is successful; returns -1 otherwise.
AtRegisterCmd()
unsigned int AtRegisterCmd (const [AtCmdTbl]($api-api-LinkIoT-AtCmdTbl.md) * cmdTbl, unsigned short cmdNum )
Description:
Registers a certain number of AT commands.
Parameters:
| cmdTbl | Indicates the command table. |
| cmdNum | Indicates the number of AT commands in the command table. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
AtSysCmdRegister()
void AtSysCmdRegister (void )
Description:
Registers a system AT command.
For example, you can use this function to register the AT+RST command, which is a system AT command used to reset a device.
unsigned int FlashDeinit (void )
Description:
Deinitializes the flash device.
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
FlashErase()
unsigned int FlashErase (const unsigned int flashOffset, const unsigned int size )
Description:
Erases data in a specified flash memory address.
Parameters:
| flashOffset | Indicates the address of the flash memory data to erase. |
| size | Indicates the length of the data to erase, in bytes. The value must be a multiple of 4000 bytes. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
FlashInit()
unsigned int FlashInit (void )
Description:
Initializes the flash device.
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
FlashIoctl()
unsigned int FlashIoctl (unsigned short cmd, char * data )
Description:
Obtains flash information based on a specific command.
Parameters:
Returns:
Returns WIFI_IOT_SUCCESS if the flash information is obtained; returns an error code defined in otherwise.
FlashPartitionInit()
unsigned int FlashPartitionInit (void )
Description:
Initializes a flash partition.
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
FlashRead()
Description:
Reads data from a flash memory address.
This function reads a specified length of data from a specified flash memory address.
Parameters:
| flashOffset | Indicates the address of the flash memory from which data is to read. |
| size | Indicates the length of the data to read. |
| ramData | Indicates the pointer to the RAM for storing the read data. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
FlashWrite()
Description:
Writes data to a flash memory address.
This function writes a specified length of data to a specified flash memory address.
Parameters:
| flashOffset | Indicates the address of the flash memory to which data is to write. |
| size | Indicates the length of the data to write. |
| ramData | Indicates the pointer to the RAM for storing the data to write. |
| doErase | Indicates whether to automatically erase and overwrite the data. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
GetPartitionTable()
[WifiIotFlashPartitionTable]($api-api-LinkIoT-WifiIotFlashPartitionTable.md)* GetPartitionTable (void )
Description:
Obtains a flash partition table.
Returns:
Returns the pointer to the partition table.
GpioDeinit()
unsigned int GpioDeinit (void )
Description:
Deinitializes the GPIO device.
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
GpioGetDir()
unsigned int GpioGetDir ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioDir]($api-api-LinkIoT-Wifiiot.md#gab4b1fb50c758d491ba297a65e1c7a70a) * dir )
Description:
Obtains the direction for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| dir | Indicates the pointer to the GPIO input/output direction. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
GpioGetInputVal()
unsigned int GpioGetInputVal ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioValue]($api-api-LinkIoT-Wifiiot.md#gac9095d1db72e5046b2ec1895aaec0e6b) * val )
Description:
Obtains the input level value of a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| val | Indicates the pointer to the input level value. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
GpioGetOutputVal()
unsigned int GpioGetOutputVal ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioValue]($api-api-LinkIoT-Wifiiot.md#gac9095d1db72e5046b2ec1895aaec0e6b) * val )
Description:
Obtains the output level value of a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| val | Indicates the pointer to the output level value. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
GpioInit()
unsigned int GpioInit (void )
Description:
Initializes the GPIO device.
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
GpioRegisterIsrFunc()
unsigned int GpioRegisterIsrFunc ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioIntType]($api-api-LinkIoT-Wifiiot.md#gac8eb8ad448903ed52c96ccc675e81f94) intType, [WifiIotGpioIntPolarity]($api-api-LinkIoT-Wifiiot.md#gab81589838cedcc3933bb789c97ad3643) intPolarity, [GpioIsrCallbackFunc]($api-api-LinkIoT-Wifiiot.md#ga93120443d8150e18701ce6d3dd290408) func, char * arg )
Description:
Enables the interrupt function for a GPIO pin.
This function can be used to set the interrupt type, interrupt polarity, and interrupt callback for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| intType | Indicates the interrupt type. |
| intPolarity | Indicates the interrupt polarity. |
| func | Indicates the interrupt callback function. |
| arg | Indicates the pointer to the argument used in the interrupt callback function. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
GpioSetDir()
unsigned int GpioSetDir ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioDir]($api-api-LinkIoT-Wifiiot.md#gab4b1fb50c758d491ba297a65e1c7a70a) dir )
Description:
Sets the direction for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| dir | Indicates the GPIO input/output direction. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
GpioSetIsrMask()
unsigned int GpioSetIsrMask ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, unsigned char mask )
Description:
Masks the interrupt function for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| mask | Indicates whether the interrupt function is masked. The value 1 means to mask the interrupt function, and 0 means not to mask the interrupt function. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
GpioSetIsrMode()
unsigned int GpioSetIsrMode ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioIntType]($api-api-LinkIoT-Wifiiot.md#gac8eb8ad448903ed52c96ccc675e81f94) intType, [WifiIotGpioIntPolarity]($api-api-LinkIoT-Wifiiot.md#gab81589838cedcc3933bb789c97ad3643) intPolarity )
Description:
Sets the interrupt trigger mode of a GPIO pin.
This function configures a GPIO pin based on the interrupt type and interrupt polarity.
Parameters:
| id | Indicates the GPIO pin ID. |
| intType | Indicates the interrupt type. |
| intPolarity | Indicates the interrupt polarity. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
GpioSetOutputVal()
unsigned int GpioSetOutputVal ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id, [WifiIotGpioValue]($api-api-LinkIoT-Wifiiot.md#gac9095d1db72e5046b2ec1895aaec0e6b) val )
Description:
Sets the output level value for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
| val | Indicates the output level value. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
GpioUnregisterIsrFunc()
unsigned int GpioUnregisterIsrFunc ([WifiIotGpioIdx]($api-api-LinkIoT-Wifiiot.md#gacb21f234cf149161f1f95f3330eeb8e7) id)
Description:
Disables the interrupt function for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin ID. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2cDeinit()
unsigned int I2cDeinit ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id)
Description:
Deinitializes an I2C device.
Parameters:
| id | Indicates the I2C device ID. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2cInit()
unsigned int I2cInit ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id, unsigned int baudrate )
Description:
Initializes an I2C device with a specified baud rate.
Parameters:
| id | Indicates the I2C device ID. |
| baudrate | Indicates the I2C baud rate. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2cRead()
unsigned int I2cRead ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id, unsigned short deviceAddr, const [WifiIotI2cData]($api-api-LinkIoT-WifiIotI2cData.md) * i2cData )
Description:
Reads data from an I2C device.
The data read will be saved to the address specified by i2cData.
Parameters:
| id | Indicates the I2C device ID. |
| deviceAddr | Indicates the I2C device address. |
| i2cData | Indicates the pointer to the data descriptor to read. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2cRegisterResetBusFunc()
void I2cRegisterResetBusFunc ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id, [WifiIotI2cFunc]($api-api-LinkIoT-WifiIotI2cFunc.md) pfn )
Description:
Registers an I2C callback.
Parameters:
| id | Indicates the I2C device ID. |
| pfn | Indicates the type of the callback to register. |
I2cSetBaudrate()
unsigned int I2cSetBaudrate ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id, unsigned int baudrate )
Description:
Sets the baud rate for an I2C device.
Parameters:
| id | Indicates the I2C device ID. |
| baudrate | Indicates the I2C baud rate to set. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2cWrite()
unsigned int I2cWrite ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id, unsigned short deviceAddr, const [WifiIotI2cData]($api-api-LinkIoT-WifiIotI2cData.md) * i2cData )
Description:
Writes data to an I2C device.
Parameters:
| id | Indicates the I2C device ID. |
| deviceAddr | Indicates the I2C device address. |
| i2cData | Indicates the pointer to the data descriptor to write. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2cWriteread()
unsigned int I2cWriteread ([WifiIotI2cIdx]($api-api-LinkIoT-Wifiiot.md#gaeeb58e02e3783d02e1ed4bad313cc0b8) id, unsigned short deviceAddr, const [WifiIotI2cData]($api-api-LinkIoT-WifiIotI2cData.md) * i2cData )
Description:
Sends data to and receives data responses from an I2C device.
Parameters:
| id | Indicates the I2C device ID. |
| deviceAddr | Indicates the I2C device address. |
| i2cData | Indicates the pointer to the device descriptor of the data to receive. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
I2sDeinit()
unsigned int I2sDeinit (void )
Description:
Deinitializes the I2S device.
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
I2sInit()
unsigned int I2sInit (const [WifiIotI2sAttribute]($api-api-LinkIoT-WifiIotI2sAttribute.md) * i2sAttribute)
Description:
Initializes the I2S device.
Parameters:
| i2sAttribute | Indicates the pointer to the I2S configuration parameter. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
I2sRead()
unsigned int I2sRead (unsigned char * rdData, unsigned int rdLen, unsigned int timeOutMs )
Description:
Reads data from the I2S device.
This function reads data with the length specified by rdLen from an I2S device within the duration specified by timeOutMs.
Parameters:
| rdData | Indicates the pointer to the data to read. |
| rdLen | Indicates the length of the data to read. |
| timeOutMs | Indicates the timeout interval. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
I2sWrite()
unsigned int I2sWrite (unsigned char * wrData, unsigned int wrLen, unsigned int timeOutMs )
Description:
Writes data to the I2S device.
This function writes data with the length specified by wrLen to an I2S device within the duration specified by timeOutMs.
Parameters:
| wrData | Indicates the pointer to the data to write. |
| wrLen | Indicates the length of the data to write. |
| timeOutMs | Indicates the timeout interval. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
IOGetDriverStrength()
unsigned int IOGetDriverStrength ([WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415) id, [WifiIotIoDriverStrength]($api-api-LinkIoT-Wifiiot.md#gae97ab4109f511ceeee889dba9e79a968) * val )
Description:
Obtains the driver strength of a GPIO pin.
Parameters:
| id | Indicates the GPIO pin. |
| val | Indicates the pointer to the address where the I/O driver strength level is to be stored. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
IoGetFunc()
unsigned int IoGetFunc ([WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415) id, unsigned char * val )
Description:
Obtains the multiplexing function for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin. |
| val | Indicates the pointer to the address whether I/O multiplexing function is to be stored. For example, if the value of id is , the value type of val is WifiIotIoFuncGpio0. If the value of id is , the value type of val is WifiIotIoFuncGpio1. The same rule applies to other values. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
IoGetPull()
unsigned int IoGetPull ([WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415) id, [WifiIotIoPull]($api-api-LinkIoT-Wifiiot.md#gacc20a5c6456ec381ed931232c29d1c4f) * val )
Description:
Obtains the pull type of a GPIO pin.
Parameters:
| id | Indicates the GPIO pin. |
| val | Indicates the pointer to the address where the pull type is to be stored. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
IOSetDriverStrength()
unsigned int IOSetDriverStrength ([WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415) id, [WifiIotIoDriverStrength]($api-api-LinkIoT-Wifiiot.md#gae97ab4109f511ceeee889dba9e79a968) val )
Description:
Sets the driver strength of a GPIO pin.
Parameters:
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
IoSetFunc()
unsigned int IoSetFunc ([WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415) id, unsigned char val )
Description:
Sets the multiplexing function for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin. |
| val | Indicates the I/O multiplexing function. For example, if the value of id is WIFI_IOT_IO_NAME_GPIO_0, the value type of val is . If the value of id is WIFI_IOT_IO_NAME_GPIO_1, the value type of val is WifiIotIoFuncGpio1. The same rule applies to other values. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
IoSetPull()
unsigned int IoSetPull ([WifiIotIoName]($api-api-LinkIoT-Wifiiot.md#ga2f42c70f1dd8a04746e30a97b3dfc415) id, [WifiIotIoPull]($api-api-LinkIoT-Wifiiot.md#gacc20a5c6456ec381ed931232c29d1c4f) val )
Description:
Sets the pull for a GPIO pin.
Parameters:
| id | Indicates the GPIO pin. |
| val | Indicates the pull-up or pull-down to set. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
KalThreadRegisterIdleCallback()
void KalThreadRegisterIdleCallback ([TickIdleKalCallback]($api-api-LinkIoT-Wifiiot.md#ga8be54bbf12f538188db10aaaf4bdbdf9) cb)
Description:
Registers the idle task callback.
Parameters:
| cb | Indicates the idle task callback to register. |
KalTickRegisterCallback()
void KalTickRegisterCallback ([TickIdleKalCallback]($api-api-LinkIoT-Wifiiot.md#ga8be54bbf12f538188db10aaaf4bdbdf9) cb)
Description:
Registers the CPU tick callback.
Parameters:
| cb | Indicates the CPU tick callback to register. |
PwmDeinit()
unsigned int PwmDeinit ([WifiIotPwmPort]($api-api-LinkIoT-Wifiiot.md#gab3518ce878df4a40d614e88a6f81dea7) port)
Description:
Deinitializes a PWM device.
Parameters:
| port | Indicates the PWM port number. |
Returns:
Returns if the operation is successful; eturns an error code defined in wifiiot_errno.h otherwise.
PwmInit()
unsigned int PwmInit ([WifiIotPwmPort]($api-api-LinkIoT-Wifiiot.md#gab3518ce878df4a40d614e88a6f81dea7) port)
Description:
Initializes a PWM device.
Parameters:
| port | Indicates the PWM port number. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
PwmStart()
unsigned int PwmStart ([WifiIotPwmPort]($api-api-LinkIoT-Wifiiot.md#gab3518ce878df4a40d614e88a6f81dea7) port, unsigned short duty, unsigned short freq )
Description:
Outputs PWM signals based on the input parameters.
This function outputs PWM signals from a specified port based on the configured frequency division multiple and duty cycle.
Parameters:
| port | Indicates the PWM port number. |
| duty | Indicates the PWM duty cycle. |
| freq | Indicates the frequency-division multiple. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
PwmStop()
unsigned int PwmStop ([WifiIotPwmPort]($api-api-LinkIoT-Wifiiot.md#gab3518ce878df4a40d614e88a6f81dea7) port)
Description:
Stops the PWM signal output.
Parameters:
| port | Indicates the PWM port number. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
SdioCompleteSend()
unsigned int SdioCompleteSend (unsigned char * admaTable, unsigned int admaIndex )
Description:
Completes data sending on the SDIO device.
After data sending is complete, the SDIO device sets a complete flag for the ADMA ID admaIndex to indicate that the ADMA data between channel 0 and the complete flag is set.
Parameters:
| admaTable | Indicates the pointer to the start address of the ADMA table. Each ADMA table occupies 8 bytes. |
| admaIndex | Indicates the ADMA ID, ranging from 0 to 130. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
SdioGetExtendInfo()
[WifiIotSdioExtendFunc]($api-api-LinkIoT-WifiIotSdioExtendFunc.md)* SdioGetExtendInfo (void )
Description:
Obtains the extended configuration.
Returns:
Returns the pointer to the address of the extended configuration.
SdioInit()
unsigned int SdioInit (void )
Description:
Initializes the SDIO device.
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
SdioIsPendingMsg()
unsigned int SdioIsPendingMsg (unsigned int msg)
Description:
Checks whether a specified message is suspended.
Parameters:
| msg | Indicates the ID of the message to check, ranging from 0 to 31. |
Returns:
Returns 1 if the message is suspended; returns 0 otherwise.
SdioIsSendingMsg()
unsigned int SdioIsSendingMsg (unsigned int msg)
Description:
Checks whether a specified message is being sent.
Parameters:
| msg | Indicates the ID of the message to check, ranging from 0 to 31. |
Returns:
Returns 1 if the message is being sent; returns 0 otherwise.
SdioProcessMsg()
unsigned int SdioProcessMsg (unsigned int sendMsg, unsigned int clearMsg )
Description:
Clears a specified suspended message in the message queue, adds a new message to it, and sends the new message.
Parameters:
| sendMsg | Indicates the ID of the message to send, ranging from 0 to 31. |
| clearMsg | Indicates the ID of the message to clear, ranging from 0 to 31. |
Returns:
Returns 1 if the operation is successful; returns 0 otherwise.
SdioRegisterCallback()
unsigned int SdioRegisterCallback (const [WifiIotSdioIntcallback]($api-api-LinkIoT-WifiIotSdioIntcallback.md) * callbackFunc)
Description:
Registers an interrupt callback for the SDIO device.
Parameters:
| callbackFunc | Indicates the pointer to the interrupt callback to register. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
SdioRegisterNotifyMessageCallback()
void SdioRegisterNotifyMessageCallback ([NotifyHostMessageEvent]($api-api-LinkIoT-Wifiiot.md#ga133bb67c0fa6e9dcab35f00edff68e58) msgEventCallback)
Description:
Registers the callback that will be invoked when the host sends a message or data.
Parameters:
| msgEventCallback | Indicates the callback to be invoked when a message or data is sent. |
SdioReinit()
unsigned int SdioReinit (void )
Description:
Reinitializes the SDIO device.
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SdioSchedMsg()
unsigned int SdioSchedMsg (void )
Description:
Sends a suspended SDIO message.
Returns:
Returns 1 if no message is suspended or the suspended message is successfully sent; returns 0 if the SDIO device is not working or is sending messages.
SdioSendData()
void SdioSendData (unsigned int xferBytes)
Description:
Starts to send data.
Data with the length specified by xferBytes is ready for transmission.
Parameters:
| xferBytes | Indicates the length of the data to send. |
SdioSendMsgAck()
unsigned int SdioSendMsgAck (unsigned int msg)
Description:
Sends a specified message.
Parameters:
| msg | Indicates the ID of the message to send, ranging from 0 to 31. |
Returns:
Returns 1 if the operation is successful; returns 0 otherwise.
SdioSendSyncMsg()
unsigned int SdioSendSyncMsg (unsigned int msg)
Description:
Adds a message to a message queue and sends the message.
Parameters:
| msg | Indicates the ID of the message to add to the message queue and send, ranging from 0 to 31. |
Returns:
Returns 1 if the operation is successful; returns 0 otherwise.
SdioSetAdmatable()
unsigned int SdioSetAdmatable (unsigned char * admatable, unsigned int admaIndex, const unsigned int * dataAddr, unsigned int dataLen )
Description:
Sets an SDIO ADMA.
This function places a specified length of data into the ADMA with a specified ADMA ID admaIndex.
Parameters:
| admatable | Indicates the pointer to the start address of the ADMA table. Each ADMA table occupies 8 bytes. |
| admaIndex | Indicates the ADMA ID, ranging from 0 to 130. |
| dataAddr | Indicates the pointer to the address where data is to send. |
| dataLen | Indicates the length of the data to send. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
SdioSetPadAdmatab()
unsigned int SdioSetPadAdmatab (unsigned int padlen, unsigned char * admatable, unsigned int admaIndex )
Description:
Sets the ADMA table that requires data padding.
Parameters:
| padlen | Indicates the length of the data to pad. |
| admatable | Indicates the pointer to the start address of the ADMA table. Each ADMA table occupies 8 bytes. |
| admaIndex | Indicates the ADMA ID, ranging from 0 to 130. |
Returns:
Returns if the operation is successful; returns an error code defined in wifiiot_errno.h otherwise.
SdioSetPowerdownWhenDeepSleep()
void SdioSetPowerdownWhenDeepSleep (unsigned char powerDown)
Description:
Sets whether the SDIO device is powered off in deep sleep mode.
Parameters:
| powerDown | Specifies whether to power off the SDIO device. The value 1 means to power it off, and 0 means not to power it off. |
SdioSoftReset()
void SdioSoftReset (void )
Description:
Resets the SDIO device.
SdioWriteExtinfo()
unsigned int SdioWriteExtinfo ([WifiIotSdioExtendFunc]($api-api-LinkIoT-WifiIotSdioExtendFunc.md) * extFunc)
Description:
Sets the extended SDIO attributes.
Parameters:
| extFunc | Indicates the pointer to the extended attributes. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiDeinit()
unsigned int SpiDeinit ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId)
Description:
Deinitializes an SPI device.
Parameters:
| spiId | Indicates the SPI channel ID. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiHostRead()
unsigned int SpiHostRead ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, char * readData, unsigned int byteLen )
Description:
Reads data in half-duplex SPI master mode.
In SPI master mode, this function reads data of the length specified by byteLen in readData through the channel specified by spiId.
Parameters:
| spiId | Indicates the SPI channel ID. |
| readData | Indicates the pointer to the data to read. |
| byteLen | Indicates the length of the data to read. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiHostWrite()
unsigned int SpiHostWrite ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, char * writeData, unsigned int byteLen )
Description:
Sends data in half-duplex SPI master mode.
In SPI master mode, this function sends data of the length specified by byteLen in writeData through the channel specified by spiId.
Parameters:
| spiId | Indicates the SPI channel ID. |
| writeData | Indicates the pointer to the data to send. |
| byteLen | Indicates the length of the data to send. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiHostWriteread()
unsigned int SpiHostWriteread ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, char * writeData, char * readData, unsigned int byteLen )
Description:
Sends and reads data in full-duplex SPI master mode.
In SPI master mode, this function sends data in writeData and reads data of the length specified by byteLen in readData both through the channel specified by spiId.
Parameters:
| spiId | Indicates the SPI channel ID. |
| writeData | Indicates the pointer to the data to send. |
| readData | Indicates the pointer to the data to read. |
| byteLen | Indicates the length of the data to read. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiInit()
unsigned int SpiInit ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, [WifiIotSpiCfgInitParam]($api-api-LinkIoT-WifiIotSpiCfgInitParam.md) initParam, const [WifiIotSpiCfgBasicInfo]($api-api-LinkIoT-WifiIotSpiCfgBasicInfo.md) * param )
Description:
Initializes an SPI device.
This function initializes the device with the channel ID spiId, device type initParam, and device parameter param.
Parameters:
| spiId | Indicates the SPI channel ID. |
| initParam | Specifies whether the device is a slave one. |
| param | Indicates the pointer to the SPI device parameter. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiRegisterUsrFunc()
unsigned int SpiRegisterUsrFunc ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, [SpiIsrFunc]($api-api-LinkIoT-Wifiiot.md#gad1acc3e9c9d1c63f70aeb9d5201ed1f0) prepareF, [SpiIsrFunc]($api-api-LinkIoT-Wifiiot.md#gad1acc3e9c9d1c63f70aeb9d5201ed1f0) restoreF )
Description:
Registers the data TX preparation/recovery function.
This function registers the functions registered by prepareF and restoreF for an SPI device with a channel specified by spiId.
Parameters:
| spiId | Indicates the SPI channel ID. |
| prepareF | Indicates the function used for data preparation. |
| restoreF | Indicates the function used for data recovery. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiSetBasicInfo()
unsigned int SpiSetBasicInfo ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, const [WifiIotSpiCfgBasicInfo]($api-api-LinkIoT-WifiIotSpiCfgBasicInfo.md) * param )
Description:
Sets the SPI channel parameter.
Parameters:
| spiId | Indicates the SPI channel ID. |
| param | Indicates the pointer to the SPI parameter to set. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiSetDmaMode()
unsigned int SpiSetDmaMode ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, unsigned char dmaEn )
Description:
Sets whether to enable DMA to transfer data for an SPI device in slave mode.
Parameters:
| spiId | Indicates the SPI channel ID. |
| dmaEn | Specifies whether to enable DMA. The value 1 means to enable DMA, and 0 means to disable DMA. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiSetIrqMode()
unsigned int SpiSetIrqMode ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, unsigned char irqEn )
Description:
Sets whether to enable the interrupt request (IRQ) mode for an SPI device.
Parameters:
| spiId | Indicates the SPI channel ID. |
| irqEn | Specifies whether to enable IRQ. The value 1 means to enable IRQ, and 0 means to disable IRQ. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiSetLoopBackMode()
unsigned int SpiSetLoopBackMode ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, unsigned char lbEn )
Description:
Sets whether to enable loopback test for an SPI device.
Parameters:
| spiId | Indicates the SPI channel ID. |
| lbEn | Specifies whether to enable loopback test. The value 1 means to enable loopback test, and 0 means to disable loopback test. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiSlaveRead()
unsigned int SpiSlaveRead ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, char * readData, unsigned int byteLen, unsigned int timeOutMs )
Description:
Reads data in SPI slave mode.
In SPI slave mode, this function reads data of the length specified by byteLen in readData through the channel specified by spiId within the duration timeOutMs.
Parameters:
| spiId | Indicates the SPI channel ID. |
| readData | Indicates the pointer to the data to read. |
| byteLen | Indicates the length of the data to read. |
| timeOutMs | Indicates the timeout interval. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
SpiSlaveWrite()
unsigned int SpiSlaveWrite ([WifiIotSpiIdx]($api-api-LinkIoT-Wifiiot.md#ga1d095e78d92cdf2ffc5e34443726e44b) spiId, char * writeData, unsigned int byteLen, unsigned int timeOutMs )
Description:
Sends data in SPI slave mode.
In SPI slave mode, this function sends data of the length specified by byteLen in writeData through the channel specified by spiId within the duration timeOutMs.
Parameters:
| spiId | Indicates the SPI channel ID. |
| writeData | Indicates the pointer to the data to send. |
| byteLen | Indicates the length of the data to send. |
| timeOutMs | Indicates the timeout interval. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartDeinit()
unsigned int UartDeinit ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id)
Description:
Deinitializes a UART device.
Parameters:
| id | Indicates the UART port number. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartGetAttribute()
unsigned int UartGetAttribute ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, [WifiIotUartAttribute]($api-api-LinkIoT-WifiIotUartAttribute.md) * attr, [WifiIotUartExtraAttr]($api-api-LinkIoT-WifiIotUartExtraAttr.md) * extraAttr )
Description:
Obtains UART attributes.
This function obtains the basic and extended attributes of a UART device.
Parameters:
| id | Indicates the UART port number. |
| attr | Indicates the pointer to the basic UART attributes. |
| extraAttr | Indicates the pointer to the extended UART attributes. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartInit()
unsigned int UartInit ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, const [WifiIotUartAttribute]($api-api-LinkIoT-WifiIotUartAttribute.md) * param, const [WifiIotUartExtraAttr]($api-api-LinkIoT-WifiIotUartExtraAttr.md) * extraAttr )
Description:
Configures a UART device.
This function configures a UART device with the port number specified by id based on the basic and extended attributes.
Parameters:
| id | Indicates the UART port number. |
| param | Indicates the pointer to the basic UART attributes. |
| extraAttr | Indicates the pointer to the extended UART attributes. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartIsBufEmpty()
unsigned int UartIsBufEmpty ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, unsigned char * empty )
Description:
Checks whether the buffer on a UART device is empty.
The query result will be stored in empty.
Parameters:
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartIsBusy()
unsigned int UartIsBusy ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, unsigned char * busy )
Description:
Checks whether the buffer on a UART device is busy.
The query result will be stored in busy.
Parameters:
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartRead()
int UartRead ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, unsigned char * data, unsigned int dataLen )
Description:
Reads data from a UART device.
This function reads a specified length of data from a UART device with the port number specified by id.
Parameters:
| id | Indicates the UART port number. |
| data | Indicates the pointer to the start address of the data to read. |
| dataLen | Indicates the number of bytes to read. |
Returns:
Returns the number of bytes read if the operation is successful; returns -1 otherwise.
UartSetFlowCtrl()
unsigned int UartSetFlowCtrl ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, [WifiIotFlowCtrl]($api-api-LinkIoT-Wifiiot.md#gacf7ec5d973706e8239c7c6e4a470d8ab) flowCtrl )
Description:
Sets UART hardware flow control.
This function configures flow control for a UART device with the port number specified by id.
Parameters:
| id | Indicates the UART port number. |
| flowCtrl | Indicates the parameter used for hardware flow control. |
Returns:
Returns WIFI_IOT_SUCCESS if the operation is successful; returns an error code defined in otherwise.
UartWrite()
int UartWrite ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, const unsigned char * data, unsigned int dataLen )
Description:
Writes data to a UART device.
This function writes a specified length of data to a UART device with the port number specified by id.
Parameters:
Returns:
Returns the number of bytes written if the operation is successful; returns -1 otherwise.
UartWriteImmediately()
int UartWriteImmediately ([WifiIotUartIdx]($api-api-LinkIoT-Wifiiot.md#ga2699252424e5469ef243ae279a263c44) id, const unsigned char * data, unsigned int dataLen )
Description:
Writes data to be sent to a UART device in polling mode.
Parameters:
| id | Indicates the UART port number. |
| data | Indicates the pointer to the start address of the data to write. |
| dataLen | Indicates the number of bytes to write. |
Returns:
Returns the number of bytes written if the operation is successful; returns -1 otherwise.
WatchDogDisable()
void WatchDogDisable (void )
Description:
Disables the watchdog.
WatchDogEnable()
Description:
Enables the watchdog.
void WatchDogKick (void )
Description:
