Merged from external project:
[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  * \version $Id: ft245rl.c 22301 2008-09-09 16:53:17Z batt $
44  * \author Francesco Sacchi <batt@develer.com>
45  */
46
47 #include "pcf8574.h"
48 #include <cfg/module.h>
49 #include <drv/i2c.h>
50
51 /**
52  * Read PCF8574 \a pcf bit status.
53  * \return the pins status or EOF on errors.
54  */
55 int pcf8574_get(Pcf8574 *pcf)
56 {
57         if (!i2c_start_r(PCF8574ID | ((pcf->addr << 1) & 0xF7)))
58                 return EOF;
59
60         int data = i2c_get(false);
61         i2c_stop();
62         return data;
63 }
64
65 /**
66  * Write to PCF8574 \a pcf port \a data.
67  * \return true if ok, false on errors.
68  */
69 bool pcf8574_put(Pcf8574 *pcf, uint8_t data)
70 {
71         return  i2c_start_w(PCF8574ID | ((pcf->addr << 1) & 0xF7)) && i2c_put(data) && i2c_stop();
72 }
73
74 /**
75  * Init a PCF8574 on the bus with addr \a addr.
76  * \return true if device is found, false otherwise.
77  */
78 bool pcf8574_init(Pcf8574 *pcf, pcf8574_addr addr)
79 {
80         MOD_CHECK(i2c);
81         pcf->addr = addr;
82         return pcf8574_get(pcf) != EOF;
83 }