Packages

package lib

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. lib
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class AnyPimped[T] extends AnyRef
  2. implicit class BigIntRicher extends LiteralRicher
  3. implicit class BinIntsRicher extends AnyRef
  4. implicit class BinaryBuilder extends AnyRef
  5. implicit class BinaryBuilder2 extends AnyRef
  6. class BitAggregator extends AnyRef
  7. class BoolPimped extends AnyRef
  8. class BufferCC[T <: Data] extends Component
  9. implicit class ByteRicher extends LiteralRicher
  10. implicit class BytesRicher extends AnyRef
  11. class ClockDomainPimped extends AnyRef
  12. class Counter extends ImplicitArea[UInt]
  13. class CounterUpDown extends ImplicitArea[UInt]
  14. trait DataCarrier[T <: Data] extends AnyRef
  15. class DataCarrierFragmentBitsPimped extends AnyRef
  16. class DataCarrierFragmentPimped[T <: Data] extends AnyRef
  17. case class DataOr[T <: Data](dataType: HardType[T]) extends Area with Product with Serializable
  18. type Event = Stream[NoData]
  19. case class EventEmitter(on: Event) extends Product with Serializable
  20. class EventFactory extends MSFactory
  21. class Flow[T <: Data] extends Bundle with IMasterSlave with DataCarrier[T]
  22. class FlowArbiterBuilder[T <: Data] extends AnyRef
  23. class FlowBitsPimped extends AnyRef
  24. class FlowCCUnsafeByToggle[T <: Data] extends Component

    CDC for a Flow, NOT SAFE for general use

    CDC for a Flow, NOT SAFE for general use

    See also

    UnsafeFlowCCByToggle.apply

  25. class FlowCmdRsp[T <: Data, T2 <: Data] extends Bundle with IMasterSlave
  26. class FlowFactory extends MSFactory
  27. class FlowFragmentBitsRouter extends AnyRef
  28. class FlowFragmentFactory extends MSFactory
  29. class FlowFragmentPimped[T <: Data] extends AnyRef
  30. class Fragment[T <: Data] extends Bundle
  31. class FragmentFactory extends AnyRef
  32. class GrowableAnyPimped[T] extends AnyRef
  33. class HistoryModifyable[T <: Data] extends Component
  34. trait IMasterSlave extends AnyRef

    Master/slave interface

  35. implicit class IntRicher extends LiteralRicher
  36. trait LiteralRicher extends AnyRef
  37. implicit class LongRicher extends LiteralRicher
  38. sealed trait MS extends AnyRef

    Declare a port as master or slave

    Declare a port as master or slave

    There are 4 available syntaxes, which are all equivalent:

    val braces = master(Flow(Bool))

val short = master Flow (Bool)

val spaceful = master port Flow(Bool)

val variadic = Flow(Bool)
master(variadic)

    The "braces" syntax is short and generic, but it uses braces.

    The "short" syntax is short, but it is formatted with a space between the type and its parameters, and it can be used only with:

    • Flow
    • Stream

    The "spaceful" syntax is generic and beatiful, but more verbose.

    The "variadic" syntax can be used with any number of interfaces, but can be used only if the interfaces are already declared.

    See also

    master slave

  39. trait MSFactory extends AnyRef

    Something which can create master/slave interfaces

  40. class MemPimped[T <: Data] extends AnyRef
  41. case class MemReadPort[T <: Data](dataType: T, addressWidth: Int) extends Bundle with IMasterSlave with Product with Serializable
  42. case class MemReadPortAsync[T <: Data](dataType: T, addressWidth: Int) extends Bundle with IMasterSlave with Product with Serializable
  43. case class MemReadStreamFlowPort[T <: Data](dataType: T, addressWidth: Int) extends Bundle with IMasterSlave with Product with Serializable
  44. case class MemReadWritePort[T <: Data](dataType: T, addressWidth: Int, maskWidth: Int = -1) extends Bundle with IMasterSlave with Product with Serializable
  45. case class MemWriteCmd[T <: Data](dataType: HardType[T], addressWidth: Int, maskWidth: Int = -1) extends Bundle with Product with Serializable
  46. case class MemWriteCmdWithMask[T <: Data](mem: Mem[T], maskWidth: Int) extends Bundle with Product with Serializable
  47. class MuxOHImpl extends AnyRef
  48. class NoData extends Bundle
  49. class PackedBundle extends Bundle

    Similar to Bundle but with bit packing capabilities.

    Similar to Bundle but with bit packing capabilities. Use pack implicit functions to assign fields to bit locations - pack(Range, [Endianness]) - Packs the data into Range aligning to bit Endianness if too wide - packFrom(Position) - Packs the data starting (LSB) at Position. Uses full data length - packTo(Position) - Packs the data ending (MSB) at Position. Uses full data length

    Providing no location tag will place the next data value immediately after the last.

    Example: 

    1. val regWord = new PackedBundle {
  val init = Bool().packFrom(0) // Bit 0
  val stop = Bool() // Bit 1
  val result = Bits(16 bit).packTo(31) // Bits 16 to 31
}
  50. class PackedWordBundle extends PackedBundle

    An enhanced form of PackedBundle with Word-centric packing.

    An enhanced form of PackedBundle with Word-centric packing. Offers all the same implicit packing assignment functions, but applies packing to an assigned word. - inWord(WordIndex) - Indicates which word to pack into. Must be used after a pack assigment. If no pack range was given then the entire data length will be assumed. Ranges that exceed the word will wrap into subsequent words.

    Like PackedBundle, providing no pack or word assignments will place data immediately after the last.

    Example: 

    1. val wordPacked = PackedWordBundle(8 bits) {
  val aNumber = UInt(8 bits).word(0) // Bits 7 downto 0
  val bNumber = UInt(8 bits).pack(0 to 7).word(1) // Bits 8 to 15
  val large   = Bits(18 bits).word(2) // Bits 33 downto 16
  val flag    = Bool() // Bit 34
  51. class PulseCCByToggle extends Component
  52. case class ReadRetLinked[T <: Data, T2 <: Data](readType: HardType[T], linkedType: HardType[T2]) extends Bundle with Product with Serializable
  53. class ResetAggregator extends Area
  54. case class ResetAggregatorSource(pin: Bool, sync: Boolean, pol: Polarity) extends Product with Serializable
  55. class ResetCtrlFiber extends Area
  56. class ResetHolder extends Area
  57. type ScalaStream[T] = scala.collection.immutable.Stream[T]
  58. sealed trait SlicesOrder extends AnyRef

    Enumeration to present order of slices.

  59. class Stream[T <: Data] extends Bundle with IMasterSlave with DataCarrier[T]
  60. class StreamAccessibleFifo[T <: Data] extends Component
  61. class StreamArbiter[T <: Data] extends Component

    A StreamArbiter is like a StreamMux, but with built-in complex selection logic that can arbitrate input streams based on a schedule or handle fragmented streams.

    A StreamArbiter is like a StreamMux, but with built-in complex selection logic that can arbitrate input streams based on a schedule or handle fragmented streams. Use a StreamArbiterFactory to create instances of this class.

  62. class StreamArbiterFactory extends AnyRef
  63. class StreamBitsPimped extends AnyRef
  64. class StreamBundlePimped[T <: Bundle] extends AnyRef
  65. class StreamCCByToggle[T <: Data] extends Component
  66. class StreamDemux[T <: Data] extends Component
  67. class StreamFactory extends MSFactory
  68. class StreamFifo[T <: Data] extends Component

    Fully redesigned in release 1.8.2 allowing improved timing closure.

    Fully redesigned in release 1.8.2 allowing improved timing closure. - latency of 0, 1, 2 cycles

  69. class StreamFifoCC[T <: Data] extends Component
  70. trait StreamFifoInterface[T <: Data] extends AnyRef
  71. class StreamFifoLowLatency[T <: Data] extends Component
  72. case class StreamFifoMultiChannelPop[T <: Data](payloadType: HardType[T], channelCount: Int) extends Bundle with IMasterSlave with Product with Serializable
  73. case class StreamFifoMultiChannelPush[T <: Data](payloadType: HardType[T], channelCount: Int) extends Bundle with IMasterSlave with Product with Serializable
  74. case class StreamFifoMultiChannelSharedSpace[T <: Data](payloadType: HardType[T], channelCount: Int, depth: Int, withAllocationFifo: Boolean = false) extends Component with Product with Serializable
  75. class StreamFlowArbiter[T <: Data] extends Area
  76. class StreamFork[T <: Data] extends Component

    A StreamFork will clone each incoming data to all its output streams.

    A StreamFork will clone each incoming data to all its output streams. If synchronous is true, all output streams will always fire together, which means that the stream will halt until all output streams are ready. If synchronous is false, output streams may be ready one at a time, at the cost of an additional flip flop (1 bit per output). The input stream will block until all output streams have processed each item regardlessly.

    Note that this means that when synchronous is true, the valid signal of the outputs depends on their inputs, which may lead to dead locks when used in combination with systems that have it the other way around. It also violates the handshake of the AXI specification (section A3.3.1).

  77. class StreamForkArea[T <: Data] extends Area
  78. class StreamFragmentBitsDispatcher extends Area
  79. case class StreamFragmentBitsDispatcherElement(sink: Stream[Bits], header: Int) extends Product with Serializable
  80. class StreamFragmentBitsPimped extends AnyRef
  81. class StreamFragmentFactory extends MSFactory
  82. class StreamFragmentPimped[T <: Data] extends AnyRef
  83. class StreamMux[T <: Data] extends Component
  84. class StreamPacker[T <: Data] extends Area

    Packs layout's Data into the given stream

    Packs layout's Data into the given stream

    stream is directly driven by this area.

    layout Data is read directly

    io.start indicates when to start packing. All layout's Data is registered before packing.

    io.done indicates when the last word has been packed.

    Use the companion object StreamPapcker to create an instance.

  85. trait StreamPipe extends AnyRef
  86. class StreamShiftChain[T <: Data] extends Component
  87. class StreamToStreamFragmentBits[T <: Data] extends Component
  88. class StreamTransactionCounter extends Component
  89. class StreamTransactionExtender[T <: Data, T2 <: Data] extends Component
  90. class StreamUnpacker[T <: Data] extends Area

    Unpacks stream's words into the given layout's Data.

    Unpacks stream's words into the given layout's Data. stream is directly driven by this area. layout Data are driven through a register.

    io.start starts unpacking io.dones is set of bits indicating when the associated Data in layout is unpacked. io.allDone indicates when the last word has been unpacked.

    Use the companion object StreamUnpacker to create an instance.

  91. class StringPimped extends AnyRef
  92. class Timeout extends ImplicitArea[Bool]
  93. class TraversableOnceAddressTransformerPimped extends AnyRef
  94. class TraversableOnceAnyPimped[T] extends AnyRef
  95. class TraversableOnceAnyTuplePimped[T, T2] extends AnyRef
  96. class TraversableOnceBoolPimped extends AnyRef
  97. class TraversableOncePimped[T <: Data] extends AnyRef
  98. implicit class UIntPimper extends AnyRef
  99. case class WhenBuilder() extends Product with Serializable
  100. class FlowCCByToggle[T <: Data] extends FlowCCUnsafeByToggle[T]
    Annotations
    @deprecated
    Deprecated

    Renamed to 'UnsafeFlowCCByToggle' because it's not safe in many cases, see its comments

  101. class StreamDispatcherSequencial[T <: Data] extends Component

    Deprecated

    Do not use. Use the companion object or a normal regular StreamMux instead.

Value Members

  1. implicit def AnyPimpedDef[T](that: T): AnyPimped[T]
  2. def Event: Stream[NoData]
  3. def NoData(): NoData
  4. val OHMux: MuxOHImpl
  5. def ScalaStream: scala.collection.immutable.Stream.type
  6. def StreamArbiterFactory(): StreamArbiterFactory
  7. implicit def boolPimped(that: Bool): BoolPimped
  8. implicit def clockDomainPimped(cd: ClockDomain): ClockDomainPimped
  9. implicit def dataCarrierFragmentBitsPimped(that: DataCarrier[Fragment[Bits]]): DataCarrierFragmentBitsPimped
  10. implicit def dataCarrierFragmentPimped[T <: Data](that: DataCarrier[Fragment[T]]): DataCarrierFragmentPimped[T]
  11. implicit def easyFragment[T <: Data](that: Fragment[T]): T
  12. implicit def flowBitsPimped(that: Flow[Bits]): FlowBitsPimped
  13. implicit def flowFragmentPimped[T <: Data](that: Flow[Fragment[T]]): FlowFragmentPimped[T]
  14. implicit def fragmentFixer[T <: Data](_data: Fragment[T]): DataPimper[Fragment[T]]
  15. implicit def growableAnyPimped[T](that: Growable[T]): GrowableAnyPimped[T]
  16. implicit def memPimped[T <: Data](mem: Mem[T]): MemPimped[T]
  17. def sexport[T <: SpinalTag](h: T): T
  18. def sexport[T](name: String, value: Any): ArrayBuffer[() ⇒ Unit]
  19. def sexport[T](h: Handle[T]): Handle[T]
  20. def sexport[T](named: Handle[T], value: ⇒ Any): ArrayBuffer[() ⇒ Unit]
  21. implicit def streamBitsPimped(that: Stream[Bits]): StreamBitsPimped
  22. implicit def streamBundlePimped[T <: Bundle](that: Stream[T]): StreamBundlePimped[T]
  23. implicit def streamFragmentBitsPimped(that: Stream[Fragment[Bits]]): StreamFragmentBitsPimped
  24. implicit def streamFragmentPimped[T <: Data](that: Stream[Fragment[T]]): StreamFragmentPimped[T]
  25. implicit def stringPimped(that: String): StringPimped
  26. implicit def traversableOnceAddressTransformerPimped(that: TraversableOnce[AddressTransformer]): TraversableOnceAddressTransformerPimped
  27. implicit def traversableOnceAnyPimped[T](that: TraversableOnce[T]): TraversableOnceAnyPimped[T]
  28. implicit def traversableOnceAnyTuplePimped[T, T2](that: TraversableOnce[(T, T2)]): TraversableOnceAnyTuplePimped[T, T2]
  29. implicit def traversableOnceBoolPimped(that: TraversableOnce[Bool]): TraversableOnceBoolPimped
  30. implicit def traversableOncePimped[T <: Data](that: TraversableOnce[T]): TraversableOncePimped[T]
  31. object AddWithCarry
  32. object AnalysisUtils
  33. object BufferCC
  34. object Callable
  35. object CheckSocketPort
  36. object ClearCount
  37. object CountLeadingZeroes

    Counts the number of consecutive zero bits starting from the MSB.

  38. object CountOne
  39. object CountOneOnEach
  40. object CountTrailingZeroes

    Counts the number of consecutive zero bits starting from the LSB.

  41. object Counter

    Creates a counter

    Creates a counter

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Libraries/utils.html?highlight=counter#counter

  42. object CounterFreeRun

    Creates an always running counter

    Creates an always running counter

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Libraries/utils.html?highlight=counter#counter

  43. object CounterMultiRequest
  44. object CounterUpDown
  45. object DataCarrier
  46. object DataCc

    Will use the BaseType.clockDomain to figure out how to connect 2 signals together (allowed use StreamCCByToggle)

  47. object Delay
  48. object DelayEvent
  49. object DelayWithInit
  50. object DoCmd

    Run command

  51. object EndiannessSwap

    **************************************************************************** Big-Endian <-> Little-Endian

  52. object Flow extends FlowFactory
  53. object FlowArbiter
  54. object FlowCCUnsafeByToggle
  55. object FlowCmdRsp
  56. object FlowFragmentBitsRouter
  57. object Fragment extends FragmentFactory
  58. object FragmentToBitsStates extends SpinalEnum
  59. object GrayCounter
  60. object HIGHER_FIRST extends SlicesOrder

    Slice with higher bits process first

  61. object History
  62. object HistoryModifyable
  63. object KeepAttribute
  64. object LOWER_FIRST extends SlicesOrder

    Slice with lower bits process first

  65. object LatencyAnalysis
  66. object LeastSignificantBitSet
  67. object MajorityVote
  68. object Max
  69. object MemWriteCmd extends Serializable
  70. object Min
  71. object MuxOH extends MuxOHImpl
  72. object Napot
  73. object OH
  74. object OHMasking
  75. object OHToUInt
  76. object OhMux extends MuxOHImpl
  77. object PriorityMux
  78. object PropagateOnes
  79. object PulseCCByToggle
  80. object RegFlow
  81. object Repeat
  82. object ResetCtrl
  83. object Reverse
  84. object SetCount
  85. object SetFromFirstOne
  86. object Shift
  87. object Stream extends StreamFactory
  88. object StreamAccessibleFifo
  89. object StreamArbiter
  90. object StreamCCByToggle
  91. object StreamCombinerSequential

    This is equivalent to a StreamMux, but with a counter attached to the port selector.

  92. object StreamDemux

    Demultiplex one stream into multiple output streams, always selecting only one at a time.

  93. object StreamDemuxOh
  94. object StreamDispatcherSequential

    This is equivalent to a StreamDemux, but with a counter attached to the port selector.

  95. object StreamFifo
  96. object StreamFifoCC
  97. object StreamFifoLowLatency
  98. object StreamFifoMultiChannelBench extends App
  99. object StreamFlowArbiter

    Combine a stream and a flow to a new stream.

    Combine a stream and a flow to a new stream. If both input sources fire, the flow will be preferred.

  100. object StreamFork
  101. object StreamFork2
  102. object StreamFork3
  103. object StreamFragmentArbiter
  104. object StreamFragmentArbiterAndHeaderAdder
  105. object StreamFragmentGenerator
  106. object StreamFragmentWidthAdapter
  107. object StreamJoin

    Join multiple streams into one.

    Join multiple streams into one. The resulting stream will only fire if all of them fire, so you may want to buffer the inputs.

  108. object StreamMux

    Multiplex multiple streams into a single one, always only processing one at a time.

  109. object StreamPacker
  110. object StreamPipe
  111. object StreamShiftChain
  112. object StreamTransactionCounter
  113. object StreamTransactionExtender
  114. object StreamUnpacker
  115. object StreamWidthAdapter
  116. object Timeout
  117. object UIntToOh
  118. object UIntToOhMinusOne
  119. object ValidFlow

    Create a new Flow that is always valid, with a given payload

  120. object WrapWithReg
  121. object fromGray
  122. object master extends MS

    Declare a master port

    Declare a master port

    See MS for syntax help.

  123. object slave extends MS

    Declare a slave port

    Declare a slave port

    See MS for syntax help.

  124. object toGray
  125. object whenIndexed
  126. object whenMasked

Deprecated Value Members

  1. object FlowCCByToggle
    Annotations
    @deprecated
    Deprecated

    Renamed to 'UnsafeFlowCCByToggle' because it's not safe in many cases, see its comments

  2. object StreamDispatcherSequencial

    Deprecated

    Do not use

  3. object masterWithNull extends MS
    Annotations
    @deprecated
    Deprecated

    Use apply or port instead: 'val b = master(maybeNull)' or 'val rgb = master port maybeNull'

  4. object slaveWithNull extends MS
    Annotations
    @deprecated
    Deprecated

    Use apply or port instead: 'val b = slave(maybeNull)' or 'val rgb = slave port maybeNull'

Inherited from AnyRef

Inherited from Any

Ungrouped