sbc_fs8x.h File Reference

FS8x driver interface. More...

#include <stdbool.h>
#include "sbc_fs8x_map.h"
#include "sbc_fs8x_common.h"

Include dependency graph for sbc_fs8x.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	FS8x_WD_SEED_DEFAULT   0x5AB2U
	Watchdog seed default value. More...

Enumerations
enum	fs8x_reg_output_t {   fs8xBuck1 = 4 , fs8xBuck2 = 3 , fs8xBuck3 = 2 , fs8xLdo1 = 1 ,   fs8xLdo2 = 0 , fs8xVBoost = 5 , fs8xVPre = 6 }
	Voltage outputs. Can be used with function FS8x_SetRegulatorState(). More...
enum	fs8x_amux_selection_t {   fs8xAmuxGnd = FS8X_M_AMUX_GND , fs8xAmuxVddio = FS8X_M_AMUX_VDDIO , fs8xAmuxTempSensor = FS8X_M_AMUX_TEMPERATURE_SENSOR , fs8xAmuxBandgapMain = FS8X_M_AMUX_BAND_GAP_MAIN ,   fs8xAmuxBandgapFailSafe = FS8X_M_AMUX_BAND_GAP_FAIL_SAFE , fs8xAmuxVbuck1Volt = FS8X_M_AMUX_VBUCK1_VOLTAGE , fs8xAmuxVbuck2Volt = FS8X_M_AMUX_VBUCK2_VOLTAGE , fs8xAmuxVbuck3VoltDiv2_5 = FS8X_M_AMUX_VBUCK3_VOLTAGE_DIVIDED ,   fs8xAmuxVpreVoltDiv2_5 = FS8X_M_AMUX_VPRE_VOLTAGE_DIVIDED , fs8xAmuxVboostVoltDiv2_5 = FS8X_M_AMUX_VBOOST_VOLTAGE_DIVIDED , fs8xAmuxVldo1VoltDiv2_5 = FS8X_M_AMUX_VLDO1_VOLTAGE_DIVIDED , fs8xAmuxVldo2VoltDiv2_5 = FS8X_M_AMUX_VLDO2_VOLTAGE_DIVIDED ,   fs8xAmuxVbosVoltDiv2_5 = FS8X_M_AMUX_VBOS_VOLTAGE_DIVIDED , fs8xAmuxVsup1VoltDiv7_5 = FS8X_M_AMUX_VSUP1_VOLTAGE_DIVIDED , fs8xAmuxWake1VoltDiv7_5 = FS8X_M_AMUX_WAKE1_VOLTAGE_DIVIDED , fs8xAmuxWake2VoltDiv7_5 = FS8X_M_AMUX_WAKE2_VOLTAGE_DIVIDED ,   fs8xAmuxVana = FS8X_M_AMUX_VANA , fs8xAmuxVdig = FS8X_M_AMUX_VDIG , fs8xAmuxVdigFs = FS8X_M_AMUX_VDIG_FS , fs8xAmuxPsync = FS8X_M_AMUX_PSYNC_VOLTAGE ,   fs8xAmuxVsup1VoltDiv14 = FS8X_M_RATIO_RATIO_14 | FS8X_M_AMUX_VSUP1_VOLTAGE_DIVIDED , fs8xAmuxWake1VoltDiv14 = FS8X_M_RATIO_RATIO_14 | FS8X_M_AMUX_WAKE1_VOLTAGE_DIVIDED , fs8xAmuxWake2VoltDiv14 = FS8X_M_RATIO_RATIO_14 | FS8X_M_AMUX_WAKE2_VOLTAGE_DIVIDED }

Functions
fs8x_status_t	FS8x_WD_ChangeSeed (SPI_INTERFACE_CONFIG_s *spiInterface, fs8x_drv_data_t *drvData, uint16_t wdSeed)
	Changes seed of LFSR used for watchdog. More...
fs8x_status_t	FS8x_WD_Refresh (SPI_INTERFACE_CONFIG_s *spiInterface, fs8x_drv_data_t *drvData)
	Performs the watchdog refresh. More...
fs8x_status_t	FS8x_FS0B_Release (SPI_INTERFACE_CONFIG_s *spiInterface, fs8x_drv_data_t *drvData)
	FS0B release routine. More...
fs8x_status_t	FS8x_SwitchAMUXchannel (SPI_INTERFACE_CONFIG_s *spiInterface, fs8x_drv_data_t *drvData, fs8x_amux_selection_t channelSelection)
	Switches a desired channel to the AMUX pin. More...
fs8x_status_t	FS8x_SetRegulatorState (SPI_INTERFACE_CONFIG_s *spiInterface, fs8x_drv_data_t *drvData, fs8x_reg_output_t vreg, bool enable)
	Sets state (enable/disable) of the selected voltage regulator. More...
fs8x_status_t	FS8x_GetFaultErrorCounterValue (SPI_INTERFACE_CONFIG_s *spiInterface, fs8x_drv_data_t *drvData, uint8_t *faultErrorCounterValue)
	Reads actual Fault Error Counter value. More...

Detailed Description

FS8x driver interface.

Author

nxf44615

Version

1.1

Date

9-Oct-2018

Copyright

Copyright (c) 2016 - 2018, NXP Semiconductors, Inc.

Updated

2020-03-18 (date of last update) Adapted driver to pass interface configuration as parameter into the functions to enable the usage of multiple ICs in the system.

Definition in file sbc_fs8x.h.

Macro Definition Documentation

FS8x_WD_SEED_DEFAULT

#define FS8x_WD_SEED_DEFAULT   0x5AB2U

Watchdog seed default value.

Definition at line 59 of file sbc_fs8x.h.