Skip to content

Commit

Permalink
RFC #60: fix formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
jfng committed Mar 22, 2024
1 parent d2c1834 commit 705e307
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions text/0060-soc-uart-peripheral.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ class MySoC(wiring.Component):

`Control.enable` is initialized to 0 on reset.

If `Control.enable` is 0, the receiver PHY should be held in reset state.
If `Control.enable` is 1, the receiver PHY should operate normally.
- If `Control.enable` is 0, the receiver PHY should be held in reset state.
- If `Control.enable` is 1, the receiver PHY should operate normally.

##### Status (read/write)

Expand Down Expand Up @@ -135,8 +135,8 @@ baudrate = int(100e6 / divisor)

An implementation may also choose to ignore the `Divisor` register and configure the baudrate through unspecified means.

If `Control.enable` is 0, `Divisor` is read/write.
If `Control.enable` is 1, `Divisor` is read-only.
- If `Control.enable` is 0, `Divisor` is read/write.
- If `Control.enable` is 1, `Divisor` is read-only.

`Divisor` is initialized to `divisor_init` on reset.

Expand All @@ -147,9 +147,9 @@ If `Control.enable` is 1, `Divisor` is read-only.
{name: 'data', bits: 8, attr: 'R'},
], {bits: 8})">

If `Control.enable` is 0 or `Status.ready` is 0:
- If `Control.enable` is 0 or `Status.ready` is 0:
* reading from `Data` has no side-effect and returns an unspecified value.
If `Control.enable` is 1 and `Status.ready` is 1:
- If `Control.enable` is 1 and `Status.ready` is 1:
* reading from `Data` consumes one symbol from the receive buffer and returns it.

#### Transmitter
Expand All @@ -164,8 +164,8 @@ If `Control.enable` is 1 and `Status.ready` is 1:

`Control.enable` is initialized to 0 on reset.

If `Control.enable` is 0, the transmitter PHY should be held in reset state.
If `Control.enable` is 1, the transmitter PHY should operate normally.
- If `Control.enable` is 0, the transmitter PHY should be held in reset state.
- If `Control.enable` is 1, the transmitter PHY should operate normally.

##### Status (read-only)

Expand Down Expand Up @@ -194,8 +194,8 @@ baudrate = int(100e6 / divisor)

An implementation may also choose to ignore the `Divisor` register and configure the baudrate through unspecified means.

If `Control.enable` is 0, `Divisor` is read/write.
If `Control.enable` is 1, `Divisor` is read-only.
- If `Control.enable` is 0, `Divisor` is read/write.
- If `Control.enable` is 1, `Divisor` is read-only.

`Divisor` is initialized to `divisor_init` on reset.

Expand All @@ -208,9 +208,9 @@ If `Control.enable` is 1, `Divisor` is read-only.

- If `Status.rdy` is 1, writing to `Data` adds one character to the transmit buffer.

If `Control.enable` is 0 or `Status.ready` is 0:
- If `Control.enable` is 0 or `Status.ready` is 0:
* writing to `Data` has no side-effect.
If `Control.enable` is 1 and `Status.ready` is 1:
- If `Control.enable` is 1 and `Status.ready` is 1:
* writing to `Data` adds one symbol to the transmit buffer.

## Reference-level explanation
Expand Down

0 comments on commit 705e307

Please sign in to comment.