NetBurner 3.1
Hardware Abstraction Layer

Functions

void HardwareSetup ()
 Initializes the system hardware such as the timer, cache and clock speed.
 
void ForceReboot (bool bFromException=false)
 Forces the system hardware to perform a soft reset.
 
void FlashErase (void *pWhere, int len)
 Erases the flash memory. More...
 
void FlashProgram (void *pWhere, void *pWhat, int len)
 Program flash memory. More...
 
void FlashProgramAppImage (void *pWhere, void *pWhat, int len)
 Write an application image to flash memory. More...
 
void DisableCache ()
 Disable the instruction and data cache.
 
void EnableCache ()
 Enable the instruction and data cache.
 
uint32_t spaceleft ()
 Report how much free unallocated space is left in dynamic memory. More...
 
uint16_t HalGetTickFraction (void)
 Returns the fraction of the current system time tick. More...
 
void StdioCheckIntc (void)
 Check STDIO interrupt sources. More...
 
void SysLogCheckIntc (void)
 This is just like the StdioCheckIntc() function, except that the results are displayed via UDP. More...
 

Variables

void(* watchdog_service_function )(void)
 Watchdog callback service function. More...
 
uint32_t HalTickMaxCount
 Rollover value for the system hardware tick timer. More...
 

Detailed Description

& Other than the ForceReboot() and spaceleft() functions, these are advanced functions that should only be used by developers experienced with NetBurner hardware, firmware and memory maps.

Function Documentation

◆ FlashErase()

void FlashErase ( void *  pWhere,
int  len 
)

Erases the flash memory.

Parameters
pWhereThe starting location in flash memory to begin the erasure
lenSpecified the number of bytes to erase

◆ FlashProgram()

void FlashProgram ( void *  pWhere,
void *  pWhat,
int  len 
)

Program flash memory.

Parameters
pWherePointer to the starting location in flash to begin programming
pWhatPointer to the content that will be programmed into flash
lenNumber of bytes to program

◆ FlashProgramAppImage()

void FlashProgramAppImage ( void *  pWhere,
void *  pWhat,
int  len 
)

Write an application image to flash memory.

On some platforms writing the application image may require calling ProgramImage even though it may only call FlashErase and FlashProgram. As a result, ProgramImage should always be used when updating the application image.

Parameters
pWherePointer to the starting location in flash to begin the programming
pWhatPointer to the content that will be programmed into flash
lenNumber of bytes to write

◆ HalGetTickFraction()

uint16_t HalGetTickFraction ( void  )

Returns the fraction of the current system time tick.

return - The current counter value used to generate tick count

◆ spaceleft()

uint32_t spaceleft ( )

Report how much free unallocated space is left in dynamic memory.

Returns
Number of bytes unallocated in dynamic memory

◆ StdioCheckIntc()

void StdioCheckIntc ( void  )

Check STDIO interrupt sources.

Checks the interrupt sources used in the system along with their associated interrupt level and priority, and also checks for any conflicts in using the same level and priority between different sources. These results are sent to stdout.

See also
SysLogCheckIntc()

◆ SysLogCheckIntc()

void SysLogCheckIntc ( void  )

This is just like the StdioCheckIntc() function, except that the results are displayed via UDP.

See also
StdioCheckIntc()

Variable Documentation

◆ HalTickMaxCount

uint32_t HalTickMaxCount

Rollover value for the system hardware tick timer.

Returns
The max/rollover counter value used to generate the tick count

◆ watchdog_service_function

void(* watchdog_service_function) (void)

Watchdog callback service function.

If the following function pointer is set to point at a function of the form:

void YourFunc( void );

Then the system will call this function throughout the AutoUpdate/TCPUpdate process to make sure that the watchdog timer is serviced.