Multicast join now works.
[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 /*
11  * Hardware constants
12  *
13  */
14
15 /* UAR context table (UCE) resource types */
16 #define ARBEL_UAR_RES_NONE              0x00
17 #define ARBEL_UAR_RES_CQ_CI             0x01
18 #define ARBEL_UAR_RES_CQ_ARM            0x02
19 #define ARBEL_UAR_RES_SQ                0x03
20 #define ARBEL_UAR_RES_RQ                0x04
21 #define ARBEL_UAR_RES_GROUP_SEP         0x07
22
23 /* Work queue entry and completion queue entry opcodes */
24 #define ARBEL_OPCODE_SEND               0x0a
25 #define ARBEL_OPCODE_RECV_ERROR         0xfe
26 #define ARBEL_OPCODE_SEND_ERROR         0xff
27
28 /* HCA command register opcodes */
29 #define ARBEL_HCR_QUERY_DEV_LIM         0x0003
30 #define ARBEL_HCR_SW2HW_CQ              0x0016
31 #define ARBEL_HCR_HW2SW_CQ              0x0017
32 #define ARBEL_HCR_RST2INIT_QPEE         0x0019
33 #define ARBEL_HCR_INIT2RTR_QPEE         0x001a
34 #define ARBEL_HCR_RTR2RTS_QPEE          0x001b
35 #define ARBEL_HCR_2RST_QPEE             0x0021
36 #define ARBEL_HCR_READ_MGM              0x0025
37 #define ARBEL_HCR_WRITE_MGM             0x0026
38 #define ARBEL_HCR_MGID_HASH             0x0027
39
40 /* Service types */
41 #define ARBEL_ST_UD                     0x03
42
43 /* MTUs */
44 #define ARBEL_MTU_2048                  0x04
45
46 #define ARBEL_INVALID_LKEY              0x00000100UL
47
48 /*
49  * Datatypes that seem to be missing from the autogenerated documentation
50  *
51  */
52 struct arbelprm_mgm_hash_st {
53         pseudo_bit_t reserved0[0x00020];
54 /* -------------- */
55         pseudo_bit_t hash[0x00010];
56         pseudo_bit_t reserved1[0x00010];
57 };
58
59 /*
60  * Wrapper structures for hardware datatypes
61  *
62  */
63
64 struct MLX_DECLARE_STRUCT ( arbelprm_completion_queue_context );
65 struct MLX_DECLARE_STRUCT ( arbelprm_completion_queue_entry );
66 struct MLX_DECLARE_STRUCT ( arbelprm_completion_with_error );
67 struct MLX_DECLARE_STRUCT ( arbelprm_cq_arm_db_record );
68 struct MLX_DECLARE_STRUCT ( arbelprm_cq_ci_db_record );
69 struct MLX_DECLARE_STRUCT ( arbelprm_hca_command_register );
70 struct MLX_DECLARE_STRUCT ( arbelprm_mgm_entry );
71 struct MLX_DECLARE_STRUCT ( arbelprm_mgm_hash );
72 struct MLX_DECLARE_STRUCT ( arbelprm_qp_db_record );
73 struct MLX_DECLARE_STRUCT ( arbelprm_qp_ee_state_transitions );
74 struct MLX_DECLARE_STRUCT ( arbelprm_query_dev_lim );
75 struct MLX_DECLARE_STRUCT ( arbelprm_queue_pair_ee_context_entry );
76 struct MLX_DECLARE_STRUCT ( arbelprm_recv_wqe_segment_next );
77 struct MLX_DECLARE_STRUCT ( arbelprm_send_doorbell );
78 struct MLX_DECLARE_STRUCT ( arbelprm_ud_address_vector );
79 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_ctrl_send );
80 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_data_ptr );
81 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_next );
82 struct MLX_DECLARE_STRUCT ( arbelprm_wqe_segment_ud );
83
84 /*
85  * Composite hardware datatypes
86  *
87  */
88
89 #define ARBEL_MAX_GATHER 1
90
91 struct arbelprm_ud_send_wqe {
92         struct arbelprm_wqe_segment_next next;
93         struct arbelprm_wqe_segment_ctrl_send ctrl;
94         struct arbelprm_wqe_segment_ud ud;
95         struct arbelprm_wqe_segment_data_ptr data[ARBEL_MAX_GATHER];
96 } __attribute__ (( packed ));
97
98 #define ARBEL_MAX_SCATTER 1
99
100 struct arbelprm_recv_wqe {
101         /* The autogenerated header is inconsistent between send and
102          * receive WQEs.  The "ctrl" structure for receive WQEs is
103          * defined to include the "next" structure.  Since the "ctrl"
104          * part of the "ctrl" structure contains only "reserved, must
105          * be zero" bits, we ignore its definition and provide
106          * something more usable.
107          */
108         struct arbelprm_recv_wqe_segment_next next;
109         uint32_t ctrl[2]; /* All "reserved, must be zero" */
110         struct arbelprm_wqe_segment_data_ptr data[ARBEL_MAX_SCATTER];
111 } __attribute__ (( packed ));
112
113 union arbelprm_completion_entry {
114         struct arbelprm_completion_queue_entry normal;
115         struct arbelprm_completion_with_error error;
116 } __attribute__ (( packed ));
117
118 union arbelprm_doorbell_record {
119         struct arbelprm_cq_arm_db_record cq_arm;
120         struct arbelprm_cq_ci_db_record cq_ci;
121         struct arbelprm_qp_db_record qp;
122 } __attribute__ (( packed ));
123
124 union arbelprm_doorbell_register {
125         struct arbelprm_send_doorbell send;
126         uint32_t dword[2];
127 } __attribute__ (( packed ));
128
129 /*
130  * gPXE-specific definitions
131  *
132  */
133
134 /** Arbel device limits */
135 struct arbel_dev_limits {
136         /** Number of reserver UARs */
137         unsigned long reserved_uars;
138         /** Number of reserved CQs */
139         unsigned long reserved_cqs;
140         /** Number of reserved QPs */
141         unsigned long reserved_qps;
142 };
143
144 /** Alignment of Arbel send work queue entries */
145 #define ARBEL_SEND_WQE_ALIGN 128
146
147 /** An Arbel send work queue entry */
148 union arbel_send_wqe {
149         struct arbelprm_ud_send_wqe ud;
150         uint8_t force_align[ARBEL_SEND_WQE_ALIGN];
151 } __attribute__ (( packed ));
152
153 /** An Arbel send work queue */
154 struct arbel_send_work_queue {
155         /** Doorbell record number */
156         unsigned int doorbell_idx;
157         /** Work queue entries */
158         union arbel_send_wqe *wqe;
159         /** Size of work queue */
160         size_t wqe_size;
161 };
162
163 /** Alignment of Arbel receive work queue entries */
164 #define ARBEL_RECV_WQE_ALIGN 64
165
166 /** An Arbel receive work queue entry */
167 union arbel_recv_wqe {
168         struct arbelprm_recv_wqe recv;
169         uint8_t force_align[ARBEL_RECV_WQE_ALIGN];
170 } __attribute__ (( packed ));
171
172 /** An Arbel receive work queue */
173 struct arbel_recv_work_queue {
174         /** Doorbell record number */
175         unsigned int doorbell_idx;
176         /** Work queue entries */
177         union arbel_recv_wqe *wqe;
178         /** Size of work queue */
179         size_t wqe_size;
180 };
181
182 /** Maximum number of allocatable queue pairs
183  *
184  * This is a policy decision, not a device limit.
185  */
186 #define ARBEL_MAX_QPS           8
187
188 /** Base queue pair number */
189 #define ARBEL_QPN_BASE 0x550000
190
191 /** An Arbel queue pair */
192 struct arbel_queue_pair {
193         /** Send work queue */
194         struct arbel_send_work_queue send;
195         /** Receive work queue */
196         struct arbel_recv_work_queue recv;
197 };
198
199 /** Maximum number of allocatable completion queues
200  *
201  * This is a policy decision, not a device limit.
202  */
203 #define ARBEL_MAX_CQS           8
204
205 /** An Arbel completion queue */
206 struct arbel_completion_queue {
207         /** Consumer counter doorbell record number */
208         unsigned int ci_doorbell_idx;
209         /** Arm queue doorbell record number */
210         unsigned int arm_doorbell_idx;
211         /** Completion queue entries */
212         union arbelprm_completion_entry *cqe;
213         /** Size of completion queue */
214         size_t cqe_size;
215 };
216
217 /** An Arbel resource bitmask */
218 typedef uint32_t arbel_bitmask_t;
219
220 /** Size of an Arbel resource bitmask */
221 #define ARBEL_BITMASK_SIZE(max_entries)                                      \
222         ( ( (max_entries) + ( 8 * sizeof ( arbel_bitmask_t ) ) - 1 ) /       \
223           ( 8 * sizeof ( arbel_bitmask_t ) ) )
224
225 /** An Arbel device */
226 struct arbel {
227         /** Configuration registers */
228         void *config;
229         /** Command input mailbox */
230         void *mailbox_in;
231         /** Command output mailbox */
232         void *mailbox_out;
233
234         /** User Access Region */
235         void *uar;
236         /** Doorbell records */
237         union arbelprm_doorbell_record *db_rec;
238         /** Reserved LKey
239          *
240          * Used to get unrestricted memory access.
241          */
242         unsigned long reserved_lkey;
243         /** Event queue number */
244         unsigned long eqn;
245
246         /** Completion queue in-use bitmask */
247         arbel_bitmask_t cq_inuse[ ARBEL_BITMASK_SIZE ( ARBEL_MAX_CQS ) ];
248         /** Queue pair in-use bitmask */
249         arbel_bitmask_t qp_inuse[ ARBEL_BITMASK_SIZE ( ARBEL_MAX_QPS ) ];
250         
251         /** Device limits */
252         struct arbel_dev_limits limits;
253 };
254
255 /** Global protection domain */
256 #define ARBEL_GLOBAL_PD                 0x123456
257
258 /*
259  * HCA commands
260  *
261  */
262
263 #define ARBEL_HCR_BASE                  0x80680
264 #define ARBEL_HCR_REG(x)                ( ARBEL_HCR_BASE + 4 * (x) )
265 #define ARBEL_HCR_MAX_WAIT_MS           2000
266
267 /* HCA command is split into
268  *
269  * bits  11:0   Opcode
270  * bit     12   Input uses mailbox
271  * bit     13   Output uses mailbox
272  * bits 22:14   Input parameter length (in dwords)
273  * bits 31:23   Output parameter length (in dwords)
274  *
275  * Encoding the information in this way allows us to cut out several
276  * parameters to the arbel_command() call.
277  */
278 #define ARBEL_HCR_IN_MBOX               0x00001000UL
279 #define ARBEL_HCR_OUT_MBOX              0x00002000UL
280 #define ARBEL_HCR_OPCODE( _command )    ( (_command) & 0xfff )
281 #define ARBEL_HCR_IN_LEN( _command )    ( ( (_command) >> 12 ) & 0x7fc )
282 #define ARBEL_HCR_OUT_LEN( _command )   ( ( (_command) >> 21 ) & 0x7fc )
283
284 /** Build HCR command from component parts */
285 #define ARBEL_HCR_INOUT_CMD( _opcode, _in_mbox, _in_len,                     \
286                              _out_mbox, _out_len )                           \
287         ( (_opcode) |                                                        \
288           ( (_in_mbox) ? ARBEL_HCR_IN_MBOX : 0 ) |                           \
289           ( ( (_in_len) / 4 ) << 14 ) |                                      \
290           ( (_out_mbox) ? ARBEL_HCR_OUT_MBOX : 0 ) |                         \
291           ( ( (_out_len) / 4 ) << 23 ) )
292
293 #define ARBEL_HCR_IN_CMD( _opcode, _in_mbox, _in_len )                       \
294         ARBEL_HCR_INOUT_CMD ( _opcode, _in_mbox, _in_len, 0, 0 )
295
296 #define ARBEL_HCR_OUT_CMD( _opcode, _out_mbox, _out_len )                    \
297         ARBEL_HCR_INOUT_CMD ( _opcode, 0, 0, _out_mbox, _out_len )
298
299 #define ARBEL_HCR_VOID_CMD( _opcode )                                        \
300         ARBEL_HCR_INOUT_CMD ( _opcode, 0, 0, 0, 0 )
301
302 /*
303  * Doorbell record allocation
304  *
305  * The doorbell record map looks like:
306  *
307  *    ARBEL_MAX_CQS * Arm completion queue doorbell
308  *    ARBEL_MAX_QPS * Send work request doorbell
309  *    Group separator
310  *    ...(empty space)...
311  *    ARBEL_MAX_QPS * Receive work request doorbell
312  *    ARBEL_MAX_CQS * Completion queue consumer counter update doorbell
313  */
314
315 #define ARBEL_MAX_DOORBELL_RECORDS 512
316 #define ARBEL_GROUP_SEPARATOR_DOORBELL ( ARBEL_MAX_CQS + ARBEL_MAX_QPS )
317
318 /**
319  * Get arm completion queue doorbell index
320  *
321  * @v cqn_offset        Completion queue number offset
322  * @ret doorbell_idx    Doorbell index
323  */
324 static inline unsigned int
325 arbel_cq_arm_doorbell_idx ( unsigned int cqn_offset ) {
326         return cqn_offset;
327 }
328
329 /**
330  * Get send work request doorbell index
331  *
332  * @v qpn_offset        Queue pair number offset
333  * @ret doorbell_idx    Doorbell index
334  */
335 static inline unsigned int
336 arbel_send_doorbell_idx ( unsigned int qpn_offset ) {
337         return ( ARBEL_MAX_CQS + qpn_offset );
338 }
339
340 /**
341  * Get receive work request doorbell index
342  *
343  * @v qpn_offset        Queue pair number offset
344  * @ret doorbell_idx    Doorbell index
345  */
346 static inline unsigned int
347 arbel_recv_doorbell_idx ( unsigned int qpn_offset ) {
348         return ( ARBEL_MAX_DOORBELL_RECORDS - ARBEL_MAX_CQS - qpn_offset - 1 );
349 }
350
351 /**
352  * Get completion queue consumer counter doorbell index
353  *
354  * @v cqn_offset        Completion queue number offset
355  * @ret doorbell_idx    Doorbell index
356  */
357 static inline unsigned int
358 arbel_cq_ci_doorbell_idx ( unsigned int cqn_offset ) {
359         return ( ARBEL_MAX_DOORBELL_RECORDS - cqn_offset - 1 );
360 }
361
362 #endif /* _ARBEL_H */