IODirection

Declare ports

A port is some Data with a direction, which can be in, out or inout.

There are 4 available syntaxes, which are all equivalent:

val braces = in(Vec(Bool, 5))

val short = in Vec (Bool, 5)

val spaceful = in port Vec(Bool, 5)

val variadic = Vec(Bool, 5)
in(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:

Bool
Bits
UInt
SInt
Vec

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

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

See also: in out inout

Linear Supertypes

BaseTypeFactory, UFixFactory, SFixFactory, TypeFactory, VecFactory, SIntFactory, UIntFactory, BitsFactory, BoolFactory, AnyRef, Any

Known Subclasses

in, inWithNull, inout, out, outWithNull

Type Members

class VecBuilder extends AnyRef

Definition Classes
VecFactory

Abstract Value Members

abstract def applyIt[T <: Data](data: T): T

Annotations
@deprecated
Deprecated
Use apply or port instead: val b = in Bool () or val rgb = out port Rgb

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def Bits(u: Unit = ()): Bits

Create a new Bits
Create a new Bits

Definition Classes
IODirection → BitsFactory
def Bits(width: BitCount): Bits

Create a new Bits of a given width
Create a new Bits of a given width

Definition Classes
BitsFactory
def Bool(u: Unit = ()): Bool

Declare a port without braces, short syntax
Declare a port without braces, short syntax
See IODirection for other syntaxes.

Definition Classes
IODirection → BoolFactory
def Bool(value: Boolean)(implicit loc: Location): Bool

Create a new Bool with a value
Create a new Bool with a value

Definition Classes
BoolFactory
def SFix(peak: ExpNumber, resolution: ExpNumber): SFix

Definition Classes
SFixFactory
def SFix(peak: ExpNumber, width: BitCount): SFix

Definition Classes
SFixFactory
def SInt(u: Unit = ()): SInt

Create a new SInt
Create a new SInt

Definition Classes
IODirection → SIntFactory
def SInt(width: BitCount): SInt

Create a new SInt of a given width
Create a new SInt of a given width

Definition Classes
SIntFactory
def UFix(peak: ExpNumber, resolution: ExpNumber): UFix

Definition Classes
UFixFactory
def UFix(peak: ExpNumber, width: BitCount): UFix

Definition Classes
UFixFactory
def UInt(u: Unit = ()): UInt

Create a new UInt
Create a new UInt

Definition Classes
IODirection → UIntFactory
def UInt(width: BitCount): UInt

Create a new UInt of a given width
Create a new UInt of a given width

Definition Classes
UIntFactory
def Vec[T <: Data](elements: TraversableOnce[T], dataType: HardType[T] = null): Vec[T]

Definition Classes
IODirection → VecFactory
def Vec[T <: Data](firstElement: T, followingElements: T*): Vec[T]

Definition Classes
VecFactory
def Vec[T <: Data](gen: HardType[T], size: Int): Vec[T]

Definition Classes
VecFactory
def Vec[T <: Data](gen: ⇒ T, size: Int): Vec[T]

Definition Classes
VecFactory
val Vec: VecBuilder

Definition Classes
VecFactory
def apply[T <: Data](datas: T*): Unit

Declare existing Data as ports, "variadic" syntax
def apply(senum: SpinalEnum): SpinalEnumCraft[senum.type]

Declare a SpinalEnum port with braces
Declare a SpinalEnum port with braces
See IODirection for other syntaxes.
def apply[T <: Data](data: HardType[T]): T

Declare a port with braces
Declare a port with braces
See IODirection for other syntaxes.
def apply[T <: Data](data: T): T

Declare a port with braces
Declare a port with braces
See IODirection for other syntaxes.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def cloneOf[T <: Data](that: T): T

Declare port with same type as that
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def port(senum: SpinalEnum): SpinalEnumCraft[senum.type]

Declare a SpinalEnum port without braces, spaceful syntax
Declare a SpinalEnum port without braces, spaceful syntax
See IODirection for other syntax.
def port[T <: Data](data: HardType[T]): T

Declare a port without braces, spaceful syntax
Declare a port without braces, spaceful syntax
See IODirection for other syntax.
def port[T <: Data](data: T): T

Declare a port without braces, spaceful syntax
Declare a port without braces, spaceful syntax
See IODirection for other syntax.
def postTypeFactory[T <: Data](that: T): T

Definition Classes
IODirection → TypeFactory
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def Bool: Bool

Definition Classes
BoolFactory
Annotations
@deprecated
Deprecated
Use Bool() (with braces) instead
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package core

sealed trait IODirection extends BaseTypeFactory

Type Members

class VecBuilder extends AnyRef

Abstract Value Members

abstract def applyIt[T <: Data](data: T): T

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def Bits(u: Unit = ()): Bits

def Bits(width: BitCount): Bits

def Bool(u: Unit = ()): Bool

def Bool(value: Boolean)(implicit loc: Location): Bool

def SFix(peak: ExpNumber, resolution: ExpNumber): SFix

def SFix(peak: ExpNumber, width: BitCount): SFix

def SInt(u: Unit = ()): SInt

def SInt(width: BitCount): SInt

def UFix(peak: ExpNumber, resolution: ExpNumber): UFix

def UFix(peak: ExpNumber, width: BitCount): UFix

def UInt(u: Unit = ()): UInt

def UInt(width: BitCount): UInt

def Vec[T <: Data](elements: TraversableOnce[T], dataType: HardType[T] = null): Vec[T]

def Vec[T <: Data](firstElement: T, followingElements: T*): Vec[T]

def Vec[T <: Data](gen: HardType[T], size: Int): Vec[T]

def Vec[T <: Data](gen: ⇒ T, size: Int): Vec[T]

val Vec: VecBuilder

def apply[T <: Data](datas: T*): Unit

def apply(senum: SpinalEnum): SpinalEnumCraft[senum.type]

def apply[T <: Data](data: HardType[T]): T

def apply[T <: Data](data: T): T

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def cloneOf[T <: Data](that: T): T

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def port(senum: SpinalEnum): SpinalEnumCraft[senum.type]

def port[T <: Data](data: HardType[T]): T

def port[T <: Data](data: T): T

def postTypeFactory[T <: Data](that: T): T

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def Bool: Bool

def finalize(): Unit

Inherited from BaseTypeFactory

Inherited from UFixFactory

Inherited from SFixFactory

Inherited from TypeFactory

Inherited from VecFactory

Inherited from SIntFactory

Inherited from UIntFactory

Inherited from BitsFactory

Inherited from BoolFactory

Inherited from AnyRef

Inherited from Any

Ungrouped