hsw-nbt 1.2.0
OPTIGA Authenticate NBT Host Library for C
ifx-record-handover-select.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG
2// SPDX-License-Identifier: MIT
3
9#ifndef IFX_RECORD_HANDOVER_SELECT_H
10#define IFX_RECORD_HANDOVER_SELECT_H
11
12#include <stddef.h>
13#include <stdint.h>
14#include "infineon/ifx-error.h"
15#include "infineon/ifx-utils.h"
16
17#ifdef __cplusplus
18extern "C" {
19#endif /* __cplusplus */
20
21/* Macro definitions */
22/* Definitions of function identifiers */
23
27#define IFX_RECORD_HS_SET UINT8_C(0x01)
28
32#define IFX_RECORD_HS_GET UINT8_C(0x02)
33
37#define IFX_RECORD_HS_RELEASE_MEMORY UINT8_C(0x03)
41#define IFX_RECORD_HS_TYPE {0x48, 0x73}
42
43/* Structure definitions */
44
57
58/* public functions */
59
71
84 uint8_t major_version);
85
98 uint8_t minor_version);
99
116 ifx_record_handle_t *handle,
117 const ifx_local_record_handles_t *local_record_list,
118 uint32_t count_of_local_records);
119
133 uint8_t *major_version);
134
148 uint8_t *minor_version);
149
164 const ifx_record_handle_t *handle,
165 ifx_local_record_handles_t *local_record_list,
166 uint32_t *count_of_local_records);
167
168#ifdef __cplusplus
169}
170
171#endif /* __cplusplus */
172#endif /* IFX_RECORD_HANDOVER_SELECT_H */
Infineon specific error code creation and parsing.
uint32_t ifx_status_t
Custom return code type used by all Infineon host software libraries.
Definition ifx-error.h:91
ifx_status_t ifx_record_hs_set_major_ver(ifx_record_handle_t *handle, uint8_t major_version)
Sets the major version in the handover select record details for the given record handle.
ifx_status_t ifx_record_hs_new(ifx_record_handle_t *handle)
Creates a new handover select record and handle of the created record. This handle holds the values o...
ifx_status_t ifx_record_hs_set_local_records(ifx_record_handle_t *handle, const ifx_local_record_handles_t *local_record_list, uint32_t count_of_local_records)
Sets the list of local records (alternative carrier and error records) to the handover select record ...
ifx_status_t ifx_record_hs_get_local_records(const ifx_record_handle_t *handle, ifx_local_record_handles_t *local_record_list, uint32_t *count_of_local_records)
Gets the list of local records from the given record handle.
ifx_status_t ifx_record_hs_set_minor_ver(ifx_record_handle_t *handle, uint8_t minor_version)
Sets the minor version in handover select record details for the given record handle.
ifx_status_t ifx_record_hs_get_major_ver(const ifx_record_handle_t *handle, uint8_t *major_version)
Gets the major version of the handover select record from the given record handle.
ifx_status_t ifx_record_hs_get_minor_ver(const ifx_record_handle_t *handle, uint8_t *minor_version)
Gets the minor version of handover select record from the given record handle.
Provides utility functions and macros.
This Structure holds the list of alternate carrier record handles and a single error record,...
ifx_record_handle_t ** alt_carrier_rec_list
Defines the handle for specific record type.