I2cMaster.h

Go to the documentation of this file.

/*
    I2cMaster.h - An I2C master library
    For AVR ATMega328p (Arduino Uno) and ATMega2560 (Arduino Mega).
    This is part of the AVRTools library.
    Copyright (c) 2014 Igor Mikolic-Torreira.  All right reserved.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/


#ifndef I2cMaster_h
#define I2cMaster_h


#ifdef I2cSlave_h
#error "You cannot use both I2cMaster and I2cSlave in the same application"
#endif


#include <stdint.h>
#include <stdlib.h>

#include <util/atomic.h>


#if defined( DEBUG_I2cMasterBuffer ) || defined( DEBUG_I2cMasterDiary )
#include "USART0.h"
#endif





#ifndef I2C_MASTER_MAX_TX_MSG_LEN
#define I2C_MASTER_MAX_TX_MSG_LEN       24
#endif

#ifndef I2C_MASTER_MAX_TX_MSG_NBR
#define I2C_MASTER_MAX_TX_MSG_NBR       3
#endif

#if I2C_MASTER_MAX_TX_MSG_LEN > 255
#error "I2C_MASTER_MAX_TX_MSG_LEN exceeds size of a uint8_t"
#endif

#if I2C_MASTER_MAX_TX_MSG_NBR > 255
#error "I2C_MASTER_MAX_TX_MSG_NBR exceeds size of a uint8_t"
#endif





namespace I2cMaster
{

    enum I2cBusSpeed
    {
        kI2cBusSlow                 = 0,                    
        kI2cBusFast                 = 1                     
    };


    enum I2cStatusCodes
    {
        kI2cCompletedOk                    = 0x00,          
        kI2cError                          = 0x01,          
        kI2cNotStarted                     = 0x02,          
        kI2cInProgress                     = 0x04           
    };


    enum I2cSendErrorCodes
    {
        kI2cNoError                 = 0,                    
        kI2cErrTxBufferFull         = 1,                    
        kI2cErrMsgTooLong           = 2,                    
        kI2cErrNullStatusPtr        = 3,                    
        kI2cErrWriteWithoutData     = 4,                    
        kI2cErrReadWithoutStorage   = 5                     
    };


    enum I2cPullups
    {
        kPullupsOff                 = 0,                    
        kPullupsOn                  = 1                     
    };





    void start( uint8_t speed = kI2cBusFast );


    void stop();


    void pullups( uint8_t set = kPullupsOn );


    bool busy();




    // Asynchronous functions


    uint8_t writeAsync( uint8_t address, uint8_t registerAddress, volatile uint8_t* status );


    uint8_t writeAsync( uint8_t address, uint8_t registerAddress, uint8_t data, volatile uint8_t* status );


    uint8_t writeAsync( uint8_t address, uint8_t registerAddress, const char* data, volatile uint8_t* status );


    uint8_t writeAsync( uint8_t address, uint8_t registerAddress, uint8_t* data, uint8_t numberBytes,
                            volatile uint8_t* status );



    uint8_t readAsync( uint8_t address, uint8_t numberBytes, volatile uint8_t* destination,
                        volatile uint8_t* bytesRead, volatile uint8_t* status );


    uint8_t readAsync( uint8_t address, uint8_t registerAddress, uint8_t numberBytes,
                        volatile uint8_t* destination, volatile uint8_t* bytesRead,
                        volatile uint8_t* status );



    // Synchronous


    int writeSync( uint8_t address, uint8_t registerAddress );


    int writeSync( uint8_t address, uint8_t registerAddress, uint8_t data );


    int writeSync( uint8_t address, uint8_t registerAddress, const char* data );


    int writeSync( uint8_t address, uint8_t registerAddress, uint8_t* data, uint8_t numberBytes );



    int readSync( uint8_t address, uint8_t numberBytes, uint8_t* destination );


    int readSync( uint8_t address, uint8_t registerAddress, uint8_t numberBytes, uint8_t* destination );


#if defined( DEBUG_I2cMasterBuffer ) || defined( DEBUG_I2cMasterDiary )
    void setDebugSout( Serial0* s );
#endif

#ifdef DEBUG_I2cMasterBuffer
    void dumpBufferContents();
#endif

#ifdef DEBUG_I2cMasterDiary
    void clearDebugI2cDiary();
    void dumpDebugI2cDiary();
#endif


};


#endif