XDK API  3.4.0
Documentation
Macros | Typedefs
user.h File Reference
#include <string.h>
#include "BCDS_WlanDriver.h"
+ Include dependency graph for user.h:
+ This graph shows which files directly or indirectly include this file:

Macros

#define _SlFd_t   int
 
#define _SlLockObj_t   WlanDriver_OsLockObject
 type definition for a locking object container More...
 
#define _SlSyncObj_t   WlanDriver_OsSyncObject
 type definition for a sync object container More...
 
#define _SlTime_t   WlanDriver_OsTime
 type definition for a time value More...
 
#define MAX_CONCURRENT_ACTIONS   10
 Defines the maximum number of concurrent action in the system Min:1 , Max: 32. More...
 
#define sl_DeviceDisable   WlanDriver_DeviceDisable
 Disable the Network Processor. More...
 
#define sl_DeviceEnable   WlanDriver_DeviceEnable
 Enable the Network Processor. More...
 
#define sl_DeviceEnablePreamble()
 Preamble to the enabling the Network Processor. Placeholder to implement any pre-process operations before enabling networking operations. More...
 
#define sl_GeneralEvtHdlr   WlanConnect_SlGeneralEventHdlr
 An event handler for general error handling from the simplelink Possible events are: SL_DEVICE_GENERAL_ERROR_EVENT SL_DEVICE_ABORT_ERROR_EVENT SL_DEVICE_DRIVER_ASSERT_ERROR_EVENT SL_DEVICE_DRIVER_TIMEOUT_CMD_COMPLETE SL_DEVICE_DRIVER_TIMEOUT_SYNC_PATTERN SL_DEVICE_DRIVER_TIMEOUT_ASYNC_EVENT SL_DEVICE_ERROR_MAX. More...
 
#define sl_HttpServerCallback   WlanDriver_SlHttpServerCb
 A callback for HTTP server events. Possible events are: SL_NETAPP_HTTPGETTOKENVALUE - NWP requests to get the value of a specific token SL_NETAPP_HTTPPOSTTOKENVALUE - NWP post to the host a new value for a specific token. More...
 
#define sl_IfClose   WlanDriver_SpiClose
 Closes an opened interface communication port. More...
 
#define sl_IfMaskIntHdlr()
 Masks the Host IRQ. More...
 
#define sl_IfOpen   WlanDriver_SpiOpen
 Opens an interface communication port to be used for communicating with a SimpleLink device. More...
 
#define sl_IfRead   WlanDriver_SpiRead
 Attempts to read up to len bytes from an opened communication channel into a buffer starting at pBuff. More...
 
#define sl_IfRegIntHdlr(InterruptHdl, pValue)   WlanDriver_RegInterruptHdlr(InterruptHdl , pValue)
 register an interrupt handler routine for the host IRQ More...
 
#define sl_IfUnMaskIntHdlr()
 Unmasks the Host IRQ. More...
 
#define sl_IfWrite   WlanDriver_SpiWrite
 attempts to write up to len bytes to the SPI channel More...
 
#define SL_INC_ARG_CHECK
 Defines whether the SimpleLink driver perform argument check or not. More...
 
#define SL_INC_EXT_API
 Defines whether to include extended API in SimpleLink driver or not. More...
 
#define SL_INC_NET_APP_PKG
 Defines whether to include NET_APP package in SimpleLink driver or not. More...
 
#define SL_INC_NET_CFG_PKG
 Defines whether to include NET_CFG package in SimpleLink driver or not. More...
 
#define SL_INC_NVMEM_PKG
 Defines whether to include NVMEM package in SimpleLink driver or not. More...
 
#define SL_INC_SOCK_CLIENT_SIDE_API
 Defines whether to include socket client side APIs in SimpleLink driver or not. More...
 
#define SL_INC_SOCK_RECV_API
 Defines whether to include socket receive APIs in SimpleLink driver or not. More...
 
#define SL_INC_SOCK_SEND_API
 Defines whether to include socket send APIs in SimpleLink driver or not. More...
 
#define SL_INC_SOCK_SERVER_SIDE_API
 Defines whether to include socket server side APIs in SimpleLink driver or not. More...
 
