2 * linux/drivers/net/ehea/ehea_qmr.h
4 * eHEA ethernet device driver for IBM eServer System p
6 * (C) Copyright IBM Corp. 2006
9 * Christoph Raisch <raisch@de.ibm.com>
10 * Jan-Bernd Themann <themann@de.ibm.com>
11 * Thomas Klein <tklein@de.ibm.com>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #ifndef __EHEA_QMR_H__
30 #define __EHEA_QMR_H__
36 * page size of ehea hardware queues
39 #define EHEA_PAGESHIFT 12
40 #define EHEA_PAGESIZE (1UL << EHEA_PAGESHIFT)
41 #define EHEA_SECTSIZE (1UL << 24)
42 #define EHEA_PAGES_PER_SECTION (EHEA_SECTSIZE >> EHEA_PAGESHIFT)
43 #define EHEA_HUGEPAGESHIFT 34
44 #define EHEA_HUGEPAGE_SIZE (1UL << EHEA_HUGEPAGESHIFT)
45 #define EHEA_HUGEPAGE_PFN_MASK ((EHEA_HUGEPAGE_SIZE - 1) >> PAGE_SHIFT)
47 #if ((1UL << SECTION_SIZE_BITS) < EHEA_SECTSIZE)
48 #error eHEA module cannot work if kernel sectionsize < ehea sectionsize
51 /* Some abbreviations used here:
53 * WQE - Work Queue Entry
54 * SWQE - Send Work Queue Entry
55 * RWQE - Receive Work Queue Entry
56 * CQE - Completion Queue Entry
57 * EQE - Event Queue Entry
61 /* Use of WR_ID field for EHEA */
62 #define EHEA_WR_ID_COUNT EHEA_BMASK_IBM(0, 19)
63 #define EHEA_WR_ID_TYPE EHEA_BMASK_IBM(20, 23)
64 #define EHEA_SWQE2_TYPE 0x1
65 #define EHEA_SWQE3_TYPE 0x2
66 #define EHEA_RWQE2_TYPE 0x3
67 #define EHEA_RWQE3_TYPE 0x4
68 #define EHEA_WR_ID_INDEX EHEA_BMASK_IBM(24, 47)
69 #define EHEA_WR_ID_REFILL EHEA_BMASK_IBM(48, 63)
71 struct ehea_vsgentry
{
77 /* maximum number of sg entries allowed in a WQE */
78 #define EHEA_MAX_WQE_SG_ENTRIES 252
79 #define SWQE2_MAX_IMM (0xD0 - 0x30)
80 #define SWQE3_MAX_IMM 224
82 /* tx control flags for swqe */
83 #define EHEA_SWQE_CRC 0x8000
84 #define EHEA_SWQE_IP_CHECKSUM 0x4000
85 #define EHEA_SWQE_TCP_CHECKSUM 0x2000
86 #define EHEA_SWQE_TSO 0x1000
87 #define EHEA_SWQE_SIGNALLED_COMPLETION 0x0800
88 #define EHEA_SWQE_VLAN_INSERT 0x0400
89 #define EHEA_SWQE_IMM_DATA_PRESENT 0x0200
90 #define EHEA_SWQE_DESCRIPTORS_PRESENT 0x0100
91 #define EHEA_SWQE_WRAP_CTL_REC 0x0080
92 #define EHEA_SWQE_WRAP_CTL_FORCE 0x0040
93 #define EHEA_SWQE_BIND 0x0020
94 #define EHEA_SWQE_PURGE 0x0010
96 /* sizeof(struct ehea_swqe) less the union */
97 #define SWQE_HEADER_SIZE 32
106 u8 immediate_data_length
;
111 u8 descriptors
; /* number of valid descriptors in WQE */
117 /* Send WQE Format 1 */
119 struct ehea_vsgentry sg_list
[EHEA_MAX_WQE_SG_ENTRIES
];
122 /* Send WQE Format 2 */
124 struct ehea_vsgentry sg_entry
;
126 u8 immediate_data
[SWQE2_MAX_IMM
];
128 struct ehea_vsgentry sg_list
[EHEA_MAX_WQE_SG_ENTRIES
-1];
129 } immdata_desc
__attribute__ ((packed
));
131 /* Send WQE Format 3 */
133 u8 immediate_data
[SWQE3_MAX_IMM
];
139 u64 wr_id
; /* work request ID */
145 struct ehea_vsgentry sg_list
[EHEA_MAX_WQE_SG_ENTRIES
];
148 #define EHEA_CQE_VLAN_TAG_XTRACT 0x0400
150 #define EHEA_CQE_TYPE_RQ 0x60
151 #define EHEA_CQE_STAT_ERR_MASK 0x700F
152 #define EHEA_CQE_STAT_FAT_ERR_MASK 0xF
153 #define EHEA_CQE_STAT_ERR_TCP 0x4000
154 #define EHEA_CQE_STAT_ERR_IP 0x2000
155 #define EHEA_CQE_STAT_ERR_CRC 0x1000
157 /* Defines which bad send cqe stati lead to a port reset */
158 #define EHEA_CQE_STAT_RESET_MASK 0x0002
161 u64 wr_id
; /* work request ID from WQE */
166 u16 num_bytes_transfered
;
168 u16 inet_checksum_value
;
180 #define EHEA_EQE_VALID EHEA_BMASK_IBM(0, 0)
181 #define EHEA_EQE_IS_CQE EHEA_BMASK_IBM(1, 1)
182 #define EHEA_EQE_IDENTIFIER EHEA_BMASK_IBM(2, 7)
183 #define EHEA_EQE_QP_CQ_NUMBER EHEA_BMASK_IBM(8, 31)
184 #define EHEA_EQE_QP_TOKEN EHEA_BMASK_IBM(32, 63)
185 #define EHEA_EQE_CQ_TOKEN EHEA_BMASK_IBM(32, 63)
186 #define EHEA_EQE_KEY EHEA_BMASK_IBM(32, 63)
187 #define EHEA_EQE_PORT_NUMBER EHEA_BMASK_IBM(56, 63)
188 #define EHEA_EQE_EQ_NUMBER EHEA_BMASK_IBM(48, 63)
189 #define EHEA_EQE_SM_ID EHEA_BMASK_IBM(48, 63)
190 #define EHEA_EQE_SM_MECH_NUMBER EHEA_BMASK_IBM(48, 55)
191 #define EHEA_EQE_SM_PORT_NUMBER EHEA_BMASK_IBM(56, 63)
193 #define EHEA_AER_RESTYPE_QP 0x8
194 #define EHEA_AER_RESTYPE_CQ 0x4
195 #define EHEA_AER_RESTYPE_EQ 0x3
197 /* Defines which affiliated errors lead to a port reset */
198 #define EHEA_AER_RESET_MASK 0xFFFFFFFFFEFFFFFFULL
199 #define EHEA_AERR_RESET_MASK 0xFFFFFFFFFFFFFFFFULL
205 #define ERROR_DATA_LENGTH EHEA_BMASK_IBM(52, 63)
206 #define ERROR_DATA_TYPE EHEA_BMASK_IBM(0, 7)
208 static inline void *hw_qeit_calc(struct hw_queue
*queue
, u64 q_offset
)
210 struct ehea_page
*current_page
;
212 if (q_offset
>= queue
->queue_length
)
213 q_offset
-= queue
->queue_length
;
214 current_page
= (queue
->queue_pages
)[q_offset
>> EHEA_PAGESHIFT
];
215 return ¤t_page
->entries
[q_offset
& (EHEA_PAGESIZE
- 1)];
218 static inline void *hw_qeit_get(struct hw_queue
*queue
)
220 return hw_qeit_calc(queue
, queue
->current_q_offset
);
223 static inline void hw_qeit_inc(struct hw_queue
*queue
)
225 queue
->current_q_offset
+= queue
->qe_size
;
226 if (queue
->current_q_offset
>= queue
->queue_length
) {
227 queue
->current_q_offset
= 0;
228 /* toggle the valid flag */
229 queue
->toggle_state
= (~queue
->toggle_state
) & 1;
233 static inline void *hw_qeit_get_inc(struct hw_queue
*queue
)
235 void *retvalue
= hw_qeit_get(queue
);
240 static inline void *hw_qeit_get_inc_valid(struct hw_queue
*queue
)
242 struct ehea_cqe
*retvalue
= hw_qeit_get(queue
);
243 u8 valid
= retvalue
->valid
;
246 if ((valid
>> 7) == (queue
->toggle_state
& 1)) {
247 /* this is a good one */
249 pref
= hw_qeit_calc(queue
, queue
->current_q_offset
);
251 prefetch(pref
+ 128);
257 static inline void *hw_qeit_get_valid(struct hw_queue
*queue
)
259 struct ehea_cqe
*retvalue
= hw_qeit_get(queue
);
263 pref
= hw_qeit_calc(queue
, queue
->current_q_offset
);
265 prefetch(pref
+ 128);
266 prefetch(pref
+ 256);
267 valid
= retvalue
->valid
;
268 if (!((valid
>> 7) == (queue
->toggle_state
& 1)))
273 static inline void *hw_qeit_reset(struct hw_queue
*queue
)
275 queue
->current_q_offset
= 0;
276 return hw_qeit_get(queue
);
279 static inline void *hw_qeit_eq_get_inc(struct hw_queue
*queue
)
281 u64 last_entry_in_q
= queue
->queue_length
- queue
->qe_size
;
284 retvalue
= hw_qeit_get(queue
);
285 queue
->current_q_offset
+= queue
->qe_size
;
286 if (queue
->current_q_offset
> last_entry_in_q
) {
287 queue
->current_q_offset
= 0;
288 queue
->toggle_state
= (~queue
->toggle_state
) & 1;
293 static inline void *hw_eqit_eq_get_inc_valid(struct hw_queue
*queue
)
295 void *retvalue
= hw_qeit_get(queue
);
296 u32 qe
= *(u8
*)retvalue
;
297 if ((qe
>> 7) == (queue
->toggle_state
& 1))
298 hw_qeit_eq_get_inc(queue
);
304 static inline struct ehea_rwqe
*ehea_get_next_rwqe(struct ehea_qp
*qp
,
307 struct hw_queue
*queue
;
310 queue
= &qp
->hw_rqueue1
;
312 queue
= &qp
->hw_rqueue2
;
314 queue
= &qp
->hw_rqueue3
;
316 return hw_qeit_get_inc(queue
);
319 static inline struct ehea_swqe
*ehea_get_swqe(struct ehea_qp
*my_qp
,
322 struct hw_queue
*queue
= &my_qp
->hw_squeue
;
323 struct ehea_swqe
*wqe_p
;
325 *wqe_index
= (queue
->current_q_offset
) >> (7 + EHEA_SG_SQ
);
326 wqe_p
= hw_qeit_get_inc(&my_qp
->hw_squeue
);
331 static inline void ehea_post_swqe(struct ehea_qp
*my_qp
, struct ehea_swqe
*swqe
)
334 ehea_update_sqa(my_qp
, 1);
337 static inline struct ehea_cqe
*ehea_poll_rq1(struct ehea_qp
*qp
, int *wqe_index
)
339 struct hw_queue
*queue
= &qp
->hw_rqueue1
;
341 *wqe_index
= (queue
->current_q_offset
) >> (7 + EHEA_SG_RQ1
);
342 return hw_qeit_get_valid(queue
);
345 static inline void ehea_inc_cq(struct ehea_cq
*cq
)
347 hw_qeit_inc(&cq
->hw_queue
);
350 static inline void ehea_inc_rq1(struct ehea_qp
*qp
)
352 hw_qeit_inc(&qp
->hw_rqueue1
);
355 static inline struct ehea_cqe
*ehea_poll_cq(struct ehea_cq
*my_cq
)
357 return hw_qeit_get_valid(&my_cq
->hw_queue
);
360 #define EHEA_CQ_REGISTER_ORIG 0
361 #define EHEA_EQ_REGISTER_ORIG 0
364 EHEA_EQ
= 0, /* event queue */
365 EHEA_NEQ
/* notification event queue */
368 struct ehea_eq
*ehea_create_eq(struct ehea_adapter
*adapter
,
369 enum ehea_eq_type type
,
370 const u32 length
, const u8 eqe_gen
);
372 int ehea_destroy_eq(struct ehea_eq
*eq
);
374 struct ehea_eqe
*ehea_poll_eq(struct ehea_eq
*eq
);
376 struct ehea_cq
*ehea_create_cq(struct ehea_adapter
*adapter
, int cqe
,
377 u64 eq_handle
, u32 cq_token
);
379 int ehea_destroy_cq(struct ehea_cq
*cq
);
381 struct ehea_qp
*ehea_create_qp(struct ehea_adapter
*adapter
, u32 pd
,
382 struct ehea_qp_init_attr
*init_attr
);
384 int ehea_destroy_qp(struct ehea_qp
*qp
);
386 int ehea_reg_kernel_mr(struct ehea_adapter
*adapter
, struct ehea_mr
*mr
);
388 int ehea_gen_smr(struct ehea_adapter
*adapter
, struct ehea_mr
*old_mr
,
389 struct ehea_mr
*shared_mr
);
391 int ehea_rem_mr(struct ehea_mr
*mr
);
393 u64
ehea_error_data(struct ehea_adapter
*adapter
, u64 res_handle
,
394 u64
*aer
, u64
*aerr
);
396 int ehea_add_sect_bmap(unsigned long pfn
, unsigned long nr_pages
);
397 int ehea_rem_sect_bmap(unsigned long pfn
, unsigned long nr_pages
);
398 int ehea_create_busmap(void);
399 void ehea_destroy_busmap(void);
400 u64
ehea_map_vaddr(void *caddr
);
402 #endif /* __EHEA_QMR_H__ */