SimpleLink CC3120/CC3220 Host Driver  Version 2.0.1.18
Simplifies the implementation of Internet connectivity
Socket

Controls standard client/server sockets programming options and capabilities. More...

Functions

_i16 sl_Socket (_i16 Domain, _i16 Type, _i16 Protocol)
 Create an endpoint for communication. More...
 
_i16 sl_Close (_i16 sd)
 Gracefully close socket. More...
 
_i16 sl_Accept (_i16 sd, SlSockAddr_t *addr, SlSocklen_t *addrlen)
 Accept a connection on a socket. More...
 
_i16 sl_Bind (_i16 sd, const SlSockAddr_t *addr, _i16 addrlen)
 Assign a name to a socket. More...
 
_i16 sl_Listen (_i16 sd, _i16 backlog)
 Listen for connections on a socket. More...
 
_i16 sl_Connect (_i16 sd, const SlSockAddr_t *addr, _i16 addrlen)
 Initiate a connection on a socket. More...
 
_i16 sl_Select (_i16 nfds, SlFdSet_t *readsds, SlFdSet_t *writesds, SlFdSet_t *exceptsds, struct SlTimeval_t *timeout)
 Monitor socket activity. More...
 
_i16 sl_SetSockOpt (_i16 sd, _i16 level, _i16 optname, const void *optval, SlSocklen_t optlen)
 Set socket options-. More...
 
_i16 sl_GetSockOpt (_i16 sd, _i16 level, _i16 optname, void *optval, SlSocklen_t *optlen)
 Get socket options. More...
 
_i16 sl_Recv (_i16 sd, void *buf, _i16 len, _i16 flags)
 Read data from TCP socket. More...
 
_i16 sl_RecvFrom (_i16 sd, void *buf, _i16 len, _i16 flags, SlSockAddr_t *from, SlSocklen_t *fromlen)
 Read data from socket. More...
 
_i16 sl_Send (_i16 sd, const void *buf, _i16 len, _i16 flags)
 Write data to TCP socket. More...
 
_i16 sl_SendTo (_i16 sd, const void *buf, _i16 len, _i16 flags, const SlSockAddr_t *to, SlSocklen_t tolen)
 Write data to socket. More...
 
_u32 sl_Htonl (_u32 val)
 Reorder the bytes of a 32-bit unsigned value. More...
 
_u16 sl_Htons (_u16 val)
 Reorder the bytes of a 16-bit unsigned value. More...
 

Typedefs

typedef struct SlInAddr_t SlInAddr_t
 
typedef struct SlIn6Addr_t SlIn6Addr_t
 
typedef _i32 SlTime_t
 
typedef _i32 SlSuseconds_t
 
typedef struct SlTimeval_t SlTimeval_t
 
typedef _u16 SlSocklen_t
 
typedef struct SlSockAddr_t SlSockAddr_t
 
typedef struct SlSockAddrIn6_t SlSockAddrIn6_t
 
typedef struct SlSockAddrIn_t SlSockAddrIn_t
 
typedef struct SlFdSet_t SlFdSet_t
 

Enumerations

enum  SlTxInhibitThreshold_e {
  SL_TX_INHIBIT_THRESHOLD_MIN = 1,
  SL_TX_INHIBIT_THRESHOLD_LOW = 2,
  SL_TX_INHIBIT_THRESHOLD_DEFAULT = 3,
  SL_TX_INHIBIT_THRESHOLD_MED = 4,
  SL_TX_INHIBIT_THRESHOLD_HIGH = 5,
  SL_TX_INHIBIT_THRESHOLD_MAX = 6
}
 
enum  SlSockSecureSocketFilesIndex_e {
  SL_BSD_SECURED_PRIVATE_KEY_IDX = 0,
  SL_BSD_SECURED_CERTIFICATE_IDX,
  SL_BSD_SECURED_CA_IDX,
  SL_BSD_SECURED_DH_IDX
}
 

Detailed Description

Controls standard client/server sockets programming options and capabilities.

Function Documentation

§ sl_Accept()

_i16 sl_Accept ( _i16  sd,
SlSockAddr_t addr,
SlSocklen_t *  addrlen 
)

Accept a connection on a socket.

This function is used with connection-based socket types (SOCK_STREAM).
It extracts the first connection request on the queue of pending connections, creates a new connected socket, and returns a new file descriptor referring to that socket.
The newly created socket is not in the listening state. The original socket sd is unaffected by this call.
The argument sd is a socket that has been created with sl_Socket(), bound to a local address with sl_Bind(), and is listening for connections after a sl_Listen(). The argument addr is a pointer to a sockaddr structure. This structure is filled in with the address of the peer socket, as known to the communications layer. The exact format of the address returned addr is determined by the socket's address family.
The addrlen argument is a value-result argument: it should initially contain the size of the structure pointed to by addr, on return it will contain the actual length (in bytes) of the address returned.

Parameters
[in]sdSocket descriptor (handle)
[out]addrThe argument addr is a pointer to a sockaddr structure. This structure is filled in with the address of the peer socket, as known to the communications layer. The exact format of the address returned addr is determined by the socket's address
sockaddr:
- code for the address format. On this version only AF_INET is supported.
- socket address, the length depends on the code format
[out]addrlenThe addrlen argument is a value-result argument: it should initially contain the size of the structure pointed to by addr
Returns
On success, a socket handle.
On a non-blocking accept a possible negative value is SL_EAGAIN.
On failure, negative error code.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system In this case try again later or increase MAX_CONCURRENT_ACTIONS
See also
sl_Socket sl_Bind sl_Listen
Note
Belongs to server_side
Warning

Definition at line 685 of file sl_socket.c.

686 {
687  _SlSockAcceptMsg_u Msg;
688  _SlReturnVal_t RetVal;
689  SlSocketAddrResponse_u AsyncRsp;
690 
691  _u8 ObjIdx = MAX_CONCURRENT_ACTIONS;
692 
693  /* verify that this api is allowed. if not allowed then
694  ignore the API execution and return immediately with an error */
695  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
696 
697  if((NULL == addrlen) || (NULL == addr))
698  {
699  return SL_RET_CODE_INVALID_INPUT;
700  }
701 
702  Msg.Cmd.Sd = (_u8)sd;
703  Msg.Cmd.Family = (_u8)((sizeof(SlSockAddrIn_t) == *addrlen) ? SL_AF_INET : SL_AF_INET6);
704 
705  ObjIdx = _SlDrvProtectAsyncRespSetting((_u8*)&AsyncRsp, ACCEPT_ID, (_u8)sd & SL_BSD_SOCKET_ID_MASK);
706 
707  if (MAX_CONCURRENT_ACTIONS == ObjIdx)
708  {
709  return SL_POOL_IS_EMPTY;
710  }
711 
712  /* send the command */
713  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlAcceptCmdCtrl, &Msg, NULL));
714  VERIFY_PROTOCOL(Msg.Rsp.Sd == (_u8)sd);
715 
716  RetVal = Msg.Rsp.StatusOrLen;
717 
718  if(SL_OS_RET_CODE_OK == RetVal)
719  {
720 #ifndef SL_TINY
721  /* in case socket is non-blocking one, the async event should be received immediately */
722  if( g_pCB->SocketNonBlocking & (1<<(sd & SL_BSD_SOCKET_ID_MASK) ))
723  {
724  SL_DRV_SYNC_OBJ_WAIT_TIMEOUT(&g_pCB->ObjPool[ObjIdx].SyncObj,
725  SL_DRIVER_TIMEOUT_SHORT,
726  SL_OPCODE_SOCKET_ACCEPTASYNCRESPONSE
727  );
728  }
729  else
730 #endif
731  {
732  /* wait for async and get Data Read parameters */
733  SL_DRV_SYNC_OBJ_WAIT_FOREVER(&g_pCB->ObjPool[ObjIdx].SyncObj);
734  }
735 
736  VERIFY_PROTOCOL(AsyncRsp.IpV4.Sd == (_u8)sd);
737 
738  RetVal = AsyncRsp.IpV4.StatusOrLen;
739 #if 0 /* Kept for backup */
740  _SlSocketParseAddress(&AsyncRsp, addr, addrlen);
741 #else
742  addr->sa_family = AsyncRsp.IpV4.Family;
743 
744  if(SL_AF_INET == addr->sa_family)
745  {
746  if( *addrlen == (SlSocklen_t)sizeof( SlSockAddrIn_t ) )
747  {
748  ((SlSockAddrIn_t *)addr)->sin_port = AsyncRsp.IpV4.Port;
749  ((SlSockAddrIn_t *)addr)->sin_addr.s_addr = AsyncRsp.IpV4.Address;
750  }
751  else
752  {
753  *addrlen = 0;
754  }
755  }
756 #ifdef SL_SUPPORT_IPV6
757  else
758  {
759  if( *addrlen == sizeof( SlSockAddrIn6_t ) )
760  {
761  ((SlSockAddrIn6_t *)addr)->sin6_port = AsyncRsp.IpV6.Port ;
762  sl_Memcpy(((SlSockAddrIn6_t *)addr)->sin6_addr._S6_un._S6_u32, AsyncRsp.IpV6.Address, 16);
763  }
764  else
765  {
766  *addrlen = 0;
767  }
768  }
769 #endif
770 #endif
771  }
772 
773  _SlDrvReleasePoolObj(ObjIdx);
774  return (_i16)RetVal;
775 }

