[6/6] serial: 8250_bcm2835aux: Document struct bcm2835aux_data

Message ID aea363c27fd541dba96d2ebfeee4f596c6d34932.1579175223.git.lukas@wunner.de
State New
Headers show
Series
  • Raspberry Pi auxiliary UART fixes & cleanups
Related show

Commit Message

Lukas Wunner Jan. 16, 2020, 12:14 p.m.
Document the driver private data of the BCM2835 auxiliary UART so that
upcoming commits may add further members with proper kerneldoc.

Signed-off-by: Lukas Wunner <lukas@wunner.de>
---
 drivers/tty/serial/8250/8250_bcm2835aux.c | 5 +++++
 1 file changed, 5 insertions(+)

Patch

diff --git a/drivers/tty/serial/8250/8250_bcm2835aux.c b/drivers/tty/serial/8250/8250_bcm2835aux.c
index d21460c9ef4b..e70e3cc30050 100644
--- a/drivers/tty/serial/8250/8250_bcm2835aux.c
+++ b/drivers/tty/serial/8250/8250_bcm2835aux.c
@@ -16,6 +16,11 @@ 
 
 #include "8250.h"
 
+/**
+ * struct bcm2835aux_data - driver private data of BCM2835 auxiliary UART
+ * @clk: clock producer of the port's uartclk
+ * @line: index of the port's serial8250_ports[] entry
+ */
 struct bcm2835aux_data {
 	struct clk *clk;
 	int line;