#define SL_INC_SOCKET_PKG
 Defines whether to include SOCKET package in SimpleLink driver or not. More...
 
#define SL_INC_STD_BSD_API_NAMING
 Defines whether SimpleLink driver should expose standard BSD APIs or not. More...
 
#define SL_INC_WLAN_PKG
 Defines whether to include WLAN package in SimpleLink driver or not. More...
 
#define sl_LockObjCreate(pLockObj, pName)   WlanDriver_OsLockObjectCreate(pLockObj)
 This function creates a locking object. More...
 
#define sl_LockObjDelete(pLockObj)   WlanDriver_OsLockObjectDelete(pLockObj)
 This function deletes a locking object. More...
 
#define sl_LockObjLock(pLockObj, TimeOut)   WlanDriver_OsLockObjectWait(pLockObj, TimeOut)
 This function locks a locking object. More...
 
#define sl_LockObjUnlock(pLockObj)   WlanDriver_OsLockUnlock(pLockObj)
 This function unlock a locking object. More...
 
#define sl_NetAppEvtHdlr   NetworkConfig_SlNetAppEvtHdlr
 An event handler for IP address asynchronous event. Usually accepted after new WLAN connection. This event handles networking events. Possible events are: SL_NETAPP_IPV4_ACQUIRED - IP address was acquired (DHCP or Static) More...
 
#define SL_OS_NO_WAIT   (WLANDRIVER_OS_NO_WAIT)
 
#define SL_OS_RET_CODE_OK   (WLANDRIVER_SUCCESS)
 
#define SL_OS_WAIT_FOREVER   (WLANDRIVER_OS_WAIT_FOREVER)
 
#define SL_PLATFORM_EXTERNAL_SPAWN
 This function call the pEntry callback from a different context. More...
 
#define SL_PLATFORM_MULTI_THREADED
 
#define sl_SockEvtHdlr   Wlan_SlSockEvtHdlr
 The socket events dispatcher which has a week definition. User can write his own implementation with a non-week definition of Wlan_SlSockEvtHdlr function, so that the compiler will use the user definition instead of the week implementation. More...
 
#define sl_Spawn(pEntry, pValue, flags)   WlanDriver_OsiSpawn(pEntry , pValue , flags);
 
#define sl_SyncObjCreate(pSyncObj, pName)   WlanDriver_OsSyncObjectCreate(pSyncObj)
 This function creates a sync object. More...
 
#define sl_SyncObjDelete(pSyncObj)   WlanDriver_OsSyncObjectDelete(pSyncObj)
 This function deletes a sync object. More...
 
#define sl_SyncObjSignal(pSyncObj)   WlanDriver_OsSyncObjectSignal(pSyncObj)
 This function generates a sync signal for the object. More...
 
#define sl_SyncObjSignalFromIRQ(pSyncObj)   WlanDriver_OsSyncSignalFromISR(pSyncObj)
 This function generates a sync signal for the object from Interrupt. More...
 
#define sl_SyncObjWait(pSyncObj, TimeOut)   WlanDriver_OsSyncObjectWait(pSyncObj, TimeOut)
 This function waits for a sync signal of the specific sync object. More...
 
#define sl_WlanEvtHdlr   WlanConnect_SLWlanEventHdlr
 An event handler for WLAN connection or disconnection indication This event handles async WLAN events. Possible events are: SL_WLAN_CONNECT_EVENT - indicates WLAN is connected SL_WLAN_DISCONNECT_EVENT - indicates WLAN is disconnected. More...
 

Typedefs

typedef WLANDRIVER_EVENT_HANDLER SL_P_EVENT_HANDLER
 

Macro Definition Documentation

#define MAX_CONCURRENT_ACTIONS   10

Actions which has async events as return, can be

See also
Note
In case there are not enough resources for the actions needed in the system, error is received: POOL_IS_EMPTY one option is to increase MAX_CONCURRENT_ACTIONS (improves performance but results in memory consumption) Other option is to call the API later (decrease performance)
Warning
In case of setting to one, recommend to use non-blocking recv to allow multiple socket recv

Typedef Documentation


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Sat Jul 28 2018 21:51:56 by doxygen 1.8.8