Jonathan Corbet | dcec3c8 | 2016-08-20 13:17:32 -0600 | [diff] [blame^] | 1 | Serial Peripheral Interface (SPI) |
| 2 | ================================= |
| 3 | |
| 4 | SPI is the "Serial Peripheral Interface", widely used with embedded |
| 5 | systems because it is a simple and efficient interface: basically a |
| 6 | multiplexed shift register. Its three signal wires hold a clock (SCK, |
| 7 | often in the range of 1-20 MHz), a "Master Out, Slave In" (MOSI) data |
| 8 | line, and a "Master In, Slave Out" (MISO) data line. SPI is a full |
| 9 | duplex protocol; for each bit shifted out the MOSI line (one per clock) |
| 10 | another is shifted in on the MISO line. Those bits are assembled into |
| 11 | words of various sizes on the way to and from system memory. An |
| 12 | additional chipselect line is usually active-low (nCS); four signals are |
| 13 | normally used for each peripheral, plus sometimes an interrupt. |
| 14 | |
| 15 | The SPI bus facilities listed here provide a generalized interface to |
| 16 | declare SPI busses and devices, manage them according to the standard |
| 17 | Linux driver model, and perform input/output operations. At this time, |
| 18 | only "master" side interfaces are supported, where Linux talks to SPI |
| 19 | peripherals and does not implement such a peripheral itself. (Interfaces |
| 20 | to support implementing SPI slaves would necessarily look different.) |
| 21 | |
| 22 | The programming interface is structured around two kinds of driver, and |
| 23 | two kinds of device. A "Controller Driver" abstracts the controller |
| 24 | hardware, which may be as simple as a set of GPIO pins or as complex as |
| 25 | a pair of FIFOs connected to dual DMA engines on the other side of the |
| 26 | SPI shift register (maximizing throughput). Such drivers bridge between |
| 27 | whatever bus they sit on (often the platform bus) and SPI, and expose |
| 28 | the SPI side of their device as a :c:type:`struct spi_master |
| 29 | <spi_master>`. SPI devices are children of that master, |
| 30 | represented as a :c:type:`struct spi_device <spi_device>` and |
| 31 | manufactured from :c:type:`struct spi_board_info |
| 32 | <spi_board_info>` descriptors which are usually provided by |
| 33 | board-specific initialization code. A :c:type:`struct spi_driver |
| 34 | <spi_driver>` is called a "Protocol Driver", and is bound to a |
| 35 | spi_device using normal driver model calls. |
| 36 | |
| 37 | The I/O model is a set of queued messages. Protocol drivers submit one |
| 38 | or more :c:type:`struct spi_message <spi_message>` objects, |
| 39 | which are processed and completed asynchronously. (There are synchronous |
| 40 | wrappers, however.) Messages are built from one or more |
| 41 | :c:type:`struct spi_transfer <spi_transfer>` objects, each of |
| 42 | which wraps a full duplex SPI transfer. A variety of protocol tweaking |
| 43 | options are needed, because different chips adopt very different |
| 44 | policies for how they use the bits transferred with SPI. |
| 45 | |
| 46 | .. kernel-doc:: include/linux/spi/spi.h |
| 47 | :internal: |
| 48 | |
| 49 | .. kernel-doc:: drivers/spi/spi.c |
| 50 | :functions: spi_register_board_info |
| 51 | |
| 52 | .. kernel-doc:: drivers/spi/spi.c |
| 53 | :export: |
| 54 | |
| 55 | I\ :sup:`2`\ C and SMBus Subsystem |
| 56 | ================================== |
| 57 | |
| 58 | I\ :sup:`2`\ C (or without fancy typography, "I2C") is an acronym for |
| 59 | the "Inter-IC" bus, a simple bus protocol which is widely used where low |
| 60 | data rate communications suffice. Since it's also a licensed trademark, |
| 61 | some vendors use another name (such as "Two-Wire Interface", TWI) for |
| 62 | the same bus. I2C only needs two signals (SCL for clock, SDA for data), |
| 63 | conserving board real estate and minimizing signal quality issues. Most |
| 64 | I2C devices use seven bit addresses, and bus speeds of up to 400 kHz; |
| 65 | there's a high speed extension (3.4 MHz) that's not yet found wide use. |
| 66 | I2C is a multi-master bus; open drain signaling is used to arbitrate |
| 67 | between masters, as well as to handshake and to synchronize clocks from |
| 68 | slower clients. |
| 69 | |
| 70 | The Linux I2C programming interfaces support only the master side of bus |
| 71 | interactions, not the slave side. The programming interface is |
| 72 | structured around two kinds of driver, and two kinds of device. An I2C |
| 73 | "Adapter Driver" abstracts the controller hardware; it binds to a |
| 74 | physical device (perhaps a PCI device or platform_device) and exposes a |
| 75 | :c:type:`struct i2c_adapter <i2c_adapter>` representing each |
| 76 | I2C bus segment it manages. On each I2C bus segment will be I2C devices |
| 77 | represented by a :c:type:`struct i2c_client <i2c_client>`. |
| 78 | Those devices will be bound to a :c:type:`struct i2c_driver |
| 79 | <i2c_driver>`, which should follow the standard Linux driver |
| 80 | model. (At this writing, a legacy model is more widely used.) There are |
| 81 | functions to perform various I2C protocol operations; at this writing |
| 82 | all such functions are usable only from task context. |
| 83 | |
| 84 | The System Management Bus (SMBus) is a sibling protocol. Most SMBus |
| 85 | systems are also I2C conformant. The electrical constraints are tighter |
| 86 | for SMBus, and it standardizes particular protocol messages and idioms. |
| 87 | Controllers that support I2C can also support most SMBus operations, but |
| 88 | SMBus controllers don't support all the protocol options that an I2C |
| 89 | controller will. There are functions to perform various SMBus protocol |
| 90 | operations, either using I2C primitives or by issuing SMBus commands to |
| 91 | i2c_adapter devices which don't support those I2C operations. |
| 92 | |
| 93 | .. kernel-doc:: include/linux/i2c.h |
| 94 | :internal: |
| 95 | |
| 96 | .. kernel-doc:: drivers/i2c/i2c-boardinfo.c |
| 97 | :functions: i2c_register_board_info |
| 98 | |
| 99 | .. kernel-doc:: drivers/i2c/i2c-core.c |
| 100 | :export: |
| 101 | |
| 102 | High Speed Synchronous Serial Interface (HSI) |
| 103 | ============================================= |
| 104 | |
| 105 | High Speed Synchronous Serial Interface (HSI) is a serial interface |
| 106 | mainly used for connecting application engines (APE) with cellular modem |
| 107 | engines (CMT) in cellular handsets. HSI provides multiplexing for up to |
| 108 | 16 logical channels, low-latency and full duplex communication. |
| 109 | |
| 110 | .. kernel-doc:: include/linux/hsi/hsi.h |
| 111 | :internal: |
| 112 | |
| 113 | .. kernel-doc:: drivers/hsi/hsi_core.c |
| 114 | :export: |
| 115 | |