drivers/arm/i2c_master.c

   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 is only valid for STM32 processors.
  19  * This library follows the convention of the AVR i2c_master library.
  20  * As a result addresses are expected to be already shifted (addr << 1).
  21  * I2CD1 is the default driver which corresponds to pins B6 and B7. This
  22  * can be changed.
  23  * Please ensure that HAL_USE_I2C is TRUE in the halconf.h file and that
  24  * STM32_I2C_USE_I2C1 is TRUE in the mcuconf.h file. Pins B6 and B7 are used
  25  * but using any other I2C pins should be trivial.
  26  */
  27
  28 #include "i2c_master.h"
  29 #include "quantum.h"
  30 #include <string.h>
  31 #include <hal.h>
  32
  33 static uint8_t i2c_address;
  34
  35 // This configures the I2C clock to 400khz assuming a 72Mhz clock
  36 // For more info : https://www.st.com/en/embedded-software/stsw-stm32126.html
  37 static const I2CConfig i2cconfig = {
  38   STM32_TIMINGR_PRESC(15U) |
  39   STM32_TIMINGR_SCLDEL(4U) | STM32_TIMINGR_SDADEL(2U) |
  40   STM32_TIMINGR_SCLH(15U)  | STM32_TIMINGR_SCLL(21U),
  41   0,
  42   0
  43 };
  44
  45 __attribute__ ((weak))
  46 void i2c_init(void)
  47 {
  48   // Try releasing special pins for a short time
  49   palSetPadMode(I2C1_BANK, I2C1_SCL, PAL_MODE_INPUT);
  50   palSetPadMode(I2C1_BANK, I2C1_SDA, PAL_MODE_INPUT);
  51
  52   chThdSleepMilliseconds(10);
  53
  54   palSetPadMode(I2C1_BANK, I2C1_SCL, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN);
  55   palSetPadMode(I2C1_BANK, I2C1_SDA, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN);
  56
  57   //i2cInit(); //This is invoked by halInit() so no need to redo it.
  58 }
  59
  60 // This is usually not needed
  61 uint8_t i2c_start(uint8_t address)
  62 {
  63   i2c_address = address;
  64   i2cStart(&I2C_DRIVER, &i2cconfig);
  65   return 0;
  66 }
  67
  68 uint8_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout)
  69 {
  70   // FIXME: Next steps: Add a print here, copy this file to your rgb_matrix firmware. Compare both.
  71   i2c_address = address;
  72   i2cStart(&I2C_DRIVER, &i2cconfig);
  73   return i2cMasterTransmitTimeout(&I2C_DRIVER, (i2c_address >> 1), data, length, 0, 0, MS2ST(timeout));
  74 }
  75
  76 uint8_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout)
  77 {
  78   i2c_address = address;
  79   i2cStart(&I2C_DRIVER, &i2cconfig);
  80   return i2cMasterReceiveTimeout(&I2C_DRIVER, (i2c_address >> 1), data, length, MS2ST(timeout));
  81 }
  82
  83 uint8_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)
  84 {
  85   i2c_address = devaddr;
  86   i2cStart(&I2C_DRIVER, &i2cconfig);
  87
  88   uint8_t complete_packet[length + 1];
  89   for(uint8_t i = 0; i < length; i++)
  90   {
  91     complete_packet[i+1] = data[i];
  92   }
  93   complete_packet[0] = regaddr;
  94
  95   return i2cMasterTransmitTimeout(&I2C_DRIVER, (i2c_address >> 1), complete_packet, length + 1, 0, 0, MS2ST(timeout));
  96 }
  97
  98 uint8_t i2c_readReg(uint8_t devaddr, uint8_t* regaddr, uint8_t* data, uint16_t length, uint16_t timeout)
  99 {
 100   i2c_address = devaddr;
 101   i2cStart(&I2C_DRIVER, &i2cconfig);
 102   return i2cMasterTransmitTimeout(&I2C_DRIVER, (i2c_address >> 1), regaddr, 1, data, length, MS2ST(timeout));
 103 }
 104
 105 // This is usually not needed. It releases the driver to allow pins to become GPIO again.
 106 uint8_t i2c_stop(uint16_t timeout)
 107 {
 108   i2cStop(&I2C_DRIVER);
 109   return 0;
 110 }