WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/nil/eth/eth.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 eth
 *  @{
 */
 
/**
 * @file
 */
 
#ifndef __NET_ETH_H__
#define __NET_ETH_H__
 
#include <rwlock.h>
#include <ipc/ipc.h>
#include <ipc/services.h>
 
#include "../../include/sockaddr.h"
#include "../../netif/device.h"
#include "../../structures/measured_strings.h"
 
/** Type definition of the Ethernet global data.
 *  @see eth_globals
 */
typedef struct eth_globals  eth_globals_t;
 
/** Type definition of the Ethernet device specific data.
 *  @see eth_device
 */
typedef struct eth_device   eth_device_t;
 
/** Type definition of the Ethernet device specific data pointer.
 *  @see eth_device
 */
typedef eth_device_t *      eth_device_ref;
 
/** Type definition of the Ethernet protocol specific data.
 *  @see eth_proto
 */
typedef struct eth_proto    eth_proto_t;
 
/** Type definition of the Ethernet protocol specific data pointer.
 *  @see eth_proto
 */
typedef eth_proto_t *       eth_proto_ref;
 
/** Ethernet address cache.
 *  Maps devices to the Ethernet device specific data.
 *  @see device.h
 */
DEVICE_MAP_DECLARE( eth_devices, eth_device_t )
 
/** Ethernet protocol map.
 *  Maps protocol identifiers to the Ethernet protocol specific data.
 *  @see int_map.h
 */
INT_MAP_DECLARE( eth_protos, eth_proto_t )
 
/** Ethernet device specific data.
 */
struct  eth_device{
    /** Device identifier.
     */
    device_id_t         device_id;
    /** Device driver service.
     */
    services_t          service;
    /** Driver phone.
     */
    int                 phone;
    /** Maximal transmission unit.
     */
    size_t              mtu;
    /** Dummy device.
     *  Preamble and FCS are mandatory part of the packets.
     */
    int                 dummy;
    /** Actual device hardware address.
     */
    measured_string_ref addr;
    /** Actual device hardware address data.
     */
    char *              addr_data;
};
 
/** Ethernet protocol specific data.
 */
struct eth_proto{
    /** Protocol service.
     */
    services_t  service;
    /** Protocol identifier.
     */
    int         protocol;
    /** Protocol module phone.
     */
    int         phone;
};
 
/** Ethernet global data.
 */
struct  eth_globals{
    /** Networking module phone.
     */
    int             networking_phone;
    /** Safety lock for devices.
     */
    rwlock_t        devices_lock;
    /** All known Ethernet devices.
     */
    eth_devices_t   devices;
    /** Safety lock for protocols.
     */
    rwlock_t        protos_lock;
    /** Protocol map.
     *  Service phone map for each protocol.
     */
    eth_protos_t    protos;
    /** Broadcast device hardware address.
     */
    measured_string_ref broadcast_addr;
};
 
#endif
 
/** @}
 */
 

Rev 3992	Rev 4153
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 eth	29	/** @addtogroup eth
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/**	33	/**
34	* @file	34	* @file
35	*/	35	*/
36		36
37	#ifndef __NET_ETH_H__	37	#ifndef __NET_ETH_H__
38	#define __NET_ETH_H__	38	#define __NET_ETH_H__
39		39
40	#include <rwlock.h>	40	#include <rwlock.h>
41	#include <ipc/ipc.h>	41	#include <ipc/ipc.h>
42	#include <ipc/services.h>	42	#include <ipc/services.h>
43		43
44	#include "../../include/sockaddr.h"	44	#include "../../include/sockaddr.h"
45	#include "../../netif/device.h"	45	#include "../../netif/device.h"
46	#include "../../structures/measured_strings.h"	46	#include "../../structures/measured_strings.h"
47		47
48	/** Type definition of the Ethernet global data.	48	/** Type definition of the Ethernet global data.
49	* @see eth_globals	49	* @see eth_globals
50	*/	50	*/
51	typedef struct eth_globals eth_globals_t;	51	typedef struct eth_globals eth_globals_t;
52		52
53	/** Type definition of the Ethernet device specific data.	53	/** Type definition of the Ethernet device specific data.
54	* @see eth_device	54	* @see eth_device
55	*/	55	*/
56	typedef struct eth_device eth_device_t;	56	typedef struct eth_device eth_device_t;
57		57
58	/** Type definition of the Ethernet device specific data pointer.	58	/** Type definition of the Ethernet device specific data pointer.
59	* @see eth_device	59	* @see eth_device
60	*/	60	*/
61	typedef eth_device_t * eth_device_ref;	61	typedef eth_device_t * eth_device_ref;
62		62
63	/** Type definition of the Ethernet protocol specific data.	63	/** Type definition of the Ethernet protocol specific data.
64	* @see eth_proto	64	* @see eth_proto
65	*/	65	*/
66	typedef struct eth_proto eth_proto_t;	66	typedef struct eth_proto eth_proto_t;
67		67
68	/** Type definition of the Ethernet protocol specific data pointer.	68	/** Type definition of the Ethernet protocol specific data pointer.
69	* @see eth_proto	69	* @see eth_proto
70	*/	70	*/
71	typedef eth_proto_t * eth_proto_ref;	71	typedef eth_proto_t * eth_proto_ref;
72		72
73	/** Ethernet address cache.	73	/** Ethernet address cache.
74	* Maps devices to the Ethernet device specific data.	74	* Maps devices to the Ethernet device specific data.
75	* @see device.h	75	* @see device.h
76	*/	76	*/
77	DEVICE_MAP_DECLARE( eth_devices, eth_device_t )	77	DEVICE_MAP_DECLARE( eth_devices, eth_device_t )
78		78
79	/** Ethernet protocol map.	79	/** Ethernet protocol map.
80	* Maps protocol identifiers to the Ethernet protocol specific data.	80	* Maps protocol identifiers to the Ethernet protocol specific data.
81	* @see int_map.h	81	* @see int_map.h
82	*/	82	*/
83	INT_MAP_DECLARE( eth_protos, eth_proto_t )	83	INT_MAP_DECLARE( eth_protos, eth_proto_t )
84		84
85	/** Ethernet device specific data.	85	/** Ethernet device specific data.
86	*/	86	*/
87	struct eth_device{	87	struct eth_device{
88	/** Device identifier.	88	/** Device identifier.
89	*/	89	*/
90	device_id_t device_id;	90	device_id_t device_id;
91	/** Device driver service.	91	/** Device driver service.
92	*/	92	*/
93	services_t service;	93	services_t service;
94	/** Driver phone.	94	/** Driver phone.
95	*/	95	*/
96	int phone;	96	int phone;
97	/** Maximal transmission unit.	97	/** Maximal transmission unit.
98	*/	98	*/
99	size_t mtu;	99	size_t mtu;
-		100	/** Dummy device.
-		101	* Preamble and FCS are mandatory part of the packets.
-		102	*/
-		103	int dummy;
100	/** Actual device hardware address.	104	/** Actual device hardware address.
101	*/	105	*/
102	measured_string_ref addr;	106	measured_string_ref addr;
103	/** Actual device hardware address data.	107	/** Actual device hardware address data.
104	*/	108	*/
105	char * addr_data;	109	char * addr_data;
106	};	110	};
107		111
108	/** Ethernet protocol specific data.	112	/** Ethernet protocol specific data.
109	*/	113	*/
110	struct eth_proto{	114	struct eth_proto{
111	/** Protocol service.	115	/** Protocol service.
112	*/	116	*/
113	services_t service;	117	services_t service;
114	/** Protocol identifier.	118	/** Protocol identifier.
115	*/	119	*/
116	int protocol;	120	int protocol;
117	/** Protocol module phone.	121	/** Protocol module phone.
118	*/	122	*/
119	int phone;	123	int phone;
120	};	124	};
121		125
122	/** Ethernet global data.	126	/** Ethernet global data.
123	*/	127	*/
124	struct eth_globals{	128	struct eth_globals{
125	/** Networking module phone.	129	/** Networking module phone.
126	*/	130	*/
127	int networking_phone;	131	int networking_phone;
128	/** Safety lock for devices.	132	/** Safety lock for devices.
129	*/	133	*/
130	rwlock_t devices_lock;	134	rwlock_t devices_lock;
131	/** All known Ethernet devices.	135	/** All known Ethernet devices.
132	*/	136	*/
133	eth_devices_t devices;	137	eth_devices_t devices;
134	/** Safety lock for protocols.	138	/** Safety lock for protocols.
135	*/	139	*/
136	rwlock_t protos_lock;	140	rwlock_t protos_lock;
137	/** Protocol map.	141	/** Protocol map.
138	* Service phone map for each protocol.	142	* Service phone map for each protocol.
139	*/	143	*/
140	eth_protos_t protos;	144	eth_protos_t protos;
141	/** Broadcast device hardware address.	145	/** Broadcast device hardware address.
142	*/	146	*/
143	measured_string_ref broadcast_addr;	147	measured_string_ref broadcast_addr;
144	};	148	};
145		149
146	#endif	150	#endif
147		151
148	/** @}	152	/** @}
149	*/	153	*/
150		154

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/nil/eth/eth.h @ 4720 – Rev 3992 → 4153