drivers/eeprom/eeprom.h

   1 /**************************************************************************/
   2 /*!
   3     @file     eeprom.h
   4     @author   K. Townsend (microBuilder.eu)
   5
   6     @section LICENSE
   7
   8     Software License Agreement (BSD License)
   9
  10     Copyright (c) 2010, microBuilder SARL
  11     All rights reserved.
  12
  13     Redistribution and use in source and binary forms, with or without
  14     modification, are permitted provided that the following conditions are met:
  15     1. Redistributions of source code must retain the above copyright
  16     notice, this list of conditions and the following disclaimer.
  17     2. Redistributions in binary form must reproduce the above copyright
  18     notice, this list of conditions and the following disclaimer in the
  19     documentation and/or other materials provided with the distribution.
  20     3. Neither the name of the copyright holders nor the
  21     names of its contributors may be used to endorse or promote products
  22     derived from this software without specific prior written permission.
  23
  24     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  25     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  26     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  28     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  29     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  30     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  31     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34 */
  35 /**************************************************************************/
  36 #ifndef __EEPROM_H__
  37 #define __EEPROM_H__
  38
  39 #include "projectconfig.h"
  40
  41 // Method Prototypes
  42 bool      eepromCheckAddress ( uint16_t addr );
  43 uint8_t   eepromReadU8 ( uint16_t addr );
  44 int8_t    eepromReadS8 ( uint16_t addr );
  45 uint16_t  eepromReadU16 ( uint16_t addr );
  46 int16_t   eepromReadS16 ( uint16_t addr );
  47 uint32_t  eepromReadU32 ( uint16_t addr );
  48 int32_t   eepromReadS32 ( uint16_t addr );
  49 uint64_t  eepromReadU64 ( uint16_t addr );
  50 int64_t   eepromReadS64 ( uint16_t addr );
  51 void      eepromReadBuffer ( uint16_t addr, uint8_t *buffer, uint32_t bufferLength);
  52 void      eepromWriteU8 ( uint16_t addr, uint8_t value );
  53 void      eepromWriteS8 ( uint16_t addr, int8_t value );
  54 void      eepromWriteU16 ( uint16_t addr, uint16_t value );
  55 void      eepromWriteS16 ( uint16_t addr, int16_t value );
  56 void      eepromWriteU32 ( uint16_t addr, uint32_t value );
  57 void      eepromWriteS32 ( uint16_t addr, int32_t value );
  58 void      eepromWriteU64 ( uint16_t addr, uint64_t value );
  59 void      eepromWriteS64 ( uint16_t addr, int64_t value );
  60
  61 #endif