[U-Boot] [PATCH v4 03/10] dm: spi: add BCM63xx SPI driver

[Jagan Teki <jagannadh.teki@gmail.com>]

On Thu, Jun 15, 2017 at 2:54 PM, Álvaro Fernández Rojas
<noltari@gmail.com> wrote:
> Hi Jagan,
>
> El 15/6/17 a las 7:38, Jagan Teki escribió:
>> On Wed, Jun 14, 2017 at 3:27 PM, Álvaro Fernández Rojas
>> <noltari@gmail.com> wrote:
>>> This driver is a simplified version of linux/drivers/spi/spi-bcm63xx.c
>>> Instead of supporting both HW revisions of the controller in a single build,
>>> support has been split by the selected config to save space.
>>>
>>> Signed-off-by: Álvaro Fernández Rojas <noltari@gmail.com>
>>> Reviewed-by: Simon Glass <sjg@chromium.org>
>>> Reviewed-by: Daniel Schwierzeck <daniel.schwierzeck@gmail.com>
>>> ---
>>>  v4: Introduce changes suggested by Jagan Teki:
>>>   - Add data for each HW controller instead of having two separate configs.
>>>   - Also check clock and reset returns as suggested by Simon Glass for HSSPI.
>>>  v3: rename BCM6338 SPI driver to BCM6348
>>>   switch to devfdt_get_addr_size_index()
>>>  v2: no changes
>>>
>>>  drivers/spi/Kconfig       |   8 +
>>>  drivers/spi/Makefile      |   1 +
>>>  drivers/spi/bcm63xx_spi.c | 419 ++++++++++++++++++++++++++++++++++++++++++++++
>>>  3 files changed, 428 insertions(+)
>>>  create mode 100644 drivers/spi/bcm63xx_spi.c
>>>
>>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>>> index bef864f..6da78bd 100644
>>> --- a/drivers/spi/Kconfig
>>> +++ b/drivers/spi/Kconfig
>>> @@ -40,6 +40,14 @@ config ATMEL_SPI
>>>           many AT32 (AVR32) and AT91 (ARM) chips. This driver can be
>>>           used to access the SPI Flash, such as AT25DF321.
>>>
>>> +config BCM63XX_SPI
>>> +       bool "BCM6348 SPI driver"
>>> +       depends on ARCH_BMIPS
>>> +       help
>>> +         Enable the BCM6348/BCM6358 SPI driver. This driver can be used to
>>> +         access the SPI NOR flash on platforms embedding these Broadcom
>>> +         SPI cores.
>>> +
>>>  config CADENCE_QSPI
>>>         bool "Cadence QSPI driver"
>>>         help
>>> diff --git a/drivers/spi/Makefile b/drivers/spi/Makefile
>>> index c090562..260ba06 100644
>>> --- a/drivers/spi/Makefile
>>> +++ b/drivers/spi/Makefile
>>> @@ -19,6 +19,7 @@ obj-$(CONFIG_ALTERA_SPI) += altera_spi.o
>>>  obj-$(CONFIG_ATH79_SPI) += ath79_spi.o
>>>  obj-$(CONFIG_ATMEL_DATAFLASH_SPI) += atmel_dataflash_spi.o
>>>  obj-$(CONFIG_ATMEL_SPI) += atmel_spi.o
>>> +obj-$(CONFIG_BCM63XX_SPI) += bcm63xx_spi.o
>>
>> Thanks for doing this change.
> That's what you requested ;).
>
>>
>>>  obj-$(CONFIG_CADENCE_QSPI) += cadence_qspi.o cadence_qspi_apb.o
>>>  obj-$(CONFIG_CF_SPI) += cf_spi.o
>>>  obj-$(CONFIG_DAVINCI_SPI) += davinci_spi.o
>>> diff --git a/drivers/spi/bcm63xx_spi.c b/drivers/spi/bcm63xx_spi.c
>>> new file mode 100644
>>> index 0000000..e1629fa
>>> --- /dev/null
>>> +++ b/drivers/spi/bcm63xx_spi.c
>>> @@ -0,0 +1,419 @@
>>> +/*
>>> + * Copyright (C) 2017 Álvaro Fernández Rojas <noltari@gmail.com>
>>> + *
>>> + * Derived from linux/drivers/spi/spi-bcm63xx.c:
>>> + *     Copyright (C) 2009-2012 Florian Fainelli <florian@openwrt.org>
>>> + *     Copyright (C) 2010 Tanguy Bouzeloc <tanguy.bouzeloc@efixo.com>
>>> + *
>>> + * SPDX-License-Identifier: GPL-2.0+
>>> + */
>>> +
>>> +#include <common.h>
>>> +#include <clk.h>
>>> +#include <dm.h>
>>> +#include <spi.h>
>>> +#include <reset.h>
>>> +#include <asm/io.h>
>>> +
>>> +DECLARE_GLOBAL_DATA_PTR;
>>> +
>>> +/* SPI Clock register */
>>> +#define SPI_CLK_SHIFT          0
>>> +#define SPI_CLK_20MHZ          (0 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_0_391MHZ       (1 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_0_781MHZ       (2 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_1_563MHZ       (3 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_3_125MHZ       (4 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_6_250MHZ       (5 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_12_50MHZ       (6 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_25MHZ          (7 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_MASK           (7 << SPI_CLK_SHIFT)
>>> +#define SPI_CLK_SSOFF_SHIFT    3
>>> +#define SPI_CLK_SSOFF_2                (2 << SPI_CLK_SSOFF_SHIFT)
>>> +#define SPI_CLK_SSOFF_MASK     (7 << SPI_CLK_SSOFF_SHIFT)
>>> +#define SPI_CLK_BSWAP_SHIFT    7
>>> +#define SPI_CLK_BSWAP_MASK     (1 << SPI_CLK_BSWAP_SHIFT)
>>> +
>>> +/* SPI Command register */
>>> +#define SPI_CMD_OP_SHIFT       0
>>> +#define SPI_CMD_OP_START       (0x3 << SPI_CMD_OP_SHIFT)
>>> +#define SPI_CMD_SLAVE_SHIFT    4
>>> +#define SPI_CMD_SLAVE_MASK     (0xf << SPI_CMD_SLAVE_SHIFT)
>>> +#define SPI_CMD_PREPEND_SHIFT  8
>>> +#define SPI_CMD_PREPEND_BYTES  0xf
>>> +#define SPI_CMD_3WIRE_SHIFT    12
>>> +#define SPI_CMD_3WIRE_MASK     (1 << SPI_CMD_3WIRE_SHIFT)
>>> +
>>> +/* SPI Control register */
>>> +# define SPI_CTL_TYPE_FD_RW    0
>>> +# define SPI_CTL_TYPE_HD_W     1
>>> +# define SPI_CTL_TYPE_HD_R     2
>>> +
>>> +/* SPI Interrupt registers */
>>> +#define SPI_IR_DONE_SHIFT      0
>>> +#define SPI_IR_DONE_MASK       (1 << SPI_IR_DONE_SHIFT)
>>> +#define SPI_IR_RXOVER_SHIFT    1
>>> +#define SPI_IR_RXOVER_MASK     (1 << SPI_IR_RXOVER_SHIFT)
>>> +#define SPI_IR_TXUNDER_SHIFT   2
>>> +#define SPI_IR_TXUNDER_MASK    (1 << SPI_IR_TXUNDER_SHIFT)
>>> +#define SPI_IR_TXOVER_SHIFT    3
>>> +#define SPI_IR_TXOVER_MASK     (1 << SPI_IR_TXOVER_SHIFT)
>>> +#define SPI_IR_RXUNDER_SHIFT   4
>>> +#define SPI_IR_RXUNDER_MASK    (1 << SPI_IR_RXUNDER_SHIFT)
>>> +#define SPI_IR_CLEAR_MASK      (SPI_IR_DONE_MASK |\
>>> +                                SPI_IR_RXOVER_MASK |\
>>> +                                SPI_IR_TXUNDER_MASK |\
>>> +                                SPI_IR_TXOVER_MASK |\
>>> +                                SPI_IR_RXUNDER_MASK)
>>> +
>>> +struct bcm63xx_spi_hw {
>>> +       /* SPI Clock register */
>>> +       uint16_t clk;
>>> +
>>> +       /* SPI Command register */
>>> +       uint16_t cmd;
>>> +
>>> +       /* SPI Control register */
>>> +       uint16_t ctl;
>>> +       uint8_t ctl_shift;
>>> +
>>> +       /* SPI Fill register */
>>> +       uint16_t fill;
>>> +
>>> +       /* SPI Interrupt registers */
>>> +       uint16_t ir_stat;
>>> +       uint16_t ir_mask;
>>> +
>>> +       /* SPI RX Data registers */
>>> +       uint16_t rx;
>>> +       uint16_t rx_size;
>>> +
>>> +       /* SPI TX Data registers */
>>> +       uint16_t tx;
>>> +       uint16_t tx_size;
>>> +};
>>> +
>>> +struct bcm63xx_spi_priv {
>>> +       const struct bcm63xx_spi_hw *hw;
>>> +       void __iomem *base;
>>> +       size_t tx_bytes;
>>> +       uint8_t num_cs;
>>> +};
>>> +
>>> +#define SPI_CLK_CNT            8
>>> +static const unsigned bcm63xx_spi_freq_table[SPI_CLK_CNT][2] = {
>>> +       { 25000000, SPI_CLK_25MHZ },
>>> +       { 20000000, SPI_CLK_20MHZ },
>>> +       { 12500000, SPI_CLK_12_50MHZ },
>>> +       {  6250000, SPI_CLK_6_250MHZ },
>>> +       {  3125000, SPI_CLK_3_125MHZ },
>>> +       {  1563000, SPI_CLK_1_563MHZ },
>>> +       {   781000, SPI_CLK_0_781MHZ },
>>> +       {   391000, SPI_CLK_0_391MHZ }
>>> +};
>>> +
>>> +static int bcm63xx_spi_cs_info(struct udevice *bus, uint cs,
>>> +                          struct spi_cs_info *info)
>>> +{
>>> +       struct bcm63xx_spi_priv *priv = dev_get_priv(bus);
>>> +
>>> +       if (cs >= priv->num_cs) {
>>> +               error("no cs %u\n", cs);
>>> +               return -ENODEV;
>>> +       }
>>> +
>>> +       return 0;
>>> +}
>>> +
>>> +static int bcm63xx_spi_set_mode(struct udevice *bus, uint mode)
>>> +{
>>> +       struct bcm63xx_spi_priv *priv = dev_get_priv(bus);
>>> +       const struct bcm63xx_spi_hw *hw = priv->hw;
>>> +
>>> +       if (mode & SPI_LSB_FIRST)
>>> +               setbits_8(priv->base + hw->clk, SPI_CLK_BSWAP_MASK);
>>> +       else
>>> +               clrbits_8(priv->base + hw->clk, SPI_CLK_BSWAP_MASK);
>>> +
>>> +       return 0;
>>> +}
>>> +
>>> +static int bcm63xx_spi_set_speed(struct udevice *bus, uint speed)
>>> +{
>>> +       struct bcm63xx_spi_priv *priv = dev_get_priv(bus);
>>> +       const struct bcm63xx_spi_hw *hw = priv->hw;
>>> +       uint8_t clk_cfg;
>>> +       int i;
>>> +
>>> +       /* default to lowest clock configuration */
>>> +       clk_cfg = SPI_CLK_0_391MHZ;
>>> +
>>> +       /* find the closest clock configuration */
>>> +       for (i = 0; i < SPI_CLK_CNT; i++) {
>>> +               if (speed >= bcm63xx_spi_freq_table[i][0]) {
>>> +                       clk_cfg = bcm63xx_spi_freq_table[i][1];
>>> +                       break;
>>> +               }
>>> +       }
>>> +
>>> +       /* write clock configuration */
>>> +       clrsetbits_8(priv->base + hw->clk,
>>> +                    SPI_CLK_SSOFF_MASK | SPI_CLK_MASK,
>>> +                    clk_cfg | SPI_CLK_SSOFF_2);
>>> +
>>> +       return 0;
>>> +}
>>> +
>>> +/*
>>> + * BCM63xx SPI driver doesn't allow keeping CS active between transfers since
>>> + * they are HW controlled.
>>> + * However, it provides a mechanism to prepend write transfers prior to read
>>> + * transfers (with a maximum prepend of 15 bytes), which is usually enough for
>>> + * SPI-connected flashes since reading requires prepending a write transfer of
>>> + * 5 bytes.
>>> + *
>>> + * This implementation takes advantage of the prepend mechanism and combines
>>> + * multiple transfers into a single one where possible (single/multiple write
>>> + * transfer(s) followed by a final read/write transfer).
>>> + * However, it's not possible to buffer reads, which means that read transfers
>>> + * should always be done as the final ones.
>>> + * On the other hand, take into account that combining write transfers into
>>> + * a single one is just buffering and doesn't require prepend mechanism.
>>> + */
>>> +static int bcm63xx_spi_xfer(struct udevice *dev, unsigned int bitlen,
>>> +               const void *dout, void *din, unsigned long flags)
>>> +{
>>> +       struct bcm63xx_spi_priv *priv = dev_get_priv(dev->parent);
>>> +       const struct bcm63xx_spi_hw *hw = priv->hw;
>>> +       size_t data_bytes = bitlen / 8;
>>> +
>>> +       if (flags & SPI_XFER_BEGIN) {
>>> +               /* clear prepends */
>>> +               priv->tx_bytes = 0;
>>> +
>>> +               /* initialize hardware */
>>> +               writeb_be(0, priv->base + hw->ir_mask);
>>> +       }
>>> +
>>> +       if (din) {
>>> +               /* buffering reads not possible since cs is hw controlled */
>>> +               if (!(flags & SPI_XFER_END)) {
>>> +                       error("unable to buffer reads\n");
>>> +                       return -EINVAL;
>>> +               }
>>> +
>>> +               /* check rx size */
>>> +                if (data_bytes > hw->rx_size) {
>>> +                       error("max rx bytes exceeded\n");
>>> +                       return -EMSGSIZE;
>>> +               }
>>> +       }
>>> +
>>> +       if (dout) {
>>> +               /* check tx size */
>>> +               if (priv->tx_bytes + data_bytes > hw->tx_size) {
>>> +                       error("max tx bytes exceeded\n");
>>> +                       return -EMSGSIZE;
>>> +               }
>>> +
>>> +               /* copy tx data */
>>> +               memcpy_toio(priv->base + hw->tx + priv->tx_bytes,
>>> +                           dout, data_bytes);
>>> +               priv->tx_bytes += data_bytes;
>>> +       }
>>> +
>>> +       if (flags & SPI_XFER_END) {
>>> +               struct dm_spi_slave_platdata *plat =
>>> +                       dev_get_parent_platdata(dev);
>>> +               uint16_t val;
>>> +               uint8_t irq;
>>> +
>>> +               /* determine control config */
>>> +               if (dout && !din) {
>>> +                       /* buffered write transfers */
>>> +                       val = priv->tx_bytes;
>>> +                       val |= (SPI_CTL_TYPE_HD_W << hw->ctl_shift);
>>> +                       priv->tx_bytes = 0;
>>> +               } else {
>>> +                       if (dout && din && (flags & SPI_XFER_ONCE)) {
>>> +                               /* full duplex read/write */
>>> +                               val = data_bytes;
>>> +                               val |= (SPI_CTL_TYPE_FD_RW << hw->ctl_shift);
>>> +                               priv->tx_bytes = 0;
>>> +                       } else {
>>> +                               /* prepended write transfer */
>>> +                               val = data_bytes;
>>> +                               val |= (SPI_CTL_TYPE_HD_R << hw->ctl_shift);
>>> +                               if (priv->tx_bytes > SPI_CMD_PREPEND_BYTES) {
>>> +                                       error("max prepend bytes exceeded\n");
>>> +                                       return -EMSGSIZE;
>>> +                               }
>>> +                       }
>>> +               }
>>> +
>>> +               if (hw->ctl_shift >= 8)
>>> +                       writew_be(val, priv->base + hw->ctl);
>>> +               else
>>> +                       writeb_be(val, priv->base + hw->ctl);
>>> +
>>> +               /* clear interrupts */
>>> +               writeb_be(SPI_IR_CLEAR_MASK, priv->base + hw->ir_stat);
>>> +
>>> +               /* issue the transfer */
>>> +               val = SPI_CMD_OP_START;
>>> +               val |= (plat->cs << SPI_CMD_SLAVE_SHIFT) & SPI_CMD_SLAVE_MASK;
>>> +               val |= (priv->tx_bytes << SPI_CMD_PREPEND_SHIFT);
>>> +               if (plat->mode & SPI_3WIRE)
>>> +                       val |= SPI_CMD_3WIRE_MASK;
>>> +               writew_be(val, priv->base + hw->cmd);
>>> +
>>> +               /* enable interrupts */
>>> +               writeb_be(SPI_IR_DONE_MASK, priv->base + hw->ir_mask);
>>> +
>>> +               do {
>>> +                       /* read interupts */
>>> +                       irq = readb_be(priv->base + hw->ir_stat);
>>> +
>>> +                       /* transfer completed */
>>> +                       if (irq & SPI_IR_DONE_MASK)
>>> +                               break;
>>> +               } while (1);
>>> +
>>> +               /* copy rx data */
>>> +               if (din)
>>> +                       memcpy_fromio(din, priv->base + hw->rx,
>>> +                                     data_bytes);
>>> +       }
>>> +
>>> +       return 0;
>>> +}
>>> +
>>> +static const struct dm_spi_ops bcm63xx_spi_ops = {
>>> +       .cs_info = bcm63xx_spi_cs_info,
>>> +       .set_mode = bcm63xx_spi_set_mode,
>>> +       .set_speed = bcm63xx_spi_set_speed,
>>> +       .xfer = bcm63xx_spi_xfer,
>>> +};
>>> +
>>> +static const struct bcm63xx_spi_hw bcm63xx_spi_bcm6348 = {
>>> +       .clk = 0x06,
>>> +       .cmd = 0x00,
>>> +       .ctl = 0x40,
>>> +       .ctl_shift = 6,
>>> +       .fill = 0x07,
>>> +       .ir_stat = 0x02,
>>> +       .ir_mask = 0x04,
>>> +       .rx = 0x80,
>>> +       .rx_size = 0x3f,
>>> +       .tx = 0x41,
>>> +       .tx_size = 0x3f,
>>> +};
>>
>> Define these hexcodes into macros like SPI_6348_CLK_CFG
> Ok, I will do that.
>
>>
>>> +
>>> +static const struct bcm63xx_spi_hw bcm63xx_spi_bcm6358 = {
>>> +       .clk = 0x706,
>>> +       .cmd = 0x700,
>>> +       .ctl = 0x000,
>>> +       .ctl_shift = 14,
>>> +       .fill = 0x707,
>>> +       .ir_stat = 0x702,
>>> +       .ir_mask = 0x704,
>>> +       .rx = 0x400,
>>> +       .rx_size = 0x220,
>>> +       .tx = 0x002,
>>> +       .tx_size = 0x21e,
>>> +};
>>
>> Define these hexcodes into macros like SPI_6358_CLK_CFG
> Ok, I will do that.
>
>>
>>> +
>>> +static const struct udevice_id bcm63xx_spi_ids[] = {
>>> +       {
>>> +               .compatible = "brcm,bcm6348-spi",
>>> +               .data = (ulong)&bcm63xx_spi_bcm6348,
>>> +       }, {
>>> +               .compatible = "brcm,bcm6358-spi",
>>> +               .data = (ulong)&bcm63xx_spi_bcm6358,
>>> +       }, { /* sentinel */ }
>>> +};
>>
>> I think this can even write more like long value instead making it in
>> structure, so-that rotating the 'struct bcm63xx_spi_hw' to respective
>> functions can avoid. like definig members in enum and use these as an
>> offset along with specific reg_space while doing io ops.
> I don't think I'm following, can you provide an example of how you want it done?
> Maybe a driver that is doing that in u-boot or something similar...

static const unsigned log bcm63xx_spi_bcm6348 = {
     [SPI_CMD]                   = SPI_6348_CMD,
     [SPI_INT_STATUS]      = SPI_6348_INT_STATUS,
    .......
    .....
};


*_probe(struct udevice *dev)
{
   const unsigned long *bcm63xx_spireg;

   /* need to assign the probed data to bcm63xx_spireg */
}

For more infor this mught look simialr to Linux drivers/spi/spi-bcm63xx.c

thanks!
-- 
Jagan Teki
Free Software Engineer | www.openedev.com
U-Boot, Linux | Upstream Maintainer
Hyderabad, India.