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