§ sl_Bind()

_i16 sl_Bind ( _i16  sd,
const SlSockAddr_t addr,
_i16  addrlen 
)

Assign a name to a socket.

This function gives the socket the local address addr. addr is addrlen bytes long. Traditionally, this is called When a socket is created with socket, it exists in a name space (address family) but has no name assigned. It is necessary to assign a local address before a SOCK_STREAM socket may receive connections.

Parameters
[in]sdSocket descriptor (handle)
[in]addrSpecifies the destination addrs
sockaddr:
- code for the address format. On this version only SL_AF_INET is supported.
- socket address, the length depends on the code format
[in]addrlenContains the size of the structure pointed to by addr
Returns
Zero on success, or negative error code on failure
See also
sl_Socket sl_Accept sl_Listen
Note
belongs to basic_api
Warning

Definition at line 222 of file sl_socket.c.

223 {
224  _SlSockBindMsg_u Msg;
225  _SlCmdCtrl_t CmdCtrl = {0, 0, (_SlArgSize_t)sizeof(SlSocketResponse_t)};
226 
227  /* verify that this api is allowed. if not allowed then
228  ignore the API execution and return immediately with an error */
229  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
230 
231  switch(addr->sa_family)
232  {
233  case SL_AF_INET :
234  CmdCtrl.Opcode = SL_OPCODE_SOCKET_BIND;
235  CmdCtrl.TxDescLen = (_SlArgSize_t)sizeof(SlSocketAddrIPv4Command_t);
236  break;
237 #ifndef SL_TINY
238 #ifdef SL_SUPPORT_IPV6
239  case SL_AF_INET6:
240  CmdCtrl.Opcode = SL_OPCODE_SOCKET_BIND_V6;
241  CmdCtrl.TxDescLen = (_SlArgSize_t)sizeof(SlSocketAddrIPv6Command_t);
242  break;
243 #endif
244 #endif
245 
246  case SL_AF_RF :
247  default:
248  return SL_RET_CODE_INVALID_INPUT;
249  }
250 
251  Msg.Cmd.IpV4.LenOrPadding = 0;
252  Msg.Cmd.IpV4.Sd = (_u8)sd;
253 
254  _SlSocketBuildAddress(addr, &Msg.Cmd);
255  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&CmdCtrl, &Msg, NULL));
256 
257  return Msg.Rsp.StatusOrLen;
258 }

§ sl_Close()

_i16 sl_Close ( _i16  sd)

Gracefully close socket.

This function causes the system to release resources allocated to a socket.
In case of TCP, the connection is terminated.

Parameters
[in]sdSocket handle (received in sl_Socket)
Returns
Zero on success, or negative error code on failure
See also
sl_Socket
Note
belongs to ext_api
Warning

Definition at line 162 of file sl_socket.c.

163 {
164  _SlSockCloseMsg_u Msg;
165  _u8 ObjIdx = MAX_CONCURRENT_ACTIONS;
166  SlSocketResponse_t AsyncRsp;
167  _SlReturnVal_t RetVal;
168  _u8 bSocketInAction = FALSE;
169 
170  /* verify that this api is allowed. if not allowed then
171  ignore the API execution and return immediately with an error */
172  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
173 
174  Msg.Cmd.Sd = (_u8)sd;
175  _SlDrvMemZero(&AsyncRsp, sizeof(SlSocketResponse_t));
176 
177  /* check if the socket has already action in progress */
178  bSocketInAction = !!(g_pCB->ActiveActionsBitmap & (1<<sd));
179 
180  if (bSocketInAction == FALSE)
181  {
182  ObjIdx = _SlDrvProtectAsyncRespSetting((_u8*)&AsyncRsp, CLOSE_ID, (_u8)(sd & SL_BSD_SOCKET_ID_MASK));
183 
184  if (MAX_CONCURRENT_ACTIONS == ObjIdx)
185  {
186  return SL_POOL_IS_EMPTY;
187  }
188  }
189 
190  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlSockCloseCmdCtrl, &Msg, NULL));
191 
192  RetVal = Msg.Rsp.StatusOrLen;
193 
194  if (bSocketInAction == FALSE)
195  {
196  if( SL_RET_CODE_OK == RetVal)
197  {
198  SL_DRV_SYNC_OBJ_WAIT_TIMEOUT(&g_pCB->ObjPool[ObjIdx].SyncObj,
199  SL_DRIVER_TIMEOUT_LONG,
200  SL_OPCODE_SOCKET_SOCKETCLOSEASYNCEVENT
201  );
202  RetVal = AsyncRsp.StatusOrLen;
203  }
204 
205  _SlDrvReleasePoolObj(ObjIdx);
206  }
207 
208  return RetVal;
209 }

§ sl_Connect()

_i16 sl_Connect ( _i16  sd,
const SlSockAddr_t addr,
_i16  addrlen 
)

Initiate a connection on a socket.

Function connects the socket referred to by the socket descriptor sd, to the address specified by addr. The addrlen argument specifies the size of addr. The format of the address in addr is determined by the address space of the socket. If it is of type SOCK_DGRAM, this call specifies the peer with which the socket is to be associated; this address is that to which datagrams are to be sent, and the only address from which datagrams are to be received. If the socket is of type SOCK_STREAM, this call attempts to make a connection to another socket. The other socket is specified by address, which is an address in the communications space of the socket.

Parameters
[in]sdSocket descriptor (handle)
[in]addrSpecifies the destination addr
sockaddr:
- code for the address format. On this version only AF_INET is supported.
- socket address, the length depends on the code format
[in]addrlenContains the size of the structure pointed to by addr
Returns
On success, a socket handle.
On a non-blocking connect a possible negative value is SL_EALREADY. On failure, negative value.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system In this case try again later or increase MAX_CONCURRENT_ACTIONS
See also
sl_Socket
Note
belongs to client_side
Warning

Definition at line 441 of file sl_socket.c.

442 {
443  _SlSockConnectMsg_u Msg;
444  _SlReturnVal_t RetVal;
445  _SlCmdCtrl_t CmdCtrl = {0, (_SlArgSize_t)0, (_SlArgSize_t)sizeof(SlSocketResponse_t)};
446  SlSocketResponse_t AsyncRsp;
447  _u8 ObjIdx = MAX_CONCURRENT_ACTIONS;
448 
449  /* verify that this api is allowed. if not allowed then
450  ignore the API execution and return immediately with an error */
451  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
452  _SlDrvMemZero(&AsyncRsp, sizeof(SlSocketResponse_t));
453 
454  switch(addr->sa_family)
455  {
456  case SL_AF_INET :
457  CmdCtrl.Opcode = SL_OPCODE_SOCKET_CONNECT;
458  CmdCtrl.TxDescLen = (_SlArgSize_t)sizeof(SlSocketAddrIPv4Command_t);
459  /* Do nothing - cmd already initialized to this type */
460  break;
461 #ifdef SL_SUPPORT_IPV6
462  case SL_AF_INET6:
463  CmdCtrl.Opcode = SL_OPCODE_SOCKET_CONNECT_V6;
464  CmdCtrl.TxDescLen = (_SlArgSize_t)sizeof(SlSocketAddrIPv6Command_t);
465  break;
466 #endif
467  case SL_AF_RF:
468  default:
469  return SL_RET_CODE_INVALID_INPUT;
470  }
471 
472  Msg.Cmd.IpV4.LenOrPadding = 0;
473  Msg.Cmd.IpV4.Sd = (_u8)sd;
474 
475  _SlSocketBuildAddress(addr, &Msg.Cmd);
476 
477  ObjIdx = _SlDrvProtectAsyncRespSetting((_u8*)&AsyncRsp, CONNECT_ID, (_u8)(sd & SL_BSD_SOCKET_ID_MASK));
478 
479  if (MAX_CONCURRENT_ACTIONS == ObjIdx)
480  {
481  return SL_POOL_IS_EMPTY;
482  }
483 
484  /* send the command */
485  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&CmdCtrl, &Msg, NULL));
486  VERIFY_PROTOCOL(Msg.Rsp.Sd == (_u8)sd);
487 
488  RetVal = Msg.Rsp.StatusOrLen;
489 
490  if(SL_RET_CODE_OK == RetVal)
491  {
492 #ifndef SL_TINY
493  /*In case socket is non-blocking one, the async event should be received immediately */
494  if( g_pCB->SocketNonBlocking & (1<<(sd & SL_BSD_SOCKET_ID_MASK) ))
495  {
496  SL_DRV_SYNC_OBJ_WAIT_TIMEOUT(&g_pCB->ObjPool[ObjIdx].SyncObj,
497  SL_DRIVER_TIMEOUT_SHORT,
498  SL_OPCODE_SOCKET_CONNECTASYNCRESPONSE
499  );
500  }
501  else
502 #endif
503  {
504 
505  /* wait for async and get Data Read parameters */
506  SL_DRV_SYNC_OBJ_WAIT_FOREVER(&g_pCB->ObjPool[ObjIdx].SyncObj);
507  }
508 
509  VERIFY_PROTOCOL(AsyncRsp.Sd == (_u8)sd);
510  RetVal = AsyncRsp.StatusOrLen;
511  }
512 
513  _SlDrvReleasePoolObj(ObjIdx);
514  return RetVal;
515 }

