Reformat comment.
[bertos.git] / bertos / drv / i2c.h
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 2005 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief I2C generic driver functions (interface).
34  *
35  * \version $Id$
36  * \author Francesco Sacchi <batt@develer.com>
37  */
38 #ifndef DRV_I2C_H
39 #define DRV_I2C_H
40
41 #include "cfg/cfg_i2c.h"
42 #include <cfg/compiler.h>
43
44 #define I2C_READBIT BV(0)
45
46 /**
47  * I2C Backends.
48  * Sometimes your cpu does not have a builtin
49  * i2c driver or you don't want, for some reason, to
50  * use that.
51  * With this you can choose, at compile time, which backend to use.
52  * \{
53  */
54 #define I2C_BACKEND_BUILTIN 0 ///< Uses cpu builtin i2c driver
55 #define I2C_BACKEND_BITBANG 1 ///< Uses emulated bitbang driver
56 /*\}*/
57
58
59 /**
60  * I2c builtin prototypes.
61  * Do NOT use these function directly, instead,
62  * you can call the ones named without "_builtin_"
63  * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
64  * that you want the builtin backend.
65  * \{
66  */
67 void i2c_builtin_init(void);
68 bool i2c_builtin_start_w(uint8_t id);
69 bool i2c_builtin_start_r(uint8_t id);
70 void i2c_builtin_stop(void);
71 bool i2c_builtin_put(uint8_t _data);
72 int i2c_builtin_get(bool ack);
73 /*\}*/
74
75 /**
76  * I2c bitbang prototypes.
77  * Same thing here: do NOT use these function directly, instead,
78  * you can call the ones named without "_bitbang_"
79  * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
80  * that you want the bitbang backend.
81  * \{
82  */
83 void i2c_bitbang_init(void);
84 bool i2c_bitbang_start_w(uint8_t id);
85 bool i2c_bitbang_start_r(uint8_t id);
86 void i2c_bitbang_stop(void);
87 bool i2c_bitbang_put(uint8_t _data);
88 int i2c_bitbang_get(bool ack);
89 /*\}*/
90
91 #if CONFIG_I2C_BACKEND == I2C_BACKEND_BUILTIN
92         #define i2c_init    i2c_builtin_init
93         #define i2c_start_w i2c_builtin_start_w
94         #define i2c_start_r i2c_builtin_start_r
95         #define i2c_stop    i2c_builtin_stop
96         #define i2c_put     i2c_builtin_put
97         #define i2c_get     i2c_builtin_get
98 #elif CONFIG_I2C_BACKEND == I2C_BACKEND_BITBANG
99         #define i2c_init    i2c_bitbang_init
100         #define i2c_start_w i2c_bitbang_start_w
101         #define i2c_start_r i2c_bitbang_start_r
102         #define i2c_stop    i2c_bitbang_stop
103         #define i2c_put     i2c_bitbang_put
104         #define i2c_get     i2c_bitbang_get
105 #else
106         #error Unsupported i2c backend.
107 #endif
108
109 bool i2c_send(const void *_buf, size_t count);
110 bool i2c_recv(void *_buf, size_t count);
111
112 #endif