Skip to content

Struct cl_firmware_update_callbacks_t

ClassList > cl_firmware_update_callbacks_t

Struct containing function pointers to callbacks, to be called throughout the update process. Used with cl_device_update_firmware_from_blob andcl_device_update_firmware_from_path .

  • #include <cl/cl_api.h>

Public Attributes

Type Name
void(* report_progress
Callback called when a chunk has been sent to the device.
void(* start_finalizing
Callback called when upload is done and device is validating firmware and writing it to its flash memory.
void(* update_finished
Callback called when the update is finished.
void(* update_starting
Callback called when update is starting.
void * user_data
User data, will be used as the first argument to all callback functions.

Public Attributes Documentation

variable report_progress

Callback called when a chunk has been sent to the device. 

void(* cl_firmware_update_callbacks_t::report_progress) (void *user_data, size_t transferred_bytes);

Parameters:

  • user_data The previously given user_data
  • transferred_bytes The amount of bytes transferred up to this point

variable start_finalizing

Callback called when upload is done and device is validating firmware and writing it to its flash memory. 

void(* cl_firmware_update_callbacks_t::start_finalizing) (void *user_data);

Parameters:

  • user_data The previously given user_data

variable update_finished

Callback called when the update is finished. 

void(* cl_firmware_update_callbacks_t::update_finished) (void *user_data, enum cl_firmware_update_result_t update_result);

Parameters:

variable update_starting

Callback called when update is starting. 

void(* cl_firmware_update_callbacks_t::update_starting) (void *user_data, size_t total_transfer_bytes);

Parameters:

  • user_data The previously given user_data
  • total_transfer_bytes The total size of the firmware

variable user_data

User data, will be used as the first argument to all callback functions. 

void* cl_firmware_update_callbacks_t::user_data;

The documentation for this class was generated from the following file cl/cl_api.h