Add comments.
[bertos.git] / boards / arduino / hw / hw_i2c_bitbang.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 2003, 2004, 2006, 2008 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
31  * All Rights Reserved.
32  * -->
33  *
34  * \brief Macro for I2C bitbang operation.
35  *
36  *
37  *
38  * \author Francesco Sacchi <batt@develer.com>
39  */
40
41 #ifndef HW_I2C_BITBANG_H
42 #define HW_I2C_BITBANG_H
43
44 #warning TODO:This is an example implementation, you must implement it!
45
46 #define SDA_HI  do { /* Implement me:Set SDA High by setting SDA pin as input */ } while (0)
47 #define SDA_LO  do { /* Implement me:Set SDA Low by setting SDA pin as open collector output */ } while (0)
48 #define SCL_HI  do { /* Implement me:Set SCL High by setting SCL pin as input */ } while (0)
49 #define SCL_LO  do { /* Implement me:Set SCL Low by setting SCL pin as open collector output */ } while (0)
50
51
52 #define SCL_IN       (true) /* Implement me: read SDA pin state */
53 #define SDA_IN       (true) /* Implement me: read SCL pin state */
54
55 /**
56  * This macro should set SDA and SCL lines as input.
57  */
58 #define I2C_BITBANG_HW_INIT do { /* Implement me! */ } while (0)
59
60 /**
61  * Half bit delay routine used to generate the correct timings.
62  */
63 #define I2C_HALFBIT_DELAY() do { /* Implement me! */ } while (0)
64
65
66 /*
67  * New api
68  */
69 #include <cfg/compiler.h>
70
71 INLINE void i2c_sdaHi(int dev)
72 {
73         (void)(dev);
74         /* Implement me:Set SDA High by setting SDA pin as input */
75 }
76
77 INLINE void i2c_sdaLo(int dev)
78 {
79         (void)(dev);
80         /* Implement me:Set SDA Low by setting SDA pin as open collector output */
81 }
82
83 INLINE void i2c_sclHi(int dev)
84 {
85         (void)(dev);
86         /* Implement me:Set SCL High by setting SCL pin as input */
87 }
88
89 INLINE void i2c_sclLo(int dev)
90 {
91         (void)(dev);
92         /* Implement me:Set SCL Low by setting SCL pin as open collector output */
93 }
94
95 INLINE bool i2c_sdaIn(int dev)
96 {
97         (void)(dev);
98         /* Implement me: read SDA pin state */
99         return true;
100 }
101
102 INLINE bool i2c_sclIn(int dev)
103 {
104         (void)(dev);
105         /* Implement me: read SCL pin state */
106         return true;
107 }
108
109 /**
110  * Half bit delay routine used to generate the correct timings.
111  */
112 INLINE void i2c_halfbitDelay(int dev)
113 {
114         (void)(dev);
115         /* Implement me! */
116 }
117
118 /**
119  * This macro should set SDA and SCL lines as input.
120  */
121 INLINE void i2c_bitbangInit(int dev)
122 {
123         (void)(dev);
124         /* Implement me! */
125 }
126
127 #endif /* HW_I2C_BITBANG_H */