Difference between revisions of "EEPROM"

(→‎EEPROM_WriteString)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[category:Library_Reference]]
 
[[category:Library_Reference]]
 
=EEPROM=
 
=EEPROM=
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
 
−
{{#Widget:LibTable}}
+
−
|-
+
−
|Defination ||
+
−
|-
+
−
| Input Arguments ||
+
−
|-
+
−
| Return Value||
+
−
|-
+
−
| Description || 
+
−
|-
+
−
| Usage ||
+
−
|}
+
  
  
Line 19: Line 7:
  
 
==EEPROM_WriteByte==
 
==EEPROM_WriteByte==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  '''void EEPROM_WriteByte(uint16_t eeprom_Address, uint8_t eeprom_Data)'''
+
|Defination ||  void EEPROM_WriteByte(uint16_t var_eepromAddress_u16, uint8_t var_eepromDatarr_u8)
 
|-
 
|-
−
| Input Arguments ||  '''uint16_t''': eeprom_address at which eeprom_data is to be written. uint8_t-->byte of data to be to be written in eeprom.
+
| Input Arguments ||  uint16_t: eeprom_address at which eeprom_data is to be written.<br />uint8_t: byte of data to be to be written in eeprom.
 
|-
 
|-
 
| Return Value||  none
 
| Return Value||  none
Line 30: Line 18:
 
| Description ||  This function is used to write the data at specified EEPROM_address..
 
| Description ||  This function is used to write the data at specified EEPROM_address..
 
|-
 
|-
−
| Usage ||
+
| Usage ||EEPROM_WriteByte(1234,25); //Writes 25 at the eeprom address 1234.
 
|}
 
|}
 +
 +
 +
  
 
==EEPROM_WriteNBytes==
 
==EEPROM_WriteNBytes==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || '''void EEPROM_WriteNBytes(uint16_t EepromAddr, uint8_t *RamAddr, uint16_t NoOfBytes)'''
+
|Defination || void EEPROM_WriteNBytes(uint16_t var_eepromAddress_u16, uint8_t *ptr_ramAddress_u8, uint16_t var_numOfBytes_u16)
 
|-
 
|-
−
| Input Arguments || '''uint16_t''',-->eeprom_address from where the N-bytes are to be written. '''uint8_t*'''-->Pointer to the N-bytes of data to be written.  '''uint16_t''' --> Number of bytes to be written.             
+
| Input Arguments || uint16_t,: eeprom_address from where the N-bytes are to be written.<br />
−
               
+
uint8_t*: Buffer(Pointer) containing the N-Bytes of data to be written in Eeprom..<br />
 +
uint16_t : Number of bytes to be written                              
 
|-
 
|-
 
| Return Value|| none
 
| Return Value|| none
Line 46: Line 38:
 
| Description ||  This function is used to write N-bytes of data at specified EEPROM_address.
 
| Description ||  This function is used to write N-bytes of data at specified EEPROM_address.
 
|-
 
|-
−
| Usage ||
+
| Usage ||uint8_t A_RamBuffer_U8[5]={10,20,30,40,50}; // Buffer containing the data to be written in Eeprom<br />
 +
EEPROM_WriteNBytes(100,A_RamBuffer_U8,5); //Copies 5bytes of data from A_RamBuffer_U8 into eeprom location 100.
 
|}
 
|}
 +
 +
 +
  
 
==EEPROM_WriteString==
 
==EEPROM_WriteString==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || '''void EEPROM_WriteString(uint16_t eeprom_address, char * source_address)'''
+
|Defination || void EEPROM_WriteString(uint16_t var_eepromAddress_u16, char *ptr_stringPointer_u8)
 
|-
 
|-
−
| Input Arguments || '''uint16_t''',-->eeprom_address where the String is to be written.'''char*'''-->Pointer to String which has to be written.
+
| Input Arguments || uint16_t: eeprom_address where the String is to be written.<br />
 +
char*: String(Pointer to String) which has to be written in Eeprom.
 
|-
 
|-
 
| Return Value|| none
 
| Return Value|| none
Line 61: Line 58:
 
| Description ||  This function is used to Write a String at specified EEPROM_address.NOTE: Null char is also written into the eeprom.
 
| Description ||  This function is used to Write a String at specified EEPROM_address.NOTE: Null char is also written into the eeprom.
 
|-
 
|-
−
| Usage ||
+
| Usage ||uint8_t A_StringBuffer_U8[20]="Hello, World"; // String to be written in eeprom<br />
 +
EEPROM_WriteString(50,A_StringBuffer_U8); //Copies "Hello, World" along with NULL character into eeprom location 50.
 
|}
 
|}
 +
 +
 +
  
 
==EEPROM_Erase==
 
