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_DMA(hi, lo) HILO_GEN(hi, lo, dma_addr_t)
29 #define HILO_64(hi, lo) HILO_GEN((le32_to_cpu(hi)), (le32_to_cpu(lo)), u64)
30 #define HILO_DMA_REGPAIR(regpair) (HILO_DMA(regpair.hi, regpair.lo))
31 #define HILO_64_REGPAIR(regpair) (HILO_64(regpair.hi, regpair.lo))
34 /* Each Page contains a next pointer at its end */
35 QED_CHAIN_MODE_NEXT_PTR,
37 /* Chain is a single page (next ptr) is unrequired */
38 QED_CHAIN_MODE_SINGLE,
40 /* Page pointers are located in a side list */
44 enum qed_chain_use_mode {
45 QED_CHAIN_USE_TO_PRODUCE, /* Chain starts empty */
46 QED_CHAIN_USE_TO_CONSUME, /* Chain starts full */
47 QED_CHAIN_USE_TO_CONSUME_PRODUCE, /* Chain starts empty */
50 enum qed_chain_cnt_type {
51 /* The chain's size/prod/cons are kept in 16-bit variables */
52 QED_CHAIN_CNT_TYPE_U16,
54 /* The chain's size/prod/cons are kept in 32-bit variables */
55 QED_CHAIN_CNT_TYPE_U32,
58 struct qed_chain_next {
59 struct regpair next_phys;
63 struct qed_chain_pbl_u16 {
68 struct qed_chain_pbl_u32 {
73 struct qed_chain_pbl {
74 /* Base address of a pre-allocated buffer for pbl */
75 dma_addr_t p_phys_table;
78 /* Table for keeping the virtual addresses of the chain pages,
79 * respectively to the physical addresses in the pbl table.
81 void **pp_virt_addr_tbl;
83 /* Index to current used page by producer/consumer */
85 struct qed_chain_pbl_u16 pbl16;
86 struct qed_chain_pbl_u32 pbl32;
90 struct qed_chain_u16 {
91 /* Cyclic index of next element to produce/consme */
96 struct qed_chain_u32 {
97 /* Cyclic index of next element to produce/consme */
104 dma_addr_t p_phys_addr;
108 enum qed_chain_mode mode;
109 enum qed_chain_use_mode intended_use; /* used to produce/consume */
110 enum qed_chain_cnt_type cnt_type;
113 struct qed_chain_u16 chain16;
114 struct qed_chain_u32 chain32;
119 /* Number of elements - capacity is for usable elements only,
120 * while size will contain total number of elements [for entire chain].
125 /* Elements information for fast calculations */
127 u16 elem_per_page_mask;
132 struct qed_chain_pbl pbl;
135 #define QED_CHAIN_PBL_ENTRY_SIZE (8)
136 #define QED_CHAIN_PAGE_SIZE (0x1000)
137 #define ELEMS_PER_PAGE(elem_size) (QED_CHAIN_PAGE_SIZE / (elem_size))
139 #define UNUSABLE_ELEMS_PER_PAGE(elem_size, mode) \
140 ((mode == QED_CHAIN_MODE_NEXT_PTR) ? \
141 (1 + ((sizeof(struct qed_chain_next) - 1) / \
144 #define USABLE_ELEMS_PER_PAGE(elem_size, mode) \
145 ((u32)(ELEMS_PER_PAGE(elem_size) - \
146 UNUSABLE_ELEMS_PER_PAGE(elem_size, mode)))
148 #define QED_CHAIN_PAGE_CNT(elem_cnt, elem_size, mode) \
149 DIV_ROUND_UP(elem_cnt, USABLE_ELEMS_PER_PAGE(elem_size, mode))
151 #define is_chain_u16(p) ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U16)
152 #define is_chain_u32(p) ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U32)
155 static inline u16 qed_chain_get_prod_idx(struct qed_chain *p_chain)
157 return p_chain->u.chain16.prod_idx;
160 static inline u16 qed_chain_get_cons_idx(struct qed_chain *p_chain)
162 return p_chain->u.chain16.cons_idx;
165 static inline u32 qed_chain_get_cons_idx_u32(struct qed_chain *p_chain)
167 return p_chain->u.chain32.cons_idx;
170 static inline u16 qed_chain_get_elem_left(struct qed_chain *p_chain)
174 used = (u16) (((u32)0x10000 +
175 (u32)p_chain->u.chain16.prod_idx) -
176 (u32)p_chain->u.chain16.cons_idx);
177 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
178 used -= p_chain->u.chain16.prod_idx / p_chain->elem_per_page -
179 p_chain->u.chain16.cons_idx / p_chain->elem_per_page;
181 return (u16)(p_chain->capacity - used);
184 static inline u32 qed_chain_get_elem_left_u32(struct qed_chain *p_chain)
188 used = (u32) (((u64)0x100000000ULL +
189 (u64)p_chain->u.chain32.prod_idx) -
190 (u64)p_chain->u.chain32.cons_idx);
191 if (p_chain->mode == QED_CHAIN_MODE_NEXT_PTR)
192 used -= p_chain->u.chain32.prod_idx / p_chain->elem_per_page -
193 p_chain->u.chain32.cons_idx / p_chain->elem_per_page;
195 return p_chain->capacity - used;
198 static inline u16 qed_chain_get_usable_per_page(struct qed_chain *p_chain)
200 return p_chain->usable_per_page;
203 static inline u16 qed_chain_get_unusable_per_page(struct qed_chain *p_chain)
205 return p_chain->elem_unusable;
208 static inline u32 qed_chain_get_page_cnt(struct qed_chain *p_chain)
210 return p_chain->page_cnt;
213 static inline dma_addr_t qed_chain_get_pbl_phys(struct qed_chain *p_chain)
215 return p_chain->pbl.p_phys_table;
219 * @brief qed_chain_advance_page -
221 * Advance the next element accros pages for a linked chain
229 qed_chain_advance_page(struct qed_chain *p_chain,
230 void **p_next_elem, void *idx_to_inc, void *page_to_inc)
233 struct qed_chain_next *p_next = NULL;
235 switch (p_chain->mode) {
236 case QED_CHAIN_MODE_NEXT_PTR:
237 p_next = *p_next_elem;
238 *p_next_elem = p_next->next_virt;
239 if (is_chain_u16(p_chain))
240 *(u16 *)idx_to_inc += p_chain->elem_unusable;
242 *(u32 *)idx_to_inc += p_chain->elem_unusable;
244 case QED_CHAIN_MODE_SINGLE:
245 *p_next_elem = p_chain->p_virt_addr;
248 case QED_CHAIN_MODE_PBL:
249 if (is_chain_u16(p_chain)) {
250 if (++(*(u16 *)page_to_inc) == p_chain->page_cnt)
251 *(u16 *)page_to_inc = 0;
252 page_index = *(u16 *)page_to_inc;
254 if (++(*(u32 *)page_to_inc) == p_chain->page_cnt)
255 *(u32 *)page_to_inc = 0;
256 page_index = *(u32 *)page_to_inc;
258 *p_next_elem = p_chain->pbl.pp_virt_addr_tbl[page_index];
262 #define is_unusable_idx(p, idx) \
263 (((p)->u.chain16.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
265 #define is_unusable_idx_u32(p, idx) \
266 (((p)->u.chain32.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
267 #define is_unusable_next_idx(p, idx) \
268 ((((p)->u.chain16.idx + 1) & (p)->elem_per_page_mask) == \
269 (p)->usable_per_page)
271 #define is_unusable_next_idx_u32(p, idx) \
272 ((((p)->u.chain32.idx + 1) & (p)->elem_per_page_mask) == \
273 (p)->usable_per_page)
275 #define test_and_skip(p, idx) \
277 if (is_chain_u16(p)) { \
278 if (is_unusable_idx(p, idx)) \
279 (p)->u.chain16.idx += (p)->elem_unusable; \
281 if (is_unusable_idx_u32(p, idx)) \
282 (p)->u.chain32.idx += (p)->elem_unusable; \
287 * @brief qed_chain_return_produced -
289 * A chain in which the driver "Produces" elements should use this API
290 * to indicate previous produced elements are now consumed.
294 static inline void qed_chain_return_produced(struct qed_chain *p_chain)
296 if (is_chain_u16(p_chain))
297 p_chain->u.chain16.cons_idx++;
299 p_chain->u.chain32.cons_idx++;
300 test_and_skip(p_chain, cons_idx);
304 * @brief qed_chain_produce -
306 * A chain in which the driver "Produces" elements should use this to get
307 * a pointer to the next element which can be "Produced". It's driver
308 * responsibility to validate that the chain has room for new element.
312 * @return void*, a pointer to next element
314 static inline void *qed_chain_produce(struct qed_chain *p_chain)
316 void *p_ret = NULL, *p_prod_idx, *p_prod_page_idx;
318 if (is_chain_u16(p_chain)) {
319 if ((p_chain->u.chain16.prod_idx &
320 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
321 p_prod_idx = &p_chain->u.chain16.prod_idx;
322 p_prod_page_idx = &p_chain->pbl.u.pbl16.prod_page_idx;
323 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
324 p_prod_idx, p_prod_page_idx);
326 p_chain->u.chain16.prod_idx++;
328 if ((p_chain->u.chain32.prod_idx &
329 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
330 p_prod_idx = &p_chain->u.chain32.prod_idx;
331 p_prod_page_idx = &p_chain->pbl.u.pbl32.prod_page_idx;
332 qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
333 p_prod_idx, p_prod_page_idx);
335 p_chain->u.chain32.prod_idx++;
338 p_ret = p_chain->p_prod_elem;
339 p_chain->p_prod_elem = (void *)(((u8 *)p_chain->p_prod_elem) +
346 * @brief qed_chain_get_capacity -
348 * Get the maximum number of BDs in chain
353 * @return number of unusable BDs
355 static inline u32 qed_chain_get_capacity(struct qed_chain *p_chain)
357 return p_chain->capacity;
361 * @brief qed_chain_recycle_consumed -
363 * Returns an element which was previously consumed;
364 * Increments producers so they could be written to FW.
368 static inline void qed_chain_recycle_consumed(struct qed_chain *p_chain)
370 test_and_skip(p_chain, prod_idx);
371 if (is_chain_u16(p_chain))
372 p_chain->u.chain16.prod_idx++;
374 p_chain->u.chain32.prod_idx++;
378 * @brief qed_chain_consume -
380 * A Chain in which the driver utilizes data written by a different source
381 * (i.e., FW) should use this to access passed buffers.
385 * @return void*, a pointer to the next buffer written
387 static inline void *qed_chain_consume(struct qed_chain *p_chain)
389 void *p_ret = NULL, *p_cons_idx, *p_cons_page_idx;
391 if (is_chain_u16(p_chain)) {
392 if ((p_chain->u.chain16.cons_idx &
393 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
394 p_cons_idx = &p_chain->u.chain16.cons_idx;
395 p_cons_page_idx = &p_chain->pbl.u.pbl16.cons_page_idx;
396 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
397 p_cons_idx, p_cons_page_idx);
399 p_chain->u.chain16.cons_idx++;
401 if ((p_chain->u.chain32.cons_idx &
402 p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
403 p_cons_idx = &p_chain->u.chain32.cons_idx;
404 p_cons_page_idx = &p_chain->pbl.u.pbl32.cons_page_idx;
405 qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
406 p_cons_idx, p_cons_page_idx);
408 p_chain->u.chain32.cons_idx++;
411 p_ret = p_chain->p_cons_elem;
412 p_chain->p_cons_elem = (void *)(((u8 *)p_chain->p_cons_elem) +
419 * @brief qed_chain_reset - Resets the chain to its start state
421 * @param p_chain pointer to a previously allocted chain
423 static inline void qed_chain_reset(struct qed_chain *p_chain)
427 if (is_chain_u16(p_chain)) {
428 p_chain->u.chain16.prod_idx = 0;
429 p_chain->u.chain16.cons_idx = 0;
431 p_chain->u.chain32.prod_idx = 0;
432 p_chain->u.chain32.cons_idx = 0;
434 p_chain->p_cons_elem = p_chain->p_virt_addr;
435 p_chain->p_prod_elem = p_chain->p_virt_addr;
437 if (p_chain->mode == QED_CHAIN_MODE_PBL) {
438 /* Use (page_cnt - 1) as a reset value for the prod/cons page's
439 * indices, to avoid unnecessary page advancing on the first
440 * call to qed_chain_produce/consume. Instead, the indices
441 * will be advanced to page_cnt and then will be wrapped to 0.
443 u32 reset_val = p_chain->page_cnt - 1;
445 if (is_chain_u16(p_chain)) {
446 p_chain->pbl.u.pbl16.prod_page_idx = (u16)reset_val;
447 p_chain->pbl.u.pbl16.cons_page_idx = (u16)reset_val;
449 p_chain->pbl.u.pbl32.prod_page_idx = reset_val;
450 p_chain->pbl.u.pbl32.cons_page_idx = reset_val;
454 switch (p_chain->intended_use) {
455 case QED_CHAIN_USE_TO_CONSUME_PRODUCE:
456 case QED_CHAIN_USE_TO_PRODUCE:
460 case QED_CHAIN_USE_TO_CONSUME:
461 /* produce empty elements */
462 for (i = 0; i < p_chain->capacity; i++)
463 qed_chain_recycle_consumed(p_chain);
469 * @brief qed_chain_init - Initalizes a basic chain struct
473 * @param p_phys_addr physical address of allocated buffer's beginning
474 * @param page_cnt number of pages in the allocated buffer
475 * @param elem_size size of each element in the chain
476 * @param intended_use
479 static inline void qed_chain_init_params(struct qed_chain *p_chain,
482 enum qed_chain_use_mode intended_use,
483 enum qed_chain_mode mode,
484 enum qed_chain_cnt_type cnt_type)
486 /* chain fixed parameters */
487 p_chain->p_virt_addr = NULL;
488 p_chain->p_phys_addr = 0;
489 p_chain->elem_size = elem_size;
490 p_chain->intended_use = intended_use;
491 p_chain->mode = mode;
492 p_chain->cnt_type = cnt_type;
494 p_chain->elem_per_page = ELEMS_PER_PAGE(elem_size);
495 p_chain->usable_per_page = USABLE_ELEMS_PER_PAGE(elem_size, mode);
496 p_chain->elem_per_page_mask = p_chain->elem_per_page - 1;
497 p_chain->elem_unusable = UNUSABLE_ELEMS_PER_PAGE(elem_size, mode);
498 p_chain->next_page_mask = (p_chain->usable_per_page &
499 p_chain->elem_per_page_mask);
501 p_chain->page_cnt = page_cnt;
502 p_chain->capacity = p_chain->usable_per_page * page_cnt;
503 p_chain->size = p_chain->elem_per_page * page_cnt;
505 p_chain->pbl.p_phys_table = 0;
506 p_chain->pbl.p_virt_table = NULL;
507 p_chain->pbl.pp_virt_addr_tbl = NULL;
511 * @brief qed_chain_init_mem -
513 * Initalizes a basic chain struct with its chain buffers
516 * @param p_virt_addr virtual address of allocated buffer's beginning
517 * @param p_phys_addr physical address of allocated buffer's beginning
520 static inline void qed_chain_init_mem(struct qed_chain *p_chain,
521 void *p_virt_addr, dma_addr_t p_phys_addr)
523 p_chain->p_virt_addr = p_virt_addr;
524 p_chain->p_phys_addr = p_phys_addr;
528 * @brief qed_chain_init_pbl_mem -
530 * Initalizes a basic chain struct with its pbl buffers
533 * @param p_virt_pbl pointer to a pre allocated side table which will hold
534 * virtual page addresses.
535 * @param p_phys_pbl pointer to a pre-allocated side table which will hold
536 * physical page addresses.
537 * @param pp_virt_addr_tbl
538 * pointer to a pre-allocated side table which will hold
539 * the virtual addresses of the chain pages.
542 static inline void qed_chain_init_pbl_mem(struct qed_chain *p_chain,
544 dma_addr_t p_phys_pbl,
545 void **pp_virt_addr_tbl)
547 p_chain->pbl.p_phys_table = p_phys_pbl;
548 p_chain->pbl.p_virt_table = p_virt_pbl;
549 p_chain->pbl.pp_virt_addr_tbl = pp_virt_addr_tbl;
553 * @brief qed_chain_init_next_ptr_elem -
555 * Initalizes a next pointer element
558 * @param p_virt_curr virtual address of a chain page of which the next
559 * pointer element is initialized
560 * @param p_virt_next virtual address of the next chain page
561 * @param p_phys_next physical address of the next chain page
565 qed_chain_init_next_ptr_elem(struct qed_chain *p_chain,
567 void *p_virt_next, dma_addr_t p_phys_next)
569 struct qed_chain_next *p_next;
572 size = p_chain->elem_size * p_chain->usable_per_page;
573 p_next = (struct qed_chain_next *)((u8 *)p_virt_curr + size);
575 DMA_REGPAIR_LE(p_next->next_phys, p_phys_next);
577 p_next->next_virt = p_virt_next;
581 * @brief qed_chain_get_last_elem -
583 * Returns a pointer to the last element of the chain
589 static inline void *qed_chain_get_last_elem(struct qed_chain *p_chain)
591 struct qed_chain_next *p_next = NULL;
592 void *p_virt_addr = NULL;
593 u32 size, last_page_idx;
595 if (!p_chain->p_virt_addr)
598 switch (p_chain->mode) {
599 case QED_CHAIN_MODE_NEXT_PTR:
600 size = p_chain->elem_size * p_chain->usable_per_page;
601 p_virt_addr = p_chain->p_virt_addr;
602 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr + size);
603 while (p_next->next_virt != p_chain->p_virt_addr) {
604 p_virt_addr = p_next->next_virt;
605 p_next = (struct qed_chain_next *)((u8 *)p_virt_addr +
609 case QED_CHAIN_MODE_SINGLE:
610 p_virt_addr = p_chain->p_virt_addr;
612 case QED_CHAIN_MODE_PBL:
613 last_page_idx = p_chain->page_cnt - 1;
614 p_virt_addr = p_chain->pbl.pp_virt_addr_tbl[last_page_idx];
617 /* p_virt_addr points at this stage to the last page of the chain */
618 size = p_chain->elem_size * (p_chain->usable_per_page - 1);
619 p_virt_addr = (u8 *)p_virt_addr + size;
625 * @brief qed_chain_set_prod - sets the prod to the given value
630 static inline void qed_chain_set_prod(struct qed_chain *p_chain,
631 u32 prod_idx, void *p_prod_elem)
633 if (is_chain_u16(p_chain))
634 p_chain->u.chain16.prod_idx = (u16) prod_idx;
636 p_chain->u.chain32.prod_idx = prod_idx;
637 p_chain->p_prod_elem = p_prod_elem;
641 * @brief qed_chain_pbl_zero_mem - set chain memory to 0
645 static inline void qed_chain_pbl_zero_mem(struct qed_chain *p_chain)
649 if (p_chain->mode != QED_CHAIN_MODE_PBL)
652 page_cnt = qed_chain_get_page_cnt(p_chain);
654 for (i = 0; i < page_cnt; i++)
655 memset(p_chain->pbl.pp_virt_addr_tbl[i], 0,
656 QED_CHAIN_PAGE_SIZE);