Skip to content

Add doc about SVIF (system verilog interface)#247

Closed
yportne13 wants to merge 11 commits into
SpinalHDL:masterfrom
yportne13:svif
Closed

Add doc about SVIF (system verilog interface)#247
yportne13 wants to merge 11 commits into
SpinalHDL:masterfrom
yportne13:svif

Conversation

@yportne13

Copy link
Copy Markdown
Contributor

@yportne13 yportne13 changed the title [WIP] Add doc about SVIF [WIP] Add doc about SVIF (system verilog interface) Mar 21, 2024
@andreasWallner

Copy link
Copy Markdown
Collaborator

FYI: while WIP please open as a draft - then it doesn't show up in the inboxes of the maintainers to review.

@yportne13 yportne13 changed the title [WIP] Add doc about SVIF (system verilog interface) Add doc about SVIF (system verilog interface) Apr 2, 2024
@Dolu1990

Copy link
Copy Markdown
Member

Hi,

One thing which is important i think, is to specify in the doc that this feature may be subject to changes (experimental)
That will let us more wiggle room for future updates :)

@mrcmry mrcmry left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi !

I have seen that the PR to the spinal lib has been merged in dev and is in v1.14.1.

I did some typo suggestions, you can use the github web interface to add them to a batch and merge them in a commit in the web interface (see this doc).

And then if it's ok for you we can merge this PR.

Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Comment thread source/SpinalHDL/Data types/SVIF.rst Outdated
Not Interface
~~~~~~~~~~~~~

If you have used a certain interface in multiple places, and at one of those locations ``sigA``, you wish to flatten it instead of generating an interface, you can achieve this by calling ``sigA.notSVIF()`` to fully flatten the signal. If the signal has nested interfaces and you only want to expand the outermost layer, you can use ``sigA.notSVIFthisLevel()``.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you have used a certain interface in multiple places, and at one of those locations ``sigA``, you wish to flatten it instead of generating an interface, you can achieve this by calling ``sigA.notSVIF()`` to fully flatten the signal. If the signal has nested interfaces and you only want to expand the outermost layer, you can use ``sigA.notSVIFthisLevel()``.
If you have used a certain interface in multiple places, and at one of those locations ``mySignal``, you wish to flatten it instead of generating an interface, you can achieve this by calling ``mySignal.notSVIF()`` to fully flatten the signal. If the signal has nested interfaces and you only want to expand the outermost layer, you can use ``mySignal.notSVIFthisLevel()``.

@mrcmry

mrcmry commented Apr 23, 2026

Copy link
Copy Markdown
Collaborator

@yportne13 did you have some time to look at my review ? If you are ok with my suggestion I can include them and merge directly with the github inteface ?

Is it ok for you ?

yportne13 and others added 8 commits April 27, 2026 21:36
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
Co-authored-by: mrcmry <marc.emery@amnis.ch>
@mrcmry mrcmry self-requested a review April 27, 2026 18:56
@mrcmry

mrcmry commented Apr 27, 2026

Copy link
Copy Markdown
Collaborator

I squashed the review commit together in #247, so it it merged and we can close this.

Thanks @yportne13 for the doc !

@mrcmry mrcmry closed this Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants