SFBEeprom.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBEeprom.h - Support for I/O with the EEPROM
  Copyright (C) 2009 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 SFBEEPROM_H_
#define SFBEEPROM_H_

#include "SFBTypes.h"

extern void eepromWrite(u32 addr, const u8 * source, u32 length) ;

extern void eepromRead(u32 addr, u8 * dest, u32 length) ;

extern void eepromWait(bool busyWait = false) ;

extern u32 eepromSize() ;

#define EEPROM_SIZE_BYTES (1<<14)    
#define EEPROM_BYTES_PER_PAGE 64     
#define EEPROM_RESERVED_PAGES 2      
#define EEPROM_RESERVED_BYTES (EEPROM_RESERVED_PAGES*EEPROM_BYTES_PER_PAGE) 
extern void eepromWriteReserved(const u32 addr, const u8 * data, const u32 length) ;

extern void eepromReadReserved(const u32 addr, u8 * data,const u32 length) ;

extern void eeprom_startup_initialization() ;

class SFBEeprom {
public:
  void write(u32 addr, const u8 * source, u32 length) { eepromWrite(addr,source,length); }

  void read(u32 addr, u8 * dest, u32 length) { eepromRead(addr, dest, length); }

  void wait(bool busyWait = false) { eepromWait(busyWait); }

  u32 size() { return eepromSize(); }
};

extern SFBEeprom EEPROM; 


#endif /*SFBEEPROM_H_*/