at45db.h File Reference


Detailed Description

Dataflash helper routines.

 *
 * $Log: at45db.h,v $
 * Revision 1.2  2006/10/08 16:48:09  haraldkipp
 * Documentation fixed
 *
 * Revision 1.1  2006/09/29 12:41:55  haraldkipp
 * Added support for AT45 serial DataFlash memory chips. Currently limited
 * to AT91 builds.
 *
 *
 * 

Definition in file at45db.h.

Go to the source code of this file.

Functions

int At45dbSendCmd (int dd, u_char op, u_long parm, int len, CONST void *tdata, void *rdata, int datalen)
 Send DataFlash command.
u_char At45dbGetStatus (int dd)
int At45dbWaitReady (int dd, u_long tmo, int poll)
 Wait until flash memory cycle finished.
int At45dbInit (u_int spibas, u_int spipcs)
 Initialize dataflash at specified interface and chip select.
int At45dbPageErase (int dd, u_int off)
 Erase sector at the specified offset.
int At45dbChipErase (void)
 Erase entire flash memory chip.
int At45dbPageRead (int dd, u_long pgn, void *data, u_int len)
 Read data from flash memory.
int At45dbPageWrite (int dd, u_int off, CONST void *data, u_int len)
 Write data into flash memory.
int At45dbParamRead (u_int pos, void *data, u_int len)
 Load configuration parameters from flash memory.
int At45dbParamWrite (u_int pos, CONST void *data, u_int len)
 Store configuration parameters in flash memory.


Function Documentation

int At45dbSendCmd ( int  dd,
u_char  op,
u_long  parm,
int  len,
CONST void *  tdata,
void *  rdata,
int  datalen 
)

Send DataFlash command.

Parameters:
dd Device descriptor.
op Command operation code.
parm Command parameter.
len Command length.
tdata Transmit data.
rdata Receive data buffer.
datalen Data length.

Definition at line 281 of file at45db.c.

Referenced by At45dbPageErase(), At45dbPageRead(), and At45dbPageWrite().

u_char At45dbGetStatus ( int  dd  ) 

Definition at line 298 of file at45db.c.

Referenced by At45dbInit(), and At45dbWaitReady().

int At45dbWaitReady ( int  dd,
u_long  tmo,
int  poll 
)

Wait until flash memory cycle finished.

Returns:
0 on success or -1 in case of an error.

Definition at line 313 of file at45db.c.

Referenced by At45dbPageWrite().

int At45dbInit ( u_int  spibas,
u_int  spipcs 
)

Initialize dataflash at specified interface and chip select.

Parameters:
spibas Interface base address. For ARM MCUs this may be the I/O base address of the hardware SPI.
spipcs Device chip select.
Returns:
Device descriptor or -1 in case of an error.

Definition at line 337 of file at45db.c.

Referenced by At45dbParamSize().

int At45dbPageErase ( int  dd,
u_int  off 
)

Erase sector at the specified offset.

Definition at line 379 of file at45db.c.

int At45dbChipErase ( void   ) 

Erase entire flash memory chip.

Definition at line 388 of file at45db.c.

int At45dbPageRead ( int  dd,
u_long  pgn,
void *  data,
u_int  len 
)

Read data from flash memory.

Parameters:
dd Device descriptor.
pgn Page number to read, starting at 0.
data Points to a buffer that receives the data.
len Number of bytes to read.
Returns:
0 on success or -1 in case of an error.

Definition at line 403 of file at45db.c.

Referenced by At45dbParamRead(), and At45dbParamWrite().

int At45dbPageWrite ( int  dd,
u_int  pgn,
CONST void *  data,
u_int  len 
)

Write data into flash memory.

The related sector must have been erased before calling this function.

Parameters:
dd Device descriptor.
pgn Start location within the chip, starting at 0.
data Points to a buffer that contains the bytes to be written.
len Number of bytes to write.
Returns:
0 on success or -1 in case of an error.

Definition at line 421 of file at45db.c.

Referenced by At45dbParamWrite().

int At45dbParamRead ( u_int  pos,
void *  data,
u_int  len 
)

Load configuration parameters from flash memory.

Parameters:
pos Start location within configuration sector.
data Points to a buffer that receives the contents.
len Number of bytes to read.
Returns:
Always 0.

Definition at line 484 of file at45db.c.

Referenced by NutNvMemLoad().

int At45dbParamWrite ( u_int  pos,
CONST void *  data,
u_int  len 
)

Store configuration parameters in flash memory.

Parameters:
pos Start location within configuration sector.
data Points to a buffer that contains the bytes to store.
len Number of bytes to store.
Returns:
0 on success or -1 in case of an error.

Definition at line 510 of file at45db.c.

Referenced by NutNvMemSave().


© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/