Skip to content

Commit

Permalink
Add missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PietPtr committed Jan 18, 2022
1 parent 24b9254 commit d3a48f1
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/Protocols/Axi4/ReadAddress.hs
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,9 @@ deriving instance
, C.NFDataX (QosType kq) ) =>
C.NFDataX (M2S_ReadAddress kb ksz lw iw aw kr kbl kl kc kp kq userType)


-- | Circuit that transforms the LHS 'Axi4ReadAddress' protocol to a
-- version using different type parameters according to two functions
-- that can transform the data and ack signal to and from the other protocol.
mapFull ::
forall dom
kb1 ksz1 lw1 iw1 aw1 kr1 kbl1 kl1 kc1 kp1 kq1 t1
Expand Down
3 changes: 3 additions & 0 deletions src/Protocols/Axi4/WriteAddress.hs
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ deriving instance
, C.NFDataX (QosType kq) ) =>
C.NFDataX (M2S_WriteAddress kb ksz lw iw aw kr kbl kl kc kp kq userType)

-- | Circuit that transforms the LHS 'Axi4WriteAddress' protocol to a
-- version using different type parameters according to two functions
-- that can transform the data and ack signal to and from the other protocol.
mapFull ::
forall dom
kb1 ksz1 lw1 iw1 aw1 kr1 kbl1 kl1 kc1 kp1 kq1 userType1
Expand Down
3 changes: 3 additions & 0 deletions src/Protocols/Axi4/WriteData.hs
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ deriving instance
, C.KnownNat nBytes ) =>
Show (M2S_WriteData ks nBytes userType)

-- | Circuit that transforms the LHS 'Axi4WriteData' protocol to a
-- version using different type parameters according to two functions
-- that can transform the data and ack signal to and from the other protocol.
mapFull ::
forall dom ks1 ks2 nBytes1 nBytes2 t1 t2.
(M2S_WriteData ks1 nBytes1 t1 -> M2S_WriteData ks2 nBytes2 t2) ->
Expand Down
3 changes: 3 additions & 0 deletions src/Protocols/Axi4/WriteResponse.hs
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ deriving instance
, C.KnownNat (Width iw) ) =>
Show (S2M_WriteResponse kr iw userType)

-- | Circuit that transforms the LHS 'Axi4WriteResponse' protocol to a
-- version using different type parameters according to two functions
-- that can transform the data and ack signal to and from the other protocol.
mapFull ::
forall dom
kr1 iw1 userType1
Expand Down

0 comments on commit d3a48f1

Please sign in to comment.