Imported Upstream version 17.05
[deb_dpdk.git] / drivers / bus / fslmc / qbman / qbman_sys.h
diff --git a/drivers/bus/fslmc/qbman/qbman_sys.h b/drivers/bus/fslmc/qbman/qbman_sys.h
new file mode 100644 (file)
index 0000000..5dbcaa5
--- /dev/null
@@ -0,0 +1,385 @@
+/*-
+ *   BSD LICENSE
+ *
+ * Copyright (C) 2014-2016 Freescale Semiconductor, Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Freescale Semiconductor nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/* qbman_sys_decl.h and qbman_sys.h are the two platform-specific files in the
+ * driver. They are only included via qbman_private.h, which is itself a
+ * platform-independent file and is included by all the other driver source.
+ *
+ * qbman_sys_decl.h is included prior to all other declarations and logic, and
+ * it exists to provide compatibility with any linux interfaces our
+ * single-source driver code is dependent on (eg. kmalloc). Ie. this file
+ * provides linux compatibility.
+ *
+ * This qbman_sys.h header, on the other hand, is included *after* any common
+ * and platform-neutral declarations and logic in qbman_private.h, and exists to
+ * implement any platform-specific logic of the qbman driver itself. Ie. it is
+ * *not* to provide linux compatibility.
+ */
+
+/* Trace the 3 different classes of read/write access to QBMan. #undef as
+ * required.
+ */
+#undef QBMAN_CCSR_TRACE
+#undef QBMAN_CINH_TRACE
+#undef QBMAN_CENA_TRACE
+
+static inline void word_copy(void *d, const void *s, unsigned int cnt)
+{
+       uint32_t *dd = d;
+       const uint32_t *ss = s;
+
+       while (cnt--)
+               *(dd++) = *(ss++);
+}
+
+/* Currently, the CENA support code expects each 32-bit word to be written in
+ * host order, and these are converted to hardware (little-endian) order on
+ * command submission. However, 64-bit quantities are must be written (and read)
+ * as two 32-bit words with the least-significant word first, irrespective of
+ * host endianness.
+ */
+static inline void u64_to_le32_copy(void *d, const uint64_t *s,
+                                   unsigned int cnt)
+{
+       uint32_t *dd = d;
+       const uint32_t *ss = (const uint32_t *)s;
+
+       while (cnt--) {
+               /* TBD: the toolchain was choking on the use of 64-bit types up
+                * until recently so this works entirely with 32-bit variables.
+                * When 64-bit types become usable again, investigate better
+                * ways of doing this.
+                */
+#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+               *(dd++) = ss[1];
+               *(dd++) = ss[0];
+               ss += 2;
+#else
+               *(dd++) = *(ss++);
+               *(dd++) = *(ss++);
+#endif
+       }
+}
+
+static inline void u64_from_le32_copy(uint64_t *d, const void *s,
+                                     unsigned int cnt)
+{
+       const uint32_t *ss = s;
+       uint32_t *dd = (uint32_t *)d;
+
+       while (cnt--) {
+#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+               dd[1] = *(ss++);
+               dd[0] = *(ss++);
+               dd += 2;
+#else
+               *(dd++) = *(ss++);
+               *(dd++) = *(ss++);
+#endif
+       }
+}
+
+/* Convert a host-native 32bit value into little endian */
+#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+static inline uint32_t make_le32(uint32_t val)
+{
+       return ((val & 0xff) << 24) | ((val & 0xff00) << 8) |
+               ((val & 0xff0000) >> 8) | ((val & 0xff000000) >> 24);
+}
+
+static inline uint32_t make_le24(uint32_t val)
+{
+       return (((val & 0xff) << 16) | (val & 0xff00) |
+               ((val & 0xff0000) >> 16));
+}
+
+static inline void make_le32_n(uint32_t *val, unsigned int num)
+{
+       while (num--) {
+               *val = make_le32(*val);
+               val++;
+       }
+}
+
+#else
+#define make_le32(val) (val)
+#define make_le24(val) (val)
+#define make_le32_n(val, len) do {} while (0)
+#endif
+
+       /******************/
+       /* Portal access  */
+       /******************/
+struct qbman_swp_sys {
+       /* On GPP, the sys support for qbman_swp is here. The CENA region isi
+        * not an mmap() of the real portal registers, but an allocated
+        * place-holder, because the actual writes/reads to/from the portal are
+        * marshalled from these allocated areas using QBMan's "MC access
+        * registers". CINH accesses are atomic so there's no need for a
+        * place-holder.
+        */
+       uint8_t *cena;
+       uint8_t __iomem *addr_cena;
+       uint8_t __iomem *addr_cinh;
+       uint32_t idx;
+       enum qbman_eqcr_mode eqcr_mode;
+};
+
+/* P_OFFSET is (ACCESS_CMD,0,12) - offset within the portal
+ * C is (ACCESS_CMD,12,1) - is inhibited? (0==CENA, 1==CINH)
+ * SWP_IDX is (ACCESS_CMD,16,10) - Software portal index
+ * P is (ACCESS_CMD,28,1) - (0==special portal, 1==any portal)
+ * T is (ACCESS_CMD,29,1) - Command type (0==READ, 1==WRITE)
+ * E is (ACCESS_CMD,31,1) - Command execute (1 to issue, poll for 0==complete)
+ */
+
+static inline void qbman_cinh_write(struct qbman_swp_sys *s, uint32_t offset,
+                                   uint32_t val)
+{
+       __raw_writel(val, s->addr_cinh + offset);
+#ifdef QBMAN_CINH_TRACE
+       pr_info("qbman_cinh_write(%p:%d:0x%03x) 0x%08x\n",
+               s->addr_cinh, s->idx, offset, val);
+#endif
+}
+
+static inline uint32_t qbman_cinh_read(struct qbman_swp_sys *s, uint32_t offset)
+{
+       uint32_t reg = __raw_readl(s->addr_cinh + offset);
+#ifdef QBMAN_CINH_TRACE
+       pr_info("qbman_cinh_read(%p:%d:0x%03x) 0x%08x\n",
+               s->addr_cinh, s->idx, offset, reg);
+#endif
+       return reg;
+}
+
+static inline void *qbman_cena_write_start(struct qbman_swp_sys *s,
+                                          uint32_t offset)
+{
+       void *shadow = s->cena + offset;
+
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_write_start(%p:%d:0x%03x) %p\n",
+               s->addr_cena, s->idx, offset, shadow);
+#endif
+       QBMAN_BUG_ON(offset & 63);
+       dcbz(shadow);
+       return shadow;
+}
+
+static inline void *qbman_cena_write_start_wo_shadow(struct qbman_swp_sys *s,
+                                                    uint32_t offset)
+{
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_write_start(%p:%d:0x%03x)\n",
+               s->addr_cena, s->idx, offset);
+#endif
+       QBMAN_BUG_ON(offset & 63);
+       return (s->addr_cena + offset);
+}
+
+static inline void qbman_cena_write_complete(struct qbman_swp_sys *s,
+                                            uint32_t offset, void *cmd)
+{
+       const uint32_t *shadow = cmd;
+       int loop;
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_write_complete(%p:%d:0x%03x) %p\n",
+               s->addr_cena, s->idx, offset, shadow);
+       hexdump(cmd, 64);
+#endif
+       for (loop = 15; loop >= 1; loop--)
+               __raw_writel(shadow[loop], s->addr_cena +
+                                        offset + loop * 4);
+       lwsync();
+               __raw_writel(shadow[0], s->addr_cena + offset);
+       dcbf(s->addr_cena + offset);
+}
+
+static inline void qbman_cena_write_complete_wo_shadow(struct qbman_swp_sys *s,
+                                                      uint32_t offset)
+{
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_write_complete(%p:%d:0x%03x)\n",
+               s->addr_cena, s->idx, offset);
+       hexdump(cmd, 64);
+#endif
+       dcbf(s->addr_cena + offset);
+}
+
+static inline uint32_t qbman_cena_read_reg(struct qbman_swp_sys *s,
+                                          uint32_t offset)
+{
+       return __raw_readl(s->addr_cena + offset);
+}
+
+static inline void *qbman_cena_read(struct qbman_swp_sys *s, uint32_t offset)
+{
+       uint32_t *shadow = (uint32_t *)(s->cena + offset);
+       unsigned int loop;
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_read(%p:%d:0x%03x) %p\n",
+               s->addr_cena, s->idx, offset, shadow);
+#endif
+
+       for (loop = 0; loop < 16; loop++)
+               shadow[loop] = __raw_readl(s->addr_cena + offset
+                                       + loop * 4);
+#ifdef QBMAN_CENA_TRACE
+       hexdump(shadow, 64);
+#endif
+       return shadow;
+}
+
+static inline void *qbman_cena_read_wo_shadow(struct qbman_swp_sys *s,
+                                             uint32_t offset)
+{
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_read(%p:%d:0x%03x) %p\n",
+               s->addr_cena, s->idx, offset, shadow);
+#endif
+
+#ifdef QBMAN_CENA_TRACE
+       hexdump(shadow, 64);
+#endif
+       return s->addr_cena + offset;
+}
+
+static inline void qbman_cena_invalidate(struct qbman_swp_sys *s,
+                                        uint32_t offset)
+{
+       dccivac(s->addr_cena + offset);
+}
+
+static inline void qbman_cena_invalidate_prefetch(struct qbman_swp_sys *s,
+                                                 uint32_t offset)
+{
+       dccivac(s->addr_cena + offset);
+       prefetch_for_load(s->addr_cena + offset);
+}
+
+static inline void qbman_cena_prefetch(struct qbman_swp_sys *s,
+                                      uint32_t offset)
+{
+       prefetch_for_load(s->addr_cena + offset);
+}
+
+       /******************/
+       /* Portal support */
+       /******************/
+
+/* The SWP_CFG portal register is special, in that it is used by the
+ * platform-specific code rather than the platform-independent code in
+ * qbman_portal.c. So use of it is declared locally here.
+ */
+#define QBMAN_CINH_SWP_CFG   0xd00
+
+/* For MC portal use, we always configure with
+ * DQRR_MF is (SWP_CFG,20,3) - DQRR max fill (<- 0x4)
+ * EST is (SWP_CFG,16,3) - EQCR_CI stashing threshold (<- 0x2)
+ * RPM is (SWP_CFG,12,2) - RCR production notification mode (<- 0x3)
+ * DCM is (SWP_CFG,10,2) - DQRR consumption notification mode (<- 0x2)
+ * EPM is (SWP_CFG,8,2) - EQCR production notification mode (<- 0x2)
+ * SD is (SWP_CFG,5,1) - memory stashing drop enable (<- TRUE)
+ * SP is (SWP_CFG,4,1) - memory stashing priority (<- TRUE)
+ * SE is (SWP_CFG,3,1) - memory stashing enable (<- TRUE)
+ * DP is (SWP_CFG,2,1) - dequeue stashing priority (<- TRUE)
+ * DE is (SWP_CFG,1,1) - dequeue stashing enable (<- TRUE)
+ * EP is (SWP_CFG,0,1) - EQCR_CI stashing priority (<- TRUE)
+ */
+static inline uint32_t qbman_set_swp_cfg(uint8_t max_fill, uint8_t wn,
+                                        uint8_t est, uint8_t rpm, uint8_t dcm,
+                                       uint8_t epm, int sd, int sp, int se,
+                                       int dp, int de, int ep)
+{
+       uint32_t reg;
+
+       reg = e32_uint8_t(20, (uint32_t)(3 + (max_fill >> 3)), max_fill) |
+               e32_uint8_t(16, 3, est) |
+               e32_uint8_t(12, 2, rpm) | e32_uint8_t(10, 2, dcm) |
+               e32_uint8_t(8, 2, epm) | e32_int(5, 1, sd) |
+               e32_int(4, 1, sp) | e32_int(3, 1, se) | e32_int(2, 1, dp) |
+               e32_int(1, 1, de) | e32_int(0, 1, ep) | e32_uint8_t(14, 1, wn);
+       return reg;
+}
+
+static inline int qbman_swp_sys_init(struct qbman_swp_sys *s,
+                                    const struct qbman_swp_desc *d,
+                                    uint8_t dqrr_size)
+{
+       uint32_t reg;
+
+       s->addr_cena = d->cena_bar;
+       s->addr_cinh = d->cinh_bar;
+       s->idx = (uint32_t)d->idx;
+       s->cena = (void *)get_zeroed_page(GFP_KERNEL);
+       if (!s->cena) {
+               pr_err("Could not allocate page for cena shadow\n");
+               return -1;
+       }
+       s->eqcr_mode = d->eqcr_mode;
+       QBMAN_BUG_ON(d->idx < 0);
+#ifdef QBMAN_CHECKING
+       /* We should never be asked to initialise for a portal that isn't in
+        * the power-on state. (Ie. don't forget to reset portals when they are
+        * decommissioned!)
+        */
+       reg = qbman_cinh_read(s, QBMAN_CINH_SWP_CFG);
+       QBMAN_BUG_ON(reg);
+#endif
+       if (s->eqcr_mode == qman_eqcr_vb_array)
+               reg = qbman_set_swp_cfg(dqrr_size, 0, 0, 3, 2, 3, 1, 1, 1, 1,
+                                       1, 1);
+       else
+               reg = qbman_set_swp_cfg(dqrr_size, 0, 2, 3, 2, 2, 1, 1, 1, 1,
+                                       1, 1);
+       qbman_cinh_write(s, QBMAN_CINH_SWP_CFG, reg);
+       reg = qbman_cinh_read(s, QBMAN_CINH_SWP_CFG);
+       if (!reg) {
+               pr_err("The portal %d is not enabled!\n", s->idx);
+               kfree(s->cena);
+               return -1;
+       }
+       return 0;
+}
+
+static inline void qbman_swp_sys_finish(struct qbman_swp_sys *s)
+{
+       free_page((unsigned long)s->cena);
+}
+
+static inline void *
+qbman_cena_write_start_wo_shadow_fast(struct qbman_swp_sys *s,
+                                     uint32_t offset)
+{
+#ifdef QBMAN_CENA_TRACE
+       pr_info("qbman_cena_write_start(%p:%d:0x%03x)\n",
+               s->addr_cena, s->idx, offset);
+#endif
+       QBMAN_BUG_ON(offset & 63);
+       return (s->addr_cena + offset);
+}