drivers/storage/eeprom/mcp24aa/mcp24aa.h

   1 /**************************************************************************/
   2 /*!
   3     @file     mcp24aa.h
   4     @author   K. Townsend (microBuilder.eu)
   5     @date     22 March 2010
   6     @version  0.10
   7
   8     @section LICENSE
   9
  10     Software License Agreement (BSD License)
  11
  12     Copyright (c) 2010, microBuilder SARL
  13     All rights reserved.
  14
  15     Redistribution and use in source and binary forms, with or without
  16     modification, are permitted provided that the following conditions are met:
  17     1. Redistributions of source code must retain the above copyright
  18     notice, this list of conditions and the following disclaimer.
  19     2. Redistributions in binary form must reproduce the above copyright
  20     notice, this list of conditions and the following disclaimer in the
  21     documentation and/or other materials provided with the distribution.
  22     3. Neither the name of the copyright holders nor the
  23     names of its contributors may be used to endorse or promote products
  24     derived from this software without specific prior written permission.
  25
  26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  27     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  30     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  31     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  33     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 */
  37 /**************************************************************************/
  38
  39 #ifndef _MCP24AA_H_
  40 #define _MCP24AA_H_
  41
  42 #include "projectconfig.h"
  43
  44 #define MCP24AA_ADDR    0xA0          // 10100000
  45 #define MCP24AA_RW      0x01
  46 #define MCP24AA_READBIT 0x01
  47 #define MCP24AA_MAXADDR 0xFFF         // 4K = 4096
  48
  49 typedef enum
  50 {
  51   MCP24AA_ERROR_OK = 0,               // Everything executed normally
  52   MCP24AA_ERROR_I2CINIT,              // Unable to initialise I2C
  53   MCP24AA_ERROR_I2CBUSY,              // I2C already in use
  54   MCP24AA_ERROR_ADDRERR,              // Address out of range
  55   MCP24AA_ERROR_BUFFEROVERFLOW,       // Max 8 bytes can be read/written in one operation
  56   MCP24AA_ERROR_LAST
  57 }
  58 mcp24aaError_e;
  59
  60 mcp24aaError_e mcp24aaInit (void);
  61 mcp24aaError_e mcp24aaReadBuffer (uint16_t address, uint8_t *buffer, uint32_t bufferLength);
  62 mcp24aaError_e mcp24aaWriteBuffer (uint16_t address, uint8_t *buffer, uint32_t bufferLength);
  63 mcp24aaError_e mcp24aaReadByte (uint16_t address, uint8_t *buffer);
  64 mcp24aaError_e mcp24aaWriteByte (uint16_t address, uint8_t value);
  65
  66
  67 #endif