tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for ICMP.c.
  34  */
  35
  36 #ifndef _ICMP_H_
  37 #define _ICMP_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <string.h>
  42
  43                 #include "EthernetProtocols.h"
  44                 #include "Ethernet.h"
  45                 #include "ProtocolDecoders.h"
  46
  47         /* Macros: */
  48                 /** ICMP message type constant, indicating an ICMP ECHO Reply message. */
  49                 #define ICMP_TYPE_ECHOREPLY              0
  50
  51                 /** ICMP message type constant, indicating a packet destination is unreachable. */
  52                 #define ICMP_TYPE_DESTINATIONUNREACHABLE 3
  53
  54                 /** ICMP message type constant, indicating an ICMP Source Quench message. */
  55                 #define ICMP_TYPE_SOURCEQUENCH           4
  56
  57                 /** ICMP message type constant, indicating an ICMP Redirect message. */
  58                 #define ICMP_TYPE_REDIRECTMESSAGE        5
  59
  60                 /** ICMP message type constant, indicating an ICMP ECHO Request message. */
  61                 #define ICMP_TYPE_ECHOREQUEST            8
  62
  63                 /** ICMP message type constant, indicating an ICMP Time Exceeded message. */
  64                 #define ICMP_TYPE_TIMEEXCEEDED           11
  65
  66         /* Type Defines: */
  67                 /** Type define for an ICMP message header. */
  68                 typedef struct
  69                 {
  70                         uint8_t       Type; /**< ICMP message type, an \c ICMP_TYPE_* constant */
  71                         uint8_t       Code; /**< ICMP message code, indicating the message value */
  72                         uint16_t      Checksum; /**< Ethernet checksum of the ICMP message */
  73                         uint16_t      Id; /**< Id of the ICMP message */
  74                         uint16_t      Sequence; /**< Sequence number of the ICMP message, to link together message responses */
  75                 } ICMP_Header_t;
  76
  77         /* Function Prototypes: */
  78                 int16_t ICMP_ProcessICMPPacket(Ethernet_Frame_Info_t* const FrameIN,
  79                                                void* InDataStart,
  80                                                void* OutDataStart);
  81
  82 #endif
  83