Subversion Repositories HelenOS

Rev

Rev 4719 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  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.  
  43. #include <sys/types.h>
  44.  
  45. #include "../../include/icmp_codes.h"
  46.  
  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 redirect error message.
  65.      *  @see icmp_redirect_msg()
  66.      */
  67.     NET_ICMP_REDIRECT,
  68.     /** Sends time exceeded error message.
  69.      *  @see icmp_time_exceeded_msg()
  70.      */
  71.     NET_ICMP_TIME_EXCEEDED,
  72.     /** Sends parameter problem error message.
  73.      *  @see icmp_parameter_problem_msg()
  74.      */
  75.     NET_ICMP_PARAMETERPROB,
  76.     /** Initializes new connection.
  77.      */
  78.     NET_ICMP_INIT
  79. } icmp_messages;
  80.  
  81. /** @name ICMP specific message parameters definitions
  82.  */
  83. /*@{*/
  84.  
  85. /** Returns the ICMP code message parameter.
  86.  *  @param call The message call structure. Input parameter.
  87.  */
  88. #define ICMP_GET_CODE( call )       ( icmp_code_t ) IPC_GET_ARG1( * call )
  89.  
  90. /** Returns the ICMP link MTU message parameter.
  91.  *  @param call The message call structure. Input parameter.
  92.  */
  93. #define ICMP_GET_MTU( call )        ( icmp_param_t ) IPC_GET_ARG3( * call )
  94.  
  95. /** Returns the pointer message parameter.
  96.  *  @param call The message call structure. Input parameter.
  97.  */
  98. #define ICMP_GET_POINTER( call )        ( icmp_param_t ) IPC_GET_ARG3( * call )
  99.  
  100. /** Returns the size message parameter.
  101.  *  @param call The message call structure. Input parameter.
  102.  */
  103. #define ICMP_GET_SIZE( call )   ( size_t ) IPC_GET_ARG1( call )
  104.  
  105. /** Returns the timeout message parameter.
  106.  *  @param call The message call structure. Input parameter.
  107.  */
  108. #define ICMP_GET_TIMEOUT( call )    (( suseconds_t ) IPC_GET_ARG2( call ))
  109.  
  110. /** Returns the time to live message parameter.
  111.  *  @param call The message call structure. Input parameter.
  112.  */
  113. #define ICMP_GET_TTL( call )    ( ip_ttl_t ) IPC_GET_ARG3( call )
  114.  
  115. /** Returns the type of service message parameter.
  116.  *  @param call The message call structure. Input parameter.
  117.  */
  118. #define ICMP_GET_TOS( call )    ( ip_tos_t ) IPC_GET_ARG4( call )
  119.  
  120. /** Returns the dont fragment message parameter.
  121.  *  @param call The message call structure. Input parameter.
  122.  */
  123. #define ICMP_GET_DONT_FRAGMENT( call )      ( int ) IPC_GET_ARG5( call )
  124.  
  125. /*@}*/
  126.  
  127. #endif
  128.  
  129. /** @}
  130.  */
  131.