Skip to content
This repository has been archived by the owner on Jun 24, 2021. It is now read-only.

Latest commit

 

History

History
343 lines (291 loc) · 15.1 KB

Parameters.md

File metadata and controls

343 lines (291 loc) · 15.1 KB
Raw

Rocket/tilelink/Parameters

TileLink interconnection parameters.

Synchronous TileLink

case class TLManagerParameters

Parameters for a TileLink manager.

case class TLManagerParameters(
  address:            Seq[AddressSet],
  resources:          Seq[Resource] = Seq(),
  regionType:         RegionType.T  = RegionType.GET_EFFECTS,
  executable:         Boolean       = false, // processor can execute from this memory
  nodePath:           Seq[BaseNode] = Seq(),
  supportsAcquireT:   TransferSizes = TransferSizes.none,
  supportsAcquireB:   TransferSizes = TransferSizes.none,
  supportsArithmetic: TransferSizes = TransferSizes.none,
  supportsLogical:    TransferSizes = TransferSizes.none,
  supportsGet:        TransferSizes = TransferSizes.none,
  supportsPutFull:    TransferSizes = TransferSizes.none,
  supportsPutPartial: TransferSizes = TransferSizes.none,
  supportsHint:       TransferSizes = TransferSizes.none,
  fifoId:             Option[Int]   = None)
  • address Seq[AddressSet] (param) address range covered by this manager.
  • resources Seq[Resource] = Seq() (param)
  • regionType RegionType.T = RegionType.GET_EFFECTS (param)
  • executable Boolean = false (param)
  • nodePath Seq[BaseNode] = Seq() (param)
  • The supported types and sizes of packets
    • supportsAcquireT TransferSizes = TransferSizes.none (param)
    • supportsAcquireB TransferSizes = TransferSizes.none (param)
    • supportsArithmetic TransferSizes = TransferSizes.none (param)
    • supportsLogical TransferSizes = TransferSizes.none (param)
    • supportsGet TransferSizes = TransferSizes.none (param)
    • supportsPutFull TransferSizes = TransferSizes.none (param)
    • supportsPutPartial TransferSizes = TransferSizes.none (param)
    • supportsHint TransferSizes = TransferSizes.none (param)
  • fifoId Option[Int] = None (param) If fifoId=Some, all accesses sent to the same fifoId are executed and ACK'd in FIFO order. Note: you can only rely on this FIFO behaviour if your TLClientParameters include requestFifo.
  • maxTransfer TransferSizes the maximal packet size.
  • maxAddress BigInt the maximal address in all address spaces.
  • name String
  • minAlignment BigInt the minimal alignment of all address spaces.
  • toResource () => ResourceAddress convert this to ResourceAddress.

case class TLManagerPortParameters

Parameters for a TileLink manager (upwards) port.

case class TLManagerPortParameters(
  managers:   Seq[TLManagerParameters],
  beatBytes:  Int,
  endSinkId:  Int = 0,  // 0 = no sink ids, 1 = a reusable sink id, >1 = unique sink ids
  minLatency: Int = 0)
  • managers Seq[TLManagerParameters] (param) parameters of the managers sharing this port.
  • beatBytes Int (param) number of bytes per beat.
  • endSinkId Int = 1 (param)
  • minLatency Int = 0 (param)
  • maxTransfer () => Int the maximal packet size.
  • maxAddress () => BigInt the maximal address in all address spaces.
  • Get the size of supported packets (the maximal size range supported by all managers)
    • allSupportAcquireT () => TransferSizes
    • allSupportAcquireB () => TransferSizes
    • allSupportArithmetic () => TransferSizes
    • allSupportLogical () => TransferSizes
    • allSupportGet () => TransferSizes
    • allSupportPutFull () => TransferSizes
    • allSupportPutPartial () => TransferSizes
    • allSupportHint () => TransferSizes
  • Get the supported types of packets (supported by any manager)
    • anySupportAcquireT () => Boolean
    • anySupportAcquireB () => Boolean
    • anySupportArithmetic () => Boolean
    • anySupportLogical () => Boolean
    • anySupportGet () => Boolean
    • anySupportPutFull () => Boolean
    • anySupportPutPartial () => Boolean
    • anySupportHint () => Boolean
  • Check whether an address is managed by this port with a certain type and size
    • supportsAcquireTSafe (address: UInt, lgSize: UInt) => Bool
    • supportsAcquireBSafe (address: UInt, lgSize: UInt) => Bool
    • supportsArithmeticSafe (address: UInt, lgSize: UInt) => Bool
    • supportsLogicalSafe (address: UInt, lgSize: UInt) => Bool
    • supportsGetSafe (address: UInt, lgSize: UInt) => Bool
    • supportsPutFullSafe (address: UInt, lgSize: UInt) => Bool
    • supportsPutPartialSafe (address: UInt, lgSize: UInt) => Bool
    • supportsHintSafe (address: UInt, lgSize: UInt) => Bool
  • Check whether an address is managed by this port with a certain type and size (fast version by assuming the address is valid)
    • supportsAcquireTFast (address: UInt, lgSize: UInt) => Bool
    • supportsAcquireBFast (address: UInt, lgSize: UInt) => Bool
    • supportsArithmeticFast (address: UInt, lgSize: UInt) => Bool
    • supportsLogicalFast (address: UInt, lgSize: UInt) => Bool
    • supportsGetFast (address: UInt, lgSize: UInt) => Bool
    • supportsPutFullFast (address: UInt, lgSize: UInt) => Bool
    • supportsPutPartialFast (address: UInt, lgSize: UInt) => Bool
    • supportsHintFast (address: UInt, lgSize: UInt) => Bool
  • routingMask BigInt which bits suffice to distinguish between all managers.
  • find (address: BigInt) => Option[TLManagerParameters] get the TLManagerParameters of an address.
  • findSafe (address: UInt) => Vec() return a bit vector that identifies the managers containing this address.
  • containsSafe (address: UInt) => Bool wWhether this address is managed by this port.
  • findFast (address: UInt) => Vec() a faster version of findSafe() by assuming the address is valid.
  • findFifoIdFast (address: UInt) => Int get the fifoId + 1 or 0 if none.
  • hasFifoIdFast (address: UInt) => Boolean whether there is a matched fifoId.

