PacketStream protocol, converters, UART stuff and async FIFO

.ci/test_whitespace.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -xou pipefail
+
+grep \
+  -E ' $' -n -r . \
+  --include=*.{hs,hs-boot,sh,cabal,md,yml} \
+  --exclude-dir=dist-newstyle --exclude-dir=deps
+if [[ $? == 0 ]]; then
+    echo "EOL whitespace detected. See ^"
+    exit 1;
+fi

.github/workflows/test.yaml

@@ -0,0 +1,40 @@
+name: "CI pipeline"
+on:
+  push:
+  pull_request:
+jobs:
+  file_endings:
+    runs-on: ubuntu-latest
+    steps:
+      - name: git checkout
+        uses: actions/checkout@v4
+      - name: Whitespace file endings
+        run: |
+          .ci/test_whitespace.sh
+
+
+  # build_and_synthesize:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - name: git checkout
+  #     uses: actions/checkout@v4
+  #   - name: install nix
+  #     uses: cachix/install-nix-action@v22
+  #     with:
+  #       nix_path: nixpkgs=channel:nixos-unstable
+  #   - name: cache nix
+  #     uses: DeterminateSystems/magic-nix-cache-action@v2
+  #   - name: build the nix environment
+  #     run: nix-build
+  #   - name: check stylish-haskell
+  #     run: nix-shell --run "make check_format"
+  #   - name: clean linting process
+  #     run: nix-shell --run "make clean_tests"
+  #   - name: Test suite
+  #     run: nix-shell --run "make test"
+  #   - name: Test synthesis
+  #     run: nix-shell --run "make verilog"
+  #   - name: Create netlist
+  #     run: nix-shell --run "make netlist"
+  #   - name: Create Place and Route
+  #     run: nix-shell --run "make pnr"

Makefile

@@ -6,6 +6,15 @@ clean:
 
 format:
 	stylish-haskell -c ./.stylish-haskell.yaml -r -i src
+
+check_format:
+	cp ./.stylish-haskell.yaml ./.stylish-haskell-check.yaml 
+	echo "exit_code: error_on_format" >> ./.stylish-haskell-check.yaml 
+	stylish-haskell -c ./.stylish-haskell-check.yaml -r src
+
+clean_tests: 
+	rm ./.stylish-haskell-check.yaml
+
 test:
 	cabal test
 

Setup.hs

@@ -0,0 +1,5 @@
+import Prelude
+import Distribution.Extra.Doctest (defaultMainWithDoctests)
+
+main :: IO ()
+main = defaultMainWithDoctests "doctests"

clash-eth.cabal

@@ -33,6 +33,7 @@ common common-options
     TypeFamilies
     TypeOperators
     ViewPatterns
+    ImportQualifiedPost
 
     -- TemplateHaskell is used to support convenience functions such as
     -- 'listToVecTH' and 'bLit'.
@@ -78,18 +79,35 @@ common common-options
     ghc-typelits-extra,
     ghc-typelits-knownnat
 
+custom-setup
+  setup-depends:
+    base          >= 4.11 && <5,
+    Cabal         >= 2.4,
+    cabal-doctest >= 1.0.1 && <1.1
+
 library
   import: common-options
   hs-source-dirs: src
   exposed-modules:
     Clash.Lattice.ECP5.Colorlight.TopEntity
     Clash.Cores.Ethernet.RGMII
+    Clash.Cores.Ethernet.PacketStream
+    Clash.Cores.Ethernet.UpConverter
+    Clash.Cores.Ethernet.DownConverter
+    Clash.Cores.Ethernet.Util
+    Clash.Cores.Ethernet.InterpacketGapInserter
+    Clash.Cores.Ethernet.AsyncFIFO
     Clash.Lattice.ECP5.Prims
+    Clash.Lattice.ECP5.UART
     Clash.Lattice.ECP5.Colorlight.CRG
   default-language: Haskell2010
   build-depends:
     interpolate,
-    clash-cores
+    clash-cores,
+    deepseq,
+    hashable,
+    -- For debugging
+    pretty-show
 
 test-suite doctests
   type:             exitcode-stdio-1.0
@@ -100,7 +118,8 @@ test-suite doctests
   build-depends:
     base,
     clash-eth,
-    doctest-parallel >= 0.2 && < 0.4,
+    doctest >= 0.17 && <= 0.19,
+    process,
 
 test-suite test-library
   import: common-options
