hpm_i2c.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_I2C_COMPONENTS_H
#define HPM_I2C_COMPONENTS_H
 
#include "hpm_i2c_drv.h"
#ifdef HPMSOC_HAS_HPMSDK_DMAV2
#include "hpm_dmav2_drv.h"
#else
#include "hpm_dma_drv.h"
#endif
#include "hpm_dmamux_drv.h"
#include "hpm_misc.h"
#include "hpm_l1c_drv.h"
 
#ifndef USE_I2C_DMA_MGR
#define USE_I2C_DMA_MGR      (0U)
#endif
 
#if USE_I2C_DMA_MGR
#include "hpm_dma_mgr.h"
typedef void (*hpm_i2c_dma_complete_cb)(uint32_t channel);
#endif
 
typedef enum i2c_speed {
    i2c_speed_100khz,  /* normal mode, speed is 100kHz*/
    i2c_speed_400khz,  /* Fast mode, speed is 400kHz */
    i2c_speed_1Mhz,    /* Fast plus mode, speed is 1MHz */
} hpm_i2c_speed_t;
 
typedef enum i2c_communication_mode {
    i2c_master,
    i2c_slave,
} hpm_i2c_communication_mode_t;
 
typedef enum i2c_master_addr_endianness {
    i2c_master_addr_little_endian = 0,
    i2c_master_addr_big_endian,
} hpm_i2c_master_addr_endianness_t;
 
typedef struct i2c_initialize_config {
    hpm_i2c_communication_mode_t communication_mode; /* I2C communication mode */
    hpm_i2c_speed_t speed;                           /* I2C communication speed */
    bool is_10bit_addressing;                    /* Flag for 10-bit addressing mode */
    uint8_t slave_address;                       /* Slave address, only support slave mode */
} hpm_i2c_initialize_config_t;
 
typedef struct i2c_context_t {
    I2C_Type *base;
    hpm_i2c_initialize_config_t init_config;
    hpm_i2c_master_addr_endianness_t addr_endianness;
} hpm_i2c_context_t;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
void hpm_i2c_get_default_init_context(hpm_i2c_context_t *context);
 
hpm_stat_t hpm_i2c_initialize(hpm_i2c_context_t *context);
 
hpm_stat_t hpm_i2c_master_probe_slave_address(hpm_i2c_context_t *context, uint16_t device_address);
 
hpm_stat_t hpm_i2c_master_addr_write_blocking(hpm_i2c_context_t *context, const uint16_t device_address, uint32_t addr, uint8_t addr_size,
                                   uint8_t *buf, uint32_t buf_size, uint32_t timeout);
 
hpm_stat_t hpm_i2c_master_addr_read_blocking(hpm_i2c_context_t *context, const uint16_t device_address, uint32_t addr, uint8_t addr_size,
                                   uint8_t *buf, uint32_t buf_size, uint32_t timeout);
 
hpm_stat_t hpm_i2c_master_write_blocking(hpm_i2c_context_t *context, uint16_t device_address,
                            uint8_t *buf, uint32_t size, uint32_t timeout);
 
hpm_stat_t hpm_i2c_master_read_blocking(hpm_i2c_context_t *context, const uint16_t device_address,
                           uint8_t *buf, const uint32_t size, uint32_t timeout);
 
hpm_stat_t hpm_i2c_slave_write_blocking(hpm_i2c_context_t *context, uint8_t *buf, uint32_t size, uint32_t timeout);
 
hpm_stat_t hpm_i2c_slave_read_blocking(hpm_i2c_context_t *context, uint8_t *buf, uint32_t size, uint32_t timeout);
 
#if USE_I2C_DMA_MGR
hpm_stat_t hpm_i2c_dma_mgr_install_callback(hpm_i2c_context_t *context, hpm_i2c_dma_complete_cb complete);
 
hpm_stat_t hpm_i2c_master_addr_write_nonblocking(hpm_i2c_context_t *context, const uint16_t device_address, uint32_t addr, uint8_t addr_size,
                                   uint8_t *buf, uint32_t buf_size);
 
hpm_stat_t hpm_i2c_master_addr_read_nonblocking(hpm_i2c_context_t *context, const uint16_t device_address, uint32_t addr, uint8_t addr_size,
                                   uint8_t *buf, uint32_t buf_size);
 
hpm_stat_t hpm_i2c_master_write_nonblocking(hpm_i2c_context_t *context, uint16_t device_address,
                            uint8_t *buf, uint32_t size);
 
hpm_stat_t hpm_i2c_master_read_nonblocking(hpm_i2c_context_t *context, const uint16_t device_address,
                           uint8_t *buf, const uint32_t size);
 
hpm_stat_t hpm_i2c_slave_read_nonblocking(hpm_i2c_context_t *context, uint8_t *buf, uint32_t size);
 
hpm_stat_t hpm_i2c_slave_write_nonblocking(hpm_i2c_context_t *context, uint8_t *buf, uint32_t size);
 
dma_resource_t *hpm_i2c_get_dma_mgr_resource(hpm_i2c_context_t *context);
 
#endif
#ifdef __cplusplus
}
#endif
 
#endif