SPI patches for 2.6.17-rc4
PATCH 1/1 SPI patches for 2.6.17-rc4
Here are some patches for 2.6.17-rc4 for the SPI subsystem that have been sitting langushing way too long in my tree and in the -mm tree. They are all self-contained and fix some SPI issues and add a new SPI driver.
They also name David Brownell as the SPI maintainer, and he'll handle getting patches to you from now on (either through Andrew or directly, they will work that out.)
Please pull from:
git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/spi-2.6.git/ or if master.kernel.org hasn't synced up yet: master.kernel.org:/pub/scm/linux/kernel/git/gregkh/spi-2.6.git/
The full patches will be sent to the linux-kernel mailing list, if anyone wants to see them.
thanks,
greg k-h
Documentation/spi/pxa2xx | 234 +++++ Documentation/spi/spi-summary | 34 MAINTAINERS | 6 drivers/spi/Kconfig | 8 drivers/spi/Makefile | 1 drivers/spi/pxa2xx_spi.c | 1467 ++++++++++++++++++++++++++++++++++ drivers/spi/spi.c | 7 drivers/spi/spi_bitbang.c | 104 +- include/asm-arm/arch-pxa/pxa2xx_spi.h | 68 + include/linux/spi/spi.h | 45 - include/linux/spi/spi_bitbang.h | 8 11 files changed, 1941 insertions(+), 41 deletions(-)
---------------
David Brownell:
SPI: spi whitespace fixes
SPI: spi bounce buffer has a minimum length
SPI: devices can require LSB-first encodings
SPI: busnum == 0 needs to work
SPI: spi_bitbang: clocking fixes
Imre Deak:
SPI: per-transfer overrides for wordsize and clocking
Kumar Gala:
SPI: Add David as the SPI subsystem maintainer
SPI: Renamed bitbang_transfer_setup to spi_bitbang_setup_transfer and export it
Stephen Street:
SPI: add PXA2xx SSP SPI Driver
spi: Update to PXA2xx SPI Driver
PATCH 9/10 spi: Update to PXA2xx SPI Driver
In reply to Greg KHFrom: Stephen Street <[email protected]>
Fix two outstanding issues with the pxa2xx_spi driver:
1) Bad cast in the function u32_writer. Thanks to Henrik Bechmann
2) Adds support for per transfer changes to speed and bits per word
---
drivers/spi/pxa2xx_spi.c | 82 ++++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 75 insertions(+), 7 deletions(-)
9708c121c38fe864eb6f5a119f7525729686e095
drivers/spi/pxa2xx_spi.c +75 -7
@@ -120,6 +120,8 @@ struct driver_data {dma_addr_t tx_dma;size_t rx_map_len;size_t tx_map_len; +u8 n_bytes; +u32 dma_width;int cs_change;void (*write)(struct driver_data *drv_data);void (*read)(struct driver_data *drv_data);
@@ -139,6 +141,8 @@ struct chip_data {u32 threshold;u32 dma_threshold;u8 enable_dma; +u8 bits_per_word; +u32 speed_hz;void (*write)(struct driver_data *drv_data);void (*read)(struct driver_data *drv_data);void (*cs_control)(u32 command);
@@ -186,7 +190,7 @@ static void null_cs_control(u32 command)static void null_writer (struct driver_data *drv_data) {void *reg = drv_data->ioaddr; -u8 n_bytes = drv_data->cur_chip->n_bytes; +u8 n_bytes = drv_data->n_bytes;while ((read_SSSR (reg) &SSSR_TNF ) && (drv_data->tx < drv_data->tx_end)) {
@@ -198,7 +202,7 @@ static void null_writer(struct driver_dastatic void null_reader (struct driver_data *drv_data) {void *reg = drv_data->ioaddr; -u8 n_bytes = drv_data->cur_chip->n_bytes; +u8 n_bytes = drv_data->n_bytes;while ((read_SSSR (reg) &SSSR_RNE ) && (drv_data->rx < drv_data->rx_end)) {
@@ -256,7 +260,7 @@ static void u32_writer(struct driver_datwhile ((read_SSSR (reg) &SSSR_TNF ) && (drv_data->tx < drv_data->tx_end)) { -write_SSDR (*(u16 *)(drv_data->tx), reg); +write_SSDR (*(u32 *)(drv_data->tx), reg); drv_data->tx +=4 ; } }
@@ -677,6 +681,10 @@ static void pump_transfers(unsigned longstruct spi_transfer *previous =NULL ;struct chip_data *chip =NULL ;void *reg = drv_data->ioaddr; +u32 clk_div =0 ; +u8 bits =0 ; +u32 speed =0 ; +u32 cr0;/* Get current state information */ message = drv_data->cur_msg;
@@ -713,6 +721,8 @@ static void pump_transfers(unsigned longgiveback (message, drv_data);return ; } + drv_data->n_bytes = chip->n_bytes; + drv_data->dma_width = chip->dma_width; drv_data->cs_control = chip->cs_control; drv_data->tx = (void *)transfer->tx_buf; drv_data->tx_end = drv_data->tx + transfer->len;
@@ -724,6 +734,62 @@ static void pump_transfers(unsigned long drv_data->write = drv_data->tx ? chip->write : null_writer; drv_data->read = drv_data->rx ? chip->read : null_reader; drv_data->cs_change = transfer->cs_change; + +/* Change speed and bit per word on a per transfer */ +if (transfer->speed_hz || transfer->bits_per_word) { + +/* Disable clock */ +write_SSCR0 (chip->cr0 & ~SSCR0_SSE , reg); + cr0 = chip->cr0; + bits = chip->bits_per_word; + speed = chip->speed_hz; + +if (transfer->speed_hz) + speed = transfer->speed_hz; + +if (transfer->bits_per_word) + bits = transfer->bits_per_word; + +if (reg ==SSP1_VIRT ) + clk_div =SSP1_SerClkDiv (speed); +else if (reg ==SSP2_VIRT ) + clk_div =SSP2_SerClkDiv (speed); +else if (reg ==SSP3_VIRT ) + clk_div =SSP3_SerClkDiv (speed); + +if (bits <=8 ) { + drv_data->n_bytes =1 ; + drv_data->dma_width =DCMD_WIDTH1 ; + drv_data->read = drv_data->read != null_reader ? + u8_reader : null_reader; + drv_data->write = drv_data->write != null_writer ? + u8_writer : null_writer; + }else if (bits <=16 ) { + drv_data->n_bytes =2 ; + drv_data->dma_width =DCMD_WIDTH2 ; + drv_data->read = drv_data->read != null_reader ? + u16_reader : null_reader; + drv_data->write = drv_data->write != null_writer ? + u16_writer : null_writer; + }else if (bits <=32 ) { + drv_data->n_bytes =4 ; + drv_data->dma_width =DCMD_WIDTH4 ; + drv_data->read = drv_data->read != null_reader ? + u32_reader : null_reader; + drv_data->write = drv_data->write != null_writer ? + u32_writer : null_writer; + } + + cr0 = clk_div + | SSCR0_Motorola + |SSCR0_DataSize (bits &0x0f ) + |SSCR0_SSE + | (bits >16 ?SSCR0_EDSS :0 ); + +/* Start it back up */ +write_SSCR0 (cr0, reg); + } + message->state =RUNNING_STATE ;/* Try to map dma buffer and do a dma transfer if successful */
@@ -739,13 +805,13 @@ static void pump_transfers(unsigned longif (drv_data->rx == drv_data->null_dma_buf)/* No target address increment */ DCMD (drv_data->rx_channel) =DCMD_FLOWSRC - | chip->dma_width + | drv_data->dma_width | chip->dma_burst_size | drv_data->len;else DCMD (drv_data->rx_channel) =DCMD_INCTRGADDR |DCMD_FLOWSRC - | chip->dma_width + | drv_data->dma_width | chip->dma_burst_size | drv_data->len;
@@ -756,13 +822,13 @@ static void pump_transfers(unsigned longif (drv_data->tx == drv_data->null_dma_buf)/* No source address increment */ DCMD (drv_data->tx_channel) =DCMD_FLOWTRG - | chip->dma_width + | drv_data->dma_width | chip->dma_burst_size | drv_data->len;else DCMD (drv_data->tx_channel) =DCMD_INCSRCADDR |DCMD_FLOWTRG - | chip->dma_width + | drv_data->dma_width | chip->dma_burst_size | drv_data->len;
@@ -943,6 +1009,7 @@ static int setup(struct spi_device *spi) clk_div =SSP3_SerClkDiv (spi->max_speed_hz); else return -ENODEV; + chip->speed_hz = spi->max_speed_hz; chip->cr0 = clk_div | SSCR0_Motorola
@@ -987,6 +1054,7 @@ static int setup(struct spi_device *spi)kfree (chip);return -ENODEV ; } + chip->bits_per_word = spi->bits_per_word;spi_set_ctldata (spi, chip);
Signature · 1 line
1.3.2
PATCH 6/10 SPI: Renamed bitbang_transfer_setup to spi_bitbang_setup_transfer and export it
In reply to Greg KHFrom: Kumar Gala <[email protected]>
Renamed bitbang_transfer_setup to follow convention of other exported symbols from spi-bitbang. Exported spi_bitbang_setup_transfer to allow users of spi-bitbang to use the function in their own setup_transfer.
---
drivers/spi/spi_bitbang.c | 10 ++++++---- include/linux/spi/spi_bitbang.h | 2 ++ 2 files changed, 8 insertions(+), 4 deletions(-)
ff9f4771b5f017ee0f57629488b6cd7a6ef3d19b
drivers/spi/spi_bitbang.c +6 -4
@@ -138,8 +138,7 @@ static unsigned bitbang_txrx_32(return t->len - count; } -static int -bitbang_transfer_setup (struct spi_device *spi,struct spi_transfer *t) +int spi_bitbang_setup_transfer (struct spi_device *spi,struct spi_transfer *t) {struct spi_bitbang_cs *cs = spi->controller_state;u8 bits_per_word;
@@ -174,6 +173,7 @@ bitbang_transfer_setup(struct spi_devicereturn 0 ; } +EXPORT_SYMBOL_GPL (spi_bitbang_setup_transfer);/** * spi_bitbang_setup - default setup for per-word I/O loops
@@ -203,7 +203,7 @@ int spi_bitbang_setup(struct spi_deviceif (!cs->txrx_word)return -EINVAL ; - retval =bitbang_transfer_setup (spi,NULL ); + retval =spi_bitbang_setup_transfer (spi,NULL );if (retval <0 )return retval;
@@ -454,7 +454,9 @@ int spi_bitbang_start(struct spi_bitbang bitbang->use_dma =0 ; bitbang->txrx_bufs = spi_bitbang_bufs;if (!bitbang->master->setup) { - bitbang->setup_transfer = bitbang_transfer_setup; +if (!bitbang->setup_transfer) + bitbang->setup_transfer = + spi_bitbang_setup_transfer; bitbang->master->setup = spi_bitbang_setup; bitbang->master->cleanup = spi_bitbang_cleanup; }
include/linux/spi/spi_bitbang.h +2 -0
@@ -57,6 +57,8 @@ #define BITBANG_CS_INACTIVE 0extern int spi_bitbang_setup (struct spi_device *spi);extern void spi_bitbang_cleanup (const struct spi_device *spi);extern int spi_bitbang_transfer (struct spi_device *spi,struct spi_message *m); +extern int spi_bitbang_setup_transfer (struct spi_device *spi, +struct spi_transfer *t);/* start or stop queue processing */ extern int spi_bitbang_start (struct spi_bitbang *spi);
Signature · 1 line
1.3.2
PATCH 5/10 SPI: Add David as the SPI subsystem maintainer
In reply to Greg KHFrom: Kumar Gala <[email protected]>
Add David as the SPI subsystem maintainer
---
MAINTAINERS | 6 ++++++ 1 files changed, 6 insertions(+), 0 deletions(-)
025c398710ac24456f0288fc7e64f426c5c5508f
MAINTAINERS +6 -0
@@ -2518,6 +2518,12 @@ M: [email protected] L: [email protected] S: Maintained +SPI SUBSYSTEM +P: David Brownell +M: [email protected] +L: [email protected] +S: Maintained + TPM DEVICE DRIVER P: Kylene Hall M: [email protected]
Signature · 1 line
1.3.2
PATCH 1/10 SPI: per-transfer overrides for wordsize and clocking
In reply to Greg KHFrom: Imre Deak <[email protected]>
Some protocols (like one for some bitmap displays) require different clock speed or word size settings for each transfer in an SPI message. This adds those parameters to struct spi_transfer. They are to be used when they are nonzero; otherwise the defaults from spi_device are to be used.
The patch also adds a setup_transfer callback to spi_bitbang, uses it for messages that use those overrides, and implements it so that the pure bitbanging code can help resolve any questions about how it should work.
---
drivers/spi/spi_bitbang.c | 77 ++++++++++++++++++++++++++++++++------- include/linux/spi/spi.h | 8 ++++ include/linux/spi/spi_bitbang.h | 6 +++ 3 files changed, 77 insertions(+), 14 deletions(-)
4cff33f94fefcce1b3c01a9d1da6bb85fe3cbdfa
drivers/spi/spi_bitbang.c +63 -14
@@ -138,6 +138,43 @@ static unsigned bitbang_txrx_32(return t->len - count; } +static int +bitbang_transfer_setup (struct spi_device *spi,struct spi_transfer *t) +{ +struct spi_bitbang_cs *cs = spi->controller_state; +u8 bits_per_word; +u32 hz; + +if (t) { + bits_per_word = t->bits_per_word; + hz = t->speed_hz; + }else { + bits_per_word =0 ; + hz =0 ; + } + +/* spi_transfer level calls that work per-word */ +if (!bits_per_word) + bits_per_word = spi->bits_per_word; +if (bits_per_word <=8 ) + cs->txrx_bufs = bitbang_txrx_8; +else if (bits_per_word <=16 ) + cs->txrx_bufs = bitbang_txrx_16; +else if (bits_per_word <=32 ) + cs->txrx_bufs = bitbang_txrx_32; +else +return -EINVAL ; + +/* nsecs = (clock period)/2 */ +if (!hz) + hz = spi->max_speed_hz; + cs->nsecs = (1000000000 /2 ) / hz; +if (cs->nsecs >MAX_UDELAY_MS *1000 ) +return -EINVAL ; + +return 0 ; +} +/** * spi_bitbang_setup - default setup for per-word I/O loops */
@@ -145,6 +182,7 @@ int spi_bitbang_setup(struct spi_device {struct spi_bitbang_cs *cs = spi->controller_state;struct spi_bitbang *bitbang; +int retval;if (!spi->max_speed_hz)return -EINVAL ;
@@ -160,25 +198,14 @@ int spi_bitbang_setup(struct spi_deviceif (!spi->bits_per_word) spi->bits_per_word =8 ; -/* spi_transfer level calls that work per-word */ -if (spi->bits_per_word <=8 ) - cs->txrx_bufs = bitbang_txrx_8; -else if (spi->bits_per_word <=16 ) - cs->txrx_bufs = bitbang_txrx_16; -else if (spi->bits_per_word <=32 ) - cs->txrx_bufs = bitbang_txrx_32; -else -return -EINVAL ; -/* per-word shift register access, in hardware or bitbanging */ cs->txrx_word = bitbang->txrx_word[spi->mode & (SPI_CPOL |SPI_CPHA )];if (!cs->txrx_word)return -EINVAL ; -/* nsecs = (clock period)/2 */ - cs->nsecs = (1000000000 /2 ) / (spi->max_speed_hz); -if (cs->nsecs >MAX_UDELAY_MS *1000 ) -return -EINVAL ; + retval =bitbang_transfer_setup (spi,NULL ); +if (retval <0 ) +return retval; dev_dbg(&spi->dev, "%s, mode %d, %u bits/w, %u nsec\n", __FUNCTION__, spi->mode & (SPI_CPOL | SPI_CPHA),
@@ -246,6 +273,8 @@ static void bitbang_work(void *_bitbang)unsigned tmp;unsigned cs_change;int status; +int (*setup_transfer)(struct spi_device *, +struct spi_transfer *); m = container_of(bitbang->queue.next, struct spi_message, queue);
@@ -262,6 +291,7 @@ static void bitbang_work(void *_bitbang) tmp =0 ; cs_change =1 ; status =0 ; + setup_transfer =NULL ; list_for_each_entry (t, &m->transfers, transfer_list) {if (bitbang->shutdown) {
@@ -269,6 +299,20 @@ static void bitbang_work(void *_bitbang)break ; } +/* override or restore speed and wordsize */ +if (t->speed_hz || t->bits_per_word) { + setup_transfer = bitbang->setup_transfer; +if (!setup_transfer) { + status = -ENOPROTOOPT ; +break ; + } + } +if (setup_transfer) { + status =setup_transfer (spi, t); +if (status <0 ) +break ; + } +/* set up default clock polarity, and activate chip; * this implicitly updates clock and spi modes as * previously recorded for this device via setup().
@@ -325,6 +369,10 @@ static void bitbang_work(void *_bitbang) m->status = status; m->complete (m->context); +/* restore speed and wordsize */ +if (setup_transfer) +setup_transfer (spi,NULL ); +/* normally deactivate chipselect ... unless no error and * cs_change has hinted that the next message will probably * be for this chip too.
@@ -406,6 +454,7 @@ int spi_bitbang_start(struct spi_bitbang bitbang->use_dma =0 ; bitbang->txrx_bufs = spi_bitbang_bufs;if (!bitbang->master->setup) { + bitbang->setup_transfer = bitbang_transfer_setup; bitbang->master->setup = spi_bitbang_setup; bitbang->master->cleanup = spi_bitbang_cleanup; }
include/linux/spi/spi.h +8 -0
@@ -31,6 +31,7 @@ extern struct bus_type spi_bus_type;* @master: SPI controller used with the device. * @max_speed_hz: Maximum clock rate to be used with this chip * (on this board); may be changed by the device's driver. +* The spi_transfer.speed_hz can override this for each transfer. * @chip-select: Chipselect, distinguishing chips handled by "master". * @mode: The spi mode defines how data is clocked out and in. * This may be changed by the device's driver.
@@ -38,6 +39,7 @@ extern struct bus_type spi_bus_type;* like eight or 12 bits are common. In-memory wordsizes are * powers of two bytes (e.g. 20 bit samples use 32 bits). * This may be changed by the device's driver. +* The spi_transfer.bits_per_word can override this for each transfer. * @irq: Negative, or the number passed to request_irq() to receive * interrupts from this device. * @controller_state: Controller's runtime state
@@ -268,6 +270,10 @@ extern struct spi_master *spi_busnum_to_* @tx_dma: DMA address of tx_buf, if spi_message.is_dma_mapped * @rx_dma: DMA address of rx_buf, if spi_message.is_dma_mapped * @len: size of rx and tx buffers (in bytes) +* @speed_hz: Select a speed other then the device default for this +* transfer. If 0 the default (from spi_device) is used. +* @bits_per_word: select a bits_per_word other then the device default +* for this transfer. If 0 the default (from spi_device) is used. * @cs_change: affects chipselect after this transfer completes * @delay_usecs: microseconds to delay after this transfer before * (optionally) changing the chipselect status, then starting
@@ -322,7 +328,9 @@ struct spi_transfer {dma_addr_t rx_dma; unsigned cs_change:1; +u8 bits_per_word;u16 delay_usecs; +u32 speed_hz;struct list_head transfer_list; };
include/linux/spi/spi_bitbang.h +6 -0
@@ -30,6 +30,12 @@ struct spi_bitbang {struct spi_master *master; +/* setup_transfer() changes clock and/or wordsize to match settings +* for this transfer; zeroes restore defaults from spi_device. +*/ +int (*setup_transfer)(struct spi_device *spi, +struct spi_transfer *t); +void (*chipselect)(struct spi_device *spi,int is_on);#define BITBANG_CS_ACTIVE 1/* normally nCS, active low */ #define BITBANG_CS_INACTIVE 0
Signature · 1 line
1.3.2
PATCH 7/10 SPI: devices can require LSB-first encodings
In reply to Greg KHFrom: David Brownell <[email protected]>
Add spi_device hook for LSB-first word encoding, and update all the (in-tree) controller drivers to reject such devices. Eventually, some controller drivers will be updated to support lsb-first encodings on the wire; no current drivers need this.
---
drivers/spi/spi_bitbang.c | 11 ++++++++++- include/linux/spi/spi.h | 7 +++++-- 2 files changed, 15 insertions(+), 3 deletions(-)
ccf77cc4af5b048e20cfd9327fcc286cb69c34cc
drivers/spi/spi_bitbang.c +10 -1
@@ -187,13 +187,22 @@ int spi_bitbang_setup(struct spi_deviceif (!spi->max_speed_hz)return -EINVAL ; + bitbang =spi_master_get_devdata (spi->master); + +/* REVISIT: some systems will want to support devices using lsb-first +* bit encodings on the wire. In pure software that would be trivial, +* just bitbang_txrx_le_cphaX() routines shifting the other way, and +* some hardware controllers also have this support. +*/ +if ((spi->mode &SPI_LSB_FIRST ) !=0 ) +return -EINVAL ; +if (!cs) { cs =kzalloc (sizeof *cs,SLAB_KERNEL );if (!cs)return -ENOMEM ; spi->controller_state = cs; } - bitbang =spi_master_get_devdata (spi->master);if (!spi->bits_per_word) spi->bits_per_word =8 ;
include/linux/spi/spi.h +5 -2
@@ -35,10 +35,13 @@ extern struct bus_type spi_bus_type;* @chip-select: Chipselect, distinguishing chips handled by "master". * @mode: The spi mode defines how data is clocked out and in. * This may be changed by the device's driver. +* The "active low" default for chipselect mode can be overridden, +* as can the "MSB first" default for each word in a transfer. * @bits_per_word: Data transfers involve one or more words; word sizes * like eight or 12 bits are common. In-memory wordsizes are * powers of two bytes (e.g. 20 bit samples use 32 bits). -* This may be changed by the device's driver. +* This may be changed by the device's driver, or left at the +* default (0) indicating protocol words are eight bit bytes. * The spi_transfer.bits_per_word can override this for each transfer. * @irq: Negative, or the number passed to request_irq() to receive * interrupts from this device.
@@ -67,6 +70,7 @@ #define SPI_MODE_1 (0|SPI_CPHA)#define SPI_MODE_2 (SPI_CPOL|0)#define SPI_MODE_3 (SPI_CPOL|SPI_CPHA)#define SPI_CS_HIGH 0x04/* chipselect active high? */ +#define SPI_LSB_FIRST 0x08/* per-word bits-on-wire */ u8 bits_per_word;int irq;void *controller_state;
@@ -75,7 +79,6 @@ #define SPI_CS_HIGH 0x04 /* chipselect// likely need more hooks for more protocol options affecting how // the controller talks to each chip, like: -// - bit order (default is wordwise msb-first) // - memory packing (12 bit samples into low bits, others zeroed) // - priority // - drop chipselect after each word
Signature · 1 line
1.3.2
PATCH 2/10 SPI: add PXA2xx SSP SPI Driver
In reply to Greg KHFrom: Stephen Street <[email protected]>
This driver turns a PXA2xx synchronous serial port (SSP) into a SPI master controller (see Documentation/spi/spi_summary). The driver has the following features:
- Support for any PXA2xx SSP
- SSP PIO and SSP DMA data transfers.
- External and Internal (SSPFRM) chip selects.
- Per slave device (chip) configuration.
- Full suspend, freeze, resume support.
---
Documentation/spi/pxa2xx | 234 ++++++ drivers/spi/Kconfig | 8 drivers/spi/Makefile | 1 drivers/spi/pxa2xx_spi.c | 1399 +++++++++++++++++++++++++++++++++ include/asm-arm/arch-pxa/pxa2xx_spi.h | 68 ++ 5 files changed, 1710 insertions(+), 0 deletions(-) create mode 100644 Documentation/spi/pxa2xx create mode 100644 drivers/spi/pxa2xx_spi.c create mode 100644 include/asm-arm/arch-pxa/pxa2xx_spi.h
e0c9905e87ac1bc56c9ea8f5b2934aeee53dce26
Documentation/spi/pxa2xx new file +234 -0
@@ -0,0 +1,234 @@ +PXA2xx SPI on SSP driver HOWTO +=================================================== +This a mini howto on the pxa2xx_spi driver. The driver turns a PXA2xx +synchronous serial port into a SPI master controller +(see Documentation/spi/spi_summary). The driver has the following features + +- Support for any PXA2xx SSP +- SSP PIO and SSP DMA data transfers. +- External and Internal (SSPFRM) chip selects. +- Per slave device (chip) configuration. +- Full suspend, freeze, resume support. + +The driver is built around a "spi_message" fifo serviced by workqueue and a +tasklet. The workqueue, "pump_messages", drives message fifo and the tasklet +(pump_transfer) is responsible for queuing SPI transactions and setting up and +launching the dma/interrupt driven transfers. + +Declaring PXA2xx Master Controllers +----------------------------------- +Typically a SPI master is defined in the arch/.../mach-*/board-*.c as a +"platform device". The master configuration is passed to the driver via a table +found in include/asm-arm/arch-pxa/pxa2xx_spi.h: + +struct pxa2xx_spi_master { + enum pxa_ssp_type ssp_type; + u32 clock_enable; + u16 num_chipselect; + u8 enable_dma; +}; + +The "pxa2xx_spi_master.ssp_type" field must have a value between 1 and 3 and +informs the driver which features a particular SSP supports. + +The "pxa2xx_spi_master.clock_enable" field is used to enable/disable the +corresponding SSP peripheral block in the "Clock Enable Register (CKEN"). See +the "PXA2xx Developer Manual" section "Clocks and Power Management". + +The "pxa2xx_spi_master.num_chipselect" field is used to determine the number of +slave device (chips) attached to this SPI master. + +The "pxa2xx_spi_master.enable_dma" field informs the driver that SSP DMA should +be used. This caused the driver to acquire two DMA channels: rx_channel and +tx_channel. The rx_channel has a higher DMA service priority the tx_channel. +See the "PXA2xx Developer Manual" section "DMA Controller". + +NSSP MASTER SAMPLE +------------------ +Below is a sample configuration using the PXA255 NSSP. + +static struct resource pxa_spi_nssp_resources[] = { + [0] = { + .start = __PREG(SSCR0_P(2)), /* Start address of NSSP */ + .end = __PREG(SSCR0_P(2)) + 0x2c, /* Range of registers */ + .flags = IORESOURCE_MEM, + }, + [1] = { + .start = IRQ_NSSP, /* NSSP IRQ */ + .end = IRQ_NSSP, + .flags = IORESOURCE_IRQ, + }, +}; + +static struct pxa2xx_spi_master pxa_nssp_master_info = { + .ssp_type = PXA25x_NSSP, /* Type of SSP */ + .clock_enable = CKEN9_NSSP, /* NSSP Peripheral clock */ + .num_chipselect = 1, /* Matches the number of chips attached to NSSP */ + .enable_dma = 1, /* Enables NSSP DMA */ +}; + +static struct platform_device pxa_spi_nssp = { + .name = "pxa2xx-spi", /* MUST BE THIS VALUE, so device match driver */ + .id = 2, /* Bus number, MUST MATCH SSP number 1..n */ + .resource = pxa_spi_nssp_resources, + .num_resources = ARRAY_SIZE(pxa_spi_nssp_resources), + .dev = { + .platform_data = &pxa_nssp_master_info, /* Passed to driver */ + }, +}; + +static struct platform_device *devices[] __initdata = { + &pxa_spi_nssp, +}; + +static void __init board_init(void) +{ + (void)platform_add_device(devices, ARRAY_SIZE(devices)); +} + +Declaring Slave Devices +----------------------- +Typically each SPI slave (chip) is defined in the arch/.../mach-*/board-*.c +using the "spi_board_info" structure found in "linux/spi/spi.h". See +"Documentation/spi/spi_summary" for additional information. + +Each slave device attached to the PXA must provide slave specific configuration +information via the structure "pxa2xx_spi_chip" found in +"include/asm-arm/arch-pxa/pxa2xx_spi.h". The pxa2xx_spi master controller driver +will uses the configuration whenever the driver communicates with the slave +device. + +struct pxa2xx_spi_chip { + u8 tx_threshold; + u8 rx_threshold; + u8 dma_burst_size; + u32 timeout_microsecs; + u8 enable_loopback; + void (*cs_control)(u32 command); +}; + +The "pxa2xx_spi_chip.tx_threshold" and "pxa2xx_spi_chip.rx_threshold" fields are +used to configure the SSP hardware fifo. These fields are critical to the +performance of pxa2xx_spi driver and misconfiguration will result in rx +fifo overruns (especially in PIO mode transfers). Good default values are + + .tx_threshold = 12, + .rx_threshold = 4, + +The "pxa2xx_spi_chip.dma_burst_size" field is used to configure PXA2xx DMA +engine and is related the "spi_device.bits_per_word" field. Read and understand +the PXA2xx "Developer Manual" sections on the DMA controller and SSP Controllers +to determine the correct value. An SSP configured for byte-wide transfers would +use a value of 8. + +The "pxa2xx_spi_chip.timeout_microsecs" fields is used to efficiently handle +trailing bytes in the SSP receiver fifo. The correct value for this field is +dependent on the SPI bus speed ("spi_board_info.max_speed_hz") and the specific +slave device. Please note the the PXA2xx SSP 1 does not support trailing byte +timeouts and must busy-wait any trailing bytes. + +The "pxa2xx_spi_chip.enable_loopback" field is used to place the SSP porting +into internal loopback mode. In this mode the SSP controller internally +connects the SSPTX pin the the SSPRX pin. This is useful for initial setup +testing. + +The "pxa2xx_spi_chip.cs_control" field is used to point to a board specific +function for asserting/deasserting a slave device chip select. If the field is +NULL, the pxa2xx_spi master controller driver assumes that the SSP port is +configured to use SSPFRM instead. + +NSSP SALVE SAMPLE +----------------- +The pxa2xx_spi_chip structure is passed to the pxa2xx_spi driver in the +"spi_board_info.controller_data" field. Below is a sample configuration using +the PXA255 NSSP. + +/* Chip Select control for the CS8415A SPI slave device */ +static void cs8415a_cs_control(u32 command) +{ + if (command & PXA2XX_CS_ASSERT) + GPCR(2) = GPIO_bit(2); + else + GPSR(2) = GPIO_bit(2); +} + +/* Chip Select control for the CS8405A SPI slave device */ +static void cs8405a_cs_control(u32 command) +{ + if (command & PXA2XX_CS_ASSERT) + GPCR(3) = GPIO_bit(3); + else + GPSR(3) = GPIO_bit(3); +} + +static struct pxa2xx_spi_chip cs8415a_chip_info = { + .tx_threshold = 12, /* SSP hardward FIFO threshold */ + .rx_threshold = 4, /* SSP hardward FIFO threshold */ + .dma_burst_size = 8, /* Byte wide transfers used so 8 byte bursts */ + .timeout_microsecs = 64, /* Wait at least 64usec to handle trailing */ + .cs_control = cs8415a_cs_control, /* Use external chip select */ +}; + +static struct pxa2xx_spi_chip cs8405a_chip_info = { + .tx_threshold = 12, /* SSP hardward FIFO threshold */ + .rx_threshold = 4, /* SSP hardward FIFO threshold */ + .dma_burst_size = 8, /* Byte wide transfers used so 8 byte bursts */ + .timeout_microsecs = 64, /* Wait at least 64usec to handle trailing */ + .cs_control = cs8405a_cs_control, /* Use external chip select */ +}; + +static struct spi_board_info streetracer_spi_board_info[] __initdata = { + { + .modalias = "cs8415a", /* Name of spi_driver for this device */ + .max_speed_hz = 3686400, /* Run SSP as fast a possbile */ + .bus_num = 2, /* Framework bus number */ + .chip_select = 0, /* Framework chip select */ + .platform_data = NULL; /* No spi_driver specific config */ + .controller_data = &cs8415a_chip_info, /* Master chip config */ + .irq = STREETRACER_APCI_IRQ, /* Slave device interrupt */ + }, + { + .modalias = "cs8405a", /* Name of spi_driver for this device */ + .max_speed_hz = 3686400, /* Run SSP as fast a possbile */ + .bus_num = 2, /* Framework bus number */ + .chip_select = 1, /* Framework chip select */ + .controller_data = &cs8405a_chip_info, /* Master chip config */ + .irq = STREETRACER_APCI_IRQ, /* Slave device interrupt */ + }, +}; + +static void __init streetracer_init(void) +{ + spi_register_board_info(streetracer_spi_board_info, + ARRAY_SIZE(streetracer_spi_board_info)); +} + + +DMA and PIO I/O Support +----------------------- +The pxa2xx_spi driver support both DMA and interrupt driven PIO message +transfers. The driver defaults to PIO mode and DMA transfers must enabled by +setting the "enable_dma" flag in the "pxa2xx_spi_master" structure and and +ensuring that the "pxa2xx_spi_chip.dma_burst_size" field is non-zero. The DMA +mode support both coherent and stream based DMA mappings. + +The following logic is used to determine the type of I/O to be used on +a per "spi_transfer" basis: + +if !enable_dma or dma_burst_size == 0 then + always use PIO transfers + +if spi_message.is_dma_mapped and rx_dma_buf != 0 and tx_dma_buf != 0 then + use coherent DMA mode + +if rx_buf and tx_buf are aligned on 8 byte boundary then + use streaming DMA mode + +otherwise + use PIO transfer + +THANKS TO +--------- + +David Brownell and others for mentoring the development of this driver. +
drivers/spi/Kconfig +8 -0
@@ -75,6 +75,14 @@ config SPI_BUTTERFLY inexpensive battery powered microcontroller evaluation board. This same cable can be used to flash new firmware. +config SPI_PXA2XX + tristate "PXA2xx SSP SPI master" + depends on SPI_MASTER && ARCH_PXA && EXPERIMENTAL + help + This enables using a PXA2xx SSP port as a SPI master controller. + The driver can be configured to use any SSP port and additional + documentation can be found a Documentation/spi/pxa2xx. + # # Add new SPI master controllers in alphabetical order above this line #
drivers/spi/Makefile +1 -0
@@ -13,6 +13,7 @@ obj-$(CONFIG_SPI_MASTER) += spi.o # SPI master controller drivers (bus) obj-$(CONFIG_SPI_BITBANG) += spi_bitbang.o obj-$(CONFIG_SPI_BUTTERFLY) += spi_butterfly.o +obj-$(CONFIG_SPI_PXA2XX) += pxa2xx_spi.o # ... add above this line ... # SPI protocol drivers (device/link on bus)
drivers/spi/pxa2xx_spi.c new file +1399 -0
1,399 lines not on this page · raw message
include/asm-arm/arch-pxa/pxa2xx_spi.h new file +68 -0
68 lines not on this page · raw message
Signature · 1 line
1.3.2
PATCH 10/10 SPI: spi_bitbang: clocking fixes
In reply to Greg KHFrom: David Brownell <[email protected]>
This fixes two problems triggered by the MMC stack updating clocks:
- SPI masters driver should accept a max clock speed of zero; that's one convention for marking idle devices. (Presumably that helps controllers that don't autogate clocks to "off" when not in use.)
- There are more than 1000 nanoseconds per millisecond; setting the clock down to 125 KHz now works properly.
Showing once again that Zero (http://en.wikipedia.org/wiki/Zero) is still an inexhaustible number of bugs.
---
drivers/spi/spi_bitbang.c | 24 ++++++++++++++---------- 1 files changed, 14 insertions(+), 10 deletions(-)
1e316d7566b63767aa18902235c719e9e95465d0
drivers/spi/spi_bitbang.c +14 -10
@@ -167,9 +167,11 @@ int spi_bitbang_setup_transfer(struct sp/* nsecs = (clock period)/2 */ if (!hz) hz = spi->max_speed_hz; - cs->nsecs = (1000000000 /2 ) / hz; -if (cs->nsecs >MAX_UDELAY_MS *1000 ) -return -EINVAL ; +if (hz) { + cs->nsecs = (1000000000 /2 ) / hz; +if (cs->nsecs > (MAX_UDELAY_MS *1000 *1000 )) +return -EINVAL ; + }return 0 ; }
@@ -184,9 +186,6 @@ int spi_bitbang_setup(struct spi_devicestruct spi_bitbang *bitbang;int retval; -if (!spi->max_speed_hz) -return -EINVAL ; - bitbang =spi_master_get_devdata (spi->master);/* REVISIT: some systems will want to support devices using lsb-first
@@ -216,7 +215,7 @@ int spi_bitbang_setup(struct spi_deviceif (retval <0 )return retval; -dev_dbg (&spi->dev,"%s, mode %d, %u bits/w, %u nsec\n" , +dev_dbg (&spi->dev,"%s, mode %d, %u bits/w, %u nsec/bit\n" , __FUNCTION__, spi->mode & (SPI_CPOL |SPI_CPHA ), spi->bits_per_word,2 * cs->nsecs);
@@ -405,6 +404,7 @@ int spi_bitbang_transfer(struct spi_devi {struct spi_bitbang *bitbang;unsigned long flags; +int status =0 ; m->actual_length =0 ; m->status = -EINPROGRESS ;
@@ -414,11 +414,15 @@ int spi_bitbang_transfer(struct spi_devireturn -ESHUTDOWN ;spin_lock_irqsave (&bitbang->lock, flags); -list_add_tail (&m->queue, &bitbang->queue); -queue_work (bitbang->workqueue, &bitbang->work); +if (!spi->max_speed_hz) + status = -ENETDOWN ; +else { +list_add_tail (&m->queue, &bitbang->queue); +queue_work (bitbang->workqueue, &bitbang->work); + }spin_unlock_irqrestore (&bitbang->lock, flags); -return 0 ; +return status; }EXPORT_SYMBOL_GPL (spi_bitbang_transfer);
Signature · 1 line
1.3.2
PATCH 3/10 SPI: spi whitespace fixes
In reply to Greg KHFrom: David Brownell <[email protected]>
This removes superfluous whitespace in the <linux/spi/spi.h> header.
---
include/linux/spi/spi.h | 24 ++++++++++++------------ 1 files changed, 12 insertions(+), 12 deletions(-)
747d844ee9a183ff3067bb1181f2a25c50649538
include/linux/spi/spi.h +12 -12
@@ -36,15 +36,15 @@ extern struct bus_type spi_bus_type;* @mode: The spi mode defines how data is clocked out and in. * This may be changed by the device's driver. * @bits_per_word: Data transfers involve one or more words; word sizes -* like eight or 12 bits are common. In-memory wordsizes are +* like eight or 12 bits are common. In-memory wordsizes are * powers of two bytes (e.g. 20 bit samples use 32 bits). * This may be changed by the device's driver. * The spi_transfer.bits_per_word can override this for each transfer. * @irq: Negative, or the number passed to request_irq() to receive -* interrupts from this device. +* interrupts from this device. * @controller_state: Controller's runtime state * @controller_data: Board-specific definitions for controller, such as -* FIFO initialization parameters; from board_info.controller_data +* FIFO initialization parameters; from board_info.controller_data * * An spi_device is used to interchange data between an SPI slave * (usually a discrete chip) and CPU memory.
@@ -145,13 +145,13 @@ static inline void spi_unregister_driver* struct spi_master - interface to SPI master controller * @cdev: class interface to this driver * @bus_num: board-specific (and often SOC-specific) identifier for a -* given SPI controller. +* given SPI controller. * @num_chipselect: chipselects are used to distinguish individual -* SPI slaves, and are numbered from zero to num_chipselects. -* each slave has a chipselect signal, but it's common that not -* every chipselect is connected to a slave. +* SPI slaves, and are numbered from zero to num_chipselects. +* each slave has a chipselect signal, but it's common that not +* every chipselect is connected to a slave. * @setup: updates the device mode and clocking records used by a -* device's SPI controller; protocol code may call this. +* device's SPI controller; protocol code may call this. * @transfer: adds a message to the controller's transfer queue. * @cleanup: frees controller-specific state *
@@ -276,8 +276,8 @@ extern struct spi_master *spi_busnum_to_* for this transfer. If 0 the default (from spi_device) is used. * @cs_change: affects chipselect after this transfer completes * @delay_usecs: microseconds to delay after this transfer before -* (optionally) changing the chipselect status, then starting -* the next transfer or completing this spi_message. +* (optionally) changing the chipselect status, then starting +* the next transfer or completing this spi_message. * @transfer_list: transfers are sequenced through spi_message.transfers * * SPI transfers always write the same number of bytes as they read.
@@ -364,7 +364,7 @@ struct spi_transfer {* and its transfers, ignore them until its completion callback. */ struct spi_message { -struct list_head transfers; +struct list_head transfers;struct spi_device *spi;
@@ -382,7 +382,7 @@ struct spi_message {*/ /* completion is reported through a callback */ -void (*complete)(void *context); +void (*complete)(void *context);void *context;unsigned actual_length;int status;
Signature · 1 line
1.3.2
PATCH 4/10 SPI: spi bounce buffer has a minimum length
From: David Brownell <[email protected]>
Make sure that spi_write_then_read() can always handle at least 32 bytes of transfer (total, both directions), minimizing one portability issue.
---
drivers/spi/spi.c | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-)
a9948b6194b46e489aa3b4d111d6dfd786c39c4b
drivers/spi/spi.c +2 -1
@@ -522,7 +522,8 @@ int spi_sync(struct spi_device *spi, str }EXPORT_SYMBOL_GPL (spi_sync); -#define SPI_BUFSIZ (SMP_CACHE_BYTES) +/* portable code must never pass more than 32 bytes */ +#define SPI_BUFSIZ max(32,SMP_CACHE_BYTES)static u8 *buf;
Signature · 1 line
1.3.2
PATCH 8/10 SPI: busnum == 0 needs to work
In reply to Greg KHFrom: David Brownell <[email protected]>
We need to be able to have a "SPI bus 0" matching chip numbering; but that number was wrongly used to flag dynamic allocation of a bus number.
This patch resolves that issue; now negative numbers trigger dynamic alloc.
It also updates the how-to-write-a-controller-driver overview to mention this stuff.
---
Documentation/spi/spi-summary | 34 +++++++++++++++++++++++++++++++++- drivers/spi/spi.c | 4 ++-- include/linux/spi/spi.h | 6 +++--- 3 files changed, 38 insertions(+), 6 deletions(-)
a020ed7521a9737bcf3e34eb880867c60c3c68d0
Documentation/spi/spi-summary +33 -1
@@ -414,7 +414,33 @@ to get the driver-private data allocated The driver will initialize the fields of that spi_master, including the bus number (maybe the same as the platform device ID) and three methods used to interact with the SPI core and SPI protocol drivers. It will -also initialize its own internal state. +also initialize its own internal state. (See below about bus numbering +and those methods.) + +After you initialize the spi_master, then use spi_register_master() to +publish it to the rest of the system. At that time, device nodes for +the controller and any predeclared spi devices will be made available, +and the driver model core will take care of binding them to drivers. + +If you need to remove your SPI controller driver, spi_unregister_master() +will reverse the effect of spi_register_master(). + + +BUS NUMBERING + +Bus numbering is important, since that's how Linux identifies a given +SPI bus (shared SCK, MOSI, MISO). Valid bus numbers start at zero. On +SOC systems, the bus numbers should match the numbers defined by the chip +manufacturer. For example, hardware controller SPI2 would be bus number 2, +and spi_board_info for devices connected to it would use that number. + +If you don't have such hardware-assigned bus number, and for some reason +you can't just assign them, then provide a negative bus number. That will +then be replaced by a dynamically assigned number. You'd then need to treat +this as a non-static configuration (see above). + + +SPI MASTER METHODS master->setup(struct spi_device *spi) This sets up the device clock rate, SPI mode, and word sizes.
@@ -431,6 +457,9 @@ also initialize its own internal state. state it dynamically associates with that device. If you do that, be sure to provide the cleanup() method to free that state. + +SPI MESSAGE QUEUE + The bulk of the driver will be managing the I/O queue fed by transfer(). That queue could be purely conceptual. For example, a driver used only
@@ -440,6 +469,9 @@ But the queue will probably be very real often DMA (especially if the root filesystem is in SPI flash), and execution contexts like IRQ handlers, tasklets, or workqueues (such as keventd). Your driver can be as fancy, or as simple, as you need. +Such a transfer() method would normally just add the message to a +queue, and then start some asynchronous transfer engine (unless it's +already running). THANKS TO
drivers/spi/spi.c +2 -2
@@ -395,7 +395,7 @@ EXPORT_SYMBOL_GPL(spi_alloc_master); int __init_or_modulespi_register_master (struct spi_master *master) { -static atomic_t dyn_bus_id =ATOMIC_INIT (0 ); +static atomic_t dyn_bus_id =ATOMIC_INIT ((1 <<16 ) -1 );struct device *dev = master->cdev.dev;int status = -ENODEV ;int dynamic =0 ;
@@ -404,7 +404,7 @@ spi_register_master(struct spi_master *mreturn -ENODEV ;/* convention: dynamically assigned bus IDs count down from the max */ -if (master->bus_num ==0 ) { +if (master->bus_num <0 ) { master->bus_num =atomic_dec_return (&dyn_bus_id); dynamic =1 ; }
include/linux/spi/spi.h +3 -3
@@ -172,13 +172,13 @@ static inline void spi_unregister_driverstruct spi_master {struct class_device cdev; -/* other than zero (== assign one dynamically), bus_num is fully +/* other than negative (== assign one dynamically), bus_num is fully * board-specific. usually that simplifies to being SOC-specific. -* example: one SOC has three SPI controllers, numbered 1..3, +* example: one SOC has three SPI controllers, numbered 0..2, * and one board's schematics might show it using SPI-2. software * would normally use bus_num=2 for that controller. */ -u16 bus_num; +s16 bus_num;/* chipselects will be integral to many controllers; some others * might use board-specific GPIOs.
Signature · 1 line
1.3.2
Re: [PATCH 09/10] spi: Update to PXA2xx SPI Driver
In reply to Greg KHThis is kind of a weird way to do things: the PXA2xx SPI driver was just added in patch 2/10. Why merge a known-buggy driver and then fix it as part of the same merge?
- R.
Re: [PATCH 09/10] spi: Update to PXA2xx SPI Driver
Quoted 3 lines · Roland Dreier
This is kind of a weird way to do things: the PXA2xx SPI driver was just added in patch 2/10. Why merge a known-buggy driver and then fix it as part of the same merge?
Because it was built up as a series of patches, and I didn't merge any of them together like I should have :)
Anyway, David will be taking care of these now, so hopefully stuff like this will not happen again.
thanks,
greg k-h