Classes | Typedefs | Enumerations | Functions
app_i2s.h File Reference

Header file containing functions prototypes of I2S app library. More...

`#include <stdbool.h>`
`#include "grx_hal.h"`
`#include "app_io.h"`
`#include "app_dma.h"`
`#include "app_drv_error.h"`
`#include "app_drv_config.h"`
Include dependency graph for app_i2s.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | app_i2s_pin_t
| I2S pins Structures. More...
struct | app_i2s_pin_cfg_t
| I2S pins config Structures. More...
struct | app_i2s_dma_cfg_t
| I2S operate mode Enumerations definition. More...
struct | app_i2s_evt_t
| I2S event structure definition. More...
struct | i2s_env_t
| I2S device structure definition. More...
struct | app_i2s_params_t
| I2S parameters structure definition. More...

## Typedefs
typedef void(* | app_i2s_evt_handler_t) (app_i2s_evt_t *p_evt)
| I2S event callback definition. More...

## Enumerations
enum | app_i2s_id_t { APP_I2S_ID_SLAVE, APP_I2S_ID_MASTER, APP_I2S_ID_MAX }
| I2S module Enumerations definition. More...
enum | app_i2s_evt_type_t { APP_I2S_EVT_ERROR, APP_I2S_EVT_TX_CPLT, APP_I2S_EVT_RX_DATA, APP_I2S_EVT_TX_RX }
| I2S event Enumerations definition. More...
enum | app_i2s_state_t { APP_I2S_INVALID = 0, APP_I2S_ACTIVITY }
| App i2s state types. More...
enum | app_i2s_dma_state_t { APP_I2S_DMA_INVALID = 0, APP_I2S_DMA_ACTIVITY }
| App i2s dma state types. More...

## Functions
uint16_t | app_i2s_init (app_i2s_params_t *p_params, app_i2s_evt_handler_t evt_handler)
| Initialize the APP I2S DRIVER according to the specified parameters in the app_i2s_params_t and app_i2s_evt_handler_t. More...
uint16_t | app_i2s_deinit (app_i2s_id_t id)
| De-initialize the APP I2S DRIVER peripheral. More...
uint16_t | app_i2s_receive_sync (app_i2s_id_t id, uint16_t *p_data, uint16_t size, uint32_t timeout)
| Receive in master or slave mode an amount of data in blocking mode. More...
uint16_t | app_i2s_receive_async (app_i2s_id_t id, uint16_t *p_data, uint16_t size)
| Receive in master or slave mode an amount of data in non-blocking mode with Interrupt. More...
uint16_t | app_i2s_transmit_sync (app_i2s_id_t id, uint16_t *p_data, uint16_t size, uint32_t timeout)
| Transmits in master or slave mode an amount of data in blocking mode. More...
uint16_t | app_i2s_transmit_async (app_i2s_id_t id, uint16_t *p_data, uint16_t size)
| Transmits in master or slave mode an amount of data in non-blocking mode with Interrupt. More...
uint16_t | app_i2s_enable (app_i2s_id_t id)
| Enable the I2S module. More...
uint16_t | app_i2s_disable (app_i2s_id_t id)
| Disable the I2S module. More...
uint16_t | app_i2s_enable_clock (app_i2s_id_t id)
| Enable the master I2S clock. More...
uint16_t | app_i2s_disable_clock (app_i2s_id_t id)
| Disable the master I2S clock. More...
uint16_t | app_i2s_flush_tx_fifo (app_i2s_id_t id)
| Flush the I2S transmitter FIFO. More...
uint16_t | app_i2s_flush_rx_fifo (app_i2s_id_t id)
| Flush the I2S receiver FIFO. More...
i2s_handle_t * | app_i2s_get_handle (app_i2s_id_t id)
| Return the I2S handle. More...
uint16_t | app_i2s_abort (app_i2s_id_t id)
| Abort ongoing transfer (blocking mode). More...
uint16_t | app_i2s_transmit_receive_sync (app_i2s_id_t id, uint16_t *p_tx_data, uint16_t *p_rx_data, uint32_t length, uint32_t timeout)
| Transmit and Receive an amount of data in blocking mode. More...
uint16_t | app_i2s_transmit_receive_async (app_i2s_id_t id, uint16_t *p_tx_data, uint16_t *p_rx_data, uint32_t length)
| Transmit and Receive an amount of data in non-blocking mode with Interrupt. More...

## Detailed Description

Header file containing functions prototypes of I2S app library.

Author
  BLE Driver Team

Attention

  ##### Copyright (c) 2019 GOODIX

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 GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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.

Definition in file app_i2s.h.