nvm.c File Reference

Functions
void	NvmInit (void)
	Initializes the NVM driver.
void	NvmReinit (void)
	Reinitializes the NVM driver. This function is called at the start of each firmware update as opposed to NvmInit, which is only called once during power on.
blt_bool	NvmWrite (blt_addr addr, blt_int32u len, blt_int8u *data)
	Programs the non-volatile memory.
blt_bool	NvmErase (blt_addr addr, blt_int32u len)
	Erases the non-volatile memory.
blt_bool	NvmVerifyChecksum (void)
	Verifies the checksum, which indicates that a valid user program is present and can be started.
blt_addr	NvmGetUserProgBaseAddress (void)
	Obtains the base address of the non-volatile memory available to the user program. This is typically that start of the vector table.
blt_bool	NvmDone (void)
	Once all erase and programming operations are completed, this function is called, so at the end of the programming session and right before a software reset is performed. It is used to calculate a checksum and program this into flash. This checksum is later used to determine if a valid user program is present in flash.

Function Documentation

NvmDone()

blt_bool NvmDone

(

void

)

Once all erase and programming operations are completed, this function is called, so at the end of the programming session and right before a software reset is performed. It is used to calculate a checksum and program this into flash. This checksum is later used to determine if a valid user program is present in flash.

Returns

BLT_TRUE if successful, BLT_FALSE otherwise.

Definition at line 136 of file nvm.c.

{
  /* compute and write checksum, which is programmed by the internal driver. */
  if (FlashWriteChecksum() == BLT_FALSE)
  {
    return BLT_FALSE;
  }
 
  /* finish up internal driver operations */
  return FlashDone();
} /*** end of NvmDone ***/

Here is the call graph for this function:

NvmErase()

blt_bool NvmErase	(	blt_addr	addr,
		blt_int32u	len
	)

Erases the non-volatile memory.

Parameters

addr	Start address.
len	Length in bytes.

Returns

BLT_TRUE if successful, BLT_FALSE otherwise.

Definition at line 95 of file nvm.c.

{
  /* still here so the internal driver should try and perform the erase operation */
  return FlashErase(addr, len);
} /*** end of NvmErase ***/

Here is the call graph for this function:

NvmGetUserProgBaseAddress()

blt_addr NvmGetUserProgBaseAddress

(

void

)

Obtains the base address of the non-volatile memory available to the user program. This is typically that start of the vector table.

Returns

Base address.

Definition at line 121 of file nvm.c.

{
  return FlashGetUserProgBaseAddress();
} /*** end of NvmGetUserProgBaseAddress ***/

Here is the call graph for this function:

NvmInit()

void NvmInit

(

void

)

Initializes the NVM driver.

Returns

none.

Definition at line 52 of file nvm.c.

{
  /* init the internal driver */
  FlashInit();
} /*** end of NvmInit ***/

Here is the call graph for this function:

NvmReinit()

void NvmReinit

(

void

)

Reinitializes the NVM driver. This function is called at the start of each firmware update as opposed to NvmInit, which is only called once during power on.

Returns

none.

Definition at line 66 of file nvm.c.

{
  /* reinitialize the internal driver */
  FlashReinit();
} /*** end of NvmReinit ***/

Here is the call graph for this function:

NvmVerifyChecksum()

blt_bool NvmVerifyChecksum

(

void

)

Verifies the checksum, which indicates that a valid user program is present and can be started.

Returns

BLT_TRUE if successful, BLT_FALSE otherwise.

Definition at line 108 of file nvm.c.

{
  /* check checksum using the interally supported method. */
  return FlashVerifyChecksum();
} /*** end of NvmVerifyChecksum ***/

Referenced by CpuStartUserProgram(), and Rs232Init().

Here is the call graph for this function:

Here is the caller graph for this function:

NvmWrite()

blt_bool NvmWrite	(	blt_addr	addr,
		blt_int32u	len,
		blt_int8u *	data
	)

Programs the non-volatile memory.

Parameters

addr	Start address.
len	Length in bytes.
data	Pointer to the data buffer.

Returns

BLT_TRUE if successful, BLT_FALSE otherwise.

Definition at line 81 of file nvm.c.

{
  /* still here so the internal driver should try and perform the program operation */
  return FlashWrite(addr, len, data);
} /*** end of NvmWrite ***/

Here is the call graph for this function:

Go to the source code of this file.