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 #include <cfg/compiler.h>
49 #include <cfg/macros.h>
50 #include <cfg/debug.h>
54 #define I2C_READBIT BV(0)
57 #define i2c_init(...) PP_CAT(i2c_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
59 #define i2c_init(args...) PP_CAT(i2c_init ## _, COUNT_PARMS(args)) (args)
64 * Sometimes your cpu does not have a builtin
65 * i2c driver or you don't want, for some reason, to
67 * With this you can choose, at compile time, which backend to use.
69 * $WIZ$ i2c_backend = "I2C_BACKEND_BUILTIN", "I2C_BACKEND_BITBANG"
71 #define I2C_BACKEND_BUILTIN 0 ///< Uses cpu builtin i2c driver
72 #define I2C_BACKEND_BITBANG 1 ///< Uses emulated bitbang driver
77 * I2c builtin prototypes.
78 * Do NOT use these function directly, instead,
79 * you can call the ones named without "_builtin_"
80 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
81 * that you want the builtin backend.
84 void i2c_builtin_init(void);
85 bool i2c_builtin_start_w(uint8_t id);
86 bool i2c_builtin_start_r(uint8_t id);
87 void i2c_builtin_stop(void);
88 bool i2c_builtin_put(uint8_t _data);
89 int i2c_builtin_get(bool ack);
93 * I2c bitbang prototypes.
94 * Same thing here: do NOT use these function directly, instead,
95 * you can call the ones named without "_bitbang_"
96 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
97 * that you want the bitbang backend.
100 void i2c_bitbang_init(void);
101 bool i2c_bitbang_start_w(uint8_t id);
102 bool i2c_bitbang_start_r(uint8_t id);
103 void i2c_bitbang_stop(void);
104 bool i2c_bitbang_put(uint8_t _data);
105 int i2c_bitbang_get(bool ack);
108 #if CONFIG_I2C_BACKEND == I2C_BACKEND_BUILTIN
109 #define i2c_init_0 i2c_builtin_init
110 #define i2c_start_w i2c_builtin_start_w
111 #define i2c_start_r i2c_builtin_start_r
112 #define i2c_stop i2c_builtin_stop
113 #define i2c_put i2c_builtin_put
114 #define i2c_get i2c_builtin_get
115 #elif CONFIG_I2C_BACKEND == I2C_BACKEND_BITBANG
116 #define i2c_init_0 i2c_bitbang_init
117 #define i2c_start_w i2c_bitbang_start_w
118 #define i2c_start_r i2c_bitbang_start_r
119 #define i2c_stop i2c_bitbang_stop
120 #define i2c_put i2c_bitbang_put
121 #define i2c_get i2c_bitbang_get
123 #error Unsupported i2c backend.
127 bool i2c_send(const void *_buf, size_t count);
128 bool i2c_recv(void *_buf, size_t count);
139 #define I2C_OK 0 ///< I2C no errors flag
140 #define I2C_ERR BV(3) ///< I2C generic error
141 #define I2C_ARB_LOST BV(2) ///< I2C arbitration lost error
142 #define I2C_START_TIMEOUT BV(0) ///< I2C timeout error on start
143 #define I2C_NO_ACK BV(1) ///< I2C no ack for sla start
148 #define I2C_NOSTOP 0 ///< Do not program the stop for current transition
149 #define I2C_STOP BV(0) ///< Program the stop for current transition
150 #define I2C_START_R BV(1) ///< Start read command
151 #define I2C_START_W 0 ///< Start write command
154 #define I2C_TEST_START(flag) ((flag) & I2C_START_R)
155 #define I2C_TEST_STOP(flag) ((flag) & I2C_STOP)
160 typedef void (*i2c_start_t)(struct I2c *i2c, uint16_t slave_addr);
161 typedef uint8_t (*i2c_get_t)(struct I2c *i2c);
162 typedef void (*i2c_put_t)(struct I2c *i2c, uint8_t data);
163 typedef void (*i2c_send_t)(struct I2c *i2c, const void *_buf, size_t count);
164 typedef void (*i2c_recv_t)(struct I2c *i2c, void *_buf, size_t count);
180 struct I2cHardware* hw;
181 const struct I2cVT *vt;
185 #include CPU_HEADER(i2c)
187 void i2c_swSend(struct I2c *i2c, const void *_buf, size_t count);
188 void i2c_swRecv(struct I2c *i2c, void *_buf, size_t count);
190 INLINE void i2c_start(I2c *i2c, uint16_t slave_addr, size_t size)
193 ASSERT(i2c->vt->start);
196 ASSERT(i2c->xfer_size == 0);
199 i2c->xfer_size = size;
201 i2c->vt->start(i2c, slave_addr);
204 INLINE void i2c_start_r(I2c *i2c, uint16_t slave_addr, size_t size, int flags)
207 i2c->flags = flags | I2C_START_R;
208 i2c_start(i2c, slave_addr, size);
211 INLINE void i2c_start_w(I2c *i2c, uint16_t slave_addr, size_t size, int flags)
214 i2c->flags = flags & ~I2C_START_R;
215 i2c_start(i2c, slave_addr, size);
218 INLINE uint8_t i2c_get(I2c *i2c)
222 ASSERT(i2c->vt->get);
224 ASSERT(i2c->xfer_size);
226 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_R);
230 uint8_t data = i2c->vt->get(i2c);
238 INLINE void i2c_put(I2c *i2c, uint8_t data)
242 ASSERT(i2c->vt->put);
244 ASSERT(i2c->xfer_size);
246 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_W);
250 i2c->vt->put(i2c, data);
255 INLINE void i2c_send(I2c *i2c, const void *_buf, size_t count)
259 ASSERT(i2c->vt->send);
263 ASSERT(count <= i2c->xfer_size);
265 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_W);
268 i2c->vt->send(i2c, _buf, count);
272 INLINE void i2c_recv(I2c *i2c, void *_buf, size_t count)
276 ASSERT(i2c->vt->recv);
280 ASSERT(count <= i2c->xfer_size);
282 ASSERT(I2C_TEST_START(i2c->flags) == I2C_START_R);
285 i2c->vt->recv(i2c, _buf, count);
288 INLINE int i2c_error(I2c *i2c)
291 int err = i2c->errors;
297 INLINE void i2c_init_3(I2c *i2c, int dev, uint32_t clock)
299 i2c_hw_init(i2c, dev, clock);