9035d3bfa9acb85ab314cfa7cceedfc87e65b6c6
[dpdk.git] / drivers / net / qede / base / ecore_spq.c
1 /*
2  * Copyright (c) 2016 QLogic Corporation.
3  * All rights reserved.
4  * www.qlogic.com
5  *
6  * See LICENSE.qede_pmd for copyright and licensing details.
7  */
8
9 #include "bcm_osal.h"
10 #include "reg_addr.h"
11 #include "ecore_gtt_reg_addr.h"
12 #include "ecore_hsi_common.h"
13 #include "ecore.h"
14 #include "ecore_sp_api.h"
15 #include "ecore_spq.h"
16 #include "ecore_iro.h"
17 #include "ecore_init_fw_funcs.h"
18 #include "ecore_cxt.h"
19 #include "ecore_int.h"
20 #include "ecore_dev_api.h"
21 #include "ecore_mcp.h"
22 #include "ecore_hw.h"
23 #include "ecore_sriov.h"
24
25 /***************************************************************************
26  * Structures & Definitions
27  ***************************************************************************/
28
29 #define SPQ_HIGH_PRI_RESERVE_DEFAULT    (1)
30
31 #define SPQ_BLOCK_DELAY_MAX_ITER        (10)
32 #define SPQ_BLOCK_DELAY_US              (10)
33 #define SPQ_BLOCK_SLEEP_MAX_ITER        (1000)
34 #define SPQ_BLOCK_SLEEP_MS              (5)
35
36 /***************************************************************************
37  * Blocking Imp. (BLOCK/EBLOCK mode)
38  ***************************************************************************/
39 static void ecore_spq_blocking_cb(struct ecore_hwfn *p_hwfn,
40                                   void *cookie,
41                                   union event_ring_data *data,
42                                   u8 fw_return_code)
43 {
44         struct ecore_spq_comp_done *comp_done;
45
46         comp_done = (struct ecore_spq_comp_done *)cookie;
47
48         comp_done->done = 0x1;
49         comp_done->fw_return_code = fw_return_code;
50
51         /* make update visible to waiting thread */
52         OSAL_SMP_WMB(p_hwfn->p_dev);
53 }
54
55 static enum _ecore_status_t __ecore_spq_block(struct ecore_hwfn *p_hwfn,
56                                               struct ecore_spq_entry *p_ent,
57                                               u8 *p_fw_ret,
58                                               bool sleep_between_iter)
59 {
60         struct ecore_spq_comp_done *comp_done;
61         u32 iter_cnt;
62
63         comp_done = (struct ecore_spq_comp_done *)p_ent->comp_cb.cookie;
64         iter_cnt = sleep_between_iter ? SPQ_BLOCK_SLEEP_MAX_ITER
65                                       : SPQ_BLOCK_DELAY_MAX_ITER;
66
67         while (iter_cnt--) {
68                 OSAL_POLL_MODE_DPC(p_hwfn);
69                 OSAL_SMP_RMB(p_hwfn->p_dev);
70                 if (comp_done->done == 1) {
71                         if (p_fw_ret)
72                                 *p_fw_ret = comp_done->fw_return_code;
73                         return ECORE_SUCCESS;
74                 }
75
76                 if (sleep_between_iter)
77                         OSAL_MSLEEP(SPQ_BLOCK_SLEEP_MS);
78                 else
79                         OSAL_UDELAY(SPQ_BLOCK_DELAY_US);
80         }
81
82         return ECORE_TIMEOUT;
83 }
84
85 static enum _ecore_status_t ecore_spq_block(struct ecore_hwfn *p_hwfn,
86                                             struct ecore_spq_entry *p_ent,
87                                             u8 *p_fw_ret, bool skip_quick_poll)
88 {
89         struct ecore_spq_comp_done *comp_done;
90         enum _ecore_status_t rc;
91
92         /* A relatively short polling period w/o sleeping, to allow the FW to
93          * complete the ramrod and thus possibly to avoid the following sleeps.
94          */
95         if (!skip_quick_poll) {
96                 rc = __ecore_spq_block(p_hwfn, p_ent, p_fw_ret, false);
97                 if (rc == ECORE_SUCCESS)
98                         return ECORE_SUCCESS;
99         }
100
101         /* Move to polling with a sleeping period between iterations */
102         rc = __ecore_spq_block(p_hwfn, p_ent, p_fw_ret, true);
103         if (rc == ECORE_SUCCESS)
104                 return ECORE_SUCCESS;
105
106         DP_INFO(p_hwfn, "Ramrod is stuck, requesting MCP drain\n");
107         rc = ecore_mcp_drain(p_hwfn, p_hwfn->p_main_ptt);
108         if (rc != ECORE_SUCCESS) {
109                 DP_NOTICE(p_hwfn, true, "MCP drain failed\n");
110                 goto err;
111         }
112
113         /* Retry after drain */
114         rc = __ecore_spq_block(p_hwfn, p_ent, p_fw_ret, true);
115         if (rc == ECORE_SUCCESS)
116                 return ECORE_SUCCESS;
117
118         comp_done = (struct ecore_spq_comp_done *)p_ent->comp_cb.cookie;
119         if (comp_done->done == 1) {
120                 if (p_fw_ret)
121                         *p_fw_ret = comp_done->fw_return_code;
122                 return ECORE_SUCCESS;
123         }
124 err:
125         DP_NOTICE(p_hwfn, true,
126                   "Ramrod is stuck [CID %08x cmd %02x proto %02x echo %04x]\n",
127                   OSAL_LE32_TO_CPU(p_ent->elem.hdr.cid),
128                   p_ent->elem.hdr.cmd_id, p_ent->elem.hdr.protocol_id,
129                   OSAL_LE16_TO_CPU(p_ent->elem.hdr.echo));
130
131         ecore_hw_err_notify(p_hwfn, ECORE_HW_ERR_RAMROD_FAIL);
132
133         return ECORE_BUSY;
134 }
135
136 /***************************************************************************
137  * SPQ entries inner API
138  ***************************************************************************/
139 static enum _ecore_status_t
140 ecore_spq_fill_entry(struct ecore_hwfn *p_hwfn, struct ecore_spq_entry *p_ent)
141 {
142         p_ent->flags = 0;
143
144         switch (p_ent->comp_mode) {
145         case ECORE_SPQ_MODE_EBLOCK:
146         case ECORE_SPQ_MODE_BLOCK:
147                 p_ent->comp_cb.function = ecore_spq_blocking_cb;
148                 break;
149         case ECORE_SPQ_MODE_CB:
150                 break;
151         default:
152                 DP_NOTICE(p_hwfn, true, "Unknown SPQE completion mode %d\n",
153                           p_ent->comp_mode);
154                 return ECORE_INVAL;
155         }
156
157         DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
158                    "Ramrod header: [CID 0x%08x CMD 0x%02x protocol 0x%02x]"
159                    " Data pointer: [%08x:%08x] Completion Mode: %s\n",
160                    p_ent->elem.hdr.cid, p_ent->elem.hdr.cmd_id,
161                    p_ent->elem.hdr.protocol_id,
162                    p_ent->elem.data_ptr.hi, p_ent->elem.data_ptr.lo,
163                    D_TRINE(p_ent->comp_mode, ECORE_SPQ_MODE_EBLOCK,
164                            ECORE_SPQ_MODE_BLOCK, "MODE_EBLOCK", "MODE_BLOCK",
165                            "MODE_CB"));
166
167         return ECORE_SUCCESS;
168 }
169
170 /***************************************************************************
171  * HSI access
172  ***************************************************************************/
173 static void ecore_spq_hw_initialize(struct ecore_hwfn *p_hwfn,
174                                     struct ecore_spq *p_spq)
175 {
176         u16 pq;
177         struct ecore_cxt_info cxt_info;
178         struct core_conn_context *p_cxt;
179         union ecore_qm_pq_params pq_params;
180         enum _ecore_status_t rc;
181
182         cxt_info.iid = p_spq->cid;
183
184         rc = ecore_cxt_get_cid_info(p_hwfn, &cxt_info);
185
186         if (rc < 0) {
187                 DP_NOTICE(p_hwfn, true, "Cannot find context info for cid=%d\n",
188                           p_spq->cid);
189                 return;
190         }
191
192         p_cxt = cxt_info.p_cxt;
193
194         if (ECORE_IS_BB(p_hwfn->p_dev) || ECORE_IS_AH(p_hwfn->p_dev)) {
195                 SET_FIELD(p_cxt->xstorm_ag_context.flags10,
196                           E4_XSTORM_CORE_CONN_AG_CTX_DQ_CF_EN, 1);
197                 SET_FIELD(p_cxt->xstorm_ag_context.flags1,
198                           E4_XSTORM_CORE_CONN_AG_CTX_DQ_CF_ACTIVE, 1);
199                 /* SET_FIELD(p_cxt->xstorm_ag_context.flags10,
200                  *        E4_XSTORM_CORE_CONN_AG_CTX_SLOW_PATH_EN, 1);
201                  */
202                 SET_FIELD(p_cxt->xstorm_ag_context.flags9,
203                           E4_XSTORM_CORE_CONN_AG_CTX_CONSOLID_PROD_CF_EN, 1);
204         }
205
206         /* CDU validation - FIXME currently disabled */
207
208         /* QM physical queue */
209         OSAL_MEMSET(&pq_params, 0, sizeof(pq_params));
210         pq_params.core.tc = LB_TC;
211         pq = ecore_get_qm_pq(p_hwfn, PROTOCOLID_CORE, &pq_params);
212         p_cxt->xstorm_ag_context.physical_q0 = OSAL_CPU_TO_LE16(pq);
213
214         p_cxt->xstorm_st_context.spq_base_lo =
215             DMA_LO_LE(p_spq->chain.p_phys_addr);
216         p_cxt->xstorm_st_context.spq_base_hi =
217             DMA_HI_LE(p_spq->chain.p_phys_addr);
218
219         DMA_REGPAIR_LE(p_cxt->xstorm_st_context.consolid_base_addr,
220                        p_hwfn->p_consq->chain.p_phys_addr);
221 }
222
223 static enum _ecore_status_t ecore_spq_hw_post(struct ecore_hwfn *p_hwfn,
224                                               struct ecore_spq *p_spq,
225                                               struct ecore_spq_entry *p_ent)
226 {
227         struct ecore_chain *p_chain = &p_hwfn->p_spq->chain;
228         u16 echo = ecore_chain_get_prod_idx(p_chain);
229         struct slow_path_element *elem;
230         struct core_db_data db;
231
232         p_ent->elem.hdr.echo = OSAL_CPU_TO_LE16(echo);
233         elem = ecore_chain_produce(p_chain);
234         if (!elem) {
235                 DP_NOTICE(p_hwfn, true, "Failed to produce from SPQ chain\n");
236                 return ECORE_INVAL;
237         }
238
239         *elem = p_ent->elem;    /* struct assignment */
240
241         /* send a doorbell on the slow hwfn session */
242         OSAL_MEMSET(&db, 0, sizeof(db));
243         SET_FIELD(db.params, CORE_DB_DATA_DEST, DB_DEST_XCM);
244         SET_FIELD(db.params, CORE_DB_DATA_AGG_CMD, DB_AGG_CMD_SET);
245         SET_FIELD(db.params, CORE_DB_DATA_AGG_VAL_SEL,
246                   DQ_XCM_CORE_SPQ_PROD_CMD);
247         db.agg_flags = DQ_XCM_CORE_DQ_CF_CMD;
248         db.spq_prod = OSAL_CPU_TO_LE16(ecore_chain_get_prod_idx(p_chain));
249
250         /* make sure the SPQE is updated before the doorbell */
251         OSAL_WMB(p_hwfn->p_dev);
252
253         DOORBELL(p_hwfn, DB_ADDR(p_spq->cid, DQ_DEMS_LEGACY),
254                  *(u32 *)&db);
255
256         /* make sure doorbell is rang */
257         OSAL_WMB(p_hwfn->p_dev);
258
259         DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
260                    "Doorbelled [0x%08x, CID 0x%08x] with Flags: %02x"
261                    " agg_params: %02x, prod: %04x\n",
262                    DB_ADDR(p_spq->cid, DQ_DEMS_LEGACY), p_spq->cid, db.params,
263                    db.agg_flags, ecore_chain_get_prod_idx(p_chain));
264
265         return ECORE_SUCCESS;
266 }
267
268 /***************************************************************************
269  * Asynchronous events
270  ***************************************************************************/
271
272 static enum _ecore_status_t
273 ecore_async_event_completion(struct ecore_hwfn *p_hwfn,
274                              struct event_ring_entry *p_eqe)
275 {
276         switch (p_eqe->protocol_id) {
277         case PROTOCOLID_COMMON:
278                 return ecore_sriov_eqe_event(p_hwfn,
279                                              p_eqe->opcode,
280                                              p_eqe->echo, &p_eqe->data);
281         default:
282                 DP_NOTICE(p_hwfn,
283                           true, "Unknown Async completion for protocol: %d\n",
284                           p_eqe->protocol_id);
285                 return ECORE_INVAL;
286         }
287 }
288
289 /***************************************************************************
290  * EQ API
291  ***************************************************************************/
292 void ecore_eq_prod_update(struct ecore_hwfn *p_hwfn, u16 prod)
293 {
294         u32 addr = GTT_BAR0_MAP_REG_USDM_RAM +
295             USTORM_EQE_CONS_OFFSET(p_hwfn->rel_pf_id);
296
297         REG_WR16(p_hwfn, addr, prod);
298
299         /* keep prod updates ordered */
300         OSAL_MMIOWB(p_hwfn->p_dev);
301 }
302
303 enum _ecore_status_t ecore_eq_completion(struct ecore_hwfn *p_hwfn,
304                                          void *cookie)
305 {
306         struct ecore_eq *p_eq = cookie;
307         struct ecore_chain *p_chain = &p_eq->chain;
308         enum _ecore_status_t rc = 0;
309
310         /* take a snapshot of the FW consumer */
311         u16 fw_cons_idx = OSAL_LE16_TO_CPU(*p_eq->p_fw_cons);
312
313         DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ, "fw_cons_idx %x\n", fw_cons_idx);
314
315         /* Need to guarantee the fw_cons index we use points to a usuable
316          * element (to comply with our chain), so our macros would comply
317          */
318         if ((fw_cons_idx & ecore_chain_get_usable_per_page(p_chain)) ==
319             ecore_chain_get_usable_per_page(p_chain)) {
320                 fw_cons_idx += ecore_chain_get_unusable_per_page(p_chain);
321         }
322
323         /* Complete current segment of eq entries */
324         while (fw_cons_idx != ecore_chain_get_cons_idx(p_chain)) {
325                 struct event_ring_entry *p_eqe = ecore_chain_consume(p_chain);
326                 if (!p_eqe) {
327                         rc = ECORE_INVAL;
328                         break;
329                 }
330
331                 DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
332                            "op %x prot %x res0 %x echo %x fwret %x flags %x\n",
333                            p_eqe->opcode,            /* Event Opcode */
334                            p_eqe->protocol_id,  /* Event Protocol ID */
335                            p_eqe->reserved0,    /* Reserved */
336                            /* Echo value from ramrod data on the host */
337                            OSAL_LE16_TO_CPU(p_eqe->echo),
338                            p_eqe->fw_return_code,    /* FW return code for SP
339                                                       * ramrods
340                                                       */
341                            p_eqe->flags);
342
343                 if (GET_FIELD(p_eqe->flags, EVENT_RING_ENTRY_ASYNC)) {
344                         if (ecore_async_event_completion(p_hwfn, p_eqe))
345                                 rc = ECORE_INVAL;
346                 } else if (ecore_spq_completion(p_hwfn,
347                                                 p_eqe->echo,
348                                                 p_eqe->fw_return_code,
349                                                 &p_eqe->data)) {
350                         rc = ECORE_INVAL;
351                 }
352
353                 ecore_chain_recycle_consumed(p_chain);
354         }
355
356         ecore_eq_prod_update(p_hwfn, ecore_chain_get_prod_idx(p_chain));
357
358         return rc;
359 }
360
361 struct ecore_eq *ecore_eq_alloc(struct ecore_hwfn *p_hwfn, u16 num_elem)
362 {
363         struct ecore_eq *p_eq;
364
365         /* Allocate EQ struct */
366         p_eq = OSAL_ZALLOC(p_hwfn->p_dev, GFP_KERNEL, sizeof(*p_eq));
367         if (!p_eq) {
368                 DP_NOTICE(p_hwfn, true,
369                           "Failed to allocate `struct ecore_eq'\n");
370                 return OSAL_NULL;
371         }
372
373         /* Allocate and initialize EQ chain*/
374         if (ecore_chain_alloc(p_hwfn->p_dev,
375                               ECORE_CHAIN_USE_TO_PRODUCE,
376                               ECORE_CHAIN_MODE_PBL,
377                               ECORE_CHAIN_CNT_TYPE_U16,
378                               num_elem,
379                               sizeof(union event_ring_element),
380                               &p_eq->chain, OSAL_NULL)) {
381                 DP_NOTICE(p_hwfn, true, "Failed to allocate eq chain\n");
382                 goto eq_allocate_fail;
383         }
384
385         /* register EQ completion on the SP SB */
386         ecore_int_register_cb(p_hwfn, ecore_eq_completion,
387                               p_eq, &p_eq->eq_sb_index, &p_eq->p_fw_cons);
388
389         return p_eq;
390
391 eq_allocate_fail:
392         ecore_eq_free(p_hwfn, p_eq);
393         return OSAL_NULL;
394 }
395
396 void ecore_eq_setup(struct ecore_hwfn *p_hwfn, struct ecore_eq *p_eq)
397 {
398         ecore_chain_reset(&p_eq->chain);
399 }
400
401 void ecore_eq_free(struct ecore_hwfn *p_hwfn, struct ecore_eq *p_eq)
402 {
403         if (!p_eq)
404                 return;
405         ecore_chain_free(p_hwfn->p_dev, &p_eq->chain);
406         OSAL_FREE(p_hwfn->p_dev, p_eq);
407 }
408
409 /***************************************************************************
410 * CQE API - manipulate EQ functionality
411 ***************************************************************************/
412 static enum _ecore_status_t ecore_cqe_completion(struct ecore_hwfn *p_hwfn,
413                                                  struct eth_slow_path_rx_cqe
414                                                  *cqe,
415                                                  enum protocol_type protocol)
416 {
417         if (IS_VF(p_hwfn->p_dev))
418                 return OSAL_VF_CQE_COMPLETION(p_hwfn, cqe, protocol);
419
420         /* @@@tmp - it's possible we'll eventually want to handle some
421          * actual commands that can arrive here, but for now this is only
422          * used to complete the ramrod using the echo value on the cqe
423          */
424         return ecore_spq_completion(p_hwfn, cqe->echo, 0, OSAL_NULL);
425 }
426
427 enum _ecore_status_t ecore_eth_cqe_completion(struct ecore_hwfn *p_hwfn,
428                                               struct eth_slow_path_rx_cqe *cqe)
429 {
430         enum _ecore_status_t rc;
431
432         rc = ecore_cqe_completion(p_hwfn, cqe, PROTOCOLID_ETH);
433         if (rc) {
434                 DP_NOTICE(p_hwfn, true,
435                           "Failed to handle RXQ CQE [cmd 0x%02x]\n",
436                           cqe->ramrod_cmd_id);
437         }
438
439         return rc;
440 }
441
442 /***************************************************************************
443  * Slow hwfn Queue (spq)
444  ***************************************************************************/
445 void ecore_spq_setup(struct ecore_hwfn *p_hwfn)
446 {
447         struct ecore_spq *p_spq = p_hwfn->p_spq;
448         struct ecore_spq_entry *p_virt = OSAL_NULL;
449         dma_addr_t p_phys = 0;
450         u32 i, capacity;
451
452         OSAL_LIST_INIT(&p_spq->pending);
453         OSAL_LIST_INIT(&p_spq->completion_pending);
454         OSAL_LIST_INIT(&p_spq->free_pool);
455         OSAL_LIST_INIT(&p_spq->unlimited_pending);
456         OSAL_SPIN_LOCK_INIT(&p_spq->lock);
457
458         /* SPQ empty pool */
459         p_phys = p_spq->p_phys + OFFSETOF(struct ecore_spq_entry, ramrod);
460         p_virt = p_spq->p_virt;
461
462         capacity = ecore_chain_get_capacity(&p_spq->chain);
463         for (i = 0; i < capacity; i++) {
464                 DMA_REGPAIR_LE(p_virt->elem.data_ptr, p_phys);
465
466                 OSAL_LIST_PUSH_TAIL(&p_virt->list, &p_spq->free_pool);
467
468                 p_virt++;
469                 p_phys += sizeof(struct ecore_spq_entry);
470         }
471
472         /* Statistics */
473         p_spq->normal_count = 0;
474         p_spq->comp_count = 0;
475         p_spq->comp_sent_count = 0;
476         p_spq->unlimited_pending_count = 0;
477
478         OSAL_MEM_ZERO(p_spq->p_comp_bitmap,
479                       SPQ_COMP_BMAP_SIZE * sizeof(unsigned long));
480         p_spq->comp_bitmap_idx = 0;
481
482         /* SPQ cid, cannot fail */
483         ecore_cxt_acquire_cid(p_hwfn, PROTOCOLID_CORE, &p_spq->cid);
484         ecore_spq_hw_initialize(p_hwfn, p_spq);
485
486         /* reset the chain itself */
487         ecore_chain_reset(&p_spq->chain);
488 }
489
490 enum _ecore_status_t ecore_spq_alloc(struct ecore_hwfn *p_hwfn)
491 {
492         struct ecore_spq_entry *p_virt = OSAL_NULL;
493         struct ecore_spq *p_spq = OSAL_NULL;
494         dma_addr_t p_phys = 0;
495         u32 capacity;
496
497         /* SPQ struct */
498         p_spq =
499             OSAL_ZALLOC(p_hwfn->p_dev, GFP_KERNEL, sizeof(struct ecore_spq));
500         if (!p_spq) {
501                 DP_NOTICE(p_hwfn, true,
502                           "Failed to allocate `struct ecore_spq'\n");
503                 return ECORE_NOMEM;
504         }
505
506         /* SPQ ring  */
507         if (ecore_chain_alloc(p_hwfn->p_dev,
508                               ECORE_CHAIN_USE_TO_PRODUCE,
509                               ECORE_CHAIN_MODE_SINGLE,
510                               ECORE_CHAIN_CNT_TYPE_U16,
511                               0, /* N/A when the mode is SINGLE */
512                               sizeof(struct slow_path_element),
513                               &p_spq->chain, OSAL_NULL)) {
514                 DP_NOTICE(p_hwfn, true, "Failed to allocate spq chain\n");
515                 goto spq_allocate_fail;
516         }
517
518         /* allocate and fill the SPQ elements (incl. ramrod data list) */
519         capacity = ecore_chain_get_capacity(&p_spq->chain);
520         p_virt = OSAL_DMA_ALLOC_COHERENT(p_hwfn->p_dev, &p_phys,
521                                          capacity *
522                                          sizeof(struct ecore_spq_entry));
523         if (!p_virt)
524                 goto spq_allocate_fail;
525
526         p_spq->p_virt = p_virt;
527         p_spq->p_phys = p_phys;
528
529         OSAL_SPIN_LOCK_ALLOC(p_hwfn, &p_spq->lock);
530
531         p_hwfn->p_spq = p_spq;
532         return ECORE_SUCCESS;
533
534 spq_allocate_fail:
535         ecore_chain_free(p_hwfn->p_dev, &p_spq->chain);
536         OSAL_FREE(p_hwfn->p_dev, p_spq);
537         return ECORE_NOMEM;
538 }
539
540 void ecore_spq_free(struct ecore_hwfn *p_hwfn)
541 {
542         struct ecore_spq *p_spq = p_hwfn->p_spq;
543         u32 capacity;
544
545         if (!p_spq)
546                 return;
547
548         if (p_spq->p_virt) {
549                 capacity = ecore_chain_get_capacity(&p_spq->chain);
550                 OSAL_DMA_FREE_COHERENT(p_hwfn->p_dev,
551                                        p_spq->p_virt,
552                                        p_spq->p_phys,
553                                        capacity *
554                                        sizeof(struct ecore_spq_entry));
555         }
556
557         ecore_chain_free(p_hwfn->p_dev, &p_spq->chain);
558         OSAL_SPIN_LOCK_DEALLOC(&p_spq->lock);
559         OSAL_FREE(p_hwfn->p_dev, p_spq);
560 }
561
562 enum _ecore_status_t
563 ecore_spq_get_entry(struct ecore_hwfn *p_hwfn, struct ecore_spq_entry **pp_ent)
564 {
565         struct ecore_spq *p_spq = p_hwfn->p_spq;
566         struct ecore_spq_entry *p_ent = OSAL_NULL;
567         enum _ecore_status_t rc = ECORE_SUCCESS;
568
569         OSAL_SPIN_LOCK(&p_spq->lock);
570
571         if (OSAL_LIST_IS_EMPTY(&p_spq->free_pool)) {
572                 p_ent = OSAL_ZALLOC(p_hwfn->p_dev, GFP_ATOMIC, sizeof(*p_ent));
573                 if (!p_ent) {
574                         DP_NOTICE(p_hwfn, true,
575                                  "Failed to allocate an SPQ entry for a pending"
576                                  " ramrod\n");
577                         rc = ECORE_NOMEM;
578                         goto out_unlock;
579                 }
580                 p_ent->queue = &p_spq->unlimited_pending;
581         } else {
582                 p_ent = OSAL_LIST_FIRST_ENTRY(&p_spq->free_pool,
583                                               struct ecore_spq_entry, list);
584                 OSAL_LIST_REMOVE_ENTRY(&p_ent->list, &p_spq->free_pool);
585                 p_ent->queue = &p_spq->pending;
586         }
587
588         *pp_ent = p_ent;
589
590 out_unlock:
591         OSAL_SPIN_UNLOCK(&p_spq->lock);
592         return rc;
593 }
594
595 /* Locked variant; Should be called while the SPQ lock is taken */
596 static void __ecore_spq_return_entry(struct ecore_hwfn *p_hwfn,
597                                      struct ecore_spq_entry *p_ent)
598 {
599         OSAL_LIST_PUSH_TAIL(&p_ent->list, &p_hwfn->p_spq->free_pool);
600 }
601
602 void ecore_spq_return_entry(struct ecore_hwfn *p_hwfn,
603                             struct ecore_spq_entry *p_ent)
604 {
605         OSAL_SPIN_LOCK(&p_hwfn->p_spq->lock);
606         __ecore_spq_return_entry(p_hwfn, p_ent);
607         OSAL_SPIN_UNLOCK(&p_hwfn->p_spq->lock);
608 }
609
610 /**
611  * @brief ecore_spq_add_entry - adds a new entry to the pending
612  *        list. Should be used while lock is being held.
613  *
614  * Addes an entry to the pending list is there is room (en empty
615  * element is available in the free_pool), or else places the
616  * entry in the unlimited_pending pool.
617  *
618  * @param p_hwfn
619  * @param p_ent
620  * @param priority
621  *
622  * @return enum _ecore_status_t
623  */
624 static enum _ecore_status_t
625 ecore_spq_add_entry(struct ecore_hwfn *p_hwfn,
626                     struct ecore_spq_entry *p_ent, enum spq_priority priority)
627 {
628         struct ecore_spq *p_spq = p_hwfn->p_spq;
629
630         if (p_ent->queue == &p_spq->unlimited_pending) {
631                 if (OSAL_LIST_IS_EMPTY(&p_spq->free_pool)) {
632                         OSAL_LIST_PUSH_TAIL(&p_ent->list,
633                                             &p_spq->unlimited_pending);
634                         p_spq->unlimited_pending_count++;
635
636                         return ECORE_SUCCESS;
637
638                 } else {
639                         struct ecore_spq_entry *p_en2;
640
641                         p_en2 = OSAL_LIST_FIRST_ENTRY(&p_spq->free_pool,
642                                                      struct ecore_spq_entry,
643                                                      list);
644                         OSAL_LIST_REMOVE_ENTRY(&p_en2->list, &p_spq->free_pool);
645
646                         /* Copy the ring element physical pointer to the new
647                          * entry, since we are about to override the entire ring
648                          * entry and don't want to lose the pointer.
649                          */
650                         p_ent->elem.data_ptr = p_en2->elem.data_ptr;
651
652                         *p_en2 = *p_ent;
653
654                         /* EBLOCK responsible to free the allocated p_ent */
655                         if (p_ent->comp_mode != ECORE_SPQ_MODE_EBLOCK)
656                                 OSAL_FREE(p_hwfn->p_dev, p_ent);
657
658                         p_ent = p_en2;
659                 }
660         }
661
662         /* entry is to be placed in 'pending' queue */
663         switch (priority) {
664         case ECORE_SPQ_PRIORITY_NORMAL:
665                 OSAL_LIST_PUSH_TAIL(&p_ent->list, &p_spq->pending);
666                 p_spq->normal_count++;
667                 break;
668         case ECORE_SPQ_PRIORITY_HIGH:
669                 OSAL_LIST_PUSH_HEAD(&p_ent->list, &p_spq->pending);
670                 p_spq->high_count++;
671                 break;
672         default:
673                 return ECORE_INVAL;
674         }
675
676         return ECORE_SUCCESS;
677 }
678
679 /***************************************************************************
680  * Accessor
681  ***************************************************************************/
682
683 u32 ecore_spq_get_cid(struct ecore_hwfn *p_hwfn)
684 {
685         if (!p_hwfn->p_spq)
686                 return 0xffffffff;      /* illegal */
687         return p_hwfn->p_spq->cid;
688 }
689
690 /***************************************************************************
691  * Posting new Ramrods
692  ***************************************************************************/
693
694 static enum _ecore_status_t ecore_spq_post_list(struct ecore_hwfn *p_hwfn,
695                                                 osal_list_t *head,
696                                                 u32 keep_reserve)
697 {
698         struct ecore_spq *p_spq = p_hwfn->p_spq;
699         enum _ecore_status_t rc;
700
701         /* TODO - implementation might be wasteful; will always keep room
702          * for an additional high priority ramrod (even if one is already
703          * pending FW)
704          */
705         while (ecore_chain_get_elem_left(&p_spq->chain) > keep_reserve &&
706                !OSAL_LIST_IS_EMPTY(head)) {
707                 struct ecore_spq_entry *p_ent =
708                     OSAL_LIST_FIRST_ENTRY(head, struct ecore_spq_entry, list);
709                 if (p_ent != OSAL_NULL) {
710 #if defined(_NTDDK_)
711 #pragma warning(suppress : 6011 28182)
712 #endif
713                         OSAL_LIST_REMOVE_ENTRY(&p_ent->list, head);
714                         OSAL_LIST_PUSH_TAIL(&p_ent->list,
715                                             &p_spq->completion_pending);
716                         p_spq->comp_sent_count++;
717
718                         rc = ecore_spq_hw_post(p_hwfn, p_spq, p_ent);
719                         if (rc) {
720                                 OSAL_LIST_REMOVE_ENTRY(&p_ent->list,
721                                                     &p_spq->completion_pending);
722                                 __ecore_spq_return_entry(p_hwfn, p_ent);
723                                 return rc;
724                         }
725                 }
726         }
727
728         return ECORE_SUCCESS;
729 }
730
731 static enum _ecore_status_t ecore_spq_pend_post(struct ecore_hwfn *p_hwfn)
732 {
733         struct ecore_spq *p_spq = p_hwfn->p_spq;
734         struct ecore_spq_entry *p_ent = OSAL_NULL;
735
736         while (!OSAL_LIST_IS_EMPTY(&p_spq->free_pool)) {
737                 if (OSAL_LIST_IS_EMPTY(&p_spq->unlimited_pending))
738                         break;
739
740                 p_ent = OSAL_LIST_FIRST_ENTRY(&p_spq->unlimited_pending,
741                                               struct ecore_spq_entry, list);
742                 if (!p_ent)
743                         return ECORE_INVAL;
744
745 #if defined(_NTDDK_)
746 #pragma warning(suppress : 6011)
747 #endif
748                 OSAL_LIST_REMOVE_ENTRY(&p_ent->list, &p_spq->unlimited_pending);
749
750                 ecore_spq_add_entry(p_hwfn, p_ent, p_ent->priority);
751         }
752
753         return ecore_spq_post_list(p_hwfn,
754                                  &p_spq->pending, SPQ_HIGH_PRI_RESERVE_DEFAULT);
755 }
756
757 enum _ecore_status_t ecore_spq_post(struct ecore_hwfn *p_hwfn,
758                                     struct ecore_spq_entry *p_ent,
759                                     u8 *fw_return_code)
760 {
761         enum _ecore_status_t rc = ECORE_SUCCESS;
762         struct ecore_spq *p_spq = p_hwfn ? p_hwfn->p_spq : OSAL_NULL;
763         bool b_ret_ent = true;
764
765         if (!p_hwfn)
766                 return ECORE_INVAL;
767
768         if (!p_ent) {
769                 DP_NOTICE(p_hwfn, true, "Got a NULL pointer\n");
770                 return ECORE_INVAL;
771         }
772
773         if (p_hwfn->p_dev->recov_in_prog) {
774                 DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
775                            "Recovery is in progress -> skip spq post"
776                            " [cmd %02x protocol %02x]\n",
777                            p_ent->elem.hdr.cmd_id, p_ent->elem.hdr.protocol_id);
778                 /* Return success to let the flows to be completed successfully
779                  * w/o any error handling.
780                  */
781                 return ECORE_SUCCESS;
782         }
783
784         OSAL_SPIN_LOCK(&p_spq->lock);
785
786         /* Complete the entry */
787         rc = ecore_spq_fill_entry(p_hwfn, p_ent);
788
789         /* Check return value after LOCK is taken for cleaner error flow */
790         if (rc)
791                 goto spq_post_fail;
792
793         /* Add the request to the pending queue */
794         rc = ecore_spq_add_entry(p_hwfn, p_ent, p_ent->priority);
795         if (rc)
796                 goto spq_post_fail;
797
798         rc = ecore_spq_pend_post(p_hwfn);
799         if (rc) {
800                 /* Since it's possible that pending failed for a different
801                  * entry [although unlikely], the failed entry was already
802                  * dealt with; No need to return it here.
803                  */
804                 b_ret_ent = false;
805                 goto spq_post_fail;
806         }
807
808         OSAL_SPIN_UNLOCK(&p_spq->lock);
809
810         if (p_ent->comp_mode == ECORE_SPQ_MODE_EBLOCK) {
811                 /* For entries in ECORE BLOCK mode, the completion code cannot
812                  * perform the necessary cleanup - if it did, we couldn't
813                  * access p_ent here to see whether it's successful or not.
814                  * Thus, after gaining the answer perform the cleanup here.
815                  */
816                 rc = ecore_spq_block(p_hwfn, p_ent, fw_return_code,
817                                      p_ent->queue == &p_spq->unlimited_pending);
818
819                 if (p_ent->queue == &p_spq->unlimited_pending) {
820                         /* This is an allocated p_ent which does not need to
821                          * return to pool.
822                          */
823                         OSAL_FREE(p_hwfn->p_dev, p_ent);
824
825                         /* TBD: handle error flow and remove p_ent from
826                          * completion pending
827                          */
828                         return rc;
829                 }
830
831                 if (rc)
832                         goto spq_post_fail2;
833
834                 /* return to pool */
835                 ecore_spq_return_entry(p_hwfn, p_ent);
836         }
837         return rc;
838
839 spq_post_fail2:
840         OSAL_SPIN_LOCK(&p_spq->lock);
841         OSAL_LIST_REMOVE_ENTRY(&p_ent->list, &p_spq->completion_pending);
842         ecore_chain_return_produced(&p_spq->chain);
843
844 spq_post_fail:
845         /* return to the free pool */
846         if (b_ret_ent)
847                 __ecore_spq_return_entry(p_hwfn, p_ent);
848         OSAL_SPIN_UNLOCK(&p_spq->lock);
849
850         return rc;
851 }
852
853 enum _ecore_status_t ecore_spq_completion(struct ecore_hwfn *p_hwfn,
854                                           __le16 echo,
855                                           u8 fw_return_code,
856                                           union event_ring_data *p_data)
857 {
858         struct ecore_spq *p_spq;
859         struct ecore_spq_entry *p_ent = OSAL_NULL;
860         struct ecore_spq_entry *tmp;
861         struct ecore_spq_entry *found = OSAL_NULL;
862         enum _ecore_status_t rc;
863
864         if (!p_hwfn)
865                 return ECORE_INVAL;
866
867         p_spq = p_hwfn->p_spq;
868         if (!p_spq)
869                 return ECORE_INVAL;
870
871         OSAL_SPIN_LOCK(&p_spq->lock);
872         OSAL_LIST_FOR_EACH_ENTRY_SAFE(p_ent,
873                                       tmp,
874                                       &p_spq->completion_pending,
875                                       list, struct ecore_spq_entry) {
876                 if (p_ent->elem.hdr.echo == echo) {
877                         OSAL_LIST_REMOVE_ENTRY(&p_ent->list,
878                                                &p_spq->completion_pending);
879
880                         /* Avoid overriding of SPQ entries when getting
881                          * out-of-order completions, by marking the completions
882                          * in a bitmap and increasing the chain consumer only
883                          * for the first successive completed entries.
884                          */
885                         SPQ_COMP_BMAP_SET_BIT(p_spq, echo);
886                         while (SPQ_COMP_BMAP_TEST_BIT(p_spq,
887                                                       p_spq->comp_bitmap_idx)) {
888                                 SPQ_COMP_BMAP_CLEAR_BIT(p_spq,
889                                                         p_spq->comp_bitmap_idx);
890                                 p_spq->comp_bitmap_idx++;
891                                 ecore_chain_return_produced(&p_spq->chain);
892                         }
893
894                         p_spq->comp_count++;
895                         found = p_ent;
896                         break;
897                 }
898
899                 /* This is debug and should be relatively uncommon - depends
900                  * on scenarios which have mutliple per-PF sent ramrods.
901                  */
902                 DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
903                            "Got completion for echo %04x - doesn't match"
904                            " echo %04x in completion pending list\n",
905                            OSAL_LE16_TO_CPU(echo),
906                            OSAL_LE16_TO_CPU(p_ent->elem.hdr.echo));
907         }
908
909         /* Release lock before callback, as callback may post
910          * an additional ramrod.
911          */
912         OSAL_SPIN_UNLOCK(&p_spq->lock);
913
914         if (!found) {
915                 DP_NOTICE(p_hwfn, true,
916                           "Failed to find an entry this"
917                           " EQE [echo %04x] completes\n",
918                           OSAL_LE16_TO_CPU(echo));
919                 return ECORE_EXISTS;
920         }
921
922         DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
923                    "Complete EQE [echo %04x]: func %p cookie %p)\n",
924                    OSAL_LE16_TO_CPU(echo),
925                    p_ent->comp_cb.function, p_ent->comp_cb.cookie);
926         if (found->comp_cb.function)
927                 found->comp_cb.function(p_hwfn, found->comp_cb.cookie, p_data,
928                                         fw_return_code);
929         else
930                 DP_VERBOSE(p_hwfn, ECORE_MSG_SPQ,
931                            "Got a completion without a callback function\n");
932
933         if ((found->comp_mode != ECORE_SPQ_MODE_EBLOCK) ||
934             (found->queue == &p_spq->unlimited_pending))
935                 /* EBLOCK  is responsible for returning its own entry into the
936                  * free list, unless it originally added the entry into the
937                  * unlimited pending list.
938                  */
939                 ecore_spq_return_entry(p_hwfn, found);
940
941         /* Attempt to post pending requests */
942         OSAL_SPIN_LOCK(&p_spq->lock);
943         rc = ecore_spq_pend_post(p_hwfn);
944         OSAL_SPIN_UNLOCK(&p_spq->lock);
945
946         return rc;
947 }
948
949 struct ecore_consq *ecore_consq_alloc(struct ecore_hwfn *p_hwfn)
950 {
951         struct ecore_consq *p_consq;
952
953         /* Allocate ConsQ struct */
954         p_consq =
955             OSAL_ZALLOC(p_hwfn->p_dev, GFP_KERNEL, sizeof(*p_consq));
956         if (!p_consq) {
957                 DP_NOTICE(p_hwfn, true,
958                           "Failed to allocate `struct ecore_consq'\n");
959                 return OSAL_NULL;
960         }
961
962         /* Allocate and initialize EQ chain */
963         if (ecore_chain_alloc(p_hwfn->p_dev,
964                               ECORE_CHAIN_USE_TO_PRODUCE,
965                               ECORE_CHAIN_MODE_PBL,
966                               ECORE_CHAIN_CNT_TYPE_U16,
967                               ECORE_CHAIN_PAGE_SIZE / 0x80,
968                               0x80,
969                               &p_consq->chain, OSAL_NULL)) {
970                 DP_NOTICE(p_hwfn, true, "Failed to allocate consq chain");
971                 goto consq_allocate_fail;
972         }
973
974         return p_consq;
975
976 consq_allocate_fail:
977         ecore_consq_free(p_hwfn, p_consq);
978         return OSAL_NULL;
979 }
980
981 void ecore_consq_setup(struct ecore_hwfn *p_hwfn, struct ecore_consq *p_consq)
982 {
983         ecore_chain_reset(&p_consq->chain);
984 }
985
986 void ecore_consq_free(struct ecore_hwfn *p_hwfn, struct ecore_consq *p_consq)
987 {
988         if (!p_consq)
989                 return;
990         ecore_chain_free(p_hwfn->p_dev, &p_consq->chain);
991         OSAL_FREE(p_hwfn->p_dev, p_consq);
992 }