Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

serial: doc: Use port->state instead of info

As of commit ebd2c8f6d2ec4012 ("serial: kill off uart_info"), the
circular transmission buffer is part of struct uart_state instead of
struct uart_info. Make it clear this structure is pointed to from struct
uart_port.

Change 'circ' to 'circ_buf' to match the structure name while we're at
it.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Geert Uytterhoeven and committed by
Jonathan Corbet
b79ef07d 95f981f2

+4 -4
+4 -4
Documentation/serial/driver
··· 48 48 49 49 port->mctrl 50 50 port->icount 51 - info->xmit.head (circ->head) 52 - info->xmit.tail (circ->tail) 51 + port->state->xmit.head (circ_buf->head) 52 + port->state->xmit.tail (circ_buf->tail) 53 53 54 54 The low level driver is free to use this lock to provide any additional 55 55 locking. ··· 204 204 RTS nor DTR; this will have already been done via a separate 205 205 call to set_mctrl. 206 206 207 - Drivers must not access port->info once this call has completed. 207 + Drivers must not access port->state once this call has completed. 208 208 209 209 This method will only be called when there are no more users of 210 210 this port. ··· 216 216 Flush any write buffers, reset any DMA state and stop any 217 217 ongoing DMA transfers. 218 218 219 - This will be called whenever the port->info->xmit circular 219 + This will be called whenever the port->state->xmit circular 220 220 buffer is cleared. 221 221 222 222 Locking: port->lock taken.