SFBHWI2C.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBHWI2C.h Low-level interface for accessing I2C communications on the LPC23xx.
  Copyright (C) 2010 Sam Bayless.  All rights reserved.
  
  Modifications for inclusion in SFB core
  Copyright (C) 2010 The Regents of the University of New Mexico.  All rights reserved.

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

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/
#ifndef SFBHWI2C_H
#define SFBHWI2C_H

#include "SFBTypes.h"

enum I2CStatusCodes {
  I2C_MODE_UNINITIALIZED = -4,   
  I2C_MODE_ARBITRATION_ERROR = -3, 
  I2C_MODE_NO_ACK = -2,          
  I2C_MODE_ERROR = -1,           
  I2C_MODE_DONE = 0,             
  I2C_MODE_RECEIVE = 1,          
  I2C_MODE_TRANSMIT = 2,         
  I2C_MODE_TRANSCEIVE = 3        
};

enum I2CInterfaceCodes {
  I2C_1 = 1,                     
  I2C_2 = 2                      
};

enum I2CPinSelectCode {
  I2C1_PINS_WEST_TX_RX = 0,     
  I2C1_PINS_SOUTH_D3_D2 = 1,    
  I2C2_PINS_EAST_TX_RX = 0      
};

typedef u32 (*I2CByteSource)(int offset); 

typedef bool (*I2CByteSink)(u8 byte);   

class SFBHWI2C {

public:

  SFBHWI2C(u32 interface ) ;

  void setByteSource(I2CByteSource function) {
    if (!function && byteSource) msgLen = 0;  // Require a new transmit when source cleared
    byteSource = function;
  }

  void setByteSink(I2CByteSink function) {
    if (!function && byteSink) msgLen = 0;   // Require a new receive when sink cleared
    byteSink = function;
  }

  void transmit(u8 address, u32 length, u8 *message);

  void receive(u8 address, u32 length, u8 *message);

  void transceive(u8 address, u32 xmtLength, u8 *xmtData, u32 rcvLength, u8 *rcvData);

  void init(u32 pins, u32 bitRate);

  s8 status();

  void setBitRate(u32 bitRate);

  u32 count();

private:
  void i2cInterrupt() ;         /* The interrupt routine */
  friend void I2C1Handler();    
  friend void I2C2Handler();    
  void masterReceive();
  void masterTransmit();

  I2CByteSource byteSource; 

  I2CByteSink byteSink;     

  u32 dataCount;  

  u32 msgLen;     

  u8* msg;        
  
  u32 xcvLen;     

  u8* xcvMsg;     

  const u8 i2c;   

  s8 mode;        

  u8 addr;        

};

#endif  /*SFBHWI2C_H */