97 lines
3 KiB
C
97 lines
3 KiB
C
// Copyright 2015-2019 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "soc/i2c_caps.h"
|
|
|
|
/**
|
|
* @brief I2C port number, can be I2C_NUM_0 ~ (I2C_NUM_MAX-1).
|
|
*/
|
|
typedef int i2c_port_t;
|
|
|
|
typedef enum{
|
|
I2C_MODE_SLAVE = 0, /*!< I2C slave mode */
|
|
I2C_MODE_MASTER, /*!< I2C master mode */
|
|
I2C_MODE_MAX,
|
|
} i2c_mode_t;
|
|
|
|
typedef enum {
|
|
I2C_MASTER_WRITE = 0, /*!< I2C write data */
|
|
I2C_MASTER_READ, /*!< I2C read data */
|
|
} i2c_rw_t;
|
|
|
|
typedef enum{
|
|
I2C_CMD_RESTART = 0, /*!<I2C restart command */
|
|
I2C_CMD_WRITE, /*!<I2C write command */
|
|
I2C_CMD_READ, /*!<I2C read command */
|
|
I2C_CMD_STOP, /*!<I2C stop command */
|
|
I2C_CMD_END /*!<I2C end command */
|
|
} i2c_opmode_t;
|
|
|
|
typedef enum {
|
|
I2C_DATA_MODE_MSB_FIRST = 0, /*!< I2C data msb first */
|
|
I2C_DATA_MODE_LSB_FIRST = 1, /*!< I2C data lsb first */
|
|
I2C_DATA_MODE_MAX
|
|
} i2c_trans_mode_t;
|
|
|
|
typedef enum {
|
|
I2C_ADDR_BIT_7 = 0, /*!< I2C 7bit address for slave mode */
|
|
I2C_ADDR_BIT_10, /*!< I2C 10bit address for slave mode */
|
|
I2C_ADDR_BIT_MAX,
|
|
} i2c_addr_mode_t;
|
|
|
|
typedef enum {
|
|
I2C_MASTER_ACK = 0x0, /*!< I2C ack for each byte read */
|
|
I2C_MASTER_NACK = 0x1, /*!< I2C nack for each byte read */
|
|
I2C_MASTER_LAST_NACK = 0x2, /*!< I2C nack for the last byte*/
|
|
I2C_MASTER_ACK_MAX,
|
|
} i2c_ack_type_t;
|
|
|
|
typedef enum {
|
|
I2C_SCLK_REF_TICK, /*!< I2C source clock from REF_TICK */
|
|
I2C_SCLK_APB, /*!< I2C source clock from APB */
|
|
} i2c_sclk_t;
|
|
|
|
/**
|
|
* @brief I2C initialization parameters
|
|
*/
|
|
typedef struct{
|
|
i2c_mode_t mode; /*!< I2C mode */
|
|
int sda_io_num; /*!< GPIO number for I2C sda signal */
|
|
int scl_io_num; /*!< GPIO number for I2C scl signal */
|
|
bool sda_pullup_en; /*!< Internal GPIO pull mode for I2C sda signal*/
|
|
bool scl_pullup_en; /*!< Internal GPIO pull mode for I2C scl signal*/
|
|
|
|
union {
|
|
struct {
|
|
uint32_t clk_speed; /*!< I2C clock frequency for master mode, (no higher than 1MHz for now) */
|
|
} master; /*!< I2C master config */
|
|
struct {
|
|
uint8_t addr_10bit_en; /*!< I2C 10bit address mode enable for slave mode */
|
|
uint16_t slave_addr; /*!< I2C address for slave mode */
|
|
} slave; /*!< I2C slave config */
|
|
};
|
|
} i2c_config_t;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|