arch-eeprom.h

Go to the documentation of this file.

#ifndef EVE_ARCH_EEPROM_H_INCLUDED
#define EVE_ARCH_EEPROM_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2015-2017, Jetro AS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * \brief Driver for EEPROM emulation layer.
 *
 * \author DT, Jetro AS
 */ /******************************************************************/

#include <stdint.h>
#include <stdbool.h>

/**
 * \defgroup eeprom_emu EEPROM emulation driver
 * \ingroup abstract
 * \{ */

/** EEPROM private state */
struct eeprom_state_t {
  uint16_t read_page;               /**< Current read element in the read bank              */
  uint16_t write_page;              /**< Current write element in the write bank            */
  uint8_t read_bank;                /**< Index of the bank currently in use for read op.    */
  uint8_t write_bank;               /**< Tndex of the bank currently in use for write op.   */
  bool opened;                      /**< True if the EEPROM was successfully opened         */
};

/** EEPROM vtbl */
struct eeprom_vtbl_t {
  bool (*Power)(bool On);
  void (*Erase)(uint32_t SectorIndex);
  void (*Write)(uint32_t DstAddress, const void *SrcBuffer, uint32_t ByteCount);
  void (*Read)(void *DstBuffer, uint32_t SrcAddress, uint32_t ByteCount);
};

/** EEPROM object */
struct eeprom_t {
  struct eeprom_state_t *State;     /**< Pointer to the eeprom private state variable       */
  const struct eeprom_vtbl_t *Vtbl; /**< Virtual function table. Ext flash family is used if not set */
  eeprom_addr_t BeginAddr;          /**< Start address in the EEPROM block                  */
  eeprom_addr_t EndAddr;            /**< Last address in the EEPROM bank _plus_1_(!)        */
  uint16_t StartSector;             /**< The sector in the flash where the EEPROM starts    */
  uint16_t PageSize;                /**< Size of the EEPROM page                            */
  uint16_t PagesPerSector;          /**< Number of EEPROM pages in the flash sector         */
  uint8_t  PagesPerEeprom;          /**< Number of pages in the EEPROM representation       */
};

extern const struct eeprom_t EepromTable[];
extern const uint8_t EepromTableSize;

extern const struct eeprom_vtbl_t EepromInExternalFlash;
extern const struct eeprom_vtbl_t EepromInInternalFlash;

/** \} eeprom */

#endif /* EVE_ARCH_EEPROM_H_INCLUDED */