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
  26 #include "ch.h"
  27 #include <hal.h>
  28
  29 #ifdef I2C1_BANK
  30     #define I2C1_SCL_BANK I2C1_BANK
  31     #define I2C1_SDA_BANK I2C1_BANK
  32 #endif
  33
  34 #ifndef I2C1_SCL_BANK
  35     #define I2C1_SCL_BANK GPIOB
  36 #endif
  37
  38 #ifndef I2C1_SDA_BANK
  39     #define I2C1_SDA_BANK GPIOB
  40 #endif
  41
  42 #ifndef I2C1_SCL
  43     #define I2C1_SCL 6
  44 #endif
  45 #ifndef I2C1_SDA
  46     #define I2C1_SDA 7
  47 #endif
  48
  49 // The default PAL alternate modes are used to signal that the pins are used for I2C
  50 #ifndef I2C1_SCL_PAL_MODE
  51     #define I2C1_SCL_PAL_MODE 4
  52 #endif
  53 #ifndef I2C1_SDA_PAL_MODE
  54     #define I2C1_SDA_PAL_MODE 4
  55 #endif
  56
  57 // The default timing values below configures the I2C clock to 400khz assuming a 72Mhz clock
  58 // For more info : https://www.st.com/en/embedded-software/stsw-stm32126.html
  59 #ifndef I2C1_TIMINGR_PRESC
  60     #define I2C1_TIMINGR_PRESC 15U
  61 #endif
  62 #ifndef I2C1_TIMINGR_SCLDEL
  63     #define I2C1_TIMINGR_SCLDEL 4U
  64 #endif
  65 #ifndef I2C1_TIMINGR_SDADEL
  66     #define I2C1_TIMINGR_SDADEL 2U
  67 #endif
  68 #ifndef I2C1_TIMINGR_SCLH
  69     #define I2C1_TIMINGR_SCLH 15U
  70 #endif
  71 #ifndef I2C1_TIMINGR_SCLL
  72     #define I2C1_TIMINGR_SCLL 21U
  73 #endif
  74
  75 #ifndef I2C_DRIVER
  76   #define I2C_DRIVER I2CD1
  77 #endif
  78
  79 typedef int16_t i2c_status_t;
  80
  81 #define I2C_STATUS_SUCCESS (0)
  82 #define I2C_STATUS_ERROR   (-1)
  83 #define I2C_STATUS_TIMEOUT (-2)
  84
  85 void i2c_init(void);
  86 i2c_status_t i2c_start(uint8_t address);
  87 i2c_status_t i2c_transmit(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout);
  88 i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);
  89 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);
  90 i2c_status_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout);
  91 i2c_status_t i2c_readReg(uint8_t devaddr, uint8_t* regaddr, uint8_t* data, uint16_t length, uint16_t timeout);
  92 void i2c_stop(void);