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

Subversion Repositories HelenOS

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