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

Rev	Author	Line No.	Line
4261	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 net_nil
		30	* @{
		31	*/
		32
4350	mejdrech	33	/** @file
		34	* Network interface layer interface.
		35	* The same interface is used for standalone remote device modules as well as for bundle device modules.
		36	* The standalone remote device modules have to be compiled with the nil_remote.c source file.
		37	* The bundle device modules with the appropriate network interface layer source file (eth.c etc.).
		38	* The upper layers cannot be bundled with the network interface layer.
4261	mejdrech	39	*/
		40
4307	mejdrech	41	#ifndef __NET_NIL_INTERFACE_H__
		42	#define __NET_NIL_INTERFACE_H__
4261	mejdrech	43
		44	#include <async.h>
		45	#include <errno.h>
		46
		47	#include <ipc/ipc.h>
		48
		49	#include "../messages.h"
		50
		51	#include "../structures/measured_strings.h"
		52	#include "../structures/packet/packet.h"
		53
4307	mejdrech	54	#include "../nil/nil_messages.h"
		55
4261	mejdrech	56	#include "device.h"
		57
4350	mejdrech	58	/** Returns the device local hardware address.
		59	* @param nil_phone The network interface layer phone. Input parameter.
		60	* @param device_id The device identifier. Input parameter.
		61	* @param address The device local hardware address. Output parameter.
		62	* @param data The address data. Output parameter.
		63	* @returns EOK on success.
		64	* @returns EBADMEM if the address parameter is NULL.
		65	* @returns ENOENT if there no such device.
		66	* @returns Other error codes as defined for the generic_get_addr() function.
		67	*/
4261	mejdrech	68	#define nil_get_addr( nil_phone, device_id, address, data ) \
		69	generic_get_addr( nil_phone, NET_NIL_ADDR, device_id, address, data )
		70
4350	mejdrech	71	/** Returns the device broadcast hardware address.
		72	* @param nil_phone The network interface layer phone. Input parameter.
		73	* @param device_id The device identifier. Input parameter.
		74	* @param address The device broadcast hardware address. Output parameter.
		75	* @param data The address data. Output parameter.
		76	* @returns EOK on success.
		77	* @returns EBADMEM if the address parameter is NULL.
		78	* @returns ENOENT if there no such device.
		79	* @returns Other error codes as defined for the generic_get_addr() function.
		80	*/
4261	mejdrech	81	#define nil_get_broadcast_addr( nil_phone, device_id, address, data ) \
		82	generic_get_addr( nil_phone, NET_NIL_BROADCAST_ADDR, device_id, address, data )
		83
4350	mejdrech	84	/** Sends the packet queue.
		85	* @param nil_phone The network interface layer phone. Input parameter.
		86	* @param device_id The device identifier. Input parameter.
		87	* @param packet The packet queue. Input parameter.
		88	* @param sender The sending module service. Input parameter.
		89	* @returns EOK on success.
		90	* @returns Other error codes as defined for the generic_send_msg() function.
		91	*/
4261	mejdrech	92	#define nil_send_msg( nil_phone, device_id, packet, sender ) \
		93	generic_send_msg( nil_phone, NET_NIL_SEND, device_id, packet_get_id( packet ), sender )
		94
4350	mejdrech	95	/** Returns the device packet dimensions for sending.
		96	* @param nil_phone The network interface layer phone. Input parameter.
		97	* @param device_id The device identifier. Input parameter.
		98	* @param addr_len The minimum reserved address length. Output parameter.
		99	* @param prefix The minimum reserved prefix size. Output parameter.
		100	* @param content The maximum content size. Output parameter.
		101	* @param suffix The minimum reserved suffix size. Output parameter.
		102	* @returns EOK on success.
		103	* @returns EBADMEM if either one of the parameters is NULL.
		104	* @returns ENOENT if there is no such device.
		105	* @returns Other error codes as defined for the generic_packet_size_req() function.
		106	*/
4261	mejdrech	107	#define nil_packet_size_req( nil_phone, device_id, addr_len, prefix, content, suffix ) \
		108	generic_packet_size_req( nil_phone, NET_NIL_PACKET_SPACE, device_id, addr_len, prefix, content, suffix )
		109
4350	mejdrech	110	/** Registers new device or updates the MTU of an existing one.
		111	* @param nil_phone The network interface layer phone. Input parameter.
		112	* @param device_id The new device identifier. Input parameter.
		113	* @param mtu The device maximum transmission unit. Input parameter.
		114	* @param netif_service The device driver service. Input parameter.
		115	* @returns EOK on success.
		116	* @returns EEXIST if the device with the different service exists.
		117	* @returns ENOMEM if there is not enough memory left.
		118	* @returns Other error codes as defined for the generic_device_req() function.
		119	*/
4261	mejdrech	120	#define nil_device_req( nil_phone, device_id, mtu, netif_service ) \
		121	generic_device_req( nil_phone, NET_NIL_DEVICE, device_id, mtu, netif_service )
		122
4350	mejdrech	123	/** Notifies the network interface layer about the device state change.
		124	* @param nil_phone The network interface layer phone. Input parameter.
		125	* @param device_id The device identifier. Input parameter.
		126	* @param state The new device state. Input parameter.
		127	* @returns EOK on success.
		128	* @returns Other error codes as defined for each specific module device state function.
		129	*/
4307	mejdrech	130	int nil_device_state_msg( int nil_phone, device_id_t device_id, int state );
4261	mejdrech	131
4350	mejdrech	132	/** Passes the packet queue to the network interface layer.
		133	* Processes and redistributes the received packet queue to the registered upper layers.
		134	* @param nil_phone The network interface layer phone. Input parameter.
		135	* @param device_id The source device identifier. Input parameter.
		136	* @param packet The received packet or the received packet queue. Input parameter.
		137	* @param target The target service. Ignored parameter.
		138	* @returns EOK on success.
		139	* @returns Other error codes as defined for each specific module received function.
		140	*/
4307	mejdrech	141	int nil_received_msg( int nil_phone, device_id_t device_id, packet_t packet, services_t target );
		142
4261	mejdrech	143	#endif
		144
		145	/** @}
		146	*/

Subversion Repositories HelenOS

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