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