bertos/drv/i2c.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 2005 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief I2C generic driver functions.
  34  *
  35  * \version $Id$
  36  * \author Francesco Sacchi <batt@develer.com>
  37  *
  38  * $WIZ$ module_name = "i2c"
  39  * $WIZ$ module_configuration = "bertos/cfg/cfg_i2c.h"
  40  * $WIZ$ module_hw = "bertos/hw/hw_i2c_bitbang.h"
  41  * $WIZ$ module_supports = "not atmega103 and not atmega168"
  42  */
  43
  44 #ifndef DRV_I2C_H
  45 #define DRV_I2C_H
  46
  47 #include "cfg/cfg_i2c.h"
  48 #include <cfg/compiler.h>
  49
  50 #define I2C_READBIT BV(0)
  51
  52 /**
  53  * I2C Backends.
  54  * Sometimes your cpu does not have a builtin
  55  * i2c driver or you don't want, for some reason, to
  56  * use that.
  57  * With this you can choose, at compile time, which backend to use.
  58  *
  59  * $WIZ$ i2c_backend = "I2C_BACKEND_BUILTIN", "I2C_BACKEND_BITBANG"
  60  */
  61 #define I2C_BACKEND_BUILTIN 0 ///< Uses cpu builtin i2c driver
  62 #define I2C_BACKEND_BITBANG 1 ///< Uses emulated bitbang driver
  63
  64
  65 /**
  66  * I2c builtin prototypes.
  67  * Do NOT use these function directly, instead,
  68  * you can call the ones named without "_builtin_"
  69  * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
  70  * that you want the builtin backend.
  71  * \{
  72  */
  73 void i2c_builtin_init(void);
  74 bool i2c_builtin_start_w(uint8_t id);
  75 bool i2c_builtin_start_r(uint8_t id);
  76 void i2c_builtin_stop(void);
  77 bool i2c_builtin_put(uint8_t _data);
  78 int i2c_builtin_get(bool ack);
  79 /*\}*/
  80
  81 /**
  82  * I2c bitbang prototypes.
  83  * Same thing here: do NOT use these function directly, instead,
  84  * you can call the ones named without "_bitbang_"
  85  * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND)
  86  * that you want the bitbang backend.
  87  * \{
  88  */
  89 void i2c_bitbang_init(void);
  90 bool i2c_bitbang_start_w(uint8_t id);
  91 bool i2c_bitbang_start_r(uint8_t id);
  92 void i2c_bitbang_stop(void);
  93 bool i2c_bitbang_put(uint8_t _data);
  94 int i2c_bitbang_get(bool ack);
  95 /*\}*/
  96
  97 #if CONFIG_I2C_BACKEND == I2C_BACKEND_BUILTIN
  98         #define i2c_init    i2c_builtin_init
  99         #define i2c_start_w i2c_builtin_start_w
 100         #define i2c_start_r i2c_builtin_start_r
 101         #define i2c_stop    i2c_builtin_stop
 102         #define i2c_put     i2c_builtin_put
 103         #define i2c_get     i2c_builtin_get
 104 #elif CONFIG_I2C_BACKEND == I2C_BACKEND_BITBANG
 105         #define i2c_init    i2c_bitbang_init
 106         #define i2c_start_w i2c_bitbang_start_w
 107         #define i2c_start_r i2c_bitbang_start_r
 108         #define i2c_stop    i2c_bitbang_stop
 109         #define i2c_put     i2c_bitbang_put
 110         #define i2c_get     i2c_bitbang_get
 111 #else
 112         #error Unsupported i2c backend.
 113 #endif
 114
 115 bool i2c_send(const void *_buf, size_t count);
 116 bool i2c_recv(void *_buf, size_t count);
 117
 118 #endif