adapter_efa_probe.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_ADAPTER_EFA_PROBE_H__
#define CDI_ADAPTER_EFA_PROBE_H__
 
#include "adapter_api.h"
#include "adapter_control_interface.h"
#include "private.h"
#include "protocol.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef struct ProbeEndpointState ProbeEndpointState;
typedef ProbeEndpointState* ProbeEndpointHandle;
 
typedef enum {
    kProbeStateIdle,
 
    kProbeStateSendReset,
 
    kProbeStateSendProtocolVersion,
 
    kProbeStateResetting,
 
    kProbeStateResetDone,
 
    kProbeStateWaitForStart,
 
    kProbeStateEfaStart,
 
    kProbeStateEfaProbe,
 
    kProbeStateEfaTxProbeAcks,
 
    kProbeStateEfaConnected,
 
    kProbeStateEfaConnectedPing,
 
    kProbeStateEfaReset,
 
    kProbeStateDestroy,
} ProbeState;
 
typedef struct {
    ProbeState tx_state;      
    int send_command_retry_count;
    int packets_enqueued_count; 
    int packets_acked_count; 
    int packets_ack_wait_count; 
} TxEndpointProbeState;
 
typedef struct {
    ProbeState rx_state;        
    int send_reset_retry_count;
    int packets_received_count; 
    uint32_t total_packet_count_snapshot; 
} RxEndpointProbeState;
 
typedef struct ProbeEndpointState ProbeEndpointState;
 
struct ProbeEndpointState {
    MessageFromEndpoint app_msg_from_endpoint_func_ptr; 
    void* app_msg_from_endpoint_param_ptr; 
 
    AdapterEndpointHandle app_adapter_endpoint_handle; 
    union {
        TxEndpointProbeState tx_probe_state;
        RxEndpointProbeState rx_probe_state;
    };
 
    CdiLogHandle log_handle; 
 
    CdiThreadID probe_thread_id;   
 
    CdiFifoHandle control_packet_fifo_handle;
 
    uint16_t control_packet_num;
 
    CdiCsID ack_lock;                
    bool ack_is_pending;             
    ProbeCommand ack_command;        
    uint16_t ack_control_packet_num;
 
    bool send_ack_command_valid;     
    ProbeCommand send_ack_command;   
    uint16_t send_ack_control_packet_num; 
    uint8_t send_ack_probe_version; 
 
    CdiProtocolHandle protocol_handle_sdk;
    CdiProtocolHandle protocol_handle_v1; 
};
 
typedef struct {
    Packet packet;          
    CdiSglEntry sgl_entry;  
    CdiRawProbeHeader packet_data; 
} ProbePacketWorkRequest;
 
typedef enum {
    kCommandTypeStateChange, 
    kCommandTypeRxPacket,    
} ControlCommandType;
 
typedef struct {
    ControlCommandType command_type; 
    union {
        ProbeState probe_state; 
        struct {
            CdiSgList packet_sgl; 
            struct sockaddr_in source_address; 
        } receive_packet; 
    };
} ControlCommand;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CdiReturnStatus ProbeEndpointCreate(AdapterEndpointHandle app_adapter_endpoint_handle,
                                    CdiLogHandle log_handle, ProbeEndpointHandle* ret_handle_ptr);
 
CdiReturnStatus ProbeEndpointError(ProbeEndpointHandle handle);
 
void ProbeEndpointReset(ProbeEndpointHandle handle);
 
CdiReturnStatus ProbeEndpointResetDone(ProbeEndpointHandle handle);
 
CdiReturnStatus ProbeEndpointStart(ProbeEndpointHandle handle);
 
void ProbeEndpointStop(ProbeEndpointHandle handle);
 
void ProbeEndpointDestroy(ProbeEndpointHandle handle);
 
#endif  // CDI_ADAPTER_EFA_PROBE_H__