ifx-record-error.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG
// SPDX-License-Identifier: MIT
 
#ifndef IFX_RECORD_ERROR_H
#define IFX_RECORD_ERROR_H
 
#include <stddef.h>
#include <stdint.h>
#include "infineon/ifx-error.h"
#include "infineon/ifx-utils.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* Macro definitions */
/* Definitions of function identifiers */
 
#define IFX_RECORD_ERROR_SET            UINT8_C(0x01)
 
#define IFX_RECORD_ERROR_GET            UINT8_C(0x02)
 
#define IFX_RECORD_ERROR_RELEASE_MEMORY UINT8_C(0x03)
 
#define IFX_RECORD_ERROR_TYPE           {0x65, 0x72, 0x72}
 
/* Structure definitions */
typedef struct
{
    uint8_t error_reason; 
    ifx_blob_t
        *error; 
} ifx_record_error_t;
 
/* public functions */
 
ifx_status_t ifx_record_error_new(ifx_record_handle_t *handle);
 
ifx_status_t ifx_record_error_set_reason(ifx_record_handle_t *handle,
                                         uint8_t error_reason);
 
ifx_status_t ifx_record_error_set_error_data(ifx_record_handle_t *handle,
                                             const ifx_blob_t *error);
 
ifx_status_t ifx_record_error_get_reason(const ifx_record_handle_t *handle,
                                         uint8_t *error_reason);
 
ifx_status_t ifx_record_error_get_error_data(const ifx_record_handle_t *handle,
                                             ifx_blob_t *error);
 
#ifdef __cplusplus
}
 
#endif /* __cplusplus */
#endif /* IFX_RECORD_ERROR_H */