bertos/cpu/cortex-m3/drv/i2c_lm3s.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Driver for the LM3S I2C (implementation)
  34  *
  35  * \author Daniele Basile <asterix@develer.com>
  36  *
  37  */
  38
  39 #include "cfg/cfg_i2c.h"
  40
  41 #define LOG_LEVEL  I2C_LOG_LEVEL
  42 #define LOG_FORMAT I2C_LOG_FORMAT
  43
  44 #include <cfg/log.h>
  45
  46 #include <cfg/debug.h>
  47 #include <cfg/macros.h> // BV()
  48 #include <cfg/module.h>
  49
  50 #include <cpu/detect.h>
  51 #include <cpu/irq.h>
  52 #include <cpu/types.h>
  53 #include <cpu/power.h>
  54
  55 #include <io/lm3s.h>
  56
  57 #include <drv/timer.h>
  58 #include <drv/i2c.h>
  59 #include <drv/gpio_lm3s.h>
  60 #include <drv/clock_lm3s.h>
  61
  62
  63 struct I2cHardware
  64 {
  65         uint32_t base;
  66         uint32_t sys_cntl;
  67         uint32_t sys_gpio;
  68         uint32_t pin_mask;
  69         uint32_t gpio_base;
  70         bool first_xtranf;
  71 };
  72
  73 #define WAIT_BUSY(base) \
  74         do { \
  75                 while (HWREG(base + I2C_O_MCS) & I2C_MCS_BUSY ) \
  76                         cpu_relax(); \
  77         } while (0);
  78
  79
  80 /*
  81  * The start is not performed when we call the start function
  82  * because the hardware should know the first data byte to send.
  83  * Generally to perform a byte send we should write the slave address
  84  * in slave address register and the first byte to send in data registry.
  85  * After then we can perform the start write procedure, and send really
  86  * the our data. To use common bertos i2c api the really start will be
  87  * performed when the user "put" or "send" its data. These tricks are hide
  88  * from the driver implementation.
  89  */
  90 static void i2c_lm3s_start(struct I2c *i2c, uint16_t slave_addr)
  91 {
  92         i2c->hw->first_xtranf = true;
  93
  94         if (I2C_TEST_START(i2c->flags) == I2C_START_W)
  95                 HWREG(i2c->hw->base + I2C_O_MSA) = slave_addr & ~BV(0);
  96         else /* (I2C_TEST_START(i2c->flags) == I2C_START_R) */
  97                 HWREG(i2c->hw->base + I2C_O_MSA) = slave_addr | BV(0);
  98 }
  99
 100 INLINE bool wait_addrAck(I2c *i2c, uint32_t mode_mask)
 101 {
 102         ticks_t start = timer_clock();
 103         while (1)
 104         {
 105                 uint32_t status = HWREG(i2c->hw->base + I2C_O_MCS);
 106
 107                 if (timer_clock() - start > ms_to_ticks(CONFIG_I2C_START_TIMEOUT))
 108                         return false;
 109
 110                 if(status & I2C_MCS_ADRACK)
 111                 {
 112                         HWREG(i2c->hw->base + I2C_O_MCS) = mode_mask;
 113                         WAIT_BUSY(i2c->hw->base);
 114                 }
 115                 else
 116                         break;
 117
 118                 cpu_relax();
 119         }
 120         return true;
 121 }
 122
 123 static void i2c_lm3s_putc(I2c *i2c, const uint8_t data)
 124 {
 125         HWREG(i2c->hw->base + I2C_O_MDR) = data;
 126
 127         if (i2c->hw->first_xtranf)
 128         {
 129                 HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_RUN | I2C_MCS_START;
 130                 while( HWREG(i2c->hw->base + I2C_O_MCS) & I2C_MCS_BUSY );
 131
 132                 if (!wait_addrAck(i2c, I2C_MCS_RUN | I2C_MCS_START))
 133                 {
 134                         LOG_ERR("Start timeout\n");
 135                         i2c->errors |= I2C_START_TIMEOUT;
 136                         HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_STOP;
 137                         WAIT_BUSY(i2c->hw->base);
 138                         return;
 139                 }
 140
 141                 i2c->hw->first_xtranf = false;
 142         }
 143         else
 144         {
 145                 HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_RUN;
 146                 WAIT_BUSY(i2c->hw->base);
 147         }
 148
 149         if ((i2c->xfer_size == 1) && (I2C_TEST_STOP(i2c->flags) == I2C_STOP))
 150         {
 151                 HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_STOP;
 152                 WAIT_BUSY(i2c->hw->base);
 153         }
 154 }
 155
 156 static uint8_t i2c_lm3s_getc(I2c *i2c)
 157 {
 158         uint8_t data;
 159         if (i2c->hw->first_xtranf)
 160         {
 161                 uint32_t start_mode;
 162                 if (i2c->xfer_size == 1)
 163                         start_mode = I2C_MCS_RUN | I2C_MCS_START;
 164                 else
 165                         start_mode = I2C_MCS_ACK | I2C_MCS_RUN | I2C_MCS_START;
 166
 167                 HWREG(i2c->hw->base + I2C_O_MCS) = start_mode;
 168                 WAIT_BUSY(i2c->hw->base);
 169                 if (!wait_addrAck(i2c, start_mode))
 170                 {
 171                         LOG_ERR("Start timeout\n");
 172                         i2c->errors |= I2C_START_TIMEOUT;
 173                         HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_STOP;
 174                         WAIT_BUSY(i2c->hw->base);
 175                         return 0xFF;
 176                 }
 177
 178                 data = HWREG(i2c->hw->base + I2C_O_MDR);
 179                 i2c->hw->first_xtranf = false;
 180         }
 181         else
 182         {
 183                 if (i2c->xfer_size > 1)
 184                         HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_ACK | I2C_MCS_RUN;
 185                 else
 186                         HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_RUN;
 187
 188                 WAIT_BUSY(i2c->hw->base);
 189                 data = HWREG(i2c->hw->base + I2C_O_MDR);
 190         }
 191
 192         if ((i2c->xfer_size == 1) && (I2C_TEST_STOP(i2c->flags) == I2C_STOP))
 193         {
 194                 HWREG(i2c->hw->base + I2C_O_MCS) = I2C_MCS_STOP;
 195                 WAIT_BUSY(i2c->hw->base);
 196         }
 197         return data;
 198 }
 199
 200 MOD_DEFINE(i2c);
 201
 202 static const I2cVT i2c_lm3s_vt =
 203 {
 204         .start = i2c_lm3s_start,
 205         .getc = i2c_lm3s_getc,
 206         .putc = i2c_lm3s_putc,
 207         .write = i2c_genericWrite,
 208         .read = i2c_genericRead,
 209 };
 210
 211 struct I2cHardware i2c_lm3s_hw[] =
 212 {
 213         { /* I2C0 */
 214                 .base = I2C0_MASTER_BASE,
 215                 .sys_cntl = SYSCTL_RCGC1_I2C0,
 216                 .sys_gpio = SYSCTL_RCGC2_GPIOB,
 217                 .pin_mask = (GPIO_I2C0_SCL_PIN | GPIO_I2C0_SDA_PIN),
 218                 .gpio_base = GPIO_PORTB_BASE,
 219         },
 220         { /* I2C1 */
 221                 .base = I2C1_MASTER_BASE,
 222                 .sys_cntl = SYSCTL_RCGC1_I2C1,
 223                 .sys_gpio = SYSCTL_RCGC2_GPIOA,
 224                 .pin_mask = (GPIO_I2C1_SCL_PIN | GPIO_I2C1_SDA_PIN),
 225                 .gpio_base = GPIO_PORTA_BASE,
 226         },
 227 };
 228
 229 /**
 230  * Initialize I2C module.
 231  */
 232 void i2c_hw_init(I2c *i2c, int dev, uint32_t clock)
 233 {
 234         i2c->hw = &i2c_lm3s_hw[dev];
 235         i2c->vt = &i2c_lm3s_vt;
 236
 237         /* Enable the peripheral clock */
 238         SYSCTL_RCGC1_R |= i2c->hw->sys_cntl;
 239         SYSCTL_RCGC2_R |= i2c->hw->sys_gpio;
 240
 241         /* Configure GPIO pins to work as I2C pins */
 242         lm3s_gpioPinConfig(i2c->hw->gpio_base, i2c->hw->pin_mask,
 243                 GPIO_DIR_MODE_HW, GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_OD_WPU);
 244         /*
 245          * Note: to set correctly the i2c speed we shold before enable the i2c
 246          * device and then set in master time period the correct value
 247          */
 248
 249         /* Enable i2c device */
 250         HWREG(i2c->hw->base + I2C_O_MCR) |= I2C_MCR_MFE;
 251
 252     /*
 253          * Compute the clock divider that achieves the fastest speed less than or
 254      * equal to the desired speed.  The numerator is biased to favor a larger
 255      * clock divider so that the resulting clock is always less than or equal
 256      * to the desired clock, never greater.
 257          */
 258     HWREG(i2c->hw->base + I2C_O_MTPR) = ((CPU_FREQ + (2 * 10 * clock) - 1) / (2 * 10 * clock)) - 1;
 259
 260         MOD_INIT(i2c);
 261 }