4 * Copyright (C) 2014 Freescale Semiconductor, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Freescale Semiconductor nor the
14 * names of its contributors may be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef _FSL_QBMAN_BASE_H
29 #define _FSL_QBMAN_BASE_H
31 typedef uint64_t dma_addr_t;
34 * DOC: QBMan basic structures
36 * The QBMan block descriptor, software portal descriptor and Frame descriptor
42 * struct qbman_block_desc - qbman block descriptor structure
43 * @ccsr_reg_bar: CCSR register map.
44 * @irq_rerr: Recoverable error interrupt line.
45 * @irq_nrerr: Non-recoverable error interrupt line
47 * Descriptor for a QBMan instance on the SoC. On partitions/targets that do not
48 * control this QBMan instance, these values may simply be place-holders. The
49 * idea is simply that we be able to distinguish between them, eg. so that SWP
50 * descriptors can identify which QBMan instance they belong to.
52 struct qbman_block_desc {
58 enum qbman_eqcr_mode {
59 qman_eqcr_vb_ring = 2, /* Valid bit, with eqcr in ring mode */
60 qman_eqcr_vb_array, /* Valid bit, with eqcr in array mode */
64 * struct qbman_swp_desc - qbman software portal descriptor structure
65 * @block: The QBMan instance.
66 * @cena_bar: Cache-enabled portal register map.
67 * @cinh_bar: Cache-inhibited portal register map.
68 * @irq: -1 if unused (or unassigned)
69 * @idx: SWPs within a QBMan are indexed. -1 if opaque to the user.
70 * @qman_version: the qman version.
71 * @eqcr_mode: Select the eqcr mode, currently only valid bit ring mode and
72 * valid bit array mode are supported.
74 * Descriptor for a QBMan software portal, expressed in terms that make sense to
75 * the user context. Ie. on MC, this information is likely to be true-physical,
76 * and instantiated statically at compile-time. On GPP, this information is
77 * likely to be obtained via "discovery" over a partition's "MC bus"
78 * (ie. in response to a MC portal command), and would take into account any
79 * virtualisation of the GPP user's address space and/or interrupt numbering.
81 struct qbman_swp_desc {
82 const struct qbman_block_desc *block;
87 uint32_t qman_version;
88 enum qbman_eqcr_mode eqcr_mode;
91 /* Driver object for managing a QBMan portal */
95 * struct qbman_fd - basci structure for qbman frame descriptor
96 * @words: for easier/faster copying the whole FD structure.
97 * @addr_lo: the lower 32 bits of the address in FD.
98 * @addr_hi: the upper 32 bits of the address in FD.
99 * @len: the length field in FD.
100 * @bpid_offset: represent the bpid and offset fields in FD. offset in
101 * the MS 16 bits, BPID in the LS 16 bits.
102 * @frc: frame context
103 * @ctrl: the 32bit control bits including dd, sc,... va, err.
104 * @flc_lo: the lower 32bit of flow context.
105 * @flc_hi: the upper 32bits of flow context.
107 * Place-holder for FDs, we represent it via the simplest form that we need for
108 * now. Different overlays may be needed to support different options, etc. (It
109 * is impractical to define One True Struct, because the resulting encoding
110 * routines (lots of read-modify-writes) would be worst-case performance whether
111 * or not circumstances required them.)
113 * Note, as with all data-structures exchanged between software and hardware (be
114 * they located in the portal register map or DMA'd to and from main-memory),
115 * the driver ensures that the caller of the driver API sees the data-structures
116 * in host-endianness. "struct qbman_fd" is no exception. The 32-bit words
117 * contained within this structure are represented in host-endianness, even if
118 * hardware always treats them as little-endian. As such, if any of these fields
119 * are interpreted in a binary (rather than numerical) fashion by hardware
120 * blocks (eg. accelerators), then the user should be careful. We illustrate
123 * Suppose the desired behaviour of an accelerator is controlled by the "frc"
124 * field of the FDs that are sent to it. Suppose also that the behaviour desired
125 * by the user corresponds to an "frc" value which is expressed as the literal
126 * sequence of bytes 0xfe, 0xed, 0xab, and 0xba. So "frc" should be the 32-bit
127 * value in which 0xfe is the first byte and 0xba is the last byte, and as
128 * hardware is little-endian, this amounts to a 32-bit "value" of 0xbaabedfe. If
129 * the software is little-endian also, this can simply be achieved by setting
130 * frc=0xbaabedfe. On the other hand, if software is big-endian, it should set
131 * frc=0xfeedabba! The best away of avoiding trouble with this sort of thing is
132 * to treat the 32-bit words as numerical values, in which the offset of a field
133 * from the beginning of the first byte (as required or generated by hardware)
134 * is numerically encoded by a left-shift (ie. by raising the field to a
135 * corresponding power of 2). Ie. in the current example, software could set
136 * "frc" in the following way, and it would work correctly on both little-endian
137 * and big-endian operation;
138 * fd.frc = (0xfe << 0) | (0xed << 8) | (0xab << 16) | (0xba << 24);
143 struct qbman_fd_simple {
147 uint32_t bpid_offset;
156 #endif /* !_FSL_QBMAN_BASE_H */