git.sur5r.net Git - u-boot/blob - arch/arm/mach-socfpga/scan_manager.c

   1 /*
   2  *  Copyright (C) 2013 Altera Corporation <www.altera.com>
   3  *
   4  * SPDX-License-Identifier:     GPL-2.0+
   5  */
   6
   7 #include <common.h>
   8 #include <asm/io.h>
   9 #include <asm/arch/freeze_controller.h>
  10 #include <asm/arch/scan_manager.h>
  11
  12 DECLARE_GLOBAL_DATA_PTR;
  13
  14 static const struct socfpga_scan_manager *scan_manager_base =
  15                 (void *)(SOCFPGA_SCANMGR_ADDRESS);
  16 static const struct socfpga_freeze_controller *freeze_controller_base =
  17                 (void *)(SOCFPGA_SYSMGR_ADDRESS + SYSMGR_FRZCTRL_ADDRESS);
  18
  19 /*
  20  * Function to check IO scan chain engine status and wait if the engine is
  21  * is active. Poll the IO scan chain engine till maximum iteration reached.
  22  */
  23 static inline uint32_t scan_chain_engine_is_idle(uint32_t max_iter)
  24 {
  25         uint32_t scanmgr_status;
  26
  27         scanmgr_status = readl(&scan_manager_base->stat);
  28
  29         /* Poll the engine until the scan engine is inactive */
  30         while (SCANMGR_STAT_ACTIVE_GET(scanmgr_status) ||
  31               (SCANMGR_STAT_WFIFOCNT_GET(scanmgr_status) > 0)) {
  32                 max_iter--;
  33                 if (max_iter > 0)
  34                         scanmgr_status = readl(&scan_manager_base->stat);
  35                 else
  36                         return 0;
  37         }
  38         return 1;
  39 }
  40
  41 /**
  42  * scan_mgr_io_scan_chain_prg() - Program HPS IO Scan Chain
  43  * @io_scan_chain_id:           IO scan chain ID
  44  * @io_scan_chain_len_in_bits:  IO scan chain length in bits
  45  * @iocsr_scan_chain:           IO scan chain table
  46  */
  47 static int scan_mgr_io_scan_chain_prg(const unsigned int io_scan_chain_id,
  48                                       uint32_t io_scan_chain_len_in_bits,
  49                                       const uint32_t *iocsr_scan_chain)
  50 {
  51         uint16_t tdi_tdo_header;
  52         uint32_t io_program_iter;
  53         uint32_t io_scan_chain_data_residual;
  54         uint32_t residual;
  55         uint32_t i;
  56         uint32_t index = 0;
  57
  58         /*
  59          * De-assert reinit if the IO scan chain is intended for HIO. In
  60          * this, its the chain 3.
  61          */
  62         if (io_scan_chain_id == 3)
  63                 clrbits_le32(&freeze_controller_base->hioctrl,
  64                              SYSMGR_FRZCTRL_HIOCTRL_DLLRST_MASK);
  65
  66         /*
  67          * Check if the scan chain engine is inactive and the
  68          * WFIFO is empty before enabling the IO scan chain
  69          */
  70         if (!scan_chain_engine_is_idle(SCAN_MAX_DELAY))
  71                 return 1;
  72
  73         /*
  74          * Enable IO Scan chain based on scan chain id
  75          * Note: only one chain can be enabled at a time
  76          */
  77         setbits_le32(&scan_manager_base->en, 1 << io_scan_chain_id);
  78
  79         /*
  80          * Calculate number of iteration needed for full 128-bit (4 x32-bits)
  81          * bits shifting. Each TDI_TDO packet can shift in maximum 128-bits
  82          */
  83         io_program_iter = io_scan_chain_len_in_bits >>
  84                 IO_SCAN_CHAIN_128BIT_SHIFT;
  85         io_scan_chain_data_residual = io_scan_chain_len_in_bits &
  86                 IO_SCAN_CHAIN_128BIT_MASK;
  87
  88         /* Construct TDI_TDO packet for 128-bit IO scan chain (2 bytes) */
  89         tdi_tdo_header = TDI_TDO_HEADER_FIRST_BYTE |
  90                 (TDI_TDO_MAX_PAYLOAD << TDI_TDO_HEADER_SECOND_BYTE_SHIFT);
  91
  92         /* Program IO scan chain in 128-bit iteration */
  93         for (i = 0; i < io_program_iter; i++) {
  94                 /* write TDI_TDO packet header to scan manager */
  95                 writel(tdi_tdo_header,  &scan_manager_base->fifo_double_byte);
  96
  97                 /* calculate array index. Multiply by 4 as write 4 x 32bits */
  98                 index = i * 4;
  99
 100                 /* write 4 successive 32-bit IO scan chain data into WFIFO */
 101                 writel(iocsr_scan_chain[index],
 102                        &scan_manager_base->fifo_quad_byte);
 103                 writel(iocsr_scan_chain[index + 1],
 104                        &scan_manager_base->fifo_quad_byte);
 105                 writel(iocsr_scan_chain[index + 2],
 106                        &scan_manager_base->fifo_quad_byte);
 107                 writel(iocsr_scan_chain[index + 3],
 108                        &scan_manager_base->fifo_quad_byte);
 109
 110                 /*
 111                  * Check if the scan chain engine has completed the
 112                  * IO scan chain data shifting
 113                  */
 114                 if (!scan_chain_engine_is_idle(SCAN_MAX_DELAY))
 115                         goto error;
 116         }
 117
 118         /* Calculate array index for final TDI_TDO packet */
 119         index = io_program_iter * 4;
 120
 121         /* Final TDI_TDO packet if any */
 122         if (io_scan_chain_data_residual) {
 123                 /*
 124                  * Calculate number of quad bytes FIFO write
 125                  * needed for the final TDI_TDO packet
 126                  */
 127                 io_program_iter = io_scan_chain_data_residual >>
 128                         IO_SCAN_CHAIN_32BIT_SHIFT;
 129
 130                 /*
 131                  * Construct TDI_TDO packet for remaining IO
 132                  * scan chain (2 bytes)
 133                  */
 134                 tdi_tdo_header  = TDI_TDO_HEADER_FIRST_BYTE |
 135                         ((io_scan_chain_data_residual - 1) <<
 136                         TDI_TDO_HEADER_SECOND_BYTE_SHIFT);
 137
 138                 /*
 139                  * Program the last part of IO scan chain write TDI_TDO packet
 140                  * header (2 bytes) to scan manager
 141                  */
 142                 writel(tdi_tdo_header, &scan_manager_base->fifo_double_byte);
 143
 144                 for (i = 0; i < io_program_iter; i++) {
 145                         /*
 146                          * write remaining scan chain data into scan
 147                          * manager WFIFO with 4 bytes write
 148                         */
 149                         writel(iocsr_scan_chain[index + i],
 150                                &scan_manager_base->fifo_quad_byte);
 151                 }
 152
 153                 index += io_program_iter;
 154                 residual = io_scan_chain_data_residual &
 155                         IO_SCAN_CHAIN_32BIT_MASK;
 156
 157                 if (IO_SCAN_CHAIN_PAYLOAD_24BIT < residual) {
 158                         /*
 159                          * write the last 4B scan chain data
 160                          * into scan manager WFIFO
 161                          */
 162                         writel(iocsr_scan_chain[index],
 163                                &scan_manager_base->fifo_quad_byte);
 164                 } else {
 165                         /*
 166                          * write the remaining 1 - 3 bytes scan chain
 167                          * data into scan manager WFIFO byte by byte
 168                          * to prevent JTAG engine shifting unused data
 169                          * from the FIFO and mistaken the data as a
 170                          * valid command (even though unused bits are
 171                          * set to 0, but just to prevent hardware
 172                          * glitch)
 173                          */
 174                         for (i = 0; i < residual; i += 8) {
 175                                 writel(((iocsr_scan_chain[index] >> i)
 176                                         & IO_SCAN_CHAIN_BYTE_MASK),
 177                                         &scan_manager_base->fifo_single_byte);
 178                         }
 179                 }
 180
 181                 /*
 182                  * Check if the scan chain engine has completed the
 183                  * IO scan chain data shifting
 184                  */
 185                 if (!scan_chain_engine_is_idle(SCAN_MAX_DELAY))
 186                         goto error;
 187         }
 188
 189         /* Disable IO Scan chain when configuration done*/
 190         clrbits_le32(&scan_manager_base->en, 1 << io_scan_chain_id);
 191         return 0;
 192
 193 error:
 194         /* Disable IO Scan chain when error detected */
 195         clrbits_le32(&scan_manager_base->en, 1 << io_scan_chain_id);
 196         return 1;
 197 }
 198
 199 int scan_mgr_configure_iocsr(void)
 200 {
 201         int status = 0;
 202
 203         /* configure the IOCSR through scan chain */
 204         status |= scan_mgr_io_scan_chain_prg(0,
 205                 CONFIG_HPS_IOCSR_SCANCHAIN0_LENGTH, iocsr_scan_chain0_table);
 206         status |= scan_mgr_io_scan_chain_prg(1,
 207                 CONFIG_HPS_IOCSR_SCANCHAIN1_LENGTH, iocsr_scan_chain1_table);
 208         status |= scan_mgr_io_scan_chain_prg(2,
 209                 CONFIG_HPS_IOCSR_SCANCHAIN2_LENGTH, iocsr_scan_chain2_table);
 210         status |= scan_mgr_io_scan_chain_prg(3,
 211                 CONFIG_HPS_IOCSR_SCANCHAIN3_LENGTH, iocsr_scan_chain3_table);
 212         return status;
 213 }