diff options
| author | Lukas Wunner <lukas@wunner.de> | 2018-11-08 10:06:10 +0300 |
|---|---|---|
| committer | Mark Brown <broonie@kernel.org> | 2018-11-28 18:58:00 +0300 |
| commit | acf0f856959937952b9758381d5b5bcb65a52cfd (patch) | |
| tree | 56374a54aacbaeb910c92ed55f0d51ca88c64872 /drivers/spi/spi-bcm2835.c | |
| parent | 5c09e42f59313774bc494b652f3177ee347786d9 (diff) | |
| download | linux-acf0f856959937952b9758381d5b5bcb65a52cfd.tar.xz | |
spi: bcm2835: Document struct bcm2835_spi
Document the driver's data structure to lower the barrier to entry for
contributors.
Signed-off-by: Lukas Wunner <lukas@wunner.de>
Cc: Mathias Duckeck <m.duckeck@kunbus.de>
Cc: Frank Pavlic <f.pavlic@kunbus.de>
Cc: Martin Sperl <kernel@martin.sperl.org>
Cc: Noralf Trønnes <noralf@tronnes.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Diffstat (limited to 'drivers/spi/spi-bcm2835.c')
| -rw-r--r-- | drivers/spi/spi-bcm2835.c | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/drivers/spi/spi-bcm2835.c b/drivers/spi/spi-bcm2835.c index 99797bbc65ae..c02a9982ac93 100644 --- a/drivers/spi/spi-bcm2835.c +++ b/drivers/spi/spi-bcm2835.c @@ -80,6 +80,17 @@ #define DRV_NAME "spi-bcm2835" +/** + * struct bcm2835_spi - BCM2835 SPI controller + * @regs: base address of register map + * @clk: core clock, divided to calculate serial clock + * @irq: interrupt, signals TX FIFO empty or RX FIFO ¾ full + * @tx_buf: pointer whence next transmitted byte is read + * @rx_buf: pointer where next received byte is written + * @tx_len: remaining bytes to transmit + * @rx_len: remaining bytes to receive + * @dma_pending: whether a DMA transfer is in progress + */ struct bcm2835_spi { void __iomem *regs; struct clk *clk; |