Sensor Hub#

sl_sensor_mode_t#

sl_sensor_mode_t

Enumeration for Sensor HUB data reading mode.

sl_sensorhub_event_t#

sl_sensorhub_event_t

Enumeration for Sensors HUB Callback Events.

sl_gpio_intr_type_t#

sl_gpio_intr_type_t

Enumeration for GPIO Interrupt Configurations.

sl_data_deliver_mode_t#

sl_data_deliver_mode_t

Enumeration for Sensor HUB data delivery mode.

sl_sensor_status_t#

sl_sensor_status_t

Enumeration for Sensors Status.

sl_adc_cfg_t#

typedef struct sl_adc_config sl_adc_cfg_t

ADC bus interface configuration structure.

sl_si91x_sensorhub_init#

sl_status_t sl_si91x_sensorhub_init ( -, -)

Initialization Peripherals of Sensor HUB.

This function will initialize the Peripherals, based on the user configuration. like - I2C/SPI/ADC

Returns

• status 0 if successful, else error code as follow:

  • SL_STATUS_FAIL (0x0001)- Fail, Peripherals initialization failed

  • SL_STATUS_OK (0X000)- Success, Peripherals initialization done properly

sl_si91x_sensorhub_detect_sensors#

sl_status_t sl_si91x_sensorhub_detect_sensors (sl_sensor_id_t sensor_id_info, uint8_t num_of_sensors, -)

Detect the sensors.

This function will detect the sensor, based on the user configuration. and it will store the scanned sensor ID in the structure.

Returns

• if successful, Return number of sensors scanned else error code

sl_si91x_sensorhub_delete_sensor#

sl_status_t sl_si91x_sensorhub_delete_sensor (sl_sensor_id_t sensor_id, -)

Delete the specific sensor from the Sensor HUB.

This function will delete the specific sensor from the sensor list, modify the sensor status to invalid, and publish the events to the event task.

Returns

• status 0 if successful, else error code as follow:

  • SL_STATUS_FAIL (0x0001) - Fail, Delete sensor failed

  • SL_STATUS_OK (0X000) - Success, Delete sensor Success

sl_si91x_sensorhub_create_sensor#

sl_status_t sl_si91x_sensorhub_create_sensor (sl_sensor_id_t sensor_id, -)

Create a sensor instance in the sensor hub.

This function creates a sensor instance as per user configuration.It also allocates max sample memory for the configured sensor.

Returns

• status 0 if successful, else error code as follow:

  • SL_STATUS_FAIL (0x0001)- Fail, Create sensor instance failed

  • SL_STATUS _OK (0X000) - Create sensor instanceSuccess ,

sl_si91x_sensorhub_start_sensor#

sl_status_t sl_si91x_sensorhub_start_sensor (sl_sensor_id_t sensor_id, -)

Start the sensor operation for the given sensor.

This function can be called after creating a sensor with given sensor ID It does following operations

• Starts timer for sensor with polling mode.

• Enable IRQ handle for sensor with interrupt mode.

Returns

• status 0 if successful, else error code as follow:

  • SL_STATUS_FAIL (0x0001)- Fail, Sensor start failed

  • SL_STATUS _OK (0X000) - Success ,Sensor start done properly

sl_si91x_sensorhub_stop_sensor#

sl_status_t sl_si91x_sensorhub_stop_sensor (sl_sensor_id_t sensor_id, -)

Stop the sensor operation of the given sensor.

This function does following operations

• Stop the sensor operations of the given sensor.

• Based on the sensor mode it will stop the Polling/interrupt mode operations and updates the sensor statutes.

• Disable IRQ handles of the interrupt mode sensors.

Returns

• status 0 if successful, else error code as follows:

  • SL_STATUS_FAIL (0x0001)- Fail, Sensor stop failed

• SL_STATUS _OK (0X000) - Success ,Sensor stop done properly

sl_si91x_em_post_event#

void sl_si91x_em_post_event (sl_sensor_id_t sensor_id, sl_sensorhub_event_t event, void * dataPtr, TickType_t ticks_to_wait, -)

Post the events to event manager(EM) to be notified to the application.

It waits for mutex till ticks_to_wait and updates event queue if mutex is acquired

Returns

• - NULL

sl_si91x_sensor_task#

void sl_si91x_sensor_task (void , -)

Task to handle the sensor operations.

Sensor Task does following operations

• Create the OS event and mutex to perform the sensor operations.

• Sample the Sensor data based on the event flags.

• Check the events and post the sensor data to the em task based on the sensor data delivery mode.

Returns

• - NULL