§ sl_GetSockOpt()

_i16 sl_GetSockOpt ( _i16  sd,
_i16  level,
_i16  optname,
void *  optval,
SlSocklen_t *  optlen 
)

Get socket options.

This function manipulate the options associated with a socket. Options may exist at multiple protocol levels; they are always present at the uppermost socket level.
When manipulating socket options the level at which the option resides and the name of the option must be specified. To manipulate options at the socket level, level is specified as SOL_SOCKET. To manipulate options at any other level the protocol number of the appropriate proto- col controlling the option is supplied. For example, to indicate that an option is to be interpreted by the TCP protocol, level should be set to the protocol number of TCP;
The parameters optval and optlen are used to access optval - ues for setsockopt(). For getsockopt() they identify a buffer in which the value for the requested option(s) are to be returned. For getsockopt(), optlen is a value-result parameter, initially containing the size of the buffer pointed to by option_value, and modified on return to indicate the actual size of the value returned. If no option value is to be supplied or returned, option_value may be NULL.

Parameters
[in]sdSocket handle
[in]levelDefines the protocol level for this option
[in]optnamedefines the option name to interrogate
[out]optvalSpecifies a value for the option
[out]optlenSpecifies the length of the option value
Returns
Zero on success, or negative error code on failure
See also
sl_SetSockOpt
Note
See sl_SetSockOpt Belongs to ext_api
Warning

Definition at line 1008 of file sl_socket.c.

1009 {
1010  _SlGetSockOptMsg_u Msg;
1011  _SlCmdExt_t CmdExt;
1012 
1013  /* verify that this api is allowed. if not allowed then
1014  ignore the API execution and return immediately with an error */
1015  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
1016  if (*optlen == 0)
1017  {
1018  return SL_EZEROLEN;
1019  }
1020 
1021  _SlDrvResetCmdExt(&CmdExt);
1022  CmdExt.RxPayloadLen = (_i16)(*optlen);
1023  CmdExt.pRxPayload = optval;
1024 
1025  Msg.Cmd.Sd = (_u8)sd;
1026  Msg.Cmd.Level = (_u8)level;
1027  Msg.Cmd.OptionLen = (_u8)(*optlen);
1028  Msg.Cmd.OptionName = (_u8)optname;
1029 
1030  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlGetSockOptCmdCtrl, &Msg, &CmdExt));
1031 
1032  if (CmdExt.RxPayloadLen < CmdExt.ActualRxPayloadLen)
1033  {
1034  *optlen = Msg.Rsp.OptionLen;
1035  return SL_ESMALLBUF;
1036  }
1037  else
1038  {
1039  *optlen = (_u8)CmdExt.ActualRxPayloadLen;
1040  }
1041  return (_i16)Msg.Rsp.Status;
1042 }

§ sl_Htonl()

_u32 sl_Htonl ( _u32  val)

Reorder the bytes of a 32-bit unsigned value.

This function is used to Reorder the bytes of a 32-bit unsigned value from processor order to network order.

Parameters
[in]valVariable to reorder
Returns
Return the reorder variable,
See also
sl_SendTo sl_Bind sl_Connect sl_RecvFrom sl_Accept
Note
Belongs to send_api
Warning

Definition at line 782 of file sl_socket.c.

783 {
784  _u32 i = 1;
785  _i8 *p = (_i8 *)&i;
786  if (p[0] == 1) /* little endian */
787  {
788  p[0] = ((_i8* )&val)[3];
789  p[1] = ((_i8* )&val)[2];
790  p[2] = ((_i8* )&val)[1];
791  p[3] = ((_i8* )&val)[0];
792  return i;
793  }
794  else /* big endian */
795  {
796  return val;
797  }
798 }

§ sl_Htons()

_u16 sl_Htons ( _u16  val)

Reorder the bytes of a 16-bit unsigned value.

This function is used to Reorder the bytes of a 16-bit unsigned value from processor order to network order.

Parameters
[in]valVariable to reorder
Returns
Return the reorder variable,
See also
sl_SendTo sl_Bind sl_Connect sl_RecvFrom sl_Accept
Note
Belongs to send_api
Warning

Definition at line 803 of file sl_socket.c.

804 {
805  _i16 i = 1;
806  _i8 *p = (_i8 *)&i;
807  if (p[0] == 1) /* little endian */
808  {
809  p[0] = ((_i8* )&val)[1];
810  p[1] = ((_i8* )&val)[0];
811  return (_u16)i;
812  }
813  else /* big endian */
814  {
815  return val;
816  }
817 }

§ sl_Listen()

_i16 sl_Listen ( _i16  sd,
_i16  backlog 
)

Listen for connections on a socket.

The willingness to accept incoming connections and a queue limit for incoming connections are specified with listen(), and then the connections are accepted with accept. The listen() call applies only to sockets of type SOCK_STREAM The backlog parameter defines the maximum length the queue of pending connections may grow to.

Parameters
[in]sdSocket descriptor (handle)
[in]backlogSpecifies the listen queue depth.
Returns
Zero on success, or negative error code on failure
See also
sl_Socket sl_Accept sl_Bind
Note
Belongs to server_side
Warning

Definition at line 649 of file sl_socket.c.

650 {
651  _SlListenMsg_u Msg;
652 
653  /* verify that this api is allowed. if not allowed then
654  ignore the API execution and return immediately with an error */
655  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
656 
657  Msg.Cmd.Sd = (_u8)sd;
658  Msg.Cmd.Backlog = (_u8)backlog;
659 
660  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlListenCmdCtrl, &Msg, NULL));
661  return (_i16)Msg.Rsp.status;
662 }

§ sl_Recv()

_i16 sl_Recv ( _i16  sd,
void *  buf,
_i16  len,
_i16  flags 
)

Read data from TCP socket.

Function receives a message from a connection-mode socket

Parameters
[in]sdSocket handle
[out]bufPoints to the buffer where the message should be stored.
[in]lenSpecifies the length in bytes of the buffer pointed to by the buffer argument. Range: 1-16000 bytes
[in]flagsSpecifies the type of message reception. On this version, this parameter is not supported.
Returns
Return the number of bytes received, or a negative value if an error occurred.
Using a non-blocking recv a possible negative value is SL_EAGAIN.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system In this case try again later or increase MAX_CONCURRENT_ACTIONS
See also
sl_RecvFrom
Note
Belongs to recv_api
Warning
Examples

Definition at line 914 of file sl_socket.c.

915 {
916  _SlRecvMsg_u Msg;
917  _SlCmdExt_t CmdExt;
918  _SlReturnVal_t status;
919 
920  /* verify that this api is allowed. if not allowed then
921  ignore the API execution and return immediately with an error */
922  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
923 
924  _SlDrvResetCmdExt(&CmdExt);
925  CmdExt.RxPayloadLen = Len;
926  CmdExt.pRxPayload = (_u8 *)pBuf;
927 
928  Msg.Cmd.Sd = (_u8)sd;
929  Msg.Cmd.StatusOrLen = (_u16)Len;
930 
931  /* no size truncation in recv path */
932  CmdExt.RxPayloadLen = (_i16)Msg.Cmd.StatusOrLen;
933 
934  Msg.Cmd.FamilyAndFlags = (_u8)(flags & 0x0F);
935 
936  status = _SlDrvDataReadOp((_SlSd_t)sd, (_SlCmdCtrl_t *)&_SlRecvCmdCtrl, &Msg, &CmdExt);
937  if( status != SL_OS_RET_CODE_OK )
938  {
939  return status;
940  }
941 
942  /* if the Device side sends less than expected it is not the Driver's role */
943  /* the returned value could be smaller than the requested size */
944  return (_i16)Msg.Rsp.StatusOrLen;
945 }

§ sl_RecvFrom()

_i16 sl_RecvFrom ( _i16  sd,
void *  buf,
_i16  len,
_i16  flags,
SlSockAddr_t from,
SlSocklen_t *  fromlen 
)

Read data from socket.

Function receives a message from a connection-mode or connectionless-mode socket

Parameters
[in]sdSocket handle
[out]bufPoints to the buffer where the message should be stored.
[in]lenSpecifies the length in bytes of the buffer pointed to by the buffer argument. Range: 1-16000 bytes
[in]flagsSpecifies the type of message reception. On this version, this parameter is not supported.
[in]fromPointer to an address structure indicating the source address.
sockaddr:
- code for the address format. On this version only AF_INET is supported.
- socket address, the length depends on the code format
[in]fromlenSource address structure size. This parameter MUST be set to the size of the structure pointed to by addr.
Returns
Return the number of bytes received, or a negative value if an error occurred.
Using a non-blocking recv a possible negative value is SL_EAGAIN. SL_RET_CODE_INVALID_INPUT (-2) will be returned if fromlen has incorrect length.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system In this case try again later or increase MAX_CONCURRENT_ACTIONS
See also
sl_Recv
Note
Belongs to recv_api
Warning
Example

