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.
36 * \author Francesco Sacchi <batt@develer.com>
38 * $WIZ$ module_name = "i2c"
39 * "configuration" : "bertos/cfg/cfg_i2c.h"
45 #include "cfg/cfg_i2c.h"
46 #include <cfg/compiler.h>
48 #define I2C_READBIT BV(0)
52 * Sometimes your cpu does not have a builtin
53 * i2c driver or you don't want, for some reason, to
55 * With this you can choose, at compile time, which backend to use.
57 * $WIZ$ i2c_backend = "I2C_BACKEND_BUILTIN", "I2C_BACKEND_BITBANG"
59 #define I2C_BACKEND_BUILTIN 0 ///< Uses cpu builtin i2c driver
60 #define I2C_BACKEND_BITBANG 1 ///< Uses emulated bitbang driver
64 * I2c builtin prototypes.
65 * Do NOT use these function directly, instead,
66 * you can call the ones named without "_builtin_"
67 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
68 * that you want the builtin backend.
71 void i2c_builtin_init(void);
72 bool i2c_builtin_start_w(uint8_t id);
73 bool i2c_builtin_start_r(uint8_t id);
74 void i2c_builtin_stop(void);
75 bool i2c_builtin_put(uint8_t _data);
76 int i2c_builtin_get(bool ack);
80 * I2c bitbang prototypes.
81 * Same thing here: do NOT use these function directly, instead,
82 * you can call the ones named without "_bitbang_"
83 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
84 * that you want the bitbang backend.
87 void i2c_bitbang_init(void);
88 bool i2c_bitbang_start_w(uint8_t id);
89 bool i2c_bitbang_start_r(uint8_t id);
90 void i2c_bitbang_stop(void);
91 bool i2c_bitbang_put(uint8_t _data);
92 int i2c_bitbang_get(bool ack);
95 #if CONFIG_I2C_BACKEND == I2C_BACKEND_BUILTIN
96 #define i2c_init i2c_builtin_init
97 #define i2c_start_w i2c_builtin_start_w
98 #define i2c_start_r i2c_builtin_start_r
99 #define i2c_stop i2c_builtin_stop
100 #define i2c_put i2c_builtin_put
101 #define i2c_get i2c_builtin_get
102 #elif CONFIG_I2C_BACKEND == I2C_BACKEND_BITBANG
103 #define i2c_init i2c_bitbang_init
104 #define i2c_start_w i2c_bitbang_start_w
105 #define i2c_start_r i2c_bitbang_start_r
106 #define i2c_stop i2c_bitbang_stop
107 #define i2c_put i2c_bitbang_put
108 #define i2c_get i2c_bitbang_get
110 #error Unsupported i2c backend.
113 bool i2c_send(const void *_buf, size_t count);
114 bool i2c_recv(void *_buf, size_t count);