wimbeaumont Project / DevInterfaces

This are general defs and base class interfaces. ( DACInterface, I2CInterface) to be used with I2C devices

Dependents:   MCP23009tst AT30TSE752TST MCP4728setaddrProg mbedSerialInterface_talkback2 ... more

The DevInterfaces class is used for a more general support of a number of I2C devices.

For the moment this is MCP4728 Quad DAC.

The idea is to write a libs for the I2C devices (and perhaps later SPI , ... devices) not restricted to a certain hardware platform.

So there is the I2CInterface. This is a ( not pure) virtual class. A pointer to this class is used for the I2C device lib (like the MCP4728 class https://developer.mbed.org/users/wbeaumont/code/MCP4728/ ) to communicate with the I2C interface. The I2C interface is kept simple as possible. So it has to be applied for "tested environments". I2C Bus timeouts etc. are hard to debug with such a simple interface. This kind of interface is also not suitable for optimal performance. The user has to take care of issues of blocking devices, parallel processes etc. This can be dealt with in the implementation of the I2CInterface class

The aim of this project is to generate code for these devices on different platforms without doing the painstaking work of looking up all the register details.

There is an implementation of the I2CInterface for the MBED , tested with the FRDM-KL05Z platform. https://developer.mbed.org/users/wbeaumont/code/I2Cinterfaces/

A very simple application on a MBED can be found in https://developer.mbed.org/users/wbeaumont/code/MCP4728test/

I2CInterface.h

Committer:
wbeaumont
Date:
2019-09-10
Revision:
7:b091a268b726
Parent:
5:b5c9eb2330dc

File content as of revision 7:b091a268b726:

#ifndef __I2CINTERFACE__
#define __I2CINTERFACE__

#include "getVersion.h"
#include "DevErrorReporter.h"
#define I2CINTERFACE_HDR_VER "2.10"


/*
 *  This is a the I2CInterface "virtual"  class used in all I2C devices 
 *  This file make part of the PeriperalDevice package see repository  
 *  https://github.com/wimbeaumont/PeripheralDevices
 *  For more info see   the README.md in the top of repository 
 *
 *  ver  0:40  added wait_for_ms 
 *  ver  1:00  changed the interface , all functions will have a retrun value was not correct 
 *  ver  1.10  added lock and unlock, abort_transfer added more coments
 *  ver  2.00  added error status info 
 *  ver  2.10  added read_reg as this is often used. 
 * (C) Wim Beaumont Universiteit Antwerpen 2016,2017,2018,2019
 *
 * License see
 * https://github.com/wimbeaumont/PeripheralDevices/blob/master/LICENSE
*/ 

class I2CInterface : public virtual getVersion, public DevErrorReporter{
private: 
protected :
     void*  callback();
     int    lockstatus; 

public : 

        I2CInterface():getVersion( I2CINTERFACE_HDR_VER ,I2CINTERFACE_HDR_VER , __TIME__, __DATE__){
      lockstatus=0;
    
    };   //Create an I2C Master interface
virtual int     frequency (int hz){ return 0;};//  Set the frequency of the I2C interface. returns 0 when ok,
virtual int     read (int address, char *data, int length, bool repeated=false){return 0;};//Read from an I2C slave.
                                               // if repeated is true no stop is generated

// gererate a write (see write function_  with repeat is flase , writing the value reg to the device 
//  the register size is in byte and has the be  equal or smaller then the size_off (int) 
// it  is assumed that the most significant byte off the regeister address is sent first 
virtual int   read_reg( int address, char *data, int length, int reg, int regsize=1) {
        return 0;}

virtual int     read (int &data, int ack){data=0; return 0;};
                    // Read a single byte from the I2C bus. ack indicates if the ack has to be generated



virtual int     write (int address, const char *data, int length, bool repeated=false){return 0;};// Write to an I2C slave.
                                               // if repeated is true no stop is generated
virtual int     write (int data){return 0;};//  Write single byte out on the I2C bus.
virtual int     start (void){return 0;};// Creates a start condition on the I2C bus.
virtual int     stop  (void){return 0;};// Creates a stop condition on the I2C bus.
virtual int     transfer (int address, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, void*  callbackptr, bool repeated=false){
            return 0;
        };     //   Start non-blocking I2C transfer.       not yet clear how to deal with the callback
             // proposol here is for the implementation a spefic call back function ,that includes the event type  
            // wait function that is sometimes needed , not I2C hardware related but different implementation for platforms
virtual void wait_for_ms(int x) { } ;
virtual int  abort_transfer(void) {return 0;} 
virtual int  lock(void) {if ( lockstatus) return -1;  lockstatus=1; return 0; } 
virtual int  unlock(void) { lockstatus=0; return 0; }  



}; 

#endif