WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/include/netif_interface.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 same interface is used for standalone remote modules as well as for bundle network interface layer modules.
 *  The standalone remote modules have to be compiled with the netif_remote.c source file.
 *  The bundle network interface layer modules are compiled with the netif_nil_bundle.c source file and the choosen network interface layer implementation source file.
 */
 
#ifndef __NET_NETIF_INTERFACE_H__
#define __NET_NETIF_INTERFACE_H__
 
#include <ipc/services.h>
 
#include "../messages.h"
 
#include "../structures/measured_strings.h"
#include "../structures/packet/packet.h"
 
#include "device.h"
 
/** @name Network interface module interface
 *  This interface is used by other modules.
 */
/*@{*/
 
/** Returns the device local hardware address.
 *  @param netif_phone The network interface phone. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param address The device local hardware address. Output parameter.
 *  @param data The address data. 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 netif_get_addr() function.
 */
int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );
 
/** Probes the existence of the device.
 *  @param netif_phone The network interface phone. Input parameter.
 *  @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 errro codes as defined for the netif_probe_message().
 */
int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );
 
/** Sends the packet queue.
 *  @param netif_phone The network interface phone. Input parameter.
 *  @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 generic_send_msg() function.
 */
int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );
 
/** Starts the device.
 *  @param netif_phone The network interface phone. Input parameter.
 *  @param device_id The device identifier. 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 netif_start_message() function.
 */
int netif_start_req( int netif_phone, device_id_t device_id );
 
/** Stops the device.
 *  @param netif_phone The network interface phone. Input parameter.
 *  @param device_id The device identifier. 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 netif_stop_message() function.
 */
int netif_stop_req( int netif_phone, device_id_t device_id );
 
/** Returns the device usage statistics.
 *  @param netif_phone The network interface phone. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param stats The device usage statistics. Output parameter.
 *  @returns EOK on success.
 */
int netif_stats_req( int netif_phone, device_id_t device_id, device_stats_ref stats );
 
/** Creates bidirectional connection with the network interface module service and registers the message receiver.
 *  @param service The network interface module service. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param me The requesting module service. Input parameter.
 *  @param receiver The message receiver. Input parameter.
 *  @returns The phone of the needed service.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for the bind_service() function.
 */
int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );
 
/*@}*/
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/netif_interface.h – 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 same interface is used for standalone remote modules as well as for bundle network interface layer modules.	35	* The same interface is used for standalone remote modules as well as for bundle network interface layer modules.
36	* The standalone remote modules have to be compiled with the netif_remote.c source file.	36	* The standalone remote modules have to be compiled with the netif_remote.c source file.
37	* The bundle network interface layer modules are compiled with the netif_nil_bundle.c source file and the choosen network interface layer implementation source file.	37	* The bundle network interface layer modules are compiled with the netif_nil_bundle.c source file and the choosen network interface layer implementation source file.
38	*/	38	*/
39		39
40	#ifndef __NET_NETIF_INTERFACE_H__	40	#ifndef __NET_NETIF_INTERFACE_H__
41	#define __NET_NETIF_INTERFACE_H__	41	#define __NET_NETIF_INTERFACE_H__
42		42
43	#include <ipc/services.h>	43	#include <ipc/services.h>
44		44
45	#include "../messages.h"	45	#include "../messages.h"
46		46
47	#include "../structures/measured_strings.h"	47	#include "../structures/measured_strings.h"
48	#include "../structures/packet/packet.h"	48	#include "../structures/packet/packet.h"
49		49
50	#include "device.h"	50	#include "device.h"
51		51
-		52	/** @name Network interface module interface
-		53	* This interface is used by other modules.
-		54	*/
-		55	/@{/
-		56
52	/** Returns the device local hardware address.	57	/** Returns the device local hardware address.
53	* @param netif_phone The network interface phone. Input parameter.	58	* @param netif_phone The network interface phone. Input parameter.
54	* @param device_id The device identifier. Input parameter.	59	* @param device_id The device identifier. Input parameter.
55	* @param address The device local hardware address. Output parameter.	60	* @param address The device local hardware address. Output parameter.
56	* @param data The address data. Output parameter.	61	* @param data The address data. Output parameter.
57	* @returns EOK on success.	62	* @returns EOK on success.
58	* @returns EBADMEM if the address parameter is NULL.	63	* @returns EBADMEM if the address parameter is NULL.
59	* @returns ENOENT if there no such device.	64	* @returns ENOENT if there no such device.
60	* @returns Other error codes as defined for the netif_get_addr() function.	65	* @returns Other error codes as defined for the netif_get_addr() function.
61	*/	66	*/
62	int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );	67	int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );
63		68
64	/** Probes the existence of the device.	69	/** Probes the existence of the device.
65	* @param netif_phone The network interface phone. Input parameter.	70	* @param netif_phone The network interface phone. Input parameter.
66	* @param device_id The device identifier. Input parameter.	71	* @param device_id The device identifier. Input parameter.
67	* @param irq The device interrupt number. Input parameter.	72	* @param irq The device interrupt number. Input parameter.
68	* @param io The device input/output address. Input parameter.	73	* @param io The device input/output address. Input parameter.
69	* @returns EOK on success.	74	* @returns EOK on success.
70	* @returns Other errro codes as defined for the netif_probe_message().	75	* @returns Other errro codes as defined for the netif_probe_message().
71	*/	76	*/
72	int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );	77	int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );
73		78
74	/** Sends the packet queue.	79	/** Sends the packet queue.
75	* @param netif_phone The network interface phone. Input parameter.	80	* @param netif_phone The network interface phone. Input parameter.
76	* @param device_id The device identifier. Input parameter.	81	* @param device_id The device identifier. Input parameter.
77	* @param packet The packet queue. Input parameter.	82	* @param packet The packet queue. Input parameter.
78	* @param sender The sending module service. Input parameter.	83	* @param sender The sending module service. Input parameter.
79	* @returns EOK on success.	84	* @returns EOK on success.
80	* @returns Other error codes as defined for the generic_send_msg() function.	85	* @returns Other error codes as defined for the generic_send_msg() function.
81	*/	86	*/
82	int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );	87	int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );
83		88
84	/** Starts the device.	89	/** Starts the device.
85	* @param netif_phone The network interface phone. Input parameter.	90	* @param netif_phone The network interface phone. Input parameter.
86	* @param device_id The device identifier. Input parameter.	91	* @param device_id The device identifier. Input parameter.
87	* @returns EOK on success.	92	* @returns EOK on success.
88	* @returns Other error codes as defined for the find_device() function.	93	* @returns Other error codes as defined for the find_device() function.
89	* @returns Other error codes as defined for the netif_start_message() function.	94	* @returns Other error codes as defined for the netif_start_message() function.
90	*/	95	*/
91	int netif_start_req( int netif_phone, device_id_t device_id );	96	int netif_start_req( int netif_phone, device_id_t device_id );
92		97
93	/** Stops the device.	98	/** Stops the device.
94	* @param netif_phone The network interface phone. Input parameter.	99	* @param netif_phone The network interface phone. Input parameter.
95	* @param device_id The device identifier. Input parameter.	100	* @param device_id The device identifier. Input parameter.
96	* @returns EOK on success.	101	* @returns EOK on success.
97	* @returns Other error codes as defined for the find_device() function.	102	* @returns Other error codes as defined for the find_device() function.
98	* @returns Other error codes as defined for the netif_stop_message() function.	103	* @returns Other error codes as defined for the netif_stop_message() function.
99	*/	104	*/
100	int netif_stop_req( int netif_phone, device_id_t device_id );	105	int netif_stop_req( int netif_phone, device_id_t device_id );
101		106
-		107	/** Returns the device usage statistics.
-		108	* @param netif_phone The network interface phone. Input parameter.
-		109	* @param device_id The device identifier. Input parameter.
-		110	* @param stats The device usage statistics. Output parameter.
-		111	* @returns EOK on success.
-		112	*/
-		113	int netif_stats_req( int netif_phone, device_id_t device_id, device_stats_ref stats );
-		114
102	/** Creates bidirectional connection with the network interface module service and registers the message receiver.	115	/** Creates bidirectional connection with the network interface module service and registers the message receiver.
103	* @param service The network interface module service. Input parameter.	116	* @param service The network interface module service. Input parameter.
104	* @param device_id The device identifier. Input parameter.	117	* @param device_id The device identifier. Input parameter.
105	* @param me The requesting module service. Input parameter.	118	* @param me The requesting module service. Input parameter.
106	* @param receiver The message receiver. Input parameter.	119	* @param receiver The message receiver. Input parameter.
107	* @returns The phone of the needed service.	120	* @returns The phone of the needed service.
108	* @returns EOK on success.	121	* @returns EOK on success.
109	* @returns Other error codes as defined for the bind_service() function.	122	* @returns Other error codes as defined for the bind_service() function.
110	*/	123	*/
111	int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );	124	int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );
112		125
-		126	/@}/
-		127
113	#endif	128	#endif
114		129
115	/** @}	130	/** @}
116	*/	131	*/
117		132