WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/net/net.h


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup net
 *  @{
 */
 
/** @file
 *  Networking subsystem central module.
 */
 
#ifndef __NET_NET_H__
#define __NET_NET_H__
 
#include <ipc/ipc.h>
 
#include "../include/device.h"
 
#include "../structures/char_map.h"
#include "../structures/generic_char_map.h"
#include "../structures/measured_strings.h"
#include "../structures/module_map.h"
#include "../structures/packet/packet.h"
 
/** @name Modules definitions
 */
/*@{*/
 
/** Loopback network interface module name.
 */
#define LO_NAME             "lo"
 
/** Loopback network interface module full path filename.
 */
#define LO_FILENAME         "/srv/lo"
 
/** DP8390 network interface module name.
 */
#define DP8390_NAME         "dp8390"
 
/** DP8390 network interface module full path filename.
 */
#define DP8390_FILENAME     "/srv/dp8390"
 
/** Ethernet module name.
 */
#define ETHERNET_NAME       "ethernet"
 
/** Ethernet module full path filename.
 */
#define ETHERNET_FILENAME   "/srv/eth"
 
/** Ethernet module name.
 */
#define NILDUMMY_NAME       "nildummy"
 
/** Ethernet module full path filename.
 */
#define NILDUMMY_FILENAME   "/srv/nildummy"
 
/** IP module name.
 */
#define IP_NAME             "ip"
 
/** IP module full path filename.
 */
#define IP_FILENAME         "/srv/ip"
 
/*@}*/
 
/** @name Configuration setting names definitions
 */
/*@{*/
 
/** Network interface name configuration label.
 */
#define CONF_NAME           "NAME"
 
/** Network interface module name configuration label.
 */
#define CONF_NETIF          "NETIF"
 
/** Network interface layer module name configuration label.
 */
#define CONF_NIL            "NIL"
 
/** Internet protocol module name configuration label.
 */
#define CONF_IL             "IL"
 
/** Interrupt number configuration label.
 */
#define CONF_IRQ            "IRQ"
 
/** Device input/output address configuration label.
 */
#define CONF_IO             "IO"
 
/** Maximum transmission unit configuration label.
 */
#define CONF_MTU            "MTU"
 
/*@}*/
 
/** Type definition of the network interface specific data.
 *  @see netif
 */
typedef struct netif    netif_t;
 
/** Type definition of the network interface specific data pointer.
 *  @see netif
 */
typedef netif_t *       netif_ref;
 
/** Type definition of the networking module global data.
 *  @see net_globals
 */
typedef struct net_globals  net_globals_t;
 
/** Present network interfaces.
 *  Maps devices to the networking device specific data.
 *  @see device.h
 */
DEVICE_MAP_DECLARE( netifs, netif_t )
 
/** Configuration settings.
 *  Maps setting names to the values.
 *  @see generic_char_map.h
 */
GENERIC_CHAR_MAP_DECLARE( measured_strings, measured_string_t )
 
/** Present network interface device.
 */
struct netif{
    /** System-unique network interface identifier.
     */
    device_id_t     id;
    /** Serving network interface driver module index.
     */
    module_ref      driver;
    /** Serving link layer module index.
     */
    module_ref      nil;
    /** Serving internet layer module index.
     */
    module_ref      il;
    /** System-unique network interface name.
     */
    char *          name;
    /** Configuration.
     */
    measured_strings_t  configuration;
};
 
/** Networking module global variables.
 */
struct net_globals{
    /** Present network interfaces.
     */
    netifs_t        netifs;
    /** Network interface structure indices by names.
     */
    char_map_t      netif_names;
    /** Available modules.
     */
    modules_t       modules;
    /** Global configuration.
     */
    measured_strings_t  configuration;
};
 
/** Adds the configured setting to the configuration map.
 *  @param configuration The configuration map. Input parameter.
 *  @param name The setting name. Input parameter.
 *  @param value The setting value. Input parameter.
 *  @returns EOK on success.
 *  @returns ENOMEM if there is not enough memory left.
 */
int add_configuration( measured_strings_ref configuration, const char * name, const char * value );
 
/** Processes the networking message.
 *  @param callid The message identifier. Input parameter.
 *  @param call The message parameters. Input parameter.
 *  @param answer The message answer parameters. Output parameter.
 *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
 *  @returns EOK on success.
 *  @returns ENOTSUP if the message is not known.
 *  @see net_interface.h
 *  @see IS_NET_NET_MESSAGE()
 */
int net_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** Initializes the networking module.
 *  @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.
 *  @returns EOK on success.
 *  @returns ENOMEM if there is not enough memory left.
 */
int net_initialize( async_client_conn_t client_connection );
 
/** Processes the module message.
 *  Distributes the message to the right bundled module.
 *  @param callid The message identifier. Input parameter.
 *  @param call The message parameters. Input parameter.
 *  @param answer The message answer parameters. Output parameter.
 *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
 *  @returns EOK on success.
 *  @returns ENOTSUP if the message is not known.
 *  @returns Other error codes as defined for each bundled module message function.
 */
int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** Reads the network interface specific configuration.
 *  @param name The network interface name. Input parameter.
 *  @param netif The network interface structure. Input/output parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the add_configuration() function.
 */
int read_netif_configuration( char * name, netif_ref netif );
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/net/net.h – Rev 4696 → 4704

Rev 4696		Rev 4704
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup net	29	/** @addtogroup net
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Networking subsystem central module.	34	* Networking subsystem central module.
35	*/	35	*/
36		36
37	#ifndef __NET_NET_H__	37	#ifndef __NET_NET_H__
38	#define __NET_NET_H__	38	#define __NET_NET_H__
39		39
40	#include <ipc/ipc.h>	40	#include <ipc/ipc.h>
41		41
42	#include "../include/device.h"	42	#include "../include/device.h"
43		43
44	#include "../structures/char_map.h"	44	#include "../structures/char_map.h"
45	#include "../structures/generic_char_map.h"	45	#include "../structures/generic_char_map.h"
46	#include "../structures/measured_strings.h"	46	#include "../structures/measured_strings.h"
47	#include "../structures/module_map.h"	47	#include "../structures/module_map.h"
48	#include "../structures/packet/packet.h"	48	#include "../structures/packet/packet.h"
49		49
-		50	/** @name Modules definitions
-		51	*/
-		52	/@{/
-		53
50	/** Loopback network interface module name.	54	/** Loopback network interface module name.
51	*/	55	*/
52	#define LO_NAME "lo"	56	#define LO_NAME "lo"
53		57
54	/** Loopback network interface module full path filename.	58	/** Loopback network interface module full path filename.
55	*/	59	*/
56	#define LO_FILENAME "/srv/lo"	60	#define LO_FILENAME "/srv/lo"
57		61
58	/** DP8390 network interface module name.	62	/** DP8390 network interface module name.
59	*/	63	*/
60	#define DP8390_NAME "dp8390"	64	#define DP8390_NAME "dp8390"
61		65
62	/** DP8390 network interface module full path filename.	66	/** DP8390 network interface module full path filename.
63	*/	67	*/
64	#define DP8390_FILENAME "/srv/dp8390"	68	#define DP8390_FILENAME "/srv/dp8390"
65		69
66	/** Ethernet module name.	70	/** Ethernet module name.
67	*/	71	*/
68	#define ETHERNET_NAME "ethernet"	72	#define ETHERNET_NAME "ethernet"
69		73
70	/** Ethernet module full path filename.	74	/** Ethernet module full path filename.
71	*/	75	*/
72	#define ETHERNET_FILENAME "/srv/eth"	76	#define ETHERNET_FILENAME "/srv/eth"
73		77
74	/** Ethernet module name.	78	/** Ethernet module name.
75	*/	79	*/
76	#define NILDUMMY_NAME "nildummy"	80	#define NILDUMMY_NAME "nildummy"
77		81
78	/** Ethernet module full path filename.	82	/** Ethernet module full path filename.
79	*/	83	*/
80	#define NILDUMMY_FILENAME "/srv/nildummy"	84	#define NILDUMMY_FILENAME "/srv/nildummy"
81		85
82	/** Internet protocol module name.	86	/** IP module name.
83	*/	87	*/
84	#define IP_NAME "ip"	88	#define IP_NAME "ip"
85		89
86	/** Internet protocol module full path filename.	90	/** IP module full path filename.
87	*/	91	*/
88	#define IP_FILENAME "/srv/ip"	92	#define IP_FILENAME "/srv/ip"
89		93
-		94	/@}/
-		95
-		96	/** @name Configuration setting names definitions
-		97	*/
-		98	/@{/
-		99
90	/** Network interface name configuration label.	100	/** Network interface name configuration label.
91	*/	101	*/
92	#define CONF_NAME "NAME"	102	#define CONF_NAME "NAME"
93		103
94	/** Network interface module name configuration label.	104	/** Network interface module name configuration label.
95	*/	105	*/
96	#define CONF_NETIF "NETIF"	106	#define CONF_NETIF "NETIF"
97		107
98	/** Network interface layer module name configuration label.	108	/** Network interface layer module name configuration label.
99	*/	109	*/
100	#define CONF_NIL "NIL"	110	#define CONF_NIL "NIL"
101		111
102	/** Internet protocol module name configuration label.	112	/** Internet protocol module name configuration label.
103	*/	113	*/
104	#define CONF_IL "IL"	114	#define CONF_IL "IL"
105		115
106	/** Interrupt number configuration label.	116	/** Interrupt number configuration label.
107	*/	117	*/
108	#define CONF_IRQ "IRQ"	118	#define CONF_IRQ "IRQ"
109		119
110	/** Device input/output address configuration label.	120	/** Device input/output address configuration label.
111	*/	121	*/
112	#define CONF_IO "IO"	122	#define CONF_IO "IO"
113		123
114	/** Maximum transmission unit configuration label.	124	/** Maximum transmission unit configuration label.
115	*/	125	*/
116	#define CONF_MTU "MTU"	126	#define CONF_MTU "MTU"
117		127
-		128	/@}/
-		129
118	/** Type definition of the network interface specific data.	130	/** Type definition of the network interface specific data.
119	* @see netif	131	* @see netif
120	*/	132	*/
121	typedef struct netif netif_t;	133	typedef struct netif netif_t;
122		134
123	/** Type definition of the network interface specific data pointer.	135	/** Type definition of the network interface specific data pointer.
124	* @see netif	136	* @see netif
125	*/	137	*/
126	typedef netif_t * netif_ref;	138	typedef netif_t * netif_ref;
127		139
128	/** Type definition of the networking module global data.	140	/** Type definition of the networking module global data.
129	* @see net_globals	141	* @see net_globals
130	*/	142	*/
131	typedef struct net_globals net_globals_t;	143	typedef struct net_globals net_globals_t;
132		144
133	/** Present network interfaces.	145	/** Present network interfaces.
134	* Maps devices to the networking device specific data.	146	* Maps devices to the networking device specific data.
135	* @see device.h	147	* @see device.h
136	*/	148	*/
137	DEVICE_MAP_DECLARE( netifs, netif_t )	149	DEVICE_MAP_DECLARE( netifs, netif_t )
138		150
139	/** Configuration settings.	151	/** Configuration settings.
140	* Maps setting names to the values.	152	* Maps setting names to the values.
141	* @see generic_char_map.h	153	* @see generic_char_map.h
142	*/	154	*/
143	GENERIC_CHAR_MAP_DECLARE( measured_strings, measured_string_t )	155	GENERIC_CHAR_MAP_DECLARE( measured_strings, measured_string_t )
144		156
145	/** Present network interface device.	157	/** Present network interface device.
146	*/	158	*/
147	struct netif{	159	struct netif{
148	/** System-unique network interface identifier.	160	/** System-unique network interface identifier.
149	*/	161	*/
150	device_id_t id;	162	device_id_t id;
151	/** Serving network interface driver module index.	163	/** Serving network interface driver module index.
152	*/	164	*/
153	module_ref driver;	165	module_ref driver;
154	/** Serving link layer module index.	166	/** Serving link layer module index.
155	*/	167	*/
156	module_ref nil;	168	module_ref nil;
157	/** Serving internet layer module index.	169	/** Serving internet layer module index.
158	*/	170	*/
159	module_ref il;	171	module_ref il;
160	/** System-unique network interface name.	172	/** System-unique network interface name.
161	*/	173	*/
162	char * name;	174	char * name;
163	/** Configuration.	175	/** Configuration.
164	*/	176	*/
165	measured_strings_t configuration;	177	measured_strings_t configuration;
166	};	178	};
167		179
168	/** Networking module global variables.	180	/** Networking module global variables.
169	*/	181	*/
170	struct net_globals{	182	struct net_globals{
171	/** Present network interfaces.	183	/** Present network interfaces.
172	*/	184	*/
173	netifs_t netifs;	185	netifs_t netifs;
174	/** Network interface structure indices by names.	186	/** Network interface structure indices by names.
175	*/	187	*/
176	char_map_t netif_names;	188	char_map_t netif_names;
177	/** Available modules.	189	/** Available modules.
178	*/	190	*/
179	modules_t modules;	191	modules_t modules;
180	/** Global configuration.	192	/** Global configuration.
181	*/	193	*/
182	measured_strings_t configuration;	194	measured_strings_t configuration;
183	};	195	};
184		196
185	/** Adds the configured setting to the configuration map.	197	/** Adds the configured setting to the configuration map.
186	* @param configuration The configuration map. Input parameter.	198	* @param configuration The configuration map. Input parameter.
187	* @param name The setting name. Input parameter.	199	* @param name The setting name. Input parameter.
188	* @param value The setting value. Input parameter.	200	* @param value The setting value. Input parameter.
189	* @returns EOK on success.	201	* @returns EOK on success.
190	* @returns ENOMEM if there is not enough memory left.	202	* @returns ENOMEM if there is not enough memory left.
191	*/	203	*/
192	int add_configuration( measured_strings_ref configuration, const char * name, const char * value );	204	int add_configuration( measured_strings_ref configuration, const char * name, const char * value );
193		205
194	/** Processes the networking message.	206	/** Processes the networking message.
195	* @param callid The message identifier. Input parameter.	207	* @param callid The message identifier. Input parameter.
196	* @param call The message parameters. Input parameter.	208	* @param call The message parameters. Input parameter.
197	* @param answer The message answer parameters. Output parameter.	209	* @param answer The message answer parameters. Output parameter.
198	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.	210	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
199	* @returns EOK on success.	211	* @returns EOK on success.
200	* @returns ENOTSUP if the message is not known.	212	* @returns ENOTSUP if the message is not known.
201	* @see net_interface.h	213	* @see net_interface.h
202	* @see IS_NET_NET_MESSAGE()	214	* @see IS_NET_NET_MESSAGE()
203	*/	215	*/
204	int net_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );	216	int net_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
205		217
206	/** Initializes the networking module.	218	/** Initializes the networking module.
207	* @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.	219	* @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.
208	* @returns EOK on success.	220	* @returns EOK on success.
209	* @returns ENOMEM if there is not enough memory left.	221	* @returns ENOMEM if there is not enough memory left.
210	*/	222	*/
211	int net_initialize( async_client_conn_t client_connection );	223	int net_initialize( async_client_conn_t client_connection );
212		224
213	/** Processes the module message.	225	/** Processes the module message.
214	* Distributes the message to the right bundled module.	226	* Distributes the message to the right bundled module.
215	* @param callid The message identifier. Input parameter.	227	* @param callid The message identifier. Input parameter.
216	* @param call The message parameters. Input parameter.	228	* @param call The message parameters. Input parameter.
217	* @param answer The message answer parameters. Output parameter.	229	* @param answer The message answer parameters. Output parameter.
218	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.	230	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
219	* @returns EOK on success.	231	* @returns EOK on success.
220	* @returns ENOTSUP if the message is not known.	232	* @returns ENOTSUP if the message is not known.
221	* @returns Other error codes as defined for each bundled module message function.	233	* @returns Other error codes as defined for each bundled module message function.
222	*/	234	*/
223	int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );	235	int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
224		236
225	/** Reads the network interface specific configuration.	237	/** Reads the network interface specific configuration.
226	* @param name The network interface name. Input parameter.	238	* @param name The network interface name. Input parameter.
227	* @param netif The network interface structure. Input/output parameter.	239	* @param netif The network interface structure. Input/output parameter.
228	* @returns EOK on success.	240	* @returns EOK on success.
229	* @returns Other error codes as defined for the add_configuration() function.	241	* @returns Other error codes as defined for the add_configuration() function.
230	*/	242	*/
231	int read_netif_configuration( char * name, netif_ref netif );	243	int read_netif_configuration( char * name, netif_ref netif );
232		244
233	#endif	245	#endif
234		246
235	/** @}	247	/** @}
236	*/	248	*/
237		249