Skip to content

Commit 18d5133

Browse files
committed
doc(uart): correct 'water mark' to 'watermark'
Signed-off-by: RAGUL D <[email protected]>
1 parent cd40a18 commit 18d5133

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

hw/ip/uart/doc/theory_of_operation.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010

1111
The TX/RX serial lines are high when idle. Data starts with a START bit (high
1212
idle state deasserts, **1**-->**0**) followed by 8 data bits. The least
13-
significant bit is sent first. If the parity feature is turned on then an odd or
14-
even parity bit follows after the data bits. Finally a STOP (**1**) bit
13+
significant bit is sent first. If the parity feature is turned on then an odd oreven parity bit follows after the data bits. Finally a STOP (**1**) bit
1514
completes one byte of data transfer.
1615

1716
```wavejson
@@ -54,7 +53,7 @@ If TX is not enabled, written DATA into FIFO will be stacked up and sent out
5453
when TX is enabled.
5554

5655
When the FIFO becomes empty as part of transmission, a TX FIFO done interrupt will be raised when the final byte has finished transmitting.
57-
This is separate from the TX FIFO water mark interrupt.
56+
This is separate from the TX FIFO watermark interrupt.
5857

5958

6059
### Reception
@@ -166,9 +165,9 @@ UART module has a few interrupts including general data flow interrupts
166165
and unexpected event interrupts.
167166

168167
#### tx_watermark / tx_empty / rx_watermark
169-
If the TX FIFO level becomes smaller than the TX water mark level (configurable via [`FIFO_CTRL.TXILVL`](registers.md#fifo_ctrl--txilvl)), the `tx_watermark` interrupt is raised to inform SW.
168+
If the TX FIFO level becomes smaller than the TX watermark level (configurable via [`FIFO_CTRL.TXILVL`](registers.md#fifo_ctrl--txilvl)), the `tx_watermark` interrupt is raised to inform SW.
170169
If the TX FIFO is empty, the `tx_empty` interrupt is raised to inform SW.
171-
If the RX FIFO level becomes greater than or equal to RX water mark level (configurable via [`FIFO_CTRL.RXILVL`](registers.md#fifo_ctrl--rxilvl)), the `rx_watermark` interrupt is raised to inform SW.
170+
If the RX FIFO level becomes greater than or equal to RX watermark level (configurable via [`FIFO_CTRL.RXILVL`](registers.md#fifo_ctrl--rxilvl)), the `rx_watermark` interrupt is raised to inform SW.
172171

173172
Note that the watermark interrupts and the empty interrupt are level-based status interrupts.
174173
They will stay asserted for as long as the FIFO levels are in violation of the configured level and cannot be cleared by writing to the status register.

0 commit comments

Comments
 (0)