| Message ID | 1394541891-26469-2-git-send-email-jcmvbkbc@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Tue, Mar 11, 2014 at 04:44:49PM +0400, Max Filippov wrote: > +static inline int xtfpga_spi_wait_busy(struct xtfpga_spi *xspi) > +{ > + unsigned long timeout = jiffies + msecs_to_jiffies(100); > + while (xtfpga_spi_read32(xspi, XTFPGA_SPI_BUSY)) { > + if (!time_before(jiffies, timeout)) > + return -EBUSY; > + else > + cpu_relax(); > + } > + return 0; > +} So we'll busy wait for up to 100ms - that seems like an awfully long time. Perhaps fall back to msleep() if the delay is non-trivial (or just reduce the timeout)? If there are large enough FIFOs dead reckoning a sleep for the expected transfer time might be helpful but it seems like there's no meaningful FIFO. > +/* Unused: this device controls its only CS automatically, > + * deactivating it after every 16 bit transfer completion. > + */ This is too limited to use with most SPI clients, they'll want to be able to transmit more than one word (and the fact that only 16 bit words are supported is also an issue, though that's easy enough to handle for a bitbanging driver - I'd really strongly suggest supporting 8 bits per word as well). Clients are pretty much going to need to use GPIO based chip select, you should make sure that's supported and covered in the binding. > +static void xtfpga_spi_chipselect(struct spi_device *spi, int is_on) > +{ > +} Omit this since it's empty.
On Tue, Mar 11, 2014 at 11:49 PM, Mark Brown <broonie@kernel.org> wrote: > On Tue, Mar 11, 2014 at 04:44:49PM +0400, Max Filippov wrote: > >> +static inline int xtfpga_spi_wait_busy(struct xtfpga_spi *xspi) >> +{ >> + unsigned long timeout = jiffies + msecs_to_jiffies(100); >> + while (xtfpga_spi_read32(xspi, XTFPGA_SPI_BUSY)) { >> + if (!time_before(jiffies, timeout)) >> + return -EBUSY; >> + else >> + cpu_relax(); >> + } >> + return 0; >> +} > > So we'll busy wait for up to 100ms - that seems like an awfully long > time. Perhaps fall back to msleep() if the delay is non-trivial (or > just reduce the timeout)? The timeout is here for the unlikely case everything went wrong. Normally transfers get completed in about 10 useconds on 50 MHz hardware, it doesn't seem worth msleeping here. I put the timeout here just because otherwise infinite loop polling the device register looks scary. > If there are large enough FIFOs dead > reckoning a sleep for the expected transfer time might be helpful but it > seems like there's no meaningful FIFO. Right, there's no FIFO in that device. >> +/* Unused: this device controls its only CS automatically, >> + * deactivating it after every 16 bit transfer completion. >> + */ > > This is too limited to use with most SPI clients, they'll want to be > able to transmit more than one word (and the fact that only 16 bit words > are supported is also an issue, though that's easy enough to handle for > a bitbanging driver - I'd really strongly suggest supporting 8 bits per > word as well). Clients are pretty much going to need to use GPIO based > chip select, you should make sure that's supported and covered in the > binding. There's no hardware for that. This device is really dumb, it is specifically suited to control TLV320AIC23 which expects exactly 16 bit words, SPI mode 0. >> +static void xtfpga_spi_chipselect(struct spi_device *spi, int is_on) >> +{ >> +} > > Omit this since it's empty. The bitbang side doesn't like when this callback is NULL and returns -EINVAL from spi_bitbang_start.
On Wed, Mar 12, 2014 at 12:20:49AM +0400, Max Filippov wrote: > On Tue, Mar 11, 2014 at 11:49 PM, Mark Brown <broonie@kernel.org> wrote: > > On Tue, Mar 11, 2014 at 04:44:49PM +0400, Max Filippov wrote: > >> + unsigned long timeout = jiffies + msecs_to_jiffies(100); > >> + while (xtfpga_spi_read32(xspi, XTFPGA_SPI_BUSY)) { > >> + if (!time_before(jiffies, timeout)) > >> + return -EBUSY; > >> + else > >> + cpu_relax(); > >> + } > > So we'll busy wait for up to 100ms - that seems like an awfully long > > time. Perhaps fall back to msleep() if the delay is non-trivial (or > > just reduce the timeout)? > The timeout is here for the unlikely case everything went wrong. Normally > transfers get completed in about 10 useconds on 50 MHz hardware, it > doesn't seem worth msleeping here. I put the timeout here just because > otherwise infinite loop polling the device register looks scary. I appreciate that but even with 5MHz that's three orders of magnitude longer busy waiting in the error case than the operation is expected to take. If you must wait for that long busy wait for a bit then start sleeping. > > >> +/* Unused: this device controls its only CS automatically, > >> + * deactivating it after every 16 bit transfer completion. > >> + */ > > This is too limited to use with most SPI clients, they'll want to be > > able to transmit more than one word (and the fact that only 16 bit words > > are supported is also an issue, though that's easy enough to handle for > > a bitbanging driver - I'd really strongly suggest supporting 8 bits per > > word as well). Clients are pretty much going to need to use GPIO based > > chip select, you should make sure that's supported and covered in the > > binding. > There's no hardware for that. This device is really dumb, it is specifically > suited to control TLV320AIC23 which expects exactly 16 bit words, SPI > mode 0. This driver is not actually compatible with the tlv320aic23 driver since it needs 8 bit words, you need to at least support that. You don't need hardware in the controller to support a GPIO chip select, the whole point is that the controller chip select isn't wired up and a GPIO is used instead. > >> +static void xtfpga_spi_chipselect(struct spi_device *spi, int is_on) > >> +{ > >> +} > > Omit this since it's empty. > The bitbang side doesn't like when this callback is NULL and returns > -EINVAL from spi_bitbang_start. So fix that, but really it's trying to tell you that the hardware is far too limited to work with many things.
On Wed, Mar 12, 2014 at 4:34 AM, Mark Brown <broonie@kernel.org> wrote: > On Wed, Mar 12, 2014 at 12:20:49AM +0400, Max Filippov wrote: >> On Tue, Mar 11, 2014 at 11:49 PM, Mark Brown <broonie@kernel.org> wrote: >> > On Tue, Mar 11, 2014 at 04:44:49PM +0400, Max Filippov wrote: > >> >> + unsigned long timeout = jiffies + msecs_to_jiffies(100); >> >> + while (xtfpga_spi_read32(xspi, XTFPGA_SPI_BUSY)) { >> >> + if (!time_before(jiffies, timeout)) >> >> + return -EBUSY; >> >> + else >> >> + cpu_relax(); >> >> + } > >> > So we'll busy wait for up to 100ms - that seems like an awfully long >> > time. Perhaps fall back to msleep() if the delay is non-trivial (or >> > just reduce the timeout)? > >> The timeout is here for the unlikely case everything went wrong. Normally >> transfers get completed in about 10 useconds on 50 MHz hardware, it >> doesn't seem worth msleeping here. I put the timeout here just because >> otherwise infinite loop polling the device register looks scary. > > I appreciate that but even with 5MHz that's three orders of magnitude > longer busy waiting in the error case than the operation is expected to > take. If you must wait for that long busy wait for a bit then start > sleeping. Ok, I'll fix that. >> >> +/* Unused: this device controls its only CS automatically, >> >> + * deactivating it after every 16 bit transfer completion. >> >> + */ > >> > This is too limited to use with most SPI clients, they'll want to be >> > able to transmit more than one word (and the fact that only 16 bit words >> > are supported is also an issue, though that's easy enough to handle for >> > a bitbanging driver - I'd really strongly suggest supporting 8 bits per >> > word as well). Clients are pretty much going to need to use GPIO based >> > chip select, you should make sure that's supported and covered in the >> > binding. > >> There's no hardware for that. This device is really dumb, it is specifically >> suited to control TLV320AIC23 which expects exactly 16 bit words, SPI >> mode 0. > > This driver is not actually compatible with the tlv320aic23 driver since > it needs 8 bit words, you need to at least support that. You don't need That's strange, because the codec datasheet says the following (section 3.1.1): A control word consists of 16 bits, starting with the MSB. The data bits are latched on the rising edge of SCLK. A rising edge on CS after the 16th rising clock edge latches the data word into the AIC (see Figure 3-1). And tlv320aic23 has the following regmap: const struct regmap_config tlv320aic23_regmap = { .reg_bits = 7, .val_bits = 9, and its SPI interface accordingly does the following in .probe: spi->bits_per_word = 16 spi->mode = SPI_MODE_0; ret = spi_setup(spi); > hardware in the controller to support a GPIO chip select, the whole > point is that the controller chip select isn't wired up and a GPIO is > used instead. Actually it's not GPIO. The controller asserts CS line once we set the start bit while the busy bit is cleared and deasserts it after 16 SCK pulses. >> >> +static void xtfpga_spi_chipselect(struct spi_device *spi, int is_on) >> >> +{ >> >> +} > >> > Omit this since it's empty. > >> The bitbang side doesn't like when this callback is NULL and returns >> -EINVAL from spi_bitbang_start. > > So fix that, but really it's trying to tell you that the hardware is far > too limited to work with many things. Ok. It's not designed to work with many things. Should I just move this driver to the rest of the platform code under arch/xtensa/platform/xtfpga?
On Wed, Mar 12, 2014 at 04:59:47AM +0400, Max Filippov wrote: > On Wed, Mar 12, 2014 at 4:34 AM, Mark Brown <broonie@kernel.org> wrote: > > This driver is not actually compatible with the tlv320aic23 driver since > > it needs 8 bit words, you need to at least support that. You don't need > That's strange, because the codec datasheet says the following (section > 3.1.1): > A control word consists of 16 bits, starting with the MSB. The data bits are > latched on the rising edge of SCLK. A rising edge on CS after the 16th rising > clock edge latches the data word into the AIC (see Figure 3-1). > And tlv320aic23 has the following regmap: > const struct regmap_config tlv320aic23_regmap = { > .reg_bits = 7, > .val_bits = 9, Yes, and regmap will format that itself for transmission in 8 bit words so you don't want the SPI controller to also do byte swapping. > and its SPI interface accordingly does the following in .probe: > spi->bits_per_word = 16 > spi->mode = SPI_MODE_0; > ret = spi_setup(spi); That's buggy, drivers should never configure anything more than 8 bits per word with regmap. > > hardware in the controller to support a GPIO chip select, the whole > > point is that the controller chip select isn't wired up and a GPIO is > > used instead. > Actually it's not GPIO. The controller asserts CS line once we set the > start bit while the busy bit is cleared and deasserts it after 16 SCK > pulses. You're missing the point. The controller chip select line can do what it likes, it's not connected to the target device if a GPIO is being used. > > So fix that, but really it's trying to tell you that the hardware is far > > too limited to work with many things. > Ok. It's not designed to work with many things. Should I just move this > driver to the rest of the platform code under arch/xtensa/platform/xtfpga? No, not if you intend to use generic drivers with it.
On Wed, Mar 12, 2014 at 04:59:47AM +0400, Max Filippov wrote: > And tlv320aic23 has the following regmap: > const struct regmap_config tlv320aic23_regmap = { > .reg_bits = 7, > .val_bits = 9, > and its SPI interface accordingly does the following in .probe: > spi->bits_per_word = 16 > spi->mode = SPI_MODE_0; > ret = spi_setup(spi); So I just looked again - the SPI code isn't in mainline, there must be some out of tree patches here that can't have been tested since the driver was converted to regmap (or the byte swapping you're doing in the controller is buggy for 16 bits per word).
On Wed, Mar 12, 2014 at 5:08 AM, Mark Brown <broonie@kernel.org> wrote: > On Wed, Mar 12, 2014 at 04:59:47AM +0400, Max Filippov wrote: >> On Wed, Mar 12, 2014 at 4:34 AM, Mark Brown <broonie@kernel.org> wrote: > >> > This driver is not actually compatible with the tlv320aic23 driver since >> > it needs 8 bit words, you need to at least support that. You don't need > >> That's strange, because the codec datasheet says the following (section >> 3.1.1): > >> A control word consists of 16 bits, starting with the MSB. The data bits are >> latched on the rising edge of SCLK. A rising edge on CS after the 16th rising >> clock edge latches the data word into the AIC (see Figure 3-1). > >> And tlv320aic23 has the following regmap: > >> const struct regmap_config tlv320aic23_regmap = { >> .reg_bits = 7, >> .val_bits = 9, > > Yes, and regmap will format that itself for transmission in 8 bit words > so you don't want the SPI controller to also do byte swapping. > >> and its SPI interface accordingly does the following in .probe: > >> spi->bits_per_word = 16 >> spi->mode = SPI_MODE_0; >> ret = spi_setup(spi); > > That's buggy, drivers should never configure anything more than 8 bits > per word with regmap. Ok, so the driver should allow for 8 bit transfers and regmap will arrange transfers as 8-bit pairs, making CS to be asserted for 16 bits, right? Hmmm... I see the only way to support that with that hardware: advertise 8 bit support, buffer bytes up to 16 bits, send 16 bit words on CS deassertion request, log violations verbosely. Other ideas? >> > hardware in the controller to support a GPIO chip select, the whole >> > point is that the controller chip select isn't wired up and a GPIO is >> > used instead. > >> Actually it's not GPIO. The controller asserts CS line once we set the >> start bit while the busy bit is cleared and deasserts it after 16 SCK >> pulses. > > You're missing the point. The controller chip select line can do what > it likes, it's not connected to the target device if a GPIO is being > used. In my case SPI controller is wired directly to the codec with three wires: SDIN, SCLK and CS. There are no registers that can control either of these wires independently of others.
On Wed, Mar 12, 2014 at 5:11 AM, Mark Brown <broonie@kernel.org> wrote: > On Wed, Mar 12, 2014 at 04:59:47AM +0400, Max Filippov wrote: > >> And tlv320aic23 has the following regmap: > >> const struct regmap_config tlv320aic23_regmap = { >> .reg_bits = 7, >> .val_bits = 9, > >> and its SPI interface accordingly does the following in .probe: > >> spi->bits_per_word = 16 >> spi->mode = SPI_MODE_0; >> ret = spi_setup(spi); > > So I just looked again - the SPI code isn't in mainline, there must > be some out of tree patches here that can't have been tested since the > driver was converted to regmap (or the byte swapping you're doing in the > controller is buggy for 16 bits per word). I'm successfully running this driver with the patches in your ASoC tree branch topic/tlv320aic23.
On Wed, Mar 12, 2014 at 05:43:49AM +0400, Max Filippov wrote: > On Wed, Mar 12, 2014 at 5:08 AM, Mark Brown <broonie@kernel.org> wrote: > > That's buggy, drivers should never configure anything more than 8 bits > > per word with regmap. > Ok, so the driver should allow for 8 bit transfers and regmap will arrange > transfers as 8-bit pairs, making CS to be asserted for 16 bits, right? > Hmmm... I see the only way to support that with that hardware: advertise > 8 bit support, buffer bytes up to 16 bits, send 16 bit words on CS deassertion > request, log violations verbosely. Other ideas? That's about it. Like I keep saying for any sort of generic use you really want to support 8 bits per word. > > You're missing the point. The controller chip select line can do what > > it likes, it's not connected to the target device if a GPIO is being > > used. > In my case SPI controller is wired directly to the codec with three > wires: SDIN, SCLK and CS. There are no registers that can control > either of these wires independently of others. Right, but other users are likely to exist and the framework has support for this so it's not much work to support.
On Wed, Mar 12, 2014 at 05:48:16AM +0400, Max Filippov wrote: > On Wed, Mar 12, 2014 at 5:11 AM, Mark Brown <broonie@kernel.org> wrote: > > So I just looked again - the SPI code isn't in mainline, there must > > be some out of tree patches here that can't have been tested since the > > driver was converted to regmap (or the byte swapping you're doing in the > > controller is buggy for 16 bits per word). > I'm successfully running this driver with the patches in your ASoC tree > branch topic/tlv320aic23. Ah, I missed that during review - the driver shouldn't be forcing 16 bits per word, any swapping that's needed should be being done in the regmap API. Though based on the discussion of the SPI driver it seems like this may be compensating for an unwanted byte swap there.
diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig index 581ee2a..e3f5335 100644 --- a/drivers/spi/Kconfig +++ b/drivers/spi/Kconfig @@ -520,6 +520,19 @@ config SPI_XILINX Or for the DS570, see "XPS Serial Peripheral Interface (SPI) (v2.00b)" +config SPI_XTENSA_XTFPGA + tristate "Xtensa SPI controller for xtfpga" + depends on XTENSA && XTENSA_PLATFORM_XTFPGA + select SPI_BITBANG + help + SPI driver for xtfpga SPI master controller. + + This simple SPI master controller is built into xtfpga bitstreams + and is used to control daughterboard audio codec. It always transfers + 16 bit words in SPI mode 0, automatically asserting CS on transfer + start and deasserting on end. + + config SPI_NUC900 tristate "Nuvoton NUC900 series SPI" depends on ARCH_W90X900 diff --git a/drivers/spi/Makefile b/drivers/spi/Makefile index 95af48d..5379ade 100644 --- a/drivers/spi/Makefile +++ b/drivers/spi/Makefile @@ -79,3 +79,4 @@ obj-$(CONFIG_SPI_TOPCLIFF_PCH) += spi-topcliff-pch.o obj-$(CONFIG_SPI_TXX9) += spi-txx9.o obj-$(CONFIG_SPI_XCOMM) += spi-xcomm.o obj-$(CONFIG_SPI_XILINX) += spi-xilinx.o +obj-$(CONFIG_SPI_XTENSA_XTFPGA) += spi-xtensa-xtfpga.o diff --git a/drivers/spi/spi-xtensa-xtfpga.c b/drivers/spi/spi-xtensa-xtfpga.c new file mode 100644 index 0000000..3131916 --- /dev/null +++ b/drivers/spi/spi-xtensa-xtfpga.c @@ -0,0 +1,165 @@ +/* + * Xtensa xtfpga SPI controller driver + * + * Copyright (c) 2014 Cadence Design Systems Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + */ + +#include <linux/io.h> +#include <linux/jiffies.h> +#include <linux/module.h> +#include <linux/of.h> +#include <linux/platform_device.h> +#include <linux/spi/spi.h> +#include <linux/spi/spi_bitbang.h> + +#define XTFPGA_SPI_NAME "xtfpga_spi" + +#define XTFPGA_SPI_START 0x0 +#define XTFPGA_SPI_BUSY 0x4 +#define XTFPGA_SPI_DATA 0x8 + +struct xtfpga_spi { + struct spi_bitbang bitbang; + void __iomem *regs; +}; + +static inline void xtfpga_spi_write32(const struct xtfpga_spi *spi, + unsigned addr, u32 val) +{ + iowrite32(val, spi->regs + addr); +} + +static inline unsigned int xtfpga_spi_read32(const struct xtfpga_spi *spi, + unsigned addr) +{ + return ioread32(spi->regs + addr); +} + +static inline int xtfpga_spi_wait_busy(struct xtfpga_spi *xspi) +{ + unsigned long timeout = jiffies + msecs_to_jiffies(100); + while (xtfpga_spi_read32(xspi, XTFPGA_SPI_BUSY)) { + if (!time_before(jiffies, timeout)) + return -EBUSY; + else + cpu_relax(); + } + return 0; +} + +static u32 xtfpga_spi_txrx_word(struct spi_device *spi, unsigned nsecs, + u32 v, u8 bits) +{ + struct xtfpga_spi *xspi = spi_master_get_devdata(spi->master); + + /* Bytes that should go out earlier have lower addresses, + * but the hardware operates with 16 bit words and transmits + * higher bits first. Thus data in memory is in BE order. + */ + xtfpga_spi_write32(xspi, XTFPGA_SPI_DATA, be16_to_cpu(v)); + xtfpga_spi_write32(xspi, XTFPGA_SPI_START, 1); + xtfpga_spi_wait_busy(xspi); + xtfpga_spi_write32(xspi, XTFPGA_SPI_START, 0); + + return 0; +} + +/* Unused: this device controls its only CS automatically, + * deactivating it after every 16 bit transfer completion. + */ +static void xtfpga_spi_chipselect(struct spi_device *spi, int is_on) +{ +} + +static int xtfpga_spi_probe(struct platform_device *pdev) +{ + struct xtfpga_spi *xspi; + struct resource *mem; + int ret; + struct spi_master *master; + + master = spi_alloc_master(&pdev->dev, sizeof(struct xtfpga_spi)); + if (!master) + return -ENOMEM; + + master->flags = SPI_MASTER_NO_RX; + master->bits_per_word_mask = SPI_BPW_MASK(16); + master->bus_num = pdev->dev.id; + master->dev.of_node = pdev->dev.of_node; + + xspi = spi_master_get_devdata(master); + xspi->bitbang.master = master; + xspi->bitbang.chipselect = xtfpga_spi_chipselect; + xspi->bitbang.txrx_word[SPI_MODE_0] = xtfpga_spi_txrx_word; + + mem = platform_get_resource(pdev, IORESOURCE_MEM, 0); + if (!mem) { + dev_err(&pdev->dev, "No memory resource\n"); + ret = -ENODEV; + goto err; + } + xspi->regs = devm_ioremap_resource(&pdev->dev, mem); + if (IS_ERR(xspi->regs)) { + ret = PTR_ERR(xspi->regs); + goto err; + } + + xtfpga_spi_write32(xspi, XTFPGA_SPI_START, 0); + ret = xtfpga_spi_wait_busy(xspi); + if (ret < 0) { + dev_err(&pdev->dev, "Device stuck in busy state\n"); + goto err; + } + + ret = spi_bitbang_start(&xspi->bitbang); + if (ret < 0) { + dev_err(&pdev->dev, "spi_bitbang_start failed\n"); + goto err; + } + + platform_set_drvdata(pdev, master); + return 0; +err: + spi_master_put(master); + return ret; +} + +static int xtfpga_spi_remove(struct platform_device *pdev) +{ + struct spi_master *master = platform_get_drvdata(pdev); + struct xtfpga_spi *xspi = spi_master_get_devdata(master); + + spi_bitbang_stop(&xspi->bitbang); + spi_master_put(master); + + return 0; +} + +MODULE_ALIAS("platform:" XTFPGA_SPI_NAME); + +#ifdef CONFIG_OF +static const struct of_device_id xtfpga_spi_of_match[] = { + { .compatible = "cdns,xtfpga-spi", }, + {} +}; +MODULE_DEVICE_TABLE(of, xtfpga_spi_of_match); +#endif + +static struct platform_driver xtfpga_spi_driver = { + .probe = xtfpga_spi_probe, + .remove = xtfpga_spi_remove, + .driver = { + .name = XTFPGA_SPI_NAME, + .owner = THIS_MODULE, + .of_match_table = of_match_ptr(xtfpga_spi_of_match), + }, +}; +module_platform_driver(xtfpga_spi_driver); + +MODULE_AUTHOR("Max Filippov <jcmvbkbc@gmail.com>"); +MODULE_DESCRIPTION("xtensa xtfpga SPI driver"); +MODULE_LICENSE("GPL");
This simple SPI master controller is built into xtfpga bitstreams. It always transfers 16 bit words in SPI mode 0, automatically asserting CS on transfer start and deasserting on end. Signed-off-by: Max Filippov <jcmvbkbc@gmail.com> --- drivers/spi/Kconfig | 13 ++++ drivers/spi/Makefile | 1 + drivers/spi/spi-xtensa-xtfpga.c | 165 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 179 insertions(+) create mode 100644 drivers/spi/spi-xtensa-xtfpga.c