Definition at line 352 of file sl_socket.c.

353 {
354  _SlRecvfromMsg_u Msg;
355  _SlCmdExt_t CmdExt;
356  _i16 RetVal;
357 
358  /* verify that this api is allowed. if not allowed then
359  ignore the API execution and return immediately with an error */
360  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
361 
362  /* RAW transceiver use only sl_Recv */
363  if ((sd & SL_SOCKET_PAYLOAD_TYPE_MASK) == SL_SOCKET_PAYLOAD_TYPE_RAW_TRANCEIVER)
364  {
365  return SL_ERROR_BSD_SOC_ERROR;
366  }
367 
368  _SlDrvResetCmdExt(&CmdExt);
369  CmdExt.RxPayloadLen = Len;
370  CmdExt.pRxPayload = (_u8 *)buf;
371 
372  Msg.Cmd.Sd = (_u8)sd;
373  Msg.Cmd.StatusOrLen = (_u16)Len;
374 
375  /* no size truncation in recv path */
376  CmdExt.RxPayloadLen = (_i16)Msg.Cmd.StatusOrLen;
377 
378  Msg.Cmd.FamilyAndFlags = (_u8)(flags & 0x0F);
379 
380  if(sizeof(SlSockAddrIn_t) == *fromlen)
381  {
382  Msg.Cmd.FamilyAndFlags |= (SL_AF_INET << 4);
383  }
384  else if (sizeof(SlSockAddrIn6_t) == *fromlen)
385  {
386  Msg.Cmd.FamilyAndFlags |= (SL_AF_INET6 << 4);
387  }
388  else
389  {
390  return SL_RET_CODE_INVALID_INPUT;
391  }
392 
393  RetVal = _SlDrvDataReadOp((_SlSd_t)sd, (_SlCmdCtrl_t *)&_SlRecvfomCmdCtrl, &Msg, &CmdExt);
394  if( RetVal != SL_OS_RET_CODE_OK )
395  {
396  return RetVal;
397  }
398 
399  RetVal = Msg.Rsp.IpV4.StatusOrLen;
400 
401  if(RetVal >= 0)
402  {
403  VERIFY_PROTOCOL(sd == (_i16)Msg.Rsp.IpV4.Sd);
404 #if 0
405  _SlSocketParseAddress(&Msg.Rsp, from, fromlen);
406 #else
407  from->sa_family = Msg.Rsp.IpV4.Family;
408  if(SL_AF_INET == from->sa_family)
409  {
410  ((SlSockAddrIn_t *)from)->sin_port = Msg.Rsp.IpV4.Port;
411  ((SlSockAddrIn_t *)from)->sin_addr.s_addr = Msg.Rsp.IpV4.Address;
412  *fromlen = (SlSocklen_t)sizeof(SlSockAddrIn_t);
413  }
414 #ifdef SL_SUPPORT_IPV6
415  else if(SL_AF_INET6 == from->sa_family)
416  {
417  VERIFY_PROTOCOL(*fromlen >= sizeof(SlSockAddrIn6_t));
418 
419  ((SlSockAddrIn6_t *)from)->sin6_port = Msg.Rsp.IpV6.Port;
420  sl_Memcpy(((SlSockAddrIn6_t *)from)->sin6_addr._S6_un._S6_u32, Msg.Rsp.IpV6.Address, 16);
421  *fromlen = sizeof(SlSockAddrIn6_t);
422  }
423 #endif
424 #endif
425  }
426 
427  return (_i16)RetVal;
428 }

§ sl_Select()

_i16 sl_Select ( _i16  nfds,
SlFdSet_t readsds,
SlFdSet_t writesds,
SlFdSet_t exceptsds,
struct SlTimeval_t timeout 
)

Monitor socket activity.

Select allow a program to monitor multiple file descriptors, waiting until one or more of the file descriptors become "ready" for some class of I/O operation. If trigger mode is enabled the active fdset is the one that retreived in the first triggerd call. To enable the trigger mode, an handler must be statically registered to the slcb_SocketTriggerEventHandler (user.h)

Parameters
[in]nfdsThe highest-numbered file descriptor in any of the three sets, plus 1.
[out]readsdsSocket descriptors list for read monitoring and accept monitoring
[out]writesdsSocket descriptors list for connect monitoring only, write monitoring is not supported
[out]exceptsdsSocket descriptors list for exception monitoring, not supported.
[in]timeoutIs an upper bound on the amount of time elapsed before select() returns. Null or above 0xffff seconds means infinity timeout. The minimum timeout is 10 milliseconds, less than 10 milliseconds will be set automatically to 10 milliseconds. Max microseconds supported is 0xfffc00. In trigger mode the timout fields must be set to zero.
Returns
On success, select() returns the number of file descriptors contained in the three returned descriptor sets (that is, the total number of bits that are set in readfds, writefds, exceptfds) which may be zero if the timeout expires before anything interesting happens.
On error, a negative value is returned. readsds - return the sockets on which Read request will return without delay with valid data.
writesds - return the sockets on which Write request will return without delay.
exceptsds - return the sockets closed recently.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system In this case try again later or increase MAX_CONCURRENT_ACTIONS
See also
sl_Socket
Note
If the timeout value set to less than 10ms it will automatically set to 10ms to prevent overload of the system
Belongs to basic_api

Only one sl_Select can be handled at a time.Calling this API while the same command is called from another thread, may result in one of the following scenarios:

  1. The command will wait (internal) until the previous command finish, and then be executed.
  2. There are not enough resources and SL_POOL_IS_EMPTY error will return. In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try again later to issue the command.
  3. In case there is already a triggered sl_Select in progress, the following call will return with SL_RET_CODE_SOCKET_SELECT_IN_PROGRESS_ERROR.
Warning

Definition at line 1099 of file sl_socket.c.

