Skip to content

Remove leading / trailing '\\' in SDC signal names (copy #2129) #2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alex-mckenna merged 1 commit into from
Mar 24, 2022
Merged

Remove leading / trailing '\\' in SDC signal names (copy #2129) #2142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog/2022-03-22T11_36_15+01_00_sdc_escaped_ids.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
FIXED: Clash no longer escapes extended identifiers when rendering SDC files.
CHANGED: Clash now always generates non-extended identifiers for port names, so that generated names play nicer with different vendor tools.
3 changes: 2 additions & 1 deletion clash-lib/src/Clash/Driver/Types.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import Data.Maybe (isJust)
import Data.Set (Set)
import qualified Data.Set as Set
import Data.Text (Text)
import qualified Data.Text as Text (dropAround)

#if MIN_VERSION_prettyprinter(1,7,0)
import Prettyprinter
Expand Down Expand Up @@ -548,7 +549,7 @@ pprSDC = vcat . fmap go . sdcClock
go (i, dom) =
-- VDomainConfiguration stores period in ps, SDC expects it in ns.
let p = MkFixed (toInteger $ vPeriod dom) :: Fixed E3
name = braces (pretty i)
name = braces (pretty (Text.dropAround (== '\\') i))
period = viaShow p
waveform = braces ("0.000" <+> viaShow (p / 2))
targets = brackets ("get_ports" <+> name)
Expand Down
10 changes: 5 additions & 5 deletions clash-lib/src/Clash/Netlist/Util.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1129,7 +1129,7 @@ mkTopInput (ExpandedPortName hwty0 i0) = do
return ([(i0, hwty1)], decls, expr, i1)

mkTopInput epp@(ExpandedPortProduct p hwty ps) = do
pN <- Id.make p
pN <- Id.makeBasic p
let netdecl = NetDecl Nothing pN hwty
case hwty of
Vector sz eHwty -> do
Expand Down Expand Up @@ -1272,7 +1272,7 @@ mkTopOutput (ExpandedPortName hwty0 i0) = do
return ([(i0, hwty1)], [Assignment i0 bvExpr, NetDecl Nothing i1 hwty0], i1)

mkTopOutput epp@(ExpandedPortProduct p hwty ps) = do
pN <- Id.make p
pN <- Id.makeBasic p
let netdecl = NetDecl Nothing pN hwty
case hwty of
Vector {} -> do
Expand Down Expand Up @@ -1411,7 +1411,7 @@ mkTopInstInput (ExpandedPortName hwty0 pN) = do
, pN' )

mkTopInstInput epp@(ExpandedPortProduct pNameHint hwty0 ps) = do
pName <- Id.make pNameHint
pName <- Id.makeBasic pNameHint

let
pDecl = NetDecl Nothing pName hwty0
Expand Down Expand Up @@ -1508,7 +1508,7 @@ mkTopInstOutput (ExpandedPortName hwty0 portName) = do
, assignName1 )

mkTopInstOutput epp@(ExpandedPortProduct productNameHint hwty ps) = do
pName <- Id.make productNameHint
pName <- Id.makeBasic productNameHint
let pDecl = NetDecl Nothing pName hwty
(attrs, hwty') = stripAttributes hwty
case hwty' of
Expand Down Expand Up @@ -1755,7 +1755,7 @@ expandTopEntityOrErr is ihwtys ohwty topM = do
is not a product!
|])
Right eTop ->
evalState (traverse (either Id.addRaw Id.make) eTop) (Id.clearSet is)
evalState (traverse (either Id.addRaw Id.makeBasic) eTop) (Id.clearSet is)

-- | Take a top entity and /expand/ its port names. I.e., make sure that every
-- port that should be generated in the HDL is part of the data structure. It
Expand Down