Homec4science
Diffusion sbcp-uc (changes-cs-and-header) Browse

sbcp-uc/include/DEE_Emulation_16-bit.h
26fad3beac65changes-cs-and-header

Last Change
Raw File

DEE_Emulation_16-bit.h
View Options

/************************************************************************
*
* Emulating Data EEPROM for PIC24 Microcontrollers and
* dsPIC Digital Signal Controllers
*
*************************************************************************
* FileName: DEE Emulation 16-bit.h
* Compiler: MPLAB C30, v2.01 or higher
* Company: Microchip Technology, Inc.
*
* Software License Agreement
*
* Copyright � 2007 Microchip Technology Inc. All rights reserved.
*
* Microchip licenses to you the right to use, modify, copy and distribute
* Software only when embedded on a Microchip microcontroller or digital
* signal controller, which is integrated into your product or third party
* product (pursuant to the sublicense terms in the accompanying license
* agreement).
*
* You should refer to the license agreement accompanying this Software for
* additional information regarding your rights and obligations.
*
* SOFTWARE AND DOCUMENTATION ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY
* KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY
* WARRANTY OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE. IN NO EVENT SHALL MICROCHIP OR ITS LICENSORS BE
* LIABLE OR OBLIGATED UNDER CONTRACT, NEGLIGENCE, STRICT LIABILITY,
* CONTRIBUTION, BREACH OF WARRANTY, OR OTHER LEGAL EQUITABLE THEORY ANY
* DIRECT OR INDIRECT DAMAGES OR EXPENSES INCLUDING BUT NOT LIMITED TO ANY
* INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE OR CONSEQUENTIAL DAMAGES, LOST
* PROFITS OR LOST DATA, COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY,
* SERVICES, OR ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO
* ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
*
* Author Date Comment
*************************************************************************
* D. Otten 2007/05/01 Version 1.0.0 - Initial Release
* D. Otten 2007/05/15 Version 1.0.1 - First publication release
* Pradeep Budagutta 2008/04/02 Version 1.1.0 - Multi EEPROM banks included
*************************************************************************
* adjusted and tested for motordriver_demo
* Francis wyffels & Tim Waegeman 2011/04/29
************************************************************************/
// User defined constants
#define DATA_EE_BANKS 1 // 1 bank is sufficient
#define DATA_EE_SIZE 64 // only 22 unsigned ints must be saved in eeprom
#define DATA_EE_TOTAL_SIZE (DATA_EE_BANKS * DATA_EE_SIZE)
#define ERASE 0x4042 // see register NVMCON 4-1 in datasheet
#define NUM_DATA_EE_PAGES 2
#define PROGRAM_ROW 0x4001
#define PROGRAM_WORD 0x4003
// Internal constants
#define ERASE_WRITE_CYCLE_MAX 4096
#define NUMBER_OF_INSTRUCTIONS_IN_PAGE 512
#define NUMBER_OF_INSTRUCTIONS_IN_ROW 64
#define NUMBER_OF_ROWS_IN_PAGE (NUMBER_OF_INSTRUCTIONS_IN_PAGE \ NUMBER_OF_INSTRUCTIONS_IN_ROW)
#define PAGE_AVAILABLE 1
#define PAGE_CURRENT 0
#define PAGE_EXPIRED 0
#define PAGE_NOT_AVAILABLE 0
#define PAGE_NOT_CURRENT 1
#define PAGE_NOT_EXPIRED 1
#define STATUS_AVAILABLE 18
#define STATUS_CURRENT 19
#define STATUS_EXPIRED 20
#define GetaddrNotFound() dataEEFlags.addrNotFound
#define SetaddrNotFound(x) dataEEFlags.addrNotFound = x
#define GetPageCorruptStatus() dataEEFlags.pageCorrupt
#define SetPageCorruptStatus(x) dataEEFlags.pageCorrupt = x
#define GetPageExpiredPage() dataEEFlags.expiredPage
#define SetPageExpiredPage(x) dataEEFlags.expiredPage = x
#define GetPageIllegalAddress() dataEEFlags.IllegalAddress
#define SetPageIllegalAddress(x) dataEEFlags.IllegalAddress = x
#define GetPagePackBeforeInit() dataEEFlags.packBeforeInit
#define SetPagePackBeforeInit(x) dataEEFlags.packBeforeInit = x
#define GetPagePackBeforePageFull() dataEEFlags.packBeforePageFull
#define SetPagePackBeforePageFull(x) dataEEFlags.packBeforePageFull = x
#define GetPagePackSkipped() dataEEFlags.packSkipped
#define SetPagePackSkipped(x) dataEEFlags.packSkipped = x
#define GetPageWriteError() dataEEFlags.writeError
#define SetPageWriteError(x) dataEEFlags.writeError = x
/**
* \private
*/
typedef union
{
unsigned char val;
struct
{
unsigned addrNotFound:1; // Return 0xFFFF
unsigned expiredPage:1; // Return 0x1
unsigned packBeforePageFull:1; // Not a return condition
unsigned packBeforeInit:1; // Return 0x3
unsigned packSkipped:1; // Return 0x4
unsigned IllegalAddress:1; // Return 0x5
unsigned pageCorrupt:1; // Return 0x6
unsigned writeError:1; // Return 0x7
};
} DATA_EE_FLAGS;
extern DATA_EE_FLAGS dataEEFlags;
extern int ReadPMHigh(int);
extern int ReadPMLow(int);
extern void UnlockPM(void);
extern int WritePMHigh(int, int);
extern int WritePMHighB(int, int);
extern int WritePMLow(int, int);
extern int WritePMLowB(int, int);
void UnlockWrite (void);
int GetPageStatus (unsigned char bank, unsigned volatile char page, unsigned volatile char field);
void ErasePage (unsigned char bank, unsigned char page);
char IncEWCount (unsigned char *index);
unsigned int GetNextAvailCount (unsigned char bank);
int PackEE (unsigned char bank);
unsigned char DataEEInit (void);
unsigned int DataEERead (unsigned int addr);
unsigned char DataEEWrite (unsigned int data, unsigned int addr);
c4science · Help