1100 {
1101  _SlSelectMsg_u Msg;
1102  SlSelectAsyncResponse_t AsyncRsp;
1103  _u8 ObjIdx = MAX_CONCURRENT_ACTIONS;
1104 #if ((defined(SL_RUNTIME_EVENT_REGISTERATION) || defined(slcb_SocketTriggerEventHandler)))
1105  _u8 IsNonBlocking = FALSE;
1106 #endif
1107 
1108  /* verify that this API is allowed. if not allowed then
1109  ignore the API execution and return immediately with an error */
1110  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
1111  _SlDrvMemZero(&AsyncRsp, sizeof(SlSelectAsyncResponse_t));
1112 
1113 #if ((defined(SL_RUNTIME_EVENT_REGISTERATION) || defined(slcb_SocketTriggerEventHandler)))
1114  if(1 == _SlIsEventRegistered(SL_EVENT_HDL_SOCKET_TRIGGER))
1115  {
1116  if( NULL != timeout )
1117  {
1118  /* Set that we are in Non-Blocking mode */
1119  if ( (0 == timeout->tv_sec) && (0 == timeout->tv_usec) )
1120  {
1121  IsNonBlocking = TRUE;
1122  }
1123  else
1124  {
1125  SL_DRV_PROTECTION_OBJ_LOCK_FOREVER();
1126 
1127  /* If there is a trigger select running in the progress abort the new blocking request */
1128  if (g_pCB->SocketTriggerSelect.Info.State > SOCK_TRIGGER_READY)
1129  {
1130  SL_DRV_PROTECTION_OBJ_UNLOCK();
1131  return SL_RET_CODE_SOCKET_SELECT_IN_PROGRESS_ERROR;
1132  }
1133 
1134  SL_DRV_PROTECTION_OBJ_UNLOCK();
1135  }
1136 
1137  if (IsNonBlocking == TRUE)
1138  {
1139  /* return EAGAIN if we alreay have select trigger in progress */
1140  if (g_pCB->SocketTriggerSelect.Info.State == SOCK_TRIGGER_WAITING_FOR_RESP)
1141  {
1142  return SL_ERROR_BSD_EAGAIN;
1143  }
1144  /* return the stored response if already received */
1145  else if (g_pCB->SocketTriggerSelect.Info.State == SOCK_TRIGGER_RESP_RECEIVED)
1146  {
1147 
1148  if( ((_i16)g_pCB->SocketTriggerSelect.Resp.Status) >= 0 )
1149  {
1150  if( readsds )
1151  {
1152  readsds->fd_array[0] = g_pCB->SocketTriggerSelect.Resp.ReadFds;
1153  }
1154  if( writesds )
1155  {
1156  writesds->fd_array[0] = g_pCB->SocketTriggerSelect.Resp.WriteFds;
1157  }
1158  }
1159 
1160  /* Now relaese the pool object */
1161  _SlDrvReleasePoolObj(g_pCB->SocketTriggerSelect.Info.ObjPoolIdx);
1162 
1163  g_pCB->SocketTriggerSelect.Info.ObjPoolIdx = MAX_CONCURRENT_ACTIONS;
1164 
1165  /* Reset the socket select trigger object */
1166  g_pCB->SocketTriggerSelect.Info.State = SOCK_TRIGGER_READY;
1167 
1168  return (_i16)g_pCB->SocketTriggerSelect.Resp.Status;
1169  }
1170  }
1171  }
1172  }
1173 #endif
1174 
1175  Msg.Cmd.Nfds = (_u8)nfds;
1176  Msg.Cmd.ReadFdsCount = 0;
1177  Msg.Cmd.WriteFdsCount = 0;
1178 
1179  Msg.Cmd.ReadFds = 0;
1180  Msg.Cmd.WriteFds = 0;
1181 
1182 
1183  if( readsds )
1184  {
1185  Msg.Cmd.ReadFds = (_u16)readsds->fd_array[0];
1186  }
1187  if( writesds )
1188  {
1189  Msg.Cmd.WriteFds = (_u16)writesds->fd_array[0];
1190  }
1191  if( NULL == timeout )
1192  {
1193  Msg.Cmd.tv_sec = 0xffff;
1194  Msg.Cmd.tv_usec = 0xffff;
1195  }
1196  else
1197  {
1198  if( 0xffff <= timeout->tv_sec )
1199  {
1200  Msg.Cmd.tv_sec = 0xffff;
1201  }
1202  else
1203  {
1204  Msg.Cmd.tv_sec = (_u16)timeout->tv_sec;
1205  }
1206 
1207  /* convert to milliseconds */
1208  timeout->tv_usec = timeout->tv_usec >> 10;
1209 
1210  if( 0xffff <= timeout->tv_usec )
1211  {
1212  Msg.Cmd.tv_usec = 0xffff;
1213  }
1214  else
1215  {
1216  Msg.Cmd.tv_usec = (_u16)timeout->tv_usec;
1217  }
1218 
1219  }
1220 
1221  /* Use Obj to issue the command, if not available try later */
1222  ObjIdx = _SlDrvProtectAsyncRespSetting((_u8*)&AsyncRsp, SELECT_ID, SL_MAX_SOCKETS);
1223 
1224  if (MAX_CONCURRENT_ACTIONS == ObjIdx)
1225  {
1226  return SL_POOL_IS_EMPTY;
1227  }
1228 
1229  /* send the command */
1230  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlSelectCmdCtrl, &Msg, NULL));
1231 
1232  if(SL_OS_RET_CODE_OK == (_i16)Msg.Rsp.status)
1233  {
1234  SL_DRV_SYNC_OBJ_WAIT_FOREVER(&g_pCB->ObjPool[ObjIdx].SyncObj);
1235 
1236  Msg.Rsp.status = (_i16)AsyncRsp.Status;
1237 
1238  /* this code handles the socket trigger mode case */
1239 #if((defined(SL_RUNTIME_EVENT_REGISTERATION) || defined(slcb_SocketTriggerEventHandler)))
1240  if(1 == _SlIsEventRegistered(SL_EVENT_HDL_SOCKET_TRIGGER))
1241  {
1242  /* if no data returned and we are in trigger mode,
1243  send another select cmd but now with timeout infinite,
1244  and return immediately with EAGAIN to the user */
1245  if ((IsNonBlocking == TRUE) && (AsyncRsp.Status == 0))
1246  {
1247  /* set the select trigger-in-progress bit */
1248  g_pCB->SocketTriggerSelect.Info.State = SOCK_TRIGGER_WAITING_FOR_RESP;
1249 
1250  Msg.Cmd.tv_sec = 0xffff;
1251  Msg.Cmd.tv_usec = 0xffff;
1252 
1253  /* Release pool object and try to take another call */
1254  _SlDrvReleasePoolObj(ObjIdx);
1255 
1256  /* Use Obj to issue the command, if not available try later */
1257  ObjIdx = _SlDrvProtectAsyncRespSetting((_u8*)&g_pCB->SocketTriggerSelect.Resp, SELECT_ID, SL_MAX_SOCKETS);
1258 
1259  if (MAX_CONCURRENT_ACTIONS == ObjIdx)
1260  {
1261  return SL_POOL_IS_EMPTY;
1262  }
1263 
1264  /* Save the pool index to be released only after the user read the response */
1265  g_pCB->SocketTriggerSelect.Info.ObjPoolIdx = ObjIdx;
1266 
1267  /* send the command */
1268  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlSelectCmdCtrl, &Msg, NULL));
1269  return SL_ERROR_BSD_EAGAIN;
1270 
1271  }
1272  }
1273 #endif
1274 
1275  if( ((_i16)Msg.Rsp.status) >= 0 )
1276  {
1277  if( readsds )
1278  {
1279  readsds->fd_array[0] = AsyncRsp.ReadFds;
1280  }
1281  if( writesds )
1282  {
1283  writesds->fd_array[0] = AsyncRsp.WriteFds;
1284  }
1285  }
1286  }
1287 
1288  _SlDrvReleasePoolObj(ObjIdx);
1289  return (_i16)Msg.Rsp.status;
1290 }
void slcb_SocketTriggerEventHandler(SlSockTriggerEvent_t *pSlSockTriggerEvent)
Socket trigger routine. This routine will notify the application that a netwrok activity has been com...

§ sl_Send()

_i16 sl_Send ( _i16  sd,
const void *  buf,
_i16  len,
_i16  flags 
)

Write data to TCP socket.

This function is used to transmit a message to another socket. Returns immediately after sending data to device. In case of TCP failure an async event SL_SOCKET_TX_FAILED_EVENT is going to be received.
In case of a RAW socket (transceiver mode), extra 4 bytes should be reserved at the end of the frame data buffer for WLAN FCS

Parameters
[in]sdSocket handle
[in]bufPoints to a buffer containing the message to be sent
[in]lenMessage size in bytes. Range: 1-1460 bytes
[in]flagsSpecifies the type of message transmission. On this version, this parameter is not supported for TCP. For transceiver mode, the SL_WLAN_RAW_RF_TX_PARAMS macro can be used to determine transmission parameters (channel,rate,tx_power,preamble)
Returns
Zero on success, or negative error code on failure
See also
sl_SendTo
Note
Belongs to send_api
Warning
Example

Definition at line 583 of file sl_socket.c.

584 {
585  _SlSendMsg_u Msg;
586  _SlCmdExt_t CmdExt;
587  _i16 RetVal;
588  _u32 tempVal;
589 
590  /* verify that this api is allowed. if not allowed then
591  ignore the API execution and return immediately with an error */
592  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
593 
594  _SlDrvResetCmdExt(&CmdExt);
595  CmdExt.TxPayload1Len = (_u16)Len;
596  CmdExt.pTxPayload1 = (_u8 *)pBuf;
597 
598  /* Only for RAW transceiver type socket, relay the flags parameter in the 2 bytes (4 byte aligned) before the actual payload */
599  if ((sd & SL_SOCKET_PAYLOAD_TYPE_MASK) == SL_SOCKET_PAYLOAD_TYPE_RAW_TRANCEIVER)
600  {
601  tempVal = (_u32)flags;
602  CmdExt.pRxPayload = (_u8 *)&tempVal;
603  CmdExt.RxPayloadLen = -4; /* the (-) sign is used to mark the rx buff as output buff as well*/
604  }
605  else
606  {
607  CmdExt.pRxPayload = NULL;
608  if (Len < 1)
609  {
610  /* ignore */
611  return 0;
612  }
613  }
614 
615  Msg.Cmd.StatusOrLen = Len;
616  Msg.Cmd.Sd = (_u8)sd;
617  Msg.Cmd.FamilyAndFlags |= flags & 0x0F;
618 
619  RetVal = _SlDrvDataWriteOp((_u8)sd, (_SlCmdCtrl_t *)&_SlSendCmdCtrl, &Msg, &CmdExt);
620  if(SL_OS_RET_CODE_OK != RetVal)
621  {
622  return RetVal;
623  }
624 
625  return (_i16)Len;
626 }

§ sl_SendTo()

_i16 sl_SendTo ( _i16  sd,
const void *  buf,
_i16  len,
_i16  flags,
const SlSockAddr_t to,
SlSocklen_t  tolen 
)

Write data to socket.

This function is used to transmit a message to another socket (connection less socket SOCK_DGRAM, SOCK_RAW).
Returns immediately after sending data to device.
In case of transmission failure an async event SL_SOCKET_TX_FAILED_EVENT is going to be received.

Parameters
[in]sdSocket handle
[in]bufPoints to a buffer containing the message to be sent
[in]lenmessage size in bytes. Range: 1-1460 bytes
[in]flagsSpecifies the type of message transmission. On this version, this parameter is not supported
[in]toPointer to an address structure indicating the destination address.
sockaddr:
- code for the address format. On this version only AF_INET is supported.
- socket address, the length depends on the code format
[in]tolenDestination address structure size
Returns
Zero on success, or negative error code on failure
See also
sl_Send
Note
Belongs to send_api
Warning
Example

