128 lines
4.5 KiB
C
128 lines
4.5 KiB
C
/**
|
|
* Eeprom object for generic microcontroller.
|
|
*
|
|
* This file is a template for other microcontrollers.
|
|
*
|
|
* @file eeprom.h
|
|
* @ingroup CO_eeprom
|
|
* @author Janez Paternoster
|
|
* @copyright 2004 - 2013 Janez Paternoster
|
|
*
|
|
* This file is part of CANopenNode, an opensource CANopen Stack.
|
|
* Project home page is <https://github.com/CANopenNode/CANopenNode>.
|
|
* For more information on CANopen see <http://www.can-cia.org/>.
|
|
*
|
|
* CANopenNode is free and open source 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) 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 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/>.
|
|
*
|
|
* Following clarification and special exception to the GNU General Public
|
|
* License is included to the distribution terms of CANopenNode:
|
|
*
|
|
* Linking this library statically or dynamically with other modules is
|
|
* making a combined work based on this library. Thus, the terms and
|
|
* conditions of the GNU General Public License cover the whole combination.
|
|
*
|
|
* As a special exception, the copyright holders of this library give
|
|
* you permission to link this library with independent modules to
|
|
* produce an executable, regardless of the license terms of these
|
|
* independent modules, and to copy and distribute the resulting
|
|
* executable under terms of your choice, provided that you also meet,
|
|
* for each linked independent module, the terms and conditions of the
|
|
* license of that module. An independent module is a module which is
|
|
* not derived from or based on this library. If you modify this
|
|
* library, you may extend this exception to your version of the
|
|
* library, but you are not obliged to do so. If you do not wish
|
|
* to do so, delete this exception statement from your version.
|
|
*/
|
|
|
|
|
|
#ifndef EEPROM_H
|
|
#define EEPROM_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup CO_eeprom Nonvolatile storage
|
|
* @ingroup CO_CANopen
|
|
* @{
|
|
*
|
|
* Storage of nonvolatile CANopen variables into the eeprom.
|
|
*/
|
|
|
|
|
|
/**
|
|
* Eeprom object.
|
|
*/
|
|
typedef struct{
|
|
uint8_t *OD_EEPROMAddress; /**< From CO_EE_init_1() */
|
|
uint32_t OD_EEPROMSize; /**< From CO_EE_init_1() */
|
|
uint8_t *OD_ROMAddress; /**< From CO_EE_init_1() */
|
|
uint32_t OD_ROMSize; /**< From CO_EE_init_1() */
|
|
uint32_t OD_EEPROMCurrentIndex; /**< Internal variable controls the OD_EEPROM vrite */
|
|
bool_t OD_EEPROMWriteEnable; /**< Writing to EEPROM is enabled */
|
|
}CO_EE_t;
|
|
|
|
|
|
/**
|
|
* First part of eeprom initialization. Called after microcontroller reset.
|
|
*
|
|
* @param ee This object will be initialized.
|
|
* @param OD_EEPROMAddress Address of OD_EEPROM structure from object dictionary.
|
|
* @param OD_EEPROMSize Size of OD_EEPROM structure from object dictionary.
|
|
* @param OD_ROMAddress Address of OD_ROM structure from object dictionary.
|
|
* @param OD_ROMSize Size of OD_ROM structure from object dictionary.
|
|
*
|
|
* @return #CO_ReturnError_t: CO_ERROR_NO, CO_ERROR_DATA_CORRUPT (Data in eeprom corrupt) or
|
|
* CO_ERROR_CRC (CRC from MBR does not match the CRC of OD_ROM block in eeprom).
|
|
*/
|
|
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. Called after CANopen communication reset.
|
|
*
|
|
* @param ee - This object.
|
|
* @param eeStatus - Return value from CO_EE_init_1().
|
|
* @param SDO - SDO object.
|
|
* @param em - Emergency object.
|
|
*/
|
|
void CO_EE_init_2(
|
|
CO_EE_t *ee,
|
|
CO_ReturnError_t eeStatus,
|
|
CO_SDO_t *SDO,
|
|
CO_EM_t *em);
|
|
|
|
|
|
/**
|
|
* Process eeprom object.
|
|
*
|
|
* Function must be called cyclically. It strores variables from OD_EEPROM data
|
|
* block into eeprom byte by byte (only if values are different).
|
|
*
|
|
* @param ee This object.
|
|
*/
|
|
void CO_EE_process(CO_EE_t *ee);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /*__cplusplus*/
|
|
|
|
/** @} */
|
|
#endif
|