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 <[email protected]>
Cc: Mathias Duckeck <[email protected]>
Cc: Frank Pavlic <[email protected]>
Cc: Martin Sperl <[email protected]>
Cc: Noralf Trønnes <[email protected]>
Signed-off-by: Mark Brown <[email protected]>
This commit is contained in:
Lukas Wunner 2018-11-08 08:06:10 +01:00 • committed by Mark Brown
commit acf0f85695
No known key found for this signature in database
GPG key ID: 24D68B725D5487D0

View file

@ -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;