XDK API  3.6.0
Documentation
Data Structures | Typedefs | Enumerations | Functions | Variables
BSP_BoardShared.h File Reference

Shared Variables for BSP_XDK110 implementation. More...

#include "BCDS_BSP_Board.h"
#include "BCDS_USB.h"
+ Include dependency graph for BSP_BoardShared.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  EXTILineEven_S
 
union  EXTILineEven_U
 
struct  EXTILineOdd_S
 
union  EXTILineOdd_U
 
struct  GPIOPorts_S
 
union  GPIOPorts_U
 
struct  I2C0Register_S
 
union  I2C0Register_U
 
struct  PowerSupply2V5Register_S
 
union  PowerSupply2V5Register_U
 
struct  PowerSupply3V3Register_S
 
union  PowerSupply3V3Register_U
 

Typedefs

typedef enum BSPLock_E BSPLock_T
 
typedef union EXTILineEven_U EXTILineEven_T
 
typedef union EXTILineOdd_U EXTILineOdd_T
 
typedef void(* GPIOINT_IrqCallbackPtr_t )(void)
 GPIO interrupt callback function pointer. More...
 
typedef union GPIOPorts_U GPIOPorts_T
 
typedef union I2C0Register_U I2C0Register_T
 
typedef enum Peripherals_E Peripherals_T
 
typedef union
PowerSupply2V5Register_U 
PowerSupply2V5Register_T
 
typedef union
PowerSupply3V3Register_U 
PowerSupply3V3Register_T
 

Enumerations

enum  BSPLock_E
 
enum  Peripherals_E
 

Functions

USB_lineCoding_t __attribute__ ((aligned(4))) USB_lineCoding_mds
 
void Board_Delay (uint32_t delay)
 Provide a delay in millisecond. More...
 
void Board_DisablePowerSupply3V3 (Peripherals_T Peripheral)
 Disables the 3V3 power rail. More...
 
void Board_EnablePowerSupply3V3 (Peripherals_T Peripheral)
 Enables the 3V3 power rail. More...
 
uint32_t Board_GetTick (void)
 Provide a tick value in millisecond. More...
 
void Board_GPIOInterruptDispatch (uint32_t iflags)
 Function calls users callback for registered pin interrupts. More...
 
GPIOINT_IrqCallbackPtr_t Board_GPIOInterruptGetCallback (uint8_t pin)
 Returns the callback pointer. More...
 
void Board_GPIOInterruptRegisterCallback (uint8_t pin, GPIOINT_IrqCallbackPtr_t callbackPtr)
 Registers user callback for given pin number. More...
 
static void Board_GPIOInterruptUnregisterCallback (uint8_t pin)
 Unregisters user callback for given pin number. More...
 
void Board_IncTick (void)
 This function is called to increment a global variable "BSP_Tick" used as application time base. More...
 
void Board_SnoozePowerSupply2V5 (Peripherals_T Peripheral)
 Puts the 2V5 power rail on low power mode(snooze). More...
 
void Board_WakeupPowerSupply2V5 (Peripherals_T Peripheral)
 Performs operations prior to SysTick count increment. More...
 

Variables

BSPLock_T ADCLock
 
I2C0Register_T BSP_I2C0
 
OStoBSPDelayFunc_T OStoBSPdelayFunc
 
BSP_Systick_Callback_T SysTickOsPostProcessing
 Performs operations Post to SysTick count increment. More...
 
BSP_Systick_Callback_T SysTickOsPreProcessing
 Performs operations prior to SysTick count increment. More...
 

Detailed Description

This file contains global variables declaration.

This file provides the definition of the shared resources in the board and the means to control those resources from within the board support package. It also contains the definition for the handles required by the efm32 library.

Typedef Documentation

typedef enum BSPLock_E BSPLock_T
typedef void(* GPIOINT_IrqCallbackPtr_t)(void)

Parameters:

  • pin - The pin index the callback function is invoked for.
typedef union GPIOPorts_U GPIOPorts_T

Enumeration Type Documentation

enum BSPLock_E
Enumerator
BSP_LOCKED 
BSP_UNLOCKED 
Enumerator
MCU 
BT_EM9301 
WIFI_CC3100MOD 
SENSOR_BMA280 
MIC_AKU340 
SENSOR_BMG160 
SENSOR_BME280 
SENSOR_BMM150 
SENSOR_BMI150 
SENSOR_MAX44009 
SENSOR_BMI160 
SD_CARD 
LED_ALL 
LED_ORANGE 
LED_RED 
LED_YELLOW 
KEY1 
KEY2 
EXTENSION_BOARD 

