examples/basic/uart: document divisor
parameter.
This commit is contained in:
parent
47bad3d20e
commit
b0ef53e095
|
@ -2,6 +2,13 @@ from nmigen import *
|
||||||
|
|
||||||
|
|
||||||
class UART(Elaboratable):
|
class UART(Elaboratable):
|
||||||
|
"""
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
divisor : int
|
||||||
|
Set to ``round(clk-rate / baud-rate)``.
|
||||||
|
E.g. ``12e6 / 115200`` = ``104``.
|
||||||
|
"""
|
||||||
def __init__(self, divisor, data_bits=8):
|
def __init__(self, divisor, data_bits=8):
|
||||||
assert divisor >= 4
|
assert divisor >= 4
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue