From 6a941985a753c9894dd46f305d7a4463a899c8a0 Mon Sep 17 00:00:00 2001 From: t-wallet Date: Fri, 18 Oct 2024 16:58:34 +0200 Subject: [PATCH] Add copyright, license and maintainer attributes to all PacketStream source files --- clash-protocols/src/Protocols/PacketStream.hs | 6 +++--- clash-protocols/src/Protocols/PacketStream/AsyncFifo.hs | 4 ++++ clash-protocols/src/Protocols/PacketStream/Base.hs | 6 +++++- clash-protocols/src/Protocols/PacketStream/Converters.hs | 7 ++++++- clash-protocols/src/Protocols/PacketStream/Delay.hs | 4 ++++ .../src/Protocols/PacketStream/Depacketizers.hs | 4 ++++ clash-protocols/src/Protocols/PacketStream/Hedgehog.hs | 6 +++--- clash-protocols/src/Protocols/PacketStream/PacketFifo.hs | 4 ++++ clash-protocols/src/Protocols/PacketStream/Packetizers.hs | 4 ++++ clash-protocols/src/Protocols/PacketStream/Routing.hs | 4 ++++ 10 files changed, 41 insertions(+), 8 deletions(-) diff --git a/clash-protocols/src/Protocols/PacketStream.hs b/clash-protocols/src/Protocols/PacketStream.hs index 41ea82ba..1799886d 100644 --- a/clash-protocols/src/Protocols/PacketStream.hs +++ b/clash-protocols/src/Protocols/PacketStream.hs @@ -1,7 +1,7 @@ {- | - Copyright : (C) 2024, QBayLogic B.V. - License : BSD2 (see the file LICENSE) - Maintainer : QBayLogic B.V. +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. Provides the PacketStream protocol, a simple streaming protocol for transferring packets of data between components. diff --git a/clash-protocols/src/Protocols/PacketStream/AsyncFifo.hs b/clash-protocols/src/Protocols/PacketStream/AsyncFifo.hs index b4f80dd2..f017d461 100644 --- a/clash-protocols/src/Protocols/PacketStream/AsyncFifo.hs +++ b/clash-protocols/src/Protocols/PacketStream/AsyncFifo.hs @@ -2,6 +2,10 @@ {-# OPTIONS_HADDOCK hide #-} {- | +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + Provides `asyncFifoC` for crossing clock domains in the packet stream protocol. -} module Protocols.PacketStream.AsyncFifo (asyncFifoC) where diff --git a/clash-protocols/src/Protocols/PacketStream/Base.hs b/clash-protocols/src/Protocols/PacketStream/Base.hs index c13bbc9a..e410caba 100644 --- a/clash-protocols/src/Protocols/PacketStream/Base.hs +++ b/clash-protocols/src/Protocols/PacketStream/Base.hs @@ -4,7 +4,11 @@ {-# OPTIONS_HADDOCK hide #-} {- | -Definitions and instances of the PacketStream protocol +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + +Definitions and instances of the PacketStream protocol. -} module Protocols.PacketStream.Base ( -- * Protocol definition diff --git a/clash-protocols/src/Protocols/PacketStream/Converters.hs b/clash-protocols/src/Protocols/PacketStream/Converters.hs index ca29176c..71f945fc 100644 --- a/clash-protocols/src/Protocols/PacketStream/Converters.hs +++ b/clash-protocols/src/Protocols/PacketStream/Converters.hs @@ -3,7 +3,12 @@ {-# OPTIONS_HADDOCK hide #-} {- | -Provides an upconverter and downconverter for changing the data width of packet streams. +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + +Provides an upconverter and downconverter for changing the data width of +packet streams. -} module Protocols.PacketStream.Converters ( downConverterC, diff --git a/clash-protocols/src/Protocols/PacketStream/Delay.hs b/clash-protocols/src/Protocols/PacketStream/Delay.hs index 9741af8b..2bc9abc8 100644 --- a/clash-protocols/src/Protocols/PacketStream/Delay.hs +++ b/clash-protocols/src/Protocols/PacketStream/Delay.hs @@ -3,6 +3,10 @@ {-# OPTIONS_HADDOCK hide #-} {- | +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + Provides a circuit that delays a stream by a configurable amount of transfers. -} module Protocols.PacketStream.Delay ( diff --git a/clash-protocols/src/Protocols/PacketStream/Depacketizers.hs b/clash-protocols/src/Protocols/PacketStream/Depacketizers.hs index 3b5812a1..5681a61b 100644 --- a/clash-protocols/src/Protocols/PacketStream/Depacketizers.hs +++ b/clash-protocols/src/Protocols/PacketStream/Depacketizers.hs @@ -6,6 +6,10 @@ {-# OPTIONS_HADDOCK hide #-} {- | +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + Utility circuits for reading from a packet stream. -} module Protocols.PacketStream.Depacketizers ( diff --git a/clash-protocols/src/Protocols/PacketStream/Hedgehog.hs b/clash-protocols/src/Protocols/PacketStream/Hedgehog.hs index dbfa166b..d6d8f91d 100644 --- a/clash-protocols/src/Protocols/PacketStream/Hedgehog.hs +++ b/clash-protocols/src/Protocols/PacketStream/Hedgehog.hs @@ -2,9 +2,9 @@ {-# LANGUAGE NoImplicitPrelude #-} {- | -Copyright : (C) 2024, QBayLogic B.V. -License : BSD2 (see the file LICENSE) -Maintainer : QBayLogic B.V. +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. Provides Hedgehog generators, models and utility functions for testing `PacketStream` circuits. diff --git a/clash-protocols/src/Protocols/PacketStream/PacketFifo.hs b/clash-protocols/src/Protocols/PacketStream/PacketFifo.hs index 78a55426..0afb1b05 100644 --- a/clash-protocols/src/Protocols/PacketStream/PacketFifo.hs +++ b/clash-protocols/src/Protocols/PacketStream/PacketFifo.hs @@ -3,6 +3,10 @@ {-# OPTIONS_HADDOCK hide #-} {- | +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + Optimized Store and forward FIFO circuit for packet streams. -} module Protocols.PacketStream.PacketFifo ( diff --git a/clash-protocols/src/Protocols/PacketStream/Packetizers.hs b/clash-protocols/src/Protocols/PacketStream/Packetizers.hs index 84d0e2f0..64881e36 100644 --- a/clash-protocols/src/Protocols/PacketStream/Packetizers.hs +++ b/clash-protocols/src/Protocols/PacketStream/Packetizers.hs @@ -5,6 +5,10 @@ {-# OPTIONS_HADDOCK hide #-} {- | +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + Utility circuits for appending headers to the beginning of packets. -} module Protocols.PacketStream.Packetizers ( diff --git a/clash-protocols/src/Protocols/PacketStream/Routing.hs b/clash-protocols/src/Protocols/PacketStream/Routing.hs index 389ee0c8..c0c597fa 100644 --- a/clash-protocols/src/Protocols/PacketStream/Routing.hs +++ b/clash-protocols/src/Protocols/PacketStream/Routing.hs @@ -2,6 +2,10 @@ {-# OPTIONS_HADDOCK hide #-} {- | +Copyright : (C) 2024, QBayLogic B.V. +License : BSD2 (see the file LICENSE) +Maintainer : QBayLogic B.V. + Provides a packet arbiter and dispatcher, for merging and splitting packet streams. -} module Protocols.PacketStream.Routing (