diff options
| author | Megan Wachs | 2021-03-18 16:47:58 -0700 |
|---|---|---|
| committer | GitHub | 2021-03-18 16:47:58 -0700 |
| commit | f1ad5b58e8a749d558758288d03ce75bf6b8ff9c (patch) | |
| tree | 2150d6f41a55f81c9f4cf3b037b715cb75ea617f /docs/src/wiki-deprecated/troubleshooting.md | |
| parent | 2a56c6540e914611ac12647e157aec4c5c595758 (diff) | |
Reorganize website docs (#1806)
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
Diffstat (limited to 'docs/src/wiki-deprecated/troubleshooting.md')
| -rw-r--r-- | docs/src/wiki-deprecated/troubleshooting.md | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/src/wiki-deprecated/troubleshooting.md b/docs/src/wiki-deprecated/troubleshooting.md deleted file mode 100644 index 333adec4..00000000 --- a/docs/src/wiki-deprecated/troubleshooting.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: docs -title: "Troubleshooting" -section: "chisel3" ---- -This page is a starting point for recording common and not so common problems in developing with Chisel3. In particular, those situations where there is a work around that will keep you going. - -### `type mismatch` specifying width/value of a `UInt`/`SInt` - -*I have some old code that used to work correctly in chisel2 (and still does if I use the `import Chisel._` compatibility layer) -but causes a `type mismatch` error in straight chisel3:* - -```scala -class TestBlock extends Module { - val io = IO(new Bundle { - val output = Output(UInt(width=3)) - }) -} -``` -*produces* -```bash -type mismatch; -[error] found : Int(3) -[error] required: chisel3.internal.firrtl.Width -[error] val output = Output(UInt(width=3)) -``` - -The single argument, multi-function object/constructors from chisel2 have been removed from chisel3. -It was felt these were too prone to error and made it difficult to diagnose error conditions in chisel3 code. - -In chisel3, the single argument to the `UInt`/`SInt` object/constructor specifies the *width* and must be a `Width` type. -Although there are no automatic conversions from `Int` to `Width`, an `Int` may be converted to a `Width` by applying the `W` method to an `Int`. -In chisel3, the above code becomes: -```scala -class TestBlock extends Module { - val io = IO(new Bundle { - val output = Output(UInt(3.W)) - }) -} -``` -`UInt`/`SInt` literals may be created from an `Int` with the application of either the `U` or `S` method. - -```scala -UInt(42) -``` -in chisel2, becomes -```scala -42.U -``` -in chisel3 - -A literal with a specific width is created by calling the `U` or `S` method with a `W` argument. -Use: -```scala -1.S(8.W) -``` -to create an 8-bit wide (signed) literal with value 1. |
