Jim Carver
Fork for workshops
_ARM_UPDATE_SOURCE Struct Reference
Structure definition holding API function pointers. More...
#include <arm_uc_source.h>
Data Fields | |
| uint32_t(* | GetVersion )(void) |
| Get driver version. | |
| ARM_SOURCE_CAPABILITIES(* | GetCapabilities )(void) |
| Get Source capabilities. | |
| arm_uc_error_t(* | Initialize )(ARM_SOURCE_SignalEvent_t cb_event) |
| Initialize Source. | |
| arm_uc_error_t(* | Uninitialize )(void) |
| Uninitialized Source. | |
| arm_uc_error_t(* | GetManifestDefaultCost )(uint32_t *cost) |
| Cost estimation for retrieving manifest from the default location. | |
| arm_uc_error_t(* | GetManifestURLCost )(arm_uc_uri_t *uri, uint32_t *cost) |
| Cost estimation for retrieving manifest from URL. | |
| arm_uc_error_t(* | GetFirmwareURLCost )(arm_uc_uri_t *uri, uint32_t *cost) |
| Cost estimation for retrieving firmware from URL. | |
| arm_uc_error_t(* | GetKeytableURLCost )(arm_uc_uri_t *uri, uint32_t *cost) |
| Cost estimation for retrieving key table from URL. | |
| arm_uc_error_t(* | GetManifestDefault )(arm_uc_buffer_t *buffer, uint32_t offset) |
| Retrieve manifest from the default location. | |
| arm_uc_error_t(* | GetManifestURL )(arm_uc_uri_t *uri, arm_uc_buffer_t *buffer, uint32_t offset) |
| Retrieve manifest from URL. | |
| arm_uc_error_t(* | GetFirmwareFragment )(arm_uc_uri_t *uri, arm_uc_buffer_t *buffer, uint32_t offset) |
| Retrieve firmware fragment. | |
| arm_uc_error_t(* | GetKeytableURL )(arm_uc_uri_t *uri, arm_uc_buffer_t *buffer) |
| Retrieve a key table from a URL. | |
Detailed Description
Structure definition holding API function pointers.
Definition at line 65 of file arm_uc_source.h.
Field Documentation
| ARM_SOURCE_CAPABILITIES(* GetCapabilities)(void) |
Get Source capabilities.
- Returns:
- Struct containing capabilites. See definition above.
Definition at line 77 of file arm_uc_source.h.
| arm_uc_error_t(* GetFirmwareFragment)(arm_uc_uri_t *uri, arm_uc_buffer_t *buffer, uint32_t offset) |
Retrieve firmware fragment.
Firmware fragment is stored in supplied buffer. Event is generated once fragment is in buffer.
- Parameters:
-
uri URI struct with firmware location. buffer Struct containing byte array, maximum size, and actual size. offset Firmware offset to retrieve fragment from.
- Returns:
- Error code.
Definition at line 175 of file arm_uc_source.h.
| arm_uc_error_t(* GetFirmwareURLCost)(arm_uc_uri_t *uri, uint32_t *cost) |
Cost estimation for retrieving firmware from URL.
The estimation can vary over time and should not be cached too long. 0x00000000 - The firmware is already downloaded. 0xFFFFFFFF - Cannot retrieve firmware from this Source.
- Parameters:
-
uri URI struct with firmware location. cost Pointer to variable for the return value.
- Returns:
- Error code.
Definition at line 127 of file arm_uc_source.h.
| arm_uc_error_t(* GetKeytableURL)(arm_uc_uri_t *uri, arm_uc_buffer_t *buffer) |
Retrieve a key table from a URL.
Key table is stored in supplied buffer. Event is generated once fragment is in buffer.
- Parameters:
-
uri URI struct with keytable location. buffer Struct containing byte array, maximum size, and actual size.
- Returns:
- Error code.
Definition at line 186 of file arm_uc_source.h.
| arm_uc_error_t(* GetKeytableURLCost)(arm_uc_uri_t *uri, uint32_t *cost) |
Cost estimation for retrieving key table from URL.
The estimation can vary over time and should not be cached too long. 0x00000000 - The firmware is already downloaded. 0xFFFFFFFF - Cannot retrieve firmware from this Source.
- Parameters:
-
uri URI struct with keytable location. cost Pointer to variable for the return value.
- Returns:
- Error code.
Definition at line 139 of file arm_uc_source.h.
| arm_uc_error_t(* GetManifestDefault)(arm_uc_buffer_t *buffer, uint32_t offset) |
Retrieve manifest from the default location.
Manifest is stored in supplied buffer. Event is generated once manifest is in buffer.
- Parameters:
-
buffer Struct containing byte array, maximum size, and actual size. offset Manifest offset in bytes where the requested fragment begins.
- Returns:
- Error code.
Definition at line 150 of file arm_uc_source.h.
| arm_uc_error_t(* GetManifestDefaultCost)(uint32_t *cost) |
Cost estimation for retrieving manifest from the default location.
The estimation can vary over time and should not be cached too long. 0x00000000 - The manifest is already downloaded. 0xFFFFFFFF - Cannot retrieve manifest from this Source.
- Parameters:
-
cost Pointer to variable for the return value.
- Returns:
- Error code.
Definition at line 103 of file arm_uc_source.h.
| arm_uc_error_t(* GetManifestURL)(arm_uc_uri_t *uri, arm_uc_buffer_t *buffer, uint32_t offset) |
Retrieve manifest from URL.
Manifest is stored in supplied buffer. Event is generated once manifest is in buffer.
- Parameters:
-
uri URI struct with manifest location. buffer Struct containing byte array, maximum size, and actual size. offset Manifest offset in bytes where the requested fragment begins.
- Returns:
- Error code.
Definition at line 163 of file arm_uc_source.h.
| arm_uc_error_t(* GetManifestURLCost)(arm_uc_uri_t *uri, uint32_t *cost) |
Cost estimation for retrieving manifest from URL.
The estimation can vary over time and should not be cached too long. 0x00000000 - The manifest is already downloaded. 0xFFFFFFFF - Cannot retrieve manifest from this Source.
- Parameters:
-
uri URI struct with manifest location. cost Pointer to variable for the return value.
- Returns:
- Error code.
Definition at line 115 of file arm_uc_source.h.
| uint32_t(* GetVersion)(void) |
| arm_uc_error_t(* Initialize)(ARM_SOURCE_SignalEvent_t cb_event) |
Initialize Source.
Function pointer to event handler is passed as argument.
- Parameters:
-
cb_event Function pointer to event handler. See events above.
- Returns:
- Error code.
Definition at line 86 of file arm_uc_source.h.
| arm_uc_error_t(* Uninitialize)(void) |
Generated on Tue Jul 12 2022 16:24:24 by
1.7.2