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