1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
2 /* QLogic qed NIC Driver
3 * Copyright (c) 2015-2017 QLogic Corporation
4 * Copyright (c) 2019-2020 Marvell International Ltd.
10 #include <linux/types.h>
11 #include <asm/byteorder.h>
12 #include <linux/kernel.h>
13 #include <linux/list.h>
14 #include <linux/slab.h>
15 #include <linux/qed/common_hsi.h>
18 /* Each Page contains a next pointer at its end */
19 QED_CHAIN_MODE_NEXT_PTR,
21 /* Chain is a single page (next ptr) is unrequired */
22 QED_CHAIN_MODE_SINGLE,
24 /* Page pointers are located in a side list */
28 enum qed_chain_use_mode {
29 QED_CHAIN_USE_TO_PRODUCE, /* Chain starts empty */
30 QED_CHAIN_USE_TO_CONSUME, /* Chain starts full */
31 QED_CHAIN_USE_TO_CONSUME_PRODUCE, /* Chain starts empty */
34 enum qed_chain_cnt_type {
35 /* The chain's size/prod/cons are kept in 16-bit variables */
36 QED_CHAIN_CNT_TYPE_U16,
38 /* The chain's size/prod/cons are kept in 32-bit variables */
39 QED_CHAIN_CNT_TYPE_U32,
42 struct qed_chain_next {
43 struct regpair next_phys;
47 struct qed_chain_pbl_u16 {
52 struct qed_chain_pbl_u32 {
57 struct qed_chain_ext_pbl {
58 dma_addr_t p_pbl_phys;
62 struct qed_chain_u16 {
63 /* Cyclic index of next element to produce/consme */
68 struct qed_chain_u32 {
69 /* Cyclic index of next element to produce/consme */
74 struct addr_tbl_entry {
80 /* Fastpath portion of the chain - required for commands such
81 * as produce / consume.
84 /* Point to next element to produce/consume */
88 /* Fastpath portions of the PBL [if exists] */
91 /* Table for keeping the virtual and physical addresses of the
92 * chain pages, respectively to the physical addresses
95 struct addr_tbl_entry *pp_addr_tbl;
98 struct qed_chain_pbl_u16 u16;
99 struct qed_chain_pbl_u32 u32;
104 struct qed_chain_u16 chain16;
105 struct qed_chain_u32 chain32;
108 /* Capacity counts only usable elements */
112 enum qed_chain_mode mode;
114 /* Elements information for fast calculations */
116 u16 elem_per_page_mask;
124 /* Slowpath of the chain - required for initialization and destruction,
125 * but isn't involved in regular functionality.
128 /* Base address of a pre-allocated buffer for pbl */
131 dma_addr_t table_phys;
135 /* Address of first page of the chain - the address is required
136 * for fastpath operation [consume/produce] but only for the SINGLE
137 * flavour which isn't considered fastpath [== SPQ].
140 dma_addr_t p_phys_addr;
142 /* Total number of elements [for entire chain] */
150 #define QED_CHAIN_PAGE_SIZE 0x1000
152 #define ELEMS_PER_PAGE(elem_size) \
153 (QED_CHAIN_PAGE_SIZE / (elem_size))
155 #define UNUSABLE_ELEMS_PER_PAGE(elem_size, mode) \
156 (((mode) == QED_CHAIN_MODE_NEXT_PTR) ? \
157 (u8)(1 + ((sizeof(struct qed_chain_next) - 1) / (elem_size))) : \
160 #define USABLE_ELEMS_PER_PAGE(elem_size, mode) \
161 ((u32)(ELEMS_PER_PAGE(elem_size) - \
162 UNUSABLE_ELEMS_PER_PAGE((elem_size), (mode))))
164 #define QED_CHAIN_PAGE_CNT(elem_cnt, elem_size, mode) \
165 DIV_ROUND_UP((elem_cnt), USABLE_ELEMS_PER_PAGE((elem_size), (mode)))
167 #define is_chain_u16(p) \
168 ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U16)
169 #define is_chain_u32(p) \
170 ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U32)
173 static inline u16 qed_chain_get_prod_idx(struct qed_chain *p_chain)
175 return p_chain->u.chain16.prod_idx;
178 static inline u16 qed_chain_get_cons_idx(struct qed_chain *p_chain)
180 return p_chain->u.chain16.cons_idx;
183 static inline u32 qed_chain_get_cons_idx_u32(struct qed_chain *p_chain)
185 return p_chain->u.chain32.cons_idx;
188 static inline u16 qed_chain_get_elem_left(struct qed_chain *p_chain)
190 u16 elem_per_page = p_chain->elem_per_page;
191 u32 prod = p_chain->u.chain16.prod_idx;
192 u32 cons = p_chain->u.chain16.cons_idx;
196 prod += (u32)U16_MAX + 1;
198 used = (u16)(prod - cons);
199 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
200 used -= prod / elem_per_page - cons / elem_per_page;
202 return (u16)(p_chain->capacity - used);
205 static inline u32 qed_chain_get_elem_left_u32(struct qed_chain *p_chain)
207 u16 elem_per_page = p_chain->elem_per_page;
208 u64 prod = p_chain->u.chain32.prod_idx;
209 u64 cons = p_chain->u.chain32.cons_idx;
213 prod += (u64)U32_MAX + 1;
215 used = (u32)(prod - cons);
216 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
217 used -= (u32)(prod / elem_per_page - cons / elem_per_page);
219 return p_chain->capacity - used;
222 static inline u16 qed_chain_get_usable_per_page(struct qed_chain *p_chain)
224 return p_chain->usable_per_page;
227 static inline u8 qed_chain_get_unusable_per_page(struct qed_chain *p_chain)
229 return p_chain->elem_unusable;
232 static inline u32 qed_chain_get_page_cnt(struct qed_chain *p_chain)
234 return p_chain->page_cnt;
237 static inline dma_addr_t qed_chain_get_pbl_phys(struct qed_chain *p_chain)
239 return p_chain->pbl_sp.table_phys;
243 * @brief qed_chain_advance_page -
245 * Advance the next element accros pages for a linked chain
253 qed_chain_advance_page(struct qed_chain *p_chain,
254 void **p_next_elem, void *idx_to_inc, void *page_to_inc)
256 struct qed_chain_next *p_next = NULL;
259 switch (p_chain->mode) {
260 case QED_CHAIN_MODE_NEXT_PTR:
261 p_next = *p_next_elem;
262 *p_next_elem = p_next->next_virt;
263 if (is_chain_u16(p_chain))
264 *(u16 *)idx_to_inc += p_chain->elem_unusable;
266 *(u32 *)idx_to_inc += p_chain->elem_unusable;
268 case QED_CHAIN_MODE_SINGLE:
269 *p_next_elem = p_chain->p_virt_addr;
272 case QED_CHAIN_MODE_PBL:
273 if (is_chain_u16(p_chain)) {
274 if (++(*(u16 *)page_to_inc) == p_chain->page_cnt)
275 *(u16 *)page_to_inc = 0;
276 page_index = *(u16 *)page_to_inc;
278 if (++(*(u32 *)page_to_inc) == p_chain->page_cnt)
279 *(u32 *)page_to_inc = 0;
280 page_index = *(u32 *)page_to_inc;
282 *p_next_elem = p_chain->pbl.pp_addr_tbl[page_index].virt_addr;
286 #define is_unusable_idx(p, idx) \
287 (((p)->u.chain16.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
289 #define is_unusable_idx_u32(p, idx) \
290 (((p)->u.chain32.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
291 #define is_unusable_next_idx(p, idx) \
292 ((((p)->u.chain16.idx + 1) & (p)->elem_per_page_mask) == \
293 (p)->usable_per_page)
295 #define is_unusable_next_idx_u32(p, idx) \
296 ((((p)->u.chain32.idx + 1) & (p)->elem_per_page_mask) == \
297 (p)->usable_per_page)
299 #define test_and_skip(p, idx) \
301 if (is_chain_u16(p)) { \
302 if (is_unusable_idx(p, idx)) \
303 (p)->u.chain16.idx += (p)->elem_unusable; \
305 if (is_unusable_idx_u32(p, idx)) \
306 (p)->u.chain32.idx += (p)->elem_unusable; \
311 * @brief qed_chain_return_produced -
313 * A chain in which the driver "Produces" elements should use this API
314 * to indicate previous produced elements are now consumed.
318 static inline void qed_chain_return_produced(struct qed_chain *p_chain)
320 if (is_chain_u16(p_chain))
321 p_chain->u.chain16.cons_idx++;
323 p_chain->u.chain32.cons_idx++;
324 test_and_skip(p_chain, cons_idx);
328 * @brief qed_chain_produce -
330 * A chain in which the driver "Produces" elements should use this to get
331 * a pointer to the next element which can be "Produced". It's driver
332 * responsibility to validate that the chain has room for new element.
336 * @return void*, a pointer to next element
338 static inline void *qed_chain_produce(struct qed_chain *p_chain)
340 void *p_ret = NULL, *p_prod_idx, *p_prod_page_idx;
342 if (is_chain_u16(p_chain)) {
343 if ((p_chain->u.chain16.prod_idx &
344 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
345 p_prod_idx = &p_chain->u.chain16.prod_idx;
346 p_prod_page_idx = &p_chain->pbl.c.u16.prod_page_idx;
347 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
348 p_prod_idx, p_prod_page_idx);
350 p_chain->u.chain16.prod_idx++;
352 if ((p_chain->u.chain32.prod_idx &
353 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
354 p_prod_idx = &p_chain->u.chain32.prod_idx;
355 p_prod_page_idx = &p_chain->pbl.c.u32.prod_page_idx;
356 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
357 p_prod_idx, p_prod_page_idx);
359 p_chain->u.chain32.prod_idx++;
362 p_ret = p_chain->p_prod_elem;
363 p_chain->p_prod_elem = (void *)(((u8 *)p_chain->p_prod_elem) +
370 * @brief qed_chain_get_capacity -
372 * Get the maximum number of BDs in chain
377 * @return number of unusable BDs
379 static inline u32 qed_chain_get_capacity(struct qed_chain *p_chain)
381 return p_chain->capacity;
385 * @brief qed_chain_recycle_consumed -
387 * Returns an element which was previously consumed;
388 * Increments producers so they could be written to FW.
392 static inline void qed_chain_recycle_consumed(struct qed_chain *p_chain)
394 test_and_skip(p_chain, prod_idx);
395 if (is_chain_u16(p_chain))
396 p_chain->u.chain16.prod_idx++;
398 p_chain->u.chain32.prod_idx++;
402 * @brief qed_chain_consume -
404 * A Chain in which the driver utilizes data written by a different source
405 * (i.e., FW) should use this to access passed buffers.
409 * @return void*, a pointer to the next buffer written
411 static inline void *qed_chain_consume(struct qed_chain *p_chain)
413 void *p_ret = NULL, *p_cons_idx, *p_cons_page_idx;
415 if (is_chain_u16(p_chain)) {
416 if ((p_chain->u.chain16.cons_idx &
417 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
418 p_cons_idx = &p_chain->u.chain16.cons_idx;
419 p_cons_page_idx = &p_chain->pbl.c.u16.cons_page_idx;
420 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
421 p_cons_idx, p_cons_page_idx);
423 p_chain->u.chain16.cons_idx++;
425 if ((p_chain->u.chain32.cons_idx &
426 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
427 p_cons_idx = &p_chain->u.chain32.cons_idx;
428 p_cons_page_idx = &p_chain->pbl.c.u32.cons_page_idx;
429 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
430 p_cons_idx, p_cons_page_idx);
432 p_chain->u.chain32.cons_idx++;
435 p_ret = p_chain->p_cons_elem;
436 p_chain->p_cons_elem = (void *)(((u8 *)p_chain->p_cons_elem) +
443 * @brief qed_chain_reset - Resets the chain to its start state
445 * @param p_chain pointer to a previously allocted chain
447 static inline void qed_chain_reset(struct qed_chain *p_chain)
451 if (is_chain_u16(p_chain)) {
452 p_chain->u.chain16.prod_idx = 0;
453 p_chain->u.chain16.cons_idx = 0;
455 p_chain->u.chain32.prod_idx = 0;
456 p_chain->u.chain32.cons_idx = 0;
458 p_chain->p_cons_elem = p_chain->p_virt_addr;
459 p_chain->p_prod_elem = p_chain->p_virt_addr;
461 if (p_chain->mode == QED_CHAIN_MODE_PBL) {
462 /* Use (page_cnt - 1) as a reset value for the prod/cons page's
463 * indices, to avoid unnecessary page advancing on the first
464 * call to qed_chain_produce/consume. Instead, the indices
465 * will be advanced to page_cnt and then will be wrapped to 0.
467 u32 reset_val = p_chain->page_cnt - 1;
469 if (is_chain_u16(p_chain)) {
470 p_chain->pbl.c.u16.prod_page_idx = (u16)reset_val;
471 p_chain->pbl.c.u16.cons_page_idx = (u16)reset_val;
473 p_chain->pbl.c.u32.prod_page_idx = reset_val;
474 p_chain->pbl.c.u32.cons_page_idx = reset_val;
478 switch (p_chain->intended_use) {
479 case QED_CHAIN_USE_TO_CONSUME:
480 /* produce empty elements */
481 for (i = 0; i < p_chain->capacity; i++)
482 qed_chain_recycle_consumed(p_chain);
485 case QED_CHAIN_USE_TO_CONSUME_PRODUCE:
486 case QED_CHAIN_USE_TO_PRODUCE:
494 * @brief qed_chain_init - Initalizes a basic chain struct
498 * @param p_phys_addr physical address of allocated buffer's beginning
499 * @param page_cnt number of pages in the allocated buffer
500 * @param elem_size size of each element in the chain
501 * @param intended_use
504 static inline void qed_chain_init_params(struct qed_chain *p_chain,
507 enum qed_chain_use_mode intended_use,
508 enum qed_chain_mode mode,
509 enum qed_chain_cnt_type cnt_type)
511 /* chain fixed parameters */
512 p_chain->p_virt_addr = NULL;
513 p_chain->p_phys_addr = 0;
514 p_chain->elem_size = elem_size;
515 p_chain->intended_use = (u8)intended_use;
516 p_chain->mode = mode;
517 p_chain->cnt_type = (u8)cnt_type;
519 p_chain->elem_per_page = ELEMS_PER_PAGE(elem_size);
520 p_chain->usable_per_page = USABLE_ELEMS_PER_PAGE(elem_size, mode);
521 p_chain->elem_per_page_mask = p_chain->elem_per_page - 1;
522 p_chain->elem_unusable = UNUSABLE_ELEMS_PER_PAGE(elem_size, mode);
523 p_chain->next_page_mask = (p_chain->usable_per_page &
524 p_chain->elem_per_page_mask);
526 p_chain->page_cnt = page_cnt;
527 p_chain->capacity = p_chain->usable_per_page * page_cnt;
528 p_chain->size = p_chain->elem_per_page * page_cnt;
530 p_chain->pbl_sp.table_phys = 0;
531 p_chain->pbl_sp.table_virt = NULL;
532 p_chain->pbl.pp_addr_tbl = NULL;
536 * @brief qed_chain_init_mem -
538 * Initalizes a basic chain struct with its chain buffers
541 * @param p_virt_addr virtual address of allocated buffer's beginning
542 * @param p_phys_addr physical address of allocated buffer's beginning
545 static inline void qed_chain_init_mem(struct qed_chain *p_chain,
546 void *p_virt_addr, dma_addr_t p_phys_addr)
548 p_chain->p_virt_addr = p_virt_addr;
549 p_chain->p_phys_addr = p_phys_addr;
553 * @brief qed_chain_init_pbl_mem -
555 * Initalizes a basic chain struct with its pbl buffers
558 * @param p_virt_pbl pointer to a pre allocated side table which will hold
559 * virtual page addresses.
560 * @param p_phys_pbl pointer to a pre-allocated side table which will hold
561 * physical page addresses.
562 * @param pp_virt_addr_tbl
563 * pointer to a pre-allocated side table which will hold
564 * the virtual addresses of the chain pages.
567 static inline void qed_chain_init_pbl_mem(struct qed_chain *p_chain,
569 dma_addr_t p_phys_pbl,
570 struct addr_tbl_entry *pp_addr_tbl)
572 p_chain->pbl_sp.table_phys = p_phys_pbl;
573 p_chain->pbl_sp.table_virt = p_virt_pbl;
574 p_chain->pbl.pp_addr_tbl = pp_addr_tbl;
578 * @brief qed_chain_init_next_ptr_elem -
580 * Initalizes a next pointer element
583 * @param p_virt_curr virtual address of a chain page of which the next
584 * pointer element is initialized
585 * @param p_virt_next virtual address of the next chain page
586 * @param p_phys_next physical address of the next chain page
590 qed_chain_init_next_ptr_elem(struct qed_chain *p_chain,
592 void *p_virt_next, dma_addr_t p_phys_next)
594 struct qed_chain_next *p_next;
597 size = p_chain->elem_size * p_chain->usable_per_page;
598 p_next = (struct qed_chain_next *)((u8 *)p_virt_curr + size);
600 DMA_REGPAIR_LE(p_next->next_phys, p_phys_next);
602 p_next->next_virt = p_virt_next;
606 * @brief qed_chain_get_last_elem -
608 * Returns a pointer to the last element of the chain
614 static inline void *qed_chain_get_last_elem(struct qed_chain *p_chain)
616 struct qed_chain_next *p_next = NULL;
617 void *p_virt_addr = NULL;
618 u32 size, last_page_idx;
620 if (!p_chain->p_virt_addr)
623 switch (p_chain->mode) {
624 case QED_CHAIN_MODE_NEXT_PTR:
625 size = p_chain->elem_size * p_chain->usable_per_page;
626 p_virt_addr = p_chain->p_virt_addr;
627 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr + size);
628 while (p_next->next_virt != p_chain->p_virt_addr) {
629 p_virt_addr = p_next->next_virt;
630 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr +
634 case QED_CHAIN_MODE_SINGLE:
635 p_virt_addr = p_chain->p_virt_addr;
637 case QED_CHAIN_MODE_PBL:
638 last_page_idx = p_chain->page_cnt - 1;
639 p_virt_addr = p_chain->pbl.pp_addr_tbl[last_page_idx].virt_addr;
642 /* p_virt_addr points at this stage to the last page of the chain */
643 size = p_chain->elem_size * (p_chain->usable_per_page - 1);
644 p_virt_addr = (u8 *)p_virt_addr + size;
650 * @brief qed_chain_set_prod - sets the prod to the given value
655 static inline void qed_chain_set_prod(struct qed_chain *p_chain,
656 u32 prod_idx, void *p_prod_elem)
658 if (p_chain->mode == QED_CHAIN_MODE_PBL) {
659 u32 cur_prod, page_mask, page_cnt, page_diff;
661 cur_prod = is_chain_u16(p_chain) ? p_chain->u.chain16.prod_idx :
662 p_chain->u.chain32.prod_idx;
664 /* Assume that number of elements in a page is power of 2 */
665 page_mask = ~p_chain->elem_per_page_mask;
667 /* Use "cur_prod - 1" and "prod_idx - 1" since producer index
668 * reaches the first element of next page before the page index
669 * is incremented. See qed_chain_produce().
670 * Index wrap around is not a problem because the difference
671 * between current and given producer indices is always
672 * positive and lower than the chain's capacity.
674 page_diff = (((cur_prod - 1) & page_mask) -
675 ((prod_idx - 1) & page_mask)) /
676 p_chain->elem_per_page;
678 page_cnt = qed_chain_get_page_cnt(p_chain);
679 if (is_chain_u16(p_chain))
680 p_chain->pbl.c.u16.prod_page_idx =
681 (p_chain->pbl.c.u16.prod_page_idx -
682 page_diff + page_cnt) % page_cnt;
684 p_chain->pbl.c.u32.prod_page_idx =
685 (p_chain->pbl.c.u32.prod_page_idx -
686 page_diff + page_cnt) % page_cnt;
689 if (is_chain_u16(p_chain))
690 p_chain->u.chain16.prod_idx = (u16) prod_idx;
692 p_chain->u.chain32.prod_idx = prod_idx;
693 p_chain->p_prod_elem = p_prod_elem;
697 * @brief qed_chain_pbl_zero_mem - set chain memory to 0
701 static inline void qed_chain_pbl_zero_mem(struct qed_chain *p_chain)
705 if (p_chain->mode != QED_CHAIN_MODE_PBL)
708 page_cnt = qed_chain_get_page_cnt(p_chain);
710 for (i = 0; i < page_cnt; i++)
711 memset(p_chain->pbl.pp_addr_tbl[i].virt_addr, 0,
712 QED_CHAIN_PAGE_SIZE);