drivers/arm/i2c_master.h

   1 /* Copyright 2018 Jack Humbert
   2  * Copyright 2018 Yiancar
   3  *
   4  * This program is free sofare: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Sofare 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
  31 #if defined(STM32F1XX) || defined(STM32F1xx) || defined(STM32F2xx) || defined(STM32F4xx) || defined(STM32L0xx) || defined(STM32L1xx)
  32     #define USE_I2CV1
  33 #endif
  34
  35 #ifdef I2C1_BANK
  36     #define I2C1_SCL_BANK I2C1_BANK
  37     #define I2C1_SDA_BANK I2C1_BANK
  38 #endif
  39
  40 #ifndef I2C1_SCL_BANK
  41     #define I2C1_SCL_BANK GPIOB
  42 #endif
  43
  44 #ifndef I2C1_SDA_BANK
  45     #define I2C1_SDA_BANK GPIOB
  46 #endif
  47
  48 #ifndef I2C1_SCL
  49     #define I2C1_SCL 6
  50 #endif
  51 #ifndef I2C1_SDA
  52     #define I2C1_SDA 7
  53 #endif
  54
  55 #ifdef USE_I2CV1
  56     #ifndef I2C1_OPMODE
  57         #define I2C1_OPMODE OPMODE_I2C
  58     #endif
  59     #ifndef I2C1_CLOCK_SPEED
  60         #define I2C1_CLOCK_SPEED 100000 /* 400000 */
  61     #endif
  62     #ifndef I2C1_DUTY_CYCLE
  63         #define I2C1_DUTY_CYCLE STD_DUTY_CYCLE /* FAST_DUTY_CYCLE_2 */
  64     #endif
  65 #else
  66     // The default PAL alternate modes are used to signal that the pins are used for I2C
  67     #ifndef I2C1_SCL_PAL_MODE
  68         #define I2C1_SCL_PAL_MODE 4
  69     #endif
  70     #ifndef I2C1_SDA_PAL_MODE
  71         #define I2C1_SDA_PAL_MODE 4
  72     #endif
  73
  74     // The default timing values below configures the I2C clock to 400khz assuming a 72Mhz clock
  75     // For more info : https://www.st.com/en/embedded-software/stsw-stm32126.html
  76     #ifndef I2C1_TIMINGR_PRESC
  77         #define I2C1_TIMINGR_PRESC 15U
  78     #endif
  79     #ifndef I2C1_TIMINGR_SCLDEL
  80         #define I2C1_TIMINGR_SCLDEL 4U
  81     #endif
  82     #ifndef I2C1_TIMINGR_SDADEL
  83         #define I2C1_TIMINGR_SDADEL 2U
  84     #endif
  85     #ifndef I2C1_TIMINGR_SCLH
  86         #define I2C1_TIMINGR_SCLH 15U
  87     #endif
  88     #ifndef I2C1_TIMINGR_SCLL
  89         #define I2C1_TIMINGR_SCLL 21U
  90     #endif
  91 #endif
  92
  93 #ifndef I2C_DRIVER
  94   #define I2C_DRIVER I2CD1
  95 #endif
  96
  97 typedef int16_t i2c_status_t;
  98
  99 #define I2C_STATUS_SUCCESS (0)
 100 #define I2C_STATUS_ERROR   (-1)
 101 #define I2C_STATUS_TIMEOUT (-2)
 102
 103 void i2c_init(void);
 104 i2c_status_t i2c_start(uint8_t address);
 105 i2c_status_t i2c_transmit(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout);
 106 i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);
 107 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);
 108 i2c_status_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout);
 109 i2c_status_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);
 110 void i2c_stop(void);