1
0
Fork 0
CANopenNode/stack/PIC32/eeprom.h
2015-07-25 14:03:15 +02:00

102 lines
3.2 KiB
C

/*
* Eeprom object for Microchip PIC32MX microcontroller.
*
* @file eeprom.h
* @version SVN: \$Id$
* @author Janez Paternoster
* @copyright 2004 - 2013 Janez Paternoster
*
* This file is part of CANopenNode, an opensource CANopen Stack.
* Project home page is <http://canopennode.sourceforge.net>.
* For more information on CANopen see <http://www.can-cia.org/>.
*
* CANopenNode 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 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EEPROM_H
#define EEPROM_H
/* For documentation see file genericDriver/eeprom.h */
/*
* PIC32MX specific
*
* 25LC128 eeprom from Microchip is used connected on SPI2A.
*
* Two blocks of CANopen Object Dictionary data are stored in eeprom:
* OD_EEPROM - Stored is from eeprom address 0. Data are stored automatically on
* change. No data corruption control is made.
* OD_ROM - Stored from upper half eeprom address. Data are protected from
* accidental write, can also be hardware protected. Data integrity
* is verified with CRC.
* Data are stored on special CANopen command - Writing 0x65766173
* into Object dictionary (index 1010, subindex 1). Default values
* are restored after reset, if writing 0x64616F6C into (1011, 1).
*/
/* Constants */
#define EE_SIZE 0x4000
#define EE_PAGE_SIZE 64
/* Master boot record is stored on the last page in eeprom */
typedef struct{
uint32_t CRC; /* CRC code of the OD_ROM block */
uint32_t OD_EEPROMSize; /* Size of OD_EEPROM block */
uint32_t OD_ROMSize; /* Size of OD_ROM block */
}EE_MBR_t;
/* Eeprom object */
typedef struct{
uint8_t *OD_EEPROMAddress;
uint32_t OD_EEPROMSize;
uint8_t *OD_ROMAddress;
uint32_t OD_ROMSize;
uint32_t OD_EEPROMCurrentIndex;
CO_bool_t OD_EEPROMWriteEnable;
}CO_EE_t;
/* First part of eeprom initialization.
*
* Allocate memory for object, configure SPI port for use with 25LCxxx, read
* eeprom and store to OD_EEPROM and OD_ROM.
*/
CO_ReturnError_t CO_EE_init_1(
CO_EE_t *ee,
uint8_t *OD_EEPROMAddress,
uint32_t OD_EEPROMSize,
uint8_t *OD_ROMAddress,
uint32_t OD_ROMSize);
/* Second part of eeprom initialization. */
void CO_EE_init_2(
CO_EE_t *ee,
CO_ReturnError_t eeStatus,
CO_SDO_t *SDO,
CO_EM_t *em);
/* Process eeprom object. */
void CO_EE_process(CO_EE_t *ee);
#endif