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

Rev	Author	Line No.	Line
4243	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 netif
		30	* @{
		31	*/
		32
4350	mejdrech	33	/** @file
		34	* Network interface module interface.
		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.
		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.
4243	mejdrech	38	*/
		39
4307	mejdrech	40	#ifndef __NET_NETIF_INTERFACE_H__
		41	#define __NET_NETIF_INTERFACE_H__
4243	mejdrech	42
4307	mejdrech	43	#include <ipc/services.h>
4243	mejdrech	44
		45	#include "../messages.h"
		46
		47	#include "../structures/measured_strings.h"
		48	#include "../structures/packet/packet.h"
		49
		50	#include "device.h"
		51
4350	mejdrech	52	/** Returns the device local hardware address.
		53	* @param netif_phone The network interface phone. Input parameter.
		54	* @param device_id The device identifier. Input parameter.
		55	* @param address The device local hardware address. Output parameter.
		56	* @param data The address data. Output parameter.
		57	* @returns EOK on success.
		58	* @returns EBADMEM if the address parameter is NULL.
		59	* @returns ENOENT if there no such device.
		60	* @returns Other error codes as defined for the netif_get_addr() function.
		61	*/
4307	mejdrech	62	int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );
4350	mejdrech	63
		64	/** Probes the existence of the device.
		65	* @param netif_phone The network interface phone. Input parameter.
		66	* @param device_id The device identifier. Input parameter.
		67	* @param irq The device interrupt number. Input parameter.
		68	* @param io The device input/output address. Input parameter.
		69	* @returns EOK on success.
		70	* @returns Other errro codes as defined for the netif_probe_message().
		71	*/
4307	mejdrech	72	int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );
4350	mejdrech	73
		74	/** Sends the packet queue.
		75	* @param netif_phone The network interface phone. Input parameter.
		76	* @param device_id The device identifier. Input parameter.
		77	* @param packet The packet queue. Input parameter.
		78	* @param sender The sending module service. Input parameter.
		79	* @returns EOK on success.
		80	* @returns Other error codes as defined for the generic_send_msg() function.
		81	*/
4307	mejdrech	82	int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );
4350	mejdrech	83
		84	/** Starts the device.
		85	* @param netif_phone The network interface phone. Input parameter.
		86	* @param device_id The device identifier. Input parameter.
		87	* @returns EOK on success.
		88	* @returns Other error codes as defined for the find_device() function.
		89	* @returns Other error codes as defined for the netif_start_message() function.
		90	*/
4307	mejdrech	91	int netif_start_req( int netif_phone, device_id_t device_id );
4350	mejdrech	92
		93	/** Stops the device.
		94	* @param netif_phone The network interface phone. Input parameter.
		95	* @param device_id The device identifier. Input parameter.
		96	* @returns EOK on success.
		97	* @returns Other error codes as defined for the find_device() function.
		98	* @returns Other error codes as defined for the netif_stop_message() function.
		99	*/
4307	mejdrech	100	int netif_stop_req( int netif_phone, device_id_t device_id );
4350	mejdrech	101
		102	/** Creates bidirectional connection with the network interface module service and registers the message receiver.
		103	* @param service The network interface module service. Input parameter.
		104	* @param device_id The device identifier. Input parameter.
		105	* @param me The requesting module service. Input parameter.
		106	* @param receiver The message receiver. Input parameter.
		107	* @returns The phone of the needed service.
		108	* @returns EOK on success.
		109	* @returns Other error codes as defined for the bind_service() function.
		110	*/
4307	mejdrech	111	int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );
4243	mejdrech	112
		113	#endif
		114
		115	/** @}
		116	*/

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/netif_interface.h – Rev 4350