Typo.
[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/cfg_i2c.h"
49
50 #include <cfg/module.h>
51
52 #include <drv/i2c.h>
53
54 #if !CONFIG_I2C_DISABLE_OLD_API
55
56 INLINE int pcf8574_get_priv(Pcf8574 *pcf)
57 {
58         if (!i2c_start_r(PCF8574ID | ((pcf->addr << 1) & 0xF7)))
59                 return EOF;
60
61         int data;
62
63         if (!i2c_recv(&data, 1))
64                 data = EOF;
65
66         i2c_stop();
67
68         return data;
69 }
70
71 /**
72  * Read PCF8574 \a pcf bit status.
73  * \return the pins status or EOF on errors.
74  */
75 int pcf8574_get_1(Pcf8574 *pcf)
76 {
77         return pcf8574_get_priv(pcf);
78 }
79
80 /**
81  * Write to PCF8574 \a pcf port \a data.
82  * \return true if ok, false on errors.
83  */
84 bool pcf8574_put_2(Pcf8574 *pcf, uint8_t data)
85 {
86         bool res = i2c_start_w(PCF8574ID | ((pcf->addr << 1) & 0xF7)) && i2c_put(data);
87         i2c_stop();
88         return res;
89 }
90
91 /**
92  * Init a PCF8574 on the bus with addr \a addr.
93  * \return true if device is found, false otherwise.
94  */
95 bool pcf8574_init_2(Pcf8574 *pcf, pcf8574_addr addr)
96 {
97         MOD_CHECK(i2c);
98         pcf->addr = addr;
99         return pcf8574_get_priv(pcf) != EOF;
100 }
101 #endif /* !CONFIG_I2C_DISABLE_OLD_API */
102
103
104 /*
105  * New API
106  */
107
108 /**
109  * Read PCF8574 \a pcf bit status.
110  * \return the pins status or EOF on errors.
111  */
112 int pcf8574_get_2(I2c *i2c, Pcf8574 *pcf)
113 {
114         i2c_start_r(i2c, PCF8574ID | ((pcf->addr << 1) & 0xF7), 1, I2C_STOP);
115
116         int data = i2c_getc(i2c);
117
118         if (i2c_error(i2c))
119                 data = EOF;
120
121         return data;
122 }
123
124 /**
125  * Write to PCF8574 \a pcf port \a data.
126  * \return true if ok, false on errors.
127  */
128 bool pcf8574_put_3(I2c *i2c, Pcf8574 *pcf, uint8_t data)
129 {
130         i2c_start_w(i2c, PCF8574ID | ((pcf->addr << 1) & 0xF7), 1, I2C_STOP);
131         i2c_putc(i2c, data);
132
133         if (i2c_error(i2c))
134                 return false;
135
136         return true;
137 }
138
139 /**
140  * Init a PCF8574 on the bus with addr \a addr.
141  * \return true if device is found, false otherwise.
142  */
143 bool pcf8574_init_3(I2c *i2c, Pcf8574 *pcf, pcf8574_addr addr)
144 {
145         ASSERT(i2c);
146         pcf->addr = addr;
147
148         return (pcf8574_get(i2c, pcf) != EOF);
149 }
150