==EEPROM_Erase==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || void EEPROM_Erase()
+
|Defination || void EEPROM_Erase()'''
 
|-
 
|-
 
| Input Arguments || none
 
| Input Arguments || none
Line 74: Line 75:
 
| Return Value|| none
 
| Return Value|| none
 
|-
 
|-
−
| Description || This function is used to erase the entire Eeprom memory. Eeprom is filled with 0xFF to accomplish the Eeprom Erase.Whole memory(C_MaxEepromSize) is traversed and filled with 0xFF.           
+
| Description || This function is used to erase the entire Eeprom memory.<br />
 +
Complete Eeprom(C_MaxEepromSize_U16) is filled with 0xFF to accomplish the Eeprom Erase.          
 
                
 
                
 
|-
 
|-
−
| Usage ||
+
| Usage ||EEPROM_Erase(); //Erases the complete(C_MaxEepromSize_U16 bytes) eeprom.
 
|}
 
|}
 +
 +
 +
  
 
==EEPROM_ReadByte==
 
==EEPROM_ReadByte==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || uint8_t EEPROM_ReadByte(uint16_t eeprom_Address)
+
|Defination || uint8_t EEPROM_ReadByte(uint16_t var_eepromAddress_u16)  
 
|-
 
|-
−
| Input Arguments || uint16_t-->eeprom_address from where eeprom_data is to be read.
+
| Input Arguments || uint16_t: eeprom_address from where eeprom_data is to be read.
 
|-
 
|-
−
| Return Value|| uint8_t-->data read from Eeprom.
+
| Return Value|| uint8_t: data read from Eeprom.
 
|-
 
|-
−
| Description ||This function is used to read the data from specified EEPROM_address.   
+
| Description ||This function is used to read a byte of data from specified EEPROM_address.   
 
|-
 
|-
−
| Usage ||   
+
| Usage ||  eeprom_data = EEPROM_ReadByte(100); reads the data from eeprom location 100 which is copied to eeprom_data
 
|}
 
|}
 +
 +
 +
  
 
==EEPROM_ReadNBytes==
 
==EEPROM_ReadNBytes==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || void EEPROM_ReadNBytes(uint16_t EepromAddr, uint8_t *RamAddr, uint16_t NoOfBytes)
+
|Defination || <syntaxhighlight>void EEPROM_ReadNBytes(uint16_t var_eepromAddress_16, uint8_t *ptr_ramAddress_u8, uint16_t var_numOfBytes_u16)</syntaxhighlight>
 
|-
 
|-
−
| Input Arguments || uint16_t,-->eeprom_address from where the N-bytes is to be read. uint8_t*-->Pointer into which the N-bytes of data is to be read. uint16_t --> Number of bytes to be Read.
+
| Input Arguments || uint16_t,: eeprom_address from where the N-bytes is to be read.<br />
−
             
+
uint8_t*: Pointer to copy the N-bytes read from Eeprom.<br />
 +
uint16_t :  Number of bytes to be Read            
 
                  
 
                  
 
|-
 
|-
 
| Return Value|| none
 
| Return Value|| none
 
|-
 
|-
−
| Description ||  This function is used to Read N-bytes of data from specified EEPROM_address. The data read from the eeprom will be copied into the RamAddress passed.Care should be taken to allocate enough buffer to read the data.
+
| Description ||  This function is used to Read N-bytes of data from specified EEPROM_address. The data read from the eeprom will be copied into the specified RamAddress .<br />Note:Care should be taken to allocate enough buffer to read the data.
 
            
 
            
 
|-
 
|-
−
| Usage ||
+
| Usage ||uint8_t A_RamBuffer_U8[20]; // Buffer to read the Eeprom data<br />
 +
EEPROM_ReadNBytes(1000,A_RamBuffer_U8,20); //Copies 20bytes of eeprom data(address 1000) into A_RamBuffer_U8
 
|}
 
|}
  
 
==EEPROM_ReadString==
 
==EEPROM_ReadString==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || void EEPROM_ReadString(uint16_t eeprom_address, char * destination_address)
+
|Defination || void EEPROM_ReadString(uint16_t var_eepromAddress_u16, char *ptr_destStringAddress_u8)
 
|-
 
|-
−
| Input Arguments ||  uint16_t,-->eeprom_address from where the String is to be read.char*-->Pointer into which the String is to be read.
+
| Input Arguments ||  uint16_t: eeprom_address from where the String is to be read.<br />
 +
char*: Pointer into which the String is to be read.
 
|-
 
|-
 
| Return Value||none  
 
| Return Value||none  
 
|-
 
|-
−
| Description ||This function is used to Read a String from specified EEPROM_address.The string read from eeprom will be copied to specified buffer and NULL terminated.   
+
| Description ||This function is used to Read a String from specified EEPROM_address.The string read from eeprom will be copied to specified buffer along with NULL character.   
 
|-
 
|-
−
| Usage ||
+
| Usage ||uint8_t A_StringBuffer_U8[20]; // Buffer to read the Eeprom data<br />
 +
EEPROM_ReadString(200,A_StringBuffer_U8); //Copies a string from eeprom(address 200) along with NULL caharacter into A_StringBuffer_U8
 
|}
 
|}
 +
 +
 +
 +
 +
==user guide==
 +
<syntaxhighlight>
 +
/* Program to illustrate the eeprom Read/Write */
 +
#include"uart.h"
 +
#include"delay.h"
 +
#include"eeprom.h"
 +
 +
int main()
 +
{
 +
 +
uint8_t arr_writeBuffer_u8[5]={10,20,35,50,60};
 +
char str_readString_u8[20];
 +
uint32_t var_writeNumber_u32=123456789;
 +
uint32_t var_readNumber_u32=0x00;
 +
char var_readChar_u8;
 +
uint8_t arr_readBuffer_u8[5];
 +
uint8_t i;
 +
 +
UART_Init(9600); //Initialize UART at 9600 baud
 +
 +
UART_TxString("\n\rErasing the Eeprom");
 +
EEPROM_Erase();
 +
UART_TxString("\n\rWriting below data into eeprom");
 +
UART_TxString("\n\rchar= A");
 +
UART_TxString("\n\r5-Bytes= 10,20,35,50,60");
 +
UART_TxString("\n\rString: hello, world");
 +
UART_Printf("\n\r32-bit number= %L",var_writeNumber_u32);
 +
EEPROM_WriteByte(10,'A');
 +
EEPROM_WriteNBytes(100,arr_writeBuffer_u8,5);
 +
EEPROM_WriteString(150,"hello, world");
 +
EEPROM_WriteNBytes(200,&var_writeNumber_u32,sizeof(var_writeNumber_u32));
 +
 +
 +
UART_TxString("\n\r\n\rReading Data back from eeprom");
 +
var_readChar_u8 = EEPROM_ReadByte(10);
 +
EEPROM_ReadNBytes(100,arr_readBuffer_u8,5);
 +
EEPROM_ReadString(150,str_readString_u8);
 +
EEPROM_ReadNBytes(200,&var_readNumber_u32,sizeof(var_readNumber_u32));
 +
UART_Printf("\n\rchar:%c",var_readChar_u8);
 +
UART_TxString("\n\r5-Bytes: ");
 +
for(i=0;i<5;i++)
 +
UART_Printf("%d ",arr_readBuffer_u8[i]);
 +
UART_Printf("\n\rstring:%s",str_readString_u8);
 +
UART_Printf("\n\r32bit Number:%L",var_readNumber_u32);
 +
 +
 +
while(1);
 +
 +
return 0;
 +
}
 +
</syntaxhighlight>

Latest revision as of 08:58, 10 January 2015

EEPROM

EEPROM_WriteByte

{{#Widget:LibTable}}
Defination void EEPROM_WriteByte(uint16_t var_eepromAddress_u16, uint8_t var_eepromDatarr_u8)
Input Arguments uint16_t: eeprom_address at which eeprom_data is to be written.
uint8_t: byte of data to be to be written in eeprom.
Return Value none
Description This function is used to write the data at specified EEPROM_address..
Usage EEPROM_WriteByte(1234,25); //Writes 25 at the eeprom address 1234.



EEPROM_WriteNBytes

{{#Widget:LibTable}}
Defination void EEPROM_WriteNBytes(uint16_t var_eepromAddress_u16, uint8_t *ptr_ramAddress_u8, uint16_t var_numOfBytes_u16)
Input Arguments uint16_t,: eeprom_address from where the N-bytes are to be written.

uint8_t*: Buffer(Pointer) containing the N-Bytes of data to be written in Eeprom..
uint16_t : Number of bytes to be written

Return Value none
Description This function is used to write N-bytes of data at specified EEPROM_address.
Usage uint8_t A_RamBuffer_U8[5]={10,20,30,40,50}; // Buffer containing the data to be written in Eeprom

EEPROM_WriteNBytes(100,A_RamBuffer_U8,5); //Copies 5bytes of data from A_RamBuffer_U8 into eeprom location 100.



EEPROM_WriteString

{{#Widget:LibTable}}
Defination void EEPROM_WriteString(uint16_t var_eepromAddress_u16, char *ptr_stringPointer_u8)
Input Arguments uint16_t: eeprom_address where the String is to be written.

char*: String(Pointer to String) which has to be written in Eeprom.

Return Value none
Description This function is used to Write a String at specified EEPROM_address.NOTE: Null char is also written into the eeprom.
Usage uint8_t A_StringBuffer_U8[20]="Hello, World"; // String to be written in eeprom

EEPROM_WriteString(50,A_StringBuffer_U8); //Copies "Hello, World" along with NULL character into eeprom location 50.



EEPROM_Erase

{{#Widget:LibTable}}
Defination void EEPROM_Erase()
Input Arguments none
Return Value none
Description This function is used to erase the entire Eeprom memory.

Complete Eeprom(C_MaxEepromSize_U16) is filled with 0xFF to accomplish the Eeprom Erase.

Usage EEPROM_Erase(); //Erases the complete(C_MaxEepromSize_U16 bytes) eeprom.



EEPROM_ReadByte

{{#Widget:LibTable}}
Defination uint8_t EEPROM_ReadByte(uint16_t var_eepromAddress_u16)
Input Arguments uint16_t: eeprom_address from where eeprom_data is to be read.
Return Value uint8_t: data read from Eeprom.
Description This function is used to read a byte of data from specified EEPROM_address.
Usage eeprom_data = EEPROM_ReadByte(100); reads the data from eeprom location 100 which is copied to eeprom_data



EEPROM_ReadNBytes

{{#Widget:LibTable}}
Defination 
void EEPROM_ReadNBytes(uint16_t var_eepromAddress_16, uint8_t *ptr_ramAddress_u8, uint16_t var_numOfBytes_u16)
Input Arguments uint16_t,: eeprom_address from where the N-bytes is to be read.

uint8_t*: Pointer to copy the N-bytes read from Eeprom.
uint16_t : Number of bytes to be Read

Return Value none
Description This function is used to Read N-bytes of data from specified EEPROM_address. The data read from the eeprom will be copied into the specified RamAddress .
Note:Care should be taken to allocate enough buffer to read the data.
Usage uint8_t A_RamBuffer_U8[20]; // Buffer to read the Eeprom data

EEPROM_ReadNBytes(1000,A_RamBuffer_U8,20); //Copies 20bytes of eeprom data(address 1000) into A_RamBuffer_U8

EEPROM_ReadString

{{#Widget:LibTable}}
Defination void EEPROM_ReadString(uint16_t var_eepromAddress_u16, char *ptr_destStringAddress_u8)
Input Arguments uint16_t: eeprom_address from where the String is to be read.

char*: Pointer into which the String is to be read.

Return Value none
Description This function is used to Read a String from specified EEPROM_address.The string read from eeprom will be copied to specified buffer along with NULL character.
Usage uint8_t A_StringBuffer_U8[20]; // Buffer to read the Eeprom data

EEPROM_ReadString(200,A_StringBuffer_U8); //Copies a string from eeprom(address 200) along with NULL caharacter into A_StringBuffer_U8



user guide

/* Program to illustrate the eeprom Read/Write */
#include"uart.h"
#include"delay.h"
#include"eeprom.h"
 
int main()
{
 
	uint8_t arr_writeBuffer_u8[5]={10,20,35,50,60};
	char str_readString_u8[20];
	uint32_t var_writeNumber_u32=123456789;
	uint32_t var_readNumber_u32=0x00;
	char var_readChar_u8;
	uint8_t arr_readBuffer_u8[5];
	uint8_t i;
 
	UART_Init(9600); //Initialize UART at 9600 baud
 
	UART_TxString("\n\rErasing the Eeprom");
	EEPROM_Erase();
	UART_TxString("\n\rWriting below data into eeprom");
	UART_TxString("\n\rchar= A");
	UART_TxString("\n\r5-Bytes= 10,20,35,50,60");
	UART_TxString("\n\rString: hello, world");
	UART_Printf("\n\r32-bit number= %L",var_writeNumber_u32);
	EEPROM_WriteByte(10,'A');
	EEPROM_WriteNBytes(100,arr_writeBuffer_u8,5);
	EEPROM_WriteString(150,"hello, world");
	EEPROM_WriteNBytes(200,&var_writeNumber_u32,sizeof(var_writeNumber_u32));
 
 
	UART_TxString("\n\r\n\rReading Data back from eeprom");
	var_readChar_u8 = EEPROM_ReadByte(10);
	EEPROM_ReadNBytes(100,arr_readBuffer_u8,5);
	EEPROM_ReadString(150,str_readString_u8);
	EEPROM_ReadNBytes(200,&var_readNumber_u32,sizeof(var_readNumber_u32));
	UART_Printf("\n\rchar:%c",var_readChar_u8);
	UART_TxString("\n\r5-Bytes: ");
	for(i=0;i<5;i++)
	UART_Printf("%d ",arr_readBuffer_u8[i]);
	UART_Printf("\n\rstring:%s",str_readString_u8);
	UART_Printf("\n\r32bit Number:%L",var_readNumber_u32);
 
 
	while(1);
 
	return 0;
}
Retrieved from "https://exploreembedded.com/wiki/index.php?title=EEPROM&oldid=4237"