WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/netif/netif.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 netif
 *  @{
 */
 
/** @file
 *  Network interface module skeleton.
 *  The skeleton has to be part of each network interface module.
 *  The skeleton can be also part of the module bundled with the network interface layer.
 */
 
#ifndef __NET_NETIF_H__
#define __NET_NETIF_H__
 
#include <async.h>
#include <rwlock.h>
 
#include <ipc/ipc.h>
 
#include "../err.h"
 
#include "../include/device.h"
 
#include "../structures/packet/packet.h"
 
/** Network interface module skeleton global data.
 */
typedef struct netif_globals    netif_globals_t;
 
/** Type definition of the device specific data.
 *  @see netif_device
 */
typedef struct netif_device device_t;
 
/** Type definition of the device specific data pointer.
 *  @see netif_device
 */
typedef device_t *          device_ref;
 
/** Device map.
 *  Maps device identifiers to the network interface device specific data.
 *  @see device.h
 */
DEVICE_MAP_DECLARE( device_map, device_t );
 
/** Network interface device specific data.
 */
struct  netif_device{
    /** Device identifier.
     */
    device_id_t device_id;
    /** Receiving network interface layer phone.
     */
    int     nil_phone;
    /** Actual device state.
     */
    device_state_t  state;
    /** Driver specific data.
     */
    void *      specific;
};
 
/** Network interface module skeleton global data.
 */
struct  netif_globals{
    /** Networking module phone.
     */
    int     net_phone;
    /** Device map.
     */
    device_map_t    device_map;
    /** Safety lock.
     */
    rwlock_t    lock;
};
 
/** Finds the device specific data.
 *  @param device_id The device identifier. Input parameter.
 *  @param device The device specific data. Output parameter.
 *  @returns EOK on success.
 *  @returns ENOENT if device is not found.
 *  @returns EPERM if the device is not initialized.
 */
int find_device( device_id_t device_id, device_ref * device );
 
/** Clears the usage statistics.
 *  @param stats The usage statistics. Input parameter.
 */
void    null_device_stats( device_stats_ref stats );
 
// prepared for future optimalizations
/** Releases the given packet.
 *  @param packet_id The packet identifier. Input parameter.
 */
void    netif_pq_release( packet_id_t packet_id );
 
/** Allocates new packet to handle the given content size.
 *  @param content The minimum content size. Input parameter.
 *  @returns The allocated packet.
 *  @returns NULL if there is an error.
 */
packet_t netif_packet_get_1( size_t content );
 
/** Processes the netif module messages.
 *  @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 specific module message function.
 *  @see netif_interface.h
 *  @see IS_NET_NETIF_MESSAGE()
 */
int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** Initializes the netif module.
 *  The function has to be defined in each module.
 *  @param client_connection The client connection functio to be registered. Input parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for each specific module message function.
 */
int netif_init_module( async_client_conn_t client_connection );
 
/** Starts and maintains the netif module until terminated.
 *  @returns EOK after the module is terminated.
 */
int netif_run_module( void );
 
#endif
 
/** @}
 */
 
 

Rev 4307	Rev 4350
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 netif	29	/** @addtogroup netif
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Network interface module skeleton.	34	* Network interface module skeleton.
-		35	* The skeleton has to be part of each network interface module.
-		36	* The skeleton can be also part of the module bundled with the network interface layer.
35	*/	37	*/
36		38
37	#ifndef __NET_NETIF_H__	39	#ifndef __NET_NETIF_H__
38	#define __NET_NETIF_H__	40	#define __NET_NETIF_H__
39		41
40	#include <async.h>	42	#include <async.h>
41	#include <rwlock.h>	43	#include <rwlock.h>
42		44
43	#include <ipc/ipc.h>	45	#include <ipc/ipc.h>
44		46
45	#include "../err.h"	47	#include "../err.h"
46		48
47	#include "../include/device.h"	49	#include "../include/device.h"
48		50
49	#include "../structures/packet/packet.h"	51	#include "../structures/packet/packet.h"
50		52
51	/** Network interface module skeleton global data.	53	/** Network interface module skeleton global data.
52	*/	54	*/
53	typedef struct netif_globals netif_globals_t;	55	typedef struct netif_globals netif_globals_t;
54		56
55	/** Type definition of the device specific data.	57	/** Type definition of the device specific data.
56	* @see netif_device	58	* @see netif_device
57	*/	59	*/
58	typedef struct netif_device device_t;	60	typedef struct netif_device device_t;
59		61
60	/** Type definition of the device specific data pointer.	62	/** Type definition of the device specific data pointer.
61	* @see netif_device	63	* @see netif_device
62	*/	64	*/
63	typedef device_t * device_ref;	65	typedef device_t * device_ref;
64		66
65	/** Device map.	67	/** Device map.
66	* Maps device identifiers to the network interface device specific data.	68	* Maps device identifiers to the network interface device specific data.
67	* @see device.h	69	* @see device.h
68	*/	70	*/
69	DEVICE_MAP_DECLARE( device_map, device_t );	71	DEVICE_MAP_DECLARE( device_map, device_t );
70		72
71	/** Network interface device specific data.	73	/** Network interface device specific data.
72	*/	74	*/
73	struct netif_device{	75	struct netif_device{
74	/** Device identifier.	76	/** Device identifier.
75	*/	77	*/
76	device_id_t device_id;	78	device_id_t device_id;
77	/** Receiving network interface layer phone.	79	/** Receiving network interface layer phone.
78	*/	80	*/
79	int nil_phone;	81	int nil_phone;
80	/** Actual device state.	82	/** Actual device state.
81	*/	83	*/
82	device_state_t state;	84	device_state_t state;
83	/** Driver specific data.	85	/** Driver specific data.
84	*/	86	*/
85	void * specific;	87	void * specific;
86	};	88	};
87		89
88	/** Network interface module skeleton global data.	90	/** Network interface module skeleton global data.
89	*/	91	*/
90	struct netif_globals{	92	struct netif_globals{
91	/** Networking module phone.	93	/** Networking module phone.
92	*/	94	*/
93	int net_phone;	95	int net_phone;
94	/** Device map.	96	/** Device map.
95	*/	97	*/
96	device_map_t device_map;	98	device_map_t device_map;
97	/** Safety lock.	99	/** Safety lock.
98	*/	100	*/
99	rwlock_t lock;	101	rwlock_t lock;
100	};	102	};
101		103
102	/** Finds the device specific data.	104	/** Finds the device specific data.
103	* @param device_id The device identifier. Input parameter.	105	* @param device_id The device identifier. Input parameter.
104	* @param device The device specific data. Output parameter.	106	* @param device The device specific data. Output parameter.
105	* @returns EOK on success.	107	* @returns EOK on success.
106	* @returns ENOENT if device is not found.	108	* @returns ENOENT if device is not found.
107	* @returns EPERM if the device is not initialized.	109	* @returns EPERM if the device is not initialized.
108	*/	110	*/
109	int find_device( device_id_t device_id, device_ref * device );	111	int find_device( device_id_t device_id, device_ref * device );
110		112
111	/** Clears the usage statistics.	113	/** Clears the usage statistics.
112	* @param stats The usage statistics. Input parameter.	114	* @param stats The usage statistics. Input parameter.
113	*/	115	*/
114	void null_device_stats( device_stats_ref stats );	116	void null_device_stats( device_stats_ref stats );
115		117
116	// prepared for future optimalizations	118	// prepared for future optimalizations
117	/** \todo	119	/** Releases the given packet.
-		120	* @param packet_id The packet identifier. Input parameter.
118	*/	121	*/
119	void netif_pq_release( packet_id_t packet );	122	void netif_pq_release( packet_id_t packet_id );
120		123
-		124	/** Allocates new packet to handle the given content size.
-		125	* @param content The minimum content size. Input parameter.
121	/** \todo	126	* @returns The allocated packet.
-		127	* @returns NULL if there is an error.
122	*/	128	*/
123	packet_t netif_packet_get_1( size_t content );	129	packet_t netif_packet_get_1( size_t content );
124		130
-		131	/** Processes the netif module messages.
-		132	* @param callid The message identifier. Input parameter.
-		133	* @param call The message parameters. Input parameter.
-		134	* @param answer The message answer parameters. Output parameter.
-		135	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
-		136	* @returns EOK on success.
-		137	* @returns ENOTSUP if the message is not known.
-		138	* @returns Other error codes as defined for each specific module message function.
-		139	* @see netif_interface.h
-		140	* @see IS_NET_NETIF_MESSAGE()
-		141	*/
125	int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );	142	int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
-		143
-		144	/** Initializes the netif module.
-		145	* The function has to be defined in each module.
-		146	* @param client_connection The client connection functio to be registered. Input parameter.
-		147	* @returns EOK on success.
-		148	* @returns Other error codes as defined for each specific module message function.
-		149	*/
126	int netif_init_module( async_client_conn_t client_connection );	150	int netif_init_module( async_client_conn_t client_connection );
-		151
-		152	/** Starts and maintains the netif module until terminated.
-		153	* @returns EOK after the module is terminated.
-		154	*/
127	int netif_run_module( void );	155	int netif_run_module( void );
128		156
129	#endif	157	#endif
130		158
131	/** @}	159	/** @}
132	*/	160	*/
133		161
134		162

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/netif/netif.h @ 4746 – Rev 4307 → 4350