Definition at line 271 of file sl_socket.c.

272 {
273  _SlSendtoMsg_u Msg;
274  _SlCmdCtrl_t CmdCtrl = {0, 0, 0};
275  _SlCmdExt_t CmdExt;
276  _i16 RetVal;
277 
278  /* verify that this api is allowed. if not allowed then
279  ignore the API execution and return immediately with an error */
280  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
281  /* RAW transceiver use only sl_Send */
282  if ((sd & SL_SOCKET_PAYLOAD_TYPE_MASK) == SL_SOCKET_PAYLOAD_TYPE_RAW_TRANCEIVER)
283  {
284  return SL_ERROR_BSD_SOC_ERROR;
285  }
286  else
287  {
288  if (Len < 1)
289  {
290  /* ignore */
291  return 0;
292  }
293  }
294 
295  _SlDrvResetCmdExt(&CmdExt);
296  CmdExt.TxPayload1Len = (_u16)Len;
297  CmdExt.pTxPayload1 = (_u8 *)pBuf;
298 
299  switch(to->sa_family)
300  {
301  case SL_AF_INET:
302  CmdCtrl.Opcode = SL_OPCODE_SOCKET_SENDTO;
303  CmdCtrl.TxDescLen = (_SlArgSize_t)sizeof(SlSocketAddrIPv4Command_t);
304  break;
305 #ifndef SL_TINY
306 #ifdef SL_SUPPORT_IPV6
307  case SL_AF_INET6:
308  CmdCtrl.Opcode = SL_OPCODE_SOCKET_SENDTO_V6;
309  CmdCtrl.TxDescLen = (_SlArgSize_t)sizeof(SlSocketAddrIPv6Command_t);
310  break;
311 #endif
312 #endif
313  case SL_AF_RF:
314  default:
315  return SL_RET_CODE_INVALID_INPUT;
316  }
317 
318  Msg.Cmd.IpV4.LenOrPadding = Len;
319  Msg.Cmd.IpV4.Sd = (_u8)sd;
320  _SlSocketBuildAddress(to, &Msg.Cmd);
321  Msg.Cmd.IpV4.FamilyAndFlags |= flags & 0x0F;
322 
323  RetVal = _SlDrvDataWriteOp((_SlSd_t)sd, &CmdCtrl, &Msg, &CmdExt);
324  if(SL_OS_RET_CODE_OK != RetVal)
325  {
326  return RetVal;
327  }
328 
329  return (_i16)Len;
330 }

§ sl_SetSockOpt()

_i16 sl_SetSockOpt ( _i16  sd,
_i16  level,
_i16  optname,
const void *  optval,
SlSocklen_t  optlen 
)

Set socket options-.

This function manipulate the options associated with a socket.
Options may exist at multiple protocol levels; they are always present at the uppermost socket level.
When manipulating socket options the level at which the option resides and the name of the option must be specified. To manipulate options at the socket level, level is specified as SOL_SOCKET. To manipulate options at any other level the protocol number of the appropriate proto- col controlling the option is supplied. For example, to indicate that an option is to be interpreted by the TCP protocol, level should be set to the protocol number of TCP;
The parameters optval and optlen are used to access optval - ues for setsockopt(). For getsockopt() they identify a buffer in which the value for the requested option(s) are to be returned. For getsockopt(), optlen is a value-result parameter, initially containing the size of the buffer pointed to by option_value, and modified on return to indicate the actual size of the value returned. If no option value is to be supplied or returned, option_value may be NULL.

Parameters
[in]sdSocket handle
[in]levelDefines the protocol level for this option
  • SL_SOL_SOCKET Socket level configurations (L4, transport layer)
  • SL_IPPROTO_IP IP level configurations (L3, network layer)
  • SL_SOL_PHY_OPT Link level configurations (L2, link layer)
[in]optnameDefines the option name to interrogate
  • SL_SOL_SOCKET
  • SL_SO_KEEPALIVE
    Enable/Disable periodic keep alive. Keeps TCP connections active by enabling the periodic transmission of messages
    Timeout is 5 minutes.
    Default: Enabled
    This options takes SlSockKeepalive_t struct as parameter
    • SL_SO_KEEPALIVETIME
      Set keep alive timeout. Value is in seconds
      Default: 5 minutes
    • SL_SO_RX_NO_IP_BOUNDARY
      Enable/Disable rx ip boundary. In connectionless socket (udp/raw), unread data is dropped (when recvfrom len parameter < data size), Enable this option in order to read the left data on the next recvfrom iteration Default: Disabled, IP boundary kept,
      This options takes SlSockRxNoIpBoundary_t struct as parameter
    • SL_SO_RCVTIMEO
      Sets the timeout value that specifies the maximum amount of time an input function waits until it completes.
      Default: No timeout
      This options takes SlTimeval_t struct as parameter
    • SL_SO_RCVBUF
      Sets tcp max recv window size.
      This options takes SlSockWinsize_t struct as parameter
    • SL_SO_NONBLOCKING
      Sets socket to non-blocking operation Impacts: connect, accept, send, sendto, recv and recvfrom.
      Default: Blocking. This options takes SlSockNonblocking_t struct as parameter
    • SL_SO_SECMETHOD
      Sets method to tcp secured socket (SL_SEC_SOCKET)
      Default: SL_SO_SEC_METHOD_SSLv3_TLSV1_2
      This options takes SlSockSecureMethod_t struct as parameter
    • SL_SO_SECURE_MASK
      Sets specific cipher to tcp secured socket (SL_SEC_SOCKET)
      Default: "Best" cipher suitable to method
      This options takes SlSockSecureMask_t struct as parameter
    • SL_SO_SECURE_FILES_CA_FILE_NAME
      Map secured socket to CA file by name
      This options takes _u8 buffer as parameter
    • SL_SO_SECURE_FILES_PRIVATE_KEY_FILE_NAME
      Map secured socket to private key by name
      This options takes _u8 buffer as parameter
    • SL_SO_SECURE_FILES_CERTIFICATE_FILE_NAME
      Map secured socket to certificate file by name
      This options takes _u8 buffer as parameter
    • SL_SO_SECURE_FILES_DH_KEY_FILE_NAME
      Map secured socket to Diffie Hellman file by name
      This options takes _u8 buffer as parameter
    • SL_SO_CHANGE_CHANNEL
      Sets channel in transceiver mode. This options takes _u32 as channel number parameter
    • SL_SO_SECURE_ALPN
      Sets the ALPN list. the parameter is a bit map consist of or of the following values - SL_SECURE_ALPN_H1 SL_SECURE_ALPN_H2 SL_SECURE_ALPN_H2C SL_SECURE_ALPN_H2_14 SL_SECURE_ALPN_H2_16 SL_SECURE_ALPN_FULL_LIST
  • SL_IPPROTO_IP
    • SL_IP_MULTICAST_TTL
      Set the time-to-live value of outgoing multicast packets for this socket.
      This options takes _u8 as parameter
    • SL_IP_ADD_MEMBERSHIP
      UDP socket, Join a multicast group.
      This options takes SlSockIpMreq_t struct as parameter
    • SL_IP_DROP_MEMBERSHIP
      UDP socket, Leave a multicast group
      This options takes SlSockIpMreq_t struct as parameter
    • SL_IP_RAW_RX_NO_HEADER
      Raw socket remove IP header from received data.
      Default: data includes ip header
      This options takes _u32 as parameter
    • SL_IP_HDRINCL
      RAW socket only, the IPv4 layer generates an IP header when sending a packet unless
      the IP_HDRINCL socket option is enabled on the socket.
      When it is enabled, the packet must contain an IP header.
      Default: disabled, IPv4 header generated by Network Stack
      This options takes _u32 as parameter
    • SL_IP_RAW_IPV6_HDRINCL (inactive)
      RAW socket only, the IPv6 layer generates an IP header when sending a packet unless
      the IP_HDRINCL socket option is enabled on the socket. When it is enabled, the packet must contain an IP header
      Default: disabled, IPv4 header generated by Network Stack
      This options takes _u32 as parameter
  • SL_SOL_PHY_OPT
    • SL_SO_PHY_RATE
      RAW socket, set WLAN PHY transmit rate
      The values are based on SlWlanRateIndex_e
      This options takes _u32 as parameter
    • SL_SO_PHY_TX_POWER
      RAW socket, set WLAN PHY TX power
      Valid rage is 1-15
      This options takes _u32 as parameter
    • SL_SO_PHY_NUM_FRAMES_TO_TX
      RAW socket, set number of frames to transmit in transceiver mode. Default: 1 packet This options takes _u32 as parameter
    • SL_SO_PHY_PREAMBLE
      RAW socket, set WLAN PHY preamble for Long/Short
      This options takes _u32 as parameter
    • SL_SO_PHY_TX_INHIBIT_THRESHOLD
      RAW socket, set WLAN Tx – Set CCA threshold.
      The values are based on SlTxInhibitThreshold_e
      This options takes _u32 as parameter
    • SL_SO_PHY_TX_TIMEOUT
      RAW socket, set WLAN Tx – changes the TX timeout (lifetime) of transceiver frames.
      Value in Ms, maximum value is 10ms
      This options takes _u32 as parameter
    • SL_SO_PHY_ALLOW_ACKS
      RAW socket, set WLAN Tx – Enable sending ACKs in transceiver mode
      0 = disabled / 1 = enabled
      This options takes _u32 as parameter
    • SL_SO_LINGER
      Socket lingers on close pending remaining send/receive packetst
    • SL_SO_SECURE_EXT_CLIENT_CHLNG_RESP
      Set with no parameter to indicate that the client uses external signature using netapp requesrt.
      needs netapp request handler
    • SL_SO_SECURE_DOMAIN_NAME_VERIFICATION
      Set a domain name, to check in ssl client connection.
