WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/netif/netif_module.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 interface.
 *  The interface has to be implemented by each network interface module.
 *  The interface is used by the network interface module skeleton.
 */
 
#ifndef __NET_NETIF_MODULE_H__
#define __NET_NETIF_MODULE_H__
 
#include <ipc/ipc.h>
#include <ipc/services.h>
 
#include "../structures/measured_strings.h"
#include "../structures/packet/packet.h"
 
#include "../include/device.h"
 
/** Initializes the specific module.
 */
int netif_initialize( void );
 
 
 
 
 
/** Probes the existence of the device.
 *  @param device_id The device identifier. Input parameter.
 *  @param irq The device interrupt number. Input parameter.
 *  @param io The device input/output address. Input parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the find_device() function.
 *  @returns Other error codes as defined for the specific module message implementation.
 */
int netif_probe_message( device_id_t device_id, int irq, int io );
 
/** Sends the packet queue.
 *  @param device_id The device identifier. Input parameter.
 *  @param packet The packet queue. Input parameter.
 *  @param sender The sending module service. Input parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the find_device() function.
 *  @returns Other error codes as defined for the specific module message implementation.
 */
int netif_send_message( device_id_t device_id, packet_t packet, services_t sender );
 
/** Starts the device.
 *  @param device The device structure. Input parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the find_device() function.
 *  @returns Other error codes as defined for the specific module message implementation.
 */
int netif_start_message( device_ref device );
 
/** Stops the device.
 *  @param device The device structure. Input parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the find_device() function.
 *  @returns Other error codes as defined for the specific module message implementation.
 */
int netif_stop_message( device_ref device );
 
/** Returns the device local hardware address.
 *  @param device_id The device identifier. Input parameter.
 *  @param address The device local hardware address. Output parameter.
 *  @returns EOK on success.
 *  @returns EBADMEM if the address parameter is NULL.
 *  @returns ENOENT if there no such device.
 *  @returns Other error codes as defined for the find_device() function.
 *  @returns Other error codes as defined for the specific module message implementation.
 */
int netif_get_addr_message( device_id_t device_id, measured_string_ref address );
 
/** Processes the netif driver specific message.
 *  This function is called for uncommon messages received by the netif skeleton.
 *  @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 the specific module message implementation.
 */
int netif_specific_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** Returns the device usage statistics.
 *  @param device_id The device identifier. Input parameter.
 *  @param stats The device usage statistics. Output parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the find_device() function.
 *  @returns Other error codes as defined for the specific module message implementation.
 */
int netif_get_device_stats( device_id_t device_id, device_stats_ref stats );
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/netif/netif_module.h @ 4731 – Rev 4350 → 4703

Rev 4350		Rev 4703
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 interface.	34	* Network interface module interface.
35	* The interface has to be implemented by each network interface module.	35	* The interface has to be implemented by each network interface module.
36	* The interface is used by the network interface module skeleton.	36	* The interface is used by the network interface module skeleton.
37	*/	37	*/
38		38
39	#ifndef __NET_NETIF_MODULE_H__	39	#ifndef __NET_NETIF_MODULE_H__
40	#define __NET_NETIF_MODULE_H__	40	#define __NET_NETIF_MODULE_H__
41		41
42	#include <ipc/ipc.h>	42	#include <ipc/ipc.h>
43	#include <ipc/services.h>	43	#include <ipc/services.h>
44		44
45	#include "../structures/measured_strings.h"	45	#include "../structures/measured_strings.h"
46	#include "../structures/packet/packet.h"	46	#include "../structures/packet/packet.h"
47		47
48	#include "../include/device.h"	48	#include "../include/device.h"
49		49
50	/** Initializes the specific module.	50	/** Initializes the specific module.
51	*/	51	*/
52	int netif_initialize( void );	52	int netif_initialize( void );
53		53
54	/** Automatically probes all known devices.	-
55	*/	-
56	int netif_probe_auto_message( void );	-
57		-
58	/** Probes the existence of the device.	54	/** Probes the existence of the device.
59	* @param device_id The device identifier. Input parameter.	55	* @param device_id The device identifier. Input parameter.
60	* @param irq The device interrupt number. Input parameter.	56	* @param irq The device interrupt number. Input parameter.
61	* @param io The device input/output address. Input parameter.	57	* @param io The device input/output address. Input parameter.
62	* @returns EOK on success.	58	* @returns EOK on success.
63	* @returns Other error codes as defined for the find_device() function.	59	* @returns Other error codes as defined for the find_device() function.
64	* @returns Other error codes as defined for the specific module message implementation.	60	* @returns Other error codes as defined for the specific module message implementation.
65	*/	61	*/
66	int netif_probe_message( device_id_t device_id, int irq, int io );	62	int netif_probe_message( device_id_t device_id, int irq, int io );
67		63
68	/** Sends the packet queue.	64	/** Sends the packet queue.
69	* @param device_id The device identifier. Input parameter.	65	* @param device_id The device identifier. Input parameter.
70	* @param packet The packet queue. Input parameter.	66	* @param packet The packet queue. Input parameter.
71	* @param sender The sending module service. Input parameter.	67	* @param sender The sending module service. Input parameter.
72	* @returns EOK on success.	68	* @returns EOK on success.
73	* @returns Other error codes as defined for the find_device() function.	69	* @returns Other error codes as defined for the find_device() function.
74	* @returns Other error codes as defined for the specific module message implementation.	70	* @returns Other error codes as defined for the specific module message implementation.
75	*/	71	*/
76	int netif_send_message( device_id_t device_id, packet_t packet, services_t sender );	72	int netif_send_message( device_id_t device_id, packet_t packet, services_t sender );
77		73
78	/** Starts the device.	74	/** Starts the device.
79	* @param device The device structure. Input parameter.	75	* @param device The device structure. Input parameter.
80	* @returns EOK on success.	76	* @returns EOK on success.
81	* @returns Other error codes as defined for the find_device() function.	77	* @returns Other error codes as defined for the find_device() function.
82	* @returns Other error codes as defined for the specific module message implementation.	78	* @returns Other error codes as defined for the specific module message implementation.
83	*/	79	*/
84	int netif_start_message( device_ref device );	80	int netif_start_message( device_ref device );
85		81
86	/** Stops the device.	82	/** Stops the device.
87	* @param device The device structure. Input parameter.	83	* @param device The device structure. Input parameter.
88	* @returns EOK on success.	84	* @returns EOK on success.
89	* @returns Other error codes as defined for the find_device() function.	85	* @returns Other error codes as defined for the find_device() function.
90	* @returns Other error codes as defined for the specific module message implementation.	86	* @returns Other error codes as defined for the specific module message implementation.
91	*/	87	*/
92	int netif_stop_message( device_ref device );	88	int netif_stop_message( device_ref device );
93		89
94	/** Returns the device local hardware address.	90	/** Returns the device local hardware address.
95	* @param device_id The device identifier. Input parameter.	91	* @param device_id The device identifier. Input parameter.
96	* @param address The device local hardware address. Output parameter.	92	* @param address The device local hardware address. Output parameter.
97	* @returns EOK on success.	93	* @returns EOK on success.
98	* @returns EBADMEM if the address parameter is NULL.	94	* @returns EBADMEM if the address parameter is NULL.
99	* @returns ENOENT if there no such device.	95	* @returns ENOENT if there no such device.
100	* @returns Other error codes as defined for the find_device() function.	96	* @returns Other error codes as defined for the find_device() function.
101	* @returns Other error codes as defined for the specific module message implementation.	97	* @returns Other error codes as defined for the specific module message implementation.
102	*/	98	*/
103	int netif_get_addr_message( device_id_t device_id, measured_string_ref address );	99	int netif_get_addr_message( device_id_t device_id, measured_string_ref address );
104		100
-		101	/** Processes the netif driver specific message.
-		102	* This function is called for uncommon messages received by the netif skeleton.
-		103	* @param callid The message identifier. Input parameter.
-		104	* @param call The message parameters. Input parameter.
-		105	* @param answer The message answer parameters. Output parameter.
-		106	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
-		107	* @returns EOK on success.
-		108	* @returns ENOTSUP if the message is not known.
-		109	* @returns Other error codes as defined for the specific module message implementation.
-		110	*/
105	int netif_specific_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );	111	int netif_specific_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
106		112
107	/** Returns the device usage statistics.	113	/** Returns the device usage statistics.
108	* @param device_id The device identifier. Input parameter.	114	* @param device_id The device identifier. Input parameter.
109	* @param stats The device usage statistics. Output parameter.	115	* @param stats The device usage statistics. Output parameter.
110	* @returns EOK on success.	116	* @returns EOK on success.
111	* @returns Other error codes as defined for the find_device() function.	117	* @returns Other error codes as defined for the find_device() function.
112	* @returns Other error codes as defined for the specific module message implementation.	118	* @returns Other error codes as defined for the specific module message implementation.
113	*/	119	*/
114	int netif_get_device_stats( device_id_t device_id, device_stats_ref stats );	120	int netif_get_device_stats( device_id_t device_id, device_stats_ref stats );
115		121
116	#endif	122	#endif
117		123
118	/** @}	124	/** @}
119	*/	125	*/
120		126