Silent warning.
[bertos.git] / bertos / drv / pcf8574.c
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 2007 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief PCF8574 i2c port expander driver.
34  *
35  * This driver controls the PCF8574.
36  * The PCF8574 is an 8bit i2c port expander.
37  * You can read/write 8 pins through an i2c bus.
38  * The pins are quasi-bidirectionals, this mean that
39  * without the need of a direction register you can use
40  * each pin as input or output, see datasheet on how this
41  * is achieved.
42  *
43  * \author Francesco Sacchi <batt@develer.com>
44  */
45
46 #include "pcf8574.h"
47
48 #include <cfg/module.h>
49
50 #include <drv/i2c.h>
51
52
53 INLINE int pcf8574_get_priv(Pcf8574 *pcf)
54 {
55         if (!i2c_start_r(PCF8574ID | ((pcf->addr << 1) & 0xF7)))
56                 return EOF;
57
58         int data;
59
60         if (!i2c_recv(&data, 1))
61                 data = EOF;
62
63         i2c_stop();
64
65         return data;
66 }
67
68
69 /**
70  * Read PCF8574 \a pcf bit status.
71  * \return the pins status or EOF on errors.
72  */
73 int pcf8574_get_1(Pcf8574 *pcf)
74 {
75         return pcf8574_get_priv(pcf);
76 }
77
78 /**
79  * Write to PCF8574 \a pcf port \a data.
80  * \return true if ok, false on errors.
81  */
82 bool pcf8574_put_2(Pcf8574 *pcf, uint8_t data)
83 {
84         bool res = i2c_start_w(PCF8574ID | ((pcf->addr << 1) & 0xF7)) && i2c_put(data);
85         i2c_stop();
86         return res;
87 }
88
89 /**
90  * Init a PCF8574 on the bus with addr \a addr.
91  * \return true if device is found, false otherwise.
92  */
93 bool pcf8574_init_2(Pcf8574 *pcf, pcf8574_addr addr)
94 {
95         MOD_CHECK(i2c);
96         pcf->addr = addr;
97         return pcf8574_get_priv(pcf) != EOF;
98 }
99
100
101
102 /*
103  * New API
104  */
105
106 /**
107  * Read PCF8574 \a pcf bit status.
108  * \return the pins status or EOF on errors.
109  */
110 int pcf8574_get_2(I2c *i2c, Pcf8574 *pcf)
111 {
112         i2c_start_r(i2c, PCF8574ID | ((pcf->addr << 1) & 0xF7), 1, I2C_STOP);
113
114         int data = i2c_getc(i2c);
115
116         if (i2c_error(i2c))
117                 data = EOF;
118
119         return data;
120 }
121
122 /**
123  * Write to PCF8574 \a pcf port \a data.
124  * \return true if ok, false on errors.
125  */
126 bool pcf8574_put_3(I2c *i2c, Pcf8574 *pcf, uint8_t data)
127 {
128         i2c_start_w(i2c, PCF8574ID | ((pcf->addr << 1) & 0xF7), 1, I2C_STOP);
129         i2c_putc(i2c, data);
130
131         if (i2c_error(i2c))
132                 return false;
133
134         return true;
135 }
136
137 /**
138  * Init a PCF8574 on the bus with addr \a addr.
139  * \return true if device is found, false otherwise.
140  */
141 bool pcf8574_init_3(I2c *i2c, Pcf8574 *pcf, pcf8574_addr addr)
142 {
143         ASSERT(i2c);
144         pcf->addr = addr;
145
146         return (pcf8574_get(i2c, pcf) != EOF);
147 }
148