From: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
To: linux-serial@vger.kernel.org,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Jiri Slaby" <jirislaby@kernel.org>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
linux-kernel@vger.kernel.org
Cc: "Niklas Schnelle" <schnelle@linux.ibm.com>,
"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
Subject: [PATCH v3 2/6] serial: 8250: Document uart_8250_port's ->dl_read/write()
Date: Tue, 9 May 2023 14:39:20 +0300 [thread overview]
Message-ID: <20230509113924.19540-3-ilpo.jarvinen@linux.intel.com> (raw)
In-Reply-To: <20230509113924.19540-1-ilpo.jarvinen@linux.intel.com>
Add documentation for the struct uart_8250_port divisor latch function
pointers. Documentation is in kernel doc format but don't enable kernel
doc yet as many other fields remain undocumented.
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
---
include/linux/serial_8250.h | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/include/linux/serial_8250.h b/include/linux/serial_8250.h
index 7b5d558e4e0c..d64e7bbe1f2f 100644
--- a/include/linux/serial_8250.h
+++ b/include/linux/serial_8250.h
@@ -90,8 +90,17 @@ struct uart_8250_em485 {
* their own 8250 ports without registering their own
* platform device. Using these will make your driver
* dependent on the 8250 driver.
+ *
+ * @dl_read: ``u32 ()(struct uart_8250_port *port)``
+ *
+ * UART divisor latch read.
+ *
+ * @dl_write: ``void ()(struct uart_8250_port *port, u32 value)``
+ *
+ * Write @value into UART divisor latch.
+ *
+ * Locking: Caller holds port's lock.
*/
-
struct uart_8250_port {
struct uart_port port;
struct timer_list timer; /* "no irq" timer */
--
2.30.2
next prev parent reply other threads:[~2023-05-09 11:39 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-09 11:39 [PATCH v3 0/6] serial: Separate RT288x/Au1xxx code into own file Ilpo Järvinen
2023-05-09 11:39 ` [PATCH v3 1/6] serial: 8250: Change dl_read/write to handle value as u32 Ilpo Järvinen
2023-05-10 5:47 ` Jiri Slaby
2023-05-09 11:39 ` Ilpo Järvinen [this message]
2023-05-09 11:39 ` [PATCH v3 3/6] serial: 8250: Add dl_read/write, bugs and mapsize into plat_serial8250_port Ilpo Järvinen
2023-05-10 5:55 ` Jiri Slaby
2023-05-09 11:39 ` [PATCH v3 4/6] serial: 8250: RT288x/Au1xxx code away from core Ilpo Järvinen
2023-05-09 11:39 ` [PATCH v3 5/6] serial: 8250_rt288x: Name non-standard divisor latch reg Ilpo Järvinen
2023-05-09 11:39 ` [PATCH v3 6/6] serial: 8250_rt288x: Remove unnecessary UART_REG_UNMAPPED Ilpo Järvinen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230509113924.19540-3-ilpo.jarvinen@linux.intel.com \
--to=ilpo.jarvinen@linux.intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=jirislaby@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-serial@vger.kernel.org \
--cc=philmd@linaro.org \
--cc=schnelle@linux.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®