sl_si91x_power_state_task#

void sl_si91x_power_state_task (void , -)

Task to handle the system power operations.

Power state task changes the system from one power save mode to another power save mode like(PS4 to PS2),(PS2toPS4),(Sleep_mode) using Binary semaphore

Returns

• - NULL

sl_si91x_em_task#

void sl_si91x_em_task (void , -)

Task to handle the operations of the Event Manager(EM)

Em task does following operaions

• Create the osMessageQueue and mutex to perform the event operations.

• Calls the callback event Returns

  • - NULL

sli_si91x_i2c_init#

int32_t sli_si91x_i2c_init (void , -)

Initialize the I2C Interface based on configuration.

This function will configure/Initialize I2C Interface based on configuration.

Returns

• I2C Initializtion status

sli_si91x_spi_init#

int32_t sli_si91x_spi_init (void , -)

Initialize SPI Interface based on configuration.

This function will configure/Initialize SPI Interface based on configuration.

Returns

• SPI Initializtion status.

sli_si91x_i2c_sensors_scan#

int32_t sli_si91x_i2c_sensors_scan (uint16_t address, -)

Scan the I2C sensors.

This function will scan the I2C sensors based on the sensor address.

Returns

• status 0 if successful, else it will wait for the sensor response.

sli_si91x_get_sensor_implementation#

sl_sensor_impl_type_t * sli_si91x_get_sensor_implementation (int32_t sensor_id, -)

to get sensor implementation.

This function will get the sensor implementation of the sensor based on sensor ID.

Returns

• if successful, returns the Sensor implementation structure else returns an error code.

sli_si91x_create_sensor_list_index#

int32_t sli_si91x_create_sensor_list_index ( -, -)

Create the sensor list index.

This function will Create the sensor list index based on the sensor status For the maximum sensors available in the sensor hub

Returns

• returns the sensor index in sensor_list

sli_si91x_get_sensor_index#

uint32_t sli_si91x_get_sensor_index (sl_sensor_id_t sensor_id, -)

Get the sensor index for the sensor list.

This function will retrieve the sensor index from the sensor list based on the sensor status and sensor ID for the maximum number of sensors available in the sensor hub.

Returns

• if successful, returns the sensor index else returns SL_SH_SENSOR_INDEX_NOT_FOUND(0XFF).

sli_si91x_delete_sensor_list_index#

uint32_t sli_si91x_delete_sensor_list_index (sl_sensor_id_t sensor_id, -)

Delete the sensor index for the sensor list.

This function will delete the sensor from the sensor list based on The sensor ID for the maximum number of sensors available in the sensor hub.

Returns

• if successful, returns the sensor index else returns error code SL_SH_SENSOR_INDEX_NOT_FOUND(0XFF).

sli_si91x_get_sensor_info#

sl_sensor_info_t * sli_si91x_get_sensor_info (sl_sensor_id_t sensor_id, -)

get the sensor info from the sensor configuration structure.

This function will retrieve sensor data from the sensor configuration structure to update the sensor list configuration structure for the maximum number of sensors available in the sensor hub.

Returns

• if successful, returns the sensor information. else returns NULL.

sl_si91x_sensorhub_notify_cb_register#

sl_status_t sl_si91x_sensorhub_notify_cb_register (sl_sensor_signalEvent_t cb_event, sl_sensor_id_t * cb_ack, -)

Call back function to the application.

This function will update the callback function event and acknowledgment.

Returns

• - If successful returns SL_STATUS_OK else returns error code

sl_si91x_sensors_timer_cb#

void sl_si91x_sensors_timer_cb (TimerHandle_t xTimer, -)

Sensor OS timer callback function.

This function will set the event flag bits based on the sensor sampling intervals. In the polling mode call the timer call-back function.

Returns

• - NULL

sl_si91x_gpio_interrupt_config#

sl_status_t sl_si91x_gpio_interrupt_config (uint16_t gpio_pin, sl_gpio_intr_type_t intr_type, -)

Configuring the different types of NPSS GPIO interrupts in the Sensor HUB.

This function configures the NPSS gpios and enables the interrupt mode for the gpios.

Returns

• - If successful returns SL_STATUS_OK else returns error code

sl_si91x_gpio_interrupt_start#

void sl_si91x_gpio_interrupt_start (uint16_t gpio_pin, -)

Enable and set the priority of NPSS GPIO interrupt.

This function configures and sets the priority of the NPSS GPIO interrupt. GPIO interrupt priority is (configMAX_SYSCALL_INTERRUPT_PRIORITY - 1)

Returns

