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