Change the comment style for the modules and the list, and use the newParser to parse...
[bertos.git] / bertos / drv / pcf8574.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 2007 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief PCF8574 i2c port expander driver.
34  *
35  * \version $Id: ft245rl.c 22301 2008-09-09 16:53:17Z batt $
36  * \author Francesco Sacchi <batt@develer.com>
37  *
38  * $WIZ$ module_name = "pcf8574"
39  * $WIZ$ module_depends = "i2c"
40  */
41
42 #ifndef DRV_PCF8574_H
43 #define DRV_PCF8574_H
44
45 #include <cfg/compiler.h>
46
47 typedef uint8_t pcf8574_addr;
48
49 /**
50  * Context for accessing a PCF8574.
51  */
52 typedef struct Pcf8574
53 {
54         pcf8574_addr addr;
55 } Pcf8574;
56
57 #define PCF8574ID 0x40 ///< I2C address
58
59 int pcf8574_get(Pcf8574 *pcf);
60 bool pcf8574_put(Pcf8574 *pcf, uint8_t data);
61 bool pcf8574_init(Pcf8574 *pcf, pcf8574_addr addr);
62
63 #endif /* DRV_PCF8574_H */