Header file of TDM Interface. More...
#include <stdint.h>#include <stdbool.h>
Go to the source code of this file.
Classes | |
| struct | no_os_tdm_init_param |
| Structure holding the parameters for TDM initialization. More... | |
| struct | no_os_tdm_desc |
| Structure holding TDM descriptor. More... | |
| struct | no_os_tdm_platform_ops |
| Structure holding TDM function pointers that point to the platform specific function. More... | |
Enumerations | |
| enum | no_os_tdm_mode { NO_OS_TDM_MASTER_TX, NO_OS_TDM_MASTER_RX, NO_OS_TDM_SLAVE_TX, NO_OS_TDM_SLAVE_RX } |
Functions | |
| int32_t | no_os_tdm_init (struct no_os_tdm_desc **desc, const struct no_os_tdm_init_param *param) |
| Initialize the TDM communication peripheral. More... | |
| int32_t | no_os_tdm_remove (struct no_os_tdm_desc *desc) |
| Free the resources allocated by no_os_tdm_init(). More... | |
| int32_t | no_os_tdm_read (struct no_os_tdm_desc *desc, void *data, uint16_t bytes_number) |
| Read data using the TDM interface. More... | |
| int32_t | no_os_tdm_write (struct no_os_tdm_desc *desc, void *data, uint16_t bytes_number) |
| Write data using the TDM interface. More... | |
| int32_t | no_os_tdm_pause (struct no_os_tdm_desc *desc) |
| Pause TDM DMA transfer. More... | |
| int32_t | no_os_tdm_resume (struct no_os_tdm_desc *desc) |
| Resume TDM DMA transfer. More... | |
| int32_t | no_os_tdm_stop (struct no_os_tdm_desc *desc) |
| Stop TDM DMA transfer. More... | |
Detailed Description
Header file of TDM Interface.
Copyright 2020(c) Analog Devices, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
- The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
- Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.
THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Enumeration Type Documentation
◆ no_os_tdm_mode
| enum no_os_tdm_mode |
Function Documentation
◆ no_os_tdm_init()
| int32_t no_os_tdm_init | ( | struct no_os_tdm_desc ** | desc, |
| const struct no_os_tdm_init_param * | param | ||
| ) |
Initialize the TDM communication peripheral.
- Parameters
-
desc - The TDM descriptor. param - The structure that contains the TDM parameters.
- Returns
- 0 in case of success, negative error code otherwise.
◆ no_os_tdm_pause()
| int32_t no_os_tdm_pause | ( | struct no_os_tdm_desc * | desc | ) |
Pause TDM DMA transfer.
- Parameters
-
desc - The TDM descriptor.
- Returns
- 0 in case of success, negative error code otherwise.
◆ no_os_tdm_read()
| int32_t no_os_tdm_read | ( | struct no_os_tdm_desc * | desc, |
| void * | data, | ||
| uint16_t | nb_samples | ||
| ) |
Read data using the TDM interface.
- Parameters
-
desc - The TDM descriptor. data - The buffer to store the received data. nb_samples - Number of samples to read.
- Returns
- 0 in case of success, negative error code otherwise.
◆ no_os_tdm_remove()
| int32_t no_os_tdm_remove | ( | struct no_os_tdm_desc * | desc | ) |
Free the resources allocated by no_os_tdm_init().
- Parameters
-
desc - The TDM descriptor.
- Returns
- 0 in case of success, negative error code otherwise.
◆ no_os_tdm_resume()
| int32_t no_os_tdm_resume | ( | struct no_os_tdm_desc * | desc | ) |
Resume TDM DMA transfer.
- Parameters
-
desc - The TDM descriptor.
- Returns
- 0 in case of success, negative error code otherwise.
◆ no_os_tdm_stop()
| int32_t no_os_tdm_stop | ( | struct no_os_tdm_desc * | desc | ) |
Stop TDM DMA transfer.
- Parameters
-
desc - The TDM descriptor.
- Returns
- 0 in case of success, negative error code otherwise.
◆ no_os_tdm_write()
| int32_t no_os_tdm_write | ( | struct no_os_tdm_desc * | desc, |
| void * | data, | ||
| uint16_t | nb_samples | ||
| ) |
Write data using the TDM interface.
- Parameters
-
desc - The TDM descriptor. data - The buffer with the data to be transmitted. nb_samples - Number of samples to write.
- Returns
- 0 in case of success, negative error code otherwise.
