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  * \author Francesco Sacchi <batt@develer.com>
  36  *
  37  * $WIZ$ module_name = "pcf8574"
  38  * $WIZ$ module_depends = "i2c"
  39  */
  40
  41 #ifndef DRV_PCF8574_H
  42 #define DRV_PCF8574_H
  43
  44 #include "cfg/cfg_i2c.h"
  45
  46 #include <cfg/compiler.h>
  47
  48 #include <drv/i2c.h>
  49
  50 #if COMPILER_C99
  51         #define pcf8574_init(...)       PP_CAT(pcf8574_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
  52         #define pcf8574_get(...)        PP_CAT(pcf8574_get ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
  53         #define pcf8574_put(...)        PP_CAT(pcf8574_put ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
  54 #else
  55         #define pcf8574_init(args...)   PP_CAT(pcf8574_init ## _, COUNT_PARMS(args)) (args)
  56         #define pcf8574_get(args...)    PP_CAT(pcf8574_get ## _, COUNT_PARMS(args)) (args)
  57         #define pcf8574_put(args...)    PP_CAT(pcf8574_put ## _, COUNT_PARMS(args)) (args)
  58 #endif
  59
  60 typedef uint8_t pcf8574_addr;
  61
  62 /**
  63  * Context for accessing a PCF8574.
  64  */
  65 typedef struct Pcf8574
  66 {
  67         pcf8574_addr addr;
  68 } Pcf8574;
  69
  70 #define PCF8574ID 0x40 ///< I2C address
  71
  72 /**
  73  * Read PCF8574 \a pcf bit status.
  74  * \return the pins status or EOF on errors.
  75  */
  76 int pcf8574_get_2(I2c *i2c, Pcf8574 *pcf);
  77
  78 /**
  79  * Write to PCF8574 \a pcf port \a data.
  80  * \return true if ok, false on errors.
  81  */
  82 bool pcf8574_put_3(I2c *i2c, Pcf8574 *pcf, uint8_t data);
  83
  84 /**
  85  * Init a PCF8574 on the bus with addr \a addr.
  86  * \return true if device is found, false otherwise.
  87  */
  88 bool pcf8574_init_3(I2c *i2c, Pcf8574 *pcf, pcf8574_addr addr);
  89
  90 #if !CONFIG_I2C_DISABLE_OLD_API
  91
  92 DEPRECATED INLINE int pcf8574_get_1(Pcf8574 *pcf)
  93 {
  94         return pcf8574_get_2(&local_i2c_old_api, pcf);
  95 }
  96
  97 DEPRECATED INLINE bool pcf8574_put_2(Pcf8574 *pcf, uint8_t data)
  98 {
  99         return pcf8574_put_3(&local_i2c_old_api, pcf, data);
 100 }
 101
 102 DEPRECATED INLINE bool pcf8574_init_2(Pcf8574 *pcf, pcf8574_addr addr)
 103 {
 104         return pcf8574_init_3(&local_i2c_old_api, pcf, addr);
 105 }
 106 #endif /* !CONFIG_I2C_DISABLE_OLD_API */
 107
 108 #endif /* DRV_PCF8574_H */