• - NULL

sl_si91x_gpio_interrupt_stop#

void sl_si91x_gpio_interrupt_stop (uint16_t gpio_pin, -)

Mask and Disable the NPSS GPIO interrupt.

This function masks and disables the IRQ handler of the NPSS GPIO interrupt.

Returns

• - NULL

sl_si91x_sensor_hub_start#

sl_status_t sl_si91x_sensor_hub_start (void , -)

Start the sensor hub Tasks.

This Starts the sensor hub Tasks.

Returns

• - If succesfull returns SL_STATUS_OK else returns error code

sli_si91x_set_alarm_intr_time#

void sli_si91x_set_alarm_intr_time (uint16_t interval, -)

set the alarm interrupt time.

This function will set the alarm interrupt based on the periodic time.

Returns

• - NULL

sli_si91x_init_m4alarm_config#

void sli_si91x_init_m4alarm_config (void , -)

initialize the Alarm block.

This function will initialize the Alarm block.

Returns

• - NULL

sli_si91x_config_wakeup_source#

void sli_si91x_config_wakeup_source (uint16_t sleep_time, -)

Configure the wake-up source for the system.

This function will configure the wake-up source to the system.

Returns

• - NULL

sli_si91x_sleep_wakeup#

void sli_si91x_sleep_wakeup (uint16_t sh_sleep_time, -)

Configures sleep/wakeup sources for the system.

This function will configure sleep/wakeup sources.

Returns

• - NULL

sli_si91x_sensorhub_ps4tops2_state#

void sli_si91x_sensorhub_ps4tops2_state (void , -)

Change the system status from PS4 to PS2.

This function will change the system status from PS4 to PS2.

Returns

• - NULL

sli_si91x_sensorhub_ps2tops4_state#

void sli_si91x_sensorhub_ps2tops4_state (void , -)

Change the system status from PS2 to PS4.

This function will change the system status from PS2 to PS4.

Returns

• - NULL

sli_si91x_adc_init#

sl_status_t sli_si91x_adc_init (void )

Initialize ADC Interface based on configuration.

This function will configure/Initialize ADC Interface based on configuration.

Returns

• error code SL_STATUS_FAIL (0x0001)- Fail , SL_STATUS_OK (0X000)- Success

vPortSetupTimerInterrupt#

void vPortSetupTimerInterrupt (void , -)

Initialize and configure the systic timer for the RTOS.

Set up the systic timer to generate the tick interrupts at the required frequency.

Returns

• Initialize status to the application.

ARM_I2C_SignalEvent#

void ARM_I2C_SignalEvent (uint32_t event, -)

I2C event handler.

Returns

• None

sl_si91x_fetch_adc_bus_intf_info#

sl_adc_cfg_t * sl_si91x_fetch_adc_bus_intf_info (void )

Fetch ADC bus interface information.

This can be used by lower level layers Returns

• Pointer to ADC configuration structure

sl_si91x_adc_callback#

void sl_si91x_adc_callback (uint8_t channel_no, uint8_t event)

ADC callback from RSI_ADC_InterruptHandler.

sli_si91x_sdc_init#

uint8_t sli_si91x_sdc_init (void )

Initialize the sdc Interface based on the configuration.

Returns

• status 0 if successful, else error code SL_STATUS_FAIL (0x0001)- Fail , SL_STATUS_OK (0X000)- Success,

sli_config_sdc_params#

void sli_config_sdc_params (sl_drv_sdc_config_t * sdc_config_st_p)

SL_SH_SENSOR_TASK_STACK_SIZE#

#define SL_SH_SENSOR_TASK_STACK_SIZE

(512 * 2)

Sensor task stack size.

SL_SH_EM_TASK_STACK_SIZE#

#define SL_SH_EM_TASK_STACK_SIZE

(512 * 2)

EM task stack size.

SL_SH_POWER_SAVE_TASK_STACK_SIZE#

#define SL_SH_POWER_SAVE_TASK_STACK_SIZE

(512 * 2)

Power task stack size.

SL_EM_TASK_RUN_TICKS#

#define SL_EM_TASK_RUN_TICKS

osWaitForever

Max wait time of message queue in Event task.

MAP_TABLE_SIZE#

#define MAP_TABLE_SIZE

10

Size of the sensors interrupt MAP table.

NPSS_GPIO_IRQHandler#

#define NPSS_GPIO_IRQHandler

IRQ021_Handler

NPSS gpio IRQ handler.

NPSS_GPIO_NVIC#

#define NPSS_GPIO_NVIC

