Subversion Repositories HelenOS

Rev

Rev 4696 | 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 net
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Networking subsystem central module.
  35.  */
  36.  
  37. #ifndef __NET_NET_H__
  38. #define __NET_NET_H__
  39.  
  40. #include <ipc/ipc.h>
  41.  
  42. #include "../include/device.h"
  43.  
  44. #include "../structures/char_map.h"
  45. #include "../structures/generic_char_map.h"
  46. #include "../structures/measured_strings.h"
  47. #include "../structures/module_map.h"
  48. #include "../structures/packet/packet.h"
  49.  
  50. /** @name Modules definitions
  51.  */
  52. /*@{*/
  53.  
  54. /** Loopback network interface module name.
  55.  */
  56. #define LO_NAME             "lo"
  57.  
  58. /** Loopback network interface module full path filename.
  59.  */
  60. #define LO_FILENAME         "/srv/lo"
  61.  
  62. /** DP8390 network interface module name.
  63.  */
  64. #define DP8390_NAME         "dp8390"
  65.  
  66. /** DP8390 network interface module full path filename.
  67.  */
  68. #define DP8390_FILENAME     "/srv/dp8390"
  69.  
  70. /** Ethernet module name.
  71.  */
  72. #define ETHERNET_NAME       "ethernet"
  73.  
  74. /** Ethernet module full path filename.
  75.  */
  76. #define ETHERNET_FILENAME   "/srv/eth"
  77.  
  78. /** Ethernet module name.
  79.  */
  80. #define NILDUMMY_NAME       "nildummy"
  81.  
  82. /** Ethernet module full path filename.
  83.  */
  84. #define NILDUMMY_FILENAME   "/srv/nildummy"
  85.  
  86. /** IP module name.
  87.  */
  88. #define IP_NAME             "ip"
  89.  
  90. /** IP module full path filename.
  91.  */
  92. #define IP_FILENAME         "/srv/ip"
  93.  
  94. /*@}*/
  95.  
  96. /** @name Configuration setting names definitions
  97.  */
  98. /*@{*/
  99.  
  100. /** Network interface name configuration label.
  101.  */
  102. #define CONF_NAME           "NAME"
  103.  
  104. /** Network interface module name configuration label.
  105.  */
  106. #define CONF_NETIF          "NETIF"
  107.  
  108. /** Network interface layer module name configuration label.
  109.  */
  110. #define CONF_NIL            "NIL"
  111.  
  112. /** Internet protocol module name configuration label.
  113.  */
  114. #define CONF_IL             "IL"
  115.  
  116. /** Interrupt number configuration label.
  117.  */
  118. #define CONF_IRQ            "IRQ"
  119.  
  120. /** Device input/output address configuration label.
  121.  */
  122. #define CONF_IO             "IO"
  123.  
  124. /** Maximum transmission unit configuration label.
  125.  */
  126. #define CONF_MTU            "MTU"
  127.  
  128. /*@}*/
  129.  
  130. /** Type definition of the network interface specific data.
  131.  *  @see netif
  132.  */
  133. typedef struct netif    netif_t;
  134.  
  135. /** Type definition of the network interface specific data pointer.
  136.  *  @see netif
  137.  */
  138. typedef netif_t *       netif_ref;
  139.  
  140. /** Type definition of the networking module global data.
  141.  *  @see net_globals
  142.  */
  143. typedef struct net_globals  net_globals_t;
  144.  
  145. /** Present network interfaces.
  146.  *  Maps devices to the networking device specific data.
  147.  *  @see device.h
  148.  */
  149. DEVICE_MAP_DECLARE( netifs, netif_t )
  150.  
  151. /** Configuration settings.
  152.  *  Maps setting names to the values.
  153.  *  @see generic_char_map.h
  154.  */
  155. GENERIC_CHAR_MAP_DECLARE( measured_strings, measured_string_t )
  156.  
  157. /** Present network interface device.
  158.  */
  159. struct netif{
  160.     /** System-unique network interface identifier.
  161.      */
  162.     device_id_t     id;
  163.     /** Serving network interface driver module index.
  164.      */
  165.     module_ref      driver;
  166.     /** Serving link layer module index.
  167.      */
  168.     module_ref      nil;
  169.     /** Serving internet layer module index.
  170.      */
  171.     module_ref      il;
  172.     /** System-unique network interface name.
  173.      */
  174.     char *          name;
  175.     /** Configuration.
  176.      */
  177.     measured_strings_t  configuration;
  178. };
  179.  
  180. /** Networking module global variables.
  181.  */
  182. struct net_globals{
  183.     /** Present network interfaces.
  184.      */
  185.     netifs_t        netifs;
  186.     /** Network interface structure indices by names.
  187.      */
  188.     char_map_t      netif_names;
  189.     /** Available modules.
  190.      */
  191.     modules_t       modules;
  192.     /** Global configuration.
  193.      */
  194.     measured_strings_t  configuration;
  195. };
  196.  
  197. /** Adds the configured setting to the configuration map.
  198.  *  @param configuration The configuration map. Input parameter.
  199.  *  @param name The setting name. Input parameter.
  200.  *  @param value The setting value. Input parameter.
  201.  *  @returns EOK on success.
  202.  *  @returns ENOMEM if there is not enough memory left.
  203.  */
  204. int add_configuration( measured_strings_ref configuration, const char * name, const char * value );
  205.  
  206. /** Processes the networking message.
  207.  *  @param callid The message identifier. Input parameter.
  208.  *  @param call The message parameters. Input parameter.
  209.  *  @param answer The message answer parameters. Output parameter.
  210.  *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
  211.  *  @returns EOK on success.
  212.  *  @returns ENOTSUP if the message is not known.
  213.  *  @see net_interface.h
  214.  *  @see IS_NET_NET_MESSAGE()
  215.  */
  216. int net_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
  217.  
  218. /** Initializes the networking module.
  219.  *  @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.
  220.  *  @returns EOK on success.
  221.  *  @returns ENOMEM if there is not enough memory left.
  222.  */
  223. int net_initialize( async_client_conn_t client_connection );
  224.  
  225. /** Processes the module message.
  226.  *  Distributes the message to the right bundled module.
  227.  *  @param callid The message identifier. Input parameter.
  228.  *  @param call The message parameters. Input parameter.
  229.  *  @param answer The message answer parameters. Output parameter.
  230.  *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
  231.  *  @returns EOK on success.
  232.  *  @returns ENOTSUP if the message is not known.
  233.  *  @returns Other error codes as defined for each bundled module message function.
  234.  */
  235. int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
  236.  
  237. /** Reads the network interface specific configuration.
  238.  *  @param name The network interface name. Input parameter.
  239.  *  @param netif The network interface structure. Input/output parameter.
  240.  *  @returns EOK on success.
  241.  *  @returns Other error codes as defined for the add_configuration() function.
  242.  */
  243. int read_netif_configuration( char * name, netif_ref netif );
  244.  
  245. #endif
  246.  
  247. /** @}
  248.  */
  249.