Skip to content

Commit

Permalink
fix: fix wrong package name in HierarchyPackage (#4512)
Browse files Browse the repository at this point in the history
Signed-off-by: unlsycn <unlsycn@unlsycn.com>
  • Loading branch information
unlsycn authored Nov 18, 2024
1 parent 4a6ff1d commit 058f162
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 46 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package chisel3.experimental
package chisel3.experimental.hierarchy

/** Classes or traits which will be used with the [[Definition]] + [[Instance]] api should be marked
* with the [[instantiable]] annotation at the class/trait definition.
Expand Down
45 changes: 0 additions & 45 deletions core/src/main/scala/chisel3/experimental/hierarchy/package.scala
Original file line number Diff line number Diff line change
@@ -1,51 +1,6 @@
package chisel3.experimental

package object hierarchy {

/** Classes or traits which will be used with the [[Definition]] + [[Instance]] api should be marked
* with the [[instantiable]] annotation at the class/trait definition.
*
* @example {{{
* @instantiable
* class MyModule extends Module {
* ...
* }
*
* val d = Definition(new MyModule)
* val i0 = Instance(d)
* val i1 = Instance(d)
* }}}
*/
class instantiable extends chisel3.internal.instantiable

/** Classes marked with [[instantiable]] can have their vals marked with the [[public]] annotation to
* enable accessing these values from a [[Definition]] or [[Instance]] of the class.
*
* Only vals of the the following types can be marked [[public]]:
* 1. IsInstantiable
* 2. IsLookupable
* 3. Data
* 4. BaseModule
* 5. Iterable/Option containing a type that meets these requirements
* 6. Basic type like String, Int, BigInt etc.
*
* @example {{{
* @instantiable
* class MyModule extends Module {
* @public val in = IO(Input(UInt(3.W)))
* @public val out = IO(Output(UInt(3.W)))
* ..
* }
*
* val d = Definition(new MyModule)
* val i0 = Instance(d)
* val i1 = Instance(d)
*
* i1.in := i0.out
* }}}
*/
class public extends chisel3.internal.public

type Instance[P] = core.Instance[P]
val Instance = core.Instance
type Definition[P] = core.Definition[P]
Expand Down

0 comments on commit 058f162

Please sign in to comment.