771d2a07abee3072f41e29e350361031c2685563
[people/meteger/gpxe.git] / src / include / gpxe / infiniband.h
1 #ifndef _GPXE_INFINIBAND_H
2 #define _GPXE_INFINIBAND_H
3
4 /** @file
5  *
6  * Infiniband protocol
7  *
8  */
9
10 FILE_LICENCE ( GPL2_OR_LATER );
11
12 #include <stdint.h>
13 #include <gpxe/refcnt.h>
14 #include <gpxe/device.h>
15 #include <gpxe/ib_packet.h>
16 #include <gpxe/ib_mad.h>
17
18 /** Subnet management interface QPN */
19 #define IB_QPN_SMI 0
20
21 /** Subnet management interface queue key */
22 #define IB_QKEY_SMI 0
23
24 /** General service interface QPN */
25 #define IB_QPN_GSI 1
26
27 /** General service interface queue key */
28 #define IB_QKEY_GSI 0x80010000UL
29
30 /** Broadcast QPN */
31 #define IB_QPN_BROADCAST 0xffffffUL
32
33 /** Default Infiniband partition key */
34 #define IB_PKEY_NONE 0xffff
35
36 /**
37  * Maximum payload size
38  *
39  * This is currently hard-coded in various places (drivers, subnet
40  * management agent, etc.) to 2048.
41  */
42 #define IB_MAX_PAYLOAD_SIZE 2048
43
44 struct ib_device;
45 struct ib_queue_pair;
46 struct ib_address_vector;
47 struct ib_completion_queue;
48 struct ib_mad_interface;
49
50 /** Infiniband transmission rates */
51 enum ib_rate {
52         IB_RATE_2_5 = 2,
53         IB_RATE_10 = 3,
54         IB_RATE_30 = 4,
55         IB_RATE_5 = 5,
56         IB_RATE_20 = 6,
57         IB_RATE_40 = 7,
58         IB_RATE_60 = 8,
59         IB_RATE_80 = 9,
60         IB_RATE_120 = 10,
61 };
62
63 /** An Infiniband Address Vector */
64 struct ib_address_vector {
65         /** Queue Pair Number */
66         unsigned long qpn;
67         /** Queue key
68          *
69          * Not specified for received packets.
70          */
71         unsigned long qkey;
72         /** Local ID */
73         unsigned int lid;
74         /** Rate
75          *
76          * Not specified for received packets.
77          */
78         enum ib_rate rate;
79         /** Service level */
80         unsigned int sl;
81         /** GID is present */
82         unsigned int gid_present;
83         /** GID, if present */
84         struct ib_gid gid;
85 };
86
87 /** An Infiniband Work Queue */
88 struct ib_work_queue {
89         /** Containing queue pair */
90         struct ib_queue_pair *qp;
91         /** "Is a send queue" flag */
92         int is_send;
93         /** Associated completion queue */
94         struct ib_completion_queue *cq;
95         /** List of work queues on this completion queue */
96         struct list_head list;
97         /** Packet sequence number */
98         uint32_t psn;
99         /** Number of work queue entries */
100         unsigned int num_wqes;
101         /** Number of occupied work queue entries */
102         unsigned int fill;
103         /** Next work queue entry index
104          *
105          * This is the index of the next entry to be filled (i.e. the
106          * first empty entry).  This value is not bounded by num_wqes;
107          * users must logical-AND with (num_wqes-1) to generate an
108          * array index.
109          */
110         unsigned long next_idx;
111         /** I/O buffers assigned to work queue */
112         struct io_buffer **iobufs;
113         /** Driver private data */
114         void *drv_priv;
115 };
116
117 /** An Infiniband multicast GID */
118 struct ib_multicast_gid {
119         /** List of multicast GIDs on this QP */
120         struct list_head list;
121         /** Multicast GID */
122         struct ib_gid gid;
123 };
124
125 /** An Infiniband queue pair type */
126 enum ib_queue_pair_type {
127         IB_QPT_SMI,
128         IB_QPT_GSI,
129         IB_QPT_UD,
130         IB_QPT_RC,
131 };
132
133 /** An Infiniband Queue Pair */
134 struct ib_queue_pair {
135         /** Containing Infiniband device */
136         struct ib_device *ibdev;
137         /** List of queue pairs on this Infiniband device */
138         struct list_head list;
139         /** Queue pair number */
140         unsigned long qpn;
141         /** Externally-visible queue pair number
142          *
143          * This may differ from the real queue pair number (e.g. when
144          * the HCA cannot use the management QPNs 0 and 1 as hardware
145          * QPNs and needs to remap them).
146          */
147         unsigned long ext_qpn;
148         /** Queue pair type */
149         enum ib_queue_pair_type type;
150         /** Queue key */
151         unsigned long qkey;
152         /** Send queue */
153         struct ib_work_queue send;
154         /** Receive queue */
155         struct ib_work_queue recv;
156         /** List of multicast GIDs */
157         struct list_head mgids;
158         /** Address vector */
159         struct ib_address_vector av;
160         /** Driver private data */
161         void *drv_priv;
162         /** Queue owner private data */
163         void *owner_priv;
164 };
165
166 /** Infiniband completion queue operations */
167 struct ib_completion_queue_operations {
168         /**
169          * Complete Send WQE
170          *
171          * @v ibdev             Infiniband device
172          * @v qp                Queue pair
173          * @v iobuf             I/O buffer
174          * @v rc                Completion status code
175          */
176         void ( * complete_send ) ( struct ib_device *ibdev,
177                                    struct ib_queue_pair *qp,
178                                    struct io_buffer *iobuf, int rc );
179         /**
180          * Complete Receive WQE
181          *
182          * @v ibdev             Infiniband device
183          * @v qp                Queue pair
184          * @v av                Address vector, or NULL
185          * @v iobuf             I/O buffer
186          * @v rc                Completion status code
187          */
188         void ( * complete_recv ) ( struct ib_device *ibdev,
189                                    struct ib_queue_pair *qp,
190                                    struct ib_address_vector *av,
191                                    struct io_buffer *iobuf, int rc );
192 };
193
194 /** An Infiniband Completion Queue */
195 struct ib_completion_queue {
196         /** Containing Infiniband device */
197         struct ib_device *ibdev;
198         /** List of completion queues on this Infiniband device */
199         struct list_head list;
200         /** Completion queue number */
201         unsigned long cqn;
202         /** Number of completion queue entries */
203         unsigned int num_cqes;
204         /** Next completion queue entry index
205          *
206          * This is the index of the next entry to be filled (i.e. the
207          * first empty entry).  This value is not bounded by num_wqes;
208          * users must logical-AND with (num_wqes-1) to generate an
209          * array index.
210          */
211         unsigned long next_idx;
212         /** List of work queues completing to this queue */
213         struct list_head work_queues;
214         /** Completion queue operations */
215         struct ib_completion_queue_operations *op;
216         /** Driver private data */
217         void *drv_priv;
218 };
219
220 /**
221  * Infiniband device operations
222  *
223  * These represent a subset of the Infiniband Verbs.
224  */
225 struct ib_device_operations {
226         /** Create completion queue
227          *
228          * @v ibdev             Infiniband device
229          * @v cq                Completion queue
230          * @ret rc              Return status code
231          */
232         int ( * create_cq ) ( struct ib_device *ibdev,
233                               struct ib_completion_queue *cq );
234         /** Destroy completion queue
235          *
236          * @v ibdev             Infiniband device
237          * @v cq                Completion queue
238          */
239         void ( * destroy_cq ) ( struct ib_device *ibdev,
240                                 struct ib_completion_queue *cq );
241         /** Create queue pair
242          *
243          * @v ibdev             Infiniband device
244          * @v qp                Queue pair
245          * @ret rc              Return status code
246          */
247         int ( * create_qp ) ( struct ib_device *ibdev,
248                               struct ib_queue_pair *qp );
249         /** Modify queue pair
250          *
251          * @v ibdev             Infiniband device
252          * @v qp                Queue pair
253          * @ret rc              Return status code
254          */
255         int ( * modify_qp ) ( struct ib_device *ibdev,
256                               struct ib_queue_pair *qp );
257         /** Destroy queue pair
258          *
259          * @v ibdev             Infiniband device
260          * @v qp                Queue pair
261          */
262         void ( * destroy_qp ) ( struct ib_device *ibdev,
263                                 struct ib_queue_pair *qp );
264         /** Post send work queue entry
265          *
266          * @v ibdev             Infiniband device
267          * @v qp                Queue pair
268          * @v av                Address vector
269          * @v iobuf             I/O buffer
270          * @ret rc              Return status code
271          *
272          * If this method returns success, the I/O buffer remains
273          * owned by the queue pair.  If this method returns failure,
274          * the I/O buffer is immediately released; the failure is
275          * interpreted as "failure to enqueue buffer".
276          */
277         int ( * post_send ) ( struct ib_device *ibdev,
278                               struct ib_queue_pair *qp,
279                               struct ib_address_vector *av,
280                               struct io_buffer *iobuf );
281         /** Post receive work queue entry
282          *
283          * @v ibdev             Infiniband device
284          * @v qp                Queue pair
285          * @v iobuf             I/O buffer
286          * @ret rc              Return status code
287          *
288          * If this method returns success, the I/O buffer remains
289          * owned by the queue pair.  If this method returns failure,
290          * the I/O buffer is immediately released; the failure is
291          * interpreted as "failure to enqueue buffer".
292          */
293         int ( * post_recv ) ( struct ib_device *ibdev,
294                               struct ib_queue_pair *qp,
295                               struct io_buffer *iobuf );
296         /** Poll completion queue
297          *
298          * @v ibdev             Infiniband device
299          * @v cq                Completion queue
300          *
301          * The relevant completion handler (specified at completion
302          * queue creation time) takes ownership of the I/O buffer.
303          */
304         void ( * poll_cq ) ( struct ib_device *ibdev,
305                              struct ib_completion_queue *cq );
306         /**
307          * Poll event queue
308          *
309          * @v ibdev             Infiniband device
310          */
311         void ( * poll_eq ) ( struct ib_device *ibdev );
312         /**
313          * Open port
314          *
315          * @v ibdev             Infiniband device
316          * @ret rc              Return status code
317          */
318         int ( * open ) ( struct ib_device *ibdev );
319         /**
320          * Close port
321          *
322          * @v ibdev             Infiniband device
323          */
324         void ( * close ) ( struct ib_device *ibdev );
325         /** Attach to multicast group
326          *
327          * @v ibdev             Infiniband device
328          * @v qp                Queue pair
329          * @v gid               Multicast GID
330          * @ret rc              Return status code
331          */
332         int ( * mcast_attach ) ( struct ib_device *ibdev,
333                                  struct ib_queue_pair *qp,
334                                  struct ib_gid *gid );
335         /** Detach from multicast group
336          *
337          * @v ibdev             Infiniband device
338          * @v qp                Queue pair
339          * @v gid               Multicast GID
340          */
341         void ( * mcast_detach ) ( struct ib_device *ibdev,
342                                   struct ib_queue_pair *qp,
343                                   struct ib_gid *gid );
344         /** Set port information
345          *
346          * @v ibdev             Infiniband device
347          * @v mad               Set port information MAD
348          *
349          * This method is required only by adapters that do not have
350          * an embedded SMA.
351          */
352         int ( * set_port_info ) ( struct ib_device *ibdev, union ib_mad *mad );
353         /** Set partition key table
354          *
355          * @v ibdev             Infiniband device
356          * @v mad               Set partition key table MAD
357          *
358          * This method is required only by adapters that do not have
359          * an embedded SMA.
360          */
361         int ( * set_pkey_table ) ( struct ib_device *ibdev,
362                                    union ib_mad *mad );
363 };
364
365 /** An Infiniband device */
366 struct ib_device {
367         /** Reference counter */
368         struct refcnt refcnt;
369         /** List of Infiniband devices */
370         struct list_head list;
371         /** Underlying device */
372         struct device *dev;
373         /** List of completion queues */
374         struct list_head cqs;
375         /** List of queue pairs */
376         struct list_head qps;
377         /** Infiniband operations */
378         struct ib_device_operations *op;
379         /** Port number */
380         unsigned int port;
381         /** Port open request counter */
382         unsigned int open_count;
383
384         /** Port state */
385         uint8_t port_state;
386         /** Link width supported */
387         uint8_t link_width_supported;
388         /** Link width enabled */
389         uint8_t link_width_enabled;
390         /** Link width active */
391         uint8_t link_width_active;
392         /** Link speed supported */
393         uint8_t link_speed_supported;
394         /** Link speed enabled */
395         uint8_t link_speed_enabled;
396         /** Link speed active */
397         uint8_t link_speed_active;
398         /** Port GID */
399         struct ib_gid gid;
400         /** Port LID */
401         uint16_t lid;
402         /** Subnet manager LID */
403         uint16_t sm_lid;
404         /** Subnet manager SL */
405         uint8_t sm_sl;
406         /** Partition key */
407         uint16_t pkey;
408
409         /** RDMA key
410          *
411          * This is a single key allowing unrestricted access to
412          * memory.
413          */
414         uint32_t rdma_key;
415
416         /** Subnet management interface */
417         struct ib_mad_interface *smi;
418         /** General services interface */
419         struct ib_mad_interface *gsi;
420
421         /** Driver private data */
422         void *drv_priv;
423         /** Owner private data */
424         void *owner_priv;
425 };
426
427 extern struct ib_completion_queue *
428 ib_create_cq ( struct ib_device *ibdev, unsigned int num_cqes,
429                struct ib_completion_queue_operations *op );
430 extern void ib_destroy_cq ( struct ib_device *ibdev,
431                             struct ib_completion_queue *cq );
432 extern void ib_poll_cq ( struct ib_device *ibdev,
433                          struct ib_completion_queue *cq );
434 extern struct ib_queue_pair *
435 ib_create_qp ( struct ib_device *ibdev, enum ib_queue_pair_type type,
436                unsigned int num_send_wqes, struct ib_completion_queue *send_cq,
437                unsigned int num_recv_wqes,
438                struct ib_completion_queue *recv_cq );
439 extern int ib_modify_qp ( struct ib_device *ibdev, struct ib_queue_pair *qp );
440 extern void ib_destroy_qp ( struct ib_device *ibdev,
441                             struct ib_queue_pair *qp );
442 extern struct ib_queue_pair * ib_find_qp_qpn ( struct ib_device *ibdev,
443                                                unsigned long qpn );
444 extern struct ib_queue_pair * ib_find_qp_mgid ( struct ib_device *ibdev,
445                                                 struct ib_gid *gid );
446 extern struct ib_work_queue * ib_find_wq ( struct ib_completion_queue *cq,
447                                            unsigned long qpn, int is_send );
448 extern int ib_post_send ( struct ib_device *ibdev, struct ib_queue_pair *qp,
449                           struct ib_address_vector *av,
450                           struct io_buffer *iobuf );
451 extern int ib_post_recv ( struct ib_device *ibdev, struct ib_queue_pair *qp,
452                           struct io_buffer *iobuf );
453 extern void ib_complete_send ( struct ib_device *ibdev,
454                                struct ib_queue_pair *qp,
455                                struct io_buffer *iobuf, int rc );
456 extern void ib_complete_recv ( struct ib_device *ibdev,
457                                struct ib_queue_pair *qp,
458                                struct ib_address_vector *av,
459                                struct io_buffer *iobuf, int rc );
460 extern void ib_refill_recv ( struct ib_device *ibdev,
461                              struct ib_queue_pair *qp );
462 extern int ib_open ( struct ib_device *ibdev );
463 extern void ib_close ( struct ib_device *ibdev );
464 extern int ib_mcast_attach ( struct ib_device *ibdev, struct ib_queue_pair *qp,
465                              struct ib_gid *gid );
466 extern void ib_mcast_detach ( struct ib_device *ibdev,
467                               struct ib_queue_pair *qp, struct ib_gid *gid );
468 extern int ib_get_hca_info ( struct ib_device *ibdev,
469                              struct ib_gid_half *hca_guid );
470 extern int ib_set_port_info ( struct ib_device *ibdev, union ib_mad *mad );
471 extern int ib_set_pkey_table ( struct ib_device *ibdev, union ib_mad *mad );
472 extern struct ib_device * alloc_ibdev ( size_t priv_size );
473 extern int register_ibdev ( struct ib_device *ibdev );
474 extern void unregister_ibdev ( struct ib_device *ibdev );
475 extern struct ib_device * find_ibdev ( struct ib_gid *gid );
476 extern void ib_link_state_changed ( struct ib_device *ibdev );
477 extern void ib_poll_eq ( struct ib_device *ibdev );
478 extern struct list_head ib_devices;
479
480 /** Iterate over all network devices */
481 #define for_each_ibdev( ibdev ) \
482         list_for_each_entry ( (ibdev), &ib_devices, list )
483
484 /**
485  * Check link state
486  *
487  * @v ibdev             Infiniband device
488  * @ret link_up         Link is up
489  */
490 static inline __always_inline int
491 ib_link_ok ( struct ib_device *ibdev ) {
492         return ( ibdev->port_state == IB_PORT_STATE_ACTIVE );
493 }
494
495 /**
496  * Get reference to Infiniband device
497  *
498  * @v ibdev             Infiniband device
499  * @ret ibdev           Infiniband device
500  */
501 static inline __always_inline struct ib_device *
502 ibdev_get ( struct ib_device *ibdev ) {
503         ref_get ( &ibdev->refcnt );
504         return ibdev;
505 }
506
507 /**
508  * Drop reference to Infiniband device
509  *
510  * @v ibdev             Infiniband device
511  */
512 static inline __always_inline void
513 ibdev_put ( struct ib_device *ibdev ) {
514         ref_put ( &ibdev->refcnt );
515 }
516
517 /**
518  * Set Infiniband work queue driver-private data
519  *
520  * @v wq                Work queue
521  * @v priv              Private data
522  */
523 static inline __always_inline void
524 ib_wq_set_drvdata ( struct ib_work_queue *wq, void *priv ) {
525         wq->drv_priv = priv;
526 }
527
528 /**
529  * Get Infiniband work queue driver-private data
530  *
531  * @v wq                Work queue
532  * @ret priv            Private data
533  */
534 static inline __always_inline void *
535 ib_wq_get_drvdata ( struct ib_work_queue *wq ) {
536         return wq->drv_priv;
537 }
538
539 /**
540  * Set Infiniband queue pair driver-private data
541  *
542  * @v qp                Queue pair
543  * @v priv              Private data
544  */
545 static inline __always_inline void
546 ib_qp_set_drvdata ( struct ib_queue_pair *qp, void *priv ) {
547         qp->drv_priv = priv;
548 }
549
550 /**
551  * Get Infiniband queue pair driver-private data
552  *
553  * @v qp                Queue pair
554  * @ret priv            Private data
555  */
556 static inline __always_inline void *
557 ib_qp_get_drvdata ( struct ib_queue_pair *qp ) {
558         return qp->drv_priv;
559 }
560
561 /**
562  * Set Infiniband queue pair owner-private data
563  *
564  * @v qp                Queue pair
565  * @v priv              Private data
566  */
567 static inline __always_inline void
568 ib_qp_set_ownerdata ( struct ib_queue_pair *qp, void *priv ) {
569         qp->owner_priv = priv;
570 }
571
572 /**
573  * Get Infiniband queue pair owner-private data
574  *
575  * @v qp                Queue pair
576  * @ret priv            Private data
577  */
578 static inline __always_inline void *
579 ib_qp_get_ownerdata ( struct ib_queue_pair *qp ) {
580         return qp->owner_priv;
581 }
582
583 /**
584  * Set Infiniband completion queue driver-private data
585  *
586  * @v cq                Completion queue
587  * @v priv              Private data
588  */
589 static inline __always_inline void
590 ib_cq_set_drvdata ( struct ib_completion_queue *cq, void *priv ) {
591         cq->drv_priv = priv;
592 }
593
594 /**
595  * Get Infiniband completion queue driver-private data
596  *
597  * @v cq                Completion queue
598  * @ret priv            Private data
599  */
600 static inline __always_inline void *
601 ib_cq_get_drvdata ( struct ib_completion_queue *cq ) {
602         return cq->drv_priv;
603 }
604
605 /**
606  * Set Infiniband device driver-private data
607  *
608  * @v ibdev             Infiniband device
609  * @v priv              Private data
610  */
611 static inline __always_inline void
612 ib_set_drvdata ( struct ib_device *ibdev, void *priv ) {
613         ibdev->drv_priv = priv;
614 }
615
616 /**
617  * Get Infiniband device driver-private data
618  *
619  * @v ibdev             Infiniband device
620  * @ret priv            Private data
621  */
622 static inline __always_inline void *
623 ib_get_drvdata ( struct ib_device *ibdev ) {
624         return ibdev->drv_priv;
625 }
626
627 /**
628  * Set Infiniband device owner-private data
629  *
630  * @v ibdev             Infiniband device
631  * @v priv              Private data
632  */
633 static inline __always_inline void
634 ib_set_ownerdata ( struct ib_device *ibdev, void *priv ) {
635         ibdev->owner_priv = priv;
636 }
637
638 /**
639  * Get Infiniband device owner-private data
640  *
641  * @v ibdev             Infiniband device
642  * @ret priv            Private data
643  */
644 static inline __always_inline void *
645 ib_get_ownerdata ( struct ib_device *ibdev ) {
646         return ibdev->owner_priv;
647 }
648
649 #endif /* _GPXE_INFINIBAND_H */