case class TLClientParameters

Parameters for a TileLink client.

case class TLClientParameters(
  name:                String,
  sourceId:            IdRange       = IdRange(0,1),
  nodePath:            Seq[BaseNode] = Seq(),
  requestFifo:         Boolean       = false, // only a request, not a requirement
  supportsProbe:       TransferSizes = TransferSizes.none,
  supportsArithmetic:  TransferSizes = TransferSizes.none,
  supportsLogical:     TransferSizes = TransferSizes.none,
  supportsGet:         TransferSizes = TransferSizes.none,
  supportsPutFull:     TransferSizes = TransferSizes.none,
  supportsPutPartial:  TransferSizes = TransferSizes.none,
  supportsHint:        TransferSizes = TransferSizes.none)

A TileLink channel may either a coherent channel (need B/C) or a strong ordered (fifo order) channel, but not both.

  • sourceId IdRange = IdRange(0,1) (param) source ID range used for routing responses.
  • nodePath Seq[BaseNode] = Seq() (param)
  • requestFifo Boolean (param) request first-in-first-out order.
  • The supported types and sizes of packets
    • supportsProbe TransferSizes = TransferSizes.none (param)
    • supportsArithmetic TransferSizes = TransferSizes.none (param)
    • supportsLogical TransferSizes = TransferSizes.none (param)
    • supportsGet TransferSizes = TransferSizes.none (param)
    • supportsPutFull TransferSizes = TransferSizes.none (param)
    • supportsPutPartial TransferSizes = TransferSizes.none (param)
    • supportsHint TransferSizes = TransferSizes.none (param)
  • maxTransfer TransferSizes the maximal packet size.
  • name String

case class TLClientPortParameters

Parameters for a TileLink client (downwards) port.

case class TLClientPortParameters(
  clients:       Seq[TLClientParameters],
  unsafeAtomics: Boolean = false,
  minLatency:    Int = 0) // Atomics are executed as get+put
  • clients Seq[TLClientParameters] (param) parameters of the clients sharing this port.
  • unsafeAtomics Boolean = false (param)
  • minLatency Int = 0 (param)
  • endSourceId () => Int the maximal source ID.
  • maxTransfer () => Int the maximal packet size.
  • Get the size of supported packets (the maximal size range supported by all clients)
    • allSupportProbe () => TransferSizes
    • allSupportArithmetic () => TransferSizes
    • allSupportLogical () => TransferSizes
    • allSupportGet () => TransferSizes
    • allSupportPutFull () => TransferSizes
    • allSupportPutPartial () => TransferSizes
    • allSupportHint () => TransferSizes
  • Get the supported types of packets (supported by any client)
    • anySupportProbe () => Boolean
    • anySupportArithmetic () => Boolean
    • anySupportLogical () => Boolean
    • anySupportGet () => Boolean
    • anySupportPutFull () => Boolean
    • anySupportPutPartial () => Boolean
    • anySupportHint () => Boolean
  • Check for support of a given operation at a specific id
    • supportsProbe (id: UInt, lgSize: UInt) => Bool
    • supportsArithmetic (id: UInt, lgSize: UInt) => Bool
    • supportsLogical (id: UInt, lgSize: UInt) => Bool
    • supportsGet (id: UInt, lgSize: UInt) => Bool
    • supportsPutFull (id: UInt, lgSize: UInt) => Bool
    • supportsPutPartial (id: UInt, lgSize: UInt) => Bool
    • supportsHint (id: UInt, lgSize: UInt) => Bool
  • find (id: Int) => Option[TLClientParameters] get the TLClientParameters of an ID.
  • find (id: UInt) => Vec() return a bit vector that identifies the clients.
  • requestFifo (id: UInt) => Bool whether need fifo order for this id.
  • contains (id: UInt) => Bool Whether this ID belongs to this port.

