Hardware Abstraction Layer (HAL)
_cyhal_audioss_interface_t Struct Reference

Description

Interface to abstract away the driver-specific differences between TDM and I2S.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

Data Fields

void(* invoke_user_callback )(struct _cyhal_audioss_s *obj, uint32_t hal_event)
 Invoke the user callback with the specified HAL event. More...
 
uint32_t event_mask_empty
 HAL event mask that represents the empty state.
 
uint32_t event_mask_half_empty
 HAL event mask that represents the half empty state.
 
uint32_t event_mask_full
 HAL event mask that represents the full state.
 
uint32_t event_mask_half_full
 HAL event mask that represents the half full state.
 
uint32_t event_rx_complete
 HAL event mask that represents async rx complete.
 
uint32_t event_tx_complete
 HAL event mask that represents async tx complete.
 
cy_rslt_t err_invalid_pin
 Error code for invalid pin.
 
cy_rslt_t err_invalid_arg
 Error code for invalid argument.
 
cy_rslt_t err_clock
 Error code for invalid clock frequency.
 
cy_rslt_t err_not_supported
 Error code for configuration not supported.
 

Field Documentation

◆ invoke_user_callback

void(* _cyhal_audioss_interface_t::invoke_user_callback) (struct _cyhal_audioss_s *obj, uint32_t hal_event)

Invoke the user callback with the specified HAL event.

Only called after the user callback has been verified to not be null.