cfn_hal_api_base_s Struct Reference

Base API structure for all peripheral drivers. Every peripheral-specific API struct MUST have this as its first member. More...

#include <cfn_hal_base.h>

Data Fields
cfn_hal_error_code_t(*	init )(cfn_hal_driver_t *base)
cfn_hal_error_code_t(*	deinit )(cfn_hal_driver_t *base)
cfn_hal_error_code_t(*	power_state_set )(cfn_hal_driver_t *base, cfn_hal_power_state_t state)
cfn_hal_error_code_t(*	config_set )(cfn_hal_driver_t *base, const void *config)
cfn_hal_error_code_t(*	config_validate )(const cfn_hal_driver_t *base, const void *config)
cfn_hal_error_code_t(*	callback_register )(cfn_hal_driver_t *base, cfn_hal_callback_t callback, void *user_arg)
cfn_hal_error_code_t(*	event_enable )(cfn_hal_driver_t *base, uint32_t event_mask)
cfn_hal_error_code_t(*	event_disable )(cfn_hal_driver_t *base, uint32_t event_mask)
cfn_hal_error_code_t(*	event_get )(cfn_hal_driver_t *base, uint32_t *event_mask)
cfn_hal_error_code_t(*	error_enable )(cfn_hal_driver_t *base, uint32_t error_mask)
cfn_hal_error_code_t(*	error_disable )(cfn_hal_driver_t *base, uint32_t error_mask)
cfn_hal_error_code_t(*	error_get )(cfn_hal_driver_t *base, uint32_t *error_mask)

Detailed Description

Base API structure for all peripheral drivers. Every peripheral-specific API struct MUST have this as its first member.

Field Documentation

callback_register

cfn_hal_error_code_t(* cfn_hal_api_base_s::callback_register) (cfn_hal_driver_t *base, cfn_hal_callback_t callback, void *user_arg)

config_set

cfn_hal_error_code_t(* cfn_hal_api_base_s::config_set) (cfn_hal_driver_t *base, const void *config)

config_validate

cfn_hal_error_code_t(* cfn_hal_api_base_s::config_validate) (const cfn_hal_driver_t *base, const void *config)

deinit

cfn_hal_error_code_t(* cfn_hal_api_base_s::deinit) (cfn_hal_driver_t *base)

error_disable

cfn_hal_error_code_t(* cfn_hal_api_base_s::error_disable) (cfn_hal_driver_t *base, uint32_t error_mask)

error_enable

cfn_hal_error_code_t(* cfn_hal_api_base_s::error_enable) (cfn_hal_driver_t *base, uint32_t error_mask)

error_get

cfn_hal_error_code_t(* cfn_hal_api_base_s::error_get) (cfn_hal_driver_t *base, uint32_t *error_mask)

event_disable

cfn_hal_error_code_t(* cfn_hal_api_base_s::event_disable) (cfn_hal_driver_t *base, uint32_t event_mask)

event_enable

cfn_hal_error_code_t(* cfn_hal_api_base_s::event_enable) (cfn_hal_driver_t *base, uint32_t event_mask)

event_get

cfn_hal_error_code_t(* cfn_hal_api_base_s::event_get) (cfn_hal_driver_t *base, uint32_t *event_mask)

init

cfn_hal_error_code_t(* cfn_hal_api_base_s::init) (cfn_hal_driver_t *base)

power_state_set

cfn_hal_error_code_t(* cfn_hal_api_base_s::power_state_set) (cfn_hal_driver_t *base, cfn_hal_power_state_t state)

---

The documentation for this struct was generated from the following file:

• include/cfn_hal_base.h