8e5d35e83891410b47ab3e1f5cec8981fd1449db
[people/peper/gpxe.git] / src / drivers / infiniband / hermon.h
1 #ifndef _HERMON_H
2 #define _HERMON_H
3
4 /** @file
5  *
6  * Mellanox Hermon Infiniband HCA driver
7  *
8  */
9
10 FILE_LICENCE ( GPL2_OR_LATER );
11
12 #include <stdint.h>
13 #include <gpxe/uaccess.h>
14 #include <gpxe/ib_packet.h>
15 #include "mlx_bitops.h"
16 #include "MT25408_PRM.h"
17
18 /*
19  * Hardware constants
20  *
21  */
22
23 /* Ports in existence */
24 #define HERMON_NUM_PORTS                2
25 #define HERMON_PORT_BASE                1
26
27 /* PCI BARs */
28 #define HERMON_PCI_CONFIG_BAR           PCI_BASE_ADDRESS_0
29 #define HERMON_PCI_CONFIG_BAR_SIZE      0x100000
30 #define HERMON_PCI_UAR_BAR              PCI_BASE_ADDRESS_2
31
32 /* Work queue entry and completion queue entry opcodes */
33 #define HERMON_OPCODE_NOP               0x00
34 #define HERMON_OPCODE_SEND              0x0a
35 #define HERMON_OPCODE_RECV_ERROR        0xfe
36 #define HERMON_OPCODE_SEND_ERROR        0xff
37
38 /* HCA command register opcodes */
39 #define HERMON_HCR_QUERY_DEV_CAP        0x0003
40 #define HERMON_HCR_QUERY_FW             0x0004
41 #define HERMON_HCR_INIT_HCA             0x0007
42 #define HERMON_HCR_CLOSE_HCA            0x0008
43 #define HERMON_HCR_INIT_PORT            0x0009
44 #define HERMON_HCR_CLOSE_PORT           0x000a
45 #define HERMON_HCR_SW2HW_MPT            0x000d
46 #define HERMON_HCR_WRITE_MTT            0x0011
47 #define HERMON_HCR_MAP_EQ               0x0012
48 #define HERMON_HCR_SW2HW_EQ             0x0013
49 #define HERMON_HCR_HW2SW_EQ             0x0014
50 #define HERMON_HCR_QUERY_EQ             0x0015
51 #define HERMON_HCR_SW2HW_CQ             0x0016
52 #define HERMON_HCR_HW2SW_CQ             0x0017
53 #define HERMON_HCR_RST2INIT_QP          0x0019
54 #define HERMON_HCR_INIT2RTR_QP          0x001a
55 #define HERMON_HCR_RTR2RTS_QP           0x001b
56 #define HERMON_HCR_RTS2RTS_QP           0x001c
57 #define HERMON_HCR_2RST_QP              0x0021
58 #define HERMON_HCR_QUERY_QP             0x0022
59 #define HERMON_HCR_CONF_SPECIAL_QP      0x0023
60 #define HERMON_HCR_MAD_IFC              0x0024
61 #define HERMON_HCR_READ_MCG             0x0025
62 #define HERMON_HCR_WRITE_MCG            0x0026
63 #define HERMON_HCR_MGID_HASH            0x0027
64 #define HERMON_HCR_RUN_FW               0x0ff6
65 #define HERMON_HCR_DISABLE_LAM          0x0ff7
66 #define HERMON_HCR_ENABLE_LAM           0x0ff8
67 #define HERMON_HCR_UNMAP_ICM            0x0ff9
68 #define HERMON_HCR_MAP_ICM              0x0ffa
69 #define HERMON_HCR_UNMAP_ICM_AUX        0x0ffb
70 #define HERMON_HCR_MAP_ICM_AUX          0x0ffc
71 #define HERMON_HCR_SET_ICM_SIZE         0x0ffd
72 #define HERMON_HCR_UNMAP_FA             0x0ffe
73 #define HERMON_HCR_MAP_FA               0x0fff
74
75 /* Service types */
76 #define HERMON_ST_RC                    0x00
77 #define HERMON_ST_UD                    0x03
78 #define HERMON_ST_MLX                   0x07
79
80 /* MTUs */
81 #define HERMON_MTU_2048                 0x04
82
83 #define HERMON_INVALID_LKEY             0x00000100UL
84
85 #define HERMON_PAGE_SIZE                4096
86
87 #define HERMON_DB_POST_SND_OFFSET       0x14
88 #define HERMON_DB_EQ_OFFSET(_eqn)       \
89         ( 0x800 + HERMON_PAGE_SIZE * ( (_eqn) / 4 ) + 0x08 * ( (_eqn) % 4 ) )
90
91 #define HERMON_QP_OPT_PARAM_PM_STATE    0x00000400UL
92 #define HERMON_QP_OPT_PARAM_QKEY        0x00000020UL
93 #define HERMON_QP_OPT_PARAM_ALT_PATH    0x00000001UL
94
95 #define HERMON_MAP_EQ                   ( 0UL << 31 )
96 #define HERMON_UNMAP_EQ                 ( 1UL << 31 )
97
98 #define HERMON_EV_PORT_STATE_CHANGE     0x09
99
100 #define HERMON_SCHED_QP0                0x3f
101 #define HERMON_SCHED_DEFAULT            0x83
102
103 #define HERMON_PM_STATE_ARMED           0x00
104 #define HERMON_PM_STATE_REARM           0x01
105 #define HERMON_PM_STATE_MIGRATED        0x03
106
107 #define HERMON_RETRY_MAX                0x07
108
109 /*
110  * Datatypes that seem to be missing from the autogenerated documentation
111  *
112  */
113 struct hermonprm_mgm_hash_st {
114         pseudo_bit_t reserved0[0x00020];
115 /* -------------- */
116         pseudo_bit_t hash[0x00010];
117         pseudo_bit_t reserved1[0x00010];
118 } __attribute__ (( packed ));
119
120 struct hermonprm_mcg_entry_st {
121         struct hermonprm_mcg_hdr_st hdr;
122         struct hermonprm_mcg_qp_dw_st qp[8];
123 } __attribute__ (( packed ));
124
125 struct hermonprm_cq_db_record_st {
126         pseudo_bit_t update_ci[0x00018];
127         pseudo_bit_t reserved0[0x00008];
128 /* -------------- */
129         pseudo_bit_t arm_ci[0x00018];
130         pseudo_bit_t cmd[0x00003];
131         pseudo_bit_t reserved1[0x00001];
132         pseudo_bit_t cmd_sn[0x00002];
133         pseudo_bit_t reserved2[0x00002];
134 } __attribute__ (( packed ));
135
136 struct hermonprm_send_db_register_st {
137         pseudo_bit_t reserved[0x00008];
138         pseudo_bit_t qn[0x00018];
139 } __attribute__ (( packed ));
140
141 struct hermonprm_event_db_register_st {
142         pseudo_bit_t ci[0x00018];
143         pseudo_bit_t reserver[0x00007];
144         pseudo_bit_t a[0x00001];
145 } __attribute__ (( packed ));
146
147 struct hermonprm_scalar_parameter_st {
148         pseudo_bit_t value_hi[0x00020];
149 /* -------------- */
150         pseudo_bit_t value[0x00020];
151 } __attribute__ (( packed ));
152
153 struct hermonprm_event_mask_st {
154         pseudo_bit_t reserved0[0x00020];
155 /* -------------- */
156         pseudo_bit_t completion[0x00001];
157         pseudo_bit_t reserved1[0x0008];
158         pseudo_bit_t port_state_change[0x00001];
159         pseudo_bit_t reserved2[0x00016];
160 } __attribute__ (( packed ));
161
162 struct hermonprm_port_state_change_event_st {
163         pseudo_bit_t reserved[0x00020];
164         struct hermonprm_port_state_change_st data;
165 } __attribute__ (( packed ));
166
167 /*
168  * Wrapper structures for hardware datatypes
169  *
170  */
171
172 struct MLX_DECLARE_STRUCT ( hermonprm_completion_queue_context );
173 struct MLX_DECLARE_STRUCT ( hermonprm_completion_queue_entry );
174 struct MLX_DECLARE_STRUCT ( hermonprm_completion_with_error );
175 struct MLX_DECLARE_STRUCT ( hermonprm_cq_db_record );
176 struct MLX_DECLARE_STRUCT ( hermonprm_eqc );
177 struct MLX_DECLARE_STRUCT ( hermonprm_event_db_register );
178 struct MLX_DECLARE_STRUCT ( hermonprm_event_mask );
179 struct MLX_DECLARE_STRUCT ( hermonprm_event_queue_entry );
180 struct MLX_DECLARE_STRUCT ( hermonprm_hca_command_register );
181 struct MLX_DECLARE_STRUCT ( hermonprm_init_hca );
182 struct MLX_DECLARE_STRUCT ( hermonprm_init_port );
183 struct MLX_DECLARE_STRUCT ( hermonprm_mad_ifc );
184 struct MLX_DECLARE_STRUCT ( hermonprm_mcg_entry );
185 struct MLX_DECLARE_STRUCT ( hermonprm_mgm_hash );
186 struct MLX_DECLARE_STRUCT ( hermonprm_mpt );
187 struct MLX_DECLARE_STRUCT ( hermonprm_mtt );
188 struct MLX_DECLARE_STRUCT ( hermonprm_port_state_change_event );
189 struct MLX_DECLARE_STRUCT ( hermonprm_qp_db_record );
190 struct MLX_DECLARE_STRUCT ( hermonprm_qp_ee_state_transitions );
191 struct MLX_DECLARE_STRUCT ( hermonprm_query_dev_cap );
192 struct MLX_DECLARE_STRUCT ( hermonprm_query_fw );
193 struct MLX_DECLARE_STRUCT ( hermonprm_queue_pair_ee_context_entry );
194 struct MLX_DECLARE_STRUCT ( hermonprm_scalar_parameter );
195 struct MLX_DECLARE_STRUCT ( hermonprm_send_db_register );
196 struct MLX_DECLARE_STRUCT ( hermonprm_ud_address_vector );
197 struct MLX_DECLARE_STRUCT ( hermonprm_virtual_physical_mapping );
198 struct MLX_DECLARE_STRUCT ( hermonprm_wqe_segment_ctrl_mlx );
199 struct MLX_DECLARE_STRUCT ( hermonprm_wqe_segment_ctrl_send );
200 struct MLX_DECLARE_STRUCT ( hermonprm_wqe_segment_data_ptr );
201 struct MLX_DECLARE_STRUCT ( hermonprm_wqe_segment_ud );
202
203 /*
204  * Composite hardware datatypes
205  *
206  */
207
208 struct hermonprm_write_mtt {
209         struct hermonprm_scalar_parameter mtt_base_addr;
210         struct hermonprm_scalar_parameter reserved;
211         struct hermonprm_mtt mtt;
212 } __attribute__ (( packed ));
213
214 #define HERMON_MAX_GATHER 2
215
216 struct hermonprm_ud_send_wqe {
217         struct hermonprm_wqe_segment_ctrl_send ctrl;
218         struct hermonprm_wqe_segment_ud ud;
219         struct hermonprm_wqe_segment_data_ptr data[HERMON_MAX_GATHER];
220 } __attribute__ (( packed ));
221
222 struct hermonprm_mlx_send_wqe {
223         struct hermonprm_wqe_segment_ctrl_mlx ctrl;
224         struct hermonprm_wqe_segment_data_ptr data[HERMON_MAX_GATHER];
225         uint8_t headers[IB_MAX_HEADER_SIZE];
226 } __attribute__ (( packed ));
227
228 struct hermonprm_rc_send_wqe {
229         struct hermonprm_wqe_segment_ctrl_send ctrl;
230         struct hermonprm_wqe_segment_data_ptr data[HERMON_MAX_GATHER];
231 } __attribute__ (( packed ));
232
233 #define HERMON_MAX_SCATTER 1
234
235 struct hermonprm_recv_wqe {
236         struct hermonprm_wqe_segment_data_ptr data[HERMON_MAX_SCATTER];
237 } __attribute__ (( packed ));
238
239 union hermonprm_completion_entry {
240         struct hermonprm_completion_queue_entry normal;
241         struct hermonprm_completion_with_error error;
242 } __attribute__ (( packed ));
243
244 union hermonprm_event_entry {
245         struct hermonprm_event_queue_entry generic;
246         struct hermonprm_port_state_change_event port_state_change;
247 } __attribute__ (( packed ));
248
249 union hermonprm_doorbell_register {
250         struct hermonprm_send_db_register send;
251         struct hermonprm_event_db_register event;
252         uint32_t dword[1];
253 } __attribute__ (( packed ));
254
255 union hermonprm_mad {
256         struct hermonprm_mad_ifc ifc;
257         union ib_mad mad;
258 } __attribute__ (( packed ));
259
260 /*
261  * gPXE-specific definitions
262  *
263  */
264
265 /** Hermon device capabilitiess */
266 struct hermon_dev_cap {
267         /** CMPT entry size */
268         size_t cmpt_entry_size;
269         /** Number of reserved QPs */
270         unsigned int reserved_qps;
271         /** QP context entry size */
272         size_t qpc_entry_size;
273         /** Alternate path context entry size */
274         size_t altc_entry_size;
275         /** Auxiliary context entry size */
276         size_t auxc_entry_size;
277         /** Number of reserved SRQs */
278         unsigned int reserved_srqs;
279         /** SRQ context entry size */
280         size_t srqc_entry_size;
281         /** Number of reserved CQs */
282         unsigned int reserved_cqs;
283         /** CQ context entry size */
284         size_t cqc_entry_size;
285         /** Number of reserved EQs */
286         unsigned int reserved_eqs;
287         /** EQ context entry size */
288         size_t eqc_entry_size;
289         /** Number of reserved MTTs */
290         unsigned int reserved_mtts;
291         /** MTT entry size */
292         size_t mtt_entry_size;
293         /** Number of reserved MRWs */
294         unsigned int reserved_mrws;
295         /** DMPT entry size */
296         size_t dmpt_entry_size;
297         /** Number of reserved UARs */
298         unsigned int reserved_uars;
299 };
300
301 /** Number of cMPT entries of each type */
302 #define HERMON_CMPT_MAX_ENTRIES ( 1 << 24 )
303
304 /** Hermon ICM memory map entry */
305 struct hermon_icm_map {
306         /** Offset (virtual address within ICM) */
307         uint64_t offset;
308         /** Length */
309         size_t len;
310 };
311
312 /** Discontiguous regions within Hermon ICM */
313 enum hermon_icm_map_regions {
314         HERMON_ICM_QP_CMPT = 0,
315         HERMON_ICM_SRQ_CMPT,
316         HERMON_ICM_CQ_CMPT,
317         HERMON_ICM_EQ_CMPT,
318         HERMON_ICM_OTHER,
319         HERMON_ICM_NUM_REGIONS
320 };
321
322 /** UAR page for doorbell accesses
323  *
324  * Pages 0-127 are reserved for event queue doorbells only, so we use
325  * page 128.
326  */
327 #define HERMON_UAR_NON_EQ_PAGE  128
328
329 /** Maximum number of allocatable MTT entries
330  *
331  * This is a policy decision, not a device limit.
332  */
333 #define HERMON_MAX_MTTS         64
334
335 /** A Hermon MTT descriptor */
336 struct hermon_mtt {
337         /** MTT offset */
338         unsigned int mtt_offset;
339         /** Number of pages */
340         unsigned int num_pages;
341         /** MTT base address */
342         unsigned int mtt_base_addr;
343         /** Offset within page */
344         unsigned int page_offset;
345 };
346
347 /** Alignment of Hermon send work queue entries */
348 #define HERMON_SEND_WQE_ALIGN 128
349
350 /** A Hermon send work queue entry */
351 union hermon_send_wqe {
352         struct hermonprm_wqe_segment_ctrl_send ctrl;
353         struct hermonprm_ud_send_wqe ud;
354         struct hermonprm_mlx_send_wqe mlx;
355         struct hermonprm_rc_send_wqe rc;
356         uint8_t force_align[HERMON_SEND_WQE_ALIGN];
357 } __attribute__ (( packed ));
358
359 /** A Hermon send work queue */
360 struct hermon_send_work_queue {
361         /** Number of work queue entries, including headroom
362          *
363          * Hermon requires us to leave unused space within the send
364          * WQ, so we create a send WQ with more entries than are
365          * requested in the create_qp() call.
366          */
367         unsigned int num_wqes;
368         /** Work queue entries */
369         union hermon_send_wqe *wqe;
370         /** Size of work queue */
371         size_t wqe_size;
372         /** Doorbell register */
373         void *doorbell;
374 };
375
376 /** Alignment of Hermon receive work queue entries */
377 #define HERMON_RECV_WQE_ALIGN 16
378
379 /** A Hermon receive work queue entry */
380 union hermon_recv_wqe {
381         struct hermonprm_recv_wqe recv;
382         uint8_t force_align[HERMON_RECV_WQE_ALIGN];
383 } __attribute__ (( packed ));
384
385 /** A Hermon receive work queue */
386 struct hermon_recv_work_queue {
387         /** Work queue entries */
388         union hermon_recv_wqe *wqe;
389         /** Size of work queue */
390         size_t wqe_size;
391         /** Doorbell */
392         struct hermonprm_qp_db_record doorbell __attribute__ (( aligned (4) ));
393 };
394
395 /** Number of special queue pairs */
396 #define HERMON_NUM_SPECIAL_QPS 8
397
398 /** Number of queue pairs reserved for the "special QP" block
399  *
400  * The special QPs must be within a contiguous block aligned on its
401  * own size.
402  */
403 #define HERMON_RSVD_SPECIAL_QPS ( ( HERMON_NUM_SPECIAL_QPS << 1 ) - 1 )
404
405 /** Maximum number of allocatable queue pairs
406  *
407  * This is a policy decision, not a device limit.
408  */
409 #define HERMON_MAX_QPS          8
410
411 /** Base queue pair number */
412 #define HERMON_QPN_BASE 0x550000
413
414 /** A Hermon queue pair */
415 struct hermon_queue_pair {
416         /** Work queue buffer */
417         void *wqe;
418         /** Size of work queue buffer */
419         size_t wqe_size;
420         /** MTT descriptor */
421         struct hermon_mtt mtt;
422         /** Send work queue */
423         struct hermon_send_work_queue send;
424         /** Receive work queue */
425         struct hermon_recv_work_queue recv;
426 };
427
428 /** Maximum number of allocatable completion queues
429  *
430  * This is a policy decision, not a device limit.
431  */
432 #define HERMON_MAX_CQS          8
433
434 /** A Hermon completion queue */
435 struct hermon_completion_queue {
436         /** Completion queue entries */
437         union hermonprm_completion_entry *cqe;
438         /** Size of completion queue */
439         size_t cqe_size;
440         /** MTT descriptor */
441         struct hermon_mtt mtt;
442         /** Doorbell */
443         struct hermonprm_cq_db_record doorbell __attribute__ (( aligned (8) ));
444 };
445
446 /** Maximum number of allocatable event queues
447  *
448  * This is a policy decision, not a device limit.
449  */
450 #define HERMON_MAX_EQS          8
451
452 /** A Hermon event queue */
453 struct hermon_event_queue {
454         /** Event queue entries */
455         union hermonprm_event_entry *eqe;
456         /** Size of event queue */
457         size_t eqe_size;
458         /** MTT descriptor */
459         struct hermon_mtt mtt;
460         /** Event queue number */
461         unsigned long eqn;
462         /** Next event queue entry index */
463         unsigned long next_idx;
464         /** Doorbell register */
465         void *doorbell;
466 };
467
468 /** Number of event queue entries
469  *
470  * This is a policy decision.
471  */
472 #define HERMON_NUM_EQES         4
473
474 /** A Hermon resource bitmask */
475 typedef uint32_t hermon_bitmask_t;
476
477 /** Size of a hermon resource bitmask */
478 #define HERMON_BITMASK_SIZE(max_entries)                                     \
479         ( ( (max_entries) + ( 8 * sizeof ( hermon_bitmask_t ) ) - 1 ) /      \
480           ( 8 * sizeof ( hermon_bitmask_t ) ) )
481
482 /** A Hermon device */
483 struct hermon {
484         /** PCI configuration registers */
485         void *config;
486         /** PCI user Access Region */
487         void *uar;
488
489         /** Command toggle */
490         unsigned int toggle;
491         /** Command input mailbox */
492         void *mailbox_in;
493         /** Command output mailbox */
494         void *mailbox_out;
495
496         /** Firmware area in external memory */
497         userptr_t firmware_area;
498         /** ICM map */
499         struct hermon_icm_map icm_map[HERMON_ICM_NUM_REGIONS];
500         /** ICM area */
501         userptr_t icm;
502
503         /** Event queue */
504         struct hermon_event_queue eq;
505         /** Unrestricted LKey
506          *
507          * Used to get unrestricted memory access.
508          */
509         unsigned long lkey;
510
511         /** Completion queue in-use bitmask */
512         hermon_bitmask_t cq_inuse[ HERMON_BITMASK_SIZE ( HERMON_MAX_CQS ) ];
513         /** Queue pair in-use bitmask */
514         hermon_bitmask_t qp_inuse[ HERMON_BITMASK_SIZE ( HERMON_MAX_QPS ) ];
515         /** MTT entry in-use bitmask */
516         hermon_bitmask_t mtt_inuse[ HERMON_BITMASK_SIZE ( HERMON_MAX_MTTS ) ];
517
518         /** Device capabilities */
519         struct hermon_dev_cap cap;
520         /** Special QPN base */
521         unsigned long special_qpn_base;
522         /** QPN base */
523         unsigned long qpn_base;
524
525         /** Infiniband devices */
526         struct ib_device *ibdev[HERMON_NUM_PORTS];
527 };
528
529 /** Global protection domain */
530 #define HERMON_GLOBAL_PD                0x123456
531
532 /** Memory key prefix */
533 #define HERMON_MKEY_PREFIX              0x77000000UL
534
535 /*
536  * HCA commands
537  *
538  */
539
540 #define HERMON_HCR_BASE                 0x80680
541 #define HERMON_HCR_REG(x)               ( HERMON_HCR_BASE + 4 * (x) )
542 #define HERMON_HCR_MAX_WAIT_MS          2000
543 #define HERMON_MBOX_ALIGN               4096
544 #define HERMON_MBOX_SIZE                512
545
546 /* HCA command is split into
547  *
548  * bits  11:0   Opcode
549  * bit     12   Input uses mailbox
550  * bit     13   Output uses mailbox
551  * bits 22:14   Input parameter length (in dwords)
552  * bits 31:23   Output parameter length (in dwords)
553  *
554  * Encoding the information in this way allows us to cut out several
555  * parameters to the hermon_command() call.
556  */
557 #define HERMON_HCR_IN_MBOX              0x00001000UL
558 #define HERMON_HCR_OUT_MBOX             0x00002000UL
559 #define HERMON_HCR_OPCODE( _command )   ( (_command) & 0xfff )
560 #define HERMON_HCR_IN_LEN( _command )   ( ( (_command) >> 12 ) & 0x7fc )
561 #define HERMON_HCR_OUT_LEN( _command )  ( ( (_command) >> 21 ) & 0x7fc )
562
563 /** Build HCR command from component parts */
564 #define HERMON_HCR_INOUT_CMD( _opcode, _in_mbox, _in_len,                    \
565                              _out_mbox, _out_len )                           \
566         ( (_opcode) |                                                        \
567           ( (_in_mbox) ? HERMON_HCR_IN_MBOX : 0 ) |                          \
568           ( ( (_in_len) / 4 ) << 14 ) |                                      \
569           ( (_out_mbox) ? HERMON_HCR_OUT_MBOX : 0 ) |                        \
570           ( ( (_out_len) / 4 ) << 23 ) )
571
572 #define HERMON_HCR_IN_CMD( _opcode, _in_mbox, _in_len )                      \
573         HERMON_HCR_INOUT_CMD ( _opcode, _in_mbox, _in_len, 0, 0 )
574
575 #define HERMON_HCR_OUT_CMD( _opcode, _out_mbox, _out_len )                   \
576         HERMON_HCR_INOUT_CMD ( _opcode, 0, 0, _out_mbox, _out_len )
577
578 #define HERMON_HCR_VOID_CMD( _opcode )                                       \
579         HERMON_HCR_INOUT_CMD ( _opcode, 0, 0, 0, 0 )
580
581 #endif /* _HERMON_H */