4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
33 * \brief I2C generic driver functions.
35 * \author Francesco Sacchi <batt@develer.com>
37 * $WIZ$ module_name = "i2c"
38 * $WIZ$ module_configuration = "bertos/cfg/cfg_i2c.h"
39 * $WIZ$ module_hw = "bertos/hw/hw_i2c_bitbang.h"
40 * $WIZ$ module_supports = "not atmega103 and not atmega168 and not at91"
46 #include "cfg/cfg_i2c.h"
48 #define LOG_LEVEL I2C_LOG_LEVEL
49 #define LOG_FORMAT I2C_LOG_FORMAT
53 #include <cfg/compiler.h>
54 #include <cfg/macros.h>
55 #include <cfg/debug.h>
59 #define I2C_READBIT BV(0)
62 #define i2c_init(...) PP_CAT(i2c_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
64 #define i2c_init(args...) PP_CAT(i2c_init ## _, COUNT_PARMS(args)) (args)
69 * Sometimes your cpu does not have a builtin
70 * i2c driver or you don't want, for some reason, to
72 * With this you can choose, at compile time, which backend to use.
74 * $WIZ$ i2c_backend = "I2C_BACKEND_BUILTIN", "I2C_BACKEND_BITBANG"
76 #define I2C_BACKEND_BUILTIN 0 ///< Uses cpu builtin i2c driver
77 #define I2C_BACKEND_BITBANG 1 ///< Uses emulated bitbang driver
82 * I2c builtin prototypes.
83 * Do NOT use these function directly, instead,
84 * you can call the ones named without "_builtin_"
85 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
86 * that you want the builtin backend.
89 void i2c_builtin_init(void);
90 bool i2c_builtin_start_w(uint8_t id);
91 bool i2c_builtin_start_r(uint8_t id);
92 void i2c_builtin_stop(void);
93 bool i2c_builtin_put(uint8_t _data);
94 int i2c_builtin_get(bool ack);
98 * I2c bitbang prototypes.
99 * Same thing here: do NOT use these function directly, instead,
100 * you can call the ones named without "_bitbang_"
101 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
102 * that you want the bitbang backend.
105 void i2c_bitbang_init(void);
106 bool i2c_bitbang_start_w(uint8_t id);
107 bool i2c_bitbang_start_r(uint8_t id);
108 void i2c_bitbang_stop(void);
109 bool i2c_bitbang_put(uint8_t _data);
110 int i2c_bitbang_get(bool ack);
113 #if CONFIG_I2C_BACKEND == I2C_BACKEND_BUILTIN
114 #define i2c_init_0 i2c_builtin_init
115 #define i2c_start_w i2c_builtin_start_w
116 #define i2c_start_r i2c_builtin_start_r
117 #define i2c_stop i2c_builtin_stop
118 #define i2c_put i2c_builtin_put
119 #define i2c_get i2c_builtin_get
120 #elif CONFIG_I2C_BACKEND == I2C_BACKEND_BITBANG
121 #define i2c_init_0 i2c_bitbang_init
122 #define i2c_start_w i2c_bitbang_start_w
123 #define i2c_start_r i2c_bitbang_start_r
124 #define i2c_stop i2c_bitbang_stop
125 #define i2c_put i2c_bitbang_put
126 #define i2c_get i2c_bitbang_get
128 #error Unsupported i2c backend.
132 bool i2c_send(const void *_buf, size_t count);
133 bool i2c_recv(void *_buf, size_t count);
144 #define I2C_OK 0 ///< I2C no errors flag
145 #define I2C_ERR BV(3) ///< I2C generic error
146 #define I2C_ARB_LOST BV(2) ///< I2C arbitration lost error
147 #define I2C_START_TIMEOUT BV(0) ///< I2C timeout error on start
148 #define I2C_NO_ACK BV(1) ///< I2C no ack for sla start
153 #define I2C_NOSTOP 0 ///< Do not program the stop for current transition
154 #define I2C_STOP BV(0) ///< Program the stop for current transition
155 #define I2C_START_R BV(1) ///< Start read command
156 #define I2C_START_W 0 ///< Start write command
159 #define I2C_TEST_START(flag) ((flag) & I2C_START_R)
160 #define I2C_TEST_STOP(flag) ((flag) & I2C_STOP)
165 typedef void (*i2c_start_t)(struct I2c *i2c, uint16_t slave_addr);
166 typedef uint8_t (*i2c_get_t)(struct I2c *i2c);
167 typedef void (*i2c_put_t)(struct I2c *i2c, uint8_t data);
168 typedef void (*i2c_send_t)(struct I2c *i2c, const void *_buf, size_t count);
169 typedef void (*i2c_recv_t)(struct I2c *i2c, void *_buf, size_t count);
185 struct I2cHardware* hw;
186 const struct I2cVT *vt;
190 #include CPU_HEADER(i2c)
192 void i2c_swSend(struct I2c *i2c, const void *_buf, size_t count);
193 void i2c_swRecv(struct I2c *i2c, void *_buf, size_t count);
195 INLINE void i2c_start(I2c *i2c, uint16_t slave_addr, size_t size)
198 ASSERT(i2c->vt->start);
201 ASSERT(i2c->xfer_size == 0);
204 i2c->xfer_size = size;
206 i2c->vt->start(i2c, slave_addr);
209 INLINE void i2c_start_r(I2c *i2c, uint16_t slave_addr, size_t size, int flags)
212 i2c->flags = flags | I2C_START_R;
213 i2c_start(i2c, slave_addr, size);
216 INLINE void i2c_start_w(I2c *i2c, uint16_t slave_addr, size_t size, int flags)
219 i2c->flags = flags & ~I2C_START_R;
220 i2c_start(i2c, slave_addr, size);
223 INLINE uint8_t i2c_get(I2c *i2c)
227 ASSERT(i2c->vt->get);
229 ASSERT(i2c->xfer_size);
231 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_R);
235 uint8_t data = i2c->vt->get(i2c);
243 INLINE void i2c_put(I2c *i2c, uint8_t data)
247 ASSERT(i2c->vt->put);
249 ASSERT(i2c->xfer_size);
251 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_W);
255 i2c->vt->put(i2c, data);
260 INLINE void i2c_send(I2c *i2c, const void *_buf, size_t count)
264 ASSERT(i2c->vt->send);
268 ASSERT(count <= i2c->xfer_size);
270 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_W);
273 i2c->vt->send(i2c, _buf, count);
277 INLINE void i2c_recv(I2c *i2c, void *_buf, size_t count)
281 ASSERT(i2c->vt->recv);
285 ASSERT(count <= i2c->xfer_size);
287 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_R);
290 i2c->vt->recv(i2c, _buf, count);
293 INLINE int i2c_error(I2c *i2c)
296 int err = i2c->errors;
301 LOG_ERR("err[%02x]\n", err);
307 INLINE void i2c_init_3(I2c *i2c, int dev, uint32_t clock)
309 i2c_hw_init(i2c, dev, clock);