From ee374b11928a6c77cd843c60c4c0b30204a69cb2 Mon Sep 17 00:00:00 2001 From: Rutherther Date: Sun, 2 Apr 2023 18:10:16 +0200 Subject: [PATCH] chore: add basic README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..79ce00e --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# JESD204B Receiver +This repository contains implementation of JESD204B standard (https://www.jedec.org/sites/default/files/docs/JESD204B.pdf) receiver in VHDL-2008. +It contains implementation of data link layer and transport layer. +It expects data from a transceivers at its input and outputs samples. +As application layer is application specific, it's not included here. +Care has been taken to allow resetting the link from application layer +as well as passing some errors to the application layer so that it can decide +whether to request resynchronization. + +There are entities that may be used for multipoint links as well as entities for single link. + +The receiver supports subclass 0 and 1. It generates LMFC from SYSREF using a counter, +if subclass 1 is used. + +TODO: add small documentation here. In the meantime, you can check out the testbenches +for some example usage. -- 2.48.1