spi: Kconfig: Add help text
[oweals/u-boot.git] / drivers / spi / Kconfig
1 menuconfig SPI
2         bool "SPI Support"
3         help
4           The "Serial Peripheral Interface" is a low level synchronous
5           protocol.  Chips that support SPI can have data transfer rates
6           up to several tens of Mbit/sec.  Chips are addressed with a
7           controller and a chipselect.  Most SPI slaves don't support
8           dynamic device discovery; some are even write-only or read-only.
9
10           SPI is widely used by microcontrollers to talk with sensors,
11           eeprom and flash memory, codecs and various other controller
12           chips, analog to digital (and d-to-a) converters, and more.
13           MMC and SD cards can be accessed using SPI protocol; and for
14           DataFlash cards used in MMC sockets, SPI must always be used.
15
16           SPI is one of a family of similar protocols using a four wire
17           interface (select, clock, data in, data out) including Microwire
18           (half duplex), SSP, SSI, and PSP.  This driver framework should
19           work with most such devices and controllers.
20
21 if SPI
22
23 config DM_SPI
24         bool "Enable Driver Model for SPI drivers"
25         depends on DM
26         help
27           Enable driver model for SPI. The SPI slave interface
28           (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
29           the SPI uclass. Drivers provide methods to access the SPI
30           buses that they control. The uclass interface is defined in
31           include/spi.h. The existing spi_slave structure is attached
32           as 'parent data' to every slave on each bus. Slaves
33           typically use driver-private data instead of extending the
34           spi_slave structure.
35
36 config SPI_MEM
37         bool "SPI memory extension"
38         help
39           Enable this option if you want to enable the SPI memory extension.
40           This extension is meant to simplify interaction with SPI memories
41           by providing an high-level interface to send memory-like commands.
42
43 if DM_SPI
44
45 config ALTERA_SPI
46         bool "Altera SPI driver"
47         help
48           Enable the Altera SPI driver. This driver can be used to
49           access the SPI NOR flash on platforms embedding this Altera
50           IP core. Please find details on the "Embedded Peripherals IP
51           User Guide" of Altera.
52
53 config ATCSPI200_SPI
54         bool "Andestech ATCSPI200 SPI driver"
55         help
56           Enable the Andestech ATCSPI200 SPI driver. This driver can be
57           used to access the SPI flash on AE3XX and AE250 platforms embedding
58           this Andestech IP core.
59
60 config ATH79_SPI
61         bool "Atheros SPI driver"
62         depends on ARCH_ATH79
63         help
64           Enable the Atheros ar7xxx/ar9xxx SoC SPI driver, it was used
65           to access SPI NOR flash and other SPI peripherals. This driver
66           uses driver model and requires a device tree binding to operate.
67           please refer to doc/device-tree-bindings/spi/spi-ath79.txt.
68
69 config ATMEL_QSPI
70         bool "Atmel Quad SPI Controller"
71         depends on ARCH_AT91
72         help
73           Enable the Atmel Quad SPI controller in master mode. This driver
74           does not support generic SPI. The implementation supports only the
75           spi-mem interface.
76
77 config ATMEL_SPI
78         bool "Atmel SPI driver"
79         default y if ARCH_AT91
80         help
81           This enables driver for the Atmel SPI Controller, present on
82           many AT91 (ARM) chips. This driver can be used to access
83           the SPI Flash, such as AT25DF321.
84
85 config BCM63XX_HSSPI
86         bool "BCM63XX HSSPI driver"
87         depends on (ARCH_BMIPS || ARCH_BCM6858 || ARCH_BCM63158)
88         help
89           Enable the BCM6328 HSSPI driver. This driver can be used to
90           access the SPI NOR flash on platforms embedding this Broadcom
91           SPI core.
92
93 config BCM63XX_SPI
94         bool "BCM6348 SPI driver"
95         depends on ARCH_BMIPS
96         help
97           Enable the BCM6348/BCM6358 SPI driver. This driver can be used to
98           access the SPI NOR flash on platforms embedding these Broadcom
99           SPI cores.
100
101 config BCMSTB_SPI
102         bool "BCMSTB SPI driver"
103         help
104           Enable the Broadcom set-top box SPI driver. This driver can
105           be used to access the SPI flash on platforms embedding this
106           Broadcom SPI core.
107
108 config CADENCE_QSPI
109         bool "Cadence QSPI driver"
110         help
111           Enable the Cadence Quad-SPI (QSPI) driver. This driver can be
112           used to access the SPI NOR flash on platforms embedding this
113           Cadence IP core.
114
115 config CF_SPI
116         bool "ColdFire SPI driver"
117         help
118           Enable the ColdFire SPI driver. This driver can be used on
119           some m68k SoCs.
120
121 config DESIGNWARE_SPI
122         bool "Designware SPI driver"
123         help
124           Enable the Designware SPI driver. This driver can be used to
125           access the SPI NOR flash on platforms embedding this Designware
126           IP core.
127
128 config EXYNOS_SPI
129         bool "Samsung Exynos SPI driver"
130         help
131           Enable the Samsung Exynos SPI driver. This driver can be used to
132           access the SPI NOR flash on platforms embedding this Samsung
133           Exynos IP core.
134
135 config FSL_DSPI
136         bool "Freescale DSPI driver"
137         help
138           Enable the Freescale DSPI driver. This driver can be used to
139           access the SPI NOR flash and SPI Data flash on platforms embedding
140           this Freescale DSPI IP core. LS102xA and Colibri VF50/VF61 platforms
141           use this driver.
142
143 config ICH_SPI
144         bool "Intel ICH SPI driver"
145         imply SPI_FLASH_BAR
146         help
147           Enable the Intel ICH SPI driver. This driver can be used to
148           access the SPI NOR flash on platforms embedding this Intel
149           ICH IP core.
150
151 config MESON_SPIFC
152         bool "Amlogic Meson SPI Flash Controller driver"
153         depends on ARCH_MESON
154         help
155           Enable the Amlogic Meson SPI Flash Controller SPIFC) driver.
156           This driver can be used to access the SPI NOR flash chips on
157           Amlogic Meson SoCs.
158
159 config MPC8XX_SPI
160         bool "MPC8XX SPI Driver"
161         depends on MPC8xx
162         help
163           Enable support for SPI on MPC8XX
164
165 config MPC8XXX_SPI
166         bool "MPC8XXX SPI Driver"
167         help
168           Enable support for SPI on the MPC8XXX PowerPC SoCs.
169
170 config MT7621_SPI
171         bool "MediaTek MT7621 SPI driver"
172         depends on SOC_MT7628
173         help
174           Enable the MT7621 SPI driver. This driver can be used to access
175           the SPI NOR flash on platforms embedding this Ralink / MediaTek
176           SPI core, like MT7621/7628/7688.
177
178 config MTK_SNFI_SPI
179         bool "Mediatek SPI memory controller driver"
180         depends on SPI_MEM
181         help
182           Enable the Mediatek SPI memory controller driver. This driver is
183           originally based on the MediaTek SNFI IP core. It can only be
184           used to access SPI memory devices like SPI-NOR or SPI-NAND on
185           platforms embedding this IP core, like MT7622/M7629.
186
187 config MVEBU_A3700_SPI
188         bool "Marvell Armada 3700 SPI driver"
189         select CLK_ARMADA_3720
190         help
191           Enable the Marvell Armada 3700 SPI driver. This driver can be
192           used to access the SPI NOR flash on platforms embedding this
193           Marvell IP core.
194
195 config PIC32_SPI
196         bool "Microchip PIC32 SPI driver"
197         depends on MACH_PIC32
198         help
199           Enable the Microchip PIC32 SPI driver. This driver can be used
200           to access the SPI NOR flash, MMC-over-SPI on platforms based on
201           Microchip PIC32 family devices.
202
203 config PL022_SPI
204         bool "ARM AMBA PL022 SSP controller driver"
205         depends on ARM
206         help
207           This selects the ARM(R) AMBA(R) PrimeCell PL022 SSP
208           controller. If you have an embedded system with an AMBA(R)
209           bus and a PL022 controller, say Y or M here.
210
211 config RENESAS_RPC_SPI
212         bool "Renesas RPC SPI driver"
213         depends on RCAR_GEN3 || RZA1
214         imply SPI_FLASH_BAR
215         help
216           Enable the Renesas RPC SPI driver, used to access SPI NOR flash
217           on Renesas RCar Gen3 SoCs. This uses driver model and requires a
218           device tree binding to operate.
219
220 config ROCKCHIP_SPI
221         bool "Rockchip SPI driver"
222         help
223           Enable the Rockchip SPI driver, used to access SPI NOR flash and
224           other SPI peripherals (such as the Chrome OS EC) on Rockchip SoCs.
225           This uses driver model and requires a device tree binding to
226           operate.
227
228 config SANDBOX_SPI
229         bool "Sandbox SPI driver"
230         depends on SANDBOX && DM
231         help
232           Enable SPI support for sandbox. This is an emulation of a real SPI
233           bus. Devices can be attached to the bus using the device tree
234           which specifies the driver to use. As an example, see this device
235           tree fragment from sandbox.dts. It shows that the SPI bus has a
236           single flash device on chip select 0 which is emulated by the driver
237           for "sandbox,spi-flash", which is in drivers/mtd/spi/sandbox.c.
238
239           spi@0 {
240                 #address-cells = <1>;
241                 #size-cells = <0>;
242                 reg = <0>;
243                 compatible = "sandbox,spi";
244                 cs-gpios = <0>, <&gpio_a 0>;
245                 flash@0 {
246                         reg = <0>;
247                         compatible = "spansion,m25p16", "jedec,spi-nor";
248                         spi-max-frequency = <40000000>;
249                         sandbox,filename = "spi.bin";
250                 };
251           };
252
253 config SPI_SIFIVE
254         bool "SiFive SPI driver"
255         help
256           This driver supports the SiFive SPI IP. If unsure say N.
257           Enable the SiFive SPI controller driver.
258
259           The SiFive SPI controller driver is found on various SiFive SoCs.
260
261 config SPI_SUNXI
262         bool "Allwinner SoC SPI controllers"
263         help
264           Enable the Allwinner SoC SPi controller driver.
265
266           Same controller driver can reuse in all Allwinner SoC variants.
267
268 config STM32_QSPI
269         bool "STM32F7 QSPI driver"
270         depends on STM32F4 || STM32F7 || ARCH_STM32MP
271         help
272           Enable the STM32F7 Quad-SPI (QSPI) driver. This driver can be
273           used to access the SPI NOR flash chips on platforms embedding
274           this ST IP core.
275
276 config STM32_SPI
277         bool "STM32 SPI driver"
278         depends on ARCH_STM32MP
279         help
280           Enable the STM32 Serial Peripheral Interface (SPI) driver for STM32MP
281           SoCs. This uses driver model and requires a device tree binding to
282           operate.
283
284 config TEGRA114_SPI
285         bool "nVidia Tegra114 SPI driver"
286         help
287           Enable the nVidia Tegra114 SPI driver. This driver can be used to
288           access the SPI NOR flash on platforms embedding this nVidia Tegra114
289           IP core.
290
291           This controller is different than the older SoCs SPI controller and
292           also register interface get changed with this controller.
293
294 config TEGRA20_SFLASH
295         bool "nVidia Tegra20 Serial Flash controller driver"
296         help
297           Enable the nVidia Tegra20 Serial Flash controller driver. This driver
298           can be used to access the SPI NOR flash on platforms embedding this
299           nVidia Tegra20 IP core.
300
301 config TEGRA20_SLINK
302         bool "nVidia Tegra20/Tegra30 SLINK driver"
303         help
304           Enable the nVidia Tegra20/Tegra30 SLINK driver. This driver can
305           be used to access the SPI NOR flash on platforms embedding this
306           nVidia Tegra20/Tegra30 IP cores.
307
308 config TEGRA210_QSPI
309         bool "nVidia Tegra210 QSPI driver"
310         help
311           Enable the Tegra Quad-SPI (QSPI) driver for T210. This driver
312           be used to access SPI chips on platforms embedding this
313           NVIDIA Tegra210 IP core.
314
315 config TI_QSPI
316         bool "TI QSPI driver"
317         imply TI_EDMA3
318         help
319           Enable the TI Quad-SPI (QSPI) driver for DRA7xx and AM43xx evms.
320           This driver support spi flash single, quad and memory reads.
321
322 config UNIPHIER_SPI
323         bool "Socionext UniPhier SPI driver"
324         depends on ARCH_UNIPHIER
325         help
326           Enable the Socionext UniPhier SPI driver. This driver can
327           be used to access SPI chips on platforms embedding this
328           UniPhier IP core.
329
330 config XILINX_SPI
331         bool "Xilinx SPI driver"
332         help
333           Enable the Xilinx SPI driver from the Xilinx EDK. This SPI
334           controller support 8 bit SPI transfers only, with or w/o FIFO.
335           For more info on Xilinx SPI Register Definitions and Overview
336           see driver file - drivers/spi/xilinx_spi.c
337
338 config ZYNQ_SPI
339         bool "Zynq SPI driver"
340         depends on ARCH_ZYNQ || ARCH_ZYNQMP || ARCH_VERSAL
341         help
342           Enable the Zynq SPI driver. This driver can be used to
343           access the SPI NOR flash on platforms embedding this Zynq
344           SPI IP core.
345
346 config ZYNQ_QSPI
347         bool "Zynq QSPI driver"
348         depends on ARCH_ZYNQ
349         imply SPI_FLASH_BAR
350         help
351           Enable the Zynq Quad-SPI (QSPI) driver. This driver can be
352           used to access the SPI NOR flash on platforms embedding this
353           Zynq QSPI IP core. This IP is used to connect the flash in
354           4-bit qspi, 8-bit dual stacked and shared 4-bit dual parallel.
355
356 config ZYNQMP_GQSPI
357         bool "Configure ZynqMP Generic QSPI"
358         depends on ARCH_ZYNQMP || ARCH_VERSAL
359         help
360           This option is used to enable ZynqMP QSPI controller driver which
361           is used to communicate with qspi flash devices.
362
363 endif # if DM_SPI
364
365 config SOFT_SPI
366         bool "Soft SPI driver"
367         depends on DM_SPI || (DEPRECATED && !DM_SPI)
368         help
369          Enable Soft SPI driver. This driver is to use GPIO simulate
370          the SPI protocol.
371
372 config MSCC_BB_SPI
373         bool "MSCC bitbang SPI driver"
374         depends on SOC_VCOREIII
375         help
376           Enable MSCC bitbang SPI driver. This driver can be used on
377           MSCC SOCs.
378
379 config CF_SPI
380         bool "ColdFire SPI driver"
381         help
382           Enable the ColdFire SPI driver. This driver can be used on
383           some m68k SoCs.
384
385 config FSL_ESPI
386         bool "Freescale eSPI driver"
387         help
388           Enable the Freescale eSPI driver. This driver can be used to
389           access the SPI interface and SPI NOR flash on platforms embedding
390           this Freescale eSPI IP core.
391
392 config FSL_QSPI
393         bool "Freescale QSPI driver"
394         imply SPI_FLASH_BAR
395         help
396           Enable the Freescale Quad-SPI (QSPI) driver. This driver can be
397           used to access the SPI NOR flash on platforms embedding this
398           Freescale IP core.
399
400 config DAVINCI_SPI
401         bool "Davinci & Keystone SPI driver"
402         depends on ARCH_DAVINCI || ARCH_KEYSTONE
403         help
404           Enable the Davinci SPI driver
405
406 config SH_SPI
407         bool "SuperH SPI driver"
408         depends on DEPRECATED
409         help
410           Enable the SuperH SPI controller driver. This driver can be used
411           on various SuperH SoCs, such as SH7757.
412
413 config SH_QSPI
414         bool "Renesas Quad SPI driver"
415         help
416           Enable the Renesas Quad SPI controller driver. This driver can be
417           used on Renesas SoCs.
418
419 config KIRKWOOD_SPI
420         bool "Marvell Kirkwood SPI Driver"
421         help
422           Enable support for SPI on various Marvell SoCs, such as
423           Kirkwood and Armada 375.
424
425 config LPC32XX_SSP
426         bool "LPC32XX SPI Driver"
427         depends on DEPRECATED
428         help
429           Enable support for SPI on LPC32xx
430
431 config MXC_SPI
432         bool "MXC SPI Driver"
433         help
434           Enable the MXC SPI controller driver. This driver can be used
435           on various i.MX SoCs such as i.MX31/35/51/6/7.
436
437 config MXS_SPI
438         bool "MXS SPI Driver"
439         help
440           Enable the MXS SPI controller driver. This driver can be used
441           on the i.MX23 and i.MX28 SoCs.
442
443 config OMAP3_SPI
444         bool "McSPI driver for OMAP"
445         help
446           SPI master controller for OMAP24XX and later Multichannel SPI
447           (McSPI). This driver be used to access SPI chips on platforms
448           embedding this OMAP3 McSPI IP core.
449
450 endif # menu "SPI Support"