i2s_platform_acquire_occupation() function

Hold the I2S port occupation

Syntax

Show:

Summary

Declaration

Definition

from i2s_platform.h:40

esp_err_t i2s_platform_acquire_occupation(i2s_ctlr_t type, int id, const char *comp_name);

Implemented in i2s_platform.c:33

Arguments

Argument

Description

type

I2S controller type

I2S port number

comp_name

The name of compnant that occupied this i2s controller

Return value

- 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

Notes

This private API is used to avoid applications from using the same I2S instance for different purpose. This function will help enable the peripheral APB clock as well.

Examples

References

from examples

i2s_platform_acquire_occupation() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle