Subversion Repositories HelenOS

Rev

Rev 4350 | Rev 4696 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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