1*a2a55e51SPrabhakar Kushwaha /* 2*a2a55e51SPrabhakar Kushwaha * Copyright (C) 2014 Freescale Semiconductor 3*a2a55e51SPrabhakar Kushwaha * 4*a2a55e51SPrabhakar Kushwaha * SPDX-License-Identifier: GPL-2.0+ 5*a2a55e51SPrabhakar Kushwaha */ 6*a2a55e51SPrabhakar Kushwaha 7*a2a55e51SPrabhakar Kushwaha #ifndef _FSL_QBMAN_PORTAL_H 8*a2a55e51SPrabhakar Kushwaha #define _FSL_QBMAN_PORTAL_H 9*a2a55e51SPrabhakar Kushwaha 10*a2a55e51SPrabhakar Kushwaha #include <fsl-mc/fsl_qbman_base.h> 11*a2a55e51SPrabhakar Kushwaha 12*a2a55e51SPrabhakar Kushwaha /* Create and destroy a functional object representing the given QBMan portal 13*a2a55e51SPrabhakar Kushwaha * descriptor. */ 14*a2a55e51SPrabhakar Kushwaha struct qbman_swp *qbman_swp_init(const struct qbman_swp_desc *); 15*a2a55e51SPrabhakar Kushwaha 16*a2a55e51SPrabhakar Kushwaha /************/ 17*a2a55e51SPrabhakar Kushwaha /* Dequeues */ 18*a2a55e51SPrabhakar Kushwaha /************/ 19*a2a55e51SPrabhakar Kushwaha 20*a2a55e51SPrabhakar Kushwaha /* See the QBMan driver API documentation for details on the enqueue 21*a2a55e51SPrabhakar Kushwaha * mechanisms. NB: the use of a 'ldpaa_' prefix for this type is because it is 22*a2a55e51SPrabhakar Kushwaha * primarily used by the "DPIO" layer that sits above (and hides) the QBMan 23*a2a55e51SPrabhakar Kushwaha * driver. The structure is defined in the DPIO interface, but to avoid circular 24*a2a55e51SPrabhakar Kushwaha * dependencies we just pre/re-declare it here opaquely. */ 25*a2a55e51SPrabhakar Kushwaha struct ldpaa_dq; 26*a2a55e51SPrabhakar Kushwaha 27*a2a55e51SPrabhakar Kushwaha 28*a2a55e51SPrabhakar Kushwaha /* ------------------- */ 29*a2a55e51SPrabhakar Kushwaha /* Pull-mode dequeuing */ 30*a2a55e51SPrabhakar Kushwaha /* ------------------- */ 31*a2a55e51SPrabhakar Kushwaha 32*a2a55e51SPrabhakar Kushwaha struct qbman_pull_desc { 33*a2a55e51SPrabhakar Kushwaha uint32_t dont_manipulate_directly[6]; 34*a2a55e51SPrabhakar Kushwaha }; 35*a2a55e51SPrabhakar Kushwaha 36*a2a55e51SPrabhakar Kushwaha /* Clear the contents of a descriptor to default/starting state. */ 37*a2a55e51SPrabhakar Kushwaha void qbman_pull_desc_clear(struct qbman_pull_desc *); 38*a2a55e51SPrabhakar Kushwaha /* If not called, or if called with 'storage' as NULL, the result pull dequeues 39*a2a55e51SPrabhakar Kushwaha * will produce results to DQRR. If 'storage' is non-NULL, then results are 40*a2a55e51SPrabhakar Kushwaha * produced to the given memory location (using the physical/DMA address which 41*a2a55e51SPrabhakar Kushwaha * the caller provides in 'storage_phys'), and 'stash' controls whether or not 42*a2a55e51SPrabhakar Kushwaha * those writes to main-memory express a cache-warming attribute. */ 43*a2a55e51SPrabhakar Kushwaha void qbman_pull_desc_set_storage(struct qbman_pull_desc *, 44*a2a55e51SPrabhakar Kushwaha struct ldpaa_dq *storage, 45*a2a55e51SPrabhakar Kushwaha dma_addr_t storage_phys, 46*a2a55e51SPrabhakar Kushwaha int stash); 47*a2a55e51SPrabhakar Kushwaha /* numframes must be between 1 and 16, inclusive */ 48*a2a55e51SPrabhakar Kushwaha void qbman_pull_desc_set_numframes(struct qbman_pull_desc *, uint8_t numframes); 49*a2a55e51SPrabhakar Kushwaha /* token is the value that shows up in the dequeue results that can be used to 50*a2a55e51SPrabhakar Kushwaha * detect when the results have been published, and is not really used when 51*a2a55e51SPrabhakar Kushwaha * dequeue results go to DQRR. The easiest technique is to zero result "storage" 52*a2a55e51SPrabhakar Kushwaha * before issuing a pull dequeue, and use any non-zero 'token' value. */ 53*a2a55e51SPrabhakar Kushwaha void qbman_pull_desc_set_token(struct qbman_pull_desc *, uint8_t token); 54*a2a55e51SPrabhakar Kushwaha /* Exactly one of the following descriptor "actions" should be set. (Calling any 55*a2a55e51SPrabhakar Kushwaha * one of these will replace the effect of any prior call to one of these.) 56*a2a55e51SPrabhakar Kushwaha * - pull dequeue from the given frame queue (FQ) 57*a2a55e51SPrabhakar Kushwaha * - pull dequeue from any FQ in the given work queue (WQ) 58*a2a55e51SPrabhakar Kushwaha * - pull dequeue from any FQ in any WQ in the given channel 59*a2a55e51SPrabhakar Kushwaha */ 60*a2a55e51SPrabhakar Kushwaha void qbman_pull_desc_set_fq(struct qbman_pull_desc *, uint32_t fqid); 61*a2a55e51SPrabhakar Kushwaha 62*a2a55e51SPrabhakar Kushwaha /* Issue the pull dequeue command */ 63*a2a55e51SPrabhakar Kushwaha int qbman_swp_pull(struct qbman_swp *, struct qbman_pull_desc *); 64*a2a55e51SPrabhakar Kushwaha 65*a2a55e51SPrabhakar Kushwaha /* -------------------------------- */ 66*a2a55e51SPrabhakar Kushwaha /* Polling DQRR for dequeue results */ 67*a2a55e51SPrabhakar Kushwaha /* -------------------------------- */ 68*a2a55e51SPrabhakar Kushwaha 69*a2a55e51SPrabhakar Kushwaha /* NULL return if there are no unconsumed DQRR entries. Returns a DQRR entry 70*a2a55e51SPrabhakar Kushwaha * only once, so repeated calls can return a sequence of DQRR entries, without 71*a2a55e51SPrabhakar Kushwaha * requiring they be consumed immediately or in any particular order. */ 72*a2a55e51SPrabhakar Kushwaha const struct ldpaa_dq *qbman_swp_dqrr_next(struct qbman_swp *); 73*a2a55e51SPrabhakar Kushwaha /* Consume DQRR entries previously returned from qbman_swp_dqrr_next(). */ 74*a2a55e51SPrabhakar Kushwaha void qbman_swp_dqrr_consume(struct qbman_swp *, const struct ldpaa_dq *); 75*a2a55e51SPrabhakar Kushwaha 76*a2a55e51SPrabhakar Kushwaha /* ------------------------------------------------- */ 77*a2a55e51SPrabhakar Kushwaha /* Polling user-provided storage for dequeue results */ 78*a2a55e51SPrabhakar Kushwaha /* ------------------------------------------------- */ 79*a2a55e51SPrabhakar Kushwaha 80*a2a55e51SPrabhakar Kushwaha /* Only used for user-provided storage of dequeue results, not DQRR. Prior to 81*a2a55e51SPrabhakar Kushwaha * being used, the storage must set "oldtoken", so that the driver notices when 82*a2a55e51SPrabhakar Kushwaha * hardware has filled it in with results using a "newtoken". NB, for efficiency 83*a2a55e51SPrabhakar Kushwaha * purposes, the driver will perform any required endianness conversion to 84*a2a55e51SPrabhakar Kushwaha * ensure that the user's dequeue result storage is in host-endian format 85*a2a55e51SPrabhakar Kushwaha * (whether or not that is the same as the little-endian format that hardware 86*a2a55e51SPrabhakar Kushwaha * DMA'd to the user's storage). As such, once the user has called 87*a2a55e51SPrabhakar Kushwaha * qbman_dq_entry_has_newtoken() and been returned a valid dequeue result, they 88*a2a55e51SPrabhakar Kushwaha * should not call it again on the same memory location (except of course if 89*a2a55e51SPrabhakar Kushwaha * another dequeue command has been executed to produce a new result to that 90*a2a55e51SPrabhakar Kushwaha * location). 91*a2a55e51SPrabhakar Kushwaha */ 92*a2a55e51SPrabhakar Kushwaha void qbman_dq_entry_set_oldtoken(struct ldpaa_dq *, 93*a2a55e51SPrabhakar Kushwaha unsigned int num_entries, 94*a2a55e51SPrabhakar Kushwaha uint8_t oldtoken); 95*a2a55e51SPrabhakar Kushwaha int qbman_dq_entry_has_newtoken(struct qbman_swp *, 96*a2a55e51SPrabhakar Kushwaha const struct ldpaa_dq *, 97*a2a55e51SPrabhakar Kushwaha uint8_t newtoken); 98*a2a55e51SPrabhakar Kushwaha 99*a2a55e51SPrabhakar Kushwaha /* -------------------------------------------------------- */ 100*a2a55e51SPrabhakar Kushwaha /* Parsing dequeue entries (DQRR and user-provided storage) */ 101*a2a55e51SPrabhakar Kushwaha /* -------------------------------------------------------- */ 102*a2a55e51SPrabhakar Kushwaha 103*a2a55e51SPrabhakar Kushwaha /* DQRR entries may contain non-dequeue results, ie. notifications */ 104*a2a55e51SPrabhakar Kushwaha int qbman_dq_entry_is_DQ(const struct ldpaa_dq *); 105*a2a55e51SPrabhakar Kushwaha 106*a2a55e51SPrabhakar Kushwaha /************/ 107*a2a55e51SPrabhakar Kushwaha /* Enqueues */ 108*a2a55e51SPrabhakar Kushwaha /************/ 109*a2a55e51SPrabhakar Kushwaha 110*a2a55e51SPrabhakar Kushwaha struct qbman_eq_desc { 111*a2a55e51SPrabhakar Kushwaha uint32_t dont_manipulate_directly[8]; 112*a2a55e51SPrabhakar Kushwaha }; 113*a2a55e51SPrabhakar Kushwaha 114*a2a55e51SPrabhakar Kushwaha 115*a2a55e51SPrabhakar Kushwaha /* Clear the contents of a descriptor to default/starting state. */ 116*a2a55e51SPrabhakar Kushwaha void qbman_eq_desc_clear(struct qbman_eq_desc *); 117*a2a55e51SPrabhakar Kushwaha /* Exactly one of the following descriptor "actions" should be set. (Calling 118*a2a55e51SPrabhakar Kushwaha * any one of these will replace the effect of any prior call to one of these.) 119*a2a55e51SPrabhakar Kushwaha * - enqueue without order-restoration 120*a2a55e51SPrabhakar Kushwaha * - enqueue with order-restoration 121*a2a55e51SPrabhakar Kushwaha * - fill a hole in the order-restoration sequence, without any enqueue 122*a2a55e51SPrabhakar Kushwaha * - advance NESN (Next Expected Sequence Number), without any enqueue 123*a2a55e51SPrabhakar Kushwaha * 'respond_success' indicates whether an enqueue response should be DMA'd 124*a2a55e51SPrabhakar Kushwaha * after success (otherwise a response is DMA'd only after failure). 125*a2a55e51SPrabhakar Kushwaha * 'incomplete' indicates that other fragments of the same 'seqnum' are yet to 126*a2a55e51SPrabhakar Kushwaha * be enqueued. 127*a2a55e51SPrabhakar Kushwaha */ 128*a2a55e51SPrabhakar Kushwaha void qbman_eq_desc_set_no_orp(struct qbman_eq_desc *, int respond_success); 129*a2a55e51SPrabhakar Kushwaha void qbman_eq_desc_set_response(struct qbman_eq_desc *, 130*a2a55e51SPrabhakar Kushwaha dma_addr_t storage_phys, 131*a2a55e51SPrabhakar Kushwaha int stash); 132*a2a55e51SPrabhakar Kushwaha /* token is the value that shows up in an enqueue response that can be used to 133*a2a55e51SPrabhakar Kushwaha * detect when the results have been published. The easiest technique is to zero 134*a2a55e51SPrabhakar Kushwaha * result "storage" before issuing an enqueue, and use any non-zero 'token' 135*a2a55e51SPrabhakar Kushwaha * value. */ 136*a2a55e51SPrabhakar Kushwaha void qbman_eq_desc_set_token(struct qbman_eq_desc *, uint8_t token); 137*a2a55e51SPrabhakar Kushwaha /* Exactly one of the following descriptor "targets" should be set. (Calling any 138*a2a55e51SPrabhakar Kushwaha * one of these will replace the effect of any prior call to one of these.) 139*a2a55e51SPrabhakar Kushwaha * - enqueue to a frame queue 140*a2a55e51SPrabhakar Kushwaha * - enqueue to a queuing destination 141*a2a55e51SPrabhakar Kushwaha * Note, that none of these will have any affect if the "action" type has been 142*a2a55e51SPrabhakar Kushwaha * set to "orp_hole" or "orp_nesn". 143*a2a55e51SPrabhakar Kushwaha */ 144*a2a55e51SPrabhakar Kushwaha void qbman_eq_desc_set_fq(struct qbman_eq_desc *, uint32_t fqid); 145*a2a55e51SPrabhakar Kushwaha void qbman_eq_desc_set_qd(struct qbman_eq_desc *, uint32_t qdid, 146*a2a55e51SPrabhakar Kushwaha uint32_t qd_bin, uint32_t qd_prio); 147*a2a55e51SPrabhakar Kushwaha 148*a2a55e51SPrabhakar Kushwaha /* Issue an enqueue command. ('fd' should only be NULL if the "action" of the 149*a2a55e51SPrabhakar Kushwaha * descriptor is "orp_hole" or "orp_nesn".) */ 150*a2a55e51SPrabhakar Kushwaha int qbman_swp_enqueue(struct qbman_swp *, const struct qbman_eq_desc *, 151*a2a55e51SPrabhakar Kushwaha const struct qbman_fd *fd); 152*a2a55e51SPrabhakar Kushwaha 153*a2a55e51SPrabhakar Kushwaha /*******************/ 154*a2a55e51SPrabhakar Kushwaha /* Buffer releases */ 155*a2a55e51SPrabhakar Kushwaha /*******************/ 156*a2a55e51SPrabhakar Kushwaha 157*a2a55e51SPrabhakar Kushwaha struct qbman_release_desc { 158*a2a55e51SPrabhakar Kushwaha uint32_t dont_manipulate_directly[1]; 159*a2a55e51SPrabhakar Kushwaha }; 160*a2a55e51SPrabhakar Kushwaha 161*a2a55e51SPrabhakar Kushwaha /* Clear the contents of a descriptor to default/starting state. */ 162*a2a55e51SPrabhakar Kushwaha void qbman_release_desc_clear(struct qbman_release_desc *); 163*a2a55e51SPrabhakar Kushwaha /* Set the ID of the buffer pool to release to */ 164*a2a55e51SPrabhakar Kushwaha void qbman_release_desc_set_bpid(struct qbman_release_desc *, uint32_t bpid); 165*a2a55e51SPrabhakar Kushwaha /* Issue a release command. 'num_buffers' must be less than 8. */ 166*a2a55e51SPrabhakar Kushwaha int qbman_swp_release(struct qbman_swp *, const struct qbman_release_desc *, 167*a2a55e51SPrabhakar Kushwaha const uint64_t *buffers, unsigned int num_buffers); 168*a2a55e51SPrabhakar Kushwaha 169*a2a55e51SPrabhakar Kushwaha /*******************/ 170*a2a55e51SPrabhakar Kushwaha /* Buffer acquires */ 171*a2a55e51SPrabhakar Kushwaha /*******************/ 172*a2a55e51SPrabhakar Kushwaha 173*a2a55e51SPrabhakar Kushwaha int qbman_swp_acquire(struct qbman_swp *, uint32_t bpid, uint64_t *buffers, 174*a2a55e51SPrabhakar Kushwaha unsigned int num_buffers); 175*a2a55e51SPrabhakar Kushwaha #endif /* !_FSL_QBMAN_PORTAL_H */ 176