|
| | CFN_HAL_VMT_CHECK (struct cfn_hal_i2s_api_s) |
| |
| | CFN_HAL_CREATE_DRIVER_TYPE (i2s, cfn_hal_i2s_config_t, cfn_hal_i2s_api_t, cfn_hal_i2s_phy_t, cfn_hal_i2s_callback_t) |
| |
| CFN_HAL_INLINE void | cfn_hal_i2s_populate (cfn_hal_i2s_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_i2s_api_t *api, const cfn_hal_i2s_phy_t *phy, const cfn_hal_i2s_config_t *config, cfn_hal_i2s_callback_t callback, void *user_arg) |
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_config_validate (const cfn_hal_i2s_t *driver, const cfn_hal_i2s_config_t *config) |
| | Validates the I2S configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_init (cfn_hal_i2s_t *driver) |
| | Initializes the I2S driver.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_deinit (cfn_hal_i2s_t *driver) |
| | Deinitializes the I2S driver.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_config_set (cfn_hal_i2s_t *driver, const cfn_hal_i2s_config_t *config) |
| | Sets the I2S configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_config_get (cfn_hal_i2s_t *driver, cfn_hal_i2s_config_t *config) |
| | Gets the current I2S configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_callback_register (cfn_hal_i2s_t *driver, const cfn_hal_i2s_callback_t callback, void *user_arg) |
| | Registers a callback for I2S events and errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_power_state_set (cfn_hal_i2s_t *driver, cfn_hal_power_state_t state) |
| | Sets the I2S power state.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_event_enable (cfn_hal_i2s_t *driver, uint32_t event_mask) |
| | Enables one or more I2S nominal events.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_event_disable (cfn_hal_i2s_t *driver, uint32_t event_mask) |
| | Disables one or more I2S nominal events.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_event_get (cfn_hal_i2s_t *driver, uint32_t *event_mask) |
| | Retrieves the current I2S nominal event status.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_error_enable (cfn_hal_i2s_t *driver, uint32_t error_mask) |
| | Enables one or more I2S exception errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_error_disable (cfn_hal_i2s_t *driver, uint32_t error_mask) |
| | Disables one or more I2S exception errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_error_get (cfn_hal_i2s_t *driver, uint32_t *error_mask) |
| | Retrieves the current I2S exception error status.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_transmit_dma (cfn_hal_i2s_t *driver, const uint16_t *data, size_t size) |
| | Starts non-blocking audio transmission via DMA.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_receive_dma (cfn_hal_i2s_t *driver, uint16_t *data, size_t size) |
| | Starts non-blocking audio reception via DMA.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_pause (cfn_hal_i2s_t *driver) |
| | Pauses the ongoing I2S audio stream.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_resume (cfn_hal_i2s_t *driver) |
| | Resumes a previously paused I2S audio stream.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_i2s_stop (cfn_hal_i2s_t *driver) |
| | Stops the I2S audio operation and DMA transfers.
|
| |
| cfn_hal_error_code_t | cfn_hal_i2s_construct (cfn_hal_i2s_t *driver, const cfn_hal_i2s_config_t *config, const cfn_hal_i2s_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_i2s_callback_t callback, void *user_arg) |
| |
| cfn_hal_error_code_t | cfn_hal_i2s_destruct (cfn_hal_i2s_t *driver) |
| |
I2S (Serial Audio Interface) HAL API.
Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
