Device

Controls the behaviour of the CC31xx/CC32xx device (start/stop, events masking and obtaining specific device status) More...

Functions
_i16	sl_Start (const void *pIfHdl, _i8 *pDevName, const P_INIT_CALLBACK pInitCallBack)
	Start the SimpleLink device. More...
_i16	sl_Stop (const _u16 Timeout)
	Stop the SimpleLink device. More...
_i16	sl_DeviceSet (const _u8 DeviceSetId, const _u8 Option, const _u16 ConfigLen, const _u8 *pValues)
	Setting device configurations. More...
_i16	sl_DeviceGet (const _u8 DeviceGetId, _u8 *pOption, _u16 *pConfigLen, _u8 *pValues)
	Internal function for getting device configurations. More...
_i16	sl_DeviceEventMaskSet (const _u8 EventClass, const _u32 Mask)
	Set asynchronous event mask. More...
_i16	sl_DeviceEventMaskGet (const _u8 EventClass, _u32 *pMask)
	Get current event mask of the device. More...
void *	sl_Task (void *pEntry)
	The SimpleLink task entry. More...
_i16	sl_DeviceUartSetMode (const SlDeviceUartIfParams_t *pUartParams)
	Setting the internal uart mode. More...

Typedefs
typedef struct SlDeviceFatalNoCmdAck_t	SlDeviceFatalCmdTimeout_t
typedef void(*	P_INIT_CALLBACK) (_u32 Status, SlDeviceInitInfo_t *DeviceInitInfo)

Enumerations
enum	SlDeviceEventId_e {   SL_DEVICE_EVENT_FATAL_DEVICE_ABORT = 1,   SL_DEVICE_EVENT_FATAL_DRIVER_ABORT,   SL_DEVICE_EVENT_FATAL_SYNC_LOSS,   SL_DEVICE_EVENT_FATAL_NO_CMD_ACK,   SL_DEVICE_EVENT_FATAL_CMD_TIMEOUT,   SL_DEVICE_EVENT_RESET_REQUEST,   SL_DEVICE_EVENT_ERROR,   SL_DEVICE_EVENT_MAX }
enum	SlDeviceSource_e {   SL_DEVICE_SOURCE_OTHER,   SL_DEVICE_SOURCE_WLAN,   SL_DEVICE_SOURCE_NETCFG,   SL_DEVICE_SOURCE_NETAPP,   SL_DEVICE_SOURCE_SECURITY,   SL_DEVICE_SOURCE_LAST = 0xFF }
enum	SlDeviceResetRequestCaller_e {   SL_DEVICE_RESET_REQUEST_CALLER_PROVISIONING,   SL_DEVICE_RESET_REQUEST_CALLER_PROVISIONING_EXTERNAL_CONFIGURATION,   SL_DEVICE_RESET_REQUEST_NUM_OF_CALLERS }

Detailed Description

Controls the behaviour of the CC31xx/CC32xx device (start/stop, events masking and obtaining specific device status)

Function Documentation

sl_DeviceEventMaskGet()

_i16 sl_DeviceEventMaskGet	(	const _u8	EventClass,
		_u32 *	pMask
	)

Get current event mask of the device.

Return the events bit mask from the device. In case event is masked, the device will not send that event.

Parameters

[in]	EventClass	The classification groups that the mask is referred to. Need to be one of the following: SL_DEVICE_EVENT_CLASS_GLOBAL SL_DEVICE_EVENT_CLASS_DEVICE SL_DEVICE_EVENT_CLASS_WLAN SL_DEVICE_EVENT_CLASS_BSD SL_DEVICE_EVENT_CLASS_NETAPP SL_DEVICE_EVENT_CLASS_NETCFG SL_DEVICE_EVENT_CLASS_FS
[out]	pMask	Pointer to mask bitmap where the value should be stored. Bitmasks are the same as in sl_DeviceEventMaskSet

Returns

Zero on success, or a negative value if an error occurred

See also

sl_DeviceEventMaskSet

Note

Belongs to ext_api

Warning

Example

