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