NPSS_TO_MCU_GPIO_INTR_IRQn

NPSS gpio IRQ Number 21.

SL_ALARM_PERIODIC_TIME#

#define SL_ALARM_PERIODIC_TIME

10

Periodic alarm configuration in milliseconds.

RC_TRIGGER_TIME#

#define RC_TRIGGER_TIME

5

RC clock trigger time.

RO_TRIGGER_TIME#

#define RO_TRIGGER_TIME

0

RO clock trigger time.

NO_OF_HOURS_IN_A_DAY#

#define NO_OF_HOURS_IN_A_DAY

24

Number of hours in a day.

NO_OF_MINUTES_IN_AN_HOUR#

#define NO_OF_MINUTES_IN_AN_HOUR

60

Number of minutes in an hour.

NO_OF_SECONDS_IN_A_MINUTE#

#define NO_OF_SECONDS_IN_A_MINUTE

60

Number of Seconds in a minute.

NO_OF_MILLISECONDS_IN_A_SECOND#

#define NO_OF_MILLISECONDS_IN_A_SECOND

1000

Number of milliseconds in a second.

NO_OF_MONTHS_IN_A_YEAR#

#define NO_OF_MONTHS_IN_A_YEAR

12

Number of months in a year.

BASE_YEAR#

#define BASE_YEAR

2000

Start year for alarm configuration.

NO_OF_DAYS_IN_A_MONTH_1#

#define NO_OF_DAYS_IN_A_MONTH_1

28

Month with 28 days.

NO_OF_DAYS_IN_A_MONTH_2#

#define NO_OF_DAYS_IN_A_MONTH_2

29

Month with 29 days.

NO_OF_DAYS_IN_A_MONTH_3#

#define NO_OF_DAYS_IN_A_MONTH_3

30

Month with 30 days.

NO_OF_DAYS_IN_A_MONTH_4#

#define NO_OF_DAYS_IN_A_MONTH_4

31

Month with 31 days.

RTC_ALARM_IRQHandler#

#define RTC_ALARM_IRQHandler

IRQ028_Handler

Alarm IRQ handler.

NVIC_RTC_ALARM#

#define NVIC_RTC_ALARM

MCU_CAL_ALARM_IRQn

Alarm IRQ number 28.

SL_SH_SENSORHUB_ERRORS_MASK#

#define SL_SH_SENSORHUB_ERRORS_MASK

0

SL_SH_TIMER_CREATION_FAILED#

#define SL_SH_TIMER_CREATION_FAILED

(1 << SL_SH_SENSORHUB_ERRORS_MASK)

Creating OS timer for the sensor failed.

SL_SH_TIMER_DELETION_FAILED#

#define SL_SH_TIMER_DELETION_FAILED

(2 << SL_SH_SENSORHUB_ERRORS_MASK)

Deleting OS timer of the sensor failed.

SL_SH_TIMER_START_FAIL#

#define SL_SH_TIMER_START_FAIL

(3 << SL_SH_SENSORHUB_ERRORS_MASK)

Starting OS timer of the sensor failed.

SL_SH_TIMER_STOP_FAIL#

#define SL_SH_TIMER_STOP_FAIL

(4 << SL_SH_SENSORHUB_ERRORS_MASK)

Stopping OS timer of the sensor failed.

SL_SH_MAX_SENSORS_REACHED#

#define SL_SH_MAX_SENSORS_REACHED

(5 << SL_SH_SENSORHUB_ERRORS_MASK)

Max number of sensor limit reached.

SL_SH_MEMORY_LIMIT_EXCEEDED#

#define SL_SH_MEMORY_LIMIT_EXCEEDED

  (6 << SL_SH_SENSORHUB_ERRORS_MASK)

Memory allocation for sensor data storage failed.

SL_SH_SENSOR_CREATE_FAIL#

#define SL_SH_SENSOR_CREATE_FAIL

  (7 << SL_SH_SENSORHUB_ERRORS_MASK)

Sensor API is called for a sensor without creating it.

SL_SH_COMMAND_SET_POWER_FAIL#

#define SL_SH_COMMAND_SET_POWER_FAIL

(8 << SL_SH_SENSORHUB_ERRORS_MASK)

Sensor set power command execution failed.

SL_SH_COMMAND_SET_RANGE_FAIL#

#define SL_SH_COMMAND_SET_RANGE_FAIL

(9 << SL_SH_SENSORHUB_ERRORS_MASK)

Sensor set range command execution failed.

SL_SH_COMMAND_SELF_TEST_FAIL#

#define SL_SH_COMMAND_SELF_TEST_FAIL

