1/**
2 * @file
3 * ICMP6 protocol definitions
4 */
5
6/*
7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without modification,
11 * are permitted provided that the following conditions are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright notice,
14 *    this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 *    this list of conditions and the following disclaimer in the documentation
17 *    and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 *    derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30 * OF SUCH DAMAGE.
31 *
32 * This file is part of the lwIP TCP/IP stack.
33 *
34 * Author: Adam Dunkels <adam@sics.se>
35 *
36 */
37#ifndef LWIP_HDR_PROT_ICMP6_H
38#define LWIP_HDR_PROT_ICMP6_H
39
40#include "lwip/arch.h"
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46/** ICMP type */
47enum icmp6_type {
48  /** Destination unreachable */
49  ICMP6_TYPE_DUR = 1,
50  /** Packet too big */
51  ICMP6_TYPE_PTB = 2,
52  /** Time exceeded */
53  ICMP6_TYPE_TE = 3,
54  /** Parameter problem */
55  ICMP6_TYPE_PP = 4,
56  /** Private experimentation */
57  ICMP6_TYPE_PE1 = 100,
58  /** Private experimentation */
59  ICMP6_TYPE_PE2 = 101,
60  /** Reserved for expansion of error messages */
61  ICMP6_TYPE_RSV_ERR = 127,
62
63  /** Echo request */
64  ICMP6_TYPE_EREQ = 128,
65  /** Echo reply */
66  ICMP6_TYPE_EREP = 129,
67  /** Multicast listener query */
68  ICMP6_TYPE_MLQ = 130,
69  /** Multicast listener report */
70  ICMP6_TYPE_MLR = 131,
71  /** Multicast listener done */
72  ICMP6_TYPE_MLD = 132,
73  /** Router solicitation */
74  ICMP6_TYPE_RS = 133,
75  /** Router advertisement */
76  ICMP6_TYPE_RA = 134,
77  /** Neighbor solicitation */
78  ICMP6_TYPE_NS = 135,
79  /** Neighbor advertisement */
80  ICMP6_TYPE_NA = 136,
81  /** Redirect */
82  ICMP6_TYPE_RD = 137,
83  /** Multicast router advertisement */
84  ICMP6_TYPE_MRA = 151,
85  /** Multicast router solicitation */
86  ICMP6_TYPE_MRS = 152,
87  /** Multicast router termination */
88  ICMP6_TYPE_MRT = 153,
89  /** Private experimentation */
90  ICMP6_TYPE_PE3 = 200,
91  /** Private experimentation */
92  ICMP6_TYPE_PE4 = 201,
93  /** Reserved for expansion of informational messages */
94  ICMP6_TYPE_RSV_INF = 255
95};
96
97/** ICMP destination unreachable codes */
98enum icmp6_dur_code {
99  /** No route to destination */
100  ICMP6_DUR_NO_ROUTE = 0,
101  /** Communication with destination administratively prohibited */
102  ICMP6_DUR_PROHIBITED = 1,
103  /** Beyond scope of source address */
104  ICMP6_DUR_SCOPE = 2,
105  /** Address unreachable */
106  ICMP6_DUR_ADDRESS = 3,
107  /** Port unreachable */
108  ICMP6_DUR_PORT = 4,
109  /** Source address failed ingress/egress policy */
110  ICMP6_DUR_POLICY = 5,
111  /** Reject route to destination */
112  ICMP6_DUR_REJECT_ROUTE = 6
113};
114
115/** ICMP time exceeded codes */
116enum icmp6_te_code {
117  /** Hop limit exceeded in transit */
118  ICMP6_TE_HL = 0,
119  /** Fragment reassembly time exceeded */
120  ICMP6_TE_FRAG = 1
121};
122
123/** ICMP parameter code */
124enum icmp6_pp_code {
125  /** Erroneous header field encountered */
126  ICMP6_PP_FIELD = 0,
127  /** Unrecognized next header type encountered */
128  ICMP6_PP_HEADER = 1,
129  /** Unrecognized IPv6 option encountered */
130  ICMP6_PP_OPTION = 2
131};
132
133/** This is the standard ICMP6 header. */
134#ifdef PACK_STRUCT_USE_INCLUDES
135#  include "arch/bpstruct.h"
136#endif
137PACK_STRUCT_BEGIN
138struct icmp6_hdr {
139  PACK_STRUCT_FLD_8(u8_t type);
140  PACK_STRUCT_FLD_8(u8_t code);
141  PACK_STRUCT_FIELD(u16_t chksum);
142  PACK_STRUCT_FIELD(u32_t data);
143} PACK_STRUCT_STRUCT;
144PACK_STRUCT_END
145#ifdef PACK_STRUCT_USE_INCLUDES
146#  include "arch/epstruct.h"
147#endif
148
149/** This is the ICMP6 header adapted for echo req/resp. */
150#ifdef PACK_STRUCT_USE_INCLUDES
151#  include "arch/bpstruct.h"
152#endif
153PACK_STRUCT_BEGIN
154struct icmp6_echo_hdr {
155  PACK_STRUCT_FLD_8(u8_t type);
156  PACK_STRUCT_FLD_8(u8_t code);
157  PACK_STRUCT_FIELD(u16_t chksum);
158  PACK_STRUCT_FIELD(u16_t id);
159  PACK_STRUCT_FIELD(u16_t seqno);
160} PACK_STRUCT_STRUCT;
161PACK_STRUCT_END
162#ifdef PACK_STRUCT_USE_INCLUDES
163#  include "arch/epstruct.h"
164#endif
165
166#ifdef __cplusplus
167}
168#endif
169
170#endif /* LWIP_HDR_PROT_ICMP6_H */
171