Ip4Icmp.h 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /** @file
  2. Header file for ICMP protocol.
  3. Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef __EFI_IP4_ICMP_H__
  7. #define __EFI_IP4_ICMP_H__
  8. //
  9. // ICMP type definitions
  10. //
  11. #define ICMP_ECHO_REPLY 0
  12. #define ICMP_DEST_UNREACHABLE 3
  13. #define ICMP_SOURCE_QUENCH 4
  14. #define ICMP_REDIRECT 5
  15. #define ICMP_ECHO_REQUEST 8
  16. #define ICMP_TIME_EXCEEDED 11
  17. #define ICMP_PARAMETER_PROBLEM 12
  18. #define ICMP_TIMESTAMP 13
  19. #define ICMP_INFO_REQUEST 15
  20. #define ICMP_INFO_REPLY 16
  21. #define ICMP_TYPE_MAX ICMP_INFO_REPLY
  22. #define ICMP_DEFAULT_CODE 0
  23. //
  24. // ICMP code definitions for ICMP_DEST_UNREACHABLE
  25. //
  26. #define ICMP_NET_UNREACHABLE 0
  27. #define ICMP_HOST_UNREACHABLE 1
  28. #define ICMP_PROTO_UNREACHABLE 2 // Host may generate
  29. #define ICMP_PORT_UNREACHABLE 3 // Host may generate
  30. #define ICMP_FRAGMENT_FAILED 4
  31. #define ICMP_SOURCEROUTE_FAILED 5 // Host may generate
  32. #define ICMP_NET_UNKNOWN 6
  33. #define ICMP_HOST_UNKNOWN 7
  34. #define ICMP_SOURCE_ISOLATED 8
  35. #define ICMP_NET_PROHIBITED 9
  36. #define ICMP_HOST_PROHIBITED 10
  37. #define ICMP_NET_UNREACHABLE_TOS 11
  38. #define ICMP_HOST_UNREACHABLE_TOS 12
  39. //
  40. // ICMP code definitions for ICMP_TIME_EXCEEDED
  41. //
  42. #define ICMP_TIMEOUT_IN_TRANSIT 0
  43. #define ICMP_TIMEOUT_REASSEMBLE 1 // Host may generate
  44. //
  45. // ICMP code definitions for ICMP_TIME_EXCEEDED
  46. //
  47. #define ICMP_NET_REDIRECT 0
  48. #define ICMP_HOST_REDIRECT 1
  49. #define ICMP_NET_TOS_REDIRECT 2
  50. #define ICMP_HOST_TOS_REDIRECT 3
  51. //
  52. // ICMP message classes, each class of ICMP message shares
  53. // a common message format. INVALID_MESSAGE is only a flag.
  54. //
  55. #define ICMP_INVALID_MESSAGE 0
  56. #define ICMP_ERROR_MESSAGE 1
  57. #define ICMP_QUERY_MESSAGE 2
  58. typedef struct {
  59. UINT8 IcmpType;
  60. UINT8 IcmpClass;
  61. } IP4_ICMP_CLASS;
  62. extern IP4_ICMP_CLASS mIcmpClass[];
  63. extern EFI_IP4_ICMP_TYPE mIp4SupportedIcmp[];
  64. /**
  65. Handle the ICMP packet. First validate the message format,
  66. then according to the message types, process it as query or
  67. error packet.
  68. @param[in] IpSb The IP4 service that receivd the packet.
  69. @param[in] Head The IP4 head of the ICMP query packet.
  70. @param[in] Packet The content of the ICMP query with IP4 head
  71. removed.
  72. @retval EFI_INVALID_PARAMETER The packet is malformatted.
  73. @retval EFI_SUCCESS The ICMP message is successfully processed.
  74. @retval Others Failed to handle ICMP packet.
  75. **/
  76. EFI_STATUS
  77. Ip4IcmpHandle (
  78. IN IP4_SERVICE *IpSb,
  79. IN IP4_HEAD *Head,
  80. IN NET_BUF *Packet
  81. );
  82. #endif