drivers/arm/i2c_master.h

   1 /* Copyright 2018 Jack Humbert
   2  * Copyright 2018 Yiancar
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /* This library follows the convention of the AVR i2c_master library.
  19  * As a result addresses are expected to be already shifted (addr << 1).
  20  * I2CD1 is the default driver which corresponds to pins B6 and B7. This
  21  * can be changed.
  22  * Please ensure that HAL_USE_I2C is TRUE in the halconf.h file and that
  23  * STM32_I2C_USE_I2C1 is TRUE in the mcuconf.h file.
  24  */
  25 #pragma once
  26
  27 #include "ch.h"
  28 #include <hal.h>
  29
  30 #if defined(STM32F1XX) || defined(STM32F1xx) || defined(STM32F2xx) || defined(STM32F4xx) || defined(STM32F4XX) || defined(STM32L0xx) || defined(STM32L1xx)
  31 #    define USE_I2CV1
  32 #endif
  33
  34 #ifdef I2C1_BANK
  35 #    define I2C1_SCL_BANK I2C1_BANK
  36 #    define I2C1_SDA_BANK I2C1_BANK
  37 #endif
  38
  39 #ifndef I2C1_SCL_BANK
  40 #    define I2C1_SCL_BANK GPIOB
  41 #endif
  42
  43 #ifndef I2C1_SDA_BANK
  44 #    define I2C1_SDA_BANK GPIOB
  45 #endif
  46
  47 #ifndef I2C1_SCL
  48 #    define I2C1_SCL 6
  49 #endif
  50 #ifndef I2C1_SDA
  51 #    define I2C1_SDA 7
  52 #endif
  53
  54 #if defined(STM32F1XX) || defined(STM32F1xx)
  55 #    define USE_GPIOV1
  56 #endif
  57
  58 #ifndef USE_GPIOV1
  59 // The default PAL alternate modes are used to signal that the pins are used for I2C
  60 #    ifndef I2C1_SCL_PAL_MODE
  61 #        define I2C1_SCL_PAL_MODE 4
  62 #    endif
  63 #    ifndef I2C1_SDA_PAL_MODE
  64 #        define I2C1_SDA_PAL_MODE 4
  65 #    endif
  66 #endif
  67
  68 #ifdef USE_I2CV1
  69 #    ifndef I2C1_OPMODE
  70 #        define I2C1_OPMODE OPMODE_I2C
  71 #    endif
  72 #    ifndef I2C1_CLOCK_SPEED
  73 #        define I2C1_CLOCK_SPEED 100000 /* 400000 */
  74 #    endif
  75 #    ifndef I2C1_DUTY_CYCLE
  76 #        define I2C1_DUTY_CYCLE STD_DUTY_CYCLE /* FAST_DUTY_CYCLE_2 */
  77 #    endif
  78 #else
  79 // The default timing values below configures the I2C clock to 400khz assuming a 72Mhz clock
  80 // For more info : https://www.st.com/en/embedded-software/stsw-stm32126.html
  81 #    ifndef I2C1_TIMINGR_PRESC
  82 #        define I2C1_TIMINGR_PRESC 0U
  83 #    endif
  84 #    ifndef I2C1_TIMINGR_SCLDEL
  85 #        define I2C1_TIMINGR_SCLDEL 7U
  86 #    endif
  87 #    ifndef I2C1_TIMINGR_SDADEL
  88 #        define I2C1_TIMINGR_SDADEL 0U
  89 #    endif
  90 #    ifndef I2C1_TIMINGR_SCLH
  91 #        define I2C1_TIMINGR_SCLH 38U
  92 #    endif
  93 #    ifndef I2C1_TIMINGR_SCLL
  94 #        define I2C1_TIMINGR_SCLL 129U
  95 #    endif
  96 #endif
  97
  98 #ifndef I2C_DRIVER
  99 #    define I2C_DRIVER I2CD1
 100 #endif
 101
 102 typedef int16_t i2c_status_t;
 103
 104 #define I2C_STATUS_SUCCESS (0)
 105 #define I2C_STATUS_ERROR (-1)
 106 #define I2C_STATUS_TIMEOUT (-2)
 107
 108 void         i2c_init(void);
 109 i2c_status_t i2c_start(uint8_t address);
 110 i2c_status_t i2c_transmit(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout);
 111 i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);
 112 i2c_status_t i2c_transmit_receive(uint8_t address, uint8_t* tx_body, uint16_t tx_length, uint8_t* rx_body, uint16_t rx_length);
 113 i2c_status_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout);
 114 i2c_status_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);
 115 void         i2c_stop(void);