Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package aop
    Definition Classes
    chisel3
  • package choice

    This package contains Chisel language definitions for describing configuration options and their accepted values.

    This package contains Chisel language definitions for describing configuration options and their accepted values.

    Definition Classes
    chisel3
  • Case
  • DynamicCase
  • DynamicGroup
  • Group
  • ModuleChoice
  • package connectable
    Definition Classes
    chisel3
  • package domain
    Definition Classes
    chisel3
  • package domains
    Definition Classes
    chisel3
  • package experimental

    Package for experimental features, which may have their API changed, be removed, etc.

    Package for experimental features, which may have their API changed, be removed, etc.

    Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

    Definition Classes
    chisel3
  • package interface
    Definition Classes
    chisel3
  • package layers

    This package contains common layer.Layers used by Chisel generators.

    This package contains common layer.Layers used by Chisel generators.

    Definition Classes
    chisel3
  • package ltl
    Definition Classes
    chisel3
  • package naming
    Definition Classes
    chisel3
  • package probe
    Definition Classes
    chisel3
  • package properties

    The properties package includes functionality related to non-hardware data.

    The properties package includes functionality related to non-hardware data.

    This entire package is currently very experimental, so expect some rough edges and rapid API evolution.

    Definition Classes
    chisel3
  • package reflect
    Definition Classes
    chisel3
  • package simulator
    Definition Classes
    chisel3
  • package stage
    Definition Classes
    chisel3
  • package test
    Definition Classes
    chisel3
  • package testing
    Definition Classes
    chisel3
  • package util

    The util package provides extensions to core chisel for common hardware components and utility functions

    The util package provides extensions to core chisel for common hardware components and utility functions

    Definition Classes
    chisel3
p

chisel3

choice

package choice

This package contains Chisel language definitions for describing configuration options and their accepted values.

Source
package.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. choice
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract class Case extends AnyRef

    An option case declaration.

  2. abstract class DynamicCase extends Case

    An option case declaration for DynamicGroup.

    An option case declaration for DynamicGroup.

    DynamicCase objects must be defined inside a DynamicGroup class. They use implicit parameters to automatically associate with their parent DynamicGroup.

  3. abstract class DynamicGroup extends AnyRef

    Dynamic option group with runtime-customizable name.

    Dynamic option group with runtime-customizable name.

    Unlike static Group objects, DynamicGroup allows the group name to be specified at instantiation time. This is useful for parameterized designs where the same group structure is reused with different names.

    Example:

    1. class Opt(name: String)(implicit sourceInfo: SourceInfo) extends DynamicGroup(name) {
  object Fast extends DynamicCase
  object Slow extends DynamicCase
}

// Use with ModuleChoice
class MyModule extends Module {
  val opt = new Opt("OptMyModule")
  val impl = ModuleChoice(new DefaultImpl)(
    Seq(
      opt.Fast -> new FastImpl,
      opt.Slow -> new SlowImpl
    )
  )
}
  4. abstract class Group extends AnyRef

    An option group declaration.

    An option group declaration. Specifies a container grouping values for some design configuration parameter.

    Example:

    1. import chisel3.option.{Group, Case}
object Platform extends Group {
  object FPGA extends Case
  object ASIC extends Case
}

Value Members

  1. object ModuleChoice extends ModuleChoiceObjIntf

Inherited from AnyRef

Inherited from Any

Ungrouped