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

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/nil/eth/eth.h – Rev 4243 → 4261