Added expansion of Id keyword for all C, CPP, and H files
[mirror/winof/.git] / ulp / ipoib / ip_stats.h
1 /*\r
2  * Copyright (c) 2005 SilverStorm Technologies.  All rights reserved.\r
3  *\r
4  * This software is available to you under the OpenIB.org BSD license\r
5  * below:\r
6  *\r
7  *     Redistribution and use in source and binary forms, with or\r
8  *     without modification, are permitted provided that the following\r
9  *     conditions are met:\r
10  *\r
11  *      - Redistributions of source code must retain the above\r
12  *        copyright notice, this list of conditions and the following\r
13  *        disclaimer.\r
14  *\r
15  *      - Redistributions in binary form must reproduce the above\r
16  *        copyright notice, this list of conditions and the following\r
17  *        disclaimer in the documentation and/or other materials\r
18  *        provided with the distribution.\r
19  *\r
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
23  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\r
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\r
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r
27  * SOFTWARE.\r
28  *\r
29  * $Id:$\r
30  */\r
31 \r
32 /*\r
33         $Revision$\r
34 */\r
35 \r
36 #ifndef _IP_STATS_H_\r
37 #define _IP_STATS_H_\r
38 \r
39 \r
40 #include <complib/cl_types.h>\r
41 \r
42 \r
43 /****s* IB Network Drivers/ip_data_stats_t\r
44 * NAME\r
45 *       ip_data_stats_t\r
46 *\r
47 * DESCRIPTION\r
48 *       Defines data transfer statistic information for an IP device.\r
49 *\r
50 * SYNOPSIS\r
51 */\r
52 typedef struct _ip_data_stats\r
53 {\r
54         uint64_t                bytes;\r
55         uint64_t                frames;\r
56 \r
57 }       ip_data_stats_t;\r
58 /*\r
59 * FIELDS\r
60 *       bytes\r
61 *               Total number of bytes transfered.\r
62 *\r
63 *       frames\r
64 *               Total number of frames transfered.\r
65 *\r
66 * SEE ALSO\r
67 *       IPoIB, INIC, ip_comp_stats_t, ip_stats_t\r
68 *********/\r
69 \r
70 \r
71 /****s* IB Network Drivers/ip_comp_stats_t\r
72 * NAME\r
73 *       ip_comp_stats_t\r
74 *\r
75 * DESCRIPTION\r
76 *       Defines transfer completion statistic information for an IP device.\r
77 *\r
78 * SYNOPSIS\r
79 */\r
80 typedef struct _ip_comp_stats\r
81 {\r
82         uint64_t                success;\r
83         uint64_t                error;\r
84         uint64_t                dropped;\r
85 \r
86 }       ip_comp_stats_t;\r
87 /*\r
88 * FIELDS\r
89 *       success\r
90 *               Total number of requests transfered successfully.\r
91 *\r
92 *       error\r
93 *               Total number of requests that failed being transfered.\r
94 *\r
95 *       dropped\r
96 *               Total number of requests that were dropped.\r
97 *\r
98 * SEE ALSO\r
99 *       IPoIB, INIC, ip_data_stats_t, ip_stats_t\r
100 *********/\r
101 \r
102 \r
103 /****s* IB Network Drivers/ip_stats_t\r
104 * NAME\r
105 *       ip_stats_t\r
106 *\r
107 * DESCRIPTION\r
108 *       Defines statistic information for an IP device.\r
109 *\r
110 * SYNOPSIS\r
111 */\r
112 typedef struct _ip_stats\r
113 {\r
114         ip_comp_stats_t         comp;\r
115         ip_data_stats_t         ucast;\r
116         ip_data_stats_t         bcast;\r
117         ip_data_stats_t         mcast;\r
118 \r
119 }       ip_stats_t;\r
120 /*\r
121 * FIELDS\r
122 *       comp\r
123 *               Request completion statistics.\r
124 *\r
125 *       ucast\r
126 *               Data statistics for unicast packets\r
127 *\r
128 *       bcast\r
129 *               Data statistics for broadcast packets\r
130 *\r
131 *       mcast\r
132 *               Data statistics for multicast packets\r
133 *\r
134 * SEE ALSO\r
135 *       IPoIB, INIC, ip_data_stats_t, ip_comp_stats_t\r
136 *********/\r
137 \r
138 \r
139 typedef enum _ip_stat_sel\r
140 {\r
141         IP_STAT_SUCCESS,\r
142         IP_STAT_ERROR,\r
143         IP_STAT_DROPPED,\r
144         IP_STAT_UCAST_BYTES,\r
145         IP_STAT_UCAST_FRAMES,\r
146         IP_STAT_BCAST_BYTES,\r
147         IP_STAT_BCAST_FRAMES,\r
148         IP_STAT_MCAST_BYTES,\r
149         IP_STAT_MCAST_FRAMES\r
150 \r
151 }       ip_stat_sel_t;\r
152 \r
153 #endif  /* _IP_STATS_H_ */\r