oc_icmp.h

Go to the documentation of this file.

#ifndef SYSTEM_CORE_INC_NET_PROTOCOLS_ICMP_OC_ICMP_H_
#define SYSTEM_CORE_INC_NET_PROTOCOLS_ICMP_OC_ICMP_H_

#include <oc_net.h>
#include <oc_process.h>
#include <oc_netif.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Icmp_Type_EchoReply                      = 0 , 
    oC_Icmp_Type_DestinationUnreachable         = 3 , 
    oC_Icmp_Type_SourceQuench                   = 4 , 
    oC_Icmp_Type_RedirectMessage                = 5 , 
    oC_Icmp_Type_EchoRequest                    = 8 , 
    oC_Icmp_Type_RouterAdvertisement            = 9 , 
    oC_Icmp_Type_RouterSolicitation             = 10 ,
    oC_Icmp_Type_TimeExceeded                   = 11 ,
    oC_Icmp_Type_ParameterProblemBadIpHeader    = 12 ,
    oC_Icmp_Type_Timestamp                      = 13 ,
    oC_Icmp_Type_TimestampReply                 = 14 ,
    oC_Icmp_Type_InformationRequest             = 15 ,
    oC_Icmp_Type_InformationReply               = 16 ,
    oC_Icmp_Type_AddressMaskRequest             = 17 ,
    oC_Icmp_Type_AddressMaskReply               = 18, 


    oC_Icmp_Type_Empty                          = 0xFF
} oC_Icmp_Type_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    uint8_t     Type;           
    uint8_t     Code;           
    uint16_t    Checksum;       
} oC_Icmp_Header_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    uint16_t    ID;                 
    uint16_t    SequenceNumber;     
    uint32_t    Payload[40];        
} oC_Icmp_Message_Echo_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    uint16_t    ID;                     
    uint16_t    SequenceNumber;         
    uint32_t    OriginateTimestamp;
    uint32_t    ReceiveTimestamp;
    uint32_t    TransmitTimestamp;
} oC_Icmp_Message_Timestamp_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    uint16_t    ID;                     
    uint16_t    SequenceNumber;         
    uint32_t    AddressMask;            
} oC_Icmp_Message_AddressMask_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    uint16_t                    Unused;
    uint16_t                    NextHopMtu;
    oC_Net_Ipv4PacketHeader_t   IPv4Header;
    uint8_t                     Data[8];
} oC_Icmp_Message_DestinationUnreachable_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    oC_Icmp_Header_t    Header;         
    union
    {
        uint8_t                                     Payload[4];                 
        oC_Icmp_Message_Echo_t                      Echo;                       
        oC_Icmp_Message_Timestamp_t                 Timestamp;                  
        oC_Icmp_Message_AddressMask_t               AddressMask;                
        oC_Icmp_Message_DestinationUnreachable_t    DestinationUnreachable;     
    } Message;
} oC_Icmp_Datagram_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef union
{
    oC_Net_Packet_t         Packet;     

    struct
    {
        oC_Net_Ipv4PacketHeader_t   Header;         
        oC_Icmp_Datagram_t          IcmpDatagram;   
    } IPv4;

    struct
    {
        oC_Net_Ipv6PacketHeader_t   Header;         
        oC_Icmp_Datagram_t          IcmpDatagram;   
    } IPv6;
} oC_Icmp_Packet_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________PROTOTYPES_SECTION_________________________________________________________________________

extern oC_ErrorCode_t       oC_Icmp_TurnOn                      ( void );
extern oC_ErrorCode_t       oC_Icmp_TurnOff                     ( void );
extern bool                 oC_Icmp_IsTypeReserved              ( oC_Icmp_Type_t Type    , oC_Process_t Process );
extern oC_ErrorCode_t       oC_Icmp_ReserveType                 ( oC_Icmp_Type_t Type    , oC_Time_t    Timeout );
extern oC_ErrorCode_t       oC_Icmp_ReleaseType                 ( oC_Icmp_Type_t Type    , oC_Time_t    Timeout );
extern oC_ErrorCode_t       oC_Icmp_ReleaseAllTypesReservedBy   ( oC_Process_t   Process , oC_Time_t    Timeout );
extern oC_ErrorCode_t       oC_Icmp_CalculateChecksum           ( oC_Icmp_Packet_t * Packet , uint16_t * outChecksum );
extern oC_Icmp_Packet_t*    oC_Icmp_Packet_New                  ( Allocator_t PacketAllocator , oC_Net_PacketType_t Type , oC_Icmp_Type_t IcmpType , uint8_t Code , const void * Data , uint16_t Size );
extern bool                 oC_Icmp_Packet_SetSize              ( oC_Icmp_Packet_t * Packet , uint16_t Size );
extern bool                 oC_Icmp_Packet_Delete               ( oC_Icmp_Packet_t ** Packet );
extern void *               oC_Icmp_Packet_GetMessageReference  ( oC_Icmp_Packet_t * Packet );
extern oC_ErrorCode_t       oC_Icmp_Send                        ( oC_Netif_t Netif , const oC_Net_Address_t * Destination , oC_Icmp_Packet_t * Packet , oC_Time_t Timeout );
extern oC_ErrorCode_t       oC_Icmp_Receive                     ( oC_Netif_t Netif , oC_Icmp_Packet_t * outPacket , oC_Icmp_Type_t Type , oC_Time_t Timeout );

#undef  _________________________________________PROTOTYPES_SECTION_________________________________________________________________________


#endif /* SYSTEM_CORE_INC_NET_PROTOCOLS_ICMP_OC_ICMP_H_ */