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