WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/include/device.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 netif
 *  @{
 */
 
/** @file
 *  Device identifier, state and usage statistics.
 */
 
#ifndef __NET_DEVICE_ID_TYPE_H__
#define __NET_DEVICE_ID_TYPE_H__
 
#include "../structures/int_map.h"
 
/** Device identifier to generic type map declaration.
 */
#define DEVICE_MAP_DECLARE      INT_MAP_DECLARE
 
/** Device identifier to generic type map implementation.
 */
#define DEVICE_MAP_IMPLEMENT    INT_MAP_IMPLEMENT
 
/** Device identifier type.
 */
typedef int device_id_t;
 
/** Device state type.
 */
typedef enum device_state   device_state_t;
 
/** Type definition of the device usage statistics.
 *  @see device_stats
 */
typedef struct device_stats device_stats_t;
 
/** Type definition of the device usage statistics pointer.
 *  @see device_stats
 */
typedef device_stats_t *    device_stats_ref;
 
/** Device state.
 */
enum    device_state{
    /** Device not present or not initialized.
     */
    NETIF_NULL = 0,
    /** Device present and stopped.
     */
    NETIF_STOPPED,
    /** Device present and active.
     */
    NETIF_ACTIVE,
    /** Device present but unable to transmit.
     */
    NETIF_CARRIER_LOST
};
 
/** Device usage statistics.
 
 */
struct  device_stats{
    /** Total packets received.
     */
    unsigned long   receive_packets;
    /** Total packets transmitted.
     */
    unsigned long   send_packets;
    /** Total bytes received.
     */
    unsigned long   receive_bytes;
    /** Total bytes transmitted.
     */
    unsigned long   send_bytes;
    /** Bad packets received counter.
     */
    unsigned long   receive_errors;
    /** Packet transmition problems counter.
     */
    unsigned long   send_errors;
    /** No space in buffers counter.
     */
    unsigned long   receive_dropped;
    /** No space available counter.
     */
    unsigned long   send_dropped;
    /** Total multicast packets received.
     */
    unsigned long   multicast;
    /** The number of collisions due to congestion on the medium.
     */
    unsigned long   collisions;
 
    /* detailed receive_errors: */
    /** Received packet length error counter.
     */
    unsigned long   receive_length_errors;
    /** Receiver buffer overflow counter.
     */
    unsigned long   receive_over_errors;
    /** Received packet with crc error counter.
     */
    unsigned long   receive_crc_errors;
    /** Received frame alignment error counter.
     */
    unsigned long   receive_frame_errors;
    /** Receiver fifo overrun counter.
     */
    unsigned long   receive_fifo_errors;
    /** Receiver missed packet counter.
     */
    unsigned long   receive_missed_errors;
 
    /* detailed send_errors */
    /** Transmitter aborted counter.
     */
    unsigned long   send_aborted_errors;
    /** Transmitter carrier errors counter.
     */
    unsigned long   send_carrier_errors;
    /** Transmitter fifo overrun counter.
     */
    unsigned long   send_fifo_errors;
    /** Transmitter carrier errors counter.
     */
    unsigned long   send_heartbeat_errors;
    /** Transmitter window errors counter.
     */
    unsigned long   send_window_errors;
 
    /* for cslip etc */
    /** Total compressed packets received.
     */
    unsigned long   receive_compressed;
    /** Total compressed packet transmitted.
     */
    unsigned long   send_compressed;
};
 
#endif
 
/** @}
 */
 
 

Rev 4725	Rev 4728
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 netif	29	/** @addtogroup netif
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Device identifier, state and usage statistics.	34	* Device identifier, state and usage statistics.
35	*/	35	*/
36		36
37	#ifndef __NET_DEVICE_ID_TYPE_H__	37	#ifndef __NET_DEVICE_ID_TYPE_H__
38	#define __NET_DEVICE_ID_TYPE_H__	38	#define __NET_DEVICE_ID_TYPE_H__
39		39
40	#include "../structures/int_map.h"	40	#include "../structures/int_map.h"
41		41
42	/** Device identifier to generic type map declaration.	42	/** Device identifier to generic type map declaration.
43	*/	43	*/
44	#define DEVICE_MAP_DECLARE INT_MAP_DECLARE	44	#define DEVICE_MAP_DECLARE INT_MAP_DECLARE
45		45
46	/** Device identifier to generic type map implementation.	46	/** Device identifier to generic type map implementation.
47	*/	47	*/
48	#define DEVICE_MAP_IMPLEMENT INT_MAP_IMPLEMENT	48	#define DEVICE_MAP_IMPLEMENT INT_MAP_IMPLEMENT
49		49
50	/** Device identifier type.	50	/** Device identifier type.
51	*/	51	*/
52	typedef int device_id_t;	52	typedef int device_id_t;
53		53
54	/** Device state type.	54	/** Device state type.
55	*/	55	*/
56	typedef enum device_state device_state_t;	56	typedef enum device_state device_state_t;
57		57
58	/** Type definition of the device usage statistics.	58	/** Type definition of the device usage statistics.
59	* @see device_stats	59	* @see device_stats
60	*/	60	*/
61	typedef struct device_stats device_stats_t;	61	typedef struct device_stats device_stats_t;
62		62
63	/** Type definition of the device usage statistics pointer.	63	/** Type definition of the device usage statistics pointer.
64	* @see device_stats	64	* @see device_stats
65	*/	65	*/
66	typedef device_stats_t * device_stats_ref;	66	typedef device_stats_t * device_stats_ref;
67		67
68	/** Device state.	68	/** Device state.
69	*/	69	*/
70	enum device_state{	70	enum device_state{
71	/** Device not present or not initialized.	71	/** Device not present or not initialized.
72	*/	72	*/
73	NETIF_NULL = 0,	73	NETIF_NULL = 0,
74	/** Device present and stopped.	74	/** Device present and stopped.
75	*/	75	*/
76	NETIF_STOPPED,	76	NETIF_STOPPED,
77	/** Device present and active.	77	/** Device present and active.
78	*/	78	*/
79	NETIF_ACTIVE,	79	NETIF_ACTIVE,
80	/** Device present but unable to transmit.	80	/** Device present but unable to transmit.
81	*/	81	*/
82	NETIF_CARRIER_LOST	82	NETIF_CARRIER_LOST
83	};	83	};
84		84
85	/** Device usage statistics.	85	/** Device usage statistics.
86	* Based on linux_kernel/include/linux/netdevice.h.	-
87	*/	86	*/
88	struct device_stats{	87	struct device_stats{
89	/** Total packets received.	88	/** Total packets received.
90	*/	89	*/
91	unsigned long rx_packets;	90	unsigned long receive_packets;
92	/** Total packets transmitted.	91	/** Total packets transmitted.
93	*/	92	*/
94	unsigned long tx_packets;	93	unsigned long send_packets;
95	/** Total bytes received.	94	/** Total bytes received.
96	*/	95	*/
97	unsigned long rx_bytes;	96	unsigned long receive_bytes;
98	/** Total bytes transmitted.	97	/** Total bytes transmitted.
99	*/	98	*/
100	unsigned long tx_bytes;	99	unsigned long send_bytes;
101	/** Bad packets received counter.	100	/** Bad packets received counter.
102	*/	101	*/
103	unsigned long rx_errors;	102	unsigned long receive_errors;
104	/** Packet transmition problems counter.	103	/** Packet transmition problems counter.
105	*/	104	*/
106	unsigned long tx_errors;	105	unsigned long send_errors;
107	/** No space in buffers counter.	106	/** No space in buffers counter.
108	*/	107	*/
109	unsigned long rx_dropped;	108	unsigned long receive_dropped;
110	/** No space available counter.	109	/** No space available counter.
111	*/	110	*/
112	unsigned long tx_dropped;	111	unsigned long send_dropped;
113	/** Total multicast packets received.	112	/** Total multicast packets received.
114	*/	113	*/
115	unsigned long multicast;	114	unsigned long multicast;
116	/** The number of collisions due to congestion on the medium.	115	/** The number of collisions due to congestion on the medium.
117	*/	116	*/
118	unsigned long collisions;	117	unsigned long collisions;
119		118
120	/* detailed rx_errors: */	119	/* detailed receive_errors: */
121	/** Received packet length error counter.	120	/** Received packet length error counter.
122	*/	121	*/
123	unsigned long rx_length_errors;	122	unsigned long receive_length_errors;
124	/** Receiver buffer overflow counter.	123	/** Receiver buffer overflow counter.
125	*/	124	*/
126	unsigned long rx_over_errors;	125	unsigned long receive_over_errors;
127	/** Received packet with crc error counter.	126	/** Received packet with crc error counter.
128	*/	127	*/
129	unsigned long rx_crc_errors;	128	unsigned long receive_crc_errors;
130	/** Received frame alignment error counter.	129	/** Received frame alignment error counter.
131	*/	130	*/
132	unsigned long rx_frame_errors;	131	unsigned long receive_frame_errors;
133	/** Receiver fifo overrun counter.	132	/** Receiver fifo overrun counter.
134	*/	133	*/
135	unsigned long rx_fifo_errors;	134	unsigned long receive_fifo_errors;
136	/** Receiver missed packet counter.	135	/** Receiver missed packet counter.
137	*/	136	*/
138	unsigned long rx_missed_errors;	137	unsigned long receive_missed_errors;
139		138
140	/* detailed tx_errors */	139	/* detailed send_errors */
141	/** Transmitter aborted counter.	140	/** Transmitter aborted counter.
142	*/	141	*/
143	unsigned long tx_aborted_errors;	142	unsigned long send_aborted_errors;
144	/** Transmitter carrier errors counter.	143	/** Transmitter carrier errors counter.
145	*/	144	*/
146	unsigned long tx_carrier_errors;	145	unsigned long send_carrier_errors;
147	/** Transmitter fifo overrun counter.	146	/** Transmitter fifo overrun counter.
148	*/	147	*/
149	unsigned long tx_fifo_errors;	148	unsigned long send_fifo_errors;
150	/** Transmitter carrier errors counter.	149	/** Transmitter carrier errors counter.
151	*/	150	*/
152	unsigned long tx_heartbeat_errors;	151	unsigned long send_heartbeat_errors;
153	/** Transmitter window errors counter.	152	/** Transmitter window errors counter.
154	*/	153	*/
155	unsigned long tx_window_errors;	154	unsigned long send_window_errors;
156		155
157	/* for cslip etc */	156	/* for cslip etc */
158	/** Total compressed packets received.	157	/** Total compressed packets received.
159	*/	158	*/
160	unsigned long rx_compressed;	159	unsigned long receive_compressed;
161	/** Total compressed packet transmitted.	160	/** Total compressed packet transmitted.
162	*/	161	*/
163	unsigned long tx_compressed;	162	unsigned long send_compressed;
164	};	163	};
165		164
166	#endif	165	#endif
167		166
168	/** @}	167	/** @}
169	*/	168	*/
170		169
171		170

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/device.h – Rev 4725 → 4728