| Age | Commit message (Collapse) | Author |
|---|
|
DataView is a mechanism for "viewing" Scala objects as a subtype of
`Data`. Often, this is useful for viewing one subtype of `Data`, as
another. One can think about a DataView as a cross between a
customizable cast and an untagged union.
A DataView has a Target type `T`, and a View type `V`. DataView requires
that an implementation of `DataProduct` is available for Target types.
DataProduct is a type class that provides a way to iterate on `Data`
children of objects of implementing types.
If a DataView is provided for a type T to a type V, then the function
.viewAs[V] (of type T => V) is available. The object (of type T) returned
by .viewAs is called a "View" and can be used as both an rvalue and an
lvalue. Unlike when using an .asTypeOf cast, connecting to a "View" will
connect to the associated field or fields of the underlying Target.
DataView also enables .viewAsSupertype which is available for viewing
Bundles as a parent Bundle type. It is similar to .viewAs but requires
a prototype object of the Target type which will be cloned in order to
create the returned View. .viewAsSupertype maps between the
corresponding fields of the parent and child Bundle types.
|
|
* Small changes to memory doc
- Fixed typo "except" => "accept"
- Use `Counter` explicitly in ROM section example.
* Fix counter doc compile error
* remove invisible doc block in memory example
* more small fixes to make mem example pass doc compile
* Get rid of sine wave iterator in memory doc
* get rid of tabs on VecInit example
* get rid of tabs on VecInit example
|
|
* Add @ekiwi's code as a starting point
* Add test for ChiselEnum isOneOf method
* Make isOneOfTester naming consistent with other testers
* Add scaladoc comments for isOneOf
* Add isOneOf tests that use the method that takes variable number of args
* Add guide level documentation example for isOneOf
|
|
Also add newline to end of `verilog` modifier code blocks so that there
is always a newline between code blocks and following material.
|
|
|
|
nitpick
|
|
* Remove space between backticks and language
* Make code examples in memories explanation work
Co-authored-by: Jack Koenig <koenig@sifive.com>
|
|
* Add documentation guide about memory initialization
* Move information to experimental and add ref
|
|
* Update the FAQ and add doc on versioning
* Update modules.md
Co-authored-by: Megan Wachs <megan@sifive.com>
|
|
Updates to chisel3 documentation for website:
* guard code examples with mdoc and fix errors encountered along the way
* move some website content here vs splitting the content across two repos
* Bring in the interval-types and loading memories content so that it will be visible from the website
* remove all references to the wiki (deprecated)
* Remove reference to Wiki from the README
* fix tabbing and compile of chisel3-vs-chisel2 section
* Appendix: faqs now guarded and compile
* FAQs: move to resources section
|
|
|
|
* Adding ChiselEnum Documentation Entry
Added documentation for the ChiselEnum type with verified examples
* Fixed some doc ambiguity and repeated emitVerilog calls
* Added ChiselStage and commented out package definition since packages cannot be declared in single files
* Fixed issue with ChiselStage not being able to generate a module with parameters and bad package imports
* Opps on not adding _ after import
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Modified Bundle for ci and made changes to select naming scheme
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Added missing backticks
* Added space around error block quote
* Fixed md paragraph in code
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
* Update docs/src/explanations/chisel-enum.md
Co-authored-by: Megan Wachs <megan@sifive.com>
* Fixed some comments and formatting
Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
|
|
* Fix some botched formatting (replace ```mdoc scala with ```scala mdoc)
* Replace some unnecessary uses of triple backticks with single
backticks
* Move appendix docs from wiki-deprecated/ to appendix/
* This will require an update on the website as well
* Update Bundle literal docs
|
|
|
|
|
|
* Refine autonaming to have more intuitive behavior
Last name in an Expression wins, while the first Statement to name wins.
This is done via checking the _id of HasIds during autonaming and only
applying a name if the HasId was created in the scope of autonaming.
There is no change to .autoSeed or .suggestName behavior.
Behavior of chisel3-plugins from before this change is maintained.
* Update docs with naming plugin changes
|
|
* Fix crosslinks in mdoc. Can't use md suffix
* Removed all .md crossrefs
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
|
|
* Fix broken mdoc
* Added test-chisel-docs to ci workflow
* Add requirement on build-treadle job
* Added forgotton colon
* Forgot cd into chisel3 dir
* moved three docs into explanations
* Updated reference
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
|
|
* Fix broken mdoc
* Added test-chisel-docs to ci workflow
|
|
* Added documentation. Bugfix in plugin. Moved plugin APIs to separate package
* Revert reg naming behavior (omit underscore)
* Added documentation and a test
* Addressed reviewer feedback.
|
|
|
