cpu_i2c.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Freie Universität Berlin
 * SPDX-FileCopyrightText: 2017 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "cpu.h"
#include "periph/cpu_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define PERIPH_I2C_NEED_READ_REG
#define PERIPH_I2C_NEED_WRITE_REG
#define PERIPH_I2C_NEED_READ_REGS
#if defined(CPU_FAM_STM32F1) || defined(CPU_FAM_STM32F2) || \
    defined(CPU_FAM_STM32L1) || defined(CPU_FAM_STM32F4) || \
    defined(CPU_FAM_STM32MP1)
#define PERIPH_I2C_NEED_WRITE_REGS
#endif
 
#ifndef DOXYGEN
#define HAVE_I2C_SPEED_T
typedef enum {
#if defined(CPU_FAM_STM32F1) || defined(CPU_FAM_STM32F2) || \
    defined(CPU_FAM_STM32F4) || defined(CPU_FAM_STM32L1) || \
    defined(CPU_FAM_STM32MP1)
    I2C_SPEED_LOW,          
#endif
    I2C_SPEED_NORMAL,       
    I2C_SPEED_FAST,         
#if defined(CPU_FAM_STM32F0) || defined(CPU_FAM_STM32F3) || \
    defined(CPU_FAM_STM32F7) || defined(CPU_FAM_STM32L0) || \
    defined(CPU_FAM_STM32L4) || defined(CPU_FAM_STM32WB) || \
    defined(CPU_FAM_STM32G4) || defined(CPU_FAM_STM32G0) || \
    defined(CPU_FAM_STM32L5) || defined(CPU_FAM_STM32U5) || \
    defined(CPU_FAM_STM32WL) || defined(CPU_FAM_STM32C0) || \
    defined(CPU_FAM_STM32H7)
    I2C_SPEED_FAST_PLUS,    
#endif
} i2c_speed_t;
#endif /* ndef DOXYGEN */

typedef struct {
    I2C_TypeDef *dev;       
    i2c_speed_t speed;      
    gpio_t scl_pin;         
    gpio_t sda_pin;         
#ifndef CPU_FAM_STM32F1
    gpio_af_t scl_af;       
    gpio_af_t sda_af;       
#endif
    uint8_t bus;            
    uint32_t rcc_mask;      
#if defined(CPU_FAM_STM32F0) || defined(CPU_FAM_STM32F3) || \
    defined(CPU_FAM_STM32F7) || defined(CPU_FAM_STM32G0) || \
    defined(CPU_FAM_STM32G4) || defined(CPU_FAM_STM32L4) || \
    defined(CPU_FAM_STM32L5) || defined(CPU_FAM_STM32WB) || \
    defined(CPU_FAM_STM32U5) || defined(CPU_FAM_STM32WL) || \
    defined(CPU_FAM_STM32C0) || defined(CPU_FAM_STM32H7)
    uint32_t rcc_sw_mask;   
#endif
#if defined(CPU_FAM_STM32F1) || defined(CPU_FAM_STM32F2) || \
    defined(CPU_FAM_STM32F4) || defined(CPU_FAM_STM32L1) || \
    defined(CPU_FAM_STM32MP1)
    uint32_t clk;           
#endif
    uint8_t irqn;           
} i2c_conf_t;
 
#if defined(CPU_FAM_STM32F0) || defined(CPU_FAM_STM32F3) || \
    defined(CPU_FAM_STM32F7) || defined(CPU_FAM_STM32L0) || \
    defined(CPU_FAM_STM32L4) || defined(CPU_FAM_STM32L5) || \
    defined(CPU_FAM_STM32G0) || defined(CPU_FAM_STM32G4) || \
    defined(CPU_FAM_STM32U5) || defined(CPU_FAM_STM32WB) || \
    defined(CPU_FAM_STM32WL) || defined(CPU_FAM_STM32C0) || \
    defined(CPU_FAM_STM32H7)
typedef struct {
    uint8_t presc;          
    uint8_t scll;           
    uint8_t sclh;           
    uint8_t sdadel;         
    uint8_t scldel;         
} i2c_timing_param_t;

