11f4d4ed6SAlexander Lobakin /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
2fe56b9e6SYuval Mintz /* QLogic qed NIC Driver
3e8f1cb50SMintz, Yuval * Copyright (c) 2015-2017 QLogic Corporation
4663eacd8SAlexander Lobakin * Copyright (c) 2019-2020 Marvell International Ltd.
5fe56b9e6SYuval Mintz */
6fe56b9e6SYuval Mintz
7fe56b9e6SYuval Mintz #ifndef _QED_CHAIN_H
8fe56b9e6SYuval Mintz #define _QED_CHAIN_H
9fe56b9e6SYuval Mintz
10fe56b9e6SYuval Mintz #include <linux/types.h>
11fe56b9e6SYuval Mintz #include <asm/byteorder.h>
12fe56b9e6SYuval Mintz #include <linux/kernel.h>
13fe56b9e6SYuval Mintz #include <linux/list.h>
1415506586SAlexander Lobakin #include <linux/sizes.h>
15fe56b9e6SYuval Mintz #include <linux/slab.h>
16fe56b9e6SYuval Mintz #include <linux/qed/common_hsi.h>
17fe56b9e6SYuval Mintz
18fe56b9e6SYuval Mintz enum qed_chain_mode {
19fe56b9e6SYuval Mintz /* Each Page contains a next pointer at its end */
20fe56b9e6SYuval Mintz QED_CHAIN_MODE_NEXT_PTR,
21fe56b9e6SYuval Mintz
22405a129fSBhaskar Chowdhury /* Chain is a single page (next ptr) is not required */
23fe56b9e6SYuval Mintz QED_CHAIN_MODE_SINGLE,
24fe56b9e6SYuval Mintz
25fe56b9e6SYuval Mintz /* Page pointers are located in a side list */
26fe56b9e6SYuval Mintz QED_CHAIN_MODE_PBL,
27fe56b9e6SYuval Mintz };
28fe56b9e6SYuval Mintz
29fe56b9e6SYuval Mintz enum qed_chain_use_mode {
30fe56b9e6SYuval Mintz QED_CHAIN_USE_TO_PRODUCE, /* Chain starts empty */
31fe56b9e6SYuval Mintz QED_CHAIN_USE_TO_CONSUME, /* Chain starts full */
32fe56b9e6SYuval Mintz QED_CHAIN_USE_TO_CONSUME_PRODUCE, /* Chain starts empty */
33fe56b9e6SYuval Mintz };
34fe56b9e6SYuval Mintz
35a91eb52aSYuval Mintz enum qed_chain_cnt_type {
36a91eb52aSYuval Mintz /* The chain's size/prod/cons are kept in 16-bit variables */
37a91eb52aSYuval Mintz QED_CHAIN_CNT_TYPE_U16,
38a91eb52aSYuval Mintz
39a91eb52aSYuval Mintz /* The chain's size/prod/cons are kept in 32-bit variables */
40a91eb52aSYuval Mintz QED_CHAIN_CNT_TYPE_U32,
41a91eb52aSYuval Mintz };
42a91eb52aSYuval Mintz
43fe56b9e6SYuval Mintz struct qed_chain_next {
44fe56b9e6SYuval Mintz struct regpair next_phys;
45fe56b9e6SYuval Mintz void *next_virt;
46fe56b9e6SYuval Mintz };
47fe56b9e6SYuval Mintz
48a91eb52aSYuval Mintz struct qed_chain_pbl_u16 {
49fe56b9e6SYuval Mintz u16 prod_page_idx;
50fe56b9e6SYuval Mintz u16 cons_page_idx;
51fe56b9e6SYuval Mintz };
52fe56b9e6SYuval Mintz
53a91eb52aSYuval Mintz struct qed_chain_pbl_u32 {
54a91eb52aSYuval Mintz u32 prod_page_idx;
55a91eb52aSYuval Mintz u32 cons_page_idx;
56a91eb52aSYuval Mintz };
57a91eb52aSYuval Mintz
58a91eb52aSYuval Mintz struct qed_chain_u16 {
59405a129fSBhaskar Chowdhury /* Cyclic index of next element to produce/consume */
60a91eb52aSYuval Mintz u16 prod_idx;
61a91eb52aSYuval Mintz u16 cons_idx;
62a91eb52aSYuval Mintz };
63a91eb52aSYuval Mintz
64a91eb52aSYuval Mintz struct qed_chain_u32 {
65405a129fSBhaskar Chowdhury /* Cyclic index of next element to produce/consume */
66a91eb52aSYuval Mintz u32 prod_idx;
67a91eb52aSYuval Mintz u32 cons_idx;
68a91eb52aSYuval Mintz };
69a91eb52aSYuval Mintz
708063f761SYuval Basson struct addr_tbl_entry {
718063f761SYuval Basson void *virt_addr;
728063f761SYuval Basson dma_addr_t dma_map;
738063f761SYuval Basson };
748063f761SYuval Basson
75fe56b9e6SYuval Mintz struct qed_chain {
762cf2f4f5SAlexander Lobakin /* Fastpath portion of the chain - required for commands such
776d937acfSMintz, Yuval * as produce / consume.
786d937acfSMintz, Yuval */
792cf2f4f5SAlexander Lobakin
806d937acfSMintz, Yuval /* Point to next element to produce/consume */
81fe56b9e6SYuval Mintz void *p_prod_elem;
82fe56b9e6SYuval Mintz void *p_cons_elem;
83a91eb52aSYuval Mintz
846d937acfSMintz, Yuval /* Fastpath portions of the PBL [if exists] */
852cf2f4f5SAlexander Lobakin
866d937acfSMintz, Yuval struct {
878063f761SYuval Basson /* Table for keeping the virtual and physical addresses of the
888063f761SYuval Basson * chain pages, respectively to the physical addresses
898063f761SYuval Basson * in the pbl table.
906d937acfSMintz, Yuval */
918063f761SYuval Basson struct addr_tbl_entry *pp_addr_tbl;
926d937acfSMintz, Yuval
936d937acfSMintz, Yuval union {
946d937acfSMintz, Yuval struct qed_chain_pbl_u16 u16;
956d937acfSMintz, Yuval struct qed_chain_pbl_u32 u32;
966d937acfSMintz, Yuval } c;
976d937acfSMintz, Yuval } pbl;
98a91eb52aSYuval Mintz
99a91eb52aSYuval Mintz union {
100a91eb52aSYuval Mintz struct qed_chain_u16 chain16;
101a91eb52aSYuval Mintz struct qed_chain_u32 chain32;
102a91eb52aSYuval Mintz } u;
103a91eb52aSYuval Mintz
1046d937acfSMintz, Yuval /* Capacity counts only usable elements */
1056d937acfSMintz, Yuval u32 capacity;
106a91eb52aSYuval Mintz u32 page_cnt;
107a91eb52aSYuval Mintz
1086d937acfSMintz, Yuval enum qed_chain_mode mode;
109a91eb52aSYuval Mintz
110a91eb52aSYuval Mintz /* Elements information for fast calculations */
111fe56b9e6SYuval Mintz u16 elem_per_page;
112fe56b9e6SYuval Mintz u16 elem_per_page_mask;
113fe56b9e6SYuval Mintz u16 elem_size;
114fe56b9e6SYuval Mintz u16 next_page_mask;
1156d937acfSMintz, Yuval u16 usable_per_page;
1166d937acfSMintz, Yuval u8 elem_unusable;
1176d937acfSMintz, Yuval
118b6db3f71SAlexander Lobakin enum qed_chain_cnt_type cnt_type;
1196d937acfSMintz, Yuval
1206d937acfSMintz, Yuval /* Slowpath of the chain - required for initialization and destruction,
1216d937acfSMintz, Yuval * but isn't involved in regular functionality.
1226d937acfSMintz, Yuval */
1236d937acfSMintz, Yuval
12415506586SAlexander Lobakin u32 page_size;
12515506586SAlexander Lobakin
1266d937acfSMintz, Yuval /* Base address of a pre-allocated buffer for pbl */
1276d937acfSMintz, Yuval struct {
1289b6ee3cfSAlexander Lobakin __le64 *table_virt;
1299b6ee3cfSAlexander Lobakin dma_addr_t table_phys;
1309b6ee3cfSAlexander Lobakin size_t table_size;
1316d937acfSMintz, Yuval } pbl_sp;
1326d937acfSMintz, Yuval
1336d937acfSMintz, Yuval /* Address of first page of the chain - the address is required
1340d80b761SRandy Dunlap * for fastpath operation [consume/produce] but only for the SINGLE
1356d937acfSMintz, Yuval * flavour which isn't considered fastpath [== SPQ].
1366d937acfSMintz, Yuval */
1376d937acfSMintz, Yuval void *p_virt_addr;
1386d937acfSMintz, Yuval dma_addr_t p_phys_addr;
1396d937acfSMintz, Yuval
1406d937acfSMintz, Yuval /* Total number of elements [for entire chain] */
1416d937acfSMintz, Yuval u32 size;
1426d937acfSMintz, Yuval
143b6db3f71SAlexander Lobakin enum qed_chain_use_mode intended_use;
1441a4a6975SMintz, Yuval
1451a4a6975SMintz, Yuval bool b_external_pbl;
146fe56b9e6SYuval Mintz };
147fe56b9e6SYuval Mintz
148b6db3f71SAlexander Lobakin struct qed_chain_init_params {
149b6db3f71SAlexander Lobakin enum qed_chain_mode mode;
150b6db3f71SAlexander Lobakin enum qed_chain_use_mode intended_use;
151b6db3f71SAlexander Lobakin enum qed_chain_cnt_type cnt_type;
152b6db3f71SAlexander Lobakin
15315506586SAlexander Lobakin u32 page_size;
154b6db3f71SAlexander Lobakin u32 num_elems;
155b6db3f71SAlexander Lobakin size_t elem_size;
156b6db3f71SAlexander Lobakin
157b6db3f71SAlexander Lobakin void *ext_pbl_virt;
158b6db3f71SAlexander Lobakin dma_addr_t ext_pbl_phys;
159b6db3f71SAlexander Lobakin };
160b6db3f71SAlexander Lobakin
16115506586SAlexander Lobakin #define QED_CHAIN_PAGE_SIZE SZ_4K
1622cf2f4f5SAlexander Lobakin
16315506586SAlexander Lobakin #define ELEMS_PER_PAGE(elem_size, page_size) \
16415506586SAlexander Lobakin ((page_size) / (elem_size))
165fe56b9e6SYuval Mintz
166fe56b9e6SYuval Mintz #define UNUSABLE_ELEMS_PER_PAGE(elem_size, mode) \
1676d937acfSMintz, Yuval (((mode) == QED_CHAIN_MODE_NEXT_PTR) ? \
1682cf2f4f5SAlexander Lobakin (u8)(1 + ((sizeof(struct qed_chain_next) - 1) / (elem_size))) : \
1692cf2f4f5SAlexander Lobakin 0)
170fe56b9e6SYuval Mintz
17115506586SAlexander Lobakin #define USABLE_ELEMS_PER_PAGE(elem_size, page_size, mode) \
17215506586SAlexander Lobakin ((u32)(ELEMS_PER_PAGE((elem_size), (page_size)) - \
1732cf2f4f5SAlexander Lobakin UNUSABLE_ELEMS_PER_PAGE((elem_size), (mode))))
174fe56b9e6SYuval Mintz
17515506586SAlexander Lobakin #define QED_CHAIN_PAGE_CNT(elem_cnt, elem_size, page_size, mode) \
17615506586SAlexander Lobakin DIV_ROUND_UP((elem_cnt), \
17715506586SAlexander Lobakin USABLE_ELEMS_PER_PAGE((elem_size), (page_size), (mode)))
178fe56b9e6SYuval Mintz
1792cf2f4f5SAlexander Lobakin #define is_chain_u16(p) \
1802cf2f4f5SAlexander Lobakin ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U16)
1812cf2f4f5SAlexander Lobakin #define is_chain_u32(p) \
1822cf2f4f5SAlexander Lobakin ((p)->cnt_type == QED_CHAIN_CNT_TYPE_U32)
183a91eb52aSYuval Mintz
184fe56b9e6SYuval Mintz /* Accessors */
185f2aefd20SAlexander Lobakin
qed_chain_get_prod_idx(const struct qed_chain * chain)186f2aefd20SAlexander Lobakin static inline u16 qed_chain_get_prod_idx(const struct qed_chain *chain)
187fe56b9e6SYuval Mintz {
188f2aefd20SAlexander Lobakin return chain->u.chain16.prod_idx;
189fe56b9e6SYuval Mintz }
190fe56b9e6SYuval Mintz
qed_chain_get_cons_idx(const struct qed_chain * chain)191f2aefd20SAlexander Lobakin static inline u16 qed_chain_get_cons_idx(const struct qed_chain *chain)
192fe56b9e6SYuval Mintz {
193f2aefd20SAlexander Lobakin return chain->u.chain16.cons_idx;
194a91eb52aSYuval Mintz }
195a91eb52aSYuval Mintz
qed_chain_get_prod_idx_u32(const struct qed_chain * chain)196f2aefd20SAlexander Lobakin static inline u32 qed_chain_get_prod_idx_u32(const struct qed_chain *chain)
197a91eb52aSYuval Mintz {
198f2aefd20SAlexander Lobakin return chain->u.chain32.prod_idx;
199fe56b9e6SYuval Mintz }
200fe56b9e6SYuval Mintz
qed_chain_get_cons_idx_u32(const struct qed_chain * chain)201f2aefd20SAlexander Lobakin static inline u32 qed_chain_get_cons_idx_u32(const struct qed_chain *chain)
202fe56b9e6SYuval Mintz {
203f2aefd20SAlexander Lobakin return chain->u.chain32.cons_idx;
204f2aefd20SAlexander Lobakin }
205f2aefd20SAlexander Lobakin
qed_chain_get_elem_used(const struct qed_chain * chain)206be0cec6fSAlexander Lobakin static inline u16 qed_chain_get_elem_used(const struct qed_chain *chain)
207f2aefd20SAlexander Lobakin {
208f2aefd20SAlexander Lobakin u32 prod = qed_chain_get_prod_idx(chain);
209f2aefd20SAlexander Lobakin u32 cons = qed_chain_get_cons_idx(chain);
210f2aefd20SAlexander Lobakin u16 elem_per_page = chain->elem_per_page;
211fe56b9e6SYuval Mintz u16 used;
212fe56b9e6SYuval Mintz
21397dd1abdSAlexander Lobakin if (prod < cons)
21497dd1abdSAlexander Lobakin prod += (u32)U16_MAX + 1;
21597dd1abdSAlexander Lobakin
21697dd1abdSAlexander Lobakin used = (u16)(prod - cons);
217f2aefd20SAlexander Lobakin if (chain->mode == QED_CHAIN_MODE_NEXT_PTR)
218f2aefd20SAlexander Lobakin used -= (u16)(prod / elem_per_page - cons / elem_per_page);
219a91eb52aSYuval Mintz
220be0cec6fSAlexander Lobakin return used;
221a91eb52aSYuval Mintz }
222a91eb52aSYuval Mintz
qed_chain_get_elem_left(const struct qed_chain * chain)223be0cec6fSAlexander Lobakin static inline u16 qed_chain_get_elem_left(const struct qed_chain *chain)
224be0cec6fSAlexander Lobakin {
225be0cec6fSAlexander Lobakin return (u16)(chain->capacity - qed_chain_get_elem_used(chain));
226be0cec6fSAlexander Lobakin }
227be0cec6fSAlexander Lobakin
qed_chain_get_elem_used_u32(const struct qed_chain * chain)228be0cec6fSAlexander Lobakin static inline u32 qed_chain_get_elem_used_u32(const struct qed_chain *chain)
229a91eb52aSYuval Mintz {
230f2aefd20SAlexander Lobakin u64 prod = qed_chain_get_prod_idx_u32(chain);
231f2aefd20SAlexander Lobakin u64 cons = qed_chain_get_cons_idx_u32(chain);
232f2aefd20SAlexander Lobakin u16 elem_per_page = chain->elem_per_page;
233a91eb52aSYuval Mintz u32 used;
234a91eb52aSYuval Mintz
23597dd1abdSAlexander Lobakin if (prod < cons)
23697dd1abdSAlexander Lobakin prod += (u64)U32_MAX + 1;
23797dd1abdSAlexander Lobakin
23897dd1abdSAlexander Lobakin used = (u32)(prod - cons);
239f2aefd20SAlexander Lobakin if (chain->mode == QED_CHAIN_MODE_NEXT_PTR)
24097dd1abdSAlexander Lobakin used -= (u32)(prod / elem_per_page - cons / elem_per_page);
241fe56b9e6SYuval Mintz
242be0cec6fSAlexander Lobakin return used;
243be0cec6fSAlexander Lobakin }
244be0cec6fSAlexander Lobakin
qed_chain_get_elem_left_u32(const struct qed_chain * chain)245be0cec6fSAlexander Lobakin static inline u32 qed_chain_get_elem_left_u32(const struct qed_chain *chain)
246be0cec6fSAlexander Lobakin {
247be0cec6fSAlexander Lobakin return chain->capacity - qed_chain_get_elem_used_u32(chain);
248fe56b9e6SYuval Mintz }
249fe56b9e6SYuval Mintz
qed_chain_get_usable_per_page(const struct qed_chain * chain)250f2aefd20SAlexander Lobakin static inline u16 qed_chain_get_usable_per_page(const struct qed_chain *chain)
251fe56b9e6SYuval Mintz {
252f2aefd20SAlexander Lobakin return chain->usable_per_page;
253fe56b9e6SYuval Mintz }
254fe56b9e6SYuval Mintz
qed_chain_get_unusable_per_page(const struct qed_chain * chain)255f2aefd20SAlexander Lobakin static inline u8 qed_chain_get_unusable_per_page(const struct qed_chain *chain)
256fe56b9e6SYuval Mintz {
257f2aefd20SAlexander Lobakin return chain->elem_unusable;
258fe56b9e6SYuval Mintz }
259fe56b9e6SYuval Mintz
qed_chain_get_page_cnt(const struct qed_chain * chain)260f2aefd20SAlexander Lobakin static inline u32 qed_chain_get_page_cnt(const struct qed_chain *chain)
261fe56b9e6SYuval Mintz {
262f2aefd20SAlexander Lobakin return chain->page_cnt;
263fe56b9e6SYuval Mintz }
264fe56b9e6SYuval Mintz
qed_chain_get_pbl_phys(const struct qed_chain * chain)265f2aefd20SAlexander Lobakin static inline dma_addr_t qed_chain_get_pbl_phys(const struct qed_chain *chain)
266fe56b9e6SYuval Mintz {
267f2aefd20SAlexander Lobakin return chain->pbl_sp.table_phys;
268fe56b9e6SYuval Mintz }
269fe56b9e6SYuval Mintz
270fe56b9e6SYuval Mintz /**
271*19198e4eSPrabhakar Kushwaha * qed_chain_advance_page(): Advance the next element across pages for a
272*19198e4eSPrabhakar Kushwaha * linked chain.
273fe56b9e6SYuval Mintz *
274*19198e4eSPrabhakar Kushwaha * @p_chain: P_chain.
275*19198e4eSPrabhakar Kushwaha * @p_next_elem: P_next_elem.
276*19198e4eSPrabhakar Kushwaha * @idx_to_inc: Idx_to_inc.
277*19198e4eSPrabhakar Kushwaha * @page_to_inc: page_to_inc.
278fe56b9e6SYuval Mintz *
279*19198e4eSPrabhakar Kushwaha * Return: Void.
280fe56b9e6SYuval Mintz */
281fe56b9e6SYuval Mintz static inline void
qed_chain_advance_page(struct qed_chain * p_chain,void ** p_next_elem,void * idx_to_inc,void * page_to_inc)282fe56b9e6SYuval Mintz qed_chain_advance_page(struct qed_chain *p_chain,
283a91eb52aSYuval Mintz void **p_next_elem, void *idx_to_inc, void *page_to_inc)
284fe56b9e6SYuval Mintz {
285a91eb52aSYuval Mintz struct qed_chain_next *p_next = NULL;
286a91eb52aSYuval Mintz u32 page_index = 0;
2876d937acfSMintz, Yuval
288fe56b9e6SYuval Mintz switch (p_chain->mode) {
289fe56b9e6SYuval Mintz case QED_CHAIN_MODE_NEXT_PTR:
290a91eb52aSYuval Mintz p_next = *p_next_elem;
291fe56b9e6SYuval Mintz *p_next_elem = p_next->next_virt;
292a91eb52aSYuval Mintz if (is_chain_u16(p_chain))
293a91eb52aSYuval Mintz *(u16 *)idx_to_inc += p_chain->elem_unusable;
294a91eb52aSYuval Mintz else
295a91eb52aSYuval Mintz *(u32 *)idx_to_inc += p_chain->elem_unusable;
296fe56b9e6SYuval Mintz break;
297fe56b9e6SYuval Mintz case QED_CHAIN_MODE_SINGLE:
298fe56b9e6SYuval Mintz *p_next_elem = p_chain->p_virt_addr;
299fe56b9e6SYuval Mintz break;
300fe56b9e6SYuval Mintz
301fe56b9e6SYuval Mintz case QED_CHAIN_MODE_PBL:
302a91eb52aSYuval Mintz if (is_chain_u16(p_chain)) {
303a91eb52aSYuval Mintz if (++(*(u16 *)page_to_inc) == p_chain->page_cnt)
304a91eb52aSYuval Mintz *(u16 *)page_to_inc = 0;
305a91eb52aSYuval Mintz page_index = *(u16 *)page_to_inc;
306a91eb52aSYuval Mintz } else {
307a91eb52aSYuval Mintz if (++(*(u32 *)page_to_inc) == p_chain->page_cnt)
308a91eb52aSYuval Mintz *(u32 *)page_to_inc = 0;
309a91eb52aSYuval Mintz page_index = *(u32 *)page_to_inc;
310fe56b9e6SYuval Mintz }
3118063f761SYuval Basson *p_next_elem = p_chain->pbl.pp_addr_tbl[page_index].virt_addr;
312fe56b9e6SYuval Mintz }
313fe56b9e6SYuval Mintz }
314fe56b9e6SYuval Mintz
315fe56b9e6SYuval Mintz #define is_unusable_idx(p, idx) \
316a91eb52aSYuval Mintz (((p)->u.chain16.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
317fe56b9e6SYuval Mintz
318a91eb52aSYuval Mintz #define is_unusable_idx_u32(p, idx) \
319a91eb52aSYuval Mintz (((p)->u.chain32.idx & (p)->elem_per_page_mask) == (p)->usable_per_page)
320fe56b9e6SYuval Mintz #define is_unusable_next_idx(p, idx) \
321a91eb52aSYuval Mintz ((((p)->u.chain16.idx + 1) & (p)->elem_per_page_mask) == \
322a91eb52aSYuval Mintz (p)->usable_per_page)
323fe56b9e6SYuval Mintz
324a91eb52aSYuval Mintz #define is_unusable_next_idx_u32(p, idx) \
325a91eb52aSYuval Mintz ((((p)->u.chain32.idx + 1) & (p)->elem_per_page_mask) == \
326a91eb52aSYuval Mintz (p)->usable_per_page)
327a91eb52aSYuval Mintz
328a91eb52aSYuval Mintz #define test_and_skip(p, idx) \
329fe56b9e6SYuval Mintz do { \
330a91eb52aSYuval Mintz if (is_chain_u16(p)) { \
331a91eb52aSYuval Mintz if (is_unusable_idx(p, idx)) \
332a91eb52aSYuval Mintz (p)->u.chain16.idx += (p)->elem_unusable; \
333a91eb52aSYuval Mintz } else { \
334a91eb52aSYuval Mintz if (is_unusable_idx_u32(p, idx)) \
335a91eb52aSYuval Mintz (p)->u.chain32.idx += (p)->elem_unusable; \
336fe56b9e6SYuval Mintz } \
337fe56b9e6SYuval Mintz } while (0)
338fe56b9e6SYuval Mintz
339fe56b9e6SYuval Mintz /**
340*19198e4eSPrabhakar Kushwaha * qed_chain_return_produced(): A chain in which the driver "Produces"
341*19198e4eSPrabhakar Kushwaha * elements should use this API
342*19198e4eSPrabhakar Kushwaha * to indicate previous produced elements
343*19198e4eSPrabhakar Kushwaha * are now consumed.
344fe56b9e6SYuval Mintz *
345*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
346fe56b9e6SYuval Mintz *
347*19198e4eSPrabhakar Kushwaha * Return: Void.
348fe56b9e6SYuval Mintz */
qed_chain_return_produced(struct qed_chain * p_chain)349fe56b9e6SYuval Mintz static inline void qed_chain_return_produced(struct qed_chain *p_chain)
350fe56b9e6SYuval Mintz {
351a91eb52aSYuval Mintz if (is_chain_u16(p_chain))
352a91eb52aSYuval Mintz p_chain->u.chain16.cons_idx++;
353a91eb52aSYuval Mintz else
354a91eb52aSYuval Mintz p_chain->u.chain32.cons_idx++;
355a91eb52aSYuval Mintz test_and_skip(p_chain, cons_idx);
356fe56b9e6SYuval Mintz }
357fe56b9e6SYuval Mintz
358fe56b9e6SYuval Mintz /**
359*19198e4eSPrabhakar Kushwaha * qed_chain_produce(): A chain in which the driver "Produces"
360*19198e4eSPrabhakar Kushwaha * elements should use this to get a pointer to
361*19198e4eSPrabhakar Kushwaha * the next element which can be "Produced". It's driver
362*19198e4eSPrabhakar Kushwaha * responsibility to validate that the chain has room for
363*19198e4eSPrabhakar Kushwaha * new element.
364fe56b9e6SYuval Mintz *
365*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
366fe56b9e6SYuval Mintz *
367*19198e4eSPrabhakar Kushwaha * Return: void*, a pointer to next element.
368fe56b9e6SYuval Mintz */
qed_chain_produce(struct qed_chain * p_chain)369fe56b9e6SYuval Mintz static inline void *qed_chain_produce(struct qed_chain *p_chain)
370fe56b9e6SYuval Mintz {
371a91eb52aSYuval Mintz void *p_ret = NULL, *p_prod_idx, *p_prod_page_idx;
372fe56b9e6SYuval Mintz
373a91eb52aSYuval Mintz if (is_chain_u16(p_chain)) {
374a91eb52aSYuval Mintz if ((p_chain->u.chain16.prod_idx &
375a91eb52aSYuval Mintz p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
376a91eb52aSYuval Mintz p_prod_idx = &p_chain->u.chain16.prod_idx;
3776d937acfSMintz, Yuval p_prod_page_idx = &p_chain->pbl.c.u16.prod_page_idx;
378fe56b9e6SYuval Mintz qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
379a91eb52aSYuval Mintz p_prod_idx, p_prod_page_idx);
380a91eb52aSYuval Mintz }
381a91eb52aSYuval Mintz p_chain->u.chain16.prod_idx++;
382a91eb52aSYuval Mintz } else {
383a91eb52aSYuval Mintz if ((p_chain->u.chain32.prod_idx &
384a91eb52aSYuval Mintz p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
385a91eb52aSYuval Mintz p_prod_idx = &p_chain->u.chain32.prod_idx;
3866d937acfSMintz, Yuval p_prod_page_idx = &p_chain->pbl.c.u32.prod_page_idx;
387a91eb52aSYuval Mintz qed_chain_advance_page(p_chain, &p_chain->p_prod_elem,
388a91eb52aSYuval Mintz p_prod_idx, p_prod_page_idx);
389a91eb52aSYuval Mintz }
390a91eb52aSYuval Mintz p_chain->u.chain32.prod_idx++;
391fe56b9e6SYuval Mintz }
392fe56b9e6SYuval Mintz
393a91eb52aSYuval Mintz p_ret = p_chain->p_prod_elem;
394fe56b9e6SYuval Mintz p_chain->p_prod_elem = (void *)(((u8 *)p_chain->p_prod_elem) +
395fe56b9e6SYuval Mintz p_chain->elem_size);
396fe56b9e6SYuval Mintz
397a91eb52aSYuval Mintz return p_ret;
398fe56b9e6SYuval Mintz }
399fe56b9e6SYuval Mintz
400fe56b9e6SYuval Mintz /**
401*19198e4eSPrabhakar Kushwaha * qed_chain_get_capacity(): Get the maximum number of BDs in chain
402fe56b9e6SYuval Mintz *
403*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
404fe56b9e6SYuval Mintz *
405*19198e4eSPrabhakar Kushwaha * Return: number of unusable BDs.
406fe56b9e6SYuval Mintz */
qed_chain_get_capacity(struct qed_chain * p_chain)407a91eb52aSYuval Mintz static inline u32 qed_chain_get_capacity(struct qed_chain *p_chain)
408fe56b9e6SYuval Mintz {
409fe56b9e6SYuval Mintz return p_chain->capacity;
410fe56b9e6SYuval Mintz }
411fe56b9e6SYuval Mintz
412fe56b9e6SYuval Mintz /**
413*19198e4eSPrabhakar Kushwaha * qed_chain_recycle_consumed(): Returns an element which was
414*19198e4eSPrabhakar Kushwaha * previously consumed;
415*19198e4eSPrabhakar Kushwaha * Increments producers so they could
416*19198e4eSPrabhakar Kushwaha * be written to FW.
417fe56b9e6SYuval Mintz *
418*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
419fe56b9e6SYuval Mintz *
420*19198e4eSPrabhakar Kushwaha * Return: Void.
421fe56b9e6SYuval Mintz */
qed_chain_recycle_consumed(struct qed_chain * p_chain)422a91eb52aSYuval Mintz static inline void qed_chain_recycle_consumed(struct qed_chain *p_chain)
423fe56b9e6SYuval Mintz {
424a91eb52aSYuval Mintz test_and_skip(p_chain, prod_idx);
425a91eb52aSYuval Mintz if (is_chain_u16(p_chain))
426a91eb52aSYuval Mintz p_chain->u.chain16.prod_idx++;
427a91eb52aSYuval Mintz else
428a91eb52aSYuval Mintz p_chain->u.chain32.prod_idx++;
429fe56b9e6SYuval Mintz }
430fe56b9e6SYuval Mintz
431fe56b9e6SYuval Mintz /**
432*19198e4eSPrabhakar Kushwaha * qed_chain_consume(): A Chain in which the driver utilizes data written
433*19198e4eSPrabhakar Kushwaha * by a different source (i.e., FW) should use this to
434*19198e4eSPrabhakar Kushwaha * access passed buffers.
435fe56b9e6SYuval Mintz *
436*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
437fe56b9e6SYuval Mintz *
438*19198e4eSPrabhakar Kushwaha * Return: void*, a pointer to the next buffer written.
439fe56b9e6SYuval Mintz */
qed_chain_consume(struct qed_chain * p_chain)440fe56b9e6SYuval Mintz static inline void *qed_chain_consume(struct qed_chain *p_chain)
441fe56b9e6SYuval Mintz {
442a91eb52aSYuval Mintz void *p_ret = NULL, *p_cons_idx, *p_cons_page_idx;
443fe56b9e6SYuval Mintz
444a91eb52aSYuval Mintz if (is_chain_u16(p_chain)) {
445a91eb52aSYuval Mintz if ((p_chain->u.chain16.cons_idx &
446a91eb52aSYuval Mintz p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
447a91eb52aSYuval Mintz p_cons_idx = &p_chain->u.chain16.cons_idx;
4486d937acfSMintz, Yuval p_cons_page_idx = &p_chain->pbl.c.u16.cons_page_idx;
449fe56b9e6SYuval Mintz qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
450a91eb52aSYuval Mintz p_cons_idx, p_cons_page_idx);
451a91eb52aSYuval Mintz }
452a91eb52aSYuval Mintz p_chain->u.chain16.cons_idx++;
453a91eb52aSYuval Mintz } else {
454a91eb52aSYuval Mintz if ((p_chain->u.chain32.cons_idx &
455a91eb52aSYuval Mintz p_chain->elem_per_page_mask) == p_chain->next_page_mask) {
456a91eb52aSYuval Mintz p_cons_idx = &p_chain->u.chain32.cons_idx;
4576d937acfSMintz, Yuval p_cons_page_idx = &p_chain->pbl.c.u32.cons_page_idx;
458a91eb52aSYuval Mintz qed_chain_advance_page(p_chain, &p_chain->p_cons_elem,
459a91eb52aSYuval Mintz p_cons_idx, p_cons_page_idx);
460a91eb52aSYuval Mintz }
461a91eb52aSYuval Mintz p_chain->u.chain32.cons_idx++;
462fe56b9e6SYuval Mintz }
463fe56b9e6SYuval Mintz
464a91eb52aSYuval Mintz p_ret = p_chain->p_cons_elem;
465fe56b9e6SYuval Mintz p_chain->p_cons_elem = (void *)(((u8 *)p_chain->p_cons_elem) +
466fe56b9e6SYuval Mintz p_chain->elem_size);
467fe56b9e6SYuval Mintz
468a91eb52aSYuval Mintz return p_ret;
469fe56b9e6SYuval Mintz }
470fe56b9e6SYuval Mintz
471fe56b9e6SYuval Mintz /**
472*19198e4eSPrabhakar Kushwaha * qed_chain_reset(): Resets the chain to its start state.
473fe56b9e6SYuval Mintz *
474*19198e4eSPrabhakar Kushwaha * @p_chain: pointer to a previously allocated chain.
475*19198e4eSPrabhakar Kushwaha *
476*19198e4eSPrabhakar Kushwaha * Return Void.
477fe56b9e6SYuval Mintz */
qed_chain_reset(struct qed_chain * p_chain)478fe56b9e6SYuval Mintz static inline void qed_chain_reset(struct qed_chain *p_chain)
479fe56b9e6SYuval Mintz {
480a91eb52aSYuval Mintz u32 i;
481fe56b9e6SYuval Mintz
482a91eb52aSYuval Mintz if (is_chain_u16(p_chain)) {
483a91eb52aSYuval Mintz p_chain->u.chain16.prod_idx = 0;
484a91eb52aSYuval Mintz p_chain->u.chain16.cons_idx = 0;
485a91eb52aSYuval Mintz } else {
486a91eb52aSYuval Mintz p_chain->u.chain32.prod_idx = 0;
487a91eb52aSYuval Mintz p_chain->u.chain32.cons_idx = 0;
488a91eb52aSYuval Mintz }
489fe56b9e6SYuval Mintz p_chain->p_cons_elem = p_chain->p_virt_addr;
490fe56b9e6SYuval Mintz p_chain->p_prod_elem = p_chain->p_virt_addr;
491fe56b9e6SYuval Mintz
492fe56b9e6SYuval Mintz if (p_chain->mode == QED_CHAIN_MODE_PBL) {
493a91eb52aSYuval Mintz /* Use (page_cnt - 1) as a reset value for the prod/cons page's
494a91eb52aSYuval Mintz * indices, to avoid unnecessary page advancing on the first
495a91eb52aSYuval Mintz * call to qed_chain_produce/consume. Instead, the indices
496a91eb52aSYuval Mintz * will be advanced to page_cnt and then will be wrapped to 0.
497a91eb52aSYuval Mintz */
498a91eb52aSYuval Mintz u32 reset_val = p_chain->page_cnt - 1;
499a91eb52aSYuval Mintz
500a91eb52aSYuval Mintz if (is_chain_u16(p_chain)) {
5016d937acfSMintz, Yuval p_chain->pbl.c.u16.prod_page_idx = (u16)reset_val;
5026d937acfSMintz, Yuval p_chain->pbl.c.u16.cons_page_idx = (u16)reset_val;
503a91eb52aSYuval Mintz } else {
5046d937acfSMintz, Yuval p_chain->pbl.c.u32.prod_page_idx = reset_val;
5056d937acfSMintz, Yuval p_chain->pbl.c.u32.cons_page_idx = reset_val;
506a91eb52aSYuval Mintz }
507fe56b9e6SYuval Mintz }
508fe56b9e6SYuval Mintz
509fe56b9e6SYuval Mintz switch (p_chain->intended_use) {
510fe56b9e6SYuval Mintz case QED_CHAIN_USE_TO_CONSUME:
511fe56b9e6SYuval Mintz /* produce empty elements */
512fe56b9e6SYuval Mintz for (i = 0; i < p_chain->capacity; i++)
513fe56b9e6SYuval Mintz qed_chain_recycle_consumed(p_chain);
514fe56b9e6SYuval Mintz break;
5156d937acfSMintz, Yuval
5166d937acfSMintz, Yuval case QED_CHAIN_USE_TO_CONSUME_PRODUCE:
5176d937acfSMintz, Yuval case QED_CHAIN_USE_TO_PRODUCE:
5186d937acfSMintz, Yuval default:
5196d937acfSMintz, Yuval /* Do nothing */
5206d937acfSMintz, Yuval break;
521fe56b9e6SYuval Mintz }
522fe56b9e6SYuval Mintz }
523fe56b9e6SYuval Mintz
524fe56b9e6SYuval Mintz /**
525*19198e4eSPrabhakar Kushwaha * qed_chain_get_last_elem(): Returns a pointer to the last element of the
526*19198e4eSPrabhakar Kushwaha * chain.
527a91eb52aSYuval Mintz *
528*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
529a91eb52aSYuval Mintz *
530*19198e4eSPrabhakar Kushwaha * Return: void*.
531a91eb52aSYuval Mintz */
qed_chain_get_last_elem(struct qed_chain * p_chain)532a91eb52aSYuval Mintz static inline void *qed_chain_get_last_elem(struct qed_chain *p_chain)
533a91eb52aSYuval Mintz {
534a91eb52aSYuval Mintz struct qed_chain_next *p_next = NULL;
535a91eb52aSYuval Mintz void *p_virt_addr = NULL;
536a91eb52aSYuval Mintz u32 size, last_page_idx;
537a91eb52aSYuval Mintz
538a91eb52aSYuval Mintz if (!p_chain->p_virt_addr)
539a91eb52aSYuval Mintz goto out;
540a91eb52aSYuval Mintz
541a91eb52aSYuval Mintz switch (p_chain->mode) {
542a91eb52aSYuval Mintz case QED_CHAIN_MODE_NEXT_PTR:
543a91eb52aSYuval Mintz size = p_chain->elem_size * p_chain->usable_per_page;
544a91eb52aSYuval Mintz p_virt_addr = p_chain->p_virt_addr;
545a91eb52aSYuval Mintz p_next = (struct qed_chain_next *)((u8 *)p_virt_addr + size);
546a91eb52aSYuval Mintz while (p_next->next_virt != p_chain->p_virt_addr) {
547a91eb52aSYuval Mintz p_virt_addr = p_next->next_virt;
548a91eb52aSYuval Mintz p_next = (struct qed_chain_next *)((u8 *)p_virt_addr +
549a91eb52aSYuval Mintz size);
550a91eb52aSYuval Mintz }
551a91eb52aSYuval Mintz break;
552a91eb52aSYuval Mintz case QED_CHAIN_MODE_SINGLE:
553a91eb52aSYuval Mintz p_virt_addr = p_chain->p_virt_addr;
554a91eb52aSYuval Mintz break;
555a91eb52aSYuval Mintz case QED_CHAIN_MODE_PBL:
556a91eb52aSYuval Mintz last_page_idx = p_chain->page_cnt - 1;
5578063f761SYuval Basson p_virt_addr = p_chain->pbl.pp_addr_tbl[last_page_idx].virt_addr;
558a91eb52aSYuval Mintz break;
559a91eb52aSYuval Mintz }
560a91eb52aSYuval Mintz /* p_virt_addr points at this stage to the last page of the chain */
561a91eb52aSYuval Mintz size = p_chain->elem_size * (p_chain->usable_per_page - 1);
562a91eb52aSYuval Mintz p_virt_addr = (u8 *)p_virt_addr + size;
563a91eb52aSYuval Mintz out:
564a91eb52aSYuval Mintz return p_virt_addr;
565a91eb52aSYuval Mintz }
566a91eb52aSYuval Mintz
567a91eb52aSYuval Mintz /**
568*19198e4eSPrabhakar Kushwaha * qed_chain_set_prod(): sets the prod to the given value.
569fe56b9e6SYuval Mintz *
570*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
571*19198e4eSPrabhakar Kushwaha * @prod_idx: Prod Idx.
572*19198e4eSPrabhakar Kushwaha * @p_prod_elem: Prod elem.
573*19198e4eSPrabhakar Kushwaha *
574*19198e4eSPrabhakar Kushwaha * Return Void.
575fe56b9e6SYuval Mintz */
qed_chain_set_prod(struct qed_chain * p_chain,u32 prod_idx,void * p_prod_elem)576fe56b9e6SYuval Mintz static inline void qed_chain_set_prod(struct qed_chain *p_chain,
577a91eb52aSYuval Mintz u32 prod_idx, void *p_prod_elem)
578fe56b9e6SYuval Mintz {
5792d533a92SDenis Bolotin if (p_chain->mode == QED_CHAIN_MODE_PBL) {
5802d533a92SDenis Bolotin u32 cur_prod, page_mask, page_cnt, page_diff;
5812d533a92SDenis Bolotin
5822d533a92SDenis Bolotin cur_prod = is_chain_u16(p_chain) ? p_chain->u.chain16.prod_idx :
5832d533a92SDenis Bolotin p_chain->u.chain32.prod_idx;
5842d533a92SDenis Bolotin
5852d533a92SDenis Bolotin /* Assume that number of elements in a page is power of 2 */
5862d533a92SDenis Bolotin page_mask = ~p_chain->elem_per_page_mask;
5872d533a92SDenis Bolotin
5882d533a92SDenis Bolotin /* Use "cur_prod - 1" and "prod_idx - 1" since producer index
5892d533a92SDenis Bolotin * reaches the first element of next page before the page index
5902d533a92SDenis Bolotin * is incremented. See qed_chain_produce().
5912d533a92SDenis Bolotin * Index wrap around is not a problem because the difference
5922d533a92SDenis Bolotin * between current and given producer indices is always
5932d533a92SDenis Bolotin * positive and lower than the chain's capacity.
5942d533a92SDenis Bolotin */
5952d533a92SDenis Bolotin page_diff = (((cur_prod - 1) & page_mask) -
5962d533a92SDenis Bolotin ((prod_idx - 1) & page_mask)) /
5972d533a92SDenis Bolotin p_chain->elem_per_page;
5982d533a92SDenis Bolotin
5992d533a92SDenis Bolotin page_cnt = qed_chain_get_page_cnt(p_chain);
6002d533a92SDenis Bolotin if (is_chain_u16(p_chain))
6012d533a92SDenis Bolotin p_chain->pbl.c.u16.prod_page_idx =
6022d533a92SDenis Bolotin (p_chain->pbl.c.u16.prod_page_idx -
6032d533a92SDenis Bolotin page_diff + page_cnt) % page_cnt;
6042d533a92SDenis Bolotin else
6052d533a92SDenis Bolotin p_chain->pbl.c.u32.prod_page_idx =
6062d533a92SDenis Bolotin (p_chain->pbl.c.u32.prod_page_idx -
6072d533a92SDenis Bolotin page_diff + page_cnt) % page_cnt;
6082d533a92SDenis Bolotin }
6092d533a92SDenis Bolotin
610a91eb52aSYuval Mintz if (is_chain_u16(p_chain))
611a91eb52aSYuval Mintz p_chain->u.chain16.prod_idx = (u16) prod_idx;
612a91eb52aSYuval Mintz else
613a91eb52aSYuval Mintz p_chain->u.chain32.prod_idx = prod_idx;
614fe56b9e6SYuval Mintz p_chain->p_prod_elem = p_prod_elem;
615fe56b9e6SYuval Mintz }
616fe56b9e6SYuval Mintz
617fe56b9e6SYuval Mintz /**
618*19198e4eSPrabhakar Kushwaha * qed_chain_pbl_zero_mem(): set chain memory to 0.
619fe56b9e6SYuval Mintz *
620*19198e4eSPrabhakar Kushwaha * @p_chain: Chain.
621*19198e4eSPrabhakar Kushwaha *
622*19198e4eSPrabhakar Kushwaha * Return: Void.
623fe56b9e6SYuval Mintz */
qed_chain_pbl_zero_mem(struct qed_chain * p_chain)624a91eb52aSYuval Mintz static inline void qed_chain_pbl_zero_mem(struct qed_chain *p_chain)
625fe56b9e6SYuval Mintz {
626a91eb52aSYuval Mintz u32 i, page_cnt;
627fe56b9e6SYuval Mintz
628a91eb52aSYuval Mintz if (p_chain->mode != QED_CHAIN_MODE_PBL)
629a91eb52aSYuval Mintz return;
630fe56b9e6SYuval Mintz
631a91eb52aSYuval Mintz page_cnt = qed_chain_get_page_cnt(p_chain);
632fe56b9e6SYuval Mintz
633a91eb52aSYuval Mintz for (i = 0; i < page_cnt; i++)
6348063f761SYuval Basson memset(p_chain->pbl.pp_addr_tbl[i].virt_addr, 0,
63515506586SAlexander Lobakin p_chain->page_size);
636fe56b9e6SYuval Mintz }
637fe56b9e6SYuval Mintz
638fe56b9e6SYuval Mintz #endif
639