Skip to content

Commit

Permalink
serial: doc: Use port->state instead of info
Browse files Browse the repository at this point in the history
As of commit ebd2c8f ("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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
geertu authored and Jonathan Corbet committed May 14, 2016
1 parent 95f981f commit b79ef07
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Documentation/serial/driver
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ data:

port->mctrl
port->icount
info->xmit.head (circ->head)
info->xmit.tail (circ->tail)
port->state->xmit.head (circ_buf->head)
port->state->xmit.tail (circ_buf->tail)

The low level driver is free to use this lock to provide any additional
locking.
Expand Down Expand Up @@ -204,7 +204,7 @@ hardware.
RTS nor DTR; this will have already been done via a separate
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 port.
Expand All @@ -216,7 +216,7 @@ hardware.
Flush any write buffers, reset any DMA state and stop any
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.

Locking: port->lock taken.
Expand Down

0 comments on commit b79ef07

Please sign in to comment.