Classes | Macros | Enumerations | Functions
fwupdate.h File Reference
#include "xbus.h"
Include dependency graph for fwupdate.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  FwUpdate
 FwUpdate object definition. More...
 
struct  XffHeader
 Definition of a xff section header. More...
 

Macros

#define FWU_REQUIRED_TXBUFFER_SIZE   300
 

Enumerations

enum  FWU_Result { FWU_Success, FWU_Failed }
 Result value. More...
 
enum  FWU_State {
  STATE_Idle, STATE_Start, STATE_WaitReady, STATE_WaitHeaderResult,
  STATE_WaitSliceReady, STATE_WaitPageOk, STATE_WaitPageReady
}
 Internal state. More...
 

Functions

void FwUpdate_handleXbus (FwUpdate *thisPtr, uint8_t const *xbusMessage)
 Handle xbus message coming from the module. More...
 
void FwUpdate_init (FwUpdate *thisPtr)
 Initialize a FwUpdate instance. More...
 
void FwUpdate_start (FwUpdate *thisPtr)
 Start a firmware update. More...
 

Macro Definition Documentation

◆ FWU_REQUIRED_TXBUFFER_SIZE

#define FWU_REQUIRED_TXBUFFER_SIZE   300

Definition at line 74 of file fwupdate.h.

Enumeration Type Documentation

◆ FWU_Result

enum FWU_Result

Result value.

Enumerator
FWU_Success 
FWU_Failed 

Definition at line 78 of file fwupdate.h.

◆ FWU_State

enum FWU_State

Internal state.

Enumerator
STATE_Idle 
STATE_Start 
STATE_WaitReady 
STATE_WaitHeaderResult 
STATE_WaitSliceReady 
STATE_WaitPageOk 
STATE_WaitPageReady 

Definition at line 106 of file fwupdate.h.

Function Documentation

◆ FwUpdate_handleXbus()

void FwUpdate_handleXbus ( FwUpdate thisPtr,
uint8_t const *  xbusMessage 
)

Handle xbus message coming from the module.

Parameters
xbusMessageThe xbus message from the module to be handled

Definition at line 382 of file fwupdate.c.

◆ FwUpdate_init()

void FwUpdate_init ( FwUpdate thisPtr)

Initialize a FwUpdate instance.

Definition at line 352 of file fwupdate.c.

◆ FwUpdate_start()

void FwUpdate_start ( FwUpdate thisPtr)

Start a firmware update.

Definition at line 361 of file fwupdate.c.



xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:20