[in]optvalSpecifies a value for the option
[in]optlenSpecifies the length of the option value
Returns
Zero on success, or negative error code on failure
Persistent
All params are Non- Persistent
See also
sl_getsockopt
Note
Belongs to basic_api
Warning
Examples
  • SL_SO_KEEPALIVE (disable Keepalive):
    SlSockKeepalive_t enableOption;
    enableOption.KeepaliveEnabled = 0;
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_KEEPALIVE, (_u8 *)&enableOption,sizeof(enableOption));

  • SL_SO_KEEPALIVETIME (Set Keepalive timeout):
    _i16 Status;
    _u32 TimeOut = 120;
    sl_SetSockOpt(Sd, SL_SOL_SOCKET, SL_SO_KEEPALIVETIME,( _u8*) &TimeOut, sizeof(TimeOut));

  • SL_SO_RX_NO_IP_BOUNDARY (disable boundary):
    enableOption.RxIpNoBoundaryEnabled = 1;
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_RX_NO_IP_BOUNDARY, (_u8 *)&enableOption,sizeof(enableOption));

  • SL_SO_RCVTIMEO:
    struct SlTimeval_t timeVal;
    timeVal.tv_sec = 1; // Seconds
    timeVal.tv_usec = 0; // Microseconds. 10000 microseconds resolution
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_RCVTIMEO, (_u8 *)&timeVal, sizeof(timeVal)); // Enable receive timeout

  • SL_SO_RCVBUF:
    size.Winsize = 3000; // bytes
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_RCVBUF, (_u8 *)&size, sizeof(size));

  • SL_SO_NONBLOCKING:
    SlSockNonblocking_t enableOption;
    enableOption.NonblockingEnabled = 1;
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_NONBLOCKING, (_u8 *)&enableOption,sizeof(enableOption)); // Enable/disable nonblocking mode

  • SL_SO_SECMETHOD:
    method.SecureMethod = SL_SO_SEC_METHOD_SSLV3; // security method we want to use
    SockID = sl_Socket(SL_AF_INET,SL_SOCK_STREAM, SL_SEC_SOCKET);
    sl_SetSockOpt(SockID, SL_SOL_SOCKET, SL_SO_SECMETHOD, (_u8 *)&method, sizeof(method));

  • SL_SO_SECURE_MASK:
    cipher.SecureMask = SL_SEC_MASK_SSL_RSA_WITH_RC4_128_SHA; // cipher type
    SockID = sl_Socket(SL_AF_INET,SL_SOCK_STREAM, SL_SEC_SOCKET);
    sl_SetSockOpt(SockID, SL_SOL_SOCKET, SL_SO_SECURE_MASK,(_u8 *)&cipher, sizeof(cipher));

  • SL_SO_SECURE_FILES_CA_FILE_NAME:
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_SECURE_FILES_CA_FILE_NAME,"exuifaxCaCert.der",strlen("exuifaxCaCert.der"));

  • SL_SO_SECURE_FILES_PRIVATE_KEY_FILE_NAME;
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_SECURE_FILES_PRIVATE_KEY_FILE_NAME,"myPrivateKey.der",strlen("myPrivateKey.der"));

  • SL_SO_SECURE_FILES_CERTIFICATE_FILE_NAME:
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_SECURE_FILES_CERTIFICATE_FILE_NAME,"myCertificate.der",strlen("myCertificate.der"));

  • SL_SO_SECURE_FILES_DH_KEY_FILE_NAME:
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_SECURE_FILES_DH_KEY_FILE_NAME,"myDHinServerMode.der",strlen("myDHinServerMode.der"));

  • SL_IP_MULTICAST_TTL:
    _u8 ttl = 20;
    sl_SetSockOpt(SockID, SL_IPPROTO_IP, SL_IP_MULTICAST_TTL, &ttl, sizeof(ttl));

  • SL_IP_ADD_MEMBERSHIP:
    sl_SetSockOpt(SockID, SL_IPPROTO_IP, SL_IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq));

  • SL_IP_DROP_MEMBERSHIP:
    sl_SetSockOpt(SockID, SL_IPPROTO_IP, SL_IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq));

  • SL_SO_CHANGE_CHANNEL:
    _u32 newChannel = 6; // range is 1-13
    sl_SetSockOpt(SockID, SL_SOL_SOCKET, SL_SO_CHANGE_CHANNEL, &newChannel, sizeof(newChannel));

  • SL_SO_SECURE_ALPN:
    alpn.SecureALPN = SL_SECURE_ALPN_H2 | SL_SECURE_ALPN_H2_14;
    sl_SetSockOpt(SockID, SL_SOL_SOCKET, SL_SO_SECURE_ALPN, &alpn, sizeof(SlSockSecureALPN_t));

  • SL_IP_RAW_RX_NO_HEADER:
    _u32 header = 1; // remove ip header
    sl_SetSockOpt(SockID, SL_IPPROTO_IP, SL_IP_RAW_RX_NO_HEADER, &header, sizeof(header));

  • SL_IP_HDRINCL:
    _u32 header = 1;
    sl_SetSockOpt(SockID, SL_IPPROTO_IP, SL_IP_HDRINCL, &header, sizeof(header));

  • SL_IP_RAW_IPV6_HDRINCL:
    _u32 header = 1;
    sl_SetSockOpt(SockID, SL_IPPROTO_IP, SL_IP_RAW_IPV6_HDRINCL, &header, sizeof(header));

  • SL_SO_PHY_RATE:
    _u32 rate = 6; // see wlan.h SlWlanRateIndex_e for values
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_RATE, &rate, sizeof(rate));

  • SL_SO_PHY_TX_POWER:
    _u32 txpower = 1; // valid range is 1-15
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_TX_POWER, &txpower, sizeof(txpower));

  • SL_SO_PHY_NUM_FRAMES_TO_TX:
    _u32 numframes = 1;
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_NUM_FRAMES_TO_TX, &numframes, sizeof(numframes));

  • SL_SO_PHY_PREAMBLE:
    _u32 preamble = 1;
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_PREAMBLE, &preamble, sizeof(preamble));

  • SL_SO_PHY_TX_INHIBIT_THRESHOLD:
    _u32 thrshld = SL_TX_INHIBIT_THRESHOLD_MED;
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_TX_INHIBIT_THRESHOLD , &thrshld, sizeof(thrshld));

  • SL_SO_PHY_TX_TIMEOUT:
    _u32 timeout = 50;
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_TX_TIMEOUT , &timeout, sizeof(timeout));

  • SL_SO_PHY_ALLOW_ACKS:
    _u32 acks = 1; // 0 = disabled / 1 = enabled
    sl_SetSockOpt(SockID, SL_SOL_PHY_OPT, SL_SO_PHY_ALLOW_ACKS, &acks, sizeof(acks));

  • SL_SO_LINGER:
    linger.l_onoff = 1;
    linger.l_linger = 10;
    sl_SetSockOpt(SockID, SL_SOL_SOCKET, SL_SO_LINGER, &linger, sizeof(linger));

  • SL_SO_SECURE_EXT_CLIENT_CHLNG_RESP:
    int dummy;
    sl_SetSockOpt(SockID, SL_SOL_SOCKET, SL_SO_SECURE_EXT_CLIENT_CHLNG_RESP, &dummy, sizeof(dummy));

  • SL_SO_SECURE_DOMAIN_NAME_VERIFICATION:
    sl_SetSockOpt(SockID,SL_SOL_SOCKET,SL_SO_SECURE_DOMAIN_NAME_VERIFICATION,"www.google.co.il",strlen("www.google.co.il"));

Definition at line 965 of file sl_socket.c.

966 {
967  _SlSetSockOptMsg_u Msg;
968  _SlCmdExt_t CmdExt;
969 
970  /* verify that this api is allowed. if not allowed then
971  ignore the API execution and return immediately with an error */
972  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
973 
974  _SlDrvResetCmdExt(&CmdExt);
975  CmdExt.TxPayload1Len = optlen;
976  CmdExt.pTxPayload1 = (_u8 *)optval;
977 
978  Msg.Cmd.Sd = (_u8)sd;
979  Msg.Cmd.Level = (_u8)level;
980  Msg.Cmd.OptionLen = (_u8)optlen;
981  Msg.Cmd.OptionName = (_u8)optname;
982 
983  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlSetSockOptCmdCtrl, &Msg, &CmdExt));
984 
985  return (_i16)Msg.Rsp.StatusOrLen;
986 }

