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