examples/basic/uart: document divisor parameter.

This commit is contained in:
Reto Kramer 2019-08-22 12:28:40 -07:00 committed by whitequark
parent 47bad3d20e
commit b0ef53e095

View file

@ -2,6 +2,13 @@ from nmigen import *
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):
assert divisor >= 4