WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/include/ip_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 ip
 *  @{
 */
 
/** @file
 *  IP module interface.
 *  The same interface is used for standalone remote modules as well as for bundle modules.
 *  The standalone remote modules have to be compiled with the ip_remote.c source file.
 *  The bundle modules with the ip.c source file.
 */
 
#ifndef __NET_IP_INTERFACE_H__
#define __NET_IP_INTERFACE_H__
 
#include <async.h>
 
#include <ipc/services.h>
 
#include "../include/device.h"
 
#include "../structures/packet/packet.h"
 
#include "in.h"
 
/** @name IP module interface
 *  This interface is used by other modules.
 */
/*@{*/
 
/** The transport layer notification function type definition.
 *  Notifies the transport layer modules about the received packet/s.
 *  @param device_id The device identifier. Input parameter.
 *  @param packet The received packet or the received packet queue. Input parameter.
 *  @param receiver The receiving module service. Input parameter.
 *  @returns EOK on success.
 */
typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );
 
/** Creates bidirectional connection with the ip module service and registers the message receiver.
 *  @param service The IP module service. Input parameter.
 *  @param protocol The transport layer protocol. Input parameter.
 *  @param me The requesting module service. Input parameter.
 *  @param receiver The message receiver. Used for remote connection. Input parameter.
 *  @param tl_received_msg The message processing function. Used if bundled together. 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 ip_bind_service( services_t service, int protocol, services_t me, async_client_conn_t receiver, tl_received_msg_t tl_received_msg );
 
/** Registers the new device.
 *  Registers itself as the ip packet receiver.
 *  If the device uses ARP registers also the new ARP device.
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
 *  @param device_id The new device identifier. Input parameter.
 *  @param netif The underlying device network interface layer service. Input parameter.
 *  @returns EOK on success.
 *  @returns ENOMEM if there is not enough memory left.
 *  @returns EINVAL if the device configuration is invalid.
 *  @returns ENOTSUP if the device uses IPv6.
 *  @returns ENOTSUP if the device uses DHCP.
 *  @returns Other error codes as defined for the net_get_device_conf_req() function.
 *  @returns Other error codes as defined for the arp_device_req() function.
 */
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
 
/** Sends the packet queue.
 *  @param ip_phone The IP module phone used for (semi)remote calls. 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 ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
 
/** Connects to the IP module.
 *  @param service The IP module service. Ignored parameter.
 *  @returns The IP module phone on success.
 *  @returns 0 if called by the bundle module.
 */
int ip_connect_module( services_t service );
 
/** Adds a route to the device routing table.
 *  The target network is routed using this device.
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param address The target network address. Input parameter.
 *  @param netmask The target network mask. Input parameter.
 *  @param gateway The target network gateway. Not used if zero. Input parameter.
 */
int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );
 
/** Sets the default gateway.
 *  This gateway is used if no other route is found.
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param gateway The default gateway. Input parameter.
 */
int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );
 
/** Returns the device packet dimensions for sending.
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
 *  @param device_id The device identifier. Input parameter.
 *  @param addr_len The minimum reserved address length. Output parameter.
 *  @param prefix The minimum reserved prefix size. Output parameter.
 *  @param content The maximum content size. Output parameter.
 *  @param suffix The minimum reserved suffix size. Output parameter.
 *  @returns EOK on success.
 *  @returns EBADMEM if either one of the parameters is NULL.
 *  @returns ENOENT if there is no such device.
 *  @returns Other error codes as defined for the generic_packet_size_req() function.
 */
int ip_packet_size_req( int ip_phone, device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix );
 
/*@}*/
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/ip_interface.h – Rev 4693 → 4704

Rev 4693		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 ip	29	/** @addtogroup ip
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Internet protocol interface.	34	* IP module interface.
35	* The same interface is used for standalone remote modules as well as for bundle modules.	35	* The same interface is used for standalone remote modules as well as for bundle modules.
36	* The standalone remote modules have to be compiled with the ip_remote.c source file.	36	* The standalone remote modules have to be compiled with the ip_remote.c source file.
37	* The bundle modules with the ip.c source file.	37	* The bundle modules with the ip.c source file.
38	*/	38	*/
39		39
40	#ifndef __NET_IP_INTERFACE_H__	40	#ifndef __NET_IP_INTERFACE_H__
41	#define __NET_IP_INTERFACE_H__	41	#define __NET_IP_INTERFACE_H__
42		42
43	#include <async.h>	43	#include <async.h>
44		44
45	#include <ipc/services.h>	45	#include <ipc/services.h>
46		46
47	#include "../include/device.h"	47	#include "../include/device.h"
48		48
49	#include "../structures/packet/packet.h"	49	#include "../structures/packet/packet.h"
50		50
51	#include "in.h"	51	#include "in.h"
52		52
-		53	/** @name IP module interface
-		54	* This interface is used by other modules.
-		55	*/
-		56	/@{/
-		57
53	/** The transport layer notification function type definition.	58	/** The transport layer notification function type definition.
54	* Notifies the transport layer modules about the received packet/s.	59	* Notifies the transport layer modules about the received packet/s.
55	* @param device_id The device identifier. Input parameter.	60	* @param device_id The device identifier. Input parameter.
56	* @param packet The received packet or the received packet queue. Input parameter.	61	* @param packet The received packet or the received packet queue. Input parameter.
57	* @param receiver The receiving module service. Input parameter.	62	* @param receiver The receiving module service. Input parameter.
58	* @returns EOK on success.	63	* @returns EOK on success.
59	*/	64	*/
60	typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );	65	typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );
61		66
62	/** Creates bidirectional connection with the ip module service and registers the message receiver.	67	/** Creates bidirectional connection with the ip module service and registers the message receiver.
63	* @param service The ip module service. Input parameter.	68	* @param service The IP module service. Input parameter.
64	* @param protocol The transport layer protocol. Input parameter.	69	* @param protocol The transport layer protocol. Input parameter.
65	* @param me The requesting module service. Input parameter.	70	* @param me The requesting module service. Input parameter.
66	* @param receiver The message receiver. Used for remote connection. Input parameter.	71	* @param receiver The message receiver. Used for remote connection. Input parameter.
67	* @param tl_received_msg The message processing function. Used if bundled together. Input parameter.	72	* @param tl_received_msg The message processing function. Used if bundled together. Input parameter.
68	* @returns The phone of the needed service.	73	* @returns The phone of the needed service.
69	* @returns EOK on success.	74	* @returns EOK on success.
70	* @returns Other error codes as defined for the bind_service() function.	75	* @returns Other error codes as defined for the bind_service() function.
71	*/	76	*/
72	int ip_bind_service( services_t service, int protocol, services_t me, async_client_conn_t receiver, tl_received_msg_t tl_received_msg );	77	int ip_bind_service( services_t service, int protocol, services_t me, async_client_conn_t receiver, tl_received_msg_t tl_received_msg );
73		78
74	/** Registers the new device.	79	/** Registers the new device.
75	* Registers itself as the ip packet receiver.	80	* Registers itself as the ip packet receiver.
76	* If the device uses ARP registers also the new ARP device.	81	* If the device uses ARP registers also the new ARP device.
77	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.	82	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
78	* @param device_id The new device identifier. Input parameter.	83	* @param device_id The new device identifier. Input parameter.
79	* @param netif The underlying device network interface layer service. Input parameter.	84	* @param netif The underlying device network interface layer service. Input parameter.
80	* @returns EOK on success.	85	* @returns EOK on success.
81	* @returns ENOMEM if there is not enough memory left.	86	* @returns ENOMEM if there is not enough memory left.
82	* @returns EINVAL if the device configuration is invalid.	87	* @returns EINVAL if the device configuration is invalid.
83	* @returns ENOTSUP if the device uses IPv6.	88	* @returns ENOTSUP if the device uses IPv6.
84	* @returns ENOTSUP if the device uses DHCP.	89	* @returns ENOTSUP if the device uses DHCP.
85	* @returns Other error codes as defined for the net_get_device_conf_req() function.	90	* @returns Other error codes as defined for the net_get_device_conf_req() function.
86	* @returns Other error codes as defined for the arp_device_req() function.	91	* @returns Other error codes as defined for the arp_device_req() function.
87	*/	92	*/
88	int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );	93	int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
89		94
90	/** Sends the packet queue.	95	/** Sends the packet queue.
91	* @param ip_phone The internet protocol phone. Input parameter.	96	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
92	* @param device_id The device identifier. Input parameter.	97	* @param device_id The device identifier. Input parameter.
93	* @param packet The packet queue. Input parameter.	98	* @param packet The packet queue. Input parameter.
94	* @param sender The sending module service. Input parameter.	99	* @param sender The sending module service. Input parameter.
95	* @returns EOK on success.	100	* @returns EOK on success.
96	* @returns Other error codes as defined for the generic_send_msg() function.	101	* @returns Other error codes as defined for the generic_send_msg() function.
97	*/	102	*/
98	int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );	103	int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
99		104
100	/** Connects to the IP module.	105	/** Connects to the IP module.
101	* @param service The IP module service. Ignored parameter.	106	* @param service The IP module service. Ignored parameter.
102	* @returns The IP module phone on success.	107	* @returns The IP module phone on success.
103	* @returns 0 if called by the bundle module.	108	* @returns 0 if called by the bundle module.
104	*/	109	*/
105	int ip_connect_module( services_t service );	110	int ip_connect_module( services_t service );
106		111
107	/** Adds a route to the device routing table.	112	/** Adds a route to the device routing table.
108	* The target network is routed using this device.	113	* The target network is routed using this device.
109	* @param ip_phone The internet protocol phone. Input parameter.	114	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
110	* @param device_id The device identifier. Input parameter.	115	* @param device_id The device identifier. Input parameter.
111	* @param address The target network address. Input parameter.	116	* @param address The target network address. Input parameter.
112	* @param netmask The target network mask. Input parameter.	117	* @param netmask The target network mask. Input parameter.
113	* @param gateway The target network gateway. Not used if zero. Input parameter.	118	* @param gateway The target network gateway. Not used if zero. Input parameter.
114	*/	119	*/
115	int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );	120	int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );
116		121
117	/** Sets the default gateway.	122	/** Sets the default gateway.
118	* This gateway is used if no other route is found.	123	* This gateway is used if no other route is found.
119	* @param ip_phone The internet protocol phone. Input parameter.	124	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
120	* @param device_id The device identifier. Input parameter.	125	* @param device_id The device identifier. Input parameter.
121	* @param gateway The default gateway. Input parameter.	126	* @param gateway The default gateway. Input parameter.
122	*/	127	*/
123	int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );	128	int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );
124		129
125	/** Returns the device packet dimensions for sending.	130	/** Returns the device packet dimensions for sending.
126	* @param ip_phone The internet protocol phone. Input parameter.	131	* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
127	* @param device_id The device identifier. Input parameter.	132	* @param device_id The device identifier. Input parameter.
128	* @param addr_len The minimum reserved address length. Output parameter.	133	* @param addr_len The minimum reserved address length. Output parameter.
129	* @param prefix The minimum reserved prefix size. Output parameter.	134	* @param prefix The minimum reserved prefix size. Output parameter.
130	* @param content The maximum content size. Output parameter.	135	* @param content The maximum content size. Output parameter.
131	* @param suffix The minimum reserved suffix size. Output parameter.	136	* @param suffix The minimum reserved suffix size. Output parameter.
132	* @returns EOK on success.	137	* @returns EOK on success.
133	* @returns EBADMEM if either one of the parameters is NULL.	138	* @returns EBADMEM if either one of the parameters is NULL.
134	* @returns ENOENT if there is no such device.	139	* @returns ENOENT if there is no such device.
135	* @returns Other error codes as defined for the generic_packet_size_req() function.	140	* @returns Other error codes as defined for the generic_packet_size_req() function.
136	*/	141	*/
137	int ip_packet_size_req( int ip_phone, device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix );	142	int ip_packet_size_req( int ip_phone, device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix );
138		143
-		144	/@}/
-		145
139	#endif	146	#endif
140		147
141	/** @}	148	/** @}
142	*/	149	*/
143		150