[infiniband] Pass address vector in receive completions
[people/mcb30/gpxe.git] / src / drivers / net / ipoib.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <stdio.h>
21 #include <unistd.h>
22 #include <string.h>
23 #include <byteswap.h>
24 #include <errno.h>
25 #include <gpxe/if_arp.h>
26 #include <gpxe/iobuf.h>
27 #include <gpxe/netdevice.h>
28 #include <gpxe/infiniband.h>
29 #include <gpxe/ipoib.h>
30
31 /** @file
32  *
33  * IP over Infiniband
34  */
35
36 /** Number of IPoIB data send work queue entries */
37 #define IPOIB_DATA_NUM_SEND_WQES 2
38
39 /** Number of IPoIB data receive work queue entries */
40 #define IPOIB_DATA_NUM_RECV_WQES 4
41
42 /** Number of IPoIB data completion entries */
43 #define IPOIB_DATA_NUM_CQES 8
44
45 /** Number of IPoIB metadata send work queue entries */
46 #define IPOIB_META_NUM_SEND_WQES 2
47
48 /** Number of IPoIB metadata receive work queue entries */
49 #define IPOIB_META_NUM_RECV_WQES 2
50
51 /** Number of IPoIB metadata completion entries */
52 #define IPOIB_META_NUM_CQES 8
53
54 /** An IPoIB queue set */
55 struct ipoib_queue_set {
56         /** Completion queue */
57         struct ib_completion_queue *cq;
58         /** Queue pair */
59         struct ib_queue_pair *qp;
60         /** Receive work queue maximum fill level */
61         unsigned int recv_max_fill;
62 };
63
64 /** An IPoIB device */
65 struct ipoib_device {
66         /** Network device */
67         struct net_device *netdev;
68         /** Underlying Infiniband device */
69         struct ib_device *ibdev;
70         /** Data queue set */
71         struct ipoib_queue_set data;
72         /** Data queue set */
73         struct ipoib_queue_set meta;
74         /** Broadcast GID */
75         struct ib_gid broadcast_gid;
76         /** Broadcast LID */
77         unsigned int broadcast_lid;
78         /** Data queue key */
79         unsigned long data_qkey;
80         /** Attached to multicast group
81          *
82          * This flag indicates whether or not we have attached our
83          * data queue pair to the broadcast multicast GID.
84          */
85         int broadcast_attached;
86 };
87
88 /**
89  * IPoIB path cache entry
90  *
91  * This serves a similar role to the ARP cache for Ethernet.  (ARP
92  * *is* used on IPoIB; we have two caches to maintain.)
93  */
94 struct ipoib_cached_path {
95         /** Destination GID */
96         struct ib_gid gid;
97         /** Destination LID */
98         unsigned int dlid;
99         /** Service level */
100         unsigned int sl;
101         /** Rate */
102         unsigned int rate;
103 };
104
105 /** Number of IPoIB path cache entries */
106 #define IPOIB_NUM_CACHED_PATHS 2
107
108 /** IPoIB path cache */
109 static struct ipoib_cached_path ipoib_path_cache[IPOIB_NUM_CACHED_PATHS];
110
111 /** Oldest IPoIB path cache entry index */
112 static unsigned int ipoib_path_cache_idx = 0;
113
114 /** TID half used to identify get path record replies */
115 #define IPOIB_TID_GET_PATH_REC 0x11111111UL
116
117 /** TID half used to identify multicast member record replies */
118 #define IPOIB_TID_MC_MEMBER_REC 0x22222222UL
119
120 /** IPoIB metadata TID */
121 static uint32_t ipoib_meta_tid = 0;
122
123 /** IPv4 broadcast GID */
124 static const struct ib_gid ipv4_broadcast_gid = {
125         { { 0xff, 0x12, 0x40, 0x1b, 0x00, 0x00, 0x00, 0x00,
126             0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff } }
127 };
128
129 /** Maximum time we will wait for the broadcast join to succeed */
130 #define IPOIB_JOIN_MAX_DELAY_MS 1000
131
132 /****************************************************************************
133  *
134  * IPoIB link layer
135  *
136  ****************************************************************************
137  */
138
139 /** Broadcast QPN used in IPoIB MAC addresses
140  *
141  * This is a guaranteed invalid real QPN
142  */
143 #define IPOIB_BROADCAST_QPN 0xffffffffUL
144
145 /** Broadcast IPoIB address */
146 static struct ipoib_mac ipoib_broadcast = {
147         .qpn = ntohl ( IPOIB_BROADCAST_QPN ),
148 };
149
150 /**
151  * Add IPoIB link-layer header
152  *
153  * @v iobuf             I/O buffer
154  * @v ll_dest           Link-layer destination address
155  * @v ll_source         Source link-layer address
156  * @v net_proto         Network-layer protocol, in network-byte order
157  * @ret rc              Return status code
158  */
159 static int ipoib_push ( struct io_buffer *iobuf, const void *ll_dest,
160                         const void *ll_source __unused, uint16_t net_proto ) {
161         struct ipoib_hdr *ipoib_hdr =
162                 iob_push ( iobuf, sizeof ( *ipoib_hdr ) );
163
164         /* Build IPoIB header */
165         memcpy ( &ipoib_hdr->pseudo.peer, ll_dest,
166                  sizeof ( ipoib_hdr->pseudo.peer ) );
167         ipoib_hdr->real.proto = net_proto;
168         ipoib_hdr->real.reserved = 0;
169
170         return 0;
171 }
172
173 /**
174  * Remove IPoIB link-layer header
175  *
176  * @v iobuf             I/O buffer
177  * @ret ll_dest         Link-layer destination address
178  * @ret ll_source       Source link-layer address
179  * @ret net_proto       Network-layer protocol, in network-byte order
180  * @ret rc              Return status code
181  */
182 static int ipoib_pull ( struct io_buffer *iobuf, const void **ll_dest,
183                         const void **ll_source, uint16_t *net_proto ) {
184         struct ipoib_hdr *ipoib_hdr = iobuf->data;
185
186         /* Sanity check */
187         if ( iob_len ( iobuf ) < sizeof ( *ipoib_hdr ) ) {
188                 DBG ( "IPoIB packet too short for link-layer header\n" );
189                 DBG_HD ( iobuf->data, iob_len ( iobuf ) );
190                 return -EINVAL;
191         }
192
193         /* Strip off IPoIB header */
194         iob_pull ( iobuf, sizeof ( *ipoib_hdr ) );
195
196         /* Fill in required fields */
197         *ll_dest = &ipoib_broadcast; /* Doesn't really exist in packet */
198         *ll_source = &ipoib_hdr->pseudo.peer;
199         *net_proto = ipoib_hdr->real.proto;
200
201         return 0;
202 }
203
204 /**
205  * Transcribe IPoIB address
206  *
207  * @v ll_addr   Link-layer address
208  * @ret string  Link-layer address in human-readable format
209  */
210 const char * ipoib_ntoa ( const void *ll_addr ) {
211         static char buf[45];
212         const struct ipoib_mac *mac = ll_addr;
213
214         snprintf ( buf, sizeof ( buf ), "%08lx:%08lx:%08lx:%08lx:%08lx",
215                    htonl ( mac->qpn ), htonl ( mac->gid.u.dwords[0] ),
216                    htonl ( mac->gid.u.dwords[1] ),
217                    htonl ( mac->gid.u.dwords[2] ),
218                    htonl ( mac->gid.u.dwords[3] ) );
219         return buf;
220 }
221
222 /**
223  * Hash multicast address
224  *
225  * @v af                Address family
226  * @v net_addr          Network-layer address
227  * @v ll_addr           Link-layer address to fill in
228  * @ret rc              Return status code
229  */
230 static int ipoib_mc_hash ( unsigned int af __unused,
231                            const void *net_addr __unused,
232                            void *ll_addr __unused ) {
233
234         return -ENOTSUP;
235 }
236
237 /** IPoIB protocol */
238 struct ll_protocol ipoib_protocol __ll_protocol = {
239         .name           = "IPoIB",
240         .ll_proto       = htons ( ARPHRD_INFINIBAND ),
241         .ll_addr_len    = IPOIB_ALEN,
242         .ll_header_len  = IPOIB_HLEN,
243         .ll_broadcast   = ( uint8_t * ) &ipoib_broadcast,
244         .push           = ipoib_push,
245         .pull           = ipoib_pull,
246         .ntoa           = ipoib_ntoa,
247         .mc_hash        = ipoib_mc_hash,
248 };
249
250 /****************************************************************************
251  *
252  * IPoIB network device
253  *
254  ****************************************************************************
255  */
256
257 /**
258  * Destroy queue set
259  *
260  * @v ipoib             IPoIB device
261  * @v qset              Queue set
262  */
263 static void ipoib_destroy_qset ( struct ipoib_device *ipoib,
264                                  struct ipoib_queue_set *qset ) {
265         struct ib_device *ibdev = ipoib->ibdev;
266
267         if ( qset->qp )
268                 ib_destroy_qp ( ibdev, qset->qp );
269         if ( qset->cq )
270                 ib_destroy_cq ( ibdev, qset->cq );
271         memset ( qset, 0, sizeof ( *qset ) );
272 }
273
274 /**
275  * Create queue set
276  *
277  * @v ipoib             IPoIB device
278  * @v qset              Queue set
279  * @v num_cqes          Number of completion queue entries
280  * @v cq_op             Completion queue operations
281  * @v num_send_wqes     Number of send work queue entries
282  * @v num_recv_wqes     Number of receive work queue entries
283  * @v qkey              Queue key
284  * @ret rc              Return status code
285  */
286 static int ipoib_create_qset ( struct ipoib_device *ipoib,
287                                struct ipoib_queue_set *qset,
288                                unsigned int num_cqes,
289                                struct ib_completion_queue_operations *cq_op,
290                                unsigned int num_send_wqes,
291                                unsigned int num_recv_wqes,
292                                unsigned long qkey ) {
293         struct ib_device *ibdev = ipoib->ibdev;
294         int rc;
295
296         /* Sanity check */
297         assert ( qset->cq == NULL );
298         assert ( qset->qp == NULL );
299
300         /* Store queue parameters */
301         qset->recv_max_fill = num_recv_wqes;
302
303         /* Allocate completion queue */
304         qset->cq = ib_create_cq ( ibdev, num_cqes, cq_op );
305         if ( ! qset->cq ) {
306                 DBGC ( ipoib, "IPoIB %p could not allocate completion queue\n",
307                        ipoib );
308                 rc = -ENOMEM;
309                 goto err;
310         }
311
312         /* Allocate queue pair */
313         qset->qp = ib_create_qp ( ibdev, num_send_wqes, qset->cq,
314                                   num_recv_wqes, qset->cq, qkey );
315         if ( ! qset->qp ) {
316                 DBGC ( ipoib, "IPoIB %p could not allocate queue pair\n",
317                        ipoib );
318                 rc = -ENOMEM;
319                 goto err;
320         }
321         ib_qp_set_ownerdata ( qset->qp, ipoib->netdev );
322
323         return 0;
324
325  err:
326         ipoib_destroy_qset ( ipoib, qset );
327         return rc;
328 }
329
330 /**
331  * Find path cache entry by GID
332  *
333  * @v gid               GID
334  * @ret entry           Path cache entry, or NULL
335  */
336 static struct ipoib_cached_path *
337 ipoib_find_cached_path ( struct ib_gid *gid ) {
338         struct ipoib_cached_path *path;
339         unsigned int i;
340
341         for ( i = 0 ; i < IPOIB_NUM_CACHED_PATHS ; i++ ) {
342                 path = &ipoib_path_cache[i];
343                 if ( memcmp ( &path->gid, gid, sizeof ( *gid ) ) == 0 )
344                         return path;
345         }
346         DBG ( "IPoIB %08lx:%08lx:%08lx:%08lx cache miss\n",
347               htonl ( gid->u.dwords[0] ), htonl ( gid->u.dwords[1] ),
348               htonl ( gid->u.dwords[2] ), htonl ( gid->u.dwords[3] ) );
349         return NULL;
350 }
351
352 /**
353  * Transmit path record request
354  *
355  * @v ipoib             IPoIB device
356  * @v gid               Destination GID
357  * @ret rc              Return status code
358  */
359 static int ipoib_get_path_record ( struct ipoib_device *ipoib,
360                                    struct ib_gid *gid ) {
361         struct ib_device *ibdev = ipoib->ibdev;
362         struct io_buffer *iobuf;
363         struct ib_mad_path_record *path_record;
364         struct ib_address_vector av;
365         int rc;
366
367         /* Allocate I/O buffer */
368         iobuf = alloc_iob ( sizeof ( *path_record ) );
369         if ( ! iobuf )
370                 return -ENOMEM;
371         iob_put ( iobuf, sizeof ( *path_record ) );
372         path_record = iobuf->data;
373         memset ( path_record, 0, sizeof ( *path_record ) );
374
375         /* Construct path record request */
376         path_record->mad_hdr.base_version = IB_MGMT_BASE_VERSION;
377         path_record->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
378         path_record->mad_hdr.class_version = 2;
379         path_record->mad_hdr.method = IB_MGMT_METHOD_GET;
380         path_record->mad_hdr.attr_id = htons ( IB_SA_ATTR_PATH_REC );
381         path_record->mad_hdr.tid[0] = IPOIB_TID_GET_PATH_REC;
382         path_record->mad_hdr.tid[1] = ipoib_meta_tid++;
383         path_record->sa_hdr.comp_mask[1] =
384                 htonl ( IB_SA_PATH_REC_DGID | IB_SA_PATH_REC_SGID );
385         memcpy ( &path_record->dgid, gid, sizeof ( path_record->dgid ) );
386         memcpy ( &path_record->sgid, &ibdev->port_gid,
387                  sizeof ( path_record->sgid ) );
388
389         /* Construct address vector */
390         memset ( &av, 0, sizeof ( av ) );
391         av.lid = ibdev->sm_lid;
392         av.qpn = IB_SA_QPN;
393         av.qkey = IB_GLOBAL_QKEY;
394
395         /* Post send request */
396         if ( ( rc = ib_post_send ( ibdev, ipoib->meta.qp, &av,
397                                    iobuf ) ) != 0 ) {
398                 DBGC ( ipoib, "IPoIB %p could not send get path record: %s\n",
399                        ipoib, strerror ( rc ) );
400                 free_iob ( iobuf );
401                 return rc;
402         }
403
404         return 0;
405 }
406
407 /**
408  * Transmit multicast group membership request
409  *
410  * @v ipoib             IPoIB device
411  * @v gid               Multicast GID
412  * @v join              Join (rather than leave) group
413  * @ret rc              Return status code
414  */
415 static int ipoib_mc_member_record ( struct ipoib_device *ipoib,
416                                     struct ib_gid *gid, int join ) {
417         struct ib_device *ibdev = ipoib->ibdev;
418         struct io_buffer *iobuf;
419         struct ib_mad_mc_member_record *mc_member_record;
420         struct ib_address_vector av;
421         int rc;
422
423         /* Allocate I/O buffer */
424         iobuf = alloc_iob ( sizeof ( *mc_member_record ) );
425         if ( ! iobuf )
426                 return -ENOMEM;
427         iob_put ( iobuf, sizeof ( *mc_member_record ) );
428         mc_member_record = iobuf->data;
429         memset ( mc_member_record, 0, sizeof ( *mc_member_record ) );
430
431         /* Construct path record request */
432         mc_member_record->mad_hdr.base_version = IB_MGMT_BASE_VERSION;
433         mc_member_record->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
434         mc_member_record->mad_hdr.class_version = 2;
435         mc_member_record->mad_hdr.method = 
436                 ( join ? IB_MGMT_METHOD_SET : IB_MGMT_METHOD_DELETE );
437         mc_member_record->mad_hdr.attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC );
438         mc_member_record->mad_hdr.tid[0] = IPOIB_TID_MC_MEMBER_REC;
439         mc_member_record->mad_hdr.tid[1] = ipoib_meta_tid++;
440         mc_member_record->sa_hdr.comp_mask[1] =
441                 htonl ( IB_SA_MCMEMBER_REC_MGID | IB_SA_MCMEMBER_REC_PORT_GID |
442                         IB_SA_MCMEMBER_REC_JOIN_STATE );
443         mc_member_record->scope__join_state = 1;
444         memcpy ( &mc_member_record->mgid, gid,
445                  sizeof ( mc_member_record->mgid ) );
446         memcpy ( &mc_member_record->port_gid, &ibdev->port_gid,
447                  sizeof ( mc_member_record->port_gid ) );
448
449         /* Construct address vector */
450         memset ( &av, 0, sizeof ( av ) );
451         av.lid = ibdev->sm_lid;
452         av.qpn = IB_SA_QPN;
453         av.qkey = IB_GLOBAL_QKEY;
454
455         /* Post send request */
456         if ( ( rc = ib_post_send ( ibdev, ipoib->meta.qp, &av,
457                                    iobuf ) ) != 0 ) {
458                 DBGC ( ipoib, "IPoIB %p could not send get path record: %s\n",
459                        ipoib, strerror ( rc ) );
460                 free_iob ( iobuf );
461                 return rc;
462         }
463
464         return 0;
465 }
466
467 /**
468  * Transmit packet via IPoIB network device
469  *
470  * @v netdev            Network device
471  * @v iobuf             I/O buffer
472  * @ret rc              Return status code
473  */
474 static int ipoib_transmit ( struct net_device *netdev,
475                             struct io_buffer *iobuf ) {
476         struct ipoib_device *ipoib = netdev->priv;
477         struct ib_device *ibdev = ipoib->ibdev;
478         struct ipoib_pseudo_hdr *ipoib_pshdr = iobuf->data;
479         struct ib_address_vector av;
480         struct ib_gid *gid;
481         struct ipoib_cached_path *path;
482         int rc;
483
484         /* Sanity check */
485         if ( iob_len ( iobuf ) < sizeof ( *ipoib_pshdr ) ) {
486                 DBGC ( ipoib, "IPoIB %p buffer too short\n", ipoib );
487                 return -EINVAL;
488         }
489         iob_pull ( iobuf, ( sizeof ( *ipoib_pshdr ) ) );
490
491         /* Attempting transmission while link is down will put the
492          * queue pair into an error state, so don't try it.
493          */
494         if ( ! ibdev->link_up )
495                 return -ENETUNREACH;
496
497         /* Construct address vector */
498         memset ( &av, 0, sizeof ( av ) );
499         av.qkey = IB_GLOBAL_QKEY;
500         av.gid_present = 1;
501         if ( ipoib_pshdr->peer.qpn == htonl ( IPOIB_BROADCAST_QPN ) ) {
502                 /* Broadcast address */
503                 av.qpn = IB_BROADCAST_QPN;
504                 av.lid = ipoib->broadcast_lid;
505                 gid = &ipoib->broadcast_gid;
506         } else {
507                 /* Unicast - look in path cache */
508                 path = ipoib_find_cached_path ( &ipoib_pshdr->peer.gid );
509                 if ( ! path ) {
510                         /* No path entry - get path record */
511                         rc = ipoib_get_path_record ( ipoib,
512                                                      &ipoib_pshdr->peer.gid );
513                         netdev_tx_complete ( netdev, iobuf );
514                         return rc;
515                 }
516                 av.qpn = ntohl ( ipoib_pshdr->peer.qpn );
517                 av.lid = path->dlid;
518                 av.rate = path->rate;
519                 av.sl = path->sl;
520                 gid = &ipoib_pshdr->peer.gid;
521         }
522         memcpy ( &av.gid, gid, sizeof ( av.gid ) );
523
524         return ib_post_send ( ibdev, ipoib->data.qp, &av, iobuf );
525 }
526
527 /**
528  * Handle IPoIB data send completion
529  *
530  * @v ibdev             Infiniband device
531  * @v qp                Queue pair
532  * @v iobuf             I/O buffer
533  * @v rc                Completion status code
534  */
535 static void ipoib_data_complete_send ( struct ib_device *ibdev __unused,
536                                        struct ib_queue_pair *qp,
537                                        struct io_buffer *iobuf, int rc ) {
538         struct net_device *netdev = ib_qp_get_ownerdata ( qp );
539
540         netdev_tx_complete_err ( netdev, iobuf, rc );
541 }
542
543 /**
544  * Handle IPoIB data receive completion
545  *
546  * @v ibdev             Infiniband device
547  * @v qp                Queue pair
548  * @v av                Address vector, or NULL
549  * @v iobuf             I/O buffer
550  * @v rc                Completion status code
551  */
552 static void ipoib_data_complete_recv ( struct ib_device *ibdev __unused,
553                                        struct ib_queue_pair *qp,
554                                        struct ib_address_vector *av __unused,
555                                        struct io_buffer *iobuf, int rc ) {
556         struct net_device *netdev = ib_qp_get_ownerdata ( qp );
557         struct ipoib_device *ipoib = netdev->priv;
558         struct ipoib_pseudo_hdr *ipoib_pshdr;
559
560         if ( rc != 0 ) {
561                 netdev_rx_err ( netdev, iobuf, rc );
562                 return;
563         }
564
565         if ( iob_len ( iobuf ) < sizeof ( struct ipoib_real_hdr ) ) {
566                 DBGC ( ipoib, "IPoIB %p received data packet too short to "
567                        "contain IPoIB header\n", ipoib );
568                 DBGC_HD ( ipoib, iobuf->data, iob_len ( iobuf ) );
569                 netdev_rx_err ( netdev, iobuf, -EIO );
570                 return;
571         }
572
573         ipoib_pshdr = iob_push ( iobuf, sizeof ( *ipoib_pshdr ) );
574         /* FIXME: fill in a MAC address for the sake of AoE! */
575
576         netdev_rx ( netdev, iobuf );
577 }
578
579 /** IPoIB data completion operations */
580 static struct ib_completion_queue_operations ipoib_data_cq_op = {
581         .complete_send = ipoib_data_complete_send,
582         .complete_recv = ipoib_data_complete_recv,
583 };
584
585 /**
586  * Handle IPoIB metadata send completion
587  *
588  * @v ibdev             Infiniband device
589  * @v qp                Queue pair
590  * @v iobuf             I/O buffer
591  * @v rc                Completion status code
592  */
593 static void ipoib_meta_complete_send ( struct ib_device *ibdev __unused,
594                                        struct ib_queue_pair *qp,
595                                        struct io_buffer *iobuf, int rc ) {
596         struct net_device *netdev = ib_qp_get_ownerdata ( qp );
597         struct ipoib_device *ipoib = netdev->priv;
598
599         if ( rc != 0 ) {
600                 DBGC ( ipoib, "IPoIB %p metadata TX completion error: %s\n",
601                        ipoib, strerror ( rc ) );
602         }
603         free_iob ( iobuf );
604 }
605
606 /**
607  * Handle received IPoIB path record
608  *
609  * @v ipoib             IPoIB device
610  * @v path_record       Path record
611  */
612 static void ipoib_recv_path_record ( struct ipoib_device *ipoib __unused,
613                                      struct ib_mad_path_record *path_record ) {
614         struct ipoib_cached_path *path;
615
616         /* Update path cache entry */
617         path = &ipoib_path_cache[ipoib_path_cache_idx];
618         memcpy ( &path->gid, &path_record->dgid, sizeof ( path->gid ) );
619         path->dlid = ntohs ( path_record->dlid );
620         path->sl = ( path_record->reserved__sl & 0x0f );
621         path->rate = ( path_record->rate_selector__rate & 0x3f );
622
623         DBG ( "IPoIB %08lx:%08lx:%08lx:%08lx dlid %x sl %x rate %x\n",
624               htonl ( path->gid.u.dwords[0] ), htonl ( path->gid.u.dwords[1] ),
625               htonl ( path->gid.u.dwords[2] ), htonl ( path->gid.u.dwords[3] ),
626               path->dlid, path->sl, path->rate );
627         
628         /* Update path cache index */
629         ipoib_path_cache_idx++;
630         if ( ipoib_path_cache_idx == IPOIB_NUM_CACHED_PATHS )
631                 ipoib_path_cache_idx = 0;
632 }
633
634 /**
635  * Handle received IPoIB multicast membership record
636  *
637  * @v ipoib             IPoIB device
638  * @v mc_member_record  Multicast membership record
639  */
640 static void ipoib_recv_mc_member_record ( struct ipoib_device *ipoib,
641                           struct ib_mad_mc_member_record *mc_member_record ) {
642         int joined;
643         int rc;
644
645         /* Record parameters */
646         joined = ( mc_member_record->scope__join_state & 0x0f );
647         ipoib->data_qkey = ntohl ( mc_member_record->qkey );
648         ipoib->broadcast_lid = ntohs ( mc_member_record->mlid );
649         DBGC ( ipoib, "IPoIB %p %s broadcast group: qkey %lx mlid %x\n",
650                ipoib, ( joined ? "joined" : "left" ), ipoib->data_qkey,
651                ipoib->broadcast_lid );
652
653         /* Update data queue pair qkey */
654         if ( ( rc = ib_modify_qp ( ipoib->ibdev, ipoib->data.qp,
655                                    IB_MODIFY_QKEY, ipoib->data_qkey ) ) != 0 ){
656                 DBGC ( ipoib, "IPoIB %p could not update data qkey: %s\n",
657                        ipoib, strerror ( rc ) );
658                 return;
659         }
660 }
661
662 /**
663  * Handle IPoIB metadata receive completion
664  *
665  * @v ibdev             Infiniband device
666  * @v qp                Queue pair
667  * @v av                Address vector, or NULL
668  * @v iobuf             I/O buffer
669  * @v rc                Completion status code
670  */
671 static void
672 ipoib_meta_complete_recv ( struct ib_device *ibdev __unused,
673                            struct ib_queue_pair *qp,
674                            struct ib_address_vector *av __unused,
675                            struct io_buffer *iobuf, int rc ) {
676         struct net_device *netdev = ib_qp_get_ownerdata ( qp );
677         struct ipoib_device *ipoib = netdev->priv;
678         union ib_mad *mad;
679
680         if ( rc != 0 ) {
681                 DBGC ( ipoib, "IPoIB %p metadata RX completion error: %s\n",
682                        ipoib, strerror ( rc ) );
683                 goto done;
684         }
685
686         if ( iob_len ( iobuf ) < sizeof ( *mad ) ) {
687                 DBGC ( ipoib, "IPoIB %p received metadata packet too short "
688                        "to contain reply\n", ipoib );
689                 DBGC_HD ( ipoib, iobuf->data, iob_len ( iobuf ) );
690                 goto done;
691         }
692         mad = iobuf->data;
693
694         if ( mad->mad_hdr.status != 0 ) {
695                 DBGC ( ipoib, "IPoIB %p metadata RX err status %04x\n",
696                        ipoib, ntohs ( mad->mad_hdr.status ) );
697                 goto done;
698         }
699
700         switch ( mad->mad_hdr.tid[0] ) {
701         case IPOIB_TID_GET_PATH_REC:
702                 ipoib_recv_path_record ( ipoib, &mad->path_record );
703                 break;
704         case IPOIB_TID_MC_MEMBER_REC:
705                 ipoib_recv_mc_member_record ( ipoib, &mad->mc_member_record );
706                 break;
707         default:
708                 DBGC ( ipoib, "IPoIB %p unwanted response:\n",
709                        ipoib );
710                 DBGC_HD ( ipoib, mad, sizeof ( *mad ) );
711                 break;
712         }
713
714  done:
715         free_iob ( iobuf );
716 }
717
718 /** IPoIB metadata completion operations */
719 static struct ib_completion_queue_operations ipoib_meta_cq_op = {
720         .complete_send = ipoib_meta_complete_send,
721         .complete_recv = ipoib_meta_complete_recv,
722 };
723
724 /**
725  * Refill IPoIB receive ring
726  *
727  * @v ipoib             IPoIB device
728  */
729 static void ipoib_refill_recv ( struct ipoib_device *ipoib,
730                                 struct ipoib_queue_set *qset ) {
731         struct ib_device *ibdev = ipoib->ibdev;
732         struct io_buffer *iobuf;
733         int rc;
734
735         while ( qset->qp->recv.fill < qset->recv_max_fill ) {
736                 iobuf = alloc_iob ( IPOIB_PKT_LEN );
737                 if ( ! iobuf )
738                         break;
739                 if ( ( rc = ib_post_recv ( ibdev, qset->qp, iobuf ) ) != 0 ) {
740                         free_iob ( iobuf );
741                         break;
742                 }
743         }
744 }
745
746 /**
747  * Poll IPoIB network device
748  *
749  * @v netdev            Network device
750  */
751 static void ipoib_poll ( struct net_device *netdev ) {
752         struct ipoib_device *ipoib = netdev->priv;
753         struct ib_device *ibdev = ipoib->ibdev;
754
755         ib_poll_cq ( ibdev, ipoib->meta.cq );
756         ib_poll_cq ( ibdev, ipoib->data.cq );
757         ipoib_refill_recv ( ipoib, &ipoib->meta );
758         ipoib_refill_recv ( ipoib, &ipoib->data );
759 }
760
761 /**
762  * Enable/disable interrupts on IPoIB network device
763  *
764  * @v netdev            Network device
765  * @v enable            Interrupts should be enabled
766  */
767 static void ipoib_irq ( struct net_device *netdev __unused,
768                         int enable __unused ) {
769         /* No implementation */
770 }
771
772 /**
773  * Join IPv4 broadcast multicast group
774  *
775  * @v ipoib             IPoIB device
776  * @ret rc              Return status code
777  */
778 static int ipoib_join_broadcast_group ( struct ipoib_device *ipoib ) {
779         int rc;
780
781         /* Sanity check */
782         if ( ! ipoib->data.qp )
783                 return 0;
784
785         /* Attach data queue to broadcast multicast GID */
786         assert ( ipoib->broadcast_attached == 0 );
787         if ( ( rc = ib_mcast_attach ( ipoib->ibdev, ipoib->data.qp,
788                                       &ipoib->broadcast_gid ) ) != 0 ){
789                 DBGC ( ipoib, "IPoIB %p could not attach to broadcast GID: "
790                        "%s\n", ipoib, strerror ( rc ) );
791                 return rc;
792         }
793         ipoib->broadcast_attached = 1;
794
795         /* Initiate broadcast group join */
796         if ( ( rc = ipoib_mc_member_record ( ipoib, &ipoib->broadcast_gid,
797                                              1 ) ) != 0 ) {
798                 DBGC ( ipoib, "IPoIB %p could not send broadcast join: %s\n",
799                        ipoib, strerror ( rc ) );
800                 return rc;
801         }
802
803         /* We will set link up on the network device when we receive
804          * the broadcast join response.
805          */
806
807         return 0;
808 }
809
810 /**
811  * Leave IPv4 broadcast multicast group
812  *
813  * @v ipoib             IPoIB device
814  */
815 static void ipoib_leave_broadcast_group ( struct ipoib_device *ipoib ) {
816
817         /* Detach data queue from broadcast multicast GID */
818         if ( ipoib->broadcast_attached ) {
819                 assert ( ipoib->data.qp != NULL );
820                 ib_mcast_detach ( ipoib->ibdev, ipoib->data.qp,
821                                   &ipoib->broadcast_gid );
822                 ipoib->broadcast_attached = 0;
823         }
824 }
825
826 /**
827  * Open IPoIB network device
828  *
829  * @v netdev            Network device
830  * @ret rc              Return status code
831  */
832 static int ipoib_open ( struct net_device *netdev ) {
833         struct ipoib_device *ipoib = netdev->priv;
834         struct ipoib_mac *mac = ( ( struct ipoib_mac * ) netdev->ll_addr );
835         int rc;
836
837         /* Allocate metadata queue set */
838         if ( ( rc = ipoib_create_qset ( ipoib, &ipoib->meta,
839                                         IPOIB_META_NUM_CQES,
840                                         &ipoib_meta_cq_op,
841                                         IPOIB_META_NUM_SEND_WQES,
842                                         IPOIB_META_NUM_RECV_WQES,
843                                         IB_GLOBAL_QKEY ) ) != 0 ) {
844                 DBGC ( ipoib, "IPoIB %p could not allocate metadata QP: %s\n",
845                        ipoib, strerror ( rc ) );
846                 goto err_create_meta_qset;
847         }
848
849         /* Allocate data queue set */
850         if ( ( rc = ipoib_create_qset ( ipoib, &ipoib->data,
851                                         IPOIB_DATA_NUM_CQES,
852                                         &ipoib_data_cq_op,
853                                         IPOIB_DATA_NUM_SEND_WQES,
854                                         IPOIB_DATA_NUM_RECV_WQES,
855                                         IB_GLOBAL_QKEY ) ) != 0 ) {
856                 DBGC ( ipoib, "IPoIB %p could not allocate data QP: %s\n",
857                        ipoib, strerror ( rc ) );
858                 goto err_create_data_qset;
859         }
860
861         /* Update MAC address with data QPN */
862         mac->qpn = htonl ( ipoib->data.qp->qpn );
863
864         /* Fill receive rings */
865         ipoib_refill_recv ( ipoib, &ipoib->meta );
866         ipoib_refill_recv ( ipoib, &ipoib->data );
867
868         /* Join broadcast group */
869         if ( ( rc = ipoib_join_broadcast_group ( ipoib ) ) != 0 ) {
870                 DBGC ( ipoib, "IPoIB %p could not join broadcast group: %s\n",
871                        ipoib, strerror ( rc ) );
872                 goto err_join_broadcast;
873         }
874
875         return 0;
876
877  err_join_broadcast:
878         ipoib_destroy_qset ( ipoib, &ipoib->data );
879  err_create_data_qset:
880         ipoib_destroy_qset ( ipoib, &ipoib->meta );
881  err_create_meta_qset:
882         return rc;
883 }
884
885 /**
886  * Close IPoIB network device
887  *
888  * @v netdev            Network device
889  */
890 static void ipoib_close ( struct net_device *netdev ) {
891         struct ipoib_device *ipoib = netdev->priv;
892         struct ipoib_mac *mac = ( ( struct ipoib_mac * ) netdev->ll_addr );
893
894         /* Leave broadcast group */
895         ipoib_leave_broadcast_group ( ipoib );
896
897         /* Remove data QPN from MAC address */
898         mac->qpn = 0;
899
900         /* Tear down the queues */
901         ipoib_destroy_qset ( ipoib, &ipoib->data );
902         ipoib_destroy_qset ( ipoib, &ipoib->meta );
903 }
904
905 /** IPoIB network device operations */
906 static struct net_device_operations ipoib_operations = {
907         .open           = ipoib_open,
908         .close          = ipoib_close,
909         .transmit       = ipoib_transmit,
910         .poll           = ipoib_poll,
911         .irq            = ipoib_irq,
912 };
913
914 /**
915  * Update IPoIB dynamic Infiniband parameters
916  *
917  * @v ipoib             IPoIB device
918  *
919  * The Infiniband port GID and partition key will change at runtime,
920  * when the link is established (or lost).  The MAC address is based
921  * on the port GID, and the broadcast GID is based on the partition
922  * key.  This function recalculates these IPoIB device parameters.
923  */
924 static void ipoib_set_ib_params ( struct ipoib_device *ipoib ) {
925         struct ib_device *ibdev = ipoib->ibdev;
926         struct net_device *netdev = ipoib->netdev;
927         struct ipoib_mac *mac;
928
929         /* Calculate GID portion of MAC address based on port GID */
930         mac = ( ( struct ipoib_mac * ) netdev->ll_addr );
931         memcpy ( &mac->gid, &ibdev->port_gid, sizeof ( mac->gid ) );
932
933         /* Calculate broadcast GID based on partition key */
934         memcpy ( &ipoib->broadcast_gid, &ipv4_broadcast_gid,
935                  sizeof ( ipoib->broadcast_gid ) );
936         ipoib->broadcast_gid.u.words[2] = htons ( ibdev->pkey );
937
938         /* Set net device link state to reflect Infiniband link state */
939         if ( ibdev->link_up ) {
940                 netdev_link_up ( netdev );
941         } else {
942                 netdev_link_down ( netdev );
943         }
944 }
945
946 /**
947  * Handle link status change
948  *
949  * @v ibdev             Infiniband device
950  */
951 void ipoib_link_state_changed ( struct ib_device *ibdev ) {
952         struct net_device *netdev = ib_get_ownerdata ( ibdev );
953         struct ipoib_device *ipoib = netdev->priv;
954         int rc;
955
956         /* Leave existing broadcast group */
957         ipoib_leave_broadcast_group ( ipoib );
958
959         /* Update MAC address and broadcast GID based on new port GID
960          * and partition key.
961          */
962         ipoib_set_ib_params ( ipoib );
963
964         /* Join new broadcast group */
965         if ( ( rc = ipoib_join_broadcast_group ( ipoib ) ) != 0 ) {
966                 DBGC ( ipoib, "IPoIB %p could not rejoin broadcast group: "
967                        "%s\n", ipoib, strerror ( rc ) );
968                 return;
969         }
970 }
971
972 /**
973  * Probe IPoIB device
974  *
975  * @v ibdev             Infiniband device
976  * @ret rc              Return status code
977  */
978 int ipoib_probe ( struct ib_device *ibdev ) {
979         struct net_device *netdev;
980         struct ipoib_device *ipoib;
981         int rc;
982
983         /* Allocate network device */
984         netdev = alloc_ipoibdev ( sizeof ( *ipoib ) );
985         if ( ! netdev )
986                 return -ENOMEM;
987         netdev_init ( netdev, &ipoib_operations );
988         ipoib = netdev->priv;
989         ib_set_ownerdata ( ibdev, netdev );
990         netdev->dev = ibdev->dev;
991         memset ( ipoib, 0, sizeof ( *ipoib ) );
992         ipoib->netdev = netdev;
993         ipoib->ibdev = ibdev;
994
995         /* Calculate as much of the broadcast GID and the MAC address
996          * as we can.  We won't know either of these in full until we
997          * have link-up.
998          */
999         ipoib_set_ib_params ( ipoib );
1000
1001         /* Register network device */
1002         if ( ( rc = register_netdev ( netdev ) ) != 0 )
1003                 goto err_register_netdev;
1004
1005         return 0;
1006
1007  err_register_netdev:
1008         netdev_nullify ( netdev );
1009         netdev_put ( netdev );
1010         return rc;
1011 }
1012
1013 /**
1014  * Remove IPoIB device
1015  *
1016  * @v ibdev             Infiniband device
1017  */
1018 void ipoib_remove ( struct ib_device *ibdev ) {
1019         struct net_device *netdev = ib_get_ownerdata ( ibdev );
1020
1021         unregister_netdev ( netdev );
1022         netdev_nullify ( netdev );
1023         netdev_put ( netdev );
1024 }