oremeq@3: /*
oremeq@3:                    canfestival@canopencanada.ca
oremeq@3: 
oremeq@3: See COPYING file for copyrights details.
oremeq@3: 
oremeq@3: This library is free software; you can redistribute it and/or
oremeq@3: modify it under the terms of the GNU Lesser General Public
oremeq@3: License as published by the Free Software Foundation; either
oremeq@3: version 2.1 of the License, or (at your option) any later version.
oremeq@3: 
oremeq@3: This library is distributed in the hope that it will be useful,
oremeq@3: but WITHOUT ANY WARRANTY; without even the implied warranty of
oremeq@3: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
oremeq@3: Lesser General Public License for more details.
oremeq@3: 
oremeq@3: You should have received a copy of the GNU Lesser General Public
oremeq@3: License along with this library; if not, write to the Free Software
oremeq@3: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
oremeq@3: 
oremeq@3: flash.c
oremeq@3: 	save to / retrieve from  the non-volatile memory
oremeq@3: 	to be tested
oremeq@3: 	- can we write/read into an address without working with the whole page (256bytes)
oremeq@3: */
oremeq@3: 
oremeq@3: 
oremeq@3: #include <stdio.h>
oremeq@3: #include <stdlib.h>
oremeq@3: 
oremeq@3: #include "applicfg.h"
oremeq@3: #include "data.h"
oremeq@3: #include "objdictdef.h"
oremeq@3: 
oremeq@3: #include "lpc2138_defs.h"                    /* LPC21xx definitions */
oremeq@3: 
oremeq@3: #define IAP_LOCATION 			0x7ffffff1
oremeq@3: 
oremeq@3: 
oremeq@3: // define a page of data of NVRAM_BLOCK_SIZE bytes
oremeq@3: //
oremeq@3: short data_len; /* 0 to NVRAM_BLOCK_SIZE bytes */
oremeq@3: short data_num_pages;
oremeq@3: unsigned int *data_page = NULL;
oremeq@3: unsigned int data_addr;
oremeq@3: 
oremeq@3: unsigned int *regs_page = NULL;
oremeq@3: 
oremeq@3: // local definitons
oremeq@3: void ee_erase(unsigned int ,unsigned int[]);		//function erases EEPROM
oremeq@3: void ee_write_page(unsigned int);	//function adds a record in EEPROM
oremeq@3: void ee_read_page(unsigned int);	//function reads the latest valid record in EEPROM
oremeq@3: 
oremeq@3: typedef void (*IAP)(unsigned int [],unsigned int[]);
oremeq@3: IAP iap_entry;
oremeq@3: 
oremeq@3: 
oremeq@18: int iat_init()
oremeq@18: {
oremeq@18: 	int n = NVRAM_BLOCK_SIZE / sizeof(unsigned int);
oremeq@18: 
oremeq@18: 	/* some actions to initialise the flash */
oremeq@18: 	data_len = 0;
oremeq@18: 	data_num_pages = 0;
oremeq@18: 
oremeq@18: 	data_page = (unsigned int *)malloc(sizeof(unsigned int) * n);
oremeq@18: 	memset(data_page, 0, sizeof(unsigned int)*n);
oremeq@18: 
oremeq@18: 	if (data_page == NULL)
oremeq@18: 		return -1;
oremeq@18: 
oremeq@18: 	regs_page = (unsigned int *)malloc(sizeof(unsigned int) * n);
oremeq@18: 	memset(regs_page, 0, sizeof(unsigned int)*n);
oremeq@18: 	if (regs_page == NULL)
oremeq@18: 		return -2;
oremeq@18: 
oremeq@18: 	iat_flash_read_regs();
oremeq@18: 
oremeq@18: 	/* start the data at the location specified in the registers */ 
oremeq@18: 	if (0) /* for now it is 0, but put here a test to know whether
oremeq@18:                   or not the NVRAM has been written before */
oremeq@18: 		data_addr = regs_page[1];
oremeq@18: 	else
oremeq@18: 		data_addr = NVRAM_BLOCK_SIZE; /* let start at block 1 */
oremeq@18: 
oremeq@18: 	return 0;
oremeq@18: }
oremeq@18: 
oremeq@18: 
oremeq@18: void iat_end()
oremeq@18: {
oremeq@18: 	/* write the last page before closing */
oremeq@18: 	iat_flash_write_page(data_addr);
oremeq@18: 
oremeq@18: 	/* some actions to end accessing the flash */
oremeq@18: 	free(data_page);
oremeq@18: 
oremeq@18: 	regs_page[4] = data_num_pages;
oremeq@18: 	/* write the registers to the NVRAM before closing */
oremeq@18: 	iat_flash_write_regs();
oremeq@18: 	free(regs_page);
oremeq@18: }
oremeq@18: 
oremeq@18: 
oremeq@3: 
oremeq@3: /************************************************************************/
oremeq@3: /*                                                                    	*/
oremeq@3: /* function:								*/
oremeq@3: /*  void ee_erase(unsigned int command_ee,unsigned int result_ee[])	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* type: void                                                          	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* parameters: 								*/
oremeq@3: /* 	command_ee   - Not used.  	               			*/
oremeq@3: /*  result_ee[0] - Returns a response to the last IAP command used.	*/
oremeq@3: /*                 0 - EEPROM successfully erased.			*/
oremeq@3: /*                 For all other response values, see microcontroller 	*/
oremeq@3: /*		   User Manual, IAP Commands and Status Codes Summary.	*/
oremeq@3: /*  result_ee[1] - Not used.                         			*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* version: 1.1 (01/27/2006)                                           	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* constants defined in LPC2k_ee.h used in this function:              	*/
oremeq@3: /*  EE_SEC_L 	 - microcontroller's Flash sector where EEPROM begins	*/
oremeq@3: /*  EE_SEC_H 	 - microcontroller's Flash sector where EEPROM ends	*/
oremeq@3: /*  EE_CCLK		 - microcontroller's system clock (cclk)        */
oremeq@3: /*                                                                     	*/
oremeq@3: /* description:								*/
oremeq@3: /*  This function erases LPC2000 on-chip Flash sectors selected to act 	*/
oremeq@3: /*  as an EEPROM. All Flash sectors between EE_SEC_L abd EE_SEC_H	*/
oremeq@3: /*  (including these sectors) will be erased using the In Application	*/
oremeq@3: /*  Programming (IAP) routines (see User Manual for more details). 	*/
oremeq@3: /*  Also, this function disables all interrupts while erasing the       */
oremeq@3: /*  EEPROM. If this is not needed, three lines of the ee_erase          */
oremeq@3: /*  subroutine can simply be commented-out without affecting the        */
oremeq@3: /*  routine performance at all.                                         */
oremeq@3: /*                                                                     	*/
oremeq@3: /* revision history:                                                   	*/
oremeq@3: /* - Rev. 1.1 adds interrupt disable feature.				*/
oremeq@3: /*                                                                     	*/
oremeq@3: /************************************************************************/
oremeq@3: void ee_erase(unsigned int command_ee,unsigned int result_ee[])
oremeq@3: {
oremeq@3: 	unsigned int command_iap[5];
oremeq@3: 	unsigned int result_iap[3];
oremeq@3: 	unsigned long int enabled_interrupts;
oremeq@3: 
oremeq@3: 	enabled_interrupts = VICIntEnable;  //disable all interrupts
oremeq@3: 	VICIntEnClr        = enabled_interrupts;
oremeq@3: 
oremeq@3: 	command_iap[0]=50;	// prepare sectors from EE_SEC_L to EE_SEC_H for erase
oremeq@3: 	command_iap[1]=EE_SEC_L;
oremeq@3: 	command_iap[2]=EE_SEC_H;
oremeq@3: 	iap_entry=(IAP) IAP_LOCATION;
oremeq@3: 	iap_entry(command_iap,result_iap);
oremeq@3: 
oremeq@3: 	command_iap[0]=52;	// erase sectors from EE_SEC_L to EE_SEC_H
oremeq@3: 	command_iap[1]=EE_SEC_L;
oremeq@3: 	command_iap[2]=EE_SEC_H;
oremeq@3: 	command_iap[3]=EE_CCLK;
oremeq@3: 	iap_entry=(IAP) IAP_LOCATION;
oremeq@3: 	iap_entry(command_iap,result_iap);
oremeq@3: 
oremeq@3: 	command_iap[0]=53;	// blankcheck sectors from EE_SEC_L to EE_SEC_H
oremeq@3: 	command_iap[1]=EE_SEC_L;
oremeq@3: 	command_iap[2]=EE_SEC_H;
oremeq@3: 	iap_entry=(IAP) IAP_LOCATION;
oremeq@3: 	iap_entry(command_iap,result_iap);
oremeq@3: 
oremeq@3: 	VICIntEnable = enabled_interrupts;  //restore interrupt enable register
oremeq@3: 
oremeq@3: 	result_ee[0]=result_iap[0];
oremeq@3: 	return;
oremeq@3: }
oremeq@3: 
oremeq@3: /************************************************************************/
oremeq@3: /*                                                                    	*/
oremeq@3: /* function: 								*/
oremeq@3: /*  void ee_write(unsigned int command_ee,unsigned int result_ee[])	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* type: void                                                          	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* parameters: 								*/
oremeq@3: /* 	command_ee   - An address of a content of ee_data type that has	*/
oremeq@3: /*                 to be programmed into EEPROM.                       	*/
oremeq@3: /*  result_ee[0] - Returns a response to the last IAP command used.	*/
oremeq@3: /*                 0 - data successfully programmed in EEPROM.		*/
oremeq@3: /*               501 - no space in EEPROM to program data.             	*/
oremeq@3: /*                 For all other response values, see microcontroller 	*/
oremeq@3: /*		   User Manual, IAP Commands and Status Codes Summary.	*/
oremeq@3: /*  result_ee[1] - Not used.                           			*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* version: 1.1 (01/27/2006)                                           	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* constants defined in LPC2k_ee.h used in this function:              	*/
oremeq@3: /*  EE_BUFFER_SIZE 	   - IAP buffer size; must be 256 or 512 	*/
oremeq@3: /*  NO_SPACE_IN_EEPROM - EEPROM is full and no data can be programmed	*/
oremeq@3: /*  EE_BUFFER_MASK	   - parameter used for interfacing with IAP	*/
oremeq@3: /*  EE_REC_SIZE   	   - ee_data structure size in bytes        	*/
oremeq@3: /*  EE_SEC_L 	 	   - micro's Flash sector where EEPROM begins	*/
oremeq@3: /*  EE_SEC_H 	 	   - micro's Flash sector where EEPROM ends	*/
oremeq@3: /*  EE_CCLK		 	   - micro's system clock (cclk)       	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* description:								*/
oremeq@3: /*  This function writes a single structure of ee_data type into the	*/
oremeq@3: /*  EEPROM using an In Application	Programming (IAP) routines (see */
oremeq@3: /*  User Manual for more details). command_ee contains an address of	*/
oremeq@3: /*  this structure. EEPROM is scanned for the last (if any) record 	*/
oremeq@3: /*  identifier (EE_REC_ID), and a new record is added next to it.      	*/
oremeq@3: /*  Also, this function disables all interrupts while erasing the       */
oremeq@3: /*  EEPROM. If this is not needed, three lines of the ee_write          */
oremeq@3: /*  subroutine can simply be commented-out without affecting the        */
oremeq@3: /*  routine performance at all.                                         */
oremeq@3: /*                                                                     	*/
oremeq@3: /* revision history:                                                   	*/
oremeq@3: /* - Rev. 1.1 fixes a bug related to verifying a content written into	*/
oremeq@3: /*   the EEPROM. 1.0 was reporting missmatch even when there were no	*/
oremeq@3: /*   problems at all.							*/
oremeq@3: /*   Rev. 1.1 adds interrupt disable feature.				*/
oremeq@3: /*                                                                     	*/
oremeq@3: /************************************************************************/
oremeq@3: 
oremeq@3: void ee_write_page(unsigned int addr)
oremeq@3: {
oremeq@3: 	unsigned long int enabled_interrupts;
oremeq@3: 	// unsigned char ee_buffer[16];
oremeq@3: 	unsigned int command_iap[5], result_iap[3];
oremeq@3: 
oremeq@3: 	enabled_interrupts = VICIntEnable;  //disable all interrupts
oremeq@3: 	VICIntEnClr        = enabled_interrupts;
oremeq@3: 
oremeq@3: 	iap_entry = (IAP) IAP_LOCATION;
oremeq@3: 
oremeq@3: 	// prepare sectors from EE_SEC_L to EE_SEC_H for erase
oremeq@3: 	command_iap[0] = 50;			
oremeq@3: 	command_iap[1] = EE_SEC_L;
oremeq@3: 	command_iap[2] = EE_SEC_H;
oremeq@3: 	iap_entry(command_iap, result_iap);
oremeq@3: 
oremeq@3: 	// copy RAM to flash/eeprom
oremeq@3: 	command_iap[0] = 51;
oremeq@3: 	command_iap[1] = (unsigned int) (addr & EE_START_MASK); // 256 kb boundary
oremeq@3: 	command_iap[2] = (unsigned int) (data_page);            // should be on a word boundary
oremeq@3: 	command_iap[3] = 256;
oremeq@3: 	command_iap[4] = EE_CCLK;
oremeq@3: 	iap_entry(command_iap, result_iap);
oremeq@3: 
oremeq@3: #if 0 
oremeq@3: 	// compare RAM and flash/eeprom
oremeq@3: 	command_iap[0] = 56;
oremeq@3: 	command_iap[1] = (unsigned int) data;
oremeq@3: 	command_iap[2] = addr;
oremeq@3: 	command_iap[3] = dlen;
oremeq@3: 	iap_entry(command_iap, result_iap);
oremeq@3: #endif
oremeq@3: 
oremeq@3: 	VICIntEnable = enabled_interrupts;  //restore interrupt enable register
oremeq@3: }
oremeq@3: 
oremeq@3: 
oremeq@3: /************************************************************************/
oremeq@3: /*                                                                    	*/
oremeq@3: /* function: 								*/
oremeq@3: /*  void ee_read(unsigned int command_ee,unsigned int result_ee[])	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* type: void                                                          	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* parameters: 								*/
oremeq@3: /* 	command_ee   - Not used.					*/
oremeq@3: /*  result_ee[0] - Returns a response.					*/
oremeq@3: /*                 0 - data successfully found in EEPROM.		*/
oremeq@3: /*               500 - no data/records available in EEPROM.		*/
oremeq@3: /*  result_ee[1] - an address of the last record of ee_data type	*/
oremeq@3: /*				   in EEPROM.  	              		*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* version: 1.1 (01/27/2006)                                           	*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* constants defined in LPC2k_ee.h used in this function:              	*/
oremeq@3: /*  NO_RECORDS_AVAILABLE - EEPROM is empty/no records identifiable	*/
oremeq@3: /*			   with a record identifier (EE_REC_ID) found	*/
oremeq@3: /*  EE_ADR_L 	    - micro's Flash address from where EEPROM begins	*/
oremeq@3: /*  EE_REC_SIZE    - size (in bytes) of a ee_data structure        	*/
oremeq@3: /*                                                                 	*/
oremeq@3: /* description:								*/
oremeq@3: /*  This function scans an EEPROM content looking for the last record 	*/
oremeq@3: /*  that can be identified with a record identifier (EE_REC_ID). When 	*/
oremeq@3: /*  such data is found, its address is passed as result_ee[1].		*/
oremeq@3: /*                                                                     	*/
oremeq@3: /* revision history:                                                   	*/
oremeq@3: /* - Rev. 1.0 had problems with accessing the last record in a fully	*/
oremeq@3: /*   occupied EEPROM. Rev. 1.1 fixes this.				*/
oremeq@3: /*                                                                     	*/
oremeq@3: /************************************************************************/
oremeq@3: void ee_read_page(unsigned int addr)
oremeq@3: {
oremeq@3: 	memcpy(data_page, (unsigned int *)addr, sizeof(unsigned int)*64);
oremeq@3: }
oremeq@3: 
oremeq@3: 
oremeq@3: //////////////////////////////////////////////////////////////////////////////////////////
oremeq@3: //////////////////////////////////////////////////////////////////////////////////////////
oremeq@3: 
oremeq@3: 
oremeq@3: /*
oremeq@3: 	CAN FESTIVAL interface functions
oremeq@3: */
oremeq@3: 
oremeq@3: 
oremeq@3: int _get_data_len(int type)
oremeq@3: {
oremeq@3: 	int len = 0; /* number of bytes */
oremeq@3: 	switch(type)
oremeq@3: 	{
oremeq@3: 		case  boolean:
oremeq@3: 			len = 1;
oremeq@3: 			break;
oremeq@3: 
oremeq@3: 		case  int8:
oremeq@3: 		case  uint8:
oremeq@3: 			len = 1;
oremeq@3: 			break;
oremeq@3: 		case  int16:
oremeq@3: 		case  uint16:
oremeq@3: 			len = 2;
oremeq@3: 			break;
oremeq@3: 		case  int24:
oremeq@3: 		case  uint24:
oremeq@3: 			len = 3;
oremeq@3: 			break;
oremeq@3: 		case  int32:
oremeq@3: 		case  uint32:
oremeq@3: 		case  real32:
oremeq@3: 			len = 4;
oremeq@3: 			break;
oremeq@3: 		case  int40:
oremeq@3: 		case  uint40:
oremeq@3: 			len = 5;
oremeq@3: 			break;
oremeq@3: 		case  int48:
oremeq@3: 		case  uint48:
oremeq@3: 			len = 6;
oremeq@3: 			break;
oremeq@3: 		case  int56:
oremeq@3: 		case  uint56:
oremeq@3: 			len = 7;
oremeq@3: 			break;
oremeq@3: 		case  int64:
oremeq@3: 		case  uint64:
oremeq@3: 		case  real64:
oremeq@3: 			len = 8;
oremeq@3: 			break;
oremeq@3: #if 0
oremeq@3: /* TO DO */
oremeq@3: 		case  visible_string:
oremeq@3: 		case  octet_string:
oremeq@3: 		case  unicode_string:
oremeq@3: 		case  time_of_day:
oremeq@3: 		case  time_difference:
oremeq@3: #endif
oremeq@3: 	}
oremeq@3: 
oremeq@3: 	return len;
oremeq@3: }
oremeq@3: 
oremeq@3: 
oremeq@3: