[U-Boot] [PATCH] spi/cadence: Adding Cadence SPI driver support for SOCFPGA

Jagan Teki jagannadh.teki at gmail.com
Thu Dec 19 17:09:57 CET 2013


Thanks for your patch.

Please see the typical driver code suggestions on below thread.
http://u-boot.10912.n7.nabble.com/Suggestions-for-SPI-driver-pusher-td161008.html

Try to avoid the header files make sure to code everything in single  .c file.
Also add some documents as well as test log on doc/ folder if possible.

On Thu, Dec 19, 2013 at 1:35 AM, Chin Liang See <clsee at altera.com> wrote:
> To add the Cadence SPI driver support for Altera SOCFPGA. It
> required information such as clocks and timing from platform's
> configuration header file within include/configs folder
>
> Signed-off-by: Chin Liang See <clsee at altera.com>
> Cc: Jagannadha Sutradharudu Teki <jaganna at xilinx.com>
> ---
>  drivers/spi/Makefile           |    1 +
>  drivers/spi/cadence_qspi.c     |  337 ++++++++++++++++
>  drivers/spi/cadence_qspi.h     |   56 +++
>  drivers/spi/cadence_qspi_apb.c |  873 ++++++++++++++++++++++++++++++++++++++++
>  4 files changed, 1267 insertions(+)
>  create mode 100644 drivers/spi/cadence_qspi.c
>  create mode 100644 drivers/spi/cadence_qspi.h
>  create mode 100644 drivers/spi/cadence_qspi_apb.c
>
> diff --git a/drivers/spi/Makefile b/drivers/spi/Makefile
> index ed4ecd7..838e6ca 100644
> --- a/drivers/spi/Makefile
> +++ b/drivers/spi/Makefile
> @@ -15,6 +15,7 @@ obj-$(CONFIG_ATMEL_DATAFLASH_SPI) += atmel_dataflash_spi.o
>  obj-$(CONFIG_ATMEL_SPI) += atmel_spi.o
>  obj-$(CONFIG_BFIN_SPI) += bfin_spi.o
>  obj-$(CONFIG_BFIN_SPI6XX) += bfin_spi6xx.o
> +obj-$(CONFIG_CADENCE_QSPI) += cadence_qspi.o cadence_qspi_apb.o
>  obj-$(CONFIG_CF_SPI) += cf_spi.o
>  obj-$(CONFIG_CF_QSPI) += cf_qspi.o
>  obj-$(CONFIG_DAVINCI_SPI) += davinci_spi.o
> diff --git a/drivers/spi/cadence_qspi.c b/drivers/spi/cadence_qspi.c
> new file mode 100644
> index 0000000..e2bf39f
> --- /dev/null
> +++ b/drivers/spi/cadence_qspi.c
> @@ -0,0 +1,337 @@
> +/*
> + * Copyright (C) Altera Corporation <www.altera.com>
> + *
> + * SPDX-License-Identifier:    GPL-2.0+
> + */
> +
> +#include <common.h>
> +#include <malloc.h>
> +#include <spi.h>
> +#include "cadence_qspi.h"
> +
> +#define CQSPI_STIG_READ                        0
> +#define CQSPI_STIG_WRITE               1
> +#define CQSPI_INDIRECT_READ            2
> +#define CQSPI_INDIRECT_WRITE           3
> +
> +static int qspi_is_init;
> +static unsigned int qspi_calibrated_hz;
> +static unsigned int qspi_calibrated_cs;
> +
> +struct cadence_qspi_slave {
> +       struct spi_slave slave;
> +       unsigned int    mode;
> +       unsigned int    max_hz;
> +       void            *regbase;
> +       void            *ahbbase;
> +       size_t          cmd_len;
> +       u8              cmd_buf[32];
> +       size_t          data_len;
> +};
> +
> +#define to_cadence_qspi_slave(s)               \
> +               container_of(s, struct cadence_qspi_slave, slave)
> +
> +void spi_set_speed(struct spi_slave *slave, uint hz)
> +{
> +       struct cadence_qspi_slave *cadence_qspi = to_cadence_qspi_slave(slave);
> +       void *base = cadence_qspi->regbase;
> +
> +       cadence_qspi_apb_config_baudrate_div(base, CONFIG_CQSPI_REF_CLK, hz);
> +
> +       /* Reconfigure delay timing if speed is changed. */
> +       cadence_qspi_apb_delay(base, CONFIG_CQSPI_REF_CLK, hz,
> +               CONFIG_CQSPI_TSHSL_NS, CONFIG_CQSPI_TSD2D_NS,
> +               CONFIG_CQSPI_TCHSH_NS, CONFIG_CQSPI_TSLCH_NS);
> +       return;
> +}
> +
> +struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
> +               unsigned int max_hz, unsigned int mode)
> +{
> +       struct cadence_qspi_slave *cadence_qspi;
> +
> +       debug("%s: bus %d cs %d max_hz %dMHz mode %d\n", __func__,
> +               bus, cs, max_hz/1000000, mode);
> +
> +       if (!spi_cs_is_valid(bus, cs))
> +               return NULL;
> +
> +       cadence_qspi = malloc(sizeof(struct cadence_qspi_slave));
> +       if (!cadence_qspi) {
> +               printf("QSPI: Can't allocate struct cadence_qspi_slave. "
> +                       "Bus %d cs %d\n", bus, cs);
> +               return NULL;
> +       }
> +
> +       cadence_qspi->slave.bus = bus;
> +       cadence_qspi->slave.cs = cs;
> +       cadence_qspi->mode = mode;
> +       cadence_qspi->max_hz = max_hz;
> +       cadence_qspi->regbase = (void *)QSPI_BASE;
> +       cadence_qspi->ahbbase = (void *)QSPI_AHB_BASE;
> +
> +       if (!qspi_is_init)
> +               spi_init();
> +
> +       return &cadence_qspi->slave;
> +}
> +
> +void spi_free_slave(struct spi_slave *slave)
> +{
> +       struct cadence_qspi_slave *cadence_qspi = to_cadence_qspi_slave(slave);
> +       free(cadence_qspi);
> +       return;
> +}
> +
> +void spi_init(void)
> +{
> +       cadence_qspi_apb_controller_init((void *)QSPI_BASE);
> +       qspi_is_init = 1;
> +       return;
> +}
> +
> +/* calibration sequence to determine the read data capture delay register */
> +int spi_calibration(struct spi_slave *slave)
> +{
> +       struct cadence_qspi_slave *cadence_qspi = to_cadence_qspi_slave(slave);
> +       void *base = cadence_qspi->regbase;
> +       u8 opcode_rdid = 0x9F;
> +       unsigned int idcode = 0, temp = 0;
> +       int err = 0, i, range_lo = -1, range_hi = -1;
> +
> +       /* start with slowest clock (1 MHz) */
> +       spi_set_speed(slave, 1000000);
> +
> +       /* configure the read data capture delay register to 0 */
> +       cadence_qspi_apb_readdata_capture(base, 1, 0);
> +
> +       /* Enable QSPI */
> +       cadence_qspi_apb_controller_enable(base);
> +
> +       /* read the ID which will be our golden value */
> +       err = cadence_qspi_apb_command_read(base, 1, &opcode_rdid,
> +               3, (u8 *)&idcode);
> +       if (err) {
> +               puts("SF: Calibration failed (read)\n");
> +               return err;
> +       }
> +
> +       /* use back the intended clock and find low range */
> +       spi_set_speed(slave, cadence_qspi->max_hz);
> +       for (i = 0; i < CQSPI_READ_CAPTURE_MAX_DELAY; i++) {
> +               /* Disable QSPI */
> +               cadence_qspi_apb_controller_disable(base);
> +
> +               /* reconfigure the read data capture delay register */
> +               cadence_qspi_apb_readdata_capture(base, 1, i);
> +
> +               /* Enable back QSPI */
> +               cadence_qspi_apb_controller_enable(base);
> +
> +               /* issue a RDID to get the ID value */
> +               err = cadence_qspi_apb_command_read(base, 1, &opcode_rdid,
> +                       3, (u8 *)&temp);
> +               if (err) {
> +                       puts("SF: Calibration failed (read)\n");
> +                       return err;
> +               }
> +
> +               /* search for range lo */
> +               if (range_lo == -1 && temp == idcode) {
> +                       range_lo = i;
> +                       continue;
> +               }
> +
> +               /* search for range hi */
> +               if (range_lo != -1 && temp != idcode) {
> +                       range_hi = i - 1;
> +                       break;
> +               }
> +               range_hi = i;
> +       }
> +
> +       if (range_lo == -1) {
> +               puts("SF: Calibration failed (low range)\n");
> +               return err;
> +       }
> +
> +       /* Disable QSPI for subsequent initialization */
> +       cadence_qspi_apb_controller_disable(base);
> +
> +       /* configure the final value for read data capture delay register */
> +       cadence_qspi_apb_readdata_capture(base, 1, (range_hi + range_lo) / 2);
> +       printf("SF: Read data capture delay calibrated to %i (%i - %i)\n",
> +               (range_hi + range_lo) / 2, range_lo, range_hi);
> +
> +       /* just to ensure we do once only when speed or chip select change */
> +       qspi_calibrated_hz = cadence_qspi->max_hz;
> +       qspi_calibrated_cs = slave->cs;
> +       return 0;
> +}
> +
> +int spi_claim_bus(struct spi_slave *slave)
> +{
> +       struct cadence_qspi_slave *cadence_qspi = to_cadence_qspi_slave(slave);
> +       unsigned int clk_pol = (cadence_qspi->mode & SPI_CPOL) ? 1 : 0;
> +       unsigned int clk_pha = (cadence_qspi->mode & SPI_CPHA) ? 1 : 0;
> +       void *base = cadence_qspi->regbase;
> +       int err = 0;
> +
> +       debug("%s: bus:%i cs:%i\n", __func__, slave->bus, slave->cs);
> +
> +       /* Disable QSPI */
> +       cadence_qspi_apb_controller_disable(base);
> +
> +       /* Set Chip select */
> +       cadence_qspi_apb_chipselect(base, slave->cs, CONFIG_CQSPI_DECODER);
> +
> +       /* Set SPI mode */
> +       cadence_qspi_apb_set_clk_mode(base, clk_pol, clk_pha);
> +
> +       /* Set clock speed */
> +       spi_set_speed(slave, cadence_qspi->max_hz);
> +
> +       /* calibration required for different SCLK speed or chip select */
> +       if (qspi_calibrated_hz != cadence_qspi->max_hz ||
> +               qspi_calibrated_cs != slave->cs) {
> +               err = spi_calibration(slave);
> +               if (err)
> +                       return err;
> +       }
> +
> +       /* Enable QSPI */
> +       cadence_qspi_apb_controller_enable(base);
> +
> +       return 0;
> +}
> +
> +void spi_release_bus(struct spi_slave *slave)
> +{
> +       return;
> +}
> +
> +int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *data_out,
> +               void *data_in, unsigned long flags)
> +{
> +       struct cadence_qspi_slave *cadence_qspi = to_cadence_qspi_slave(slave);
> +       void *base = cadence_qspi->regbase;
> +       void *ahbbase = cadence_qspi->ahbbase;
> +       u8 *cmd_buf = cadence_qspi->cmd_buf;
> +       size_t data_bytes;
> +       int err = 0;
> +       u32 mode = CQSPI_STIG_WRITE;
> +
> +       if (flags & SPI_XFER_BEGIN) {
> +               /* copy command to local buffer */
> +               cadence_qspi->cmd_len = bitlen / 8;
> +               memcpy(cmd_buf, data_out, cadence_qspi->cmd_len);
> +       }
> +
> +       if (flags == (SPI_XFER_BEGIN | SPI_XFER_END)) {
> +               /* if start and end bit are set, the data bytes is 0. */
> +               data_bytes = 0;
> +       } else {
> +               data_bytes = bitlen / 8;
> +       }
> +
> +       if ((flags & SPI_XFER_END) || (flags == 0)) {
> +               if (cadence_qspi->cmd_len == 0) {
> +                       printf("QSPI: Error, command is empty.\n");
> +                       return -1;
> +               }
> +
> +               if (data_in && data_bytes) {
> +                       /* read */
> +                       /* Use STIG if no address. */
> +                       if (!CQSPI_IS_ADDR(cadence_qspi->cmd_len))
> +                               mode = CQSPI_STIG_READ;
> +                       else
> +                               mode = CQSPI_INDIRECT_READ;
> +               } else if (data_out && !(flags & SPI_XFER_BEGIN)) {
> +                       /* write */
> +                       if (!CQSPI_IS_ADDR(cadence_qspi->cmd_len))
> +                               mode = CQSPI_STIG_WRITE;
> +                       else
> +                               mode = CQSPI_INDIRECT_WRITE;
> +               }
> +
> +               switch (mode) {
> +               case CQSPI_STIG_READ:
> +                       err = cadence_qspi_apb_command_read(
> +                               base, cadence_qspi->cmd_len, cmd_buf,
> +                               data_bytes, data_in);
> +
> +               break;
> +               case CQSPI_STIG_WRITE:
> +                       err = cadence_qspi_apb_command_write(base,
> +                               cadence_qspi->cmd_len, cmd_buf,
> +                               data_bytes, data_out);
> +               break;
> +               case CQSPI_INDIRECT_READ:
> +                       err = cadence_qspi_apb_indirect_read_setup(
> +                               base, QSPI_AHB_BASE,
> +                               cadence_qspi->cmd_len, cmd_buf);
> +                       if (!err) {
> +                               err = cadence_qspi_apb_indirect_read_execute
> +                               (base, ahbbase, data_bytes, data_in);
> +                       }
> +               break;
> +               case CQSPI_INDIRECT_WRITE:
> +                       err = cadence_qspi_apb_indirect_write_setup
> +                               (base, QSPI_AHB_BASE,
> +                               cadence_qspi->cmd_len, cmd_buf);
> +                       if (!err) {
> +                               err = cadence_qspi_apb_indirect_write_execute
> +                               (base, ahbbase, data_bytes, data_out);
> +                       }
> +               break;
> +               default:
> +                       err = -1;
> +                       break;
> +               }
> +
> +               if (flags & SPI_XFER_END) {
> +                       /* clear command buffer */
> +                       memset(cmd_buf, 0, sizeof(cadence_qspi->cmd_buf));
> +                       cadence_qspi->cmd_len = 0;
> +               }
> +       }
> +       return err;
> +}
> +
> +int spi_cs_is_valid(unsigned int bus, unsigned int cs)
> +{
> +#if (CONFIG_CQSPI_DECODER == 1)
> +       if (((cs >= 0) && (cs < CQSPI_DECODER_MAX_CS)) && ((bus >= 0) &&
> +               (bus < CQSPI_DECODER_MAX_CS))) {
> +               return 1;
> +       }
> +#else
> +       if (((cs >= 0) && (cs < CQSPI_NO_DECODER_MAX_CS)) &&
> +               ((bus >= 0) && (bus < CQSPI_NO_DECODER_MAX_CS))) {
> +               return 1;
> +       }
> +#endif
> +       printf("QSPI: Invalid bus or cs. Bus %d cs %d\n", bus, cs);
> +       return 0;
> +}
> +
> +void spi_cs_activate(struct spi_slave *slave)
> +{
> +       return;
> +}
> +
> +void spi_cs_deactivate(struct spi_slave *slave)
> +{
> +       return;
> +}
> +
> +void spi_enter_xip(struct spi_slave *slave, char xip_dummy)
> +{
> +       struct cadence_qspi_slave *cadence_qspi = to_cadence_qspi_slave(slave);
> +       void *base = cadence_qspi->regbase;
> +       /* Enter XiP */
> +       cadence_qspi_apb_enter_xip(base, xip_dummy);
> +       return;
> +}
> diff --git a/drivers/spi/cadence_qspi.h b/drivers/spi/cadence_qspi.h
> new file mode 100644
> index 0000000..5e63bc4
> --- /dev/null
> +++ b/drivers/spi/cadence_qspi.h
> @@ -0,0 +1,56 @@
> +/*
> + * Copyright (C) Altera Corporation <www.altera.com>
> + *
> + * SPDX-License-Identifier:    GPL-2.0+
> + */
> +
> +#ifndef __CADENCE_QSPI_H__
> +#define __CADENCE_QSPI_H__
> +
> +#define CQSPI_WRITEL           writel
> +#define CQSPI_READL            readl
> +
> +#define QSPI_BASE                      (CONFIG_CQSPI_BASE)
> +#define QSPI_AHB_BASE                  (CONFIG_CQSPI_AHB_BASE)
> +#define CQSPI_IS_ADDR(cmd_len)         (cmd_len > 1 ? 1 : 0)
> +
> +#define CQSPI_NO_DECODER_MAX_CS                (4)
> +#define CQSPI_DECODER_MAX_CS           (16)
> +#define CQSPI_READ_CAPTURE_MAX_DELAY   (16)
> +
> +/* Functions call declaration */
> +void cadence_qspi_apb_controller_init(void *reg_base_addr);
> +void cadence_qspi_apb_controller_enable(void *reg_base_addr);
> +void cadence_qspi_apb_controller_disable(void *reg_base_addr);
> +
> +int cadence_qspi_apb_command_read(void *reg_base_addr,
> +       unsigned int cmdlen, const u8 *cmdbuf, unsigned int rxlen, u8 *rxbuf);
> +int cadence_qspi_apb_command_write(void *reg_base_addr,
> +       unsigned int cmdlen, const u8 *cmdbuf,
> +       unsigned int txlen,  const u8 *txbuf);
> +
> +int cadence_qspi_apb_indirect_read_setup(void *reg_base,
> +       unsigned int ahb_phy_addr, unsigned int cmdlen, const u8 *cmdbuf);
> +int cadence_qspi_apb_indirect_read_execute(void *reg_base_addr,
> +       void *ahb_base_addr, unsigned int rxlen, u8 *rxbuf);
> +
> +int cadence_qspi_apb_indirect_write_setup(void *reg_base,
> +       unsigned int ahb_phy_addr, unsigned int cmdlen, const u8 *cmdbuf);
> +int cadence_qspi_apb_indirect_write_execute(void *reg_base_addr,
> +       void *ahb_base_addr, unsigned int txlen, const u8 *txbuf);
> +
> +void cadence_qspi_apb_chipselect(void *reg_base,
> +       unsigned int chip_select, unsigned int decoder_enable);
> +void cadence_qspi_apb_set_clk_mode(void *reg_base_addr,
> +       unsigned int clk_pol, unsigned int clk_pha);
> +void cadence_qspi_apb_config_baudrate_div(void *reg_base,
> +       unsigned int ref_clk_hz, unsigned int sclk_hz);
> +void cadence_qspi_apb_delay(void *reg_base,
> +       unsigned int ref_clk, unsigned int sclk_hz,
> +       unsigned int tshsl_ns, unsigned int tsd2d_ns,
> +       unsigned int tchsh_ns, unsigned int tslch_ns);
> +void cadence_qspi_apb_enter_xip(void *reg_base, char xip_dummy);
> +void cadence_qspi_apb_readdata_capture(void *reg_base,
> +       unsigned int bypass, unsigned int delay);
> +
> +#endif /* __CADENCE_QSPI_H__ */
> diff --git a/drivers/spi/cadence_qspi_apb.c b/drivers/spi/cadence_qspi_apb.c
> new file mode 100644
> index 0000000..7798acb
> --- /dev/null
> +++ b/drivers/spi/cadence_qspi_apb.c
> @@ -0,0 +1,873 @@
> +/*
> + * Copyright (C) Altera Corporation <www.altera.com>
> + *
> + * SPDX-License-Identifier:    BSD-3-Clause
> + */
> +
> +#include <common.h>
> +#include <asm/io.h>
> +#include <asm/errno.h>
> +#include "cadence_qspi.h"
> +
> +#define CQSPI_REG_POLL_US                      (1)
> +#define CQSPI_REG_RETRY                                (10000)
> +#define CQSPI_POLL_IDLE_RETRY                  (3)
> +
> +#define CQSPI_FIFO_WIDTH                       (4)
> +
> +/* Controller sram size in word */
> +#define CQSPI_REG_SRAM_SIZE_WORD               (128)
> +#define CQSPI_REG_SRAM_RESV_WORDS              (2)
> +#define CQSPI_REG_SRAM_PARTITION_WR            (1)
> +#define CQSPI_REG_SRAM_PARTITION_RD            \
> +       (CQSPI_REG_SRAM_SIZE_WORD - CQSPI_REG_SRAM_RESV_WORDS)
> +#define CQSPI_REG_SRAM_THRESHOLD_WORDS         (50)
> +
> +/* Transfer mode */
> +#define CQSPI_INST_TYPE_SINGLE                 (0)
> +#define CQSPI_INST_TYPE_DUAL                   (1)
> +#define CQSPI_INST_TYPE_QUAD                   (2)
> +
> +#define CQSPI_STIG_DATA_LEN_MAX                        (8)
> +#define CQSPI_INDIRECTTRIGGER_ADDR_MASK                (0xFFFFF)
> +
> +#define CQSPI_DUMMY_CLKS_PER_BYTE              (8)
> +#define CQSPI_DUMMY_BYTES_MAX                  (4)
> +
> +
> +#define CQSPI_REG_SRAM_FILL_THRESHOLD  \
> +       ((CQSPI_REG_SRAM_SIZE_WORD / 2) * CQSPI_FIFO_WIDTH)
> +/****************************************************************************
> + * Controller's configuration and status register (offset from QSPI_BASE)
> + ****************************************************************************/
> +#define        CQSPI_REG_CONFIG                        0x00
> +#define        CQSPI_REG_CONFIG_CLK_POL_LSB            1
> +#define        CQSPI_REG_CONFIG_CLK_PHA_LSB            2
> +#define        CQSPI_REG_CONFIG_ENABLE_MASK            (1 << 0)
> +#define        CQSPI_REG_CONFIG_DIRECT_MASK            (1 << 7)
> +#define        CQSPI_REG_CONFIG_DECODE_MASK            (1 << 9)
> +#define        CQSPI_REG_CONFIG_XIP_IMM_MASK           (1 << 18)
> +#define        CQSPI_REG_CONFIG_CHIPSELECT_LSB         10
> +#define        CQSPI_REG_CONFIG_BAUD_LSB               19
> +#define        CQSPI_REG_CONFIG_IDLE_LSB               31
> +#define        CQSPI_REG_CONFIG_CHIPSELECT_MASK        0xF
> +#define        CQSPI_REG_CONFIG_BAUD_MASK              0xF
> +
> +#define        CQSPI_REG_RD_INSTR                      0x04
> +#define        CQSPI_REG_RD_INSTR_OPCODE_LSB           0
> +#define        CQSPI_REG_RD_INSTR_TYPE_INSTR_LSB       8
> +#define        CQSPI_REG_RD_INSTR_TYPE_ADDR_LSB        12
> +#define        CQSPI_REG_RD_INSTR_TYPE_DATA_LSB        16
> +#define        CQSPI_REG_RD_INSTR_MODE_EN_LSB          20
> +#define        CQSPI_REG_RD_INSTR_DUMMY_LSB            24
> +#define        CQSPI_REG_RD_INSTR_TYPE_INSTR_MASK      0x3
> +#define        CQSPI_REG_RD_INSTR_TYPE_ADDR_MASK       0x3
> +#define        CQSPI_REG_RD_INSTR_TYPE_DATA_MASK       0x3
> +#define        CQSPI_REG_RD_INSTR_DUMMY_MASK           0x1F
> +
> +#define        CQSPI_REG_WR_INSTR                      0x08
> +#define        CQSPI_REG_WR_INSTR_OPCODE_LSB           0
> +
> +#define        CQSPI_REG_DELAY                         0x0C
> +#define        CQSPI_REG_DELAY_TSLCH_LSB               0
> +#define        CQSPI_REG_DELAY_TCHSH_LSB               8
> +#define        CQSPI_REG_DELAY_TSD2D_LSB               16
> +#define        CQSPI_REG_DELAY_TSHSL_LSB               24
> +#define        CQSPI_REG_DELAY_TSLCH_MASK              0xFF
> +#define        CQSPI_REG_DELAY_TCHSH_MASK              0xFF
> +#define        CQSPI_REG_DELAY_TSD2D_MASK              0xFF
> +#define        CQSPI_REG_DELAY_TSHSL_MASK              0xFF
> +
> +#define        CQSPI_READLCAPTURE                      0x10
> +#define        CQSPI_READLCAPTURE_BYPASS_LSB           0
> +#define        CQSPI_READLCAPTURE_DELAY_LSB            1
> +#define        CQSPI_READLCAPTURE_DELAY_MASK           0xF
> +
> +#define        CQSPI_REG_SIZE                          0x14
> +#define        CQSPI_REG_SIZE_ADDRESS_LSB              0
> +#define        CQSPI_REG_SIZE_PAGE_LSB                 4
> +#define        CQSPI_REG_SIZE_BLOCK_LSB                16
> +#define        CQSPI_REG_SIZE_ADDRESS_MASK             0xF
> +#define        CQSPI_REG_SIZE_PAGE_MASK                0xFFF
> +#define        CQSPI_REG_SIZE_BLOCK_MASK               0x3F
> +
> +#define        CQSPI_REG_SRAMPARTITION                 0x18
> +#define        CQSPI_REG_INDIRECTTRIGGER               0x1C
> +
> +#define        CQSPI_REG_REMAP                         0x24
> +#define        CQSPI_REG_MODE_BIT                      0x28
> +
> +#define        CQSPI_REG_SDRAMLEVEL                    0x2C
> +#define        CQSPI_REG_SDRAMLEVEL_RD_LSB             0
> +#define        CQSPI_REG_SDRAMLEVEL_WR_LSB             16
> +#define        CQSPI_REG_SDRAMLEVEL_RD_MASK            0xFFFF
> +#define        CQSPI_REG_SDRAMLEVEL_WR_MASK            0xFFFF
> +
> +#define        CQSPI_REG_IRQSTATUS                     0x40
> +#define        CQSPI_REG_IRQMASK                       0x44
> +
> +#define        CQSPI_REG_INDIRECTRD                    0x60
> +#define        CQSPI_REG_INDIRECTRD_START_MASK         (1 << 0)
> +#define        CQSPI_REG_INDIRECTRD_CANCEL_MASK        (1 << 1)
> +#define        CQSPI_REG_INDIRECTRD_INPROGRESS_MASK    (1 << 2)
> +#define        CQSPI_REG_INDIRECTRD_DONE_MASK          (1 << 5)
> +
> +#define        CQSPI_REG_INDIRECTRDWATERMARK           0x64
> +#define        CQSPI_REG_INDIRECTRDSTARTADDR           0x68
> +#define        CQSPI_REG_INDIRECTRDBYTES               0x6C
> +
> +#define        CQSPI_REG_CMDCTRL                       0x90
> +#define        CQSPI_REG_CMDCTRL_EXECUTE_MASK          (1 << 0)
> +#define        CQSPI_REG_CMDCTRL_INPROGRESS_MASK       (1 << 1)
> +#define        CQSPI_REG_CMDCTRL_DUMMY_LSB             7
> +#define        CQSPI_REG_CMDCTRL_WR_BYTES_LSB          12
> +#define        CQSPI_REG_CMDCTRL_WR_EN_LSB             15
> +#define        CQSPI_REG_CMDCTRL_ADD_BYTES_LSB         16
> +#define        CQSPI_REG_CMDCTRL_ADDR_EN_LSB           19
> +#define        CQSPI_REG_CMDCTRL_RD_BYTES_LSB          20
> +#define        CQSPI_REG_CMDCTRL_RD_EN_LSB             23
> +#define        CQSPI_REG_CMDCTRL_OPCODE_LSB            24
> +#define        CQSPI_REG_CMDCTRL_DUMMY_MASK            0x1F
> +#define        CQSPI_REG_CMDCTRL_WR_BYTES_MASK         0x7
> +#define        CQSPI_REG_CMDCTRL_ADD_BYTES_MASK        0x3
> +#define        CQSPI_REG_CMDCTRL_RD_BYTES_MASK         0x7
> +#define        CQSPI_REG_CMDCTRL_OPCODE_MASK           0xFF
> +
> +#define        CQSPI_REG_INDIRECTWR                    0x70
> +#define        CQSPI_REG_INDIRECTWR_START_MASK         (1 << 0)
> +#define        CQSPI_REG_INDIRECTWR_CANCEL_MASK        (1 << 1)
> +#define        CQSPI_REG_INDIRECTWR_INPROGRESS_MASK    (1 << 2)
> +#define        CQSPI_REG_INDIRECTWR_DONE_MASK          (1 << 5)
> +
> +#define        CQSPI_REG_INDIRECTWRWATERMARK           0x74
> +#define        CQSPI_REG_INDIRECTWRSTARTADDR           0x78
> +#define        CQSPI_REG_INDIRECTWRBYTES               0x7C
> +
> +#define        CQSPI_REG_CMDADDRESS                    0x94
> +#define        CQSPI_REG_CMDREADDATALOWER              0xA0
> +#define        CQSPI_REG_CMDREADDATAUPPER              0xA4
> +#define        CQSPI_REG_CMDWRITEDATALOWER             0xA8
> +#define        CQSPI_REG_CMDWRITEDATAUPPER             0xAC
> +
> +#define CQSPI_REG_IS_IDLE(base)                                        \
> +       ((CQSPI_READL(base + CQSPI_REG_CONFIG) >>               \
> +               CQSPI_REG_CONFIG_IDLE_LSB) & 0x1)
> +
> +#define CQSPI_CAL_DELAY(tdelay_ns, tref_ns, tsclk_ns)          \
> +       ((((tdelay_ns) - (tsclk_ns)) / (tref_ns)))
> +
> +#define CQSPI_GET_RD_SRAM_LEVEL(reg_basse)                     \
> +       (((CQSPI_READL(reg_base + CQSPI_REG_SDRAMLEVEL)) >>     \
> +       CQSPI_REG_SDRAMLEVEL_RD_LSB) & CQSPI_REG_SDRAMLEVEL_RD_MASK)
> +
> +#define CQSPI_GET_WR_SRAM_LEVEL(reg_basse)                     \
> +       (((CQSPI_READL(reg_base + CQSPI_REG_SDRAMLEVEL)) >>     \
> +       CQSPI_REG_SDRAMLEVEL_WR_LSB) & CQSPI_REG_SDRAMLEVEL_WR_MASK)
> +
> +static unsigned int cadence_qspi_apb_cmd2addr(const unsigned char *addr_buf,
> +       unsigned int addr_width)
> +{
> +       unsigned int addr;
> +
> +       addr = (addr_buf[0] << 16) | (addr_buf[1] << 8) | addr_buf[2];
> +
> +       if (addr_width == 4)
> +               addr = (addr << 8) | addr_buf[3];
> +
> +       return addr;
> +}
> +
> +static void cadence_qspi_apb_read_fifo_data(void *dest,
> +       const void *src_ahb_addr, unsigned int bytes)
> +{
> +       unsigned int temp;
> +       int remaining = bytes;
> +       unsigned int *dest_ptr = (unsigned int *)dest;
> +       unsigned int *src_ptr = (unsigned int *)src_ahb_addr;
> +
> +       while (remaining > 0) {
> +               if (remaining >= CQSPI_FIFO_WIDTH) {
> +                       *dest_ptr = CQSPI_READL(src_ptr);
> +                       remaining -= CQSPI_FIFO_WIDTH;
> +               } else {
> +                       /* dangling bytes */
> +                       temp = CQSPI_READL(src_ptr);
> +                       memcpy(dest_ptr, &temp, remaining);
> +                       break;
> +               }
> +               dest_ptr++;
> +       }
> +
> +       return;
> +}
> +
> +static void cadence_qspi_apb_write_fifo_data(const void *dest_ahb_addr,
> +       const void *src, unsigned int bytes)
> +{
> +       unsigned int temp;
> +       int remaining = bytes;
> +       unsigned int *dest_ptr = (unsigned int *)dest_ahb_addr;
> +       unsigned int *src_ptr = (unsigned int *)src;
> +
> +       while (remaining > 0) {
> +               if (remaining >= CQSPI_FIFO_WIDTH) {
> +                       CQSPI_WRITEL(*src_ptr, dest_ptr);
> +                       remaining -= sizeof(unsigned int);
> +               } else {
> +                       /* dangling bytes */
> +                       memcpy(&temp, src_ptr, remaining);
> +                       CQSPI_WRITEL(temp, dest_ptr);
> +                       break;
> +               }
> +               src_ptr++;
> +       }
> +
> +       return;
> +}
> +
> +/* Read from SRAM FIFO with polling SRAM fill level. */
> +static int qspi_read_sram_fifo_poll(const void *reg_base, void *dest_addr,
> +                       const void *src_addr,  unsigned int num_bytes)
> +{
> +       unsigned int remaining = num_bytes;
> +       unsigned int retry;
> +       unsigned int sram_level = 0;
> +       unsigned char *dest = (unsigned char *)dest_addr;
> +
> +       while (remaining > 0) {
> +               retry = CQSPI_REG_RETRY;
> +               while (retry--) {
> +                       sram_level = CQSPI_GET_RD_SRAM_LEVEL(reg_base);
> +                       if (sram_level)
> +                               break;
> +                       udelay(1);
> +               }
> +
> +               if (!retry) {
> +                       printf("QSPI: No receive data after polling for %d "
> +                               "times\n", CQSPI_REG_RETRY);
> +                       return -1;
> +               }
> +
> +               sram_level *= CQSPI_FIFO_WIDTH;
> +               sram_level = sram_level > remaining ? remaining : sram_level;
> +
> +               /* Read data from FIFO. */
> +               cadence_qspi_apb_read_fifo_data(dest, src_addr, sram_level);
> +               dest += sram_level;
> +               remaining -= sram_level;
> +               udelay(1);
> +       }
> +       return 0;
> +}
> +
> +
> +/* Write to SRAM FIFO with polling SRAM fill level. */
> +static int qpsi_write_sram_fifo_push(const void *reg_base, void *dest_addr,
> +                               const void *src_addr, unsigned int num_bytes)
> +{
> +       unsigned int retry = CQSPI_REG_RETRY;
> +       unsigned int sram_level;
> +       unsigned int wr_bytes;
> +       unsigned char *src = (unsigned char *)src_addr;
> +       int remaining = num_bytes;
> +       unsigned int page_size = CONFIG_CQSPI_PAGE_SIZE;
> +       unsigned int sram_threshold_words = CQSPI_REG_SRAM_THRESHOLD_WORDS;
> +
> +       while (remaining > 0) {
> +               retry = CQSPI_REG_RETRY;
> +               while (retry--) {
> +                       sram_level = CQSPI_GET_WR_SRAM_LEVEL(reg_base);
> +                       if (sram_level <= sram_threshold_words)
> +                               break;
> +               }
> +               if (!retry) {
> +                       printf("QSPI: SRAM fill level (0x%08x) "
> +                               "not hit lower expected level (0x%08x)",
> +                               sram_level, sram_threshold_words);
> +                       return -1;
> +               }
> +               /* Write a page or remaining bytes. */
> +               wr_bytes = (remaining > page_size) ?
> +                                       page_size : remaining;
> +
> +               cadence_qspi_apb_write_fifo_data(dest_addr, src, wr_bytes);
> +               src += wr_bytes;
> +               remaining -= wr_bytes;
> +       }
> +
> +       return 0;
> +}
> +
> +void cadence_qspi_apb_controller_enable(void *reg_base)
> +{
> +       unsigned int reg;
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CONFIG);
> +       reg |= CQSPI_REG_CONFIG_ENABLE_MASK;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CONFIG);
> +       return;
> +}
> +
> +void cadence_qspi_apb_controller_disable(void *reg_base)
> +{
> +       unsigned int reg;
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CONFIG);
> +       reg &= ~CQSPI_REG_CONFIG_ENABLE_MASK;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CONFIG);
> +       return;
> +}
> +
> +/* Return 1 if idle, otherwise return 0 (busy). */
> +static unsigned int cadence_qspi_wait_idle(void *reg_base)
> +{
> +       unsigned int start, count = 0;
> +       /* timeout in unit of ms */
> +       unsigned int timeout = 5000;
> +
> +       start = get_timer(0);
> +       for ( ; get_timer(start) < timeout ; ) {
> +               if (CQSPI_REG_IS_IDLE(reg_base))
> +                       count++;
> +               else
> +                       count = 0;
> +               /*
> +                * Ensure the QSPI controller is in true idle state after
> +                * reading back the same idle status consecutively
> +                */
> +               if (count >= CQSPI_POLL_IDLE_RETRY)
> +                       return 1;
> +       }
> +
> +       /* Timeout, still in busy mode. */
> +       printf("QSPI: QSPI is still busy after poll for %d times.\n",
> +               CQSPI_REG_RETRY);
> +       return 0;
> +}
> +
> +void cadence_qspi_apb_readdata_capture(void *reg_base,
> +                               unsigned int bypass, unsigned int delay)
> +{
> +       unsigned int reg;
> +       cadence_qspi_apb_controller_disable(reg_base);
> +
> +       reg = CQSPI_READL(reg_base + CQSPI_READLCAPTURE);
> +
> +       if (bypass)
> +               reg |= (1 << CQSPI_READLCAPTURE_BYPASS_LSB);
> +       else
> +               reg &= ~(1 << CQSPI_READLCAPTURE_BYPASS_LSB);
> +
> +       reg &= ~(CQSPI_READLCAPTURE_DELAY_MASK
> +               << CQSPI_READLCAPTURE_DELAY_LSB);
> +
> +       reg |= ((delay & CQSPI_READLCAPTURE_DELAY_MASK)
> +               << CQSPI_READLCAPTURE_DELAY_LSB);
> +
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_READLCAPTURE);
> +
> +       cadence_qspi_apb_controller_enable(reg_base);
> +       return;
> +}
> +
> +void cadence_qspi_apb_config_baudrate_div(void *reg_base,
> +       unsigned int ref_clk_hz, unsigned int sclk_hz)
> +{
> +       unsigned int reg;
> +       unsigned int div;
> +
> +       cadence_qspi_apb_controller_disable(reg_base);
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CONFIG);
> +       reg &= ~(CQSPI_REG_CONFIG_BAUD_MASK << CQSPI_REG_CONFIG_BAUD_LSB);
> +
> +       div = ref_clk_hz / sclk_hz;
> +
> +       if (div > 32)
> +               div = 32;
> +
> +       /* Check if even number. */
> +       if ((div & 1))
> +               div = (div / 2);
> +       else
> +               div = (div / 2) - 1;
> +
> +       debug("%s: ref_clk %dHz sclk %dHz Div 0x%x\n", __func__,
> +               ref_clk_hz, sclk_hz, div);
> +
> +       div = (div & CQSPI_REG_CONFIG_BAUD_MASK) << CQSPI_REG_CONFIG_BAUD_LSB;
> +       reg |= div;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CONFIG);
> +
> +       cadence_qspi_apb_controller_enable(reg_base);
> +       return;
> +}
> +
> +void cadence_qspi_apb_set_clk_mode(void *reg_base,
> +       unsigned int clk_pol, unsigned int clk_pha)
> +{
> +       unsigned int reg;
> +
> +       cadence_qspi_apb_controller_disable(reg_base);
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CONFIG);
> +       reg &= ~(1 <<
> +               (CQSPI_REG_CONFIG_CLK_POL_LSB | CQSPI_REG_CONFIG_CLK_PHA_LSB));
> +
> +       reg |= ((clk_pol & 0x1) << CQSPI_REG_CONFIG_CLK_POL_LSB);
> +       reg |= ((clk_pha & 0x1) << CQSPI_REG_CONFIG_CLK_PHA_LSB);
> +
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CONFIG);
> +
> +       cadence_qspi_apb_controller_enable(reg_base);
> +       return;
> +}
> +
> +void cadence_qspi_apb_chipselect(void *reg_base,
> +       unsigned int chip_select, unsigned int decoder_enable)
> +{
> +       unsigned int reg;
> +
> +       cadence_qspi_apb_controller_disable(reg_base);
> +
> +       debug("%s : chipselect %d decode %d\n", __func__, chip_select,
> +               decoder_enable);
> +
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CONFIG);
> +       /* docoder */
> +       if (decoder_enable)
> +               reg |= CQSPI_REG_CONFIG_DECODE_MASK;
> +       else {
> +               reg &= ~CQSPI_REG_CONFIG_DECODE_MASK;
> +               /* Convert CS if without decoder.
> +                * CS0 to 4b'1110
> +                * CS1 to 4b'1101
> +                * CS2 to 4b'1011
> +                * CS3 to 4b'0111
> +                */
> +               chip_select = 0xF & ~(1 << chip_select);
> +       }
> +
> +       reg &= ~(CQSPI_REG_CONFIG_CHIPSELECT_MASK
> +                       << CQSPI_REG_CONFIG_CHIPSELECT_LSB);
> +       reg |= (chip_select & CQSPI_REG_CONFIG_CHIPSELECT_MASK)
> +                       << CQSPI_REG_CONFIG_CHIPSELECT_LSB;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CONFIG);
> +
> +       cadence_qspi_apb_controller_enable(reg_base);
> +       return;
> +}
> +
> +void cadence_qspi_apb_delay(void *reg_base,
> +       unsigned int ref_clk, unsigned int sclk_hz,
> +       unsigned int tshsl_ns, unsigned int tsd2d_ns,
> +       unsigned int tchsh_ns, unsigned int tslch_ns)
> +{
> +       unsigned int ref_clk_ns;
> +       unsigned int sclk_ns;
> +       unsigned int tshsl, tchsh, tslch, tsd2d;
> +       unsigned int reg;
> +
> +       cadence_qspi_apb_controller_disable(reg_base);
> +
> +       /* Convert to ns. */
> +       ref_clk_ns = (1000000000) / ref_clk;
> +
> +       /* Convert to ns. */
> +       sclk_ns = (1000000000) / sclk_hz;
> +
> +       /* Plus 1 to round up 1 clock cycle. */
> +       tshsl = CQSPI_CAL_DELAY(tshsl_ns, ref_clk_ns, sclk_ns) + 1;
> +       tchsh = CQSPI_CAL_DELAY(tchsh_ns, ref_clk_ns, sclk_ns) + 1;
> +       tslch = CQSPI_CAL_DELAY(tslch_ns, ref_clk_ns, sclk_ns) + 1;
> +       tsd2d = CQSPI_CAL_DELAY(tsd2d_ns, ref_clk_ns, sclk_ns) + 1;
> +
> +       reg = ((tshsl & CQSPI_REG_DELAY_TSHSL_MASK)
> +                       << CQSPI_REG_DELAY_TSHSL_LSB);
> +       reg |= ((tchsh & CQSPI_REG_DELAY_TCHSH_MASK)
> +                       << CQSPI_REG_DELAY_TCHSH_LSB);
> +       reg |= ((tslch & CQSPI_REG_DELAY_TSLCH_MASK)
> +                       << CQSPI_REG_DELAY_TSLCH_LSB);
> +       reg |= ((tsd2d & CQSPI_REG_DELAY_TSD2D_MASK)
> +                       << CQSPI_REG_DELAY_TSD2D_LSB);
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_DELAY);
> +
> +       cadence_qspi_apb_controller_enable(reg_base);
> +       return;
> +}
> +
> +void cadence_qspi_apb_controller_init(void *reg_base)
> +{
> +       unsigned reg;
> +
> +       cadence_qspi_apb_controller_disable(reg_base);
> +
> +       /* Configure the device size and address bytes */
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_SIZE);
> +       /* Clear the previous value */
> +       reg &= ~(CQSPI_REG_SIZE_PAGE_MASK << CQSPI_REG_SIZE_PAGE_LSB);
> +       reg &= ~(CQSPI_REG_SIZE_BLOCK_MASK << CQSPI_REG_SIZE_BLOCK_LSB);
> +       reg |= (CONFIG_CQSPI_PAGE_SIZE << CQSPI_REG_SIZE_PAGE_LSB);
> +       reg |= (CONFIG_CQSPI_BLOCK_SIZE << CQSPI_REG_SIZE_BLOCK_LSB);
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_SIZE);
> +
> +       /* Configure the remap address register, no remap */
> +       CQSPI_WRITEL(0, reg_base + CQSPI_REG_REMAP);
> +
> +       /* Disable all interrupts */
> +       CQSPI_WRITEL(0, reg_base + CQSPI_REG_IRQMASK);
> +
> +       cadence_qspi_apb_controller_enable(reg_base);
> +       return;
> +}
> +
> +static int cadence_qspi_apb_exec_flash_cmd(void *reg_base,
> +       unsigned int reg)
> +{
> +       unsigned int retry = CQSPI_REG_RETRY;
> +
> +       /* Write the CMDCTRL without start execution. */
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CMDCTRL);
> +       /* Start execute */
> +       reg |= CQSPI_REG_CMDCTRL_EXECUTE_MASK;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CMDCTRL);
> +
> +       while (retry--) {
> +               reg = CQSPI_READL(reg_base + CQSPI_REG_CMDCTRL);
> +               if ((reg & CQSPI_REG_CMDCTRL_INPROGRESS_MASK) == 0)
> +                       break;
> +               udelay(1);
> +       }
> +
> +       if (!retry) {
> +               printf("QSPI: flash command execution timeout\n");
> +               return -EIO;
> +       }
> +
> +       /* Polling QSPI idle status. */
> +       if (!cadence_qspi_wait_idle(reg_base))
> +               return -EIO;
> +
> +       return 0;
> +}
> +
> +/* For command RDID, RDSR. */
> +int cadence_qspi_apb_command_read(void *reg_base,
> +       unsigned int cmdlen, const u8 *cmdbuf, unsigned int rxlen,
> +       u8 *rxbuf)
> +{
> +       unsigned int reg;
> +       unsigned int read_len;
> +       int status;
> +
> +       if (!cmdlen || rxlen > CQSPI_STIG_DATA_LEN_MAX || rxbuf == NULL) {
> +               printf("QSPI: Invalid input arguments cmdlen %d "
> +                       "rxlen %d\n", cmdlen, rxlen);
> +               return -EINVAL;
> +       }
> +
> +       reg = cmdbuf[0] << CQSPI_REG_CMDCTRL_OPCODE_LSB;
> +
> +       reg |= (0x1 << CQSPI_REG_CMDCTRL_RD_EN_LSB);
> +
> +       /* 0 means 1 byte. */
> +       reg |= (((rxlen - 1) & CQSPI_REG_CMDCTRL_RD_BYTES_MASK)
> +               << CQSPI_REG_CMDCTRL_RD_BYTES_LSB);
> +       status = cadence_qspi_apb_exec_flash_cmd(reg_base, reg);
> +       if (status != 0)
> +               return status;
> +
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CMDREADDATALOWER);
> +
> +       /* Put the read value into rx_buf */
> +       read_len = (rxlen > 4) ? 4 : rxlen;
> +       memcpy(rxbuf, &reg, read_len);
> +       rxbuf += read_len;
> +
> +       if (rxlen > 4) {
> +               reg = CQSPI_READL(reg_base + CQSPI_REG_CMDREADDATAUPPER);
> +
> +               read_len = rxlen - read_len;
> +               memcpy(rxbuf, &reg, read_len);
> +       }
> +       return 0;
> +}
> +
> +/* For commands: WRSR, WREN, WRDI, CHIP_ERASE, BE, etc. */
> +int cadence_qspi_apb_command_write(void *reg_base, unsigned int cmdlen,
> +       const u8 *cmdbuf, unsigned int txlen,  const u8 *txbuf)
> +{
> +       unsigned int reg = 0;
> +       unsigned int addr_value;
> +       unsigned int wr_data;
> +       unsigned int wr_len;
> +
> +       if (!cmdlen || cmdlen > 5 || txlen > 8 || cmdbuf == NULL) {
> +               printf("QSPI: Invalid input arguments cmdlen %d txlen %d\n",
> +                       cmdlen, txlen);
> +               return -EINVAL;
> +       }
> +
> +       reg |= cmdbuf[0] << CQSPI_REG_CMDCTRL_OPCODE_LSB;
> +
> +       if (cmdlen == 4 || cmdlen == 5) {
> +               /* Command with address */
> +               reg |= (0x1 << CQSPI_REG_CMDCTRL_ADDR_EN_LSB);
> +               /* Number of bytes to write. */
> +               reg |= ((cmdlen - 2) & CQSPI_REG_CMDCTRL_ADD_BYTES_MASK)
> +                       << CQSPI_REG_CMDCTRL_ADD_BYTES_LSB;
> +               /* Get address */
> +               addr_value = cadence_qspi_apb_cmd2addr(&cmdbuf[1],
> +                       cmdlen >= 5 ? 4 : 3);
> +
> +               CQSPI_WRITEL(addr_value, reg_base + CQSPI_REG_CMDADDRESS);
> +       }
> +
> +       if (txlen) {
> +               /* writing data = yes */
> +               reg |= (0x1 << CQSPI_REG_CMDCTRL_WR_EN_LSB);
> +               reg |= ((txlen - 1) & CQSPI_REG_CMDCTRL_WR_BYTES_MASK)
> +                       << CQSPI_REG_CMDCTRL_WR_BYTES_LSB;
> +
> +               wr_len = txlen > 4 ? 4 : txlen;
> +               memcpy(&wr_data, txbuf, wr_len);
> +               CQSPI_WRITEL(wr_data, reg_base +
> +                       CQSPI_REG_CMDWRITEDATALOWER);
> +
> +               if (txlen > 4) {
> +                       txbuf += wr_len;
> +                       wr_len = txlen - wr_len;
> +                       memcpy(&wr_data, txbuf, wr_len);
> +                       CQSPI_WRITEL(wr_data, reg_base +
> +                               CQSPI_REG_CMDWRITEDATAUPPER);
> +               }
> +       }
> +
> +       /* Execute the command */
> +       return cadence_qspi_apb_exec_flash_cmd(reg_base, reg);
> +}
> +
> +/* Opcode + Address (3/4 bytes) + dummy bytes (0-4 bytes) */
> +int cadence_qspi_apb_indirect_read_setup(void *reg_base,
> +       unsigned int ahb_phy_addr, unsigned int cmdlen, const u8 *cmdbuf)
> +{
> +       unsigned int reg;
> +       unsigned int rd_reg;
> +       unsigned int addr_value;
> +       unsigned int dummy_clk;
> +       unsigned int dummy_bytes;
> +       unsigned int addr_bytes;
> +
> +       /*
> +        * Identify addr_byte. All NOR flash device drivers are using fast read
> +        * which always expecting 1 dummy byte, 1 cmd byte and 3/4 addr byte.
> +        * With that, the length is in value of 5 or 6. Only FRAM chip from
> +        * ramtron using normal read (which won't need dummy byte).
> +        * Unlikely NOR flash using normal read due to performance issue.
> +        */
> +       if (cmdlen >= 5)
> +               /* to cater fast read where cmd + addr + dummy */
> +               addr_bytes = cmdlen - 2;
> +       else
> +               /* for normal read (only ramtron as of now) */
> +               addr_bytes = cmdlen - 1;
> +
> +       /* Setup the indirect trigger address */
> +       CQSPI_WRITEL((ahb_phy_addr & CQSPI_INDIRECTTRIGGER_ADDR_MASK),
> +               reg_base + CQSPI_REG_INDIRECTTRIGGER);
> +
> +       /* Configure SRAM partition for read. */
> +       CQSPI_WRITEL(CQSPI_REG_SRAM_PARTITION_RD, reg_base +
> +               CQSPI_REG_SRAMPARTITION);
> +
> +       /* Configure the opcode */
> +       rd_reg = cmdbuf[0] << CQSPI_REG_RD_INSTR_OPCODE_LSB;
> +
> +#if (CONFIG_SPI_FLASH_QUAD == 1)
> +       /* Instruction and address at DQ0, data at DQ0-3. */
> +       rd_reg |= CQSPI_INST_TYPE_QUAD << CQSPI_REG_RD_INSTR_TYPE_DATA_LSB;
> +#endif
> +
> +       /* Get address */
> +       addr_value = cadence_qspi_apb_cmd2addr(&cmdbuf[1], addr_bytes);
> +       CQSPI_WRITEL(addr_value, reg_base + CQSPI_REG_INDIRECTRDSTARTADDR);
> +
> +       /* The remaining lenght is dummy bytes. */
> +       dummy_bytes = cmdlen - addr_bytes - 1;
> +       if (dummy_bytes) {
> +
> +               if (dummy_bytes > CQSPI_DUMMY_BYTES_MAX)
> +                       dummy_bytes = CQSPI_DUMMY_BYTES_MAX;
> +
> +               rd_reg |= (1 << CQSPI_REG_RD_INSTR_MODE_EN_LSB);
> +#if defined(CONFIG_SPL_SPI_XIP) && defined(CONFIG_SPL_BUILD)
> +               CQSPI_WRITEL(0x0, reg_base + CQSPI_REG_MODE_BIT);
> +#else
> +               CQSPI_WRITEL(0xFF, reg_base + CQSPI_REG_MODE_BIT);
> +#endif
> +
> +               /* Convert to clock cycles. */
> +               dummy_clk = dummy_bytes * CQSPI_DUMMY_CLKS_PER_BYTE;
> +               /* Need to minus the mode byte (8 clocks). */
> +               dummy_clk -= CQSPI_DUMMY_CLKS_PER_BYTE;
> +
> +               if (dummy_clk)
> +                       rd_reg |= (dummy_clk & CQSPI_REG_RD_INSTR_DUMMY_MASK)
> +                               << CQSPI_REG_RD_INSTR_DUMMY_LSB;
> +       }
> +
> +       CQSPI_WRITEL(rd_reg, reg_base + CQSPI_REG_RD_INSTR);
> +
> +       /* set device size */
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_SIZE);
> +       reg &= ~CQSPI_REG_SIZE_ADDRESS_MASK;
> +       reg |= (addr_bytes - 1);
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_SIZE);
> +       return 0;
> +}
> +
> +int cadence_qspi_apb_indirect_read_execute(void *reg_base,
> +       void *ahb_base_addr, unsigned int rxlen, u8 *rxbuf)
> +{
> +       unsigned int reg;
> +
> +       CQSPI_WRITEL(rxlen, reg_base + CQSPI_REG_INDIRECTRDBYTES);
> +
> +       /* Start the indirect read transfer */
> +       CQSPI_WRITEL(CQSPI_REG_INDIRECTRD_START_MASK,
> +                       reg_base + CQSPI_REG_INDIRECTRD);
> +
> +       if (qspi_read_sram_fifo_poll(reg_base, (void *)rxbuf,
> +                               (const void *)ahb_base_addr, rxlen)) {
> +               goto failrd;
> +       }
> +
> +       /* Check flash indirect controller */
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_INDIRECTRD);
> +       if (!(reg & CQSPI_REG_INDIRECTRD_DONE_MASK)) {
> +               reg = CQSPI_READL(reg_base + CQSPI_REG_INDIRECTRD);
> +               printf("QSPI: indirect completion status "
> +                       "error with reg 0x%08x\n", reg);
> +               goto failrd;
> +       }
> +
> +       /* Clear indirect completion status */
> +       CQSPI_WRITEL(CQSPI_REG_INDIRECTRD_DONE_MASK,
> +               reg_base + CQSPI_REG_INDIRECTRD);
> +       return 0;
> +
> +failrd:
> +       /* Cancel the indirect read */
> +       CQSPI_WRITEL(CQSPI_REG_INDIRECTRD_CANCEL_MASK,
> +               reg_base + CQSPI_REG_INDIRECTRD);
> +       return -1;
> +}
> +
> +/* Opcode + Address (3/4 bytes) */
> +int cadence_qspi_apb_indirect_write_setup(void *reg_base,
> +       unsigned int ahb_phy_addr, unsigned int cmdlen, const u8 *cmdbuf)
> +{
> +       unsigned int reg;
> +       unsigned int addr_bytes = cmdlen > 4 ? 4 : 3;
> +
> +       if (cmdlen < 4 || cmdbuf == NULL) {
> +               printf("QSPI: iInvalid input argument, len %d cmdbuf 0x%08x\n",
> +                       cmdlen, (unsigned int)cmdbuf);
> +               return -EINVAL;
> +       }
> +       /* Setup the indirect trigger address */
> +       CQSPI_WRITEL((ahb_phy_addr & CQSPI_INDIRECTTRIGGER_ADDR_MASK),
> +               reg_base + CQSPI_REG_INDIRECTTRIGGER);
> +
> +       CQSPI_WRITEL(CQSPI_REG_SRAM_PARTITION_WR,
> +               reg_base + CQSPI_REG_SRAMPARTITION);
> +
> +       /* Configure the opcode */
> +       reg = cmdbuf[0] << CQSPI_REG_WR_INSTR_OPCODE_LSB;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_WR_INSTR);
> +
> +       /* Setup write address. */
> +       reg = cadence_qspi_apb_cmd2addr(&cmdbuf[1], addr_bytes);
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_INDIRECTWRSTARTADDR);
> +
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_SIZE);
> +       reg &= ~CQSPI_REG_SIZE_ADDRESS_MASK;
> +       reg |= (addr_bytes - 1);
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_SIZE);
> +       return 0;
> +}
> +
> +int cadence_qspi_apb_indirect_write_execute(void *reg_base,
> +       void *ahb_base_addr, unsigned int txlen, const u8 *txbuf)
> +{
> +       unsigned int reg = 0;
> +       unsigned int retry;
> +
> +       /* Configure the indirect read transfer bytes */
> +       CQSPI_WRITEL(txlen, reg_base + CQSPI_REG_INDIRECTWRBYTES);
> +
> +       /* Start the indirect write transfer */
> +       CQSPI_WRITEL(CQSPI_REG_INDIRECTWR_START_MASK,
> +                       reg_base + CQSPI_REG_INDIRECTWR);
> +
> +       if (qpsi_write_sram_fifo_push(reg_base, ahb_base_addr,
> +               (const void *)txbuf, txlen)) {
> +               goto failwr;
> +       }
> +
> +       /* Wait until last write is completed (FIFO empty) */
> +       retry = CQSPI_REG_RETRY;
> +       while (retry--) {
> +               reg = CQSPI_GET_WR_SRAM_LEVEL(reg_base);
> +               if (reg == 0)
> +                       break;
> +
> +               udelay(1);
> +       }
> +       if (reg != 0) {
> +               printf("QSPI: timeout for indirect write\n");
> +               goto failwr;
> +       }
> +
> +       /* Check flash indirect controller status */
> +       retry = CQSPI_REG_RETRY;
> +       while (retry--) {
> +               reg = CQSPI_READL(reg_base + CQSPI_REG_INDIRECTWR);
> +               if (reg & CQSPI_REG_INDIRECTWR_DONE_MASK)
> +                       break;
> +               udelay(1);
> +       }
> +       if (!(reg & CQSPI_REG_INDIRECTWR_DONE_MASK)) {
> +               printf("QSPI: indirect completion "
> +                       "status error with reg 0x%08x\n", reg);
> +               goto failwr;
> +       }
> +
> +       /* Clear indirect completion status */
> +       CQSPI_WRITEL(CQSPI_REG_INDIRECTWR_DONE_MASK,
> +               reg_base + CQSPI_REG_INDIRECTWR);
> +       return 0;
> +
> +failwr:
> +       /* Cancel the indirect write */
> +       CQSPI_WRITEL(CQSPI_REG_INDIRECTWR_CANCEL_MASK,
> +                       reg_base + CQSPI_REG_INDIRECTWR);
> +       return -1;
> +}
> +
> +void cadence_qspi_apb_enter_xip(void *reg_base, char xip_dummy)
> +{
> +       unsigned int reg;
> +
> +       /* enter XiP mode immediately and enable direct mode */
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_CONFIG);
> +       reg |= CQSPI_REG_CONFIG_ENABLE_MASK;
> +       reg |= CQSPI_REG_CONFIG_DIRECT_MASK;
> +       reg |= CQSPI_REG_CONFIG_XIP_IMM_MASK;
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_CONFIG);
> +
> +       /* keep the XiP mode */
> +       CQSPI_WRITEL(xip_dummy, reg_base + CQSPI_REG_MODE_BIT);
> +
> +       /* Enable mode bit at devrd */
> +       reg = CQSPI_READL(reg_base + CQSPI_REG_RD_INSTR);
> +       reg |= (1 << CQSPI_REG_RD_INSTR_MODE_EN_LSB);
> +       CQSPI_WRITEL(reg, reg_base + CQSPI_REG_RD_INSTR);
> +}
> --
> 1.7.9.5
>

-- 
Thanks,
Jagan.
--------
Jagannadha Sutradharudu Teki,
E: jagannadh.teki at gmail.com, P: +91-9676773388
Engineer - System Software Hacker
U-boot - SPI Custodian and Zynq APSOC
Ln: http://www.linkedin.com/in/jaganteki


More information about the U-Boot mailing list