Skip to content

Commit

Permalink
Add copyright, license and maintainer attributes to all PacketStream …
Browse files Browse the repository at this point in the history
…source files
  • Loading branch information
t-wallet committed Oct 18, 2024
1 parent 356e222 commit 6a94198
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 8 deletions.
6 changes: 3 additions & 3 deletions clash-protocols/src/Protocols/PacketStream.hs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Provides the PacketStream protocol, a simple streaming protocol for transferring packets of data between components.
Expand Down
4 changes: 4 additions & 0 deletions clash-protocols/src/Protocols/PacketStream/AsyncFifo.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
{-# OPTIONS_HADDOCK hide #-}

{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Provides `asyncFifoC` for crossing clock domains in the packet stream protocol.
-}
module Protocols.PacketStream.AsyncFifo (asyncFifoC) where
Expand Down
6 changes: 5 additions & 1 deletion clash-protocols/src/Protocols/PacketStream/Base.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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. <[email protected]>
Definitions and instances of the PacketStream protocol.
-}
module Protocols.PacketStream.Base (
-- * Protocol definition
Expand Down
7 changes: 6 additions & 1 deletion clash-protocols/src/Protocols/PacketStream/Converters.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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. <[email protected]>
Provides an upconverter and downconverter for changing the data width of
packet streams.
-}
module Protocols.PacketStream.Converters (
downConverterC,
Expand Down
4 changes: 4 additions & 0 deletions clash-protocols/src/Protocols/PacketStream/Delay.hs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
{-# OPTIONS_HADDOCK hide #-}

{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Provides a circuit that delays a stream by a configurable amount of transfers.
-}
module Protocols.PacketStream.Delay (
Expand Down
4 changes: 4 additions & 0 deletions clash-protocols/src/Protocols/PacketStream/Depacketizers.hs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
{-# OPTIONS_HADDOCK hide #-}

{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Utility circuits for reading from a packet stream.
-}
module Protocols.PacketStream.Depacketizers (
Expand Down
6 changes: 3 additions & 3 deletions clash-protocols/src/Protocols/PacketStream/Hedgehog.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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. <[email protected]>
Provides Hedgehog generators, models and utility functions for testing
`PacketStream` circuits.
Expand Down
4 changes: 4 additions & 0 deletions clash-protocols/src/Protocols/PacketStream/PacketFifo.hs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
{-# OPTIONS_HADDOCK hide #-}

{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Optimized Store and forward FIFO circuit for packet streams.
-}
module Protocols.PacketStream.PacketFifo (
Expand Down
4 changes: 4 additions & 0 deletions clash-protocols/src/Protocols/PacketStream/Packetizers.hs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
{-# OPTIONS_HADDOCK hide #-}

{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Utility circuits for appending headers to the beginning of packets.
-}
module Protocols.PacketStream.Packetizers (
Expand Down
4 changes: 4 additions & 0 deletions clash-protocols/src/Protocols/PacketStream/Routing.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
{-# OPTIONS_HADDOCK hide #-}

{- |
Copyright : (C) 2024, QBayLogic B.V.
License : BSD2 (see the file LICENSE)
Maintainer : QBayLogic B.V. <[email protected]>
Provides a packet arbiter and dispatcher, for merging and splitting packet streams.
-}
module Protocols.PacketStream.Routing (
Expand Down

0 comments on commit 6a94198

Please sign in to comment.