(10 << SL_SH_SENSORHUB_ERRORS_MASK)

Sensor self-test command execution failed.

SL_SH_INVALID_PARAMETERS#

#define SL_SH_INVALID_PARAMETERS

(11 << SL_SH_SENSORHUB_ERRORS_MASK)

Generic error code for any invalid parameters.

SL_SH_GPIO_OUT_OF_RANGE#

#define SL_SH_GPIO_OUT_OF_RANGE

(12 << SL_SH_SENSORHUB_ERRORS_MASK)

Invalid gpio number.

SL_SH_SENSOR_IMPLEMENTATION_NOT_FOUND#

#define SL_SH_SENSOR_IMPLEMENTATION_NOT_FOUND

  (13 << SL_SH_SENSORHUB_ERRORS_MASK)

No hal implementation found for given sensor type.

SL_SH_INTERRUPT_TYPE_CONFIG_FAIL#

#define SL_SH_INTERRUPT_TYPE_CONFIG_FAIL

(14 << SL_SH_SENSORHUB_ERRORS_MASK)

Interrupt type configuration failed.

SL_SH_MEMORY_ALLOCATION_FAILED#

#define SL_SH_MEMORY_ALLOCATION_FAILED

(15 << SL_SH_SENSORHUB_ERRORS_MASK)

Allocating memory for sensor hal failed.

SL_SH_SENSOR_INDEX_NOT_FOUND#

#define SL_SH_SENSOR_INDEX_NOT_FOUND

(0xFF)

Sensor not created.

SL_SH_CONFIG_NOT_FOUND#

#define SL_SH_CONFIG_NOT_FOUND

(16 << SL_SH_SENSORHUB_ERRORS_MASK)

Sensor configuration not found.

SL_SH_INVALID_ADDRESS#

#define SL_SH_INVALID_ADDRESS

(17 << SL_SH_SENSORHUB_ERRORS_MASK)

No sensor found at given address.

SL_SH_WRONG_INTERRUPT_TYPE#

#define SL_SH_WRONG_INTERRUPT_TYPE

  (18 << SL_SH_SENSORHUB_ERRORS_MASK)

Invalid interrupt type is given for the sensor.

SL_SH_INVALID_MODE#

#define SL_SH_INVALID_MODE

(19 << SL_SH_SENSORHUB_ERRORS_MASK)

Invalid mode is given for the sensor.

SL_SH_INVALID_DELIVERY_MODE#

#define SL_SH_INVALID_DELIVERY_MODE

  (20 << SL_SH_SENSORHUB_ERRORS_MASK)

Invalid delivery mode is given for the sensor.

SL_SH_HAL_SENSOR_CREATION_FAILED#

#define SL_SH_HAL_SENSOR_CREATION_FAILED

(21 << SL_SH_SENSORHUB_ERRORS_MASK)

Create sensor in HAL failed.

SL_SH_HAL_SENSOR_DELETION_FAILED#

#define SL_SH_HAL_SENSOR_DELETION_FAILED

(22 << SL_SH_SENSORHUB_ERRORS_MASK)

Delete sensor in HAL failed.

SL_SH_HAL_SENSOR_SAMPLE_FAIL#

#define SL_SH_HAL_SENSOR_SAMPLE_FAIL

(23 << SL_SH_SENSORHUB_ERRORS_MASK)

Sample sensor in HAL failed.

SL_SH_HAL_SENSOR_CONTROL_FAIL#

#define SL_SH_HAL_SENSOR_CONTROL_FAIL

(24 << SL_SH_SENSORHUB_ERRORS_MASK)

Control sensor in HAL failed.

SL_SH_POWER_TASK_CREATION_FAILED#

#define SL_SH_POWER_TASK_CREATION_FAILED

(25 << SL_SH_SENSORHUB_ERRORS_MASK)

Power task creation failed.

SL_SH_SENSOR_TASK_CREATION_FAILED#

#define SL_SH_SENSOR_TASK_CREATION_FAILED

(26 << SL_SH_SENSORHUB_ERRORS_MASK)

Sensor task creation failed.

SL_SH_EM_TASK_CREATION_FAILED#

#define SL_SH_EM_TASK_CREATION_FAILED

(27 << SL_SH_SENSORHUB_ERRORS_MASK)

EM task creation failed.

SL_ALL_PERIPHERALS_INIT_FAILED#

#define SL_ALL_PERIPHERALS_INIT_FAILED

  (28 << SL_SH_SENSORHUB_ERRORS_MASK)

All(i2c,spi,adc) peripheral's initialization failed.