git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/i2c.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2001,2004 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_I2C_H
  24 #define INCLUDED_I2C_H
  25
  26 #include <boost/shared_ptr.hpp>
  27
  28 class i2c;
  29 typedef boost::shared_ptr<i2c> i2c_sptr;
  30
  31 /*!
  32  * \brief abstract class for controlling i2c bus
  33  */
  34 class i2c {
  35  public:
  36
  37   i2c () {}
  38   virtual ~i2c ();
  39
  40   //! \returns true iff successful
  41   virtual bool write (int addr, const unsigned char *buf, int nbytes) = 0;
  42
  43   //! \returns number of bytes read or -1 if error
  44   virtual int read (int addr, unsigned char *buf, int max_bytes) = 0;
  45 };
  46
  47 #endif /* INCLUDED_I2C_H */
  48