Hilscher netX microcontroller driver
V0.0.5.0
Documentation of the netX driver package
|
This is the BISS peripheral module driver. More...
Data Structures | |
struct | CYCLE_T |
struct | DRV_BISSM_CFG_T |
struct | DRV_BISSM_STATE_T |
struct | DRV_BISSM_CTRL_STATE_T |
Macros | |
#define | HW_PTR_BISS(var) |
#define | HW_PTR_BISS_CTRL(var) |
#define | DRV_BISSM_INST 0 |
#define | DRV_BISSM_CTRL_CHN_CNT 8 |
#define | DRV_BISSM_CTRL_REG_CNT 64 |
#define | DRV_BISSM_INSTR_CDM1 0x1UL |
#define | DRV_BISSM_INSTR_CDM0 0x2UL |
#define | DRV_BISSM_INSTR_REGCOM 0x4UL |
#define | DRV_BISSM_INSTR_REGCOM_REDUCE 0x7UL |
#define | DRV_BISSM_CC_SL_CFG_BISS_B 0x0 |
#define | DRV_BISSM_CC_SL_CFG_BISS_C 0x1 |
#define | DRV_BISSM_CC_SL_CFG_SSI 0x2 |
#define | _HW_CONCAT(a, b) a ## b |
#define | HW_MSK(bf) _HW_CONCAT(MSK_NX90_, bf) |
#define | HW_SRT(bf) _HW_CONCAT(SRT_NX90_, bf) |
#define | HW_DFLT_BF_VAL(bf) _HW_CONCAT(DFLT_BF_VAL_NX90_, bf) |
#define | HW_DFLT_VAL(reg) _HW_CONCAT(DFLT_VAL_NX90_, reg) |
#define | HW_REGADR(reg) _HW_CONCAT(Adr_NX90_, reg) |
#define | HW_AREAADR(area) _HW_CONCAT(Addr_NX90_, area) |
#define | HW_TYPE(area) _HW_CONCAT(NX90_, area) |
#define | HW_WR32(var, val) (var) = (val) |
#define | HW_RD32(var) (var) |
#define | HW_WR16(var, val) (var) = (val) |
#define | HW_RD16(var) (var) |
#define | HW_WR8(var, val) (var) = (val) |
#define | HW_RD8(var) (var) |
This is the BISS peripheral module driver.
This driver is one of our legacy HALs. The support for the legacy hall's is very limited. They are developed and maintained by our chip development and verification department and provide only a hardware near abstraction layer. They are in most cases not convenient or do not support as much functionality as that
#define _HW_CONCAT | ( | a, | |
b | |||
) | a ## b |
Definition at line 79 of file netx_drv_biss.c.
#define DRV_BISSM_CC_SL_CFG_BISS_B 0x0 |
Definition at line 62 of file netx_drv_biss.c.
#define DRV_BISSM_CC_SL_CFG_BISS_C 0x1 |
Definition at line 63 of file netx_drv_biss.c.
#define DRV_BISSM_CC_SL_CFG_SSI 0x2 |
Definition at line 64 of file netx_drv_biss.c.
#define DRV_BISSM_CTRL_CHN_CNT 8 |
Definition at line 54 of file netx_drv_biss.c.
#define DRV_BISSM_CTRL_REG_CNT 64 |
Definition at line 55 of file netx_drv_biss.c.
#define DRV_BISSM_INST 0 |
Definition at line 51 of file netx_drv_biss.c.
#define DRV_BISSM_INSTR_CDM0 0x2UL |
Definition at line 58 of file netx_drv_biss.c.
#define DRV_BISSM_INSTR_CDM1 0x1UL |
Definition at line 57 of file netx_drv_biss.c.
#define DRV_BISSM_INSTR_REGCOM 0x4UL |
Definition at line 59 of file netx_drv_biss.c.
#define DRV_BISSM_INSTR_REGCOM_REDUCE 0x7UL |
Definition at line 60 of file netx_drv_biss.c.
#define HW_AREAADR | ( | area | ) | _HW_CONCAT(Addr_NX90_, area) |
Definition at line 85 of file netx_drv_biss.c.
#define HW_DFLT_BF_VAL | ( | bf | ) | _HW_CONCAT(DFLT_BF_VAL_NX90_, bf) |
Definition at line 82 of file netx_drv_biss.c.
#define HW_DFLT_VAL | ( | reg | ) | _HW_CONCAT(DFLT_VAL_NX90_, reg) |
Definition at line 83 of file netx_drv_biss.c.
#define HW_MSK | ( | bf | ) | _HW_CONCAT(MSK_NX90_, bf) |
Definition at line 80 of file netx_drv_biss.c.
#define HW_PTR_BISS | ( | var | ) |
Definition at line 47 of file netx_drv_biss.h.
#define HW_PTR_BISS_CTRL | ( | var | ) |
Definition at line 53 of file netx_drv_biss.h.
#define HW_RD16 | ( | var | ) | (var) |
Definition at line 102 of file netx_drv_biss.c.
#define HW_RD32 | ( | var | ) | (var) |
Definition at line 94 of file netx_drv_biss.c.
#define HW_RD8 | ( | var | ) | (var) |
Definition at line 110 of file netx_drv_biss.c.
#define HW_REGADR | ( | reg | ) | _HW_CONCAT(Adr_NX90_, reg) |
Definition at line 84 of file netx_drv_biss.c.
#define HW_SRT | ( | bf | ) | _HW_CONCAT(SRT_NX90_, bf) |
Definition at line 81 of file netx_drv_biss.c.
#define HW_TYPE | ( | area | ) | _HW_CONCAT(NX90_, area) |
Definition at line 86 of file netx_drv_biss.c.
#define HW_WR16 | ( | var, | |
val | |||
) | (var) = (val) |
Definition at line 98 of file netx_drv_biss.c.
#define HW_WR32 | ( | var, | |
val | |||
) | (var) = (val) |
Definition at line 90 of file netx_drv_biss.c.
#define HW_WR8 | ( | var, | |
val | |||
) | (var) = (val) |
Definition at line 106 of file netx_drv_biss.c.
enum DRV_BISSM_CFG_IF_E |
BiSS Interface Configuration Enumeration interface configuration.
Enumerator | |
---|---|
DRV_BISSM_CFG_IF_DEFAULT |
Operate as BiSS C-Mode Master |
DRV_BISSM_CFG_IF_DISABLE_CDS |
Default with B-Mode sensor communication |
DRV_BISSM_CFG_IF_SSI |
Operate as SSI Master |
Definition at line 92 of file netx_drv_biss.h.
BiSS Channel Parameters These parameters can be set by DRV_BissM_SetChannelParam() for each data channel
Definition at line 169 of file netx_drv_biss.h.
Control Frame Error Codes Error Codes of an acyclic control frame.
Definition at line 251 of file netx_drv_biss.h.
BiSS Data Active Configuration Enumeration data active configuration.
Definition at line 134 of file netx_drv_biss.h.
BiSS Data Align Configuration Enumeration data align configuration.
Enumerator | |
---|---|
DRV_BISSM_DATA_ALIGN_LEFT |
"101" is stored as "1010000" |
DRV_BISSM_DATA_ALIGN_RIGHT |
"101" is stored as "0000101" |
Definition at line 158 of file netx_drv_biss.h.
Channel Error Codes Error Codes of single data channel provided with the process data.
Enumerator | |
---|---|
DRV_BISSM_DATA_OK |
State = OK |
DRV_BISSM_DATA_ERR_FRM |
BiSS frame is erroneous |
DRV_BISSM_DATA_ERR_CRC |
BiSS frame CRC is invalid |
Definition at line 282 of file netx_drv_biss.h.
BiSS Data Type Configuration Enumeration data type configuration.
Enumerator | |
---|---|
DRV_BISSM_DATA_TYPE_SENS |
Single cycle sensor data |
DRV_BISSM_DATA_TYPE_ACT |
Single cycle actuator data |
Definition at line 147 of file netx_drv_biss.h.
enum DRV_BISSM_FRM_ERR_E |
BiSS Frame Error Codes Error Codes for a single BiSS frame.
Definition at line 203 of file netx_drv_biss.h.
enum DRV_BISSM_IRQ_E |
BiSS Interrupts Enumeration interrupt requests.
Enumerator | |
---|---|
DRV_BISSM_IRQ_DATA |
BiSS Frame finished, new state can be read with DRV_BissM_GetState(), new process data can be read with DRV_BissM_GetProccesData() |
DRV_BISSM_IRQ_RESET |
BiSS communication stopped, DRV_BissM_SetParam(), DRV_BissM_SetChannelParam() and DRV_BissM_Start() may be called again |
DRV_BISSM_IRQ_CTRL |
Control frame finished, DRV_BissM_GetCtrlData() may be called |
Definition at line 104 of file netx_drv_biss.h.
enum DRV_BISSM_PARAM_E |
BiSS Global Parameters These parameters can be set by DRV_BissM_SetParam() for global DRV_BISSM configuration
Definition at line 116 of file netx_drv_biss.h.
enum DRV_BISSM_RESULT_E |
Functions Result Codes All functions return one of the following values after returning from the function call. Function return values shall always be evaluated by the calling function.
Definition at line 190 of file netx_drv_biss.h.
Definition at line 229 of file netx_drv_biss.h.
void DRV_BissM_Break | ( | void | ) |
Definition at line 1121 of file netx_drv_biss.c.
void DRV_BissM_ConfirmAllIrq | ( | void | ) |
void DRV_BissM_ConfirmIrq | ( | uint32_t | ulIrqMsk | ) |
Definition at line 1018 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_CtrlRst | ( | void | ) |
Definition at line 864 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_CtrlStart | ( | void | ) |
Definition at line 299 of file netx_drv_biss.c.
uint32_t DRV_BissM_GetConfirmIrq | ( | void | ) |
Definition at line 1099 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_GetCtrlData | ( | unsigned int | uRegNr, |
uint8_t * | pbData | ||
) |
Definition at line 928 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_GetCtrlState | ( | DRV_BISSM_CTRL_STATE_T * | ptCtrlState | ) |
Definition at line 972 of file netx_drv_biss.c.
uint32_t DRV_BissM_GetIrq | ( | void | ) |
Definition at line 1038 of file netx_drv_biss.c.
uint32_t DRV_BissM_GetIrqRaw | ( | void | ) |
Definition at line 997 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_GetProcessData | ( | unsigned int | uChNr, |
DRV_BISSM_DATA_STATE_E * | peStatus, | ||
uint16_t * | pusCycleCnt, | ||
uint8_t * | pbData | ||
) |
Definition at line 637 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_GetSsiExtData | ( | unsigned int | uChNr, |
DRV_BISSM_DATA_STATE_E * | peStatus, | ||
uint16_t * | pusCycleCnt, | ||
uint8_t * | pbData | ||
) |
Definition at line 707 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_GetState | ( | DRV_BISSM_STATE_T * | ptState | ) |
Definition at line 572 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_Init | ( | DRV_BISSM_CFG_T * | ptConfig, |
void * | pvUser | ||
) |
void DRV_BissM_IrqDisable | ( | uint32_t | ulIrqMsk | ) |
Definition at line 1079 of file netx_drv_biss.c.
void DRV_BissM_IrqEnable | ( | uint32_t | ulIrqMsk | ) |
Definition at line 1059 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_SetChannelParam | ( | unsigned int | uChNr, |
DRV_BISSM_CHANNEL_PARAM_E | ePrmID, | ||
uint32_t | ulPrmVal | ||
) |
Definition at line 448 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_SetCtrlData | ( | unsigned int | uRegNr, |
const uint8_t * | pbData | ||
) |
Definition at line 882 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_SetParam | ( | DRV_BISSM_PARAM_E | ePrmID, |
uint32_t | ulPrmVal | ||
) |
Definition at line 326 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_SetProcessData | ( | unsigned int | uChNr, |
const uint8_t * | pbData | ||
) |
Definition at line 599 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_StartAgsMin | ( | void | ) |
DRV_BISSM_RESULT_E DRV_BissM_StartCtrlCmd | ( | unsigned int | uSlaveId, |
unsigned int | uOpcode | ||
) |
Definition at line 773 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_StartCtrlReg | ( | unsigned int | uSlaveId, |
unsigned int | uRegAdr, | ||
unsigned int | uRegNr, | ||
unsigned int | uWnR | ||
) |
Definition at line 821 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_StartCycle | ( | uint32_t | ulCycleTimeUs | ) |
DRV_BISSM_RESULT_E DRV_BissM_StartTrigger | ( | DRV_BISSM_TRIGGER_TYPE_E | eTriggerCfg | ) |
uint32_t DRV_BissM_Status0 | ( | void | ) |
Definition at line 1126 of file netx_drv_biss.c.
DRV_BISSM_RESULT_E DRV_BissM_Stop | ( | void | ) |