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>
20 /* Each Page contains a next pointer at its end */
21 QED_CHAIN_MODE_NEXT_PTR,
23 /* Chain is a single page (next ptr) is unrequired */
24 QED_CHAIN_MODE_SINGLE,
26 /* Page pointers are located in a side list */
30 enum qed_chain_use_mode {
31 QED_CHAIN_USE_TO_PRODUCE, /* Chain starts empty */
32 QED_CHAIN_USE_TO_CONSUME, /* Chain starts full */
33 QED_CHAIN_USE_TO_CONSUME_PRODUCE, /* Chain starts empty */
36 enum qed_chain_cnt_type {
37 /* The chain's size/prod/cons are kept in 16-bit variables */
38 QED_CHAIN_CNT_TYPE_U16,
40 /* The chain's size/prod/cons are kept in 32-bit variables */
41 QED_CHAIN_CNT_TYPE_U32,
44 struct qed_chain_next {
45 struct regpair next_phys;
49 struct qed_chain_pbl_u16 {
54 struct qed_chain_pbl_u32 {
59 struct qed_chain_pbl {
60 /* Base address of a pre-allocated buffer for pbl */
61 dma_addr_t p_phys_table;
64 /* Table for keeping the virtual addresses of the chain pages,
65 * respectively to the physical addresses in the pbl table.
67 void **pp_virt_addr_tbl;
69 /* Index to current used page by producer/consumer */
71 struct qed_chain_pbl_u16 pbl16;
72 struct qed_chain_pbl_u32 pbl32;
76 struct qed_chain_u16 {
77 /* Cyclic index of next element to produce/consme */
82 struct qed_chain_u32 {
83 /* Cyclic index of next element to produce/consme */
90 dma_addr_t p_phys_addr;
94 enum qed_chain_mode mode;
95 enum qed_chain_use_mode intended_use; /* used to produce/consume */
96 enum qed_chain_cnt_type cnt_type;
99 struct qed_chain_u16 chain16;
100 struct qed_chain_u32 chain32;
105 /* Number of elements - capacity is for usable elements only,
106 * while size will contain total number of elements [for entire chain].
111 /* Elements information for fast calculations */
113 u16 elem_per_page_mask;
118 struct qed_chain_pbl pbl;
121 #define QED_CHAIN_PBL_ENTRY_SIZE (8)
122 #define QED_CHAIN_PAGE_SIZE (0x1000)
123 #define ELEMS_PER_PAGE(elem_size) (QED_CHAIN_PAGE_SIZE / (elem_size))
125 #define UNUSABLE_ELEMS_PER_PAGE(elem_size, mode) \
126 ((mode == QED_CHAIN_MODE_NEXT_PTR) ? \
127 (1 + ((sizeof(struct qed_chain_next) - 1) / \
130 #define USABLE_ELEMS_PER_PAGE(elem_size, mode) \
131 ((u32)(ELEMS_PER_PAGE(elem_size) - \
132 UNUSABLE_ELEMS_PER_PAGE(elem_size, mode)))
134 #define QED_CHAIN_PAGE_CNT(elem_cnt, elem_size, mode) \
135 DIV_ROUND_UP(elem_cnt, USABLE_ELEMS_PER_PAGE(elem_size, mode))
137 #define is_chain_u16(p) ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U16)
138 #define is_chain_u32(p) ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U32)
141 static inline u16 qed_chain_get_prod_idx(struct qed_chain *p_chain)
143 return p_chain->u.chain16.prod_idx;
146 static inline u16 qed_chain_get_cons_idx(struct qed_chain *p_chain)
148 return p_chain->u.chain16.cons_idx;
151 static inline u32 qed_chain_get_cons_idx_u32(struct qed_chain *p_chain)
153 return p_chain->u.chain32.cons_idx;
156 static inline u16 qed_chain_get_elem_left(struct qed_chain *p_chain)
158 u16 elem_per_page = p_chain->elem_per_page;
159 u32 prod = p_chain->u.chain16.prod_idx;
160 u32 cons = p_chain->u.chain16.cons_idx;
164 prod += (u32)U16_MAX + 1;
166 used = (u16)(prod - cons);
167 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
168 used -= prod / elem_per_page - cons / elem_per_page;
170 return (u16)(p_chain->capacity - used);
173 static inline u32 qed_chain_get_elem_left_u32(struct qed_chain *p_chain)
175 u16 elem_per_page = p_chain->elem_per_page;
176 u64 prod = p_chain->u.chain32.prod_idx;
177 u64 cons = p_chain->u.chain32.cons_idx;
181 prod += (u64)U32_MAX + 1;
183 used = (u32)(prod - cons);
184 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
185 used -= (u32)(prod / elem_per_page - cons / elem_per_page);
187 return p_chain->capacity - used;
190 static inline u16 qed_chain_get_usable_per_page(struct qed_chain *p_chain)
192 return p_chain->usable_per_page;
195 static inline u16 qed_chain_get_unusable_per_page(struct qed_chain *p_chain)
197 return p_chain->elem_unusable;
200 static inline u32 qed_chain_get_page_cnt(struct qed_chain *p_chain)
202 return p_chain->page_cnt;
205 static inline dma_addr_t qed_chain_get_pbl_phys(struct qed_chain *p_chain)
207 return p_chain->pbl.p_phys_table;
211 * @brief qed_chain_advance_page -
213 * Advance the next element accros pages for a linked chain
221 qed_chain_advance_page(struct qed_chain *p_chain,
222 void **p_next_elem, void *idx_to_inc, void *page_to_inc)
225 struct qed_chain_next *p_next = NULL;
227 switch (p_chain->mode) {
228 case QED_CHAIN_MODE_NEXT_PTR:
229 p_next = *p_next_elem;
230 *p_next_elem = p_next->next_virt;
231 if (is_chain_u16(p_chain))
232 *(u16 *)idx_to_inc += p_chain->elem_unusable;
234 *(u32 *)idx_to_inc += p_chain->elem_unusable;
236 case QED_CHAIN_MODE_SINGLE:
237 *p_next_elem = p_chain->p_virt_addr;
240 case QED_CHAIN_MODE_PBL:
241 if (is_chain_u16(p_chain)) {
242 if (++(*(u16 *)page_to_inc) == p_chain->page_cnt)
243 *(u16 *)page_to_inc = 0;
244 page_index = *(u16 *)page_to_inc;
246 if (++(*(u32 *)page_to_inc) == p_chain->page_cnt)
247 *(u32 *)page_to_inc = 0;
248 page_index = *(u32 *)page_to_inc;
250 *p_next_elem = p_chain->pbl.pp_virt_addr_tbl[page_index];
254 #define is_unusable_idx(p, idx) \
255 (((p)->u.chain16.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
257 #define is_unusable_idx_u32(p, idx) \
258 (((p)->u.chain32.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
259 #define is_unusable_next_idx(p, idx) \
260 ((((p)->u.chain16.idx + 1) & (p)->elem_per_page_mask) == \
261 (p)->usable_per_page)
263 #define is_unusable_next_idx_u32(p, idx) \
264 ((((p)->u.chain32.idx + 1) & (p)->elem_per_page_mask) == \
265 (p)->usable_per_page)
267 #define test_and_skip(p, idx) \
269 if (is_chain_u16(p)) { \
270 if (is_unusable_idx(p, idx)) \
271 (p)->u.chain16.idx += (p)->elem_unusable; \
273 if (is_unusable_idx_u32(p, idx)) \
274 (p)->u.chain32.idx += (p)->elem_unusable; \
279 * @brief qed_chain_return_produced -
281 * A chain in which the driver "Produces" elements should use this API
282 * to indicate previous produced elements are now consumed.
286 static inline void qed_chain_return_produced(struct qed_chain *p_chain)
288 if (is_chain_u16(p_chain))
289 p_chain->u.chain16.cons_idx++;
291 p_chain->u.chain32.cons_idx++;
292 test_and_skip(p_chain, cons_idx);
296 * @brief qed_chain_produce -
298 * A chain in which the driver "Produces" elements should use this to get
299 * a pointer to the next element which can be "Produced". It's driver
300 * responsibility to validate that the chain has room for new element.
304 * @return void*, a pointer to next element
306 static inline void *qed_chain_produce(struct qed_chain *p_chain)
308 void *p_ret = NULL, *p_prod_idx, *p_prod_page_idx;
310 if (is_chain_u16(p_chain)) {
311 if ((p_chain->u.chain16.prod_idx &
312 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
313 p_prod_idx = &p_chain->u.chain16.prod_idx;
314 p_prod_page_idx = &p_chain->pbl.u.pbl16.prod_page_idx;
315 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
316 p_prod_idx, p_prod_page_idx);
318 p_chain->u.chain16.prod_idx++;
320 if ((p_chain->u.chain32.prod_idx &
321 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
322 p_prod_idx = &p_chain->u.chain32.prod_idx;
323 p_prod_page_idx = &p_chain->pbl.u.pbl32.prod_page_idx;
324 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
325 p_prod_idx, p_prod_page_idx);
327 p_chain->u.chain32.prod_idx++;
330 p_ret = p_chain->p_prod_elem;
331 p_chain->p_prod_elem = (void *)(((u8 *)p_chain->p_prod_elem) +
338 * @brief qed_chain_get_capacity -
340 * Get the maximum number of BDs in chain
345 * @return number of unusable BDs
347 static inline u32 qed_chain_get_capacity(struct qed_chain *p_chain)
349 return p_chain->capacity;
353 * @brief qed_chain_recycle_consumed -
355 * Returns an element which was previously consumed;
356 * Increments producers so they could be written to FW.
360 static inline void qed_chain_recycle_consumed(struct qed_chain *p_chain)
362 test_and_skip(p_chain, prod_idx);
363 if (is_chain_u16(p_chain))
364 p_chain->u.chain16.prod_idx++;
366 p_chain->u.chain32.prod_idx++;
370 * @brief qed_chain_consume -
372 * A Chain in which the driver utilizes data written by a different source
373 * (i.e., FW) should use this to access passed buffers.
377 * @return void*, a pointer to the next buffer written
379 static inline void *qed_chain_consume(struct qed_chain *p_chain)
381 void *p_ret = NULL, *p_cons_idx, *p_cons_page_idx;
383 if (is_chain_u16(p_chain)) {
384 if ((p_chain->u.chain16.cons_idx &
385 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
386 p_cons_idx = &p_chain->u.chain16.cons_idx;
387 p_cons_page_idx = &p_chain->pbl.u.pbl16.cons_page_idx;
388 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
389 p_cons_idx, p_cons_page_idx);
391 p_chain->u.chain16.cons_idx++;
393 if ((p_chain->u.chain32.cons_idx &
394 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
395 p_cons_idx = &p_chain->u.chain32.cons_idx;
396 p_cons_page_idx = &p_chain->pbl.u.pbl32.cons_page_idx;
397 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
398 p_cons_idx, p_cons_page_idx);
400 p_chain->u.chain32.cons_idx++;
403 p_ret = p_chain->p_cons_elem;
404 p_chain->p_cons_elem = (void *)(((u8 *)p_chain->p_cons_elem) +
411 * @brief qed_chain_reset - Resets the chain to its start state
413 * @param p_chain pointer to a previously allocted chain
415 static inline void qed_chain_reset(struct qed_chain *p_chain)
419 if (is_chain_u16(p_chain)) {
420 p_chain->u.chain16.prod_idx = 0;
421 p_chain->u.chain16.cons_idx = 0;
423 p_chain->u.chain32.prod_idx = 0;
424 p_chain->u.chain32.cons_idx = 0;
426 p_chain->p_cons_elem = p_chain->p_virt_addr;
427 p_chain->p_prod_elem = p_chain->p_virt_addr;
429 if (p_chain->mode == QED_CHAIN_MODE_PBL) {
430 /* Use (page_cnt - 1) as a reset value for the prod/cons page's
431 * indices, to avoid unnecessary page advancing on the first
432 * call to qed_chain_produce/consume. Instead, the indices
433 * will be advanced to page_cnt and then will be wrapped to 0.
435 u32 reset_val = p_chain->page_cnt - 1;
437 if (is_chain_u16(p_chain)) {
438 p_chain->pbl.u.pbl16.prod_page_idx = (u16)reset_val;
439 p_chain->pbl.u.pbl16.cons_page_idx = (u16)reset_val;
441 p_chain->pbl.u.pbl32.prod_page_idx = reset_val;
442 p_chain->pbl.u.pbl32.cons_page_idx = reset_val;
446 switch (p_chain->intended_use) {
447 case QED_CHAIN_USE_TO_CONSUME_PRODUCE:
448 case QED_CHAIN_USE_TO_PRODUCE:
452 case QED_CHAIN_USE_TO_CONSUME:
453 /* produce empty elements */
454 for (i = 0; i < p_chain->capacity; i++)
455 qed_chain_recycle_consumed(p_chain);
461 * @brief qed_chain_init - Initalizes a basic chain struct
465 * @param p_phys_addr physical address of allocated buffer's beginning
466 * @param page_cnt number of pages in the allocated buffer
467 * @param elem_size size of each element in the chain
468 * @param intended_use
471 static inline void qed_chain_init_params(struct qed_chain *p_chain,
474 enum qed_chain_use_mode intended_use,
475 enum qed_chain_mode mode,
476 enum qed_chain_cnt_type cnt_type)
478 /* chain fixed parameters */
479 p_chain->p_virt_addr = NULL;
480 p_chain->p_phys_addr = 0;
481 p_chain->elem_size = elem_size;
482 p_chain->intended_use = intended_use;
483 p_chain->mode = mode;
484 p_chain->cnt_type = cnt_type;
486 p_chain->elem_per_page = ELEMS_PER_PAGE(elem_size);
487 p_chain->usable_per_page = USABLE_ELEMS_PER_PAGE(elem_size, mode);
488 p_chain->elem_per_page_mask = p_chain->elem_per_page - 1;
489 p_chain->elem_unusable = UNUSABLE_ELEMS_PER_PAGE(elem_size, mode);
490 p_chain->next_page_mask = (p_chain->usable_per_page &
491 p_chain->elem_per_page_mask);
493 p_chain->page_cnt = page_cnt;
494 p_chain->capacity = p_chain->usable_per_page * page_cnt;
495 p_chain->size = p_chain->elem_per_page * page_cnt;
497 p_chain->pbl.p_phys_table = 0;
498 p_chain->pbl.p_virt_table = NULL;
499 p_chain->pbl.pp_virt_addr_tbl = NULL;
503 * @brief qed_chain_init_mem -
505 * Initalizes a basic chain struct with its chain buffers
508 * @param p_virt_addr virtual address of allocated buffer's beginning
509 * @param p_phys_addr physical address of allocated buffer's beginning
512 static inline void qed_chain_init_mem(struct qed_chain *p_chain,
513 void *p_virt_addr, dma_addr_t p_phys_addr)
515 p_chain->p_virt_addr = p_virt_addr;
516 p_chain->p_phys_addr = p_phys_addr;
520 * @brief qed_chain_init_pbl_mem -
522 * Initalizes a basic chain struct with its pbl buffers
525 * @param p_virt_pbl pointer to a pre allocated side table which will hold
526 * virtual page addresses.
527 * @param p_phys_pbl pointer to a pre-allocated side table which will hold
528 * physical page addresses.
529 * @param pp_virt_addr_tbl
530 * pointer to a pre-allocated side table which will hold
531 * the virtual addresses of the chain pages.
534 static inline void qed_chain_init_pbl_mem(struct qed_chain *p_chain,
536 dma_addr_t p_phys_pbl,
537 void **pp_virt_addr_tbl)
539 p_chain->pbl.p_phys_table = p_phys_pbl;
540 p_chain->pbl.p_virt_table = p_virt_pbl;
541 p_chain->pbl.pp_virt_addr_tbl = pp_virt_addr_tbl;
545 * @brief qed_chain_init_next_ptr_elem -
547 * Initalizes a next pointer element
550 * @param p_virt_curr virtual address of a chain page of which the next
551 * pointer element is initialized
552 * @param p_virt_next virtual address of the next chain page
553 * @param p_phys_next physical address of the next chain page
557 qed_chain_init_next_ptr_elem(struct qed_chain *p_chain,
559 void *p_virt_next, dma_addr_t p_phys_next)
561 struct qed_chain_next *p_next;
564 size = p_chain->elem_size * p_chain->usable_per_page;
565 p_next = (struct qed_chain_next *)((u8 *)p_virt_curr + size);
567 DMA_REGPAIR_LE(p_next->next_phys, p_phys_next);
569 p_next->next_virt = p_virt_next;
573 * @brief qed_chain_get_last_elem -
575 * Returns a pointer to the last element of the chain
581 static inline void *qed_chain_get_last_elem(struct qed_chain *p_chain)
583 struct qed_chain_next *p_next = NULL;
584 void *p_virt_addr = NULL;
585 u32 size, last_page_idx;
587 if (!p_chain->p_virt_addr)
590 switch (p_chain->mode) {
591 case QED_CHAIN_MODE_NEXT_PTR:
592 size = p_chain->elem_size * p_chain->usable_per_page;
593 p_virt_addr = p_chain->p_virt_addr;
594 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr + size);
595 while (p_next->next_virt != p_chain->p_virt_addr) {
596 p_virt_addr = p_next->next_virt;
597 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr +
601 case QED_CHAIN_MODE_SINGLE:
602 p_virt_addr = p_chain->p_virt_addr;
604 case QED_CHAIN_MODE_PBL:
605 last_page_idx = p_chain->page_cnt - 1;
606 p_virt_addr = p_chain->pbl.pp_virt_addr_tbl[last_page_idx];
609 /* p_virt_addr points at this stage to the last page of the chain */
610 size = p_chain->elem_size * (p_chain->usable_per_page - 1);
611 p_virt_addr = (u8 *)p_virt_addr + size;
617 * @brief qed_chain_set_prod - sets the prod to the given value
622 static inline void qed_chain_set_prod(struct qed_chain *p_chain,
623 u32 prod_idx, void *p_prod_elem)
625 if (is_chain_u16(p_chain))
626 p_chain->u.chain16.prod_idx = (u16) prod_idx;
628 p_chain->u.chain32.prod_idx = prod_idx;
629 p_chain->p_prod_elem = p_prod_elem;
633 * @brief qed_chain_pbl_zero_mem - set chain memory to 0
637 static inline void qed_chain_pbl_zero_mem(struct qed_chain *p_chain)
641 if (p_chain->mode != QED_CHAIN_MODE_PBL)
644 page_cnt = qed_chain_get_page_cnt(p_chain);
646 for (i = 0; i < page_cnt; i++)
647 memset(p_chain->pbl.pp_virt_addr_tbl[i], 0,
648 QED_CHAIN_PAGE_SIZE);