mirror of
https://github.com/espressif/esp-idf.git
synced 2025-09-25 01:37:22 +00:00
i2s: Introduced a brand new driver
This commit is contained in:
@@ -10,38 +10,39 @@
|
||||
#pragma once
|
||||
|
||||
#include "esp_err.h"
|
||||
#include "soc/soc_caps.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Register an I2S or I2S variant driver object to platform
|
||||
* @brief Hold the I2S port occupation
|
||||
*
|
||||
* @note This private API is used to avoid applications from using the same I2S instance for different purpose.
|
||||
* @note This function will help enable the peripheral APB clock as well.
|
||||
*
|
||||
* @param driver_obj Driver object
|
||||
* @param port_id I2S port number
|
||||
* @param id I2S port number
|
||||
* @param comp_name The name of compnant that occupied this i2s controller
|
||||
* @return
|
||||
* - ESP_OK: The specific I2S port is free and register the new device object successfully
|
||||
* - ESP_ERR_INVALID_ARG: Invalid argument, e.g. wrong port_id
|
||||
* - ESP_ERR_NOT_FOUND: Specific I2S port is not available
|
||||
* - ESP_ERR_NOT_FOUND Specific I2S port is not available
|
||||
*/
|
||||
esp_err_t i2s_priv_register_object(void *driver_obj, int port_id);
|
||||
esp_err_t i2s_platform_acquire_occupation(int id, const char *comp_name);
|
||||
|
||||
/**
|
||||
* @brief Deregister I2S or I2S variant driver object from platform
|
||||
* @brief Release the I2S port occupation
|
||||
*
|
||||
* @note This function will help disable the peripheral APB clock as well.
|
||||
*
|
||||
* @param port_id I2S port number
|
||||
* @param id I2S port number
|
||||
* @return
|
||||
* - ESP_OK: Deregister I2S port successfully (i.e. that I2S port can used used by other users after this function returns)
|
||||
* - ESP_ERR_INVALID_ARG: Invalid argument, e.g. wrong port_id
|
||||
* - ESP_ERR_INVALID_STATE: Specific I2S port is free already
|
||||
*/
|
||||
esp_err_t i2s_priv_deregister_object(int port_id);
|
||||
esp_err_t i2s_platform_release_occupation(int id);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
Reference in New Issue
Block a user