• Getting an event mask for WLAN class:

  _u32 maskWlan;
  sl_DeviceEventMaskGet(SL_DEVICE_EVENT_CLASS_WLAN,&maskWlan);

Definition at line 427 of file device.c.

{
    _SlEventMaskGetMsg_u Msg;

    /* verify that this api is allowed. if not allowed then
    ignore the API execution and return immediately with an error */
    VERIFY_API_ALLOWED(SL_OPCODE_SILO_DEVICE);

    Msg.Cmd.Group = EventClass;

    VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlEventMaskGetCmdCtrl, &Msg, NULL));

    *pMask = Msg.Rsp.Mask;

    return SL_RET_CODE_OK;
}

sl_DeviceEventMaskSet()

_i16 sl_DeviceEventMaskSet	(	const _u8	EventClass,
		const _u32	Mask
	)

Set asynchronous event mask.

Mask asynchronous events from the device.
Masked events do not generate asynchronous messages from the device.
By default - all events are active

Parameters

[in]	EventClass	The classification groups that the mask is referred to. Need to be one of the following: SL_DEVICE_EVENT_CLASS_DEVICE SL_DEVICE_EVENT_CLASS_WLAN SL_DEVICE_EVENT_CLASS_BSD SL_DEVICE_EVENT_CLASS_NETAPP SL_DEVICE_EVENT_CLASS_NETCFG SL_DEVICE_EVENT_CLASS_FS
[in]	Mask	Event Mask bitmap. Valid mask are (per group): SL_DEVICE_EVENT_CLASS_WLAN user events SL_WLAN_EVENT_CONNECT SL_WLAN_EVENT_P2P_CONNECT SL_WLAN_EVENT_DISCONNECT SL_WLAN_EVENT_P2P_DISCONNECT SL_WLAN_EVENT_STA_ADDED SL_WLAN_EVENT_STA_REMOVED SL_WLAN_EVENT_P2P_CLIENT_ADDED SL_WLAN_EVENT_P2P_CLIENT_REMOVED SL_WLAN_EVENT_P2P_DEVFOUND SL_WLAN_EVENT_P2P_REQUEST SL_WLAN_EVENT_P2P_CONNECTFAIL SL_WLAN_EVENT_PROVISIONING_STATUS SL_WLAN_EVENT_PROVISIONING_PROFILE_ADDED SL_WLAN_EVENT_RXFILTER SL_DEVICE_EVENT_CLASS_DEVICE user events SL_DEVICE_EVENT_ERROR SL_DEVICE_EVENT_CLASS_BSD user events SL_SOCKET_TX_FAILED_EVENT SL_SOCKET_ASYNC_EVENT SL_DEVICE_EVENT_CLASS_NETAPP user events SL_NETAPP_EVENT_IPV4_ACQUIRED SL_NETAPP_EVENT_IPV6_ACQUIRED SL_NETAPP_EVENT_DHCPV4_LEASED SL_NETAPP_EVENT_DHCPV4_RELEASED SL_NETAPP_EVENT_IP_COLLISION SL_NETAPP_EVENT_IPV4_LOST SL_NETAPP_EVENT_DHCP_IPV4_ACQUIRE_TIMEOUT SL_NETAPP_EVENT_IPV6_LOST

Returns

Zero on success, or a negative value if an error occurred

Persistent System Persistent

See also

sl_DeviceEventMaskGet

Note

Belongs to ext_api

Warning

Example

• Masking connection/disconnection async events from WLAN class:

  sl_DeviceEventMaskSet(SL_DEVICE_EVENT_CLASS_WLAN, (SL_DEVICE_EVENT_BIT(SL_WLAN_EVENT_CONNECT) | SL_DEVICE_EVENT_BIT(SL_WLAN_EVENT_DISCONNECT) ) );

Definition at line 389 of file device.c.

{
    _SlEventMaskSetMsg_u Msg;

    /* verify that this api is allowed. if not allowed then
    ignore the API execution and return immediately with an error */
    VERIFY_API_ALLOWED(SL_OPCODE_SILO_DEVICE);

    Msg.Cmd.Group = EventClass;
    Msg.Cmd.Mask = Mask;

    VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlEventMaskSetCmdCtrl, &Msg, NULL));

    return (_i16)Msg.Rsp.status;
}

