]> git.karo-electronics.de Git - karo-tx-uboot.git/blobdiff - arch/arm/mach-socfpga/scan_manager.c
arm: socfpga: scan: Clean up horrible macros
[karo-tx-uboot.git] / arch / arm / mach-socfpga / scan_manager.c
index a820b1b1bfcb5d8c674a8f21c26f048fac927fc2..dd32195d6a436d19773817bd797419b8b896d6de 100644 (file)
@@ -5,10 +5,28 @@
  */
 
 #include <common.h>
+#include <errno.h>
 #include <asm/io.h>
 #include <asm/arch/freeze_controller.h>
 #include <asm/arch/scan_manager.h>
 
+/*
+ * Maximum polling loop to wait for IO scan chain engine becomes idle
+ * to prevent infinite loop. It is important that this is NOT changed
+ * to delay using timer functions, since at the time this function is
+ * called, timer might not yet be inited.
+ */
+#define SCANMGR_MAX_DELAY              100
+
+/*
+ * Maximum length of TDI_TDO packet payload is 128 bits,
+ * represented by (length - 1) in TDI_TDO header.
+ */
+#define TDI_TDO_MAX_PAYLOAD            127
+
+#define SCANMGR_STAT_ACTIVE            (1 << 31)
+#define SCANMGR_STAT_WFIFOCNT_MASK     0x70000000
+
 DECLARE_GLOBAL_DATA_PTR;
 
 static const struct socfpga_scan_manager *scan_manager_base =
@@ -16,40 +34,88 @@ static const struct socfpga_scan_manager *scan_manager_base =
 static const struct socfpga_freeze_controller *freeze_controller_base =
                (void *)(SOCFPGA_SYSMGR_ADDRESS + SYSMGR_FRZCTRL_ADDRESS);
 
-/*
+/**
+ * scan_chain_engine_is_idle() - Check if the JTAG scan chain is idle
+ * @max_iter:  Maximum number of iterations to wait for idle
+ *
  * Function to check IO scan chain engine status and wait if the engine is
  * is active. Poll the IO scan chain engine till maximum iteration reached.
  */