static const i2c_timing_param_t timing_params[] = {
#  if defined (CPU_FAM_STM32H7) /* HSI input clock 64MHz */
    [ I2C_SPEED_NORMAL ]    = {
        .presc  = 4,
        .scll   = 0x3F,     /* t_SCLL   = 5.0us   */
        .sclh   = 0x33,     /* t_SCLH   = 4.0us   */
        .sdadel = 0x1,      /* t_SDADEL = 500ns   */
        .scldel = 0xF,      /* t_SCLDEL = 1250ns  */
    }, /* 0x4F10333F */
    [ I2C_SPEED_FAST ]      = {
        .presc  = 1,
        .scll   = 0x27,     /* t_SCLL   = 1250ns  */
        .sclh   = 0x0F,     /* t_SCLH   = 500ns   */
        .sdadel = 0x1,      /* t_SDADEL = 250ns   */
        .scldel = 0xC,      /* t_SCLDEL = 500ns   */
    }, /* 0x1C100F27 */
    [ I2C_SPEED_FAST_PLUS ] = {
        .presc =  1,
        .scll =   0x09,     /* t_SCLL   = 312.5ns */
        .sclh =   0x05,     /* t_SCLH   = 187.5ns */
        .sdadel = 0x1,      /* t_SDADEL = 0ns     */
        .scldel = 0xC,      /* t_SCLDEL = 187.5ns */
    }, /* 0x1C100509 */
#  else
    [ I2C_SPEED_NORMAL ]    = {
        .presc  = 3,
        .scll   = 0x13,     /* t_SCLL   = 5.0us   */
        .sclh   = 0xF,      /* t_SCLH   = 4.0us   */
        .sdadel = 0x2,      /* t_SDADEL = 500ns   */
        .scldel = 0x4,      /* t_SCLDEL = 1250ns  */
    },
    [ I2C_SPEED_FAST ]      = {
        .presc  = 1,
        .scll   = 0x9,      /* t_SCLL   = 1250ns  */
        .sclh   = 0x3,      /* t_SCLH   = 500ns   */
        .sdadel = 0x2,      /* t_SDADEL = 250ns   */
        .scldel = 0x3,      /* t_SCLDEL = 500ns   */
    },
    [ I2C_SPEED_FAST_PLUS ] = {
        .presc =  0,
        .scll =   0x4,      /* t_SCLL   = 312.5ns */
        .sclh =   0x2,      /* t_SCLH   = 187.5ns */
        .sdadel = 0x0,      /* t_SDADEL = 0ns     */
        .scldel = 0x2,      /* t_SCLDEL = 187.5ns */
    }
#  endif
};
#endif  /* CPU_FAM_STM32F0 || CPU_FAM_STM32F3 || CPU_FAM_STM32F7 ||
            CPU_FAM_STM32L0 || CPU_FAM_STM32L4 || CPU_FAM_STM32L5 ||
            CPU_FAM_STM32G0 || CPU_FAM_STM32G4 || CPU_FAM_STM32U5 ||
            CPU_FAM_STM32WB || CPU_FAM_STM32WL || CPU_FAM_STM32C0 ||
            CPU_FAM_STM32H7 */
 
#if defined(CPU_FAM_STM32F0) || defined(CPU_FAM_STM32F3) || \
    defined(CPU_FAM_STM32F7) || defined(CPU_FAM_STM32G0) || \
    defined(CPU_FAM_STM32G4) || defined(CPU_FAM_STM32L0) || \
    defined(CPU_FAM_STM32L4) || defined(CPU_FAM_STM32L5) || \
    defined(CPU_FAM_STM32U5) || defined(CPU_FAM_STM32WB) || \
    defined(CPU_FAM_STM32WL) || defined(CPU_FAM_STM32C0) || \
    defined(CPU_FAM_STM32H7)
#define PERIPH_I2C_MAX_BYTES_PER_FRAME  (256U)
#endif
 
#ifdef __cplusplus
}
#endif