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