case class TLBundleParameters

Parameters for a TileLink IO interface (Bundle).

case class TLBundleParameters(
  addressBits: Int,
  dataBits:    Int,
  sourceBits:  Int,
  sinkBits:    Int,
  sizeBits:    Int)
  • addressBits Int (param) size of address.
  • dataBits Int (param) size of data.
  • sourceBits Int (param) size of source ID.
  • sinkBits Int (param) size of sink ID?
  • sizeBits Int (param) size of size field.
  • addrLoBits Int size of beat offset bits.
  • union (x: TLBundleParameters) => TLBundleParameters return a parameter object that fits both this and x.

object TLBundleParameters

  • emptyBundleParams TLBundleParameters(1,8,1,1,1) the default (empty) bundle parameter object.
  • union (Seq[TLBundleParameters]) => TLBundleParameters get a parameter that fits all individual parameter objects.
  • apply (TLClientPortParameters, TLManagerPortParameters) => TLBundleParameters generate a bundle parameter according to port parameters.

case class TLEdgeParameters

Parameters for a TileLink connection.

case class TLEdgeParameters(
  client:  TLClientPortParameters,
  manager: TLManagerPortParameters)
  • client TLClientPortParameters (param) client side parameters.
  • manager TLManagerPortParameters (param) manager side parameters.
  • maxTransfer Int the maximal transfer size in both client/manager sides.
  • maxLgSize log2Ceil(maxTransfer)
  • bundle TLBundleParameters(client, manager)

Asynchronous TileLink

case class TLAsyncManagerPortParameters

Async TileLink (cross clock-domain) manager port parameters.

case class TLAsyncManagerPortParameters(
    depth: Int, base: TLManagerPortParameters)

case class TLAsyncClientPortParameters

Async TileLink (cross clock-domain) client port parameters.

case class TLAsyncClientPortParameters(base: TLClientPortParameters)

case class TLAsyncBundleParameters

Async TileLink (cross clock-domain) interface IO parameters.

case class TLAsyncBundleParameters(depth: Int, base: TLBundleParameters)
  • union (x: TLAsyncBundleParameters) => TLAsyncBundleParameters get a parameter that fits both this and x.

object TLAsyncBundleParameters

  • emptyBundleParams TLAsyncBundleParameters(1, TLBundleParameters.emptyBundleParams) the default (empty) bundle parameter object.
  • union (Seq[TLAsyncBundleParameters]) => TLAsyncBundleParameters get a parameter that fits all individual parameter objects.

case class TLAsyncEdgeParameters

Parameters for an asynchronous TileLink connection.

case class TLAsyncEdgeParameters(
    client: TLAsyncClientPortParameters, manager: TLAsyncManagerPortParameters)
  • client TLAsyncClientPortParameters (param) client side parameters.
  • manager TLAsyncManagerPortParameters (param) manager side parameters.
  • bundle TLAsyncBundleParameters(client, manager)

Rational TileLink

case class TLRationalManagerPortParameters

Rational TileLink (cross clock-domain) manager port parameters.

case class TLRationalManagerPortParameters(
    direction: RationalDirection, base: TLManagerPortParameters)
  • direction RationalDirection (param) The relation between two source synchronised clocks:
    • Symmetric Nor sure which side is slower so put queues on both sides.
    • FastToSlow Register at the slow sink.
    • SlowToFast Register at the slow source.

case class TLRationalClientPortParameters

Rational TileLink (cross clock-domain) client port parameters.

case class TLRationalClientPortParameters(base: TLClientPortParameters)

case class TLRationalEdgeParameters

Parameters for a rational TileLink connection.

case class TLRationalEdgeParameters(
    client: TLRationalClientPortParameters, manager: TLRationalManagerPortParameters)
  • bundle TLBundleParameters(client.base, manager.base)

object ManagerUnification

  • apply (Seq[TLManagerParameters]) => Seq[TLManagerParameters] merge TLManagerParameters that have the same key (transaction types). Key is defined as
case class TLManagerKey(
    regionType:         RegionType.T,
    executable:         Boolean,
    lastNode:           BaseNode,
    supportsAcquireT:   TransferSizes,
    supportsAcquireB:   TransferSizes,
    supportsArithmetic: TransferSizes,
    supportsLogical:    TransferSizes,
    supportsGet:        TransferSizes,
    supportsPutFull:    TransferSizes,
    supportsPutPartial: TransferSizes,
    supportsHint:       TransferSizes)




Last updated: 25/09/2017
CC BY-NC-SA 4.0, © (2017) Wei Song
Apache 2.0, © (2016-2017) SiFive, Inc
BSD, © (2012-2014, 2016) The Regents of the University of California (Regents)