Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Configuration - Capabilities Set

Macros

#define SL_INC_ARG_CHECK
 Defines whether the SimpleLink driver perform argument check or not.
 
#define SL_INC_STD_BSD_API_NAMING
 Defines whether SimpleLink driver should expose standard BSD APIs or not.
 
#define SL_INC_EXT_API
 Defines whether to include extended API in SimpleLink driver or not.
 
#define SL_INC_WLAN_PKG
 Defines whether to include WLAN package in SimpleLink driver or not.
 
#define SL_INC_SOCKET_PKG
 Defines whether to include SOCKET package in SimpleLink driver or not.
 
#define SL_INC_NET_APP_PKG
 Defines whether to include NET_APP package in SimpleLink driver or not.
 
#define SL_INC_NET_CFG_PKG
 Defines whether to include NET_CFG package in SimpleLink driver or not.
 
#define SL_INC_NVMEM_PKG
 Defines whether to include NVMEM package in SimpleLink driver or not.
 
#define SL_INC_SOCK_SERVER_SIDE_API
 Defines whether to include socket server side APIs in SimpleLink driver or not.
 
#define SL_INC_SOCK_CLIENT_SIDE_API
 Defines whether to include socket client side APIs in SimpleLink driver or not.
 
#define SL_INC_SOCK_RECV_API
 Defines whether to include socket receive APIs in SimpleLink driver or not.
 
#define SL_INC_SOCK_SEND_API
 Defines whether to include socket send APIs in SimpleLink driver or not.
 
#define SL_INC_ARG_CHECK
 Defines whether the SimpleLink driver perform argument check or not.
 
#define SL_INC_EXT_API
 Defines whether to include extended API in SimpleLink driver or not.
 
#define SL_INC_WLAN_PKG
 Defines whether to include WLAN package in SimpleLink driver or not.
 
#define SL_INC_SOCKET_PKG
 Defines whether to include SOCKET package in SimpleLink driver or not.
 
#define SL_INC_NET_APP_PKG
 Defines whether to include NET_APP package in SimpleLink driver or not.
 
#define SL_INC_NET_CFG_PKG
 Defines whether to include NET_CFG package in SimpleLink driver or not.
 
#define SL_INC_NVMEM_PKG
 Defines whether to include NVMEM package in SimpleLink driver or not.
 
#define SL_INC_SOCK_SERVER_SIDE_API
 Defines whether to include socket server side APIs in SimpleLink driver or not.
 
#define SL_INC_SOCK_CLIENT_SIDE_API
 Defines whether to include socket client side APIs in SimpleLink driver or not.
 
#define SL_INC_SOCK_RECV_API
 Defines whether to include socket receive APIs in SimpleLink driver or not.
 
#define SL_INC_SOCK_SEND_API
 Defines whether to include socket send APIs in SimpleLink driver or not.
 

Detailed Description

This section IS NOT REQUIRED in case one of the following pre defined capabilities set is in use:

PORTING ACTION:

Macro Definition Documentation

◆ SL_INC_ARG_CHECK [1/2]

#define SL_INC_ARG_CHECK

Defines whether the SimpleLink driver perform argument check or not.

\def                SL_INC_ARG_CHECK

When defined, the SimpleLink driver perform argument check on function call. Removing this define could reduce some code size and improve slightly the performances but may impact in unpredictable behavior in case of invalid arguments

See also

Note
belongs to configuration_sec
Warning
Removing argument check may cause unpredictable behavior in case of invalid arguments. In this case the user is responsible to argument validity (for example all handlers must not be NULL)
\def                SL_INC_ARG_CHECK

When defined, the SimpleLink driver perform argument check on function call. Removing this define could reduce some code size and improve slightly the performances but may impact in unpredictable behavior in case of invalid arguments

See also

Note
belongs to configuration_sec
Warning
Removing argument check may cause unpredictable behavior in case of invalid arguments. In this case the user is responsible to argument validity (for example all handlers must not be NULL)

Definition at line 125 of file nonos_user.h.

◆ SL_INC_ARG_CHECK [2/2]

#define SL_INC_ARG_CHECK

Defines whether the SimpleLink driver perform argument check or not.

\def                SL_INC_ARG_CHECK

When defined, the SimpleLink driver perform argument check on function call. Removing this define could reduce some code size and improve slightly the performances but may impact in unpredictable behavior in case of invalid arguments

See also

Note
belongs to configuration_sec
Warning
Removing argument check may cause unpredictable behavior in case of invalid arguments. In this case the user is responsible to argument validity (for example all handlers must not be NULL)

Definition at line 124 of file user.h.

◆ SL_INC_EXT_API [1/2]

#define SL_INC_EXT_API

Defines whether to include extended API in SimpleLink driver or not.

When defined, the SimpleLink driver will include also all exteded API of the included packages

See also
ext_api
Note
belongs to configuration_sec
Warning

Definition at line 163 of file nonos_user.h.

◆ SL_INC_EXT_API [2/2]

#define SL_INC_EXT_API

Defines whether to include extended API in SimpleLink driver or not.

When defined, the SimpleLink driver will include also all exteded API of the included packages

See also
ext_api
Note
belongs to configuration_sec
Warning

Definition at line 162 of file user.h.

◆ SL_INC_NET_APP_PKG [1/2]

#define SL_INC_NET_APP_PKG

Defines whether to include NET_APP package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the NET_APP package

