ifx-error.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG
// SPDX-License-Identifier: MIT
 
#ifndef IFX_ERROR_H
#define IFX_ERROR_H
 
#include <stdbool.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
 
#define IFX_MODULE(library_id, module_id)                                      \
    (uint16_t) (((library_id & 0x7F) << 8) | (module_id & 0xFF))
 
#define IFX_SUCCESS           ((ifx_status_t) 0x00000000)
 
#define IFX_ERROR_INDICATOR   ((ifx_status_t) 0x80000000u)
 
#define IFX_UNSPECIFIED_ERROR ((uint8_t) 0xffu)
 
#define IFX_OUT_OF_MEMORY     ((uint8_t) 0xfeu)
 
#define IFX_ILLEGAL_ARGUMENT  ((uint8_t) 0xfdu)
 
#define IFX_TOO_LITTLE_DATA   ((uint8_t) 0xfcu)
 
#define IFX_INVALID_STATE     ((uint8_t) 0xfbu)
 
#define IFX_PROGRAMMING_ERROR ((uint8_t) 0xfau)
 
#define IFX_ERROR(module, function, reason)                                    \
    ((ifx_status_t) (IFX_ERROR_INDICATOR | (((module >> 8) & 0x7Fu) << 24) |   \
                     (((module) & 0xFFu) << 16) |                              \
                     (((function) & 0xFFu) << 8) | ((reason) & 0xFFu)))
 
typedef uint32_t ifx_status_t;
 
bool ifx_error_check(ifx_status_t status_code);
 
uint8_t ifx_error_get_library(ifx_status_t error_code);
 
uint8_t ifx_error_get_module(ifx_status_t error_code);
 
uint8_t ifx_error_get_function(ifx_status_t error_code);
 
uint8_t ifx_error_get_reason(ifx_status_t error_code);
 
#ifdef __cplusplus
}
#endif
 
#endif // IFX_ERROR_H