| [21580dd] | 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 icmp
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | #ifndef __NET_ICMP_INTERFACE_H__
|
|---|
| 34 | #define __NET_ICMP_INTERFACE_H__
|
|---|
| 35 |
|
|---|
| [058edb6] | 36 | #include <net/socket_codes.h>
|
|---|
| [21580dd] | 37 | #include <sys/types.h>
|
|---|
| 38 |
|
|---|
| [e526f08] | 39 | #include <net/device.h>
|
|---|
| [849ed54] | 40 | #include <adt/measured_strings.h>
|
|---|
| [c69d327] | 41 | #include <net/packet.h>
|
|---|
| [e4554d4] | 42 | #include <net/inet.h>
|
|---|
| [ff2a62d] | 43 | #include <net/ip_codes.h>
|
|---|
| [753bca3] | 44 | #include <net/icmp_codes.h>
|
|---|
| 45 | #include <net/icmp_common.h>
|
|---|
| [21580dd] | 46 |
|
|---|
| 47 | /** @name ICMP module interface
|
|---|
| 48 | * This interface is used by other modules.
|
|---|
| 49 | */
|
|---|
| 50 | /*@{*/
|
|---|
| 51 |
|
|---|
| 52 | /** Sends the Destination Unreachable error notification packet.
|
|---|
| 53 | * Beginning of the packet is sent as the notification packet data.
|
|---|
| 54 | * The source and the destination addresses should be set in the original packet.
|
|---|
| 55 | * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
|
|---|
| 56 | * @param[in] code The error specific code.
|
|---|
| 57 | * @param[in] mtu The error MTU value.
|
|---|
| 58 | * @param[in] packet The original packet.
|
|---|
| 59 | * @returns EOK on success.
|
|---|
| 60 | * @returns EPERM if the ICMP error notifications are disabled.
|
|---|
| 61 | * @returns ENOMEM if there is not enough memory left.
|
|---|
| 62 | */
|
|---|
| [849ed54] | 63 | extern int icmp_destination_unreachable_msg(int icmp_phone, icmp_code_t code, icmp_param_t mtu, packet_t packet);
|
|---|
| [21580dd] | 64 |
|
|---|
| 65 | /** Sends the Source Quench error notification packet.
|
|---|
| 66 | * Beginning of the packet is sent as the notification packet data.
|
|---|
| 67 | * The source and the destination addresses should be set in the original packet.
|
|---|
| 68 | * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
|
|---|
| 69 | * @param[in] packet The original packet.
|
|---|
| 70 | * @returns EOK on success.
|
|---|
| 71 | * @returns EPERM if the ICMP error notifications are disabled.
|
|---|
| 72 | * @returns ENOMEM if there is not enough memory left.
|
|---|
| 73 | */
|
|---|
| [849ed54] | 74 | extern int icmp_source_quench_msg(int icmp_phone, packet_t packet);
|
|---|
| [21580dd] | 75 |
|
|---|
| 76 | /** Sends the Time Exceeded error notification packet.
|
|---|
| 77 | * Beginning of the packet is sent as the notification packet data.
|
|---|
| 78 | * The source and the destination addresses should be set in the original packet.
|
|---|
| 79 | * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
|
|---|
| 80 | * @param[in] code The error specific code.
|
|---|
| 81 | * @param[in] packet The original packet.
|
|---|
| 82 | * @returns EOK on success.
|
|---|
| 83 | * @returns EPERM if the ICMP error notifications are disabled.
|
|---|
| 84 | * @returns ENOMEM if there is not enough memory left.
|
|---|
| 85 | */
|
|---|
| [849ed54] | 86 | extern int icmp_time_exceeded_msg(int icmp_phone, icmp_code_t code, packet_t packet);
|
|---|
| [21580dd] | 87 |
|
|---|
| 88 | /** Sends the Parameter Problem error notification packet.
|
|---|
| 89 | * Beginning of the packet is sent as the notification packet data.
|
|---|
| 90 | * The source and the destination addresses should be set in the original packet.
|
|---|
| 91 | * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
|
|---|
| 92 | * @param[in] code The error specific code.
|
|---|
| 93 | * @param[in] pointer The problematic parameter offset.
|
|---|
| 94 | * @param[in] packet The original packet.
|
|---|
| 95 | * @returns EOK on success.
|
|---|
| 96 | * @returns EPERM if the ICMP error notifications are disabled.
|
|---|
| 97 | * @returns ENOMEM if there is not enough memory left.
|
|---|
| 98 | */
|
|---|
| [849ed54] | 99 | extern int icmp_parameter_problem_msg(int icmp_phone, icmp_code_t code, icmp_param_t pointer, packet_t packet);
|
|---|
| [21580dd] | 100 |
|
|---|
| 101 | /*@}*/
|
|---|
| 102 |
|
|---|
| 103 | #endif
|
|---|
| 104 |
|
|---|
| 105 | /** @}
|
|---|
| 106 | */
|
|---|
