1============================== 2PXA2xx SPI on SSP driver HOWTO 3============================== 4 5This a mini HOWTO on the pxa2xx_spi driver. The driver turns a PXA2xx 6synchronous serial port into an SPI host 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 peripheral device (chip) configuration. 13- Full suspend, freeze, resume support. 14 15The driver is built around a &struct spi_message FIFO serviced by kernel 16thread. The kernel thread, spi_pump_messages(), drives message FIFO and 17is responsible for queuing SPI transactions and setting up and launching 18the DMA or interrupt driven transfers. 19 20Declaring PXA2xx host controllers 21--------------------------------- 22Typically, for a legacy platform, an SPI host controller is defined in the 23arch/.../mach-*/board-*.c as a "platform device". The host controller configuration 24is 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 32The "pxa2xx_spi_controller.num_chipselect" field is used to determine the number of 33peripheral devices (chips) attached to this SPI host controller. 34 35The "pxa2xx_spi_controller.enable_dma" field informs the driver that SSP DMA should 36be used. This caused the driver to acquire two DMA channels: Rx channel and 37Tx channel. The Rx channel has a higher DMA service priority than the Tx channel. 38See the "PXA2xx Developer Manual" section "DMA Controller". 39 40For the new platforms the description of the controller and peripheral devices 41comes from Device Tree or ACPI. 42 43NSSP HOST SAMPLE 44---------------- 45Below 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_controller_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_controller_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 84Declaring peripheral devices 85---------------------------- 86Typically, for a legacy platform, each SPI peripheral device (chip) is defined in the 87arch/.../mach-*/board-*.c using the "spi_board_info" structure found in 88"linux/spi/spi.h". See "Documentation/spi/spi-summary.rst" for additional 89information. 90 91Each peripheral device (chip) attached to the PXA2xx must provide specific chip configuration 92information via the structure "pxa2xx_spi_chip" found in 93"include/linux/spi/pxa2xx_spi.h". The PXA2xx host controller driver will use 94the configuration whenever the driver communicates with the peripheral 95device. 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 106The "pxa2xx_spi_chip.tx_threshold" and "pxa2xx_spi_chip.rx_threshold" fields are 107used to configure the SSP hardware FIFO. These fields are critical to the 108performance of pxa2xx_spi driver and misconfiguration will result in rx 109FIFO overruns (especially in PIO mode transfers). Good default values are:: 110 111 .tx_threshold = 8, 112 .rx_threshold = 8, 113 114The range is 1 to 16 where zero indicates "use default". 115 116The "pxa2xx_spi_chip.dma_burst_size" field is used to configure PXA2xx DMA 117engine and is related the "spi_device.bits_per_word" field. Read and understand 118the PXA2xx "Developer Manual" sections on the DMA controller and SSP Controllers 119to determine the correct value. An SSP configured for byte-wide transfers would 120use a value of 8. The driver will determine a reasonable default if 121dma_burst_size == 0. 122 123The "pxa2xx_spi_chip.timeout" fields is used to efficiently handle 124trailing bytes in the SSP receiver FIFO. The correct value for this field is 125dependent on the SPI bus speed ("spi_board_info.max_speed_hz") and the specific 126peripheral device. Please note that the PXA2xx SSP 1 does not support trailing byte 127timeouts and must busy-wait any trailing bytes. 128 129NOTE: the SPI driver cannot control the chip select if SSPFRM is used, so the 130chipselect is dropped after each spi_transfer. Most devices need chip select 131asserted around the complete message. Use SSPFRM as a GPIO (through a descriptor) 132to accommodate these chips. 133 134 135NSSP PERIPHERAL SAMPLE 136---------------------- 137For a legacy platform or in some other cases, the pxa2xx_spi_chip structure 138is passed to the pxa2xx_spi driver in the "spi_board_info.controller_data" 139field. 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, /* Host controller config */ 165 .irq = STREETRACER_APCI_IRQ, /* Peripheral 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, /* Host controller config */ 173 .irq = STREETRACER_APCI_IRQ, /* Peripheral 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 184DMA and PIO I/O Support 185----------------------- 186The pxa2xx_spi driver supports both DMA and interrupt driven PIO message 187transfers. The driver defaults to PIO mode and DMA transfers must be enabled 188by setting the "enable_dma" flag in the "pxa2xx_spi_controller" structure. 189For the newer platforms, that are known to support DMA, the driver will enable 190it automatically and try it first with a possible fallback to PIO. The DMA 191mode supports both coherent and stream based DMA mappings. 192 193The following logic is used to determine the type of I/O to be used on 194a per "spi_transfer" basis:: 195 196 if spi_message.len > 65536 then 197 if spi_message.is_dma_mapped or rx_dma_buf != 0 or tx_dma_buf != 0 then 198 reject premapped transfers 199 200 print "rate limited" warning 201 use PIO transfers 202 203 if enable_dma and the size is in the range [DMA burst size..65536] then 204 use streaming DMA mode 205 206 otherwise 207 use PIO transfer 208 209THANKS TO 210--------- 211David Brownell and others for mentoring the development of this driver. 212