sl_DeviceGet()

_i16 sl_DeviceGet	(	const _u8	DeviceGetId,
		_u8 *	pOption,
		_u16 *	pConfigLen,
		_u8 *	pValues
	)

Internal function for getting device configurations.

Parameters

[in]	DeviceGetId	configuration id: SL_DEVICE_STATUS SL_DEVICE_GENERAL SL_DEVICE_IOT
[out]	pOption	Get configurations option: SL_DEVICE_STATUS: SL_DEVICE_EVENT_CLASS_DEVICE SL_DEVICE_EVENT_CLASS_WLAN SL_DEVICE_EVENT_CLASS_BSD SL_DEVICE_EVENT_CLASS_NETAPP SL_DEVICE_EVENT_CLASS_NETCFG SL_DEVICE_EVENT_CLASS_FS SL_DEVICE_GENERAL: SL_DEVICE_GENERAL_VERSION SL_DEVICE_GENERAL_DATE_TIME SL_DEVICE_GENERAL_PERSISTENT SL_DEVICE_IOT: SL_DEVICE_IOT_UDID
[out]	pConfigLen	The length of the allocated memory as input, when the function complete, the value of this parameter would be the len that actually read from the device. If the device return length that is longer from the input value, the function will cut the end of the returned structure and will return SL_ESMALLBUF
[out]	pValues	Get requested configurations values

Returns

Zero on success, or a negative value if an error occurred

See also

Note

Warning

Examples

• Getting WLAN class status (status is always cleared on read):

  _u32 statusWlan;
  _u8 pConfigOpt;
  _u16 pConfigLen;
  pConfigOpt = SL_DEVICE_EVENT_CLASS_WLAN;
  pConfigLen = sizeof(_u32);
  sl_DeviceGet(SL_DEVICE_STATUS,&pConfigOpt,&pConfigLen,(_u8 *)(&statusWlan));
  if (SL_DEVICE_STATUS_WLAN_STA_CONNECTED & statusWlan )
  {
     printf("Device is connected\n");
  }
  if (SL_DEVICE_EVENT_DROPPED_WLAN_RX_FILTERS & statusWlan )
  {
     printf("RX filer event dropped\n");
  }

  
  
• Getting version:

  SlDeviceVersion_t ver;
  pConfigLen = sizeof(ver);
  pConfigOpt = SL_DEVICE_GENERAL_VERSION;
  sl_DeviceGet(SL_DEVICE_GENERAL,&pConfigOpt,&pConfigLen,(_u8 *)(&ver));
  printf("CHIP %d\nMAC 31.%d.%d.%d.%d\nPHY %d.%d.%d.%d\nNWP %d.%d.%d.%d\nROM %d\nHOST %d.%d.%d.%d\n",
                   ver.ChipId,
                   ver.FwVersion[0],ver.FwVersion[1],
                   ver.FwVersion[2],ver.FwVersion[3],
                   ver.PhyVersion[0],ver.PhyVersion[1],
                   ver.PhyVersion[2],ver.PhyVersion[3],
                   ver.NwpVersion[0],ver.NwpVersion[1],ver.NwpVersion[2],ver.NwpVersion[3],
                   ver.RomVersion,
                   SL_MAJOR_VERSION_NUM,SL_MINOR_VERSION_NUM,SL_VERSION_NUM,SL_SUB_VERSION_NUM);

  
  
• Getting Device time and date:

  SlDateTime_t dateTime =  {0};  
  _i16 configLen = sizeof(SlDateTime_t); 
  _i8 configOpt = SL_DEVICE_GENERAL_DATE_TIME;
  sl_DeviceGet(SL_DEVICE_GENERAL,&configOpt, &configLen,(_u8 *)(&dateTime)); 
  
  printf("Day %d,Mon %d,Year %d,Hour %,Min %d,Sec %d\n",dateTime.tm_day,dateTime.tm_mon,dateTime.tm_year,
          dateTime.tm_hour,dateTime.tm_min,dateTime.tm_sec);

• Getting persistency system configuration:

  _i16 configLen = sizeof(_u8); 
  _i8 configOpt = SL_DEVICE_GENERAL_PERSISTENT;
  sl_DeviceGet(SL_DEVICE_GENERAL,&configOpt, &configLen,&persistent); 

Definition at line 468 of file device.c.

{
    _SlDeviceMsgGet_u         Msg;
    _SlCmdExt_t               CmdExt;

    /* verify that this api is allowed. if not allowed then
    ignore the API execution and return immediately with an error */
    VERIFY_API_ALLOWED(SL_OPCODE_SILO_DEVICE);

    if (*pConfigLen == 0)
    {
        return SL_EZEROLEN;
    }

    if( pOption )
    {

       _SlDrvResetCmdExt(&CmdExt);
        CmdExt.RxPayloadLen = (_i16)*pConfigLen;
        CmdExt.pRxPayload = (_u8 *)pValues;

        Msg.Cmd.DeviceSetId = DeviceGetId;

        Msg.Cmd.Option   = (_u16)*pOption;

        VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlDeviceGetCmdCtrl, &Msg, &CmdExt));

        if( pOption )
        {
            *pOption = (_u8)Msg.Rsp.Option;
        }

        if (CmdExt.RxPayloadLen < CmdExt.ActualRxPayloadLen) 
        {
            *pConfigLen = (_u16)CmdExt.RxPayloadLen;

            return SL_ESMALLBUF;
        }
        else
        {
            *pConfigLen = (_u16)CmdExt.ActualRxPayloadLen;
        }

        return (_i16)Msg.Rsp.Status;
    }
    else
    {
        return SL_RET_CODE_INVALID_INPUT;
    }
}

sl_DeviceSet()

_i16 sl_DeviceSet	(	const _u8	DeviceSetId,
		const _u8	Option,
		const _u16	ConfigLen,
		const _u8 *	pValues
	)

Setting device configurations.

Parameters

[in]	DeviceSetId	configuration id: SL_DEVICE_GENERAL
[in]	Option	configurations option: SL_DEVICE_GENERAL_DATE_TIME SL_DEVICE_GENERAL_PERSISTENT
[in]	ConfigLen	configurations len
[in]	pValues	configurations values

Returns

Zero on success, or a negative value if an error occurred

Persistent

SL_DEVICE_GENERAL_DATE_TIME - Non-Persistent (Kept during hibernate) SL_DEVICE_GENERAL_PERSISTENT - Persistent

See also

Note

Warning

Examples:

• Setting device time and date example:

  SlDateTime_t dateTime= {0};
  dateTime.tm_day =   (_u32)23;          // Day of month (DD format) range 1-31
  dateTime.tm_mon =   (_u32)6;           // Month (MM format) in the range of 1-12 
  dateTime.tm_year =  (_u32)2014;        // Year (YYYY format) 
  dateTime.tm_hour =  (_u32)17;          // Hours in the range of 0-23
  dateTime.tm_min =   (_u32)55;          // Minutes in the range of 0-59
  dateTime.tm_sec =   (_u32)22;          // Seconds in the range of  0-59
  sl_DeviceSet(SL_DEVICE_GENERAL,
            SL_DEVICE_GENERAL_DATE_TIME,
            sizeof(SlDateTime_t),
            (_u8 *)(&dateTime));

  
  
• Setting system persistent configuration:
  Sets the default system-wide configuration persistence mode. In case true, all APIs that follow 'system configured' persistence (see persistence attribute noted per API) shall maintain the configured settings. In case false, all calls to APIs that follow 'system configured' persistence shall be volatile. Configuration should revert to default after reset or power recycle

  _u8 persistent = 1;
  sl_DeviceSet(SL_DEVICE_GENERAL,
             SL_DEVICE_GENERAL_PERSISTENT,
             sizeof(_u8),
             (_u8 *)(&persistent));

Definition at line 540 of file device.c.

