Documentation/spi/pxa2xx.rst

   1 ==============================
   2 PXA2xx SPI on SSP driver HOWTO
   3 ==============================
   4
   5 This a mini HOWTO on the pxa2xx_spi driver. The driver turns a PXA2xx
   6 synchronous serial port into an SPI master controller
   7 (see Documentation/spi/spi-summary.rst). The driver has the following features
   8
   9 - Support for any PXA2xx and compatible SSP.
  10 - SSP PIO and SSP DMA data transfers.
  11 - External and Internal (SSPFRM) chip selects.
  12 - Per slave device (chip) configuration.
  13 - Full suspend, freeze, resume support.
  14
  15 The driver is built around a &struct spi_message FIFO serviced by kernel
  16 thread. The kernel thread, spi_pump_messages(), drives message FIFO and
  17 is responsible for queuing SPI transactions and setting up and launching
  18 the DMA or interrupt driven transfers.
  19
  20 Declaring PXA2xx Master Controllers
  21 -----------------------------------
  22 Typically, for a legacy platform, an SPI master is defined in the
  23 arch/.../mach-*/board-*.c as a "platform device". The master configuration
  24 is passed to the driver via a table found in include/linux/spi/pxa2xx_spi.h::
  25
  26   struct pxa2xx_spi_controller {
  27         u16 num_chipselect;
  28         u8 enable_dma;
  29         ...
  30   };
  31
  32 The "pxa2xx_spi_controller.num_chipselect" field is used to determine the number of
  33 slave device (chips) attached to this SPI master.
  34
  35 The "pxa2xx_spi_controller.enable_dma" field informs the driver that SSP DMA should
  36 be used. This caused the driver to acquire two DMA channels: Rx channel and
  37 Tx channel. The Rx channel has a higher DMA service priority than the Tx channel.
  38 See the "PXA2xx Developer Manual" section "DMA Controller".
  39
  40 For the new platforms the description of the controller and peripheral devices
  41 comes from Device Tree or ACPI.
  42
  43 NSSP MASTER SAMPLE
  44 ------------------
  45 Below is a sample configuration using the PXA255 NSSP for a legacy platform::
  46
  47   static struct resource pxa_spi_nssp_resources[] = {
  48         [0] = {
  49                 .start  = __PREG(SSCR0_P(2)), /* Start address of NSSP */
  50                 .end    = __PREG(SSCR0_P(2)) + 0x2c, /* Range of registers */
  51                 .flags  = IORESOURCE_MEM,
  52         },
  53         [1] = {
  54                 .start  = IRQ_NSSP, /* NSSP IRQ */
  55                 .end    = IRQ_NSSP,
  56                 .flags  = IORESOURCE_IRQ,
  57         },
  58   };
  59
  60   static struct pxa2xx_spi_controller pxa_nssp_master_info = {
  61         .num_chipselect = 1, /* Matches the number of chips attached to NSSP */
  62         .enable_dma = 1, /* Enables NSSP DMA */
  63   };
  64
  65   static struct platform_device pxa_spi_nssp = {
  66         .name = "pxa2xx-spi", /* MUST BE THIS VALUE, so device match driver */
  67         .id = 2, /* Bus number, MUST MATCH SSP number 1..n */
  68         .resource = pxa_spi_nssp_resources,
  69         .num_resources = ARRAY_SIZE(pxa_spi_nssp_resources),
  70         .dev = {
  71                 .platform_data = &pxa_nssp_master_info, /* Passed to driver */
  72         },
  73   };
  74
  75   static struct platform_device *devices[] __initdata = {
  76         &pxa_spi_nssp,
  77   };
  78
  79   static void __init board_init(void)
  80   {
  81         (void)platform_add_device(devices, ARRAY_SIZE(devices));
  82   }
  83
  84 Declaring Slave Devices
  85 -----------------------
  86 Typically, for a legacy platform, each SPI slave (chip) is defined in the
  87 arch/.../mach-*/board-*.c using the "spi_board_info" structure found in
  88 "linux/spi/spi.h". See "Documentation/spi/spi-summary.rst" for additional
  89 information.
  90
  91 Each slave device attached to the PXA must provide slave specific configuration
  92 information via the structure "pxa2xx_spi_chip" found in
  93 "include/linux/spi/pxa2xx_spi.h".  The pxa2xx_spi master controller driver
  94 will uses the configuration whenever the driver communicates with the slave
  95 device. All fields are optional.
  96
  97 ::
  98
  99   struct pxa2xx_spi_chip {
 100         u8 tx_threshold;
 101         u8 rx_threshold;
 102         u8 dma_burst_size;
 103         u32 timeout;
 104   };
 105
 106 The "pxa2xx_spi_chip.tx_threshold" and "pxa2xx_spi_chip.rx_threshold" fields are
 107 used to configure the SSP hardware FIFO. These fields are critical to the
 108 performance of pxa2xx_spi driver and misconfiguration will result in rx
 109 FIFO overruns (especially in PIO mode transfers). Good default values are::
 110
 111         .tx_threshold = 8,
 112         .rx_threshold = 8,
 113
 114 The range is 1 to 16 where zero indicates "use default".
 115
 116 The "pxa2xx_spi_chip.dma_burst_size" field is used to configure PXA2xx DMA
 117 engine and is related the "spi_device.bits_per_word" field.  Read and understand
 118 the PXA2xx "Developer Manual" sections on the DMA controller and SSP Controllers
 119 to determine the correct value. An SSP configured for byte-wide transfers would
 120 use a value of 8. The driver will determine a reasonable default if
 121 dma_burst_size == 0.
 122
 123 The "pxa2xx_spi_chip.timeout" fields is used to efficiently handle
 124 trailing bytes in the SSP receiver FIFO. The correct value for this field is
 125 dependent on the SPI bus speed ("spi_board_info.max_speed_hz") and the specific
 126 slave device.  Please note that the PXA2xx SSP 1 does not support trailing byte
 127 timeouts and must busy-wait any trailing bytes.
 128
 129 NOTE: the SPI driver cannot control the chip select if SSPFRM is used, so the
 130 chipselect is dropped after each spi_transfer.  Most devices need chip select
 131 asserted around the complete message. Use SSPFRM as a GPIO (through a descriptor)
 132 to accommodate these chips.
 133
 134
 135 NSSP SLAVE SAMPLE
 136 -----------------
 137 For a legacy platform or in some other cases, the pxa2xx_spi_chip structure
 138 is passed to the pxa2xx_spi driver in the "spi_board_info.controller_data"
 139 field. Below is a sample configuration using the PXA255 NSSP.
 140
 141 ::
 142
 143   static struct pxa2xx_spi_chip cs8415a_chip_info = {
 144         .tx_threshold = 8, /* SSP hardware FIFO threshold */
 145         .rx_threshold = 8, /* SSP hardware FIFO threshold */
 146         .dma_burst_size = 8, /* Byte wide transfers used so 8 byte bursts */
 147         .timeout = 235, /* See Intel documentation */
 148   };
 149
 150   static struct pxa2xx_spi_chip cs8405a_chip_info = {
 151         .tx_threshold = 8, /* SSP hardware FIFO threshold */
 152         .rx_threshold = 8, /* SSP hardware FIFO threshold */
 153         .dma_burst_size = 8, /* Byte wide transfers used so 8 byte bursts */
 154         .timeout = 235, /* See Intel documentation */
 155   };
 156
 157   static struct spi_board_info streetracer_spi_board_info[] __initdata = {
 158         {
 159                 .modalias = "cs8415a", /* Name of spi_driver for this device */
 160                 .max_speed_hz = 3686400, /* Run SSP as fast a possible */
 161                 .bus_num = 2, /* Framework bus number */
 162                 .chip_select = 0, /* Framework chip select */
 163                 .platform_data = NULL; /* No spi_driver specific config */
 164                 .controller_data = &cs8415a_chip_info, /* Master chip config */
 165                 .irq = STREETRACER_APCI_IRQ, /* Slave device interrupt */
 166         },
 167         {
 168                 .modalias = "cs8405a", /* Name of spi_driver for this device */
 169                 .max_speed_hz = 3686400, /* Run SSP as fast a possible */
 170                 .bus_num = 2, /* Framework bus number */
 171                 .chip_select = 1, /* Framework chip select */
 172                 .controller_data = &cs8405a_chip_info, /* Master chip config */
 173                 .irq = STREETRACER_APCI_IRQ, /* Slave device interrupt */
 174         },
 175   };
 176
 177   static void __init streetracer_init(void)
 178   {
 179         spi_register_board_info(streetracer_spi_board_info,
 180                                 ARRAY_SIZE(streetracer_spi_board_info));
 181   }
 182
 183
 184 DMA and PIO I/O Support
 185 -----------------------
 186 The pxa2xx_spi driver supports both DMA and interrupt driven PIO message
 187 transfers.  The driver defaults to PIO mode and DMA transfers must be enabled
 188 by setting the "enable_dma" flag in the "pxa2xx_spi_controller" structure.
 189 For the newer platforms, that are known to support DMA, the driver will enable
 190 it automatically and try it first with a possible fallback to PIO. The DMA
 191 mode supports both coherent and stream based DMA mappings.
 192
 193 The following logic is used to determine the type of I/O to be used on
 194 a per "spi_transfer" basis::
 195
 196   if !enable_dma then
 197         always use PIO transfers
 198
 199   if spi_message.len > 8191 then
 200         print "rate limited" warning
 201         use PIO transfers
 202
 203   if spi_message.is_dma_mapped and rx_dma_buf != 0 and tx_dma_buf != 0 then
 204         use coherent DMA mode
 205
 206   if rx_buf and tx_buf are aligned on 8 byte boundary then
 207         use streaming DMA mode
 208
 209   otherwise
 210         use PIO transfer
 211
 212 THANKS TO
 213 ---------
 214 David Brownell and others for mentoring the development of this driver.