§ sl_Socket()

_i16 sl_Socket ( _i16  Domain,
_i16  Type,
_i16  Protocol 
)

Create an endpoint for communication.

The socket function creates a new socket of a certain socket type, identified by an integer number, and allocates system resources to it.
This function is called by the application layer to obtain a socket handle.

Parameters
[in]DomainSpecifies the protocol family of the created socket. For example:
  • SL_AF_INET for network protocol IPv4
  • SL_AF_INET6 for network protocol IPv6
  • SL_AF_RF for starting transceiver mode. Notes:
    • sending and receiving any packet overriding 802.11 header
    • for optimized power consumption the socket will be started in TX only mode until receive command is activated
[in]Typespecifies the communication semantic, one of:
  • SL_SOCK_STREAM (reliable stream-oriented service or Stream Sockets)
  • SL_SOCK_DGRAM (datagram service or Datagram Sockets)
  • SL_SOCK_RAW (raw protocols atop the network layer)
  • when used with AF_RF:
    • SL_SOCK_DGRAM - L2 socket
    • SL_SOCK_RAW - L1 socket - bypass WLAN CCA (Clear Channel Assessment)
[in]Protocolspecifies a particular transport to be used with the socket.
The most common are
  • SL_IPPROTO_TCP
  • SL_IPPROTO_UDP The value 0 may be used to select a default protocol from the selected domain and type
Returns
On success, socket handle that is used for consequent socket operations.
A successful return code should be a positive number (int16)
On error, a negative (int16) value will be returned specifying the error code.
  • SL_EAFNOSUPPORT - illegal domain parameter
  • SL_EPROTOTYPE - illegal type parameter
  • SL_EACCES - permission denied
  • SL_ENSOCK - exceeded maximal number of socket
  • SL_ENOMEM - memory allocation error
  • SL_EINVAL - error in socket configuration
  • SL_EPROTONOSUPPORT - illegal protocol parameter
  • SL_EOPNOTSUPP - illegal combination of protocol and type parameters
See also
sl_Close
Note
belongs to basic_api
Warning

Definition at line 118 of file sl_socket.c.

119 {
120  _SlSockSocketMsg_u Msg;
121 
122  Msg.Cmd.Domain = (_u8)Domain;
123  Msg.Cmd.Type = (_u8)Type;
124  Msg.Cmd.Protocol = (_u8)Protocol;
125 
126  /* verify that this api is allowed. if not allowed then
127  ignore the API execution and return immediately with an error */
128  VERIFY_API_ALLOWED(SL_OPCODE_SILO_SOCKET);
129 
130  VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlSockSocketCmdCtrl, &Msg, NULL));
131 
132  if( Msg.Rsp.StatusOrLen < 0 )
133  {
134  return ( Msg.Rsp.StatusOrLen);
135  }
136  else
137  {
138  return (_i16)((_u8)Msg.Rsp.Sd);
139  }
140 }

Data Structure Documentation

§ SlInAddr_t

struct SlInAddr_t

Definition at line 200 of file sl_socket.h.

Data Fields
_u32 s_addr
union S_un S_un

§ SlIn6Addr_t

struct SlIn6Addr_t

Definition at line 214 of file sl_socket.h.

Data Fields
union SlIn6Addr_t _S6_un

§ SlIn6Addr_t._S6_un

union SlIn6Addr_t._S6_un

Definition at line 216 of file sl_socket.h.

Data Fields
_u32 _S6_u32[4]
_u8 _S6_u8[16]

§ SlSockKeepalive_t

struct SlSockKeepalive_t

Definition at line 225 of file sl_socket.h.

Data Fields
_u32 KeepaliveEnabled

§ SlSockReuseaddr_t

struct SlSockReuseaddr_t

Definition at line 230 of file sl_socket.h.

Data Fields
_u32 ReuseaddrEnabled

§ SlSockRxNoIpBoundary_t

struct SlSockRxNoIpBoundary_t

Definition at line 235 of file sl_socket.h.

Data Fields
_i32 RxIpNoBoundaryEnabled

§ SlSockWinsize_t

struct SlSockWinsize_t

Definition at line 241 of file sl_socket.h.

Data Fields
_u32 WinSize

§ SlSockNonblocking_t

struct SlSockNonblocking_t

Definition at line 246 of file sl_socket.h.

Data Fields
_u32 NonBlockingEnabled

§ SlSocketAsyncEvent_t

struct SlSocketAsyncEvent_t

Definition at line 251 of file sl_socket.h.

Data Fields
_i8 pExtraInfo[128]
_u8 Sd
_u8 Type
_i16 Val

§ SlSockTxFailEventData_t

struct SlSockTxFailEventData_t

Definition at line 259 of file sl_socket.h.

Data Fields
_u8 Padding
_u8 Sd
_i16 Status

§ SlSockEventData_u

union SlSockEventData_u

Definition at line 267 of file sl_socket.h.

Data Fields
SlSocketAsyncEvent_t SockAsyncData
SlSockTxFailEventData_t SockTxFailData

§ SlSockEvent_t

struct SlSockEvent_t

Definition at line 274 of file sl_socket.h.

Data Fields
_u32 Event
SlSockEventData_u SocketAsyncEvent

§ SlSockTriggerEvent_t

struct SlSockTriggerEvent_t

Definition at line 280 of file sl_socket.h.

Data Fields
_u32 Event
_u32 EventData

§ SlSockSecureALPN_t

struct SlSockSecureALPN_t

Definition at line 287 of file sl_socket.h.

Data Fields
_u32 SecureALPN

§ SlSockSecureMask_t

struct SlSockSecureMask_t

Definition at line 292 of file sl_socket.h.

Data Fields
_u32 SecureMask

§ SlSockSecureMethod_t

struct SlSockSecureMethod_t

Definition at line 297 of file sl_socket.h.

Data Fields
_u8 SecureMethod

§ SlSockSSLCertInfo_t

struct SlSockSSLCertInfo_t

Definition at line 302 of file sl_socket.h.

Data Fields
_i8 FromDate[8]
_i8 IssuerName[SL_MAX_ISSUER_AND_SUBJECT_NAME_LEN]
_i8 IssuerNameLen
_u16 IssuerNameXoredSha1
_i8 Padding[2]
_i8 SubjectName[SL_MAX_ISSUER_AND_SUBJECT_NAME_LEN]
_i8 SubjectNameLen
_u16 SubjectNameXoredSha1
_i8 ToDate[8]

§ SlSockSSLConnectionParams_t

struct SlSockSSLConnectionParams_t

Definition at line 316 of file sl_socket.h.

Data Fields
_u32 SecureALPNChosenProtocol
_u32 SecureCipherSuit
_u32 SecureIsPeerValidated
SlSockSSLCertInfo_t SecurePeerCertinfo
_u32 SecureVersion

§ SlSockIpMreq_t

struct SlSockIpMreq_t

Definition at line 339 of file sl_socket.h.

Data Fields
SlInAddr_t imr_interface
SlInAddr_t imr_multiaddr

§ SlSockIpV6Mreq_t

struct SlSockIpV6Mreq_t

Definition at line 345 of file sl_socket.h.

Data Fields
_u32 ipv6mr_interface
SlIn6Addr_t ipv6mr_multiaddr

§ SlSocklinger_t

struct SlSocklinger_t

Definition at line 350 of file sl_socket.h.

Data Fields
_u32 l_linger
_u32 l_onoff

§ SlTimeval_t

struct SlTimeval_t

Definition at line 360 of file sl_socket.h.

Data Fields
SlTime_t tv_sec
SlSuseconds_t tv_usec

§ SlSockAddr_t

struct SlSockAddr_t

Definition at line 369 of file sl_socket.h.

Data Fields
_u8 sa_data[14]
_u16 sa_family

§ SlSockAddrIn6_t

struct SlSockAddrIn6_t

Definition at line 376 of file sl_socket.h.

Data Fields
SlIn6Addr_t sin6_addr
_u16 sin6_family
_u32 sin6_flowinfo
_u16 sin6_port
_u32 sin6_scope_id

§ SlSockAddrIn_t

struct SlSockAddrIn_t

Definition at line 387 of file sl_socket.h.

Data Fields
SlInAddr_t sin_addr
_u16 sin_family
_u16 sin_port
_i8 sin_zero[8]

§ SlSockSecureFiles_t

struct SlSockSecureFiles_t

Definition at line 396 of file sl_socket.h.

Data Fields
_u8 SecureFiles[4]

§ SlFdSet_t

struct SlFdSet_t

Definition at line 402 of file sl_socket.h.

Data Fields
_u32 fd_array[(SL_FD_SETSIZE+(_u8) 31)/(_u8) 32]

§ SlTransceiverRxOverHead_t

struct SlTransceiverRxOverHead_t

Definition at line 407 of file sl_socket.h.

Data Fields
_u8 Channel
_u8 Padding
_u8 Rate
_i8 Rssi
_u32 Timestamp