1 /* QLogic qed NIC Driver
2 * Copyright (c) 2015 QLogic Corporation
4 * This software is available under the terms of the GNU General Public License
5 * (GPL) Version 2, available from the file COPYING in the main directory of
12 #include <linux/types.h>
13 #include <asm/byteorder.h>
14 #include <linux/kernel.h>
15 #include <linux/list.h>
16 #include <linux/slab.h>
17 #include <linux/qed/common_hsi.h>
19 /* dma_addr_t manip */
20 #define DMA_LO_LE(x) cpu_to_le32(lower_32_bits(x))
21 #define DMA_HI_LE(x) cpu_to_le32(upper_32_bits(x))
22 #define DMA_REGPAIR_LE(x, val) do { \
23 (x).hi = DMA_HI_LE((val)); \
24 (x).lo = DMA_LO_LE((val)); \
27 #define HILO_GEN(hi, lo, type) ((((type)(hi)) << 32) + (lo))
28 #define HILO_64(hi, lo) HILO_GEN((le32_to_cpu(hi)), (le32_to_cpu(lo)), u64)
29 #define HILO_64_REGPAIR(regpair) (HILO_64(regpair.hi, regpair.lo))
30 #define HILO_DMA_REGPAIR(regpair) ((dma_addr_t)HILO_64_REGPAIR(regpair))
33 /* Each Page contains a next pointer at its end */
34 QED_CHAIN_MODE_NEXT_PTR,
36 /* Chain is a single page (next ptr) is unrequired */
37 QED_CHAIN_MODE_SINGLE,
39 /* Page pointers are located in a side list */
43 enum qed_chain_use_mode {
44 QED_CHAIN_USE_TO_PRODUCE, /* Chain starts empty */
45 QED_CHAIN_USE_TO_CONSUME, /* Chain starts full */
46 QED_CHAIN_USE_TO_CONSUME_PRODUCE, /* Chain starts empty */
49 enum qed_chain_cnt_type {
50 /* The chain's size/prod/cons are kept in 16-bit variables */
51 QED_CHAIN_CNT_TYPE_U16,
53 /* The chain's size/prod/cons are kept in 32-bit variables */
54 QED_CHAIN_CNT_TYPE_U32,
57 struct qed_chain_next {
58 struct regpair next_phys;
62 struct qed_chain_pbl_u16 {
67 struct qed_chain_pbl_u32 {
72 struct qed_chain_pbl {
73 /* Base address of a pre-allocated buffer for pbl */
74 dma_addr_t p_phys_table;
77 /* Table for keeping the virtual addresses of the chain pages,
78 * respectively to the physical addresses in the pbl table.
80 void **pp_virt_addr_tbl;
82 /* Index to current used page by producer/consumer */
84 struct qed_chain_pbl_u16 pbl16;
85 struct qed_chain_pbl_u32 pbl32;
89 struct qed_chain_u16 {
90 /* Cyclic index of next element to produce/consme */
95 struct qed_chain_u32 {
96 /* Cyclic index of next element to produce/consme */
103 dma_addr_t p_phys_addr;
107 enum qed_chain_mode mode;
108 enum qed_chain_use_mode intended_use; /* used to produce/consume */
109 enum qed_chain_cnt_type cnt_type;
112 struct qed_chain_u16 chain16;
113 struct qed_chain_u32 chain32;
118 /* Number of elements - capacity is for usable elements only,
119 * while size will contain total number of elements [for entire chain].
124 /* Elements information for fast calculations */
126 u16 elem_per_page_mask;
131 struct qed_chain_pbl pbl;
134 #define QED_CHAIN_PBL_ENTRY_SIZE (8)
135 #define QED_CHAIN_PAGE_SIZE (0x1000)
136 #define ELEMS_PER_PAGE(elem_size) (QED_CHAIN_PAGE_SIZE / (elem_size))
138 #define UNUSABLE_ELEMS_PER_PAGE(elem_size, mode) \
139 ((mode == QED_CHAIN_MODE_NEXT_PTR) ? \
140 (1 + ((sizeof(struct qed_chain_next) - 1) / \
143 #define USABLE_ELEMS_PER_PAGE(elem_size, mode) \
144 ((u32)(ELEMS_PER_PAGE(elem_size) - \
145 UNUSABLE_ELEMS_PER_PAGE(elem_size, mode)))
147 #define QED_CHAIN_PAGE_CNT(elem_cnt, elem_size, mode) \
148 DIV_ROUND_UP(elem_cnt, USABLE_ELEMS_PER_PAGE(elem_size, mode))
150 #define is_chain_u16(p) ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U16)
151 #define is_chain_u32(p) ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U32)
154 static inline u16 qed_chain_get_prod_idx(struct qed_chain *p_chain)
156 return p_chain->u.chain16.prod_idx;
159 static inline u16 qed_chain_get_cons_idx(struct qed_chain *p_chain)
161 return p_chain->u.chain16.cons_idx;
164 static inline u32 qed_chain_get_cons_idx_u32(struct qed_chain *p_chain)
166 return p_chain->u.chain32.cons_idx;
169 static inline u16 qed_chain_get_elem_left(struct qed_chain *p_chain)
173 used = (u16) (((u32)0x10000 +
174 (u32)p_chain->u.chain16.prod_idx) -
175 (u32)p_chain->u.chain16.cons_idx);
176 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
177 used -= p_chain->u.chain16.prod_idx / p_chain->elem_per_page -
178 p_chain->u.chain16.cons_idx / p_chain->elem_per_page;
180 return (u16)(p_chain->capacity - used);
183 static inline u32 qed_chain_get_elem_left_u32(struct qed_chain *p_chain)
187 used = (u32) (((u64)0x100000000ULL +
188 (u64)p_chain->u.chain32.prod_idx) -
189 (u64)p_chain->u.chain32.cons_idx);
190 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
191 used -= p_chain->u.chain32.prod_idx / p_chain->elem_per_page -
192 p_chain->u.chain32.cons_idx / p_chain->elem_per_page;
194 return p_chain->capacity - used;
197 static inline u16 qed_chain_get_usable_per_page(struct qed_chain *p_chain)
199 return p_chain->usable_per_page;
202 static inline u16 qed_chain_get_unusable_per_page(struct qed_chain *p_chain)
204 return p_chain->elem_unusable;
207 static inline u32 qed_chain_get_page_cnt(struct qed_chain *p_chain)
209 return p_chain->page_cnt;
212 static inline dma_addr_t qed_chain_get_pbl_phys(struct qed_chain *p_chain)
214 return p_chain->pbl.p_phys_table;
218 * @brief qed_chain_advance_page -
220 * Advance the next element accros pages for a linked chain
228 qed_chain_advance_page(struct qed_chain *p_chain,
229 void **p_next_elem, void *idx_to_inc, void *page_to_inc)
232 struct qed_chain_next *p_next = NULL;
234 switch (p_chain->mode) {
235 case QED_CHAIN_MODE_NEXT_PTR:
236 p_next = *p_next_elem;
237 *p_next_elem = p_next->next_virt;
238 if (is_chain_u16(p_chain))
239 *(u16 *)idx_to_inc += p_chain->elem_unusable;
241 *(u32 *)idx_to_inc += p_chain->elem_unusable;
243 case QED_CHAIN_MODE_SINGLE:
244 *p_next_elem = p_chain->p_virt_addr;
247 case QED_CHAIN_MODE_PBL:
248 if (is_chain_u16(p_chain)) {
249 if (++(*(u16 *)page_to_inc) == p_chain->page_cnt)
250 *(u16 *)page_to_inc = 0;
251 page_index = *(u16 *)page_to_inc;
253 if (++(*(u32 *)page_to_inc) == p_chain->page_cnt)
254 *(u32 *)page_to_inc = 0;
255 page_index = *(u32 *)page_to_inc;
257 *p_next_elem = p_chain->pbl.pp_virt_addr_tbl[page_index];
261 #define is_unusable_idx(p, idx) \
262 (((p)->u.chain16.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
264 #define is_unusable_idx_u32(p, idx) \
265 (((p)->u.chain32.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
266 #define is_unusable_next_idx(p, idx) \
267 ((((p)->u.chain16.idx + 1) & (p)->elem_per_page_mask) == \
268 (p)->usable_per_page)
270 #define is_unusable_next_idx_u32(p, idx) \
271 ((((p)->u.chain32.idx + 1) & (p)->elem_per_page_mask) == \
272 (p)->usable_per_page)
274 #define test_and_skip(p, idx) \
276 if (is_chain_u16(p)) { \
277 if (is_unusable_idx(p, idx)) \
278 (p)->u.chain16.idx += (p)->elem_unusable; \
280 if (is_unusable_idx_u32(p, idx)) \
281 (p)->u.chain32.idx += (p)->elem_unusable; \
286 * @brief qed_chain_return_produced -
288 * A chain in which the driver "Produces" elements should use this API
289 * to indicate previous produced elements are now consumed.
293 static inline void qed_chain_return_produced(struct qed_chain *p_chain)
295 if (is_chain_u16(p_chain))
296 p_chain->u.chain16.cons_idx++;
298 p_chain->u.chain32.cons_idx++;
299 test_and_skip(p_chain, cons_idx);
303 * @brief qed_chain_produce -
305 * A chain in which the driver "Produces" elements should use this to get
306 * a pointer to the next element which can be "Produced". It's driver
307 * responsibility to validate that the chain has room for new element.
311 * @return void*, a pointer to next element
313 static inline void *qed_chain_produce(struct qed_chain *p_chain)
315 void *p_ret = NULL, *p_prod_idx, *p_prod_page_idx;
317 if (is_chain_u16(p_chain)) {
318 if ((p_chain->u.chain16.prod_idx &
319 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
320 p_prod_idx = &p_chain->u.chain16.prod_idx;
321 p_prod_page_idx = &p_chain->pbl.u.pbl16.prod_page_idx;
322 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
323 p_prod_idx, p_prod_page_idx);
325 p_chain->u.chain16.prod_idx++;
327 if ((p_chain->u.chain32.prod_idx &
328 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
329 p_prod_idx = &p_chain->u.chain32.prod_idx;
330 p_prod_page_idx = &p_chain->pbl.u.pbl32.prod_page_idx;
331 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
332 p_prod_idx, p_prod_page_idx);
334 p_chain->u.chain32.prod_idx++;
337 p_ret = p_chain->p_prod_elem;
338 p_chain->p_prod_elem = (void *)(((u8 *)p_chain->p_prod_elem) +
345 * @brief qed_chain_get_capacity -
347 * Get the maximum number of BDs in chain
352 * @return number of unusable BDs
354 static inline u32 qed_chain_get_capacity(struct qed_chain *p_chain)
356 return p_chain->capacity;
360 * @brief qed_chain_recycle_consumed -
362 * Returns an element which was previously consumed;
363 * Increments producers so they could be written to FW.
367 static inline void qed_chain_recycle_consumed(struct qed_chain *p_chain)
369 test_and_skip(p_chain, prod_idx);
370 if (is_chain_u16(p_chain))
371 p_chain->u.chain16.prod_idx++;
373 p_chain->u.chain32.prod_idx++;
377 * @brief qed_chain_consume -
379 * A Chain in which the driver utilizes data written by a different source
380 * (i.e., FW) should use this to access passed buffers.
384 * @return void*, a pointer to the next buffer written
386 static inline void *qed_chain_consume(struct qed_chain *p_chain)
388 void *p_ret = NULL, *p_cons_idx, *p_cons_page_idx;
390 if (is_chain_u16(p_chain)) {
391 if ((p_chain->u.chain16.cons_idx &
392 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
393 p_cons_idx = &p_chain->u.chain16.cons_idx;
394 p_cons_page_idx = &p_chain->pbl.u.pbl16.cons_page_idx;
395 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
396 p_cons_idx, p_cons_page_idx);
398 p_chain->u.chain16.cons_idx++;
400 if ((p_chain->u.chain32.cons_idx &
401 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
402 p_cons_idx = &p_chain->u.chain32.cons_idx;
403 p_cons_page_idx = &p_chain->pbl.u.pbl32.cons_page_idx;
404 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
405 p_cons_idx, p_cons_page_idx);
407 p_chain->u.chain32.cons_idx++;
410 p_ret = p_chain->p_cons_elem;
411 p_chain->p_cons_elem = (void *)(((u8 *)p_chain->p_cons_elem) +
418 * @brief qed_chain_reset - Resets the chain to its start state
420 * @param p_chain pointer to a previously allocted chain
422 static inline void qed_chain_reset(struct qed_chain *p_chain)
426 if (is_chain_u16(p_chain)) {
427 p_chain->u.chain16.prod_idx = 0;
428 p_chain->u.chain16.cons_idx = 0;
430 p_chain->u.chain32.prod_idx = 0;
431 p_chain->u.chain32.cons_idx = 0;
433 p_chain->p_cons_elem = p_chain->p_virt_addr;
434 p_chain->p_prod_elem = p_chain->p_virt_addr;
436 if (p_chain->mode == QED_CHAIN_MODE_PBL) {
437 /* Use (page_cnt - 1) as a reset value for the prod/cons page's
438 * indices, to avoid unnecessary page advancing on the first
439 * call to qed_chain_produce/consume. Instead, the indices
440 * will be advanced to page_cnt and then will be wrapped to 0.
442 u32 reset_val = p_chain->page_cnt - 1;
444 if (is_chain_u16(p_chain)) {
445 p_chain->pbl.u.pbl16.prod_page_idx = (u16)reset_val;
446 p_chain->pbl.u.pbl16.cons_page_idx = (u16)reset_val;
448 p_chain->pbl.u.pbl32.prod_page_idx = reset_val;
449 p_chain->pbl.u.pbl32.cons_page_idx = reset_val;
453 switch (p_chain->intended_use) {
454 case QED_CHAIN_USE_TO_CONSUME_PRODUCE:
455 case QED_CHAIN_USE_TO_PRODUCE:
459 case QED_CHAIN_USE_TO_CONSUME:
460 /* produce empty elements */
461 for (i = 0; i < p_chain->capacity; i++)
462 qed_chain_recycle_consumed(p_chain);
468 * @brief qed_chain_init - Initalizes a basic chain struct
472 * @param p_phys_addr physical address of allocated buffer's beginning
473 * @param page_cnt number of pages in the allocated buffer
474 * @param elem_size size of each element in the chain
475 * @param intended_use
478 static inline void qed_chain_init_params(struct qed_chain *p_chain,
481 enum qed_chain_use_mode intended_use,
482 enum qed_chain_mode mode,
483 enum qed_chain_cnt_type cnt_type)
485 /* chain fixed parameters */
486 p_chain->p_virt_addr = NULL;
487 p_chain->p_phys_addr = 0;
488 p_chain->elem_size = elem_size;
489 p_chain->intended_use = intended_use;
490 p_chain->mode = mode;
491 p_chain->cnt_type = cnt_type;
493 p_chain->elem_per_page = ELEMS_PER_PAGE(elem_size);
494 p_chain->usable_per_page = USABLE_ELEMS_PER_PAGE(elem_size, mode);
495 p_chain->elem_per_page_mask = p_chain->elem_per_page - 1;
496 p_chain->elem_unusable = UNUSABLE_ELEMS_PER_PAGE(elem_size, mode);
497 p_chain->next_page_mask = (p_chain->usable_per_page &
498 p_chain->elem_per_page_mask);
500 p_chain->page_cnt = page_cnt;
501 p_chain->capacity = p_chain->usable_per_page * page_cnt;
502 p_chain->size = p_chain->elem_per_page * page_cnt;
504 p_chain->pbl.p_phys_table = 0;
505 p_chain->pbl.p_virt_table = NULL;
506 p_chain->pbl.pp_virt_addr_tbl = NULL;
510 * @brief qed_chain_init_mem -
512 * Initalizes a basic chain struct with its chain buffers
515 * @param p_virt_addr virtual address of allocated buffer's beginning
516 * @param p_phys_addr physical address of allocated buffer's beginning
519 static inline void qed_chain_init_mem(struct qed_chain *p_chain,
520 void *p_virt_addr, dma_addr_t p_phys_addr)
522 p_chain->p_virt_addr = p_virt_addr;
523 p_chain->p_phys_addr = p_phys_addr;
527 * @brief qed_chain_init_pbl_mem -
529 * Initalizes a basic chain struct with its pbl buffers
532 * @param p_virt_pbl pointer to a pre allocated side table which will hold
533 * virtual page addresses.
534 * @param p_phys_pbl pointer to a pre-allocated side table which will hold
535 * physical page addresses.
536 * @param pp_virt_addr_tbl
537 * pointer to a pre-allocated side table which will hold
538 * the virtual addresses of the chain pages.
541 static inline void qed_chain_init_pbl_mem(struct qed_chain *p_chain,
543 dma_addr_t p_phys_pbl,
544 void **pp_virt_addr_tbl)
546 p_chain->pbl.p_phys_table = p_phys_pbl;
547 p_chain->pbl.p_virt_table = p_virt_pbl;
548 p_chain->pbl.pp_virt_addr_tbl = pp_virt_addr_tbl;
552 * @brief qed_chain_init_next_ptr_elem -
554 * Initalizes a next pointer element
557 * @param p_virt_curr virtual address of a chain page of which the next
558 * pointer element is initialized
559 * @param p_virt_next virtual address of the next chain page
560 * @param p_phys_next physical address of the next chain page
564 qed_chain_init_next_ptr_elem(struct qed_chain *p_chain,
566 void *p_virt_next, dma_addr_t p_phys_next)
568 struct qed_chain_next *p_next;
571 size = p_chain->elem_size * p_chain->usable_per_page;
572 p_next = (struct qed_chain_next *)((u8 *)p_virt_curr + size);
574 DMA_REGPAIR_LE(p_next->next_phys, p_phys_next);
576 p_next->next_virt = p_virt_next;
580 * @brief qed_chain_get_last_elem -
582 * Returns a pointer to the last element of the chain
588 static inline void *qed_chain_get_last_elem(struct qed_chain *p_chain)
590 struct qed_chain_next *p_next = NULL;
591 void *p_virt_addr = NULL;
592 u32 size, last_page_idx;
594 if (!p_chain->p_virt_addr)
597 switch (p_chain->mode) {
598 case QED_CHAIN_MODE_NEXT_PTR:
599 size = p_chain->elem_size * p_chain->usable_per_page;
600 p_virt_addr = p_chain->p_virt_addr;
601 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr + size);
602 while (p_next->next_virt != p_chain->p_virt_addr) {
603 p_virt_addr = p_next->next_virt;
604 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr +
608 case QED_CHAIN_MODE_SINGLE:
609 p_virt_addr = p_chain->p_virt_addr;
611 case QED_CHAIN_MODE_PBL:
612 last_page_idx = p_chain->page_cnt - 1;
613 p_virt_addr = p_chain->pbl.pp_virt_addr_tbl[last_page_idx];
616 /* p_virt_addr points at this stage to the last page of the chain */
617 size = p_chain->elem_size * (p_chain->usable_per_page - 1);
618 p_virt_addr = (u8 *)p_virt_addr + size;
624 * @brief qed_chain_set_prod - sets the prod to the given value
629 static inline void qed_chain_set_prod(struct qed_chain *p_chain,
630 u32 prod_idx, void *p_prod_elem)
632 if (is_chain_u16(p_chain))
633 p_chain->u.chain16.prod_idx = (u16) prod_idx;
635 p_chain->u.chain32.prod_idx = prod_idx;
636 p_chain->p_prod_elem = p_prod_elem;
640 * @brief qed_chain_pbl_zero_mem - set chain memory to 0
644 static inline void qed_chain_pbl_zero_mem(struct qed_chain *p_chain)
648 if (p_chain->mode != QED_CHAIN_MODE_PBL)
651 page_cnt = qed_chain_get_page_cnt(p_chain);
653 for (i = 0; i < page_cnt; i++)
654 memset(p_chain->pbl.pp_virt_addr_tbl[i], 0,
655 QED_CHAIN_PAGE_SIZE);