-static inline uint32_t scan_chain_engine_is_idle(uint32_t max_iter)
+static u32 scan_chain_engine_is_idle(u32 max_iter)
 {
-       uint32_t scanmgr_status;
-
-       scanmgr_status = readl(&scan_manager_base->stat);
+       const u32 mask = SCANMGR_STAT_ACTIVE | SCANMGR_STAT_WFIFOCNT_MASK;
+       u32 status;
 
-       /* Poll the engine until the scan engine is inactive */
-       while (SCANMGR_STAT_ACTIVE_GET(scanmgr_status) ||
-             (SCANMGR_STAT_WFIFOCNT_GET(scanmgr_status) > 0)) {
-               max_iter--;
-               if (max_iter > 0)
-                       scanmgr_status = readl(&scan_manager_base->stat);
-               else
+       /* Poll the engine until the scan engine is inactive. */
+       do {
+               status = readl(&scan_manager_base->stat);
+               if (!(status & mask))
                        return 0;
+       } while (max_iter--);
+
+       return -ETIMEDOUT;
+}
+
+#define JTAG_BP_INSN           (1 << 0)
+#define JTAG_BP_TMS            (1 << 1)
+#define JTAG_BP_PAYLOAD                (1 << 2)
+#define JTAG_BP_2BYTE          (1 << 3)
+#define JTAG_BP_4BYTE          (1 << 4)
+
+/**
+ * scan_mgr_jtag_io() - Access the JTAG chain
+ * @flags:     Control flags, used to configure the action on the JTAG
+ * @iarg:      Instruction argument
+ * @parg:      Payload argument or data
+ *
+ * Perform I/O on the JTAG chain
+ */
+static void scan_mgr_jtag_io(const u32 flags, const u8 iarg, const u32 parg)
+{
+       u32 data = parg;
+
+       if (flags & JTAG_BP_INSN) {     /* JTAG instruction */
+               /*
+                * The SCC JTAG register is LSB first, so make
+                * space for the instruction at the LSB.
+                */
+               data <<= 8;
+               if (flags & JTAG_BP_TMS) {
+                       data |= (0 << 7);       /* TMS instruction. */
+                       data |= iarg & 0x3f;    /* TMS arg is 6 bits. */
+                       if (flags & JTAG_BP_PAYLOAD)
+                               data |= (1 << 6);
+               } else {
+                       data |= (1 << 7);       /* TDI/TDO instruction. */
+                       data |= iarg & 0xf;     /* TDI/TDO arg is 4 bits. */
+                       if (flags & JTAG_BP_PAYLOAD)
+                               data |= (1 << 4);
+               }
        }
-       return 1;
+
+       if (flags & JTAG_BP_4BYTE)
+               writel(data, &scan_manager_base->fifo_quad_byte);
+       else if (flags & JTAG_BP_2BYTE)
+               writel(data & 0xffff, &scan_manager_base->fifo_double_byte);
+       else
+               writel(data & 0xff, &scan_manager_base->fifo_single_byte);
 }
 
-/* Program HPS IO Scan Chain */
-uint32_t scan_mgr_io_scan_chain_prg(
-       uint32_t io_scan_chain_id,
-       uint32_t io_scan_chain_len_in_bits,
-       const uint32_t *iocsr_scan_chain)
+/**
+ * scan_mgr_io_scan_chain_prg() - Program HPS IO Scan Chain
+ * @io_scan_chain_id:          IO scan chain ID
+ */
+static int scan_mgr_io_scan_chain_prg(const unsigned int io_scan_chain_id)
 {
-       uint16_t tdi_tdo_header;
-       uint32_t io_program_iter;
-       uint32_t io_scan_chain_data_residual;
-       uint32_t residual;
-       uint32_t i;
-       uint32_t index = 0;
+       u32 residual;
+       u32 io_scan_chain_len_in_bits;
+       const unsigned long *iocsr_scan_chain;
+       int i, ret, index = 0;
+
+       ret = iocsr_get_config_table(io_scan_chain_id, &iocsr_scan_chain,
+                                    &io_scan_chain_len_in_bits);
+       if (ret)
+               return 1;
 
        /*
         * De-assert reinit if the IO scan chain is intended for HIO. In
@@ -63,8 +129,9 @@ uint32_t scan_mgr_io_scan_chain_prg(
         * Check if the scan chain engine is inactive and the
         * WFIFO is empty before enabling the IO scan chain
         */
-       if (!scan_chain_engine_is_idle(SCAN_MAX_DELAY))
-               return 1;
+       ret = scan_chain_engine_is_idle(SCANMGR_MAX_DELAY);
+       if (ret)
+               return ret;
 
        /*
         * Enable IO Scan chain based on scan chain id
@@ -72,91 +139,55 @@ uint32_t scan_mgr_io_scan_chain_prg(
         */
        setbits_le32(&scan_manager_base->en, 1 << io_scan_chain_id);
 
-       /*
-        * Calculate number of iteration needed for full 128-bit (4 x32-bits)
-        * bits shifting. Each TDI_TDO packet can shift in maximum 128-bits
-        */
-       io_program_iter = io_scan_chain_len_in_bits >>
-               IO_SCAN_CHAIN_128BIT_SHIFT;
-       io_scan_chain_data_residual = io_scan_chain_len_in_bits &
-               IO_SCAN_CHAIN_128BIT_MASK;
-
-       /* Construct TDI_TDO packet for 128-bit IO scan chain (2 bytes) */
-       tdi_tdo_header = TDI_TDO_HEADER_FIRST_BYTE |
-               (TDI_TDO_MAX_PAYLOAD << TDI_TDO_HEADER_SECOND_BYTE_SHIFT);
-
        /* Program IO scan chain in 128-bit iteration */
-       for (i = 0; i < io_program_iter; i++) {
-               /* write TDI_TDO packet header to scan manager */
-               writel(tdi_tdo_header,  &scan_manager_base->fifo_double_byte);
-
-               /* calculate array index. Multiply by 4 as write 4 x 32bits */
-               index = i * 4;
+       for (i = 0; i < io_scan_chain_len_in_bits / 128; i++) {
+               /* Write TDI_TDO packet header for 128-bit IO scan chain */
+               scan_mgr_jtag_io(JTAG_BP_INSN | JTAG_BP_2BYTE, 0x0,
+                                TDI_TDO_MAX_PAYLOAD);
 
                /* write 4 successive 32-bit IO scan chain data into WFIFO */
-               writel(iocsr_scan_chain[index],
-                      &scan_manager_base->fifo_quad_byte);
-               writel(iocsr_scan_chain[index + 1],
-                      &scan_manager_base->fifo_quad_byte);
-               writel(iocsr_scan_chain[index + 2],
-                      &scan_manager_base->fifo_quad_byte);
-               writel(iocsr_scan_chain[index + 3],
-                      &scan_manager_base->fifo_quad_byte);
+               scan_mgr_jtag_io(JTAG_BP_4BYTE, 0x0, iocsr_scan_chain[index++]);
+               scan_mgr_jtag_io(JTAG_BP_4BYTE, 0x0, iocsr_scan_chain[index++]);
+               scan_mgr_jtag_io(JTAG_BP_4BYTE, 0x0, iocsr_scan_chain[index++]);
+               scan_mgr_jtag_io(JTAG_BP_4BYTE, 0x0, iocsr_scan_chain[index++]);
 
                /*
                 * Check if the scan chain engine has completed the
                 * IO scan chain data shifting
                 */
-               if (!scan_chain_engine_is_idle(SCAN_MAX_DELAY))
+               ret = scan_chain_engine_is_idle(SCANMGR_MAX_DELAY);
+               if (ret)
                        goto error;
        }
 
-       /* Calculate array index for final TDI_TDO packet */
-       index = io_program_iter * 4;
+       residual = io_scan_chain_len_in_bits % 128;
 
-       /* Final TDI_TDO packet if any */
-       if (io_scan_chain_data_residual) {
+       /* Final TDI_TDO packet (if chain length is not aligned to 128 bits) */
+       if (residual) {
                /*
-                * Calculate number of quad bytes FIFO write
-                * needed for the final TDI_TDO packet
+                * Program the last part of IO scan chain write TDI_TDO
+                * packet header (2 bytes) to scan manager.
                 */
-               io_program_iter = io_scan_chain_data_residual >>
-                       IO_SCAN_CHAIN_32BIT_SHIFT;
+               scan_mgr_jtag_io(JTAG_BP_INSN | JTAG_BP_2BYTE, 0x0,
+                                residual - 1);
 
-               /*
-                * Construct TDI_TDO packet for remaining IO
-                * scan chain (2 bytes)
-                */
-               tdi_tdo_header  = TDI_TDO_HEADER_FIRST_BYTE |
-                       ((io_scan_chain_data_residual - 1) <<
-                       TDI_TDO_HEADER_SECOND_BYTE_SHIFT);
-
-               /*
-                * Program the last part of IO scan chain write TDI_TDO packet
-                * header (2 bytes) to scan manager
-                */
-               writel(tdi_tdo_header, &scan_manager_base->fifo_double_byte);
-
-               for (i = 0; i < io_program_iter; i++) {
+               for (i = 0; i < residual / 32; i++) {
                        /*
                         * write remaining scan chain data into scan
                         * manager WFIFO with 4 bytes write
-                       */
-                       writel(iocsr_scan_chain[index + i],
-                              &scan_manager_base->fifo_quad_byte);
+                        */
+                       scan_mgr_jtag_io(JTAG_BP_4BYTE, 0x0,
+                                        iocsr_scan_chain[index++]);
                }
 
-               index += io_program_iter;
-               residual = io_scan_chain_data_residual &
-                       IO_SCAN_CHAIN_32BIT_MASK;
-
-               if (IO_SCAN_CHAIN_PAYLOAD_24BIT < residual) {
+               residual = io_scan_chain_len_in_bits % 32;
+               if (residual > 24) {
                        /*
                         * write the last 4B scan chain data
                         * into scan manager WFIFO
                         */
-                       writel(iocsr_scan_chain[index],
-                              &scan_manager_base->fifo_quad_byte);
+                       scan_mgr_jtag_io(JTAG_BP_4BYTE, 0x0,
+                                        iocsr_scan_chain[index]);
                } else {
                        /*
                         * write the remaining 1 - 3 bytes scan chain
@@ -168,9 +199,8 @@ uint32_t scan_mgr_io_scan_chain_prg(
                         * glitch)
                         */
                        for (i = 0; i < residual; i += 8) {
-                               writel(((iocsr_scan_chain[index] >> i)
-                                       & IO_SCAN_CHAIN_BYTE_MASK),
-                                       &scan_manager_base->fifo_single_byte);
+                               scan_mgr_jtag_io(0, 0x0,
+                                        iocsr_scan_chain[index] >> i);
                        }
                }
 
@@ -178,7 +208,8 @@ uint32_t scan_mgr_io_scan_chain_prg(
                 * Check if the scan chain engine has completed the
                 * IO scan chain data shifting
                 */
-               if (!scan_chain_engine_is_idle(SCAN_MAX_DELAY))
+               ret = scan_chain_engine_is_idle(SCANMGR_MAX_DELAY);
+               if (ret)
                        goto error;
        }
 
@@ -189,7 +220,7 @@ uint32_t scan_mgr_io_scan_chain_prg(
 error:
        /* Disable IO Scan chain when error detected */
        clrbits_le32(&scan_manager_base->en, 1 << io_scan_chain_id);
-       return 1;
+       return ret;
 }
 
 int scan_mgr_configure_iocsr(void)
@@ -197,13 +228,9 @@ int scan_mgr_configure_iocsr(void)
        int status = 0;
 
        /* configure the IOCSR through scan chain */
-       status |= scan_mgr_io_scan_chain_prg(0,
-               CONFIG_HPS_IOCSR_SCANCHAIN0_LENGTH, iocsr_scan_chain0_table);
-       status |= scan_mgr_io_scan_chain_prg(1,
-               CONFIG_HPS_IOCSR_SCANCHAIN1_LENGTH, iocsr_scan_chain1_table);
-       status |= scan_mgr_io_scan_chain_prg(2,
-               CONFIG_HPS_IOCSR_SCANCHAIN2_LENGTH, iocsr_scan_chain2_table);
-       status |= scan_mgr_io_scan_chain_prg(3,
-               CONFIG_HPS_IOCSR_SCANCHAIN3_LENGTH, iocsr_scan_chain3_table);
+       status |= scan_mgr_io_scan_chain_prg(0);
+       status |= scan_mgr_io_scan_chain_prg(1);
+       status |= scan_mgr_io_scan_chain_prg(2);
+       status |= scan_mgr_io_scan_chain_prg(3);
        return status;
 }