Function Documentation

USB_lineCoding_t __attribute__ ( (aligned(4))  )
void Board_Delay ( uint32_t  delay)
Parameters
delaydelay time in ms;

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Board_DisablePowerSupply3V3 ( Peripherals_T  Peripheral)

This function holds a register of the connected peripherals to the power supply and if a peripheral requests disabling it, the corresponding bit field is Reset and the register and if this register equals zero then the power rail is safe to be disabled.

Parameters
Peripheral: enumerated value representing the peripheral requesting the Disabling of the power supply
Returns
RETCODE_OK in case of success error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Board_EnablePowerSupply3V3 ( Peripherals_T  Peripheral)

This function holds a register of the connected peripherals to the power supply and if a peripheral requests enabling it, the MCU output enabling the Power rail is Set its and the corresponding peripheral bit field is Set

Parameters
Peripheral: enumerated value representing the peripheral requesting the Enabling of the power supply
Returns
RETCODE_OK in case of success error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t Board_GetTick ( void  )
Return values
tickvalue

+ Here is the caller graph for this function:

void Board_GPIOInterruptDispatch ( uint32_t  iflags)

This function is called when GPIO interrupts are handled by the dispatcher. Function gets even or odd interrupt flags and calls user callback registered for that pin. Function iterates on flags starting from MSB.

Parameters
iflagsInterrupt flags which shall be handled by the dispatcher.

+ Here is the caller graph for this function:

GPIOINT_IrqCallbackPtr_t Board_GPIOInterruptGetCallback ( uint8_t  pin)

This function is used to query the callback function registered for the requested pin.

Parameters
pinThe pin number.
Returns
The callback pointer.

+ Here is the caller graph for this function:

void Board_GPIOInterruptRegisterCallback ( uint8_t  pin,
GPIOINT_IrqCallbackPtr_t  callbackPtr 
)

Use this function to register a callback which shall be called upon interrupt generated from given pin number (port is irrelevant). Interrupt itself must be configured externally. Function overwrites previously registered callback.

Parameters
[in]pinPin number for the callback.
[in]callbackPtrA pointer to callback function.

+ Here is the caller graph for this function:

static void Board_GPIOInterruptUnregisterCallback ( uint8_t  pin)
inlinestatic

Use this function to unregister a callback.

Parameters
[in]pinPin number for the callback.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Board_IncTick ( void  )
Note
In the default implementation, this variable is incremented each 1ms in SysTick ISR.
Return values
None
void Board_SnoozePowerSupply2V5 ( Peripherals_T  Peripheral)

This function holds a register of the connected peripherals to the power supply and if a peripheral requests disabling it, the corresponding bit field is Reset and the register and if this register equals zero then the power rail is safe to be scaled down.

Parameters
Peripheral: enumerated value representing the peripheral requesting the Snoozing of the power supply
Returns
RETCODE_OK in case of success error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Board_WakeupPowerSupply2V5 ( Peripherals_T  Peripheral)

This function is initialized during BSP_Board_OSTickInitialize() and makes it possible for the application to perform some operations before the SysTick counter is incremented (e.g. context switching in OS based applications)

  • This function is called in SysTick_Handler() function in IrqHandler.c file Wakes up the 2V5 power rail

This function holds a register of the connected peripherals to the power supply and if a peripheral requests enabling it, the MCU output enabling the Power rail is Set its and the corresponding peripheral bit field is Set

Parameters
Peripheral: enumerated value representing the peripheral requesting the Enabling of the power supply

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

BSPLock_T ADCLock
I2C0Register_T BSP_I2C0
OStoBSPDelayFunc_T OStoBSPdelayFunc
BSP_Systick_Callback_T SysTickOsPostProcessing

This function is initialized during BSP_Board_OSTickInitialize() and makes it possible for the application to perform some operations after the SysTick counter has is incremented (e.g. context switching in OS based applications) This function is called in SysTick_Handler() function in IrqHandler.c file

BSP_Systick_Callback_T SysTickOsPreProcessing

This function is initialized during BSP_Board_OSTickInitialize() and makes it possible for the application to perform some operations before the SysTick counter is incremented (e.g. context switching in OS based applications)


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:48 by doxygen 1.8.8