FwUpdate Struct Reference

FwUpdate object definition. More...

#include <fwupdate.h>

Public Attributes
uint8_t	m_endOfFile
uint32_t	m_nofPages
uint32_t	m_nofSlicesPerPage
uint32_t	m_pageCounter
uint32_t	m_readIndex
uint32_t(*	m_readXffData )(uint8_t *buffer, uint32_t offset, uint32_t length)
	Callback function by which FwUpdate requests for xff data. More...
void(*	m_readyHandler )(FWU_Result result)
	Callback function by which FwUpdate notifies the host that a firmware update has finished. More...
void(*	m_sendXbusMessage )(uint8_t const *xbusMessage)
	Callback function via which FwUpdate can send xbus messages to the module. More...
uint32_t	m_sliceCounter
FWU_State	m_state
uint8_t *	m_txBuffer
	Memory needed by the FwUpdate. Host must allocate a block of memory of size FWU_REQUIRED_TXBUFFER_SIZE. More...
XffHeader	m_xffHeader

Detailed Description

FwUpdate object definition.

Definition at line 121 of file fwupdate.h.

Member Data Documentation

m_endOfFile

uint8_t FwUpdate::m_endOfFile

Internal state member of FwUpdate

Definition at line 156 of file fwupdate.h.

m_nofPages

uint32_t FwUpdate::m_nofPages

Internal state member of FwUpdate

Definition at line 151 of file fwupdate.h.

m_nofSlicesPerPage

uint32_t FwUpdate::m_nofSlicesPerPage

Internal state member of FwUpdate

Definition at line 152 of file fwupdate.h.

m_pageCounter

uint32_t FwUpdate::m_pageCounter

Internal state member of FwUpdate

Definition at line 153 of file fwupdate.h.

m_readIndex

uint32_t FwUpdate::m_readIndex

Internal state member of FwUpdate

Definition at line 155 of file fwupdate.h.

m_readXffData

uint32_t(* FwUpdate::m_readXffData) (uint8_t *buffer, uint32_t offset, uint32_t length)

Callback function by which FwUpdate requests for xff data.

Parameters

buffer	Target buffer in which the xff data should be written by the host
offset	Offset in the xff file where reading should start
length	Number of bytes which is requested

Returns

Number of bytes which is actually written to the buffer

Definition at line 131 of file fwupdate.h.

m_readyHandler

void(* FwUpdate::m_readyHandler) (FWU_Result result)

Callback function by which FwUpdate notifies the host that a firmware update has finished.

Parameters

result

FWU_Success or FWU_Failed

Definition at line 141 of file fwupdate.h.

m_sendXbusMessage

void(* FwUpdate::m_sendXbusMessage) (uint8_t const *xbusMessage)

Callback function via which FwUpdate can send xbus messages to the module.

Parameters

xbusMessage

Xbus message that should be send to the module

Definition at line 136 of file fwupdate.h.

m_sliceCounter

uint32_t FwUpdate::m_sliceCounter

Internal state member of FwUpdate

Definition at line 154 of file fwupdate.h.

m_state

FWU_State FwUpdate::m_state

Internal state member of FwUpdate

Definition at line 149 of file fwupdate.h.

m_txBuffer

uint8_t* FwUpdate::m_txBuffer

Memory needed by the FwUpdate. Host must allocate a block of memory of size FWU_REQUIRED_TXBUFFER_SIZE.

Definition at line 146 of file fwupdate.h.

m_xffHeader

XffHeader FwUpdate::m_xffHeader

Internal state member of FwUpdate

Definition at line 150 of file fwupdate.h.

---

The documentation for this struct was generated from the following file:

• fwupdate.h