| 1 | /*
|
|---|
| 2 | * Copyright (c) 2009 Lukas Mejdrech
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libc
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | /** @file
|
|---|
| 34 | * ICMP module messages.
|
|---|
| 35 | * @see icmp_remote.h
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | #ifndef LIBC_ICMP_MESSAGES_
|
|---|
| 39 | #define LIBC_ICMP_MESSAGES_
|
|---|
| 40 |
|
|---|
| 41 | #include <ipc/ipc.h>
|
|---|
| 42 | #include <ipc/net.h>
|
|---|
| 43 | #include <sys/types.h>
|
|---|
| 44 | #include <sys/time.h>
|
|---|
| 45 |
|
|---|
| 46 | #include <net/icmp_codes.h>
|
|---|
| 47 |
|
|---|
| 48 | /** ICMP module messages. */
|
|---|
| 49 | typedef enum {
|
|---|
| 50 | /** Send echo request. @see icmp_echo() */
|
|---|
| 51 | NET_ICMP_ECHO = NET_ICMP_FIRST,
|
|---|
| 52 |
|
|---|
| 53 | /**
|
|---|
| 54 | * Send destination unreachable error message.
|
|---|
| 55 | * @see icmp_destination_unreachable_msg()
|
|---|
| 56 | */
|
|---|
| 57 | NET_ICMP_DEST_UNREACH,
|
|---|
| 58 |
|
|---|
| 59 | /**
|
|---|
| 60 | * Send source quench error message.
|
|---|
| 61 | * @see icmp_source_quench_msg()
|
|---|
| 62 | */
|
|---|
| 63 | NET_ICMP_SOURCE_QUENCH,
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * Send time exceeded error message.
|
|---|
| 67 | * @see icmp_time_exceeded_msg()
|
|---|
| 68 | */
|
|---|
| 69 | NET_ICMP_TIME_EXCEEDED,
|
|---|
| 70 |
|
|---|
| 71 | /**
|
|---|
| 72 | * Send parameter problem error message.
|
|---|
| 73 | * @see icmp_parameter_problem_msg()
|
|---|
| 74 | */
|
|---|
| 75 | NET_ICMP_PARAMETERPROB
|
|---|
| 76 | } icmp_messages_t;
|
|---|
| 77 |
|
|---|
| 78 | /** @name ICMP specific message parameters definitions */
|
|---|
| 79 | /*@{*/
|
|---|
| 80 |
|
|---|
| 81 | /** Return the ICMP code message parameter.
|
|---|
| 82 | *
|
|---|
| 83 | * @param[in] call Message call structure.
|
|---|
| 84 | *
|
|---|
| 85 | */
|
|---|
| 86 | #define ICMP_GET_CODE(call) ((icmp_code_t) IPC_GET_ARG1(call))
|
|---|
| 87 |
|
|---|
| 88 | /** Return the ICMP link MTU message parameter.
|
|---|
| 89 | *
|
|---|
| 90 | * @param[in] call Message call structure.
|
|---|
| 91 | *
|
|---|
| 92 | */
|
|---|
| 93 | #define ICMP_GET_MTU(call) ((icmp_param_t) IPC_GET_ARG3(call))
|
|---|
| 94 |
|
|---|
| 95 | /** Return the pointer message parameter.
|
|---|
| 96 | *
|
|---|
| 97 | * @param[in] call Message call structure.
|
|---|
| 98 | *
|
|---|
| 99 | */
|
|---|
| 100 | #define ICMP_GET_POINTER(call) ((icmp_param_t) IPC_GET_ARG3(call))
|
|---|
| 101 |
|
|---|
| 102 | /** Return the size message parameter.
|
|---|
| 103 | *
|
|---|
| 104 | * @param[in] call Message call structure.
|
|---|
| 105 | *
|
|---|
| 106 | */
|
|---|
| 107 | #define ICMP_GET_SIZE(call) ((size_t) IPC_GET_ARG1(call))
|
|---|
| 108 |
|
|---|
| 109 | /** Return the timeout message parameter.
|
|---|
| 110 | *
|
|---|
| 111 | * @param[in] call Message call structure.
|
|---|
| 112 | *
|
|---|
| 113 | */
|
|---|
| 114 | #define ICMP_GET_TIMEOUT(call) ((suseconds_t) IPC_GET_ARG2(call))
|
|---|
| 115 |
|
|---|
| 116 | /** Return the time to live message parameter.
|
|---|
| 117 | *
|
|---|
| 118 | * @param[in] call Message call structure.
|
|---|
| 119 | *
|
|---|
| 120 | */
|
|---|
| 121 | #define ICMP_GET_TTL(call) ((ip_ttl_t) IPC_GET_ARG3(call))
|
|---|
| 122 |
|
|---|
| 123 | /** Return the type of service message parameter.
|
|---|
| 124 | *
|
|---|
| 125 | * @param[in] call Message call structure.
|
|---|
| 126 | *
|
|---|
| 127 | */
|
|---|
| 128 | #define ICMP_GET_TOS(call) ((ip_tos_t) IPC_GET_ARG4(call))
|
|---|
| 129 |
|
|---|
| 130 | /** Return the dont fragment message parameter.
|
|---|
| 131 | *
|
|---|
| 132 | * @param[in] call Message call structure.
|
|---|
| 133 | */
|
|---|
| 134 | #define ICMP_GET_DONT_FRAGMENT(call) ((int) IPC_GET_ARG5(call))
|
|---|
| 135 |
|
|---|
| 136 | /*@}*/
|
|---|
| 137 |
|
|---|
| 138 | #endif
|
|---|
| 139 |
|
|---|
| 140 | /** @}
|
|---|
| 141 | */
|
|---|