See also

Note
belongs to configuration_sec
Warning

Definition at line 208 of file nonos_user.h.

◆ SL_INC_NET_APP_PKG [2/2]

#define SL_INC_NET_APP_PKG

Defines whether to include NET_APP package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the NET_APP package

See also

Note
belongs to configuration_sec
Warning

Definition at line 207 of file user.h.

◆ SL_INC_NET_CFG_PKG [1/2]

#define SL_INC_NET_CFG_PKG

Defines whether to include NET_CFG package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the NET_CFG package

See also

Note
belongs to configuration_sec
Warning

Definition at line 223 of file nonos_user.h.

◆ SL_INC_NET_CFG_PKG [2/2]

#define SL_INC_NET_CFG_PKG

Defines whether to include NET_CFG package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the NET_CFG package

See also

Note
belongs to configuration_sec
Warning

Definition at line 222 of file user.h.

◆ SL_INC_NVMEM_PKG [1/2]

#define SL_INC_NVMEM_PKG

Defines whether to include NVMEM package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the NVMEM package

See also

Note
belongs to configuration_sec
Warning

Definition at line 238 of file nonos_user.h.

◆ SL_INC_NVMEM_PKG [2/2]

#define SL_INC_NVMEM_PKG

Defines whether to include NVMEM package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the NVMEM package

See also

Note
belongs to configuration_sec
Warning

Definition at line 237 of file user.h.

◆ SL_INC_SOCK_CLIENT_SIDE_API [1/2]

#define SL_INC_SOCK_CLIENT_SIDE_API

Defines whether to include socket client side APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket client side APIs

See also
client_side
Note
belongs to configuration_sec
Warning

Definition at line 268 of file nonos_user.h.

◆ SL_INC_SOCK_CLIENT_SIDE_API [2/2]

#define SL_INC_SOCK_CLIENT_SIDE_API

Defines whether to include socket client side APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket client side APIs

See also
client_side
Note
belongs to configuration_sec
Warning

Definition at line 267 of file user.h.

◆ SL_INC_SOCK_RECV_API [1/2]

#define SL_INC_SOCK_RECV_API

Defines whether to include socket receive APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket receive side APIs

See also
recv_api
Note
belongs to configuration_sec
Warning

Definition at line 283 of file nonos_user.h.

◆ SL_INC_SOCK_RECV_API [2/2]

#define SL_INC_SOCK_RECV_API

Defines whether to include socket receive APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket receive side APIs

See also
recv_api
Note
belongs to configuration_sec
Warning

Definition at line 282 of file user.h.

◆ SL_INC_SOCK_SEND_API [1/2]

#define SL_INC_SOCK_SEND_API

Defines whether to include socket send APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket send side APIs

See also
send_api
Note
belongs to configuration_sec
Warning

Definition at line 298 of file nonos_user.h.

◆ SL_INC_SOCK_SEND_API [2/2]

#define SL_INC_SOCK_SEND_API

Defines whether to include socket send APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket send side APIs

See also
send_api
Note
belongs to configuration_sec
Warning

Definition at line 297 of file user.h.

◆ SL_INC_SOCK_SERVER_SIDE_API [1/2]

#define SL_INC_SOCK_SERVER_SIDE_API

Defines whether to include socket server side APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket server side APIs

See also
server_side
Note

Warning

Definition at line 253 of file nonos_user.h.

◆ SL_INC_SOCK_SERVER_SIDE_API [2/2]

#define SL_INC_SOCK_SERVER_SIDE_API

Defines whether to include socket server side APIs in SimpleLink driver or not.

When defined, the SimpleLink driver will include also socket server side APIs

See also
server_side
Note

Warning

Definition at line 252 of file user.h.

◆ SL_INC_SOCKET_PKG [1/2]

#define SL_INC_SOCKET_PKG

Defines whether to include SOCKET package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the SOCKET package

See also

Note
belongs to configuration_sec
Warning

Definition at line 193 of file nonos_user.h.

◆ SL_INC_SOCKET_PKG [2/2]

#define SL_INC_SOCKET_PKG

Defines whether to include SOCKET package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the SOCKET package

See also

Note
belongs to configuration_sec
Warning

Definition at line 192 of file user.h.

◆ SL_INC_STD_BSD_API_NAMING

#define SL_INC_STD_BSD_API_NAMING

Defines whether SimpleLink driver should expose standard BSD APIs or not.

When defined, the SimpleLink driver in addtion to its alternative BSD APIs expose also standard BSD APIs. Stadrad BSD API includs the following functions: socket , close , accept , bind , listen , connect , select , setsockopt , getsockopt , recv , recvfrom , write , send , sendto , gethostbyname

See also

Note
belongs to configuration_sec
Warning

Definition at line 147 of file nonos_user.h.

◆ SL_INC_WLAN_PKG [1/2]

#define SL_INC_WLAN_PKG

Defines whether to include WLAN package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the WLAN package

See also

Note
belongs to configuration_sec
Warning

Definition at line 178 of file nonos_user.h.

◆ SL_INC_WLAN_PKG [2/2]

#define SL_INC_WLAN_PKG

Defines whether to include WLAN package in SimpleLink driver or not.

When defined, the SimpleLink driver will include also the WLAN package

See also

Note
belongs to configuration_sec
Warning

Definition at line 177 of file user.h.