Remove svn tags.
[bertos.git] / bertos / cpu / avr / drv / i2c_avr.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 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Driver for the AVR ATMega TWI (implementation)
34  *
35  * \author Stefano Fedrigo <aleph@develer.com>
36  * \author Bernie Innocenti <bernie@codewiz.org>
37  */
38
39 #include <hw/hw_cpufreq.h>  /* CPU_FREQ */
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 <cfg/debug.h>
49 #include <cfg/macros.h> // BV()
50 #include <cfg/module.h>
51
52 #include <cpu/detect.h>
53 #include <cpu/irq.h>
54 #include <drv/timer.h>
55 #include <drv/i2c.h>
56
57 #include <compat/twi.h>
58
59
60 /* Wait for TWINT flag set: bus is ready */
61 #define WAIT_TWI_READY  do {} while (!(TWCR & BV(TWINT)))
62
63 /**
64  * Send START condition on the bus.
65  *
66  * \return true on success, false otherwise.
67  */
68 static bool i2c_builtin_start(void)
69 {
70         TWCR = BV(TWINT) | BV(TWSTA) | BV(TWEN);
71         WAIT_TWI_READY;
72
73         if (TW_STATUS == TW_START || TW_STATUS == TW_REP_START)
74                 return true;
75
76         LOG_ERR("!TW_(REP)START: %x\n", TWSR);
77         return false;
78 }
79
80
81 /**
82  * Send START condition and select slave for write.
83  * \c id is the device id comprehensive of address left shifted by 1.
84  * The LSB of \c id is ignored and reset to 0 for write operation.
85  *
86  * \return true on success, false otherwise.
87  */
88 bool i2c_builtin_start_w(uint8_t id)
89 {
90         /*
91          * Loop on the select write sequence: when the eeprom is busy
92          * writing previously sent data it will reply to the SLA_W
93          * control byte with a NACK.  In this case, we must
94          * keep trying until the eeprom responds with an ACK.
95          */
96         ticks_t start = timer_clock();
97         while (i2c_builtin_start())
98         {
99                 TWDR = id & ~I2C_READBIT;
100                 TWCR = BV(TWINT) | BV(TWEN);
101                 WAIT_TWI_READY;
102
103                 if (TW_STATUS == TW_MT_SLA_ACK)
104                         return true;
105                 else if (TW_STATUS != TW_MT_SLA_NACK)
106                 {
107                         LOG_ERR("!TW_MT_SLA_(N)ACK: %x\n", TWSR);
108                         break;
109                 }
110                 else if (timer_clock() - start > ms_to_ticks(CONFIG_I2C_START_TIMEOUT))
111                 {
112                         LOG_ERR("Timeout on TWI_MT_START\n");
113                         break;
114                 }
115         }
116
117         return false;
118 }
119
120
121 /**
122  * Send START condition and select slave for read.
123  * \c id is the device id comprehensive of address left shifted by 1.
124  * The LSB of \c id is ignored and set to 1 for read operation.
125  *
126  * \return true on success, false otherwise.
127  */
128 bool i2c_builtin_start_r(uint8_t id)
129 {
130         if (i2c_builtin_start())
131         {
132                 TWDR = id | I2C_READBIT;
133                 TWCR = BV(TWINT) | BV(TWEN);
134                 WAIT_TWI_READY;
135
136                 if (TW_STATUS == TW_MR_SLA_ACK)
137                         return true;
138
139                 LOG_ERR("!TW_MR_SLA_ACK: %x\n", TWSR);
140         }
141
142         return false;
143 }
144
145
146 /**
147  * Send STOP condition.
148  */
149 void i2c_builtin_stop(void)
150 {
151         TWCR = BV(TWINT) | BV(TWEN) | BV(TWSTO);
152 }
153
154
155 /**
156  * Put a single byte in master transmitter mode
157  * to the selected slave device through the TWI bus.
158  *
159  * \return true on success, false on error.
160  */
161 bool i2c_builtin_put(const uint8_t data)
162 {
163         TWDR = data;
164         TWCR = BV(TWINT) | BV(TWEN);
165         WAIT_TWI_READY;
166         if (TW_STATUS != TW_MT_DATA_ACK)
167         {
168                 LOG_ERR("!TW_MT_DATA_ACK: %x\n", TWSR);
169                 return false;
170         }
171         return true;
172 }
173
174 /**
175  * Get 1 byte from slave in master transmitter mode
176  * to the selected slave device through the TWI bus.
177  * If \a ack is true issue a ACK after getting the byte,
178  * otherwise a NACK is issued.
179  *
180  * \return the byte read if ok, EOF on errors.
181  */
182 int i2c_builtin_get(bool ack)
183 {
184         TWCR = BV(TWINT) | BV(TWEN) | (ack ? BV(TWEA) : 0);
185         WAIT_TWI_READY;
186
187         if (ack)
188         {
189                 if (TW_STATUS != TW_MR_DATA_ACK)
190                 {
191                         LOG_ERR("!TW_MR_DATA_ACK: %x\n", TWSR);
192                         return EOF;
193                 }
194         }
195         else
196         {
197                 if (TW_STATUS != TW_MR_DATA_NACK)
198                 {
199                         LOG_ERR("!TW_MR_DATA_NACK: %x\n", TWSR);
200                         return EOF;
201                 }
202         }
203
204         /* avoid sign extension */
205         return (int)(uint8_t)TWDR;
206 }
207
208 MOD_DEFINE(i2c);
209
210 /**
211  * Initialize TWI module.
212  */
213 void i2c_builtin_init(void)
214 {
215         ATOMIC(
216                 /*
217                  * This is pretty useless according to AVR's datasheet,
218                  * but it helps us driving the TWI data lines on boards
219                  * where the bus pull-up resistors are missing.  This is
220                  * probably due to some unwanted interaction between the
221                  * port pin and the TWI lines.
222                  */
223 #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 || CPU_AVR_ATMEGA1281
224                 PORTD |= BV(PD0) | BV(PD1);
225                 DDRD  |= BV(PD0) | BV(PD1);
226 #elif CPU_AVR_ATMEGA8
227                 PORTC |= BV(PC4) | BV(PC5);
228                 DDRC  |= BV(PC4) | BV(PC5);
229 #elif CPU_AVR_ATMEGA32
230                 PORTC |= BV(PC1) | BV(PC0);
231                 DDRC  |= BV(PC1) | BV(PC0);
232 #else
233                 #error Unsupported architecture
234 #endif
235
236                 /*
237                  * Set speed:
238                  * F = CPU_FREQ / (16 + 2*TWBR * 4^TWPS)
239                  */
240                 #ifndef CONFIG_I2C_FREQ
241                         #warning Using default value of 300000L for CONFIG_I2C_FREQ
242                         #define CONFIG_I2C_FREQ  300000L /* ~300 kHz */
243                 #endif
244                 #define TWI_PRESC 1       /* 4 ^ TWPS */
245
246                 TWBR = (CPU_FREQ / (2 * CONFIG_I2C_FREQ * TWI_PRESC)) - (8 / TWI_PRESC);
247                 TWSR = 0;
248                 TWCR = BV(TWEN);
249         );
250         MOD_INIT(i2c);
251 }