[IPoIB] Fix NDIS WHQL 1c_Reset test failures.
[mirror/winof/.git] / ulp / ipoib / kernel / ipoib_adapter.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 #ifndef _IPOIB_ADAPTER_H_\r
34 #define _IPOIB_ADAPTER_H_\r
35 \r
36 #include <iba/ipoib_ifc.h>\r
37 #include <iba/ib_al.h>\r
38 #include <complib/cl_obj.h>\r
39 #include <complib/cl_spinlock.h>\r
40 #include <complib/cl_mutex.h>\r
41 #include <complib/cl_qpool.h>\r
42 #include <complib/cl_atomic.h>\r
43 #include <complib/cl_perf.h>\r
44 #include <complib/cl_vector.h>\r
45 #include "ip_packet.h"\r
46 #include "ip_stats.h"\r
47 \r
48 \r
49 /*\r
50  * Definitions\r
51  */\r
52 #define MAX_MCAST                               32\r
53 \r
54 #define IPV4_ADDR_SIZE                  4\r
55 \r
56 #define PORT_NUM_INDEX_IN_GUID  3 /* 0 based index into big endian GUID to get port number */\r
57 \r
58 /*\r
59  * Macros\r
60  */\r
61 \r
62 \r
63 typedef struct _ipoib_params\r
64 {\r
65         int32_t         rq_depth;\r
66         int32_t         sq_depth;\r
67         boolean_t       send_chksum_offload;\r
68         boolean_t       wsdp_enabled;\r
69         uint16_t        static_lid;\r
70         uint32_t        sa_timeout;\r
71         uint32_t        sa_retry_cnt;\r
72         uint32_t        recv_pool_ratio;\r
73         boolean_t       recv_growth;\r
74 }       ipoib_params_t;\r
75 /*\r
76 * FIELDS\r
77 *       rq_depth\r
78 *               Number of receive WQEs to allocate.\r
79 *\r
80 *       sq_depth\r
81 *               Number of send WQEs to allocate.\r
82 *\r
83 *       send_chksum_offload\r
84 *               Flag to indicate whether to offload send checksums.  This will make it\r
85 *               so that IPoIB packets should never be forwarded out of the IB subnet\r
86 *               without recalculating the checksum.\r
87 *\r
88 *       wsdp_enabled\r
89 *               Flag to indicate whether WSDP is enabled for an adapter adapter.\r
90 *\r
91 *       static_lid\r
92 *               LID to assign to the port if that port is down (not init) and has none.\r
93 *               This feature allows a LID to be assigned, alowing locally targetted\r
94 *               traffic to occur even on ports that are not plugged in.\r
95 *\r
96 *       sa_timeout\r
97 *               Time, in milliseconds, to wait for a response before retransmitting an\r
98 *               SA query request.\r
99 *\r
100 *       sa_retry_cnt\r
101 *               Number of times to retry an SA query request.\r
102 *\r
103 *       recv_pool_ratio\r
104 *               Initial ratio of receive pool size to receive queue depth.\r
105 *\r
106 *       grow_thresh\r
107 *               Threshold at which to grow the receive pool.  Valid values start are\r
108 *               powers of 2, excluding 1.  When zero, grows only when the pool is\r
109 *               exhausted.  Other values indicate fractional values\r
110 *               (i.e. 2 indicates 1/2, 4 indicates 1/4, etc.)\r
111 *********/\r
112 \r
113 \r
114 typedef struct _pending_oid\r
115 {\r
116         NDIS_OID                        oid;\r
117         PVOID                           p_buf;\r
118         ULONG                           buf_len;\r
119         PULONG                          p_bytes_used;\r
120         PULONG                          p_bytes_needed;\r
121 \r
122 }       pending_oid_t;\r
123 \r
124 \r
125 typedef struct _ipoib_adapter\r
126 {\r
127         cl_obj_t                                obj;\r
128         NDIS_HANDLE                             h_adapter;\r
129         ipoib_ifc_data_t                guids;\r
130 \r
131         cl_list_item_t                  entry;\r
132 \r
133         ib_al_handle_t                  h_al;\r
134         ib_pnp_handle_t                 h_pnp;\r
135 \r
136         ib_pnp_event_t                  state;\r
137         boolean_t                               hung;\r
138         boolean_t                               reset;\r
139         boolean_t                               registering;\r
140 \r
141         boolean_t                               pending_query;\r
142         pending_oid_t                   query_oid;\r
143         boolean_t                               pending_set;\r
144         pending_oid_t                   set_oid;\r
145 \r
146         struct _ipoib_port              *p_port;\r
147 \r
148         uint32_t                                rate;\r
149 \r
150         ipoib_params_t                  params;\r
151         cl_spinlock_t                   recv_stat_lock;\r
152         ip_stats_t                              recv_stats;\r
153         cl_spinlock_t                   send_stat_lock;\r
154         ip_stats_t                              send_stats;\r
155 \r
156         boolean_t                               is_primary;\r
157         struct _ipoib_adapter   *p_primary;\r
158 \r
159         uint32_t                                packet_filter;\r
160 \r
161         mac_addr_t                              mac;\r
162         mac_addr_t                              mcast_array[MAX_MCAST];\r
163         uint8_t                                 mcast_array_size;\r
164 \r
165         cl_qpool_t                              item_pool;\r
166 \r
167         cl_mutex_t                              mutex;\r
168 \r
169         cl_vector_t                             ip_vector;\r
170 \r
171         cl_perf_t                               perf;\r
172         ib_al_ifc_t                             *p_ifc;\r
173 \r
174 }       ipoib_adapter_t;\r
175 /*\r
176 * FIELDS\r
177 *       obj\r
178 *               Complib object for reference counting and destruction synchronization.\r
179 *\r
180 *       h_adapter\r
181 *               NDIS adapter handle.\r
182 *\r
183 *       guids\r
184 *               CA and port GUIDs returned by the bus driver.\r
185 *\r
186 *       entry\r
187 *               List item for storing all adapters in a list for address translation.\r
188 *               We add adapters when their packet filter is set to a non-zero value,\r
189 *               and remove them when their packet filter is cleared.  This is needed\r
190 *               since user-mode removal events are generated after the packet filter\r
191 *               is cleared, but before the adapter is destroyed.\r
192 *\r
193 *       h_al\r
194 *               AL handle for all IB resources.\r
195 *\r
196 *       h_pnp\r
197 *               PNP registration handle for port events.\r
198 *\r
199 *       state\r
200 *               State of the adapter.  IB_PNP_PORT_ADD indicates that the adapter\r
201 *               is ready to transfer data.\r
202 *\r
203 *       hung\r
204 *               Boolean flag used to return whether we are hung or not.\r
205 *\r
206 *       p_port\r
207 *               Pointer to an ipoib_port_t representing all resources for moving data\r
208 *               on the IB fabric.\r
209 *\r
210 *       rate\r
211 *               Rate, in 100bps increments, of the link.\r
212 *\r
213 *       params\r
214 *               Configuration parameters.\r
215 *\r
216 *       pending_query\r
217 *               Indicates that an query OID request is being processed asynchronously.\r
218 *\r
219 *       query_oid\r
220 *               Information about the pended query OID request.\r
221 *               Valid only if pending_query is TRUE.\r
222 *\r
223 *       pending_set\r
224 *               Indicates that an set OID request is being processed asynchronously.\r
225 *\r
226 *       set_oid\r
227 *               Information about the pended set OID request.\r
228 *               Valid only if pending_set is TRUE.\r
229 *\r
230 *       recv_lock\r
231 *               Spinlock protecting receive processing.\r
232 *\r
233 *       recv_stats\r
234 *               Receive statistics.\r
235 *\r
236 *       send_lock\r
237 *               Spinlock protecting send processing.\r
238 *\r
239 *       send_stats\r
240 *               Send statistics.\r
241 *\r
242 *       is_primary\r
243 *               Boolean flag to indicate if an adapter is the primary adapter\r
244 *               of a bundle.\r
245 *\r
246 *       p_primary\r
247 *               Pointer to the primary adapter for a bundle.\r
248 *\r
249 *       packet_filter\r
250 *               Packet filter set by NDIS.\r
251 *\r
252 *       mac_addr\r
253 *               Ethernet MAC address reported to NDIS.\r
254 *\r
255 *       mcast_array\r
256 *               List of multicast MAC addresses programmed by NDIS.\r
257 *\r
258 *       mcast_array_size\r
259 *               Number of entries in the multicat MAC address array;\r
260 *\r
261 *       item_pool\r
262 *               Pool of cl_pool_obj_t structures to use for queueing pending\r
263 *               packets for transmission.\r
264 *\r
265 *       mutex\r
266 *               Mutex to synchronized PnP callbacks with destruction.\r
267 *\r
268 *       ip_vector\r
269 *               Vector of assigned IP addresses.\r
270 *\r
271 *       p_ifc\r
272 *               Pointer to transport interface.\r
273 *\r
274 *********/\r
275 \r
276 \r
277 typedef struct _ats_reg\r
278 {\r
279         ipoib_adapter_t         *p_adapter;\r
280         ib_reg_svc_handle_t     h_reg_svc;\r
281 \r
282 }       ats_reg_t;\r
283 /*\r
284 * FIELDS\r
285 *       p_adapter\r
286 *               Pointer to the adapter to which this address is assigned.\r
287 *\r
288 *       h_reg_svc\r
289 *               Service registration handle.\r
290 *********/\r
291 \r
292 \r
293 typedef struct _net_address_item\r
294 {\r
295         ats_reg_t                       *p_reg;\r
296         union _net_address_item_address\r
297         {\r
298                 ULONG                   as_ulong;\r
299                 UCHAR                   as_bytes[IPV4_ADDR_SIZE];\r
300         }       address;\r
301 \r
302 }       net_address_item_t;\r
303 /*\r
304 * FIELDS\r
305 *       p_reg\r
306 *               Pointer to the ATS registration assigned to this address.\r
307 *\r
308 *       address\r
309 *               Union representing the IP address as an unsigned long or as\r
310 *               an array of bytes.\r
311 *\r
312 *       as_ulong\r
313 *               The IP address represented as an unsigned long.  Windows stores\r
314 *               IPs this way.\r
315 *\r
316 *       as_bytes\r
317 *               The IP address represented as an array of bytes.\r
318 *********/\r
319 \r
320 \r
321 ib_api_status_t\r
322 ipoib_create_adapter(\r
323         IN              NDIS_HANDLE                     wrapper_config_context,\r
324         IN              void* const                     h_adapter,\r
325         OUT             ipoib_adapter_t**  const        pp_adapter );\r
326 \r
327 \r
328 ib_api_status_t\r
329 ipoib_start_adapter(\r
330         IN                              ipoib_adapter_t* const          p_adapter );\r
331 \r
332 \r
333 void\r
334 ipoib_destroy_adapter(\r
335         IN                              ipoib_adapter_t* const          p_adapter );\r
336 \r
337 \r
338 /* Joins/leaves mcast groups based on currently programmed mcast MACs. */\r
339 void\r
340 ipoib_refresh_mcast(\r
341         IN                              ipoib_adapter_t* const          p_adapter,\r
342         IN                              mac_addr_t* const                       p_mac_array,\r
343         IN              const   uint8_t                                         num_macs );\r
344 /*\r
345 * PARAMETERS\r
346 *       p_adapter\r
347 *               Instance whose multicast MAC address list to modify.\r
348 *\r
349 *       p_mac_array\r
350 *               Array of multicast MAC addresses assigned to the adapter.\r
351 *\r
352 *       num_macs\r
353 *               Number of MAC addresses in the array.\r
354 *********/\r
355 \r
356 \r
357 NDIS_STATUS\r
358 ipoib_get_recv_stat(\r
359         IN                              ipoib_adapter_t* const          p_adapter,\r
360         IN              const   ip_stat_sel_t                           stat_sel,\r
361         IN                              pending_oid_t* const            p_oid_info );\r
362 \r
363 \r
364 void\r
365 ipoib_inc_recv_stat(\r
366         IN                              ipoib_adapter_t* const          p_adapter,\r
367         IN              const   ip_stat_sel_t                           stat_sel,\r
368         IN              const   size_t                                          bytes OPTIONAL );\r
369 \r
370 \r
371 NDIS_STATUS\r
372 ipoib_get_send_stat(\r
373         IN                              ipoib_adapter_t* const          p_adapter,\r
374         IN              const   ip_stat_sel_t                           stat_sel,\r
375         IN                              pending_oid_t* const            p_oid_info );\r
376 \r
377 \r
378 void\r
379 ipoib_inc_send_stat(\r
380         IN                              ipoib_adapter_t* const          p_adapter,\r
381         IN              const   ip_stat_sel_t                           stat_sel,\r
382         IN              const   size_t                                          bytes OPTIONAL );\r
383 \r
384 \r
385 void\r
386 ipoib_set_rate(\r
387         IN                              ipoib_adapter_t* const          p_adapter,\r
388         IN              const   uint8_t                                         link_width,\r
389         IN              const   uint8_t                                         link_speed );\r
390 \r
391 \r
392 void\r
393 ipoib_set_active(\r
394         IN                              ipoib_adapter_t* const          p_adapter );\r
395 \r
396 \r
397 ib_api_status_t\r
398 ipoib_reset_adapter(\r
399         IN                              ipoib_adapter_t* const          p_adapter );\r
400 \r
401 void\r
402 ipoib_reg_addrs(\r
403         IN                              ipoib_adapter_t* const          p_adapter );\r
404 \r
405 void\r
406 ipoib_dereg_addrs(\r
407         IN                              ipoib_adapter_t* const          p_adapter );\r
408 \r
409 #endif  /* _IPOIB_ADAPTER_H_ */\r