From 54139b9e7bf810238177fe22ddb7baf43cbff54e Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Thu, 16 Dec 2021 19:27:06 -0800 Subject: [PATCH] clean up rest of grev.py docs --- src/nmutil/grev.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/nmutil/grev.py b/src/nmutil/grev.py index 49d8e6d..1b90685 100644 --- a/src/nmutil/grev.py +++ b/src/nmutil/grev.py @@ -1,10 +1,9 @@ # SPDX-License-Identifier: LGPL-3-or-later -# See Notices.txt for copyright information +# Copyright Jacob Lifshay -# TODO add funding and explicit copyright notice (contractually required by -# NGI POINTER) +# TODO(lkcl): add NGI POINTER funding notice, idk what we need for that... -# TODO link to bugreport +"""Generalized bit-reverse. See `GRev` for docs.""" from nmigen.hdl.ast import Signal from nmigen.hdl.dsl import Module @@ -43,6 +42,8 @@ def grev(input, chunk_sizes, log2_width): class GRev(Elaboratable): """ Generalized bit-reverse. + https://bugs.libre-soc.org/show_bug.cgi?id=755 + A generalized bit-reverse is where every output bit is the input bit at index `output_bit_index XOR chunk_sizes` where `chunk_sizes` is the control input. -- 2.30.2