{
    _SlDeviceMsgSet_u         Msg;
    _SlCmdExt_t               CmdExt;

    /* verify that this api is allowed. if not allowed then
    ignore the API execution and return immediately with an error */
    VERIFY_API_ALLOWED(SL_OPCODE_SILO_DEVICE);

    _SlDrvResetCmdExt(&CmdExt);

    CmdExt.TxPayload1Len = (ConfigLen+3) & (~3);
    CmdExt.pTxPayload1 = (_u8 *)pValues;

    Msg.Cmd.DeviceSetId    = DeviceSetId;
    Msg.Cmd.ConfigLen   = ConfigLen;
    Msg.Cmd.Option   = Option;

    VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlDeviceSetCmdCtrl, &Msg, &CmdExt));

    return (_i16)Msg.Rsp.status;
}

sl_DeviceUartSetMode()

_i16 sl_DeviceUartSetMode

(

const SlDeviceUartIfParams_t *

pUartParams

)

Setting the internal uart mode.

Parameters

[in]

pUartParams

Pointer to the uart configuration parameter set: baudrate - up to 711 Kbps flow control - enable/disable comm port - the comm port number

Returns

On success zero is returned, otherwise - Failed.

See also

Note

Belongs to basic_api

Warning

This function must consider the host uart capability

Definition at line 715 of file device.c.

{
    _SlUartSetModeMsg_u Msg;
    _u32 magicCode = (_u32)0xFFFFFFFF;

    Msg.Cmd.BaudRate = pUartParams->BaudRate;
    Msg.Cmd.FlowControlEnable = pUartParams->FlowControlEnable;


    VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlUartSetModeCmdCtrl, &Msg, NULL));

    /* cmd response OK, we can continue with the handshake */
    if (SL_RET_CODE_OK == Msg.Rsp.status)
    {
        sl_IfMaskIntHdlr();

        /* Close the comm port */
        sl_IfClose(g_pCB->FD);

        /* Re-open the comm port */
        sl_IfOpen((void * )pUartParams, SL_IF_UART_REOPEN_FLAGS);

        sl_IfUnMaskIntHdlr();

        /* send the magic code and wait for the response */
        sl_IfWrite(g_pCB->FD, (_u8* )&magicCode, 4);

        magicCode = UART_SET_MODE_MAGIC_CODE;
        sl_IfWrite(g_pCB->FD, (_u8* )&magicCode, 4);

        /* clear magic code */
        magicCode = 0;

        /* wait (blocking) till the magic code to be returned from device */
        sl_IfRead(g_pCB->FD, (_u8* )&magicCode, 4);

        /* check for the received magic code matching */
        if (UART_SET_MODE_MAGIC_CODE != magicCode)
        {
            _SL_ASSERT(0);
        }
    }

    return (_i16)Msg.Rsp.status;
}

sl_Start()

_i16 sl_Start	(	const void *	pIfHdl,
		_i8 *	pDevName,
		const P_INIT_CALLBACK	pInitCallBack
	)

Start the SimpleLink device.

This function initialize the communication interface, set the enable pin of the device, and call to the init complete callback.

Parameters

[in]	pIfHdl	Opened Interface Object. In case the interface must be opened outside the SimpleLink Driver, the user might give the handler to be used in any access of the communication interface with the device (UART/SPI). The SimpleLink driver will open an interface port only if this parameter is null!
[in]	pDevName	The name of the device to open. Could be used when the pIfHdl is null, to transfer information to the open interface function This pointer could be used to pass additional information to sl_IfOpen in case it is required (e.g. UART com port name)
[in]	pInitCallBack	Pointer to function that would be called on completion of the initialization process. If this parameter is NULL the function is blocked until the device initialization is completed, otherwise the function returns immediately.

Returns

Returns the current active role (STA/AP/P2P) or an error code:

