drivers/bus/fslmc/qbman/include/fsl_qbman_base.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (C) 2014 Freescale Semiconductor, Inc.
   4  *
   5  */
   6 #ifndef _FSL_QBMAN_BASE_H
   7 #define _FSL_QBMAN_BASE_H
   8
   9 typedef uint64_t  dma_addr_t;
  10
  11 /**
  12  * DOC: QBMan basic structures
  13  *
  14  * The QBMan block descriptor, software portal descriptor and Frame descriptor
  15  * are defined here.
  16  *
  17  */
  18
  19 /**
  20  * struct qbman_block_desc - qbman block descriptor structure
  21  * @ccsr_reg_bar: CCSR register map.
  22  * @irq_rerr: Recoverable error interrupt line.
  23  * @irq_nrerr: Non-recoverable error interrupt line
  24  *
  25  * Descriptor for a QBMan instance on the SoC. On partitions/targets that do not
  26  * control this QBMan instance, these values may simply be place-holders. The
  27  * idea is simply that we be able to distinguish between them, eg. so that SWP
  28  * descriptors can identify which QBMan instance they belong to.
  29  */
  30 struct qbman_block_desc {
  31         void *ccsr_reg_bar;
  32         int irq_rerr;
  33         int irq_nrerr;
  34 };
  35
  36 enum qbman_eqcr_mode {
  37         qman_eqcr_vb_ring = 2, /* Valid bit, with eqcr in ring mode */
  38         qman_eqcr_vb_array, /* Valid bit, with eqcr in array mode */
  39 };
  40
  41 /**
  42  * struct qbman_swp_desc - qbman software portal descriptor structure
  43  * @block: The QBMan instance.
  44  * @cena_bar: Cache-enabled portal register map.
  45  * @cinh_bar: Cache-inhibited portal register map.
  46  * @irq: -1 if unused (or unassigned)
  47  * @idx: SWPs within a QBMan are indexed. -1 if opaque to the user.
  48  * @qman_version: the qman version.
  49  * @eqcr_mode: Select the eqcr mode, currently only valid bit ring mode and
  50  * valid bit array mode are supported.
  51  *
  52  * Descriptor for a QBMan software portal, expressed in terms that make sense to
  53  * the user context. Ie. on MC, this information is likely to be true-physical,
  54  * and instantiated statically at compile-time. On GPP, this information is
  55  * likely to be obtained via "discovery" over a partition's "MC bus"
  56  * (ie. in response to a MC portal command), and would take into account any
  57  * virtualisation of the GPP user's address space and/or interrupt numbering.
  58  */
  59 struct qbman_swp_desc {
  60         const struct qbman_block_desc *block;
  61         uint8_t *cena_bar;
  62         uint8_t *cinh_bar;
  63         int irq;
  64         int idx;
  65         uint32_t qman_version;
  66         enum qbman_eqcr_mode eqcr_mode;
  67 };
  68
  69 /* Driver object for managing a QBMan portal */
  70 struct qbman_swp;
  71
  72 /**
  73  * struct qbman_fd - basci structure for qbman frame descriptor
  74  * @words: for easier/faster copying the whole FD structure.
  75  * @addr_lo: the lower 32 bits of the address in FD.
  76  * @addr_hi: the upper 32 bits of the address in FD.
  77  * @len: the length field in FD.
  78  * @bpid_offset: represent the bpid and offset fields in FD. offset in
  79  * the MS 16 bits, BPID in the LS 16 bits.
  80  * @frc: frame context
  81  * @ctrl: the 32bit control bits including dd, sc,... va, err.
  82  * @flc_lo: the lower 32bit of flow context.
  83  * @flc_hi: the upper 32bits of flow context.
  84  *
  85  * Place-holder for FDs, we represent it via the simplest form that we need for
  86  * now. Different overlays may be needed to support different options, etc. (It
  87  * is impractical to define One True Struct, because the resulting encoding
  88  * routines (lots of read-modify-writes) would be worst-case performance whether
  89  * or not circumstances required them.)
  90  *
  91  * Note, as with all data-structures exchanged between software and hardware (be
  92  * they located in the portal register map or DMA'd to and from main-memory),
  93  * the driver ensures that the caller of the driver API sees the data-structures
  94  * in host-endianness. "struct qbman_fd" is no exception. The 32-bit words
  95  * contained within this structure are represented in host-endianness, even if
  96  * hardware always treats them as little-endian. As such, if any of these fields
  97  * are interpreted in a binary (rather than numerical) fashion by hardware
  98  * blocks (eg. accelerators), then the user should be careful. We illustrate
  99  * with an example;
 100  *
 101  * Suppose the desired behaviour of an accelerator is controlled by the "frc"
 102  * field of the FDs that are sent to it. Suppose also that the behaviour desired
 103  * by the user corresponds to an "frc" value which is expressed as the literal
 104  * sequence of bytes 0xfe, 0xed, 0xab, and 0xba. So "frc" should be the 32-bit
 105  * value in which 0xfe is the first byte and 0xba is the last byte, and as
 106  * hardware is little-endian, this amounts to a 32-bit "value" of 0xbaabedfe. If
 107  * the software is little-endian also, this can simply be achieved by setting
 108  * frc=0xbaabedfe. On the other hand, if software is big-endian, it should set
 109  * frc=0xfeedabba! The best away of avoiding trouble with this sort of thing is
 110  * to treat the 32-bit words as numerical values, in which the offset of a field
 111  * from the beginning of the first byte (as required or generated by hardware)
 112  * is numerically encoded by a left-shift (ie. by raising the field to a
 113  * corresponding power of 2).  Ie. in the current example, software could set
 114  * "frc" in the following way, and it would work correctly on both little-endian
 115  * and big-endian operation;
 116  *    fd.frc = (0xfe << 0) | (0xed << 8) | (0xab << 16) | (0xba << 24);
 117  */
 118 struct qbman_fd {
 119         union {
 120                 uint32_t words[8];
 121                 struct qbman_fd_simple {
 122                         uint32_t addr_lo;
 123                         uint32_t addr_hi;
 124                         uint32_t len;
 125                         uint32_t bpid_offset;
 126                         uint32_t frc;
 127                         uint32_t ctrl;
 128                         uint32_t flc_lo;
 129                         uint32_t flc_hi;
 130                 } simple;
 131         };
 132 };
 133
 134 #endif /* !_FSL_QBMAN_BASE_H */