bertos/cpu/cortex-m3/drv/i2c_sam3.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 2011 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief TWI driver for SAM3 (implementation)
  34  *
  35  * Only master mode is supported.
  36  *
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  */
  39
  40
  41 #include "cfg/cfg_i2c.h"
  42
  43 #define LOG_LEVEL  I2C_LOG_LEVEL
  44 #define LOG_FORMAT I2C_LOG_FORMAT
  45
  46 #include <cfg/log.h>
  47
  48 #include <hw/hw_cpufreq.h>  // CPU_FREQ
  49 #include <cfg/debug.h>
  50 #include <cfg/macros.h> // BV()
  51 #include <cfg/module.h>
  52 #include <cpu/detect.h>
  53 #include <cpu/irq.h>
  54 #include <cpu/power.h>
  55 #include <drv/timer.h>
  56 #include <drv/i2c.h>
  57 #include <io/sam3.h>
  58
  59
  60 struct I2cHardware
  61 {
  62         uint32_t base;
  63         bool     first_xtranf;
  64 };
  65
  66
  67 INLINE bool waitTxRdy(I2c *i2c, time_t ms_timeout)
  68 {
  69         ticks_t start = timer_clock();
  70
  71         while (!(HWREG(i2c->hw->base + TWI_SR_OFF) & TWI_SR_TXRDY))
  72         {
  73                 if (timer_clock() - start > ms_to_ticks(ms_timeout))
  74                         return false;
  75                 cpu_relax();
  76         }
  77
  78         return true;
  79 }
  80
  81 INLINE bool waitRxRdy(I2c *i2c, time_t ms_timeout)
  82 {
  83         ticks_t start = timer_clock();
  84
  85         while (!(HWREG(i2c->hw->base + TWI_SR_OFF) & TWI_SR_RXRDY))
  86         {
  87                 if (timer_clock() - start > ms_to_ticks(ms_timeout))
  88                         return false;
  89                 cpu_relax();
  90         }
  91
  92         return true;
  93 }
  94
  95 INLINE void waitXferComplete(I2c *i2c)
  96 {
  97         while (!(HWREG(i2c->hw->base + TWI_SR_OFF) & TWI_SR_TXCOMP))
  98                 cpu_relax();
  99 }
 100
 101
 102 /*
 103  * The start is not performed when we call the start function
 104  * because the hardware should know the first data byte to send.
 105  * Generally to perform a byte send we should write the slave address
 106  * in slave address register and the first byte to send in data registry.
 107  * After then we can perform the start write procedure, and send really
 108  * the our data. To use common bertos i2c api the really start will be
 109  * performed when the user "put" or "send" its data. These tricks are hide
 110  * from the driver implementation.
 111  */
 112 static void i2c_sam3_start(struct I2c *i2c, uint16_t slave_addr)
 113 {
 114         i2c->hw->first_xtranf = true;
 115
 116         if (I2C_TEST_START(i2c->flags) == I2C_START_R)
 117                 HWREG(i2c->hw->base + TWI_MMR_OFF) = TWI_MMR_DADR(slave_addr >> 1) | TWI_MMR_MREAD;
 118         else
 119                 HWREG(i2c->hw->base + TWI_MMR_OFF) = TWI_MMR_DADR(slave_addr >> 1);
 120 }
 121
 122 static void i2c_sam3_putc(I2c *i2c, const uint8_t data)
 123 {
 124         if (!waitTxRdy(i2c, CONFIG_I2C_START_TIMEOUT))
 125         {
 126                 LOG_ERR("i2c: txready timeout\n");
 127                 i2c->errors |= I2C_START_TIMEOUT;
 128                 return;
 129         }
 130
 131         HWREG(i2c->hw->base + TWI_THR_OFF) = data;
 132
 133         if ((i2c->xfer_size == 1) && (I2C_TEST_STOP(i2c->flags) == I2C_STOP))
 134                 HWREG(i2c->hw->base + TWI_CR_OFF) = TWI_CR_STOP;
 135
 136         // On first byte sent wait for start timeout
 137         if (i2c->hw->first_xtranf && !waitTxRdy(i2c, CONFIG_I2C_START_TIMEOUT))
 138         {
 139                 LOG_ERR("i2c: write start timeout\n");
 140                 i2c->errors |= I2C_START_TIMEOUT;
 141                 HWREG(i2c->hw->base + TWI_CR_OFF) = TWI_CR_STOP;
 142                 waitXferComplete(i2c);
 143                 return;
 144         }
 145         i2c->hw->first_xtranf = false;
 146
 147         if ((i2c->xfer_size == 1) && (I2C_TEST_STOP(i2c->flags) == I2C_STOP))
 148                 waitXferComplete(i2c);
 149 }
 150
 151 static uint8_t i2c_sam3_getc(I2c *i2c)
 152 {
 153         uint8_t data;
 154         uint32_t cr = 0;
 155
 156         if (i2c->hw->first_xtranf)
 157         {
 158                 cr |= TWI_CR_START;
 159                 i2c->hw->first_xtranf = false;
 160         }
 161         if ((i2c->xfer_size == 1) && (I2C_TEST_STOP(i2c->flags) == I2C_STOP))
 162                 cr |= TWI_CR_STOP;
 163
 164         HWREG(i2c->hw->base + TWI_CR_OFF) = cr;
 165
 166         if (!waitRxRdy(i2c, CONFIG_I2C_START_TIMEOUT))
 167         {
 168                 LOG_ERR("i2c: read start timeout\n");
 169                 i2c->errors |= I2C_START_TIMEOUT;
 170                 return 0xFF;
 171         }
 172
 173         data = HWREG(i2c->hw->base + TWI_RHR_OFF);
 174
 175         if ((i2c->xfer_size == 1) && (I2C_TEST_STOP(i2c->flags) == I2C_STOP))
 176                 waitXferComplete(i2c);
 177
 178         return data;
 179 }
 180
 181 static void i2c_setClock(I2c *i2c, int clock)
 182 {
 183         uint32_t ck_div = 0;
 184         uint32_t cl_div;
 185
 186         for (;;)
 187         {
 188                 cl_div = ((CPU_FREQ / (2 * clock)) - 4) / (1 << ck_div);
 189
 190                 if (cl_div <= 255)
 191                         break;
 192
 193                 ck_div++;
 194         }
 195
 196         ASSERT(ck_div < 8);
 197         LOG_INFO("i2c: using CKDIV = %lu and CLDIV/CHDIV = %lu\n\n", ck_div, cl_div);
 198
 199         HWREG(i2c->hw->base + TWI_CWGR_OFF) = 0;
 200         HWREG(i2c->hw->base + TWI_CWGR_OFF) = (ck_div << 16) | (cl_div << 8) | cl_div;
 201 }
 202
 203
 204 static const I2cVT i2c_sam3_vt =
 205 {
 206         .start = i2c_sam3_start,
 207         .getc = i2c_sam3_getc,
 208         .putc = i2c_sam3_putc,
 209         .write = i2c_genericWrite,
 210         .read = i2c_genericRead,
 211 };
 212
 213 struct I2cHardware i2c_sam3_hw[I2C_CNT];
 214
 215
 216 /**
 217  * Initialize I2C module.
 218  */
 219 void i2c_hw_init(I2c *i2c, int dev, uint32_t clock)
 220 {
 221         ASSERT(dev < I2C_CNT);
 222
 223         i2c->hw = &i2c_sam3_hw[dev];
 224         i2c->vt = &i2c_sam3_vt;
 225
 226         pmc_periphEnable(PIOA_ID);
 227
 228         switch (dev)
 229         {
 230                 case I2C0:
 231                         i2c->hw->base = TWI0_BASE;
 232                         PIO_PERIPH_SEL(TWI0_PORT, BV(TWI0_TWD) | BV(TWI0_TWCK), TWI0_PERIPH);
 233                         HWREG(TWI0_PORT + PIO_PDR_OFF) = BV(TWI0_TWD) | BV(TWI0_TWCK);
 234                         pmc_periphEnable(TWI0_ID);
 235                         break;
 236                 case I2C1:
 237                         i2c->hw->base = TWI1_BASE;
 238                         PIO_PERIPH_SEL(TWI1_PORT, BV(TWI1_TWD) | BV(TWI1_TWCK), TWI1_PERIPH);
 239                         HWREG(TWI1_PORT + PIO_PDR_OFF) = BV(TWI1_TWD) | BV(TWI1_TWCK);
 240                         pmc_periphEnable(TWI1_ID);
 241                         break;
 242                 default:
 243                         ASSERT(!"i2c: invalid dev number");
 244                         return;
 245         }
 246
 247
 248         // Reset and set master mode
 249         HWREG(i2c->hw->base + TWI_CR_OFF) = TWI_CR_SWRST;
 250         HWREG(i2c->hw->base + TWI_CR_OFF) = TWI_CR_MSEN | TWI_CR_SVDIS;
 251
 252         i2c_setClock(i2c, clock);
 253 }