@@ -110,11 +129,20 @@ test-suite test-library
   ghc-options: -threaded
   main-is: unittests.hs
   other-modules:
-    Test.Cores.Ethernet.Ethernet
+    Test.Cores.Ethernet.Util
+    Test.Cores.Ethernet.PacketStream
+    Test.Lattice.ECP5.UART
+    Test.Cores.Ethernet.DownConverter
+    Test.Cores.Ethernet.UpConverter
+    Test.Cores.Ethernet.InterpacketGapInserter
+    Test.Cores.Ethernet.AsyncFIFO
   build-depends:
     clash-eth,
     QuickCheck,
     hedgehog,
+    clash-cores,
+    hashable,
+    unordered-containers,
     tasty >= 1.2 && < 1.5,
     tasty-hedgehog,
     tasty-th

default.nix

@@ -0,0 +1,9 @@
+with import ./nix/nixpkgs.nix {};
+
+stdenv.mkDerivation{
+    name = "qbaylogic-clash-based-macipudp-stack-spring24" ;
+    src = ./. ;
+    installPhase= '' 
+        touch $out
+    '';
+}

diagram/build.sh

@@ -1,5 +1,7 @@
 #!/usr/bin/env sh
 set -euxo pipefail
 
-plantuml -tsvg layer1+2-arch.puml
-plantuml -tsvg uart-eth.puml
+for i in *.puml
+do
+  plantuml -tsvg "$i"
+done

diagram/layer1+2-arch.puml

@@ -34,14 +34,15 @@ rectangle "Frame check sequence\nvalidation" as FCSRx <<SystemDomain>>
 rectangle "MAC depacketizer" as PacketRx <<SystemDomain>>
 rectangle "MAC sink" as Sink <<SystemDomain>>
 
-PhyRx -down-> UpConv : last_be :: Maybe (Vec 1 Bool) \nabort :: Bool\npayload ::  Vec 1 (BitVector 8)
-UpConv -down-> CDCRx : last_be :: Maybe (Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-CDCRx -down-> PreRx : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-PreRx -down-> FCSRx : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-FCSRx -down-> PacketRx : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-PacketRx -down-> Sink : mac_header :: MacHeader\nlast_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
+PhyRx -down-> UpConv : PacketStream 1 ()
+UpConv -down-> CDCRx : PacketStream 1 ()
+CDCRx -down-> PreRx : PacketStream 4 ()
+PreRx -down-> FCSRx : PacketStream 4 ()
+FCSRx -down-> PacketRx : PacketStream 4 ()
+PacketRx -down-> Sink : PacketStream 4 MacHeader
 
 rectangle "MAC source" as Source <<SystemDomain>>
+rectangle "Padding insert" as PaddingTx <<SystemDomain>>
 rectangle "MAC Packetizer" as PacketTx <<SystemDomain>>
 rectangle "Frame check sequence\ninserter" as FCSTx <<SystemDomain>>
 rectangle "Preamble inserter" as PreTx <<SystemDomain>>
@@ -50,12 +51,13 @@ rectangle "DownConverter" as DownConv <<PhyTxDomain>>
 rectangle "Interpacket gap inserter" as IPG <<PhyTxDomain>>
 rectangle "Phy Transmitter" as PhyTx <<PhyTxDomain>>
 
-Source -up-> PacketTx : mac_header :: MacHeader\nlast_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-PacketTx -up-> FCSTx : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-FCSTx -up-> PreTx : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-PreTx -up-> CDCTx : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-CDCTx -up-> DownConv : last_be :: Maybe(Vec n Bool)\nabort :: Bool\npayload :: Vec n (BitVector 8)
-DownConv -up-> IPG : last_be :: Maybe (Vec 1 Bool) \nabort :: Bool\npayload ::  Vec 1 (BitVector 8)
-IPG -up-> PhyTx : last_be :: Maybe (Vec 1 Bool) \nabort :: Bool\npayload ::  Vec 1 (BitVector 8)
+Source -up-> PacketTx : PacketStream 4 MacHeader
+PacketTx -up-> PaddingTx : PacketStream 4 ()
+PaddingTx -up-> FCSTx : PacketStream 4 ()
+FCSTx -up-> PreTx : PacketStream 4 ()
+PreTx -up-> CDCTx : PacketStream 4 ()
+CDCTx -up-> DownConv : PacketStream 4 ()
+DownConv -up-> IPG : PacketStream 1 ()
+IPG -up-> PhyTx : PacketStream 1 ()
 
 @enduml