XDK API  3.6.0
Documentation
Typedefs | Functions
WIFI_CC3100MOD

Generic interface to the WIFI CC3100MOD BSP API. More...

+ Collaboration diagram for WIFI_CC3100MOD:

Typedefs

typedef void(* BSP_WiFi_CC3100MOD_InterruptCallback_T )(void)
 

Functions

Retcode_T BSP_WiFi_CC3100MOD_Connect (void)
 Maps the GPIO pins to their desired function. More...
 
Retcode_T BSP_WiFi_CC3100MOD_Disable (void)
 Disables the control over the peripheral. More...
 
Retcode_T BSP_WiFi_CC3100MOD_Disconnect (void)
 Disconnects the WIFI peripheral. More...
 
Retcode_T BSP_WiFi_CC3100MOD_Enable (BSP_WiFi_CC3100MOD_InterruptCallback_T callback)
 Enables the control over the peripheral. More...
 
HWHandle_T BSP_WiFi_CC3100MOD_GetSPIHandle (void)
 Returns the SPI handle of the communication interfaces used by the peripheral. More...
 
HWHandle_T BSP_WiFi_CC3100MOD_GetUartHandle (void)
 Returns the UART handle of the communication interfaces used by the peripheral. More...
 
Retcode_T BSP_WiFi_CC3100MOD_Hibernate (void)
 Hibernates the WIFI module. More...
 
Retcode_T BSP_WiFi_CC3100MOD_Reset (void)
 Resets the WIFI module. More...
 
Retcode_T BSP_WiFi_CC3100MOD_SetCSHigh (void)
 Sets the CS pin to high i.e. device deselected. More...
 
Retcode_T BSP_WiFi_CC3100MOD_SetCSLow (void)
 Sets the CS pin to Low i.e. device selected. More...
 
Retcode_T BSP_WiFi_CC3100MOD_Wakeup (void)
 Wakes the module from hibernate mode. More...
 

Detailed Description

A prior call to BSP_Board_Initialize(param1, param2) function is necessary to initialize the MCU resources needed by the WIFI device.

Once the WIFI is requested a call to BSP_WIFI_CC3100MOD_Connect() function is required to map the internal MCU resources to their associated function.

The application needs get the handle for the MCU resource driver via BSP_WIFI_CC3100MOD_GetHandle() and to initialize the MCU resource driver by calling the MCU_<RESOURCE>_Initialize() and providing it with the previously acquired handle and an event callback function.

Then a call to BSP_WIFI_CC3100MOD_Enable() will execute the required sequence to enable the WIFI peripheral and the MCU resources dedicated for it (UART, SPI, I2C, etc.) and will associate the interrupt requests to their appropriate service routines.

The BSP_WIFI_CC3100MOD_Disable() will revert back what the BSP_WIFI_CC3100MOD_Enable() has done and set the WIFI and the MCU resource into disabled state.

The BSP_WIFI_CC3100MOD_Disconnect() will put the GPIO pins associated to the WIFI peripheral in analog mode to further reduce the consumption.

Typedef Documentation

typedef void(* BSP_WiFi_CC3100MOD_InterruptCallback_T)(void)

Type definition for the wlan interrupt callback The application should then pass the callback at the BSP_WiFi_CC3100MOD_Enable() function.

During call the BSP will this function whenever a rising edge occurs in the module interrupt line Refer to the implementation for more details.

Function Documentation

Retcode_T BSP_WiFi_CC3100MOD_Connect ( void  )

This function once called will map the GPIO pins to their desired functions to drive the TI(R) CC3100MOD WIFI peripheral. It is needed to call this function prior to the BSP_WIFI_CC3100MOD_Enable().

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

Retcode_T BSP_WiFi_CC3100MOD_Disable ( void  )

This function once called will disable control over the TI(R) CC3100MOD WIFI peripheral by executing the disabling procedure as prescribed in the vendor datasheet.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

Retcode_T BSP_WiFi_CC3100MOD_Disconnect ( void  )

This function disconnects the GPIO pins dedicated to the TI(R) CC3100MOD WIFI peripheral and put them into low power consumption status.

Return values
RETCODE_OKin the case of success or an error code otherwise.
Retcode_T BSP_WiFi_CC3100MOD_Enable ( BSP_WiFi_CC3100MOD_InterruptCallback_T  callback)

A prior call to MCU_<RESOURCE>_Initialize() is necessary for this function in order to operate.This function once called will allow the TI(R) CC3100MOD WIFI peripheral to receive, execute commands and transmit process data.

Parameters
callback: function to be called whenever an interrupt occurs on the line
Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

HWHandle_T BSP_WiFi_CC3100MOD_GetSPIHandle ( void  )

After successful execution of BSP_Board_Initialize(param1, param2), the application is free to call this function in order to get the handle needed by the resources drivers. This handle will be used by the MCU drivers for the intended resource.

Returns
HWHandle_T: Handle for the used MCU resource.
HWHandle_T BSP_WiFi_CC3100MOD_GetUartHandle ( void  )

After successful execution of BSP_Board_Initialize(param1, param2), the application is free to call this function in order to get the handle needed by the resources drivers. This handle will be used by the MCU drivers for the intended resource.

Returns
HWHandle_T: Handle for the used MCU resource.
Retcode_T BSP_WiFi_CC3100MOD_Hibernate ( void  )

this function will execute the instruction sequence in order to put the WIFI module into hibernated state.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

Retcode_T BSP_WiFi_CC3100MOD_Reset ( void  )

This function will execute the sequence to reset the CC3100MOD device

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

Retcode_T BSP_WiFi_CC3100MOD_SetCSHigh ( void  )
Return values
RETCODE_OKin the case of success or an error code otherwise.
Retcode_T BSP_WiFi_CC3100MOD_SetCSLow ( void  )
Return values
RETCODE_OKin the case of success or an error code otherwise.
Retcode_T BSP_WiFi_CC3100MOD_Wakeup ( void  )

If the WIFI peripheral is hibernated this function will execute the wake-up sequence with respect to the timing specified in the component data-sheet.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:53 by doxygen 1.8.8