Class

spinal.lib.com.i2c

I2cSlave

Related Doc: package i2c

Permalink

class I2cSlave extends Component

I2C Slave IO Layer :

This component manages the low level of the I2C protocol. (START, STOP, Send & Receive bit data)

| |<------- I2C ------->| |---> CMD | Master | | Slave | || ||<--- RSP

3 bit frame => : | | | | | | | | | CMD : START DRIVE READ DRIVE READ DRIVE READ DRIVE STOP RSP : | |RSP | |RSP | |RSP |

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. I2cSlave
  2. Component
  3. SpinalTagReady
  4. Stackable
  5. DelayedInit
  6. NameableByComponent
  7. Nameable
  8. ContextUser
  9. ScalaLocated
  10. GlobalDataUser
  11. OwnableRef
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new I2cSlave(g: I2cSlaveGenerics)

    Permalink

Type Members

  1. case class PrePopTask(task: () ⇒ Unit, clockDomain: ClockDomain) extends Product with Serializable

    Permalink

    Class used to create a task that must be executed after the creation of the component

    Class used to create a task that must be executed after the creation of the component

    Definition Classes
    Component
  2. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. var _spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): I2cSlave.this.type

    Permalink
    Definition Classes
    ComponentSpinalTagReady
  6. def addAttribute(name: String, value: String): I2cSlave.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String): I2cSlave.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink

    Add a new prePopTask

    Add a new prePopTask

    Definition Classes
    Component
  9. def addTag[T <: SpinalTag](spinalTag: T): I2cSlave.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  10. def addTags[T <: SpinalTag](tags: Iterable[T]): I2cSlave.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. val children: ArrayBuffer[Component]

    Permalink

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  13. val clockDomain: ClockDomain

    Permalink

    Get the current clock domain (null if there is no clock domain already set )

    Get the current clock domain (null if there is no clock domain already set )

    Definition Classes
    Component
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def component: Component

    Permalink
    Definition Classes
    ContextUser
  16. val ctrl: Area { ... /* 9 definitions in type refinement */ }

    Permalink

    Slave controller

  17. var definitionName: String

    Permalink

    Definition Name (name of the entity (VHDL) or module (Verilog))

    Definition Name (name of the entity (VHDL) or module (Verilog))

    Definition Classes
    Component
  18. def delayedInit(body: ⇒ Unit): Unit

    Permalink

    Initialization class delay

    Initialization class delay

    Definition Classes
    Component → DelayedInit
  19. val detector: Area { ... /* 2 definitions in type refinement */ }

    Permalink

    Detect the start/restart and the stop sequences

  20. val dslBody: ScopeStatement

    Permalink
    Definition Classes
    Component
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  24. val filter: I2cIoFilter

    Permalink

    Filter SDA and SCL input

  25. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  28. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  29. def getAllIo: Set[BaseType]

    Permalink

    Get a set of all IO available in the component

    Get a set of all IO available in the component

    Definition Classes
    Component
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  31. def getDisplayName(): String

    Permalink
    Definition Classes
    ComponentNameable
  32. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]

    Permalink
    Definition Classes
    Component
  33. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  34. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  35. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  36. def getName(): String

    Permalink
    Definition Classes
    Nameable
  37. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  38. def getParentsPath(sep: String = "/"): String

    Permalink

    Return the path of the parent

    Return the path of the parent

    Definition Classes
    Component
    Example:
    1. toplevel/[myComponent1] // Current component is myComponent2
  39. def getPath(sep: String = "/"): String

    Permalink

    Return the path of the component

    Return the path of the component

    Definition Classes
    Component
    Example:
    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  40. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  41. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  42. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  43. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  44. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  45. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  46. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  47. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  48. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  49. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  50. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  51. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  52. val io: I2cSlaveIo

    Permalink

    Interface of the I2C Hal slave

  53. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  54. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  55. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  56. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  57. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  58. var localNamingScope: NamingScope

    Permalink

    Name allocation

    Name allocation

    Definition Classes
    Component
  59. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  60. def nameElements(): Unit

    Permalink

    Name all Nameable object

    Name all Nameable object

    Definition Classes
    Component
  61. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  62. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  63. def noIoPrefix(): I2cSlave.this.type

    Permalink

    No "io_" prefix in front of the in/out signals

    No "io_" prefix in front of the in/out signals

    Definition Classes
    Component
  64. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  65. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  66. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  67. def parent: Component

    Permalink

    Get the parent component (null if there is no parent)

    Get the parent component (null if there is no parent)

    Definition Classes
    Component
  68. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  69. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Permalink

    Return a list of all parents of the components

    Return a list of all parents of the components

    Definition Classes
    Component
  70. def postPopEvent(): Unit

    Permalink
    Definition Classes
    Stackable
  71. def postPushEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  72. def prePop(): Unit

    Permalink
    Definition Classes
    Component
  73. def prePopEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  74. var pulledDataCache: Map[Data, Data]

    Permalink

    Reference owner type

    Reference owner type

    Definition Classes
    Component
  75. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  76. def removeTag(spinalTag: SpinalTag): I2cSlave.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  77. def removeTags(tags: Iterable[SpinalTag]): I2cSlave.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  78. def rework[T](gen: ⇒ T): T

    Permalink

    Rework the component

    Rework the component

    Definition Classes
    Component
  79. val sclEdge: BoolEdges

    Permalink

    Detect the rising and falling edge of the scl signal

  80. val sdaEdge: BoolEdges

    Permalink
  81. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  82. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable, postfix: String): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  84. def setCompositeName(nameable: Nameable, namePriority: Byte): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  85. def setCompositeName(nameable: Nameable, weak: Boolean): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  86. def setCompositeName(nameable: Nameable): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  87. def setDefinitionName(name: String): I2cSlave.this.type

    Permalink

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  88. def setName(name: String, namePriority: Byte): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  89. def setName(name: String, weak: Boolean): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  90. def setName(name: String): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  91. def setPartialName(name: String, namePriority: Byte): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  92. def setPartialName(name: String, weak: Boolean): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  93. def setPartialName(owner: Nameable, name: String, namePriority: Byte): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  94. def setPartialName(owner: Nameable, name: String, weak: Boolean): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  95. def setPartialName(name: String): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  96. def setPartialName(owner: Nameable, name: String): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  97. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  98. def setScalaLocated(source: ScalaLocated): I2cSlave.this.type

    Permalink
    Definition Classes
    ScalaLocated
  99. def setWeakName(name: String): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  100. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  101. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  102. val timeout: Area { ... /* 2 definitions in type refinement */ }

    Permalink
  103. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  104. val tsuData: Area { ... /* 3 definitions in type refinement */ }

    Permalink
  105. def unsetName(): I2cSlave.this.type

    Permalink
    Definition Classes
    Nameable
  106. val userCache: Map[AnyRef, Map[AnyRef, AnyRef]]

    Permalink

    Used to store arbitrary object related to the component

    Used to store arbitrary object related to the component

    Definition Classes
    Component
  107. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Component

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from DelayedInit

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped