WebSVN – HelenOS – Blame – /branches/network/uspace/srv/net/include/ip_interface.h

Rev	Author	Line No.	Line
4307	mejdrech	1	/*
		2	* Copyright (c) 2009 Lukas Mejdrech
		3	* All rights reserved.
		4	*
		5	* Redistribution and use in source and binary forms, with or without
		6	* modification, are permitted provided that the following conditions
		7	* are met:
		8	*
		9	* - Redistributions of source code must retain the above copyright
		10	* notice, this list of conditions and the following disclaimer.
		11	* - Redistributions in binary form must reproduce the above copyright
		12	* notice, this list of conditions and the following disclaimer in the
		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
		15	* derived from this software without specific prior written permission.
		16	*
		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
		19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
		20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
		21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
		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
		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
		26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		27	*/
		28
		29	/** @addtogroup ip
		30	* @{
		31	*/
		32
		33	/** @file
4350	mejdrech	34	* Internet protocol interface.
		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.
		37	* The bundle modules with the ip.c source file.
4307	mejdrech	38	*/
		39
		40	#ifndef __NET_IP_INTERFACE_H__
		41	#define __NET_IP_INTERFACE_H__
		42
		43	#include <async.h>
		44
		45	#include <ipc/services.h>
		46
		47	#include "../include/device.h"
		48
		49	#include "../structures/packet/packet.h"
		50
4575	mejdrech	51	#include "in.h"
4505	mejdrech	52
		53	/** The transport layer notification function type definition.
		54	* Notifies the transport layer modules about the received packet/s.
		55	* @param device_id The device identifier. Input parameter.
		56	* @param packet The received packet or the received packet queue. Input parameter.
		57	* @param receiver The receiving module service. Input parameter.
		58	* @returns EOK on success.
		59	*/
		60	typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );
		61
4693	mejdrech	62	/** Creates bidirectional connection with the ip module service and registers the message receiver.
		63	* @param service The ip module service. Input parameter.
		64	* @param protocol The transport layer protocol. Input parameter.
		65	* @param me The requesting module service. Input parameter.
		66	* @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.
		68	* @returns The phone of the needed service.
		69	* @returns EOK on success.
		70	* @returns Other error codes as defined for the bind_service() function.
4350	mejdrech	71	*/
4505	mejdrech	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 );
4350	mejdrech	73
		74	/** Registers the new device.
		75	* Registers itself as the ip packet receiver.
		76	* 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.
		78	* @param device_id The new device identifier. Input parameter.
		79	* @param netif The underlying device network interface layer service. Input parameter.
		80	* @returns EOK on success.
		81	* @returns ENOMEM if there is not enough memory left.
		82	* @returns EINVAL if the device configuration is invalid.
		83	* @returns ENOTSUP if the device uses IPv6.
		84	* @returns ENOTSUP if the device uses DHCP.
		85	* @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.
		87	*/
		88	int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
		89
4351	mejdrech	90	/** Sends the packet queue.
		91	* @param ip_phone The internet protocol phone. Input parameter.
		92	* @param device_id The device identifier. Input parameter.
		93	* @param packet The packet queue. Input parameter.
		94	* @param sender The sending module service. Input parameter.
		95	* @returns EOK on success.
		96	* @returns Other error codes as defined for the generic_send_msg() function.
4350	mejdrech	97	*/
4307	mejdrech	98	int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
4350	mejdrech	99
		100	/** Connects to the IP module.
		101	* @param service The IP module service. Ignored parameter.
		102	* @returns The IP module phone on success.
		103	* @returns 0 if called by the bundle module.
		104	*/
4307	mejdrech	105	int ip_connect_module( services_t service );
		106
4693	mejdrech	107	/** Adds a route to the device routing table.
		108	* The target network is routed using this device.
		109	* @param ip_phone The internet protocol phone. Input parameter.
		110	* @param device_id The device identifier. Input parameter.
		111	* @param address The target network address. Input parameter.
		112	* @param netmask The target network mask. Input parameter.
		113	* @param gateway The target network gateway. Not used if zero. Input parameter.
4505	mejdrech	114	*/
		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 );
		116
4693	mejdrech	117	/** Sets the default gateway.
		118	* This gateway is used if no other route is found.
		119	* @param ip_phone The internet protocol phone. Input parameter.
		120	* @param device_id The device identifier. Input parameter.
		121	* @param gateway The default gateway. Input parameter.
4505	mejdrech	122	*/
		123	int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );
		124
4693	mejdrech	125	/** Returns the device packet dimensions for sending.
		126	* @param ip_phone The internet protocol phone. Input parameter.
		127	* @param device_id The device identifier. Input parameter.
		128	* @param addr_len The minimum reserved address length. Output parameter.
		129	* @param prefix The minimum reserved prefix size. Output parameter.
		130	* @param content The maximum content size. Output parameter.
		131	* @param suffix The minimum reserved suffix size. Output parameter.
		132	* @returns EOK on success.
		133	* @returns EBADMEM if either one of the parameters is NULL.
		134	* @returns ENOENT if there is no such device.
		135	* @returns Other error codes as defined for the generic_packet_size_req() function.
4505	mejdrech	136	*/
		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 );
		138
4307	mejdrech	139	#endif
		140
		141	/** @}
		142	*/

Subversion Repositories HelenOS

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