bertos/cpu/arm/drv/i2c_lpc2.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 LPC23xx I2C (implementation)
  34  *
  35  */
  36
  37 #include "cfg/cfg_i2c.h"
  38
  39 #define LOG_LEVEL  I2C_LOG_LEVEL
  40 #define LOG_FORMAT I2C_LOG_FORMAT
  41
  42 #include <cfg/log.h>
  43
  44 #include <cfg/debug.h>
  45 #include <cfg/macros.h> // BV()
  46 #include <cfg/module.h>
  47
  48 #include <cpu/detect.h>
  49 #include <cpu/irq.h>
  50
  51 #include <drv/timer.h>
  52 #include <drv/i2c.h>
  53 #include <drv/vic_lpc2.h> /* vic_handler_t */
  54
  55 #include <io/lpc23xx.h>
  56
  57 #include <stdarg.h>
  58
  59
  60 struct I2cHardware
  61 {
  62         int dev;
  63 };
  64
  65 /*
  66  *
  67  */
  68 #if 1
  69         /* I2C 0 */
  70         #define I2C_PCONP                    PCONP_PCI2C0
  71         #define I2C_CONSET                   I20CONSET
  72         #define I2C_CONCLR                   I20CONCLR
  73         #define I2C_SCLH                     I20SCLH
  74         #define I2C_SCLL                     I20SCLL
  75         #define I2C_STAT                     I20STAT
  76         #define I2C_DAT                      I20DAT
  77         #define I2C_PINSEL_PORT              PINSEL1
  78         #define I2C_PINSEL                   I2C0_PINSEL
  79         #define I2C_PINSEL_MASK              I2C0_PINSEL_MASK
  80         #define I2C_PCLKSEL                  PCLKSEL0
  81         #define I2C_PCLK_MASK                I2C0_PCLK_MASK
  82         #define I2C_PCLK_DIV8                I2C0_PCLK_DIV8
  83 #else
  84         /* I2C 1 */
  85         #error
  86 #endif
  87
  88 #define GET_STATUS()   ((uint8_t)I2C_STAT)
  89 /*
  90  * Wait that SI bit is set.
  91  *
  92  * Note: this bit is set when the I2C state changes. However, entering
  93  * state F8 does not set SI since there is nothing for an interrupt service
  94  * routine to do in that case.
  95  */
  96 #define WAIT_SI() \
  97         do { \
  98                 ticks_t start = timer_clock(); \
  99                 while( !(I2C_CONSET & BV(I2CON_SI)) ) \
 100                 { \
 101                         if (timer_clock() - start > ms_to_ticks(CONFIG_I2C_START_TIMEOUT)) \
 102                         { \
 103                                 LOG_ERR("Timeout SI assert\n"); \
 104                                 break; \
 105                         } \
 106                 } \
 107         } while (0)
 108
 109 static void i2c_hw_restart(void)
 110 {
 111         // Clear all pending flags.
 112         I2C_CONCLR = BV(I2CON_STAC) | BV(I2CON_SIC) | BV(I2CON_AAC);
 113
 114         // Set start and ack bit.
 115         I2C_CONSET = BV(I2CON_STA);
 116
 117         WAIT_SI();
 118 }
 119
 120
 121 static void i2c_hw_stop(void)
 122 {
 123         /* Set the stop bit */
 124         I2C_CONSET = BV(I2CON_STO);
 125         /* Clear pending flags */
 126         I2C_CONCLR = BV(I2CON_STAC) | BV(I2CON_SIC) | BV(I2CON_AAC);
 127 }
 128
 129 static void i2c_lpc2_put(I2c *i2c, uint8_t data)
 130 {
 131         I2C_DAT = data;
 132         I2C_CONCLR = BV(I2CON_SIC);
 133
 134         WAIT_SI();
 135
 136         uint32_t status = GET_STATUS();
 137
 138
 139         /* Generate the stop if we finish to send all programmed bytes */
 140         if (i2c->xfer_size == 1)
 141         {
 142                 if (I2C_TEST_STOP(i2c->flags) == I2C_STOP)
 143                         i2c_hw_stop();
 144         }
 145
 146         if (status == I2C_STAT_DATA_NACK)
 147         {
 148                 LOG_ERR("Data NACK\n");
 149                 i2c->errors |= I2C_NO_ACK;
 150                 i2c_hw_stop();
 151         }
 152         else if ((status == I2C_STAT_ERROR) || (status == I2C_STAT_UNKNOW))
 153         {
 154                 LOG_ERR("I2C error.\n");
 155                 i2c->errors |= I2C_ERR;
 156                 i2c_hw_stop();
 157         }
 158 }
 159
 160 static uint8_t i2c_lpc2_get(I2c *i2c)
 161 {
 162         /*
 163          * Set ack bit if we want read more byte, otherwise
 164          * we disable it
 165          */
 166         if (i2c->xfer_size > 1)
 167                 I2C_CONSET = BV(I2CON_AA);
 168         else
 169                 I2C_CONCLR = BV(I2CON_AAC);
 170
 171         I2C_CONCLR = BV(I2CON_SIC);
 172
 173         WAIT_SI();
 174
 175         uint32_t status = GET_STATUS();
 176         uint8_t data = (uint8_t)(I2C_DAT & 0xFF);
 177
 178         if (status == I2C_STAT_RDATA_ACK)
 179         {
 180                 return data;
 181         }
 182         else if (status == I2C_STAT_RDATA_NACK)
 183         {
 184                 /*
 185                  * last byte to read generate the stop if
 186                  * required
 187                  */
 188                 if (I2C_TEST_STOP(i2c->flags) == I2C_STOP)
 189                         i2c_hw_stop();
 190
 191                 return data;
 192         }
 193         else if ((status == I2C_STAT_ERROR) || (status == I2C_STAT_UNKNOW))
 194         {
 195                 LOG_ERR("I2C error.\n");
 196                 i2c->errors |= I2C_ERR;
 197                 i2c_hw_stop();
 198         }
 199
 200         return 0xFF;
 201 }
 202
 203 MOD_DEFINE(i2c);
 204
 205 static void i2c_lpc2_start(struct I2c *i2c, uint16_t slave_addr)
 206 {
 207         if (I2C_TEST_START(i2c->flags) == I2C_START_W)
 208         {
 209                 ticks_t start = timer_clock();
 210                 while (true)
 211                 {
 212                         i2c_hw_restart();
 213
 214                         uint8_t status = GET_STATUS();
 215
 216                         /* Start status ok, set addres and the R/W bit */
 217                         if ((status == I2C_STAT_SEND) || (status == I2C_STAT_RESEND))
 218                                 I2C_DAT = slave_addr & ~I2C_READBIT;
 219
 220                         /* Clear the start bit and clear the SI bit */
 221                         I2C_CONCLR = BV(I2CON_SIC) | BV(I2CON_STAC);
 222
 223                         if (status == I2C_STAT_SLAW_ACK)
 224                                 break;
 225
 226                         if (status == I2C_STAT_ARB_LOST)
 227                                 goto error;
 228
 229                         if (timer_clock() - start > ms_to_ticks(CONFIG_I2C_START_TIMEOUT))
 230                         {
 231                                 LOG_ERR("Timeout on I2C START\n");
 232                                 i2c->errors |= I2C_NO_ACK;
 233                                 i2c_hw_stop();
 234                                 break;
 235                         }
 236                 }
 237         }
 238         else if (I2C_TEST_START(i2c->flags) == I2C_START_R)
 239         {
 240                 i2c_hw_restart();
 241
 242                 uint8_t status = GET_STATUS();
 243
 244                 /* Start status ok, set addres and the R/W bit */
 245                 if ((status == I2C_STAT_SEND) || (status == I2C_STAT_RESEND))
 246                         I2C_DAT = slave_addr | I2C_READBIT;
 247
 248                 /* Clear the start bit and clear the SI bit */
 249                 I2C_CONCLR = BV(I2CON_SIC) | BV(I2CON_STAC);
 250
 251                 WAIT_SI();
 252
 253                 status = GET_STATUS();
 254
 255                 if (status == I2C_STAT_SLAR_NACK)
 256                 {
 257                         LOG_ERR("SLAR NACK:%02x\n", status);
 258                         i2c->errors |= I2C_NO_ACK;
 259                         i2c_hw_stop();
 260                 }
 261
 262                 if (status == I2C_STAT_ARB_LOST)
 263                         goto error;
 264         }
 265         else
 266         {
 267                 ASSERT(0);
 268         }
 269
 270 error:
 271         LOG_ERR("Arbitration lost\n");
 272         i2c->errors |= I2C_ARB_LOST;
 273         i2c_hw_stop();
 274 }
 275
 276 static const I2cVT i2c_lpc_vt =
 277 {
 278         .start = i2c_lpc2_start,
 279         .get = i2c_lpc2_get,
 280         .put = i2c_lpc2_put,
 281         .send = i2c_swSend,
 282         .recv = i2c_swRecv,
 283 };
 284
 285 struct I2cHardware i2c_lpc2_hw =
 286 {
 287         .dev = 0,
 288 };
 289
 290
 291 /**
 292  * Initialize I2C module.
 293  */
 294 void i2c_hw_init(I2c *i2c, int dev, uint32_t clock)
 295 {
 296         i2c->hw = &i2c_lpc2_hw;
 297         i2c->vt = &i2c_lpc_vt;
 298
 299         /* Enable I2C clock */
 300         PCONP |= BV(I2C_PCONP);
 301
 302         ASSERT(clock <= 400000);
 303
 304         I2C_CONCLR = BV(I2CON_I2ENC) | BV(I2CON_STAC) | BV(I2CON_SIC) | BV(I2CON_AAC);
 305
 306         /*
 307          * Bit Frequency = Fplk / (I2C_I2SCLH + I2C_I2SCLL)
 308          * value of I2SCLH and I2SCLL must be different
 309          */
 310         I2C_PCLKSEL &= ~I2C_PCLK_MASK;
 311         I2C_PCLKSEL |= I2C_PCLK_DIV8;
 312
 313         I2C_SCLH = (((CPU_FREQ / 8) / clock) / 2) + 1;
 314         I2C_SCLL = (((CPU_FREQ / 8) / clock) / 2);
 315
 316         ASSERT(I2C_SCLH > 4 || I2C_SCLL > 4);
 317
 318         /* Assign pins to SCL and SDA (P0_27, P0_28) */
 319         I2C_PINSEL_PORT &= ~I2C_PINSEL_MASK;
 320         I2C_PINSEL_PORT |= I2C_PINSEL;
 321
 322         // Enable I2C
 323         I2C_CONSET = BV(I2CON_I2EN);
 324
 325         MOD_INIT(i2c);
 326 }