eeprom-wl.h

Go to the documentation of this file.

/* EEPROM access and wear leveling */
/* Copyright (C) 2010 Sebastian Klemm
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) version 3.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License along
 *   with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef EEPROM_WL_H
#define EEPROM_WL_H

#include "config-params.h"

#define EE_PARAM_BUFFER_SIZE  (8)
#define EE_STATUS_BUFFER_SIZE  EE_PARAM_BUFFER_SIZE

#define EE_BYTE_SIZE (1)
#define EE_WORD_SIZE (2)
#define EE_DWORD_SIZE (4)

#define EE_STATIC_PARAM_1  (0)
#define EE_STATIC_PARAM_2  (EE_STATIC_PARAM_1 + EE_STATIC_PARAM_1_SIZE)
#define EE_STATIC_PARAM_3  (EE_STATIC_PARAM_2 + EE_STATIC_PARAM_2_SIZE)
#define EE_STATIC_PARAM_4  (EE_STATIC_PARAM_3 + EE_STATIC_PARAM_3_SIZE)
#define EE_STATIC_PARAM_5  (EE_STATIC_PARAM_4 + EE_STATIC_PARAM_4_SIZE)
#define EE_STATIC_PARAM_6  (EE_STATIC_PARAM_5 + EE_STATIC_PARAM_5_SIZE)
#define EE_STATIC_PARAM_7  (EE_STATIC_PARAM_6 + EE_STATIC_PARAM_6_SIZE)
#define EE_STATIC_PARAM_LAST  (EE_STATIC_PARAM_7 + EE_STATIC_PARAM_7_SIZE)

#define EE_PARAM_BUFFER_START (64)

#define EE_PARAM_1  EE_PARAM_BUFFER_START
#define EE_PARAM_2  (EE_PARAM_1 + EE_PARAM_1_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)
#define EE_PARAM_3  (EE_PARAM_2 + EE_PARAM_2_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)
#define EE_PARAM_4  (EE_PARAM_3 + EE_PARAM_3_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)
#define EE_PARAM_5  (EE_PARAM_4 + EE_PARAM_4_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)
#define EE_PARAM_6  (EE_PARAM_5 + EE_PARAM_5_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)
#define EE_PARAM_7  (EE_PARAM_6 + EE_PARAM_6_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)
#define EE_PARAM_LAST  (EE_PARAM_7 + EE_PARAM_7_SIZE * EE_PARAM_BUFFER_SIZE + EE_STATUS_BUFFER_SIZE)

#if (EE_STATIC_PARAM_LAST + EE_STATIC_PARAM_LAST_SIZE) > EE_PARAM_BUFFER_START
#error "Memory space needed for static config parameters exceeds reserved size!"
#endif

#if EE_PARAM_LAST > E2END
#error "Memory space needed for config parameters exceeds size of EEPROM!"
#endif

#define EE_ECHO (1)

#define EE_WRITE (1)

typedef uint8_t * ee_addr_t;

uint8_t read_config_byte (ee_addr_t parameter, ee_addr_t *address);
uint16_t read_config_word (ee_addr_t parameter, ee_addr_t *address);
uint32_t read_config_dword (ee_addr_t parameter, ee_addr_t *address);

void write_config_byte (ee_addr_t parameter, ee_addr_t *address, uint8_t data);
void write_config_word (ee_addr_t parameter, ee_addr_t *address, uint16_t data);
void write_config_dword (ee_addr_t parameter, ee_addr_t *address, uint32_t data);


void ee_find_current_buffer_address (ee_addr_t parameter, ee_addr_t *EeBufPtr, uint8_t param_size);

void ee_read_buffer (ee_addr_t address, void *data, uint8_t param_size);

void ee_write_byte (ee_addr_t address, uint8_t data);

void ee_write_buffer (ee_addr_t parameter, ee_addr_t *address, void *data, uint8_t param_size);

#endif