[Infiniband] Add preliminary support for multi-port devices.
[people/sha0/gpxe.git] / src / drivers / infiniband / arbel.h
1 #ifndef _ARBEL_H
2 #define _ARBEL_H
3
4 /** @file
5  *
6  * Mellanox Arbel Infiniband HCA driver
7  *
8  */
9
10 #include <stdint.h>
11 #include <gpxe/uaccess.h>
12 #include "mlx_bitops.h"
13 #include "MT25218_PRM.h"
14
15 /*
16  * Hardware constants
17  *
18  */
19
20 /* Ports in existence */
21 #define ARBEL_NUM_PORTS                 1
22 #define ARBEL_PORT_BASE                 1
23
24 /* PCI BARs */
25 #define ARBEL_PCI_CONFIG_BAR            PCI_BASE_ADDRESS_0
26 #define ARBEL_PCI_CONFIG_BAR_SIZE       0x100000
27 #define ARBEL_PCI_UAR_BAR               PCI_BASE_ADDRESS_2
28 #define ARBEL_PCI_UAR_IDX               1
29 #define ARBEL_PCI_UAR_SIZE              0x1000
30
31 /* UAR context table (UCE) resource types */
32 #define ARBEL_UAR_RES_NONE              0x00
33 #define ARBEL_UAR_RES_CQ_CI             0x01
34 #define ARBEL_UAR_RES_CQ_ARM            0x02
35 #define ARBEL_UAR_RES_SQ                0x03
36 #define ARBEL_UAR_RES_RQ                0x04
37 #define ARBEL_UAR_RES_GROUP_SEP         0x07
38
39 /* Work queue entry and completion queue entry opcodes */
40 #define ARBEL_OPCODE_SEND               0x0a
41 #define ARBEL_OPCODE_RECV_ERROR         0xfe
42 #define ARBEL_OPCODE_SEND_ERROR         0xff
43
44 /* HCA command register opcodes */
45 #define ARBEL_HCR_QUERY_DEV_LIM         0x0003
46 #define ARBEL_HCR_QUERY_FW              0x0004
47 #define ARBEL_HCR_INIT_HCA              0x0007
48 #define ARBEL_HCR_CLOSE_HCA             0x0008
49 #define ARBEL_HCR_INIT_IB               0x0009
50 #define ARBEL_HCR_CLOSE_IB              0x000a
51 #define ARBEL_HCR_SW2HW_MPT             0x000d
52 #define ARBEL_HCR_MAP_EQ                0x0012
53 #define ARBEL_HCR_SW2HW_EQ              0x0013
54 #define ARBEL_HCR_HW2SW_EQ              0x0014
55 #define ARBEL_HCR_SW2HW_CQ              0x0016
56 #define ARBEL_HCR_HW2SW_CQ              0x0017
57 #define ARBEL_HCR_RST2INIT_QPEE         0x0019
58 #define ARBEL_HCR_INIT2RTR_QPEE         0x001a
59 #define ARBEL_HCR_RTR2RTS_QPEE          0x001b
60 #define ARBEL_HCR_2RST_QPEE             0x0021
61 #define ARBEL_HCR_MAD_IFC               0x0024
62 #define ARBEL_HCR_READ_MGM              0x0025
63 #define ARBEL_HCR_WRITE_MGM             0x0026
64 #define ARBEL_HCR_MGID_HASH             0x0027
65 #define ARBEL_HCR_RUN_FW                0x0ff6
66 #define ARBEL_HCR_DISABLE_LAM           0x0ff7
67 #define ARBEL_HCR_ENABLE_LAM            0x0ff8
68 #define ARBEL_HCR_UNMAP_ICM             0x0ff9
69 #define ARBEL_HCR_MAP_ICM               0x0ffa
70 #define ARBEL_HCR_UNMAP_ICM_AUX         0x0ffb
71 #define ARBEL_HCR_MAP_ICM_AUX           0x0ffc
72 #define ARBEL_HCR_SET_ICM_SIZE          0x0ffd
73 #define ARBEL_HCR_UNMAP_FA              0x0ffe
74 #define ARBEL_HCR_MAP_FA                0x0fff
75
76 /* Service types */
77 #define ARBEL_ST_UD                     0x03
78
79 /* MTUs */
80 #define ARBEL_MTU_2048                  0x04
81
82 #define ARBEL_NO_EQ                     64
83
84 #define ARBEL_INVALID_LKEY              0x00000100UL
85
86 #define ARBEL_PAGE_SIZE                 4096
87
88 #define ARBEL_DB_POST_SND_OFFSET        0x10
89
90 /*
91  * Datatypes that seem to be missing from the autogenerated documentation
92  *
93  */
94 struct arbelprm_mgm_hash_st {
95         pseudo_bit_t reserved0[0x00020];
96 /* -------------- */
97         pseudo_bit_t hash[0x00010];
98         pseudo_bit_t reserved1[0x00010];
99 } __attribute__ (( packed ));
100
101 struct arbelprm_scalar_parameter_st {
102         pseudo_bit_t reserved0[0x00020];
103 /* -------------- */
104         pseudo_bit_t value[0x00020];
105 } __attribute__ (( packed ));
106
107 /*
108  * Wrapper structures for hardware datatypes
109  *
110  */
111
112 struct MLX_DECLARE_STRUCT ( arbelprm_access_lam );
113 struct MLX_DECLARE_STRUCT ( arbelprm_completion_queue_context );
114 struct MLX_DECLARE_STRUCT ( arbelprm_completion_queue_entry );
115 struct MLX_DECLARE_STRUCT ( arbelprm_completion_with_error );
116 struct MLX_DECLARE_STRUCT ( arbelprm_cq_arm_db_record );
117 struct MLX_DECLARE_STRUCT ( arbelprm_cq_ci_db_record );
118 struct MLX_DECLARE_STRUCT ( arbelprm_eqc );
119 struct MLX_DECLARE_STRUCT ( arbelprm_hca_command_register );
120 struct MLX_DECLARE_STRUCT ( arbelprm_init_hca );
121 struct MLX_DECLARE_STRUCT ( arbelprm_init_ib );
122 struct MLX_DECLARE_STRUCT ( arbelprm_mad_ifc );
123 struct MLX_DECLARE_STRUCT ( arbelprm_mgm_entry );
124 struct MLX_DECLARE_STRUCT ( arbelprm_mgm_hash );
125 struct MLX_DECLARE_STRUCT ( arbelprm_mpt );
126 struct MLX_DECLARE_STRUCT ( arbelprm_qp_db_record );
127 struct MLX_DECLARE_STRUCT ( arbelprm_qp_ee_state_transitions );
128 struct MLX_DECLARE_STRUCT ( arbelprm_query_dev_lim );
129 struct MLX_DECLARE_STRUCT ( arbelprm_query_fw );
130 struct MLX_DECLARE_STRUCT ( arbelprm_queue_pair_ee_context_entry );
131 struct MLX_DECLARE_STRUCT ( arbelprm_recv_wqe_segment_next );
132 struct MLX_DECLARE_STRUCT ( arbelprm_scalar_parameter );
133 struct MLX_DECLARE_STRUCT ( arbelprm_send_doorbell );
134 struct MLX_DECLARE_STRUCT ( arbelprm_ud_address_vector );
135 struct MLX_DECLARE_STRUCT ( arbelprm_virtual_physical_mapping );
136 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_ctrl_send );
137 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_data_ptr );
138 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_next );
139 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_ud );
140
141 /*
142  * Composite hardware datatypes
143  *
144  */
145
146 #define ARBEL_MAX_GATHER 1
147
148 struct arbelprm_ud_send_wqe {
149         struct arbelprm_wqe_segment_next next;
150         struct arbelprm_wqe_segment_ctrl_send ctrl;
151         struct arbelprm_wqe_segment_ud ud;
152         struct arbelprm_wqe_segment_data_ptr data[ARBEL_MAX_GATHER];
153 } __attribute__ (( packed ));
154
155 #define ARBEL_MAX_SCATTER 1
156
157 struct arbelprm_recv_wqe {
158         /* The autogenerated header is inconsistent between send and
159          * receive WQEs.  The "ctrl" structure for receive WQEs is
160          * defined to include the "next" structure.  Since the "ctrl"
161          * part of the "ctrl" structure contains only "reserved, must
162          * be zero" bits, we ignore its definition and provide
163          * something more usable.
164          */
165         struct arbelprm_recv_wqe_segment_next next;
166         uint32_t ctrl[2]; /* All "reserved, must be zero" */
167         struct arbelprm_wqe_segment_data_ptr data[ARBEL_MAX_SCATTER];
168 } __attribute__ (( packed ));
169
170 union arbelprm_completion_entry {
171         struct arbelprm_completion_queue_entry normal;
172         struct arbelprm_completion_with_error error;
173 } __attribute__ (( packed ));
174
175 union arbelprm_doorbell_record {
176         struct arbelprm_cq_arm_db_record cq_arm;
177         struct arbelprm_cq_ci_db_record cq_ci;
178         struct arbelprm_qp_db_record qp;
179 } __attribute__ (( packed ));
180
181 union arbelprm_doorbell_register {
182         struct arbelprm_send_doorbell send;
183         uint32_t dword[2];
184 } __attribute__ (( packed ));
185
186 union arbelprm_mad {
187         struct arbelprm_mad_ifc ifc;
188         union ib_mad mad;
189 } __attribute__ (( packed ));
190
191 /*
192  * gPXE-specific definitions
193  *
194  */
195
196 /** Arbel device limits */
197 struct arbel_dev_limits {
198         /** Number of reserved QPs */
199         unsigned int reserved_qps;
200         /** QP context entry size */
201         size_t qpc_entry_size;
202         /** Extended QP context entry size */
203         size_t eqpc_entry_size;
204         /** Number of reserved SRQs */
205         unsigned int reserved_srqs;
206         /** SRQ context entry size */
207         size_t srqc_entry_size;
208         /** Number of reserved EEs */
209         unsigned int reserved_ees;
210         /** EE context entry size */
211         size_t eec_entry_size;
212         /** Extended EE context entry size */
213         size_t eeec_entry_size;
214         /** Number of reserved CQs */
215         unsigned int reserved_cqs;
216         /** CQ context entry size */
217         size_t cqc_entry_size;
218         /** Number of reserved MTTs */
219         unsigned int reserved_mtts;
220         /** MTT entry size */
221         size_t mtt_entry_size;
222         /** Number of reserved MRWs */
223         unsigned int reserved_mrws;
224         /** MPT entry size */
225         size_t mpt_entry_size;
226         /** Number of reserved RDBs */
227         unsigned int reserved_rdbs;
228         /** EQ context entry size */
229         size_t eqc_entry_size;
230         /** Number of reserved UARs */
231         unsigned int reserved_uars;
232 };
233
234 /** Alignment of Arbel send work queue entries */
235 #define ARBEL_SEND_WQE_ALIGN 128
236
237 /** An Arbel send work queue entry */
238 union arbel_send_wqe {
239         struct arbelprm_ud_send_wqe ud;
240         uint8_t force_align[ARBEL_SEND_WQE_ALIGN];
241 } __attribute__ (( packed ));
242
243 /** An Arbel send work queue */
244 struct arbel_send_work_queue {
245         /** Doorbell record number */
246         unsigned int doorbell_idx;
247         /** Work queue entries */
248         union arbel_send_wqe *wqe;
249         /** Size of work queue */
250         size_t wqe_size;
251 };
252
253 /** Alignment of Arbel receive work queue entries */
254 #define ARBEL_RECV_WQE_ALIGN 64
255
256 /** An Arbel receive work queue entry */
257 union arbel_recv_wqe {
258         struct arbelprm_recv_wqe recv;
259         uint8_t force_align[ARBEL_RECV_WQE_ALIGN];
260 } __attribute__ (( packed ));
261
262 /** An Arbel receive work queue */
263 struct arbel_recv_work_queue {
264         /** Doorbell record number */
265         unsigned int doorbell_idx;
266         /** Work queue entries */
267         union arbel_recv_wqe *wqe;
268         /** Size of work queue */
269         size_t wqe_size;
270 };
271
272 /** Maximum number of allocatable queue pairs
273  *
274  * This is a policy decision, not a device limit.
275  */
276 #define ARBEL_MAX_QPS           8
277
278 /** Base queue pair number */
279 #define ARBEL_QPN_BASE 0x550000
280
281 /** An Arbel queue pair */
282 struct arbel_queue_pair {
283         /** Send work queue */
284         struct arbel_send_work_queue send;
285         /** Receive work queue */
286         struct arbel_recv_work_queue recv;
287 };
288
289 /** Maximum number of allocatable completion queues
290  *
291  * This is a policy decision, not a device limit.
292  */
293 #define ARBEL_MAX_CQS           8
294
295 /** An Arbel completion queue */
296 struct arbel_completion_queue {
297         /** Consumer counter doorbell record number */
298         unsigned int ci_doorbell_idx;
299         /** Arm queue doorbell record number */
300         unsigned int arm_doorbell_idx;
301         /** Completion queue entries */
302         union arbelprm_completion_entry *cqe;
303         /** Size of completion queue */
304         size_t cqe_size;
305 };
306
307 /** An Arbel resource bitmask */
308 typedef uint32_t arbel_bitmask_t;
309
310 /** Size of an Arbel resource bitmask */
311 #define ARBEL_BITMASK_SIZE(max_entries)                                      \
312         ( ( (max_entries) + ( 8 * sizeof ( arbel_bitmask_t ) ) - 1 ) /       \
313           ( 8 * sizeof ( arbel_bitmask_t ) ) )
314
315 /** An Arbel device */
316 struct arbel {
317         /** PCI configuration registers */
318         void *config;
319         /** PCI user Access Region */
320         void *uar;
321
322         /** Command input mailbox */
323         void *mailbox_in;
324         /** Command output mailbox */
325         void *mailbox_out;
326
327         /** Firmware area in external memory */
328         userptr_t firmware_area;
329         /** ICM size */
330         size_t icm_len;
331         /** ICM AUX size */
332         size_t icm_aux_len;
333         /** ICM area */
334         userptr_t icm;
335
336         /** Doorbell records */
337         union arbelprm_doorbell_record *db_rec;
338         /** Reserved LKey
339          *
340          * Used to get unrestricted memory access.
341          */
342         unsigned long reserved_lkey;
343
344         /** Completion queue in-use bitmask */
345         arbel_bitmask_t cq_inuse[ ARBEL_BITMASK_SIZE ( ARBEL_MAX_CQS ) ];
346         /** Queue pair in-use bitmask */
347         arbel_bitmask_t qp_inuse[ ARBEL_BITMASK_SIZE ( ARBEL_MAX_QPS ) ];
348         
349         /** Device limits */
350         struct arbel_dev_limits limits;
351
352         /** Infiniband devices */
353         struct ib_device *ibdev[ARBEL_NUM_PORTS];
354 };
355
356 /** Global protection domain */
357 #define ARBEL_GLOBAL_PD                 0x123456
358
359 /** Memory key prefix */
360 #define ARBEL_MKEY_PREFIX               0x77000000UL
361
362 /*
363  * HCA commands
364  *
365  */
366
367 #define ARBEL_HCR_BASE                  0x80680
368 #define ARBEL_HCR_REG(x)                ( ARBEL_HCR_BASE + 4 * (x) )
369 #define ARBEL_HCR_MAX_WAIT_MS           2000
370 #define ARBEL_MBOX_ALIGN                4096
371 #define ARBEL_MBOX_SIZE                 512
372
373 /* HCA command is split into
374  *
375  * bits  11:0   Opcode
376  * bit     12   Input uses mailbox
377  * bit     13   Output uses mailbox
378  * bits 22:14   Input parameter length (in dwords)
379  * bits 31:23   Output parameter length (in dwords)
380  *
381  * Encoding the information in this way allows us to cut out several
382  * parameters to the arbel_command() call.
383  */
384 #define ARBEL_HCR_IN_MBOX               0x00001000UL
385 #define ARBEL_HCR_OUT_MBOX              0x00002000UL
386 #define ARBEL_HCR_OPCODE( _command )    ( (_command) & 0xfff )
387 #define ARBEL_HCR_IN_LEN( _command )    ( ( (_command) >> 12 ) & 0x7fc )
388 #define ARBEL_HCR_OUT_LEN( _command )   ( ( (_command) >> 21 ) & 0x7fc )
389
390 /** Build HCR command from component parts */
391 #define ARBEL_HCR_INOUT_CMD( _opcode, _in_mbox, _in_len,                     \
392                              _out_mbox, _out_len )                           \
393         ( (_opcode) |                                                        \
394           ( (_in_mbox) ? ARBEL_HCR_IN_MBOX : 0 ) |                           \
395           ( ( (_in_len) / 4 ) << 14 ) |                                      \
396           ( (_out_mbox) ? ARBEL_HCR_OUT_MBOX : 0 ) |                         \
397           ( ( (_out_len) / 4 ) << 23 ) )
398
399 #define ARBEL_HCR_IN_CMD( _opcode, _in_mbox, _in_len )                       \
400         ARBEL_HCR_INOUT_CMD ( _opcode, _in_mbox, _in_len, 0, 0 )
401
402 #define ARBEL_HCR_OUT_CMD( _opcode, _out_mbox, _out_len )                    \
403         ARBEL_HCR_INOUT_CMD ( _opcode, 0, 0, _out_mbox, _out_len )
404
405 #define ARBEL_HCR_VOID_CMD( _opcode )                                        \
406         ARBEL_HCR_INOUT_CMD ( _opcode, 0, 0, 0, 0 )
407
408 /*
409  * Doorbell record allocation
410  *
411  * The doorbell record map looks like:
412  *
413  *    ARBEL_MAX_CQS * Arm completion queue doorbell
414  *    ARBEL_MAX_QPS * Send work request doorbell
415  *    Group separator
416  *    ...(empty space)...
417  *    ARBEL_MAX_QPS * Receive work request doorbell
418  *    ARBEL_MAX_CQS * Completion queue consumer counter update doorbell
419  */
420
421 #define ARBEL_MAX_DOORBELL_RECORDS 512
422 #define ARBEL_GROUP_SEPARATOR_DOORBELL ( ARBEL_MAX_CQS + ARBEL_MAX_QPS )
423
424 /**
425  * Get arm completion queue doorbell index
426  *
427  * @v cqn_offset        Completion queue number offset
428  * @ret doorbell_idx    Doorbell index
429  */
430 static inline unsigned int
431 arbel_cq_arm_doorbell_idx ( unsigned int cqn_offset ) {
432         return cqn_offset;
433 }
434
435 /**
436  * Get send work request doorbell index
437  *
438  * @v qpn_offset        Queue pair number offset
439  * @ret doorbell_idx    Doorbell index
440  */
441 static inline unsigned int
442 arbel_send_doorbell_idx ( unsigned int qpn_offset ) {
443         return ( ARBEL_MAX_CQS + qpn_offset );
444 }
445
446 /**
447  * Get receive work request doorbell index
448  *
449  * @v qpn_offset        Queue pair number offset
450  * @ret doorbell_idx    Doorbell index
451  */
452 static inline unsigned int
453 arbel_recv_doorbell_idx ( unsigned int qpn_offset ) {
454         return ( ARBEL_MAX_DOORBELL_RECORDS - ARBEL_MAX_CQS - qpn_offset - 1 );
455 }
456
457 /**
458  * Get completion queue consumer counter doorbell index
459  *
460  * @v cqn_offset        Completion queue number offset
461  * @ret doorbell_idx    Doorbell index
462  */
463 static inline unsigned int
464 arbel_cq_ci_doorbell_idx ( unsigned int cqn_offset ) {
465         return ( ARBEL_MAX_DOORBELL_RECORDS - cqn_offset - 1 );
466 }
467
468 #endif /* _ARBEL_H */