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

As of commit ebd2c8f6d2 ("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>
This commit is contained in:
Geert Uytterhoeven 2016-05-11 13:56:05 +02:00 committed by Jonathan Corbet
parent 95f981f2e3
commit b79ef07d20
1 changed files with 4 additions and 4 deletions

View File

@ -48,8 +48,8 @@ data:
port->mctrl port->mctrl
port->icount port->icount
info->xmit.head (circ->head) port->state->xmit.head (circ_buf->head)
info->xmit.tail (circ->tail) port->state->xmit.tail (circ_buf->tail)
The low level driver is free to use this lock to provide any additional The low level driver is free to use this lock to provide any additional
locking. locking.
@ -204,7 +204,7 @@ hardware.
RTS nor DTR; this will have already been done via a separate RTS nor DTR; this will have already been done via a separate
call to set_mctrl. call to set_mctrl.
Drivers must not access port->info once this call has completed. Drivers must not access port->state once this call has completed.
This method will only be called when there are no more users of This method will only be called when there are no more users of
this port. this port.
@ -216,7 +216,7 @@ hardware.
Flush any write buffers, reset any DMA state and stop any Flush any write buffers, reset any DMA state and stop any
ongoing DMA transfers. ongoing DMA transfers.
This will be called whenever the port->info->xmit circular This will be called whenever the port->state->xmit circular
buffer is cleared. buffer is cleared.
Locking: port->lock taken. Locking: port->lock taken.