ifx-protocol.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG
// SPDX-License-Identifier: MIT
 
#ifndef IFX_PROTOCOL_H
#define IFX_PROTOCOL_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "infineon/ifx-error.h"
#include "infineon/ifx-logger.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LIB_PROTOCOL                    UINT8_C(0x20)
 
#define IFX_PROTOCOL_ACTIVATE           UINT8_C(0x01)
 
#define IFX_PROTOCOL_TRANSMIT           UINT8_C(0x02)
 
#define IFX_PROTOCOL_RECEIVE            UINT8_C(0x03)
 
#define IFX_PROTOCOL_RECEIVE_LEN_UNKOWN SIZE_MAX
 
#define IFX_PROTOCOL_LAYER_INITIALIZE   UINT8_C(0x04)
 
#define IFX_PROTOCOL_TRANSCEIVE         UINT8_C(0x05)
 
#define IFX_PROTOCOL_STACK_INVALID      UINT8_C(0x01)
 
// Forward declaration only
typedef struct ifx_protocol ifx_protocol_t;
 
typedef ifx_status_t (*ifx_protocol_activate_callback_t)(ifx_protocol_t *self,
                                                         uint8_t **response,
                                                         size_t *response_len);
 
ifx_status_t ifx_protocol_activate(ifx_protocol_t *self, uint8_t **response,
                                   size_t *response_len);
 
typedef ifx_status_t (*ifx_protocol_transceive_callback_t)(
    ifx_protocol_t *self, const uint8_t *data, size_t data_len,
    uint8_t **response, size_t *response_len);
 
ifx_status_t ifx_protocol_transceive(ifx_protocol_t *self, const uint8_t *data,
                                     size_t data_len, uint8_t **response,
                                     size_t *response_len);
 
typedef ifx_status_t (*ifx_protocol_transmit_callback_t)(ifx_protocol_t *self,
                                                         const uint8_t *data,
                                                         size_t data_len);
 
typedef ifx_status_t (*ifx_protocol_receive_callback_t)(ifx_protocol_t *self,
                                                        size_t expected_len,
                                                        uint8_t **response,
                                                        size_t *response_len);
 
typedef void (*ifx_protocol_destroy_callback_t)(ifx_protocol_t *self);
 
void ifx_protocol_destroy(ifx_protocol_t *self);
 
void ifx_protocol_set_logger(ifx_protocol_t *self, ifx_logger_t *logger);
 
ifx_status_t ifx_protocol_layer_initialize(ifx_protocol_t *self);
 
struct ifx_protocol
{
    ifx_protocol_t *_base;
 
    uint64_t _layer_id;
 
    ifx_protocol_activate_callback_t _activate;
 
    ifx_protocol_transceive_callback_t _transceive;
 
    ifx_protocol_transmit_callback_t _transmit;
 
    ifx_protocol_receive_callback_t _receive;
 
    ifx_protocol_destroy_callback_t _destructor;
 
    ifx_logger_t *_logger;
 
    void *_properties;
};
 
#ifdef __cplusplus
}
#endif
 
#endif // IFX_PROTOCOL_H