• ROLE_STA, ROLE_AP, ROLE_P2P in case of success, otherwise in failure one of the following is return:
• SL_ERROR_ROLE_STA_ERR (Failure to load MAC/PHY in STA role)
• SL_ERROR_ROLE_AP_ERR (Failure to load MAC/PHY in AP role)
• SL_ERROR_ROLE_P2P_ERR (Failure to load MAC/PHY in P2P role)
• SL_ERROR_CALIB_FAIL (Failure of calibration)
• SL_ERROR_FS_CORRUPTED_ERR (FS is corrupted, Return to Factory Image or Program new image should be invoked (see sl_FsCtl, sl_FsProgram))
• SL_ERROR_FS_ALERT_ERR (Device is locked, Return to Factory Image or Program new image should be invoked (see sl_FsCtl, sl_FsProgram))
• SL_ERROR_RESTORE_IMAGE_COMPLETE (Return to factory image completed, perform reset)
• SL_ERROR_GENERAL_ERR (General error during init)

See also

sl_Stop

Note

Belongs to basic_api

Warning

This function must be called before any other SimpleLink API is used, or after sl_Stop is called for reinit the device

Example:

• Open interface without callback routine. The interface name and handler are handled by the sl_IfOpen routine:

  if( sl_Start(NULL, NULL, NULL) < 0 )
  {
      LOG("Error opening interface to device\n"); 
  }

  
  
• Open interface with a callback routine:

  void SimpleLinkInitCallback(_u32 status)
  {
      LOG("Handle SimpleLink Interface acording to ststus %d\n", status);
  }
              
  void main(void) 
  {
      if  (sl_Start(NULL, NULL, SimpleLinkInitCallback) < 0)
      {
          LOG("Error opening interface to device\n");
      }
  }

Definition at line 102 of file device.c.

{
    _u8 ObjIdx = MAX_CONCURRENT_ACTIONS;
    InitComplete_t  AsyncRsp;

    _SlDrvMemZero(&AsyncRsp, sizeof(InitComplete_t));

    /* verify no erorr handling in progress. if in progress than
    ignore the API execution and return immediately with an error */
    VERIFY_NO_ERROR_HANDLING_IN_PROGRESS();
    if (SL_IS_DEVICE_STARTED)
    {
        return SL_RET_CODE_DEV_ALREADY_STARTED;
    }
    /* Perform any preprocessing before enable networking services */
#ifdef sl_DeviceEnablePreamble
    sl_DeviceEnablePreamble();
#endif

    /* ControlBlock init */
    (void)_SlDrvDriverCBInit();

    /* open the interface: usually SPI or UART */
    if (NULL == pIfHdl)
    {
        g_pCB->FD = sl_IfOpen((void *)pDevName, SL_IF_OPEN_FLAGS);
    }
    else
    {
        g_pCB->FD = (_SlFd_t)pIfHdl;
    }
    
    ObjIdx = _SlDrvProtectAsyncRespSetting((_u8 *)&AsyncRsp, START_STOP_ID, SL_MAX_SOCKETS);

    if (MAX_CONCURRENT_ACTIONS == ObjIdx)
    {
        return SL_POOL_IS_EMPTY;
    }

    if( g_pCB->FD >= (_SlFd_t)0)
    {
        /* store the interface parameters for the internal call of the 
           sl_start to be called upon reset request handling */
        DeviceCB.pIfHdl = pIfHdl;
        DeviceCB.pDevName = pDevName;

        /* Mark that device is in progress! */
        SL_SET_DEVICE_START_IN_PROGRESS;

        sl_DeviceDisable();

        sl_IfRegIntHdlr((SL_P_EVENT_HANDLER)_SlDrvRxIrqHandler, NULL);

        g_pCB->pInitCallback = pInitCallBack;
        sl_DeviceEnable();
        
        if (NULL == pInitCallBack)
        {
#ifdef SL_TINY
            _SlDrvSyncObjWaitForever(&g_pCB->ObjPool[ObjIdx].SyncObj);
#else
            SL_DRV_SYNC_OBJ_WAIT_TIMEOUT(&g_pCB->ObjPool[ObjIdx].SyncObj,
                                         INIT_COMPLETE_TIMEOUT,
                                         SL_OPCODE_DEVICE_INITCOMPLETE);
#endif            

            SL_UNSET_DEVICE_START_IN_PROGRESS;

            SL_SET_DEVICE_STARTED;

            /* release Pool Object */
            _SlDrvReleasePoolObj(g_pCB->FunctionParams.AsyncExt.ActionIndex);
            return _SlDeviceGetStartResponseConvert(AsyncRsp.Status);
        }
        else
        {
            return SL_RET_CODE_OK;
        }
    }
    return SL_BAD_INTERFACE;
}

sl_Stop()

_i16 sl_Stop

(

const _u16

Timeout

)

Stop the SimpleLink device.

This function clears the enable pin of the device, closes the communication
interface and invokes the stop complete callback

Parameters

[in]

Timeout

Stop timeout in msec. Should be used to give the device time to finish any transmission/reception that is not completed when the function was called. Additional options: 0 Enter to hibernate immediately 0xFFFF Host waits for device's response before hibernating, without timeout protection 0 < Timeout[msec] < 0xFFFF Host waits for device's response before hibernating, with a defined timeout protection This timeout defines the max time to wait. The NWP response can be sent earlier than this timeout.

Returns

Zero on success, or a negative value if an error occurred

See also

sl_Start

Note

This API will shutdown the device and invoke the "i/f close" function regardless
if it was opened implicitly or explicitly.
It is up to the platform interface library to properly handle interface close
routine
Belongs to basic_api

Warning

Definition at line 261 of file device.c.

{
    _i16 RetVal=0;
    _SlStopMsg_u      Msg;
    _BasicResponse_t  AsyncRsp;
    _u8 ObjIdx = MAX_CONCURRENT_ACTIONS;
    _u8 ReleasePoolObject = FALSE;
    _u8 IsProvInProgress = FALSE;

    /* In case the device has already stopped,
     * return an error code .
     */
    if (!SL_IS_DEVICE_STARTED)
    {
        return SL_RET_CODE_DEV_NOT_STARTED;
    }

    /* NOTE: don't check VERIFY_API_ALLOWED(), this command is not
     * filtered in error handling and also not filtered in NWP lock state.
     * If we are in the middle of assert handling than ignore stopping
     * the device with timeout and force immediate shutdown as we would like
     * to avoid any additional commands to the NWP */
    if( (Timeout != 0) 
#ifndef SL_TINY  
       && (!SL_IS_RESTART_REQUIRED)
#endif 
    )      
    {
        /* Clear the Async response structure */
        _SlDrvMemZero(&AsyncRsp, sizeof(_BasicResponse_t));

        /* let the device make the shutdown using the defined timeout */
        Msg.Cmd.Timeout = Timeout;

        IsProvInProgress = SL_IS_PROVISIONING_IN_PROGRESS;

        /* if provisioning in progress do not take pool object as we are not going to wait for it if */
        if (!IsProvInProgress)
        {
            ObjIdx = _SlDrvProtectAsyncRespSetting((_u8 *)&AsyncRsp, START_STOP_ID, SL_MAX_SOCKETS);
            if (MAX_CONCURRENT_ACTIONS == ObjIdx)
            {
              return SL_POOL_IS_EMPTY;
            }

            ReleasePoolObject = TRUE;
        }
      
        /* Set the stop-in-progress flag */
        SL_SET_DEVICE_STOP_IN_PROGRESS;

        VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlStopCmdCtrl, &Msg, NULL));
        

        /* Do not wait for stop async event if provisioning is in progress */
        if((SL_OS_RET_CODE_OK == (_i16)Msg.Rsp.status) && (!(IsProvInProgress)))
        {

#ifdef SL_TINY        
            _SlDrvSyncObjWaitForever(&g_pCB->ObjPool[ObjIdx].SyncObj);
                /* Wait for sync object to be signaled */
#else                
            SL_DRV_SYNC_OBJ_WAIT_TIMEOUT(&g_pCB->ObjPool[ObjIdx].SyncObj,
                                                       STOP_DEVICE_TIMEOUT,
                                                       SL_OPCODE_DEVICE_STOP_ASYNC_RESPONSE);

#endif

             Msg.Rsp.status = AsyncRsp.status;
             RetVal = Msg.Rsp.status;
        }

       /* Release pool object only if taken */
        if (ReleasePoolObject == TRUE)
        {
            _SlDrvReleasePoolObj(ObjIdx);
        }

        /* This macro wait for the NWP to raise a ready for shutdown indication.
         * This function is unique for the CC32XX family, and expected to return
         * in less than 600 mSec, which is the time takes for NWP to gracefully shutdown. */
        WAIT_NWP_SHUTDOWN_READY;
    }
    else
    {
        /* Set the stop-in-progress flag */
        SL_SET_DEVICE_STOP_IN_PROGRESS;
    }

    sl_IfRegIntHdlr(NULL, NULL);
    sl_DeviceDisable();
    RetVal = sl_IfClose(g_pCB->FD);

    (void)_SlDrvDriverCBDeinit();

    /* clear the stop-in-progress flag */
    SL_UNSET_DEVICE_STOP_IN_PROGRESS;

    /* clear the device started flag */
    SL_UNSET_DEVICE_STARTED;

    return RetVal;
}

sl_Task()

void* sl_Task

(

void *

pEntry

)

The SimpleLink task entry.

This function must be called from the main loop or from dedicated thread in the following cases:

• Non-Os Platform - should be called from the mail loop
• Multi Threaded Platform when the user does not implement the external spawn functions - should be called from dedicated thread allocated to the SimpleLink driver. In this mode the function never return.

parameters

None

Returns

None

See also

Note

Belongs to basic_api

Warning

This function must be called from a thread that is start running before any call to other SimpleLink API

Definition at line 87 of file device.c.

{
#ifdef _SlTaskEntry
    return (void*)_SlTaskEntry();
#else
    return (void*)0;
#endif
}

---

Data Structure Documentation

SlDeviceEventResetRequest_t

struct SlDeviceEventResetRequest_t

Definition at line 63 of file device.h.

Data Fields
_u16	Caller
_i16	Status

SlDeviceEventError_t

struct SlDeviceEventError_t

Definition at line 80 of file device.h.

Data Fields
_i16	Code
SlDeviceSource_e	Source

SlDeviceEventData_u

union SlDeviceEventData_u

Definition at line 86 of file device.h.

Data Fields
SlDeviceEventError_t	Error
SlDeviceEventResetRequest_t	ResetRequest

SlDeviceEvent_t

struct SlDeviceEvent_t

Definition at line 101 of file device.h.

Data Fields
SlDeviceEventData_u	Data
_u32	Id

SlDeviceFatalDeviceAssert_t

struct SlDeviceFatalDeviceAssert_t

Definition at line 115 of file device.h.

Data Fields
_u32	Code
_u32	Value

SlDeviceFatalNoCmdAck_t

struct SlDeviceFatalNoCmdAck_t

Definition at line 122 of file device.h.

Data Fields
_u32	Code

SlDeviceFatalData_u

union SlDeviceFatalData_u

Definition at line 128 of file device.h.

Data Fields
SlDeviceFatalCmdTimeout_t	CmdTimeout
SlDeviceFatalDeviceAssert_t	DeviceAssert
SlDeviceFatalNoCmdAck_t	NoCmdAck

SlDeviceFatal_t

struct SlDeviceFatal_t

Definition at line 136 of file device.h.

Data Fields
SlDeviceFatalData_u	Data
_u32	Id

SlDeviceUartIfParams_t

struct SlDeviceUartIfParams_t

Definition at line 215 of file device.h.

Data Fields
_u32	BaudRate
_u8	CommPort
_u8	FlowControlEnable

SlDeviceVersion_t

struct SlDeviceVersion_t

Definition at line 237 of file device.h.

Data Fields
_u32	ChipId
_u8	FwVersion[4]
_u8	NwpVersion[4]
_u16	Padding
_u8	PhyVersion[4]
_u16	RomVersion

SlDateTime_t

struct SlDateTime_t

Definition at line 248 of file device.h.

Data Fields
_u32	reserved[3]
_u32	tm_day
_u32	tm_hour
_u32	tm_min
_u32	tm_mon
_u32	tm_sec
_u32	tm_week_day
_u32	tm_year
_u32	tm_year_day

SlDeviceInitInfo_t

struct SlDeviceInitInfo_t

Definition at line 267 of file device.h.

Data Fields
_u32	ChipId
_u32	MoreData