linux-toradex.git/Documentation/driver-api/serial, branch v6.4-rc1

Documentation: driver-api: correct spelling

2023-02-02T18:05:16+00:00

Correct spelling problems for Documentation/driver-api/ as reported
by codespell.

Signed-off-by: Randy Dunlap 
Cc: Mauro Carvalho Chehab 
Cc: linux-media@vger.kernel.org
Cc: Vishal Verma 
Cc: Dave Jiang 
Cc: nvdimm@lists.linux.dev
Cc: Vinod Koul 
Cc: dmaengine@vger.kernel.org
Cc: linux-raid@vger.kernel.org
Cc: linux-usb@vger.kernel.org
Acked-by: Dan Williams 
Acked-by: Song Liu 
Acked-by: Greg Kroah-Hartman 
Link: https://lore.kernel.org/r/20230129231053.20863-3-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet

Documentation: Make formatting consistent for rs485 docs

2022-11-03T02:43:05+00:00

Tweak styling of names that come directly from the code.

Suggested-by: Bagas Sanjaya 
Reviewed-by: Bagas Sanjaya 
Signed-off-by: Ilpo Järvinen 
Link: https://lore.kernel.org/r/20221019093343.9546-6-ilpo.jarvinen@linux.intel.com
Signed-off-by: Greg Kroah-Hartman

Documentation: rs485: Fix struct referencing

2022-11-03T02:43:05+00:00

Use "struct serial_rs485" to get the references properly recognized.

Reviewed-by: Andy Shevchenko 
Reviewed-by: Bagas Sanjaya 
Signed-off-by: Ilpo Järvinen 
Link: https://lore.kernel.org/r/20221019093343.9546-5-ilpo.jarvinen@linux.intel.com
Signed-off-by: Greg Kroah-Hartman

Documentation: rs485: Mention uart_get_rs485_mode()

2022-11-03T02:43:05+00:00

Add to rs485 documentation that serial core prepares the struct
serial_rs485 when uart_get_rs485_mode() is called. Remove the wrong
claim that the driver must fill it by itself.

Reviewed-by: Andy Shevchenko 
Reviewed-by: Bagas Sanjaya 
Signed-off-by: Ilpo Järvinen 
Link: https://lore.kernel.org/r/20221019093343.9546-4-ilpo.jarvinen@linux.intel.com
Signed-off-by: Greg Kroah-Hartman

Documentation: rs485: Link reference properly

2022-11-03T02:43:05+00:00

Link DT bindings reference properly.

Reviewed-by: Andy Shevchenko 
Reviewed-by: Bagas Sanjaya 
Signed-off-by: Ilpo Järvinen 
Link: https://lore.kernel.org/r/20221019093343.9546-3-ilpo.jarvinen@linux.intel.com
Signed-off-by: Greg Kroah-Hartman

serial: Convert serial_rs485 to kernel doc

2022-11-03T02:43:05+00:00

Convert struct serial_rs485 comments to kernel doc format and include
it into documentation.

Suggested-by: Andy Shevchenko 
Reviewed-by: Andy Shevchenko 
Reviewed-by: Bagas Sanjaya 
Signed-off-by: Ilpo Järvinen 
Link: https://lore.kernel.org/r/20221019093343.9546-2-ilpo.jarvinen@linux.intel.com
Signed-off-by: Greg Kroah-Hartman

tty: serial: introduce transmit helpers

2022-11-03T02:32:40+00:00

Many serial drivers do the same thing:
* send x_char if set
* keep sending from the xmit circular buffer until either
  - the loop reaches the end of the xmit buffer
  - TX is stopped
  - HW fifo is full
* check for pending characters and:
  - wake up tty writers to fill for more data into xmit buffer
  - stop TX if there is nothing in the xmit buffer

The only differences are:
* how to write the character to the HW fifo
* the check of the end condition:
  - is the HW fifo full?
  - is limit of the written characters reached?

So unify the above into two helpers:
* uart_port_tx_limited() -- it performs the above taking the written
  characters limit into account, and
* uart_port_tx() -- the same as above, except it only checks the HW
  readiness, not the characters limit.

The HW specific operations (as stated as "differences" above) are passed
as arguments to the macros. They are:
* tx_ready -- returns true if HW can accept more data.
* put_char -- write a character to the device.
* tx_done -- when the write loop is done, perform arbitrary action
  before potential invocation of ops->stop_tx() happens.

Note that the above are macros. This means the code is generated in
place and the above 3 arguments are "inlined". I.e. no added penalty by
generating call instructions for every single character. Nor any
indirect calls. (As in some previous versions of this patchset.)

Reviewed-by: Ilpo Järvinen 
Signed-off-by: Jiri Slaby (SUSE) 
Link: https://lore.kernel.org/r/20221004104927.14361-2-jirislaby@kernel.org
Signed-off-by: Greg Kroah-Hartman

tty: serial: document uart_get_console()

2022-07-28T08:37:42+00:00

This was the only function mentioned in the text, but was neither linked
nor documented. So document and link it, so that hyperlinking works in
the text.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20220728061056.20799-6-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

tty: serial: serial_core, reformat kernel-doc for functions

2022-07-28T08:37:42+00:00

There are many annotated functions in serial_core.c, but they do not
completely conform to the kernel-doc style. So reformat them and link
them from the Documentation.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20220728061056.20799-5-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

Documentation: serial: link uart_ops properly

2022-07-28T08:37:42+00:00

The syntax to reference a struct in text is "struct XY". So reference
uart_ops properly, so that hyperlinks work.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20220728061056.20799-4-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman