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

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

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

Go to the source code of this file.

## Classes
struct | app_i2c_pin_t
| I2C pins Structures. More...
struct | app_i2c_pin_cfg_t
| I2C pins config Structures. More...
struct | app_i2c_dma_cfg_t
| I2C operate mode Enumerations definition. More...
struct | app_i2c_evt_t
| I2C event structure definition. More...
struct | i2c_env_t
| I2C device structure definition. More...
struct | app_i2c_params_t
| I2C parameters structure definition. More...

## Typedefs
typedef void(* | app_i2c_evt_handler_t) (app_i2c_evt_t *p_evt)
| I2C event callback definition. More...

## Enumerations
enum | app_i2c_id_t { APP_I2C_ID_0, APP_I2C_ID_1, APP_I2C_ID_MAX }
| I2C module Enumerations definition. More...
enum | app_i2c_role_t { APP_I2C_ROLE_MASTER, APP_I2C_ROLE_SLAVE, APP_I2C_ROLE_MAX }
| I2C role Enumerations definition. More...
enum | app_i2c_evt_type_t { APP_I2C_EVT_ERROR, APP_I2C_EVT_TX_CPLT, APP_I2C_EVT_RX_DATA, APP_I2C_ABORT }
| I2C event Enumerations definition. More...
enum | app_i2c_state_t { APP_I2C_INVALID = 0, APP_I2C_ACTIVITY }
| App i2c state types. More...
enum | app_i2c_dma_state_t { APP_I2C_DMA_INVALID = 0, APP_I2C_DMA_ACTIVITY }
| App i2c dma state types. More...

## Functions
uint16_t | app_i2c_init (app_i2c_params_t *p_params, app_i2c_evt_handler_t evt_handler)
| Initialize the APP I2C DRIVER according to the specified parameters in the app_i2c_params_t and app_i2c_evt_handler_t. More...
uint16_t | app_i2c_deinit (app_i2c_id_t id)
| De-initialize the APP I2C DRIVER peripheral. More...
uint16_t | app_i2c_receive_sync (app_i2c_id_t id, uint16_t target_address, uint8_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_i2c_receive_async (app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size)
| Receive in master or slave mode an amount of data in non-blocking mode with Interrupt/DMA. More...
uint16_t | app_i2c_transmit_sync (app_i2c_id_t id, uint16_t target_address, uint8_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_i2c_transmit_async (app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size)
| Transmits in master or slave mode an amount of data in non-blocking mode with Interrupt/DMA. More...
uint16_t | app_i2c_mem_read_sync (app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size, uint32_t timeout)
| Read an amount of data in blocking mode from a specific memory address. More...
uint16_t | app_i2c_mem_read_async (app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)
| Read an amount of data in non-blocking mode with Interrupt/DMA from a specific memory address. More...
uint16_t | app_i2c_mem_write_sync (app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size, uint32_t timeout)
| Write an amount of data in blocking mode to a specific memory address. More...
uint16_t | app_i2c_mem_write_async (app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)
| Write an amount of data in non-blocking mode with Interrupt/DMA to a specific memory address. More...
i2c_handle_t * | app_i2c_get_handle (app_i2c_id_t id)
| Return the I2C handle. More...
uint16_t | app_i2c_master_abort_it (app_i2c_id_t id)
| Abort a master I2C IT or DMA process communication with Interrupt. More...
uint16_t | app_i2c_timing_adjust (app_i2c_id_t id, uint32_t timing_type, int32_t delta)
| Adjust I2C timing value to adapt to real load. More...
uint16_t | app_i2c_timing_get (app_i2c_id_t id, uint32_t timing_type, uint32_t *p_timing_value)
| Get I2C timing value. More...
uint16_t | app_i2c_transmit_receive_sync (app_i2c_id_t id, uint16_t dev_address, uint8_t *p_tdata, uint16_t tsize, uint8_t *p_rdata, uint16_t rsize, uint32_t timeout)
| Transmits than receives in master mode or receives than transmits in slave mode with only one stop bit. More...

## Detailed Description

Header file containing functions prototypes of I2C 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_i2c.h.