Subversion Repositories HelenOS

Rev

Rev 4743 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
4707 mejdrech 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 
/** @file
34 
 *  ICMP module messages.
35 
 *  @see icmp_interface.h
36 
 */
37 
 
38 
#ifndef __NET_ICMP_MESSAGES__
39 
#define __NET_ICMP_MESSAGES__
40 
 
41 
#include <ipc/ipc.h>
42 
 
4715 mejdrech 43 
#include <sys/types.h>
44 
 
45 
#include "../../include/icmp_codes.h"
46 
 
4707 mejdrech 47 
#include "../../messages.h"
48 
 
49 
/** ICMP module messages.
50 
 */
51 
typedef enum{
52 
    /** Sends echo request.
53 
     *  @see icmp_echo()
54 
     */
55 
    NET_ICMP_ECHO = NET_ICMP_FIRST,
56 
    /** Sends destination unreachable error message.
57 
     *  @see icmp_destination_unreachable_msg()
58 
     */
59 
    NET_ICMP_DEST_UNREACH,
60 
    /** Sends source quench error message.
61 
     *  @see icmp_source_quench_msg()
62 
     */
63 
    NET_ICMP_SOURCE_QUENCH,
64 
    /** Sends time exceeded error message.
65 
     *  @see icmp_time_exceeded_msg()
66 
     */
67 
    NET_ICMP_TIME_EXCEEDED,
68 
    /** Sends parameter problem error message.
69 
     *  @see icmp_parameter_problem_msg()
70 
     */
71 
    NET_ICMP_PARAMETERPROB,
4715 mejdrech 72 
    /** Initializes new connection.
73 
     */
74 
    NET_ICMP_INIT
4707 mejdrech 75 
} icmp_messages;
76 
 
77 
/** @name ICMP specific message parameters definitions
78 
 */
79 
/*@{*/
80 
 
81 
/** Returns the ICMP code message parameter.
4756 mejdrech 82 
 *  @param[in] call The message call structure.
4707 mejdrech 83 
 */
4720 mejdrech 84 
#define ICMP_GET_CODE( call )       ( icmp_code_t ) IPC_GET_ARG1( * call )
4707 mejdrech 85 
 
4715 mejdrech 86 
/** Returns the ICMP link MTU message parameter.
4756 mejdrech 87 
 *  @param[in] call The message call structure.
4707 mejdrech 88 
 */
4720 mejdrech 89 
#define ICMP_GET_MTU( call )        ( icmp_param_t ) IPC_GET_ARG3( * call )
4707 mejdrech 90 
 
4715 mejdrech 91 
/** Returns the pointer message parameter.
4756 mejdrech 92 
 *  @param[in] call The message call structure.
4707 mejdrech 93 
 */
4720 mejdrech 94 
#define ICMP_GET_POINTER( call )        ( icmp_param_t ) IPC_GET_ARG3( * call )
4707 mejdrech 95 
 
4715 mejdrech 96 
/** Returns the size message parameter.
4756 mejdrech 97 
 *  @param[in] call The message call structure.
4707 mejdrech 98 
 */
4715 mejdrech 99 
#define ICMP_GET_SIZE( call )   ( size_t ) IPC_GET_ARG1( call )
4707 mejdrech 100 
 
4715 mejdrech 101 
/** Returns the timeout message parameter.
4756 mejdrech 102 
 *  @param[in] call The message call structure.
4707 mejdrech 103 
 */
4720 mejdrech 104 
#define ICMP_GET_TIMEOUT( call )    (( suseconds_t ) IPC_GET_ARG2( call ))
4707 mejdrech 105 
 
4715 mejdrech 106 
/** Returns the time to live message parameter.
4756 mejdrech 107 
 *  @param[in] call The message call structure.
4715 mejdrech 108 
 */
109 
#define ICMP_GET_TTL( call )    ( ip_ttl_t ) IPC_GET_ARG3( call )
110 
 
111 
/** Returns the type of service message parameter.
4756 mejdrech 112 
 *  @param[in] call The message call structure.
4715 mejdrech 113 
 */
114 
#define ICMP_GET_TOS( call )    ( ip_tos_t ) IPC_GET_ARG4( call )
115 
 
116 
/** Returns the dont fragment message parameter.
4756 mejdrech 117 
 *  @param[in] call The message call structure.
4715 mejdrech 118 
 */
119 
#define ICMP_GET_DONT_FRAGMENT( call )      ( int ) IPC_GET_ARG5( call )
120 
 
4707 mejdrech 121 
/*@}*/
122 
 
123 
#endif
124 
 
125 
/** @}
126 
 */