rocket-chip/uncore/src/main/scala/tilelink2/Monitor.scala

// See LICENSE for license details.

package uncore.tilelink2

import Chisel._
import chisel3.internal.sourceinfo.SourceInfo

object TLMonitor
{
  def legalizeA(bundle: TLBundleA, edge: TLEdgeOut, sourceInfo: SourceInfo) = {
    assert (TLMessages.isA(bundle.opcode), "'A' channel has invalid opcode")(sourceInfo)
    
    // Reuse these subexpressions to save some firrtl lines
    val source_ok = edge.client.contains(bundle.source)
    val is_aligned = edge.isAligned(bundle.address, bundle.size)
    val mask = edge.fullMask(bundle.address, bundle.size)

    when (bundle.opcode === TLMessages.Acquire) {
      assert (edge.manager.supportsAcquire(bundle.address, bundle.size), "'A' channel carries Acquire type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel Acquire carries invalid source ID")(sourceInfo)
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'A' channel Acquire smaller than a beat")(sourceInfo)
      assert (is_aligned, "'A' channel Acquire address not aligned to size")(sourceInfo)
      assert (TLPermissions.isGrow(bundle.param), "'A' channel Acquire carries invalid grow param")(sourceInfo)
      assert (bundle.mask === SInt(-1).asUInt, "'A' channel Acquire contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.Get) {
      assert (edge.manager.supportsGet(bundle.address, bundle.size), "'A' channel carries Get type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel Get carries invalid source ID")(sourceInfo)
      assert (is_aligned, "'A' channel Get address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'A' channel Get carries invalid param")(sourceInfo)
      assert (bundle.mask === mask, "'A' channel Get contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.PutFullData) {
      assert (edge.manager.supportsPutFull(bundle.address, bundle.size), "'A' channel carries PutFull type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel PutFull carries invalid source ID")(sourceInfo)
      assert (is_aligned, "'A' channel PutFull address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'A' channel PutFull carries invalid param")(sourceInfo)
      assert (bundle.mask === mask, "'A' channel PutFull contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.PutPartialData) {
      assert (edge.manager.supportsPutPartial(bundle.address, bundle.size), "'A' channel carries PutPartial type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel PutPartial carries invalid source ID")(sourceInfo)
      assert (is_aligned, "'A' channel PutPartial address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'A' channel PutPartial carries invalid param")(sourceInfo)
      assert ((bundle.mask & ~mask) === UInt(0), "'A' channel PutPartial contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.ArithmeticData) {
      assert (edge.manager.supportsArithmetic(bundle.address, bundle.size), "'A' channel carries Arithmetic type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel Arithmetic carries invalid source ID")(sourceInfo)
      assert (is_aligned, "'A' channel Arithmetic address not aligned to size")(sourceInfo)
      assert (TLAtomics.isArithmetic(bundle.param), "'A' channel Arithmetic carries invalid opcode param")(sourceInfo)
      assert (bundle.mask === mask, "'A' channel Arithmetic contains invalid mask")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.LogicalData) {
      assert (edge.manager.supportsLogical(bundle.address, bundle.size), "'A' channel carries Logical type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel Logical carries invalid source ID")(sourceInfo)
      assert (is_aligned, "'A' channel Logical address not aligned to size")(sourceInfo)
      assert (TLAtomics.isLogical(bundle.param), "'A' channel Logical carries invalid opcode param")(sourceInfo)
      assert (bundle.mask === mask, "'A' channel Logical contains invalid mask")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.Hint) {
      assert (edge.manager.supportsHint(bundle.address), "'A' channel carries Hint type unsupported by manager")(sourceInfo)
      assert (source_ok, "'A' channel Hint carries invalid source ID")(sourceInfo)
      assert (is_aligned, "'A' channel Hint address not aligned to size")(sourceInfo)
      assert (bundle.mask === mask, "'A' channel Hint contains invalid mask")(sourceInfo)
    }
  }

  def legalizeB(bundle: TLBundleB, edge: TLEdgeIn, sourceInfo: SourceInfo) = {
    assert (TLMessages.isB(bundle.opcode), "'B' channel has invalid opcode")(sourceInfo)

    // Reuse these subexpressions to save some firrtl lines
    val address_ok = edge.manager.contains(bundle.source)
    val is_aligned = edge.isAligned(bundle.address, bundle.size)
    val mask = edge.fullMask(bundle.address, bundle.size)

    when (bundle.opcode === TLMessages.Probe) {
      assert (edge.client.supportsProbe(bundle.source, bundle.size), "'B' channel carries Probe type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel Probe carries unmanaged address")(sourceInfo)
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'B' channel Probe smaller than a beat")(sourceInfo)
      assert (is_aligned, "'B' channel Probe address not aligned to size")(sourceInfo)
      assert (TLPermissions.isCap(bundle.param), "'B' channel Probe carries invalid cap param")(sourceInfo)
      assert (bundle.mask === SInt(-1).asUInt, "'B' channel Probe contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.Get) {
      assert (edge.client.supportsGet(bundle.source, bundle.size), "'B' channel carries Get type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel Get carries unmanaged address")(sourceInfo)
      assert (is_aligned, "'B' channel Get address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'B' channel Get carries invalid param")(sourceInfo)
      assert (bundle.mask === mask, "'A' channel Get contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.PutFullData) {
      assert (edge.client.supportsPutFull(bundle.source, bundle.size), "'B' channel carries PutFull type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel PutFull carries unmanaged address")(sourceInfo)
      assert (is_aligned, "'B' channel PutFull address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'B' channel PutFull carries invalid param")(sourceInfo)
      assert (bundle.mask === mask, "'B' channel PutFull contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.PutPartialData) {
      assert (edge.client.supportsPutPartial(bundle.source, bundle.size), "'B' channel carries PutPartial type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel PutPartial carries unmanaged address")(sourceInfo)
      assert (is_aligned, "'B' channel PutPartial address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'B' channel PutPartial carries invalid param")(sourceInfo)
      assert ((bundle.mask & ~mask) === UInt(0), "'B' channel PutPartial contains invalid mask")(sourceInfo)
    }

    when (bundle.opcode === TLMessages.ArithmeticData) {
      assert (edge.client.supportsArithmetic(bundle.source, bundle.size), "'B' channel carries Arithmetic type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel Arithmetic carries unmanaged address")(sourceInfo)
      assert (is_aligned, "'B' channel Arithmetic address not aligned to size")(sourceInfo)
      assert (TLAtomics.isArithmetic(bundle.param), "'B' channel Arithmetic carries invalid opcode param")(sourceInfo)
      assert (bundle.mask === mask, "'B' channel Arithmetic contains invalid mask")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.LogicalData) {
      assert (edge.client.supportsLogical(bundle.source, bundle.size), "'B' channel carries Logical type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel Logical carries unmanaged address")(sourceInfo)
      assert (is_aligned, "'B' channel Logical address not aligned to size")(sourceInfo)
      assert (TLAtomics.isLogical(bundle.param), "'B' channel Logical carries invalid opcode param")(sourceInfo)
      assert (bundle.mask === mask, "'B' channel Logical contains invalid mask")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.Hint) {
      assert (edge.client.supportsHint(bundle.source), "'B' channel carries Hint type unsupported by client")(sourceInfo)
      assert (address_ok, "'B' channel Hint carries unmanaged address")(sourceInfo)
      assert (is_aligned, "'B' channel Hint address not aligned to size")(sourceInfo)
      assert (bundle.mask === mask, "'B' channel Hint contains invalid mask")(sourceInfo)
    }
  }

  def legalizeC(bundle: TLBundleC, edge: TLEdgeOut, sourceInfo: SourceInfo) = {
    assert (TLMessages.isC(bundle.opcode), "'C' channel has invalid opcode")(sourceInfo)
    
    val source_ok = edge.client.contains(bundle.source)
    val is_aligned = edge.isAligned(bundle.address, bundle.size)
    val address_ok = edge.manager.contains(bundle.source)

    when (bundle.opcode === TLMessages.ProbeAck) {
      assert (address_ok, "'C' channel ProbeAck carries unmanaged address")(sourceInfo)
      // source is ignored
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'C' channel ProbeAck smaller than a beat")(sourceInfo)
      assert (is_aligned, "'C' channel ProbeAck address not aligned to size")(sourceInfo)
      assert (TLPermissions.isReport(bundle.param), "'C' channel ProbeAck carries invalid report param")(sourceInfo)
      assert (!bundle.error, "'C' channel Probe carries an error")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.ProbeAckData) {
      assert (address_ok, "'C' channel ProbeAckData carries unmanaged address")(sourceInfo)
      // source is ignored
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'C' channel ProbeAckData smaller than a beat")(sourceInfo)
      assert (is_aligned, "'C' channel ProbeAckData address not aligned to size")(sourceInfo)
      assert (TLPermissions.isReport(bundle.param), "'C' channel ProbeAckData carries invalid report param")(sourceInfo)
      assert (!bundle.error, "'C' channel ProbeData carries an error")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.Release) {
      assert (edge.manager.supportsAcquire(bundle.address, bundle.size), "'C' channel carries Release type unsupported by manager")(sourceInfo)
      assert (source_ok, "'C' channel Release carries invalid source ID")(sourceInfo)
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'C' channel Release smaller than a beat")(sourceInfo)
      assert (is_aligned, "'C' channel Release address not aligned to size")(sourceInfo)
      assert (TLPermissions.isShrink(bundle.param), "'C' channel Release carries invalid shrink param")(sourceInfo)
      assert (!bundle.error, "'C' channel Release carries an error")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.ReleaseData) {
      assert (edge.manager.supportsAcquire(bundle.address, bundle.size), "'C' channel carries ReleaseData type unsupported by manager")(sourceInfo)
      assert (source_ok, "'C' channel ReleaseData carries invalid source ID")(sourceInfo)
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'C' channel ReleaseData smaller than a beat")(sourceInfo)
      assert (is_aligned, "'C' channel ReleaseData address not aligned to size")(sourceInfo)
      assert (TLPermissions.isShrink(bundle.param), "'C' channel ReleaseData carries invalid shrink param")(sourceInfo)
      assert (!bundle.error, "'C' channel ReleaseData carries an error")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.AccessAck) {
      assert (address_ok, "'C' channel AccessAck carries unmanaged address")(sourceInfo)
      // source is ignored
      assert (is_aligned, "'C' channel AccessAck address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'C' channel AccessAck carries invalid param")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.AccessAckData) {
      assert (address_ok, "'C' channel AccessAckData carries unmanaged address")(sourceInfo)
      // source is ignored
      assert (is_aligned, "'C' channel AccessAckData address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'C' channel AccessAckData carries invalid param")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.HintAck) {
      assert (address_ok, "'C' channel HintAck carries unmanaged address")(sourceInfo)
      // source is ignored
      assert (is_aligned, "'C' channel HintAck address not aligned to size")(sourceInfo)
      assert (bundle.param === UInt(0), "'C' channel HintAck carries invalid param")(sourceInfo)
      assert (!bundle.error, "'C' channel HintAck carries an error")(sourceInfo)
    }
  }

  def legalizeD(bundle: TLBundleD, edge: TLEdgeIn, sourceInfo: SourceInfo) = {
    assert (TLMessages.isD(bundle.opcode), "'D' channel has invalid opcode")(sourceInfo)
    
    val source_ok = edge.client.contains(bundle.source)
    val sink_ok = edge.manager.containsById(bundle.sink)
    
    when (bundle.opcode === TLMessages.ReleaseAck) {
      assert (source_ok, "'D' channel ReleaseAck carries invalid source ID")(sourceInfo)
      // sink is ignored
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'D' channel ReleaseAck smaller than a beat")(sourceInfo)
      assert (bundle.param === UInt(0), "'D' channel ReleaseeAck carries invalid param")(sourceInfo)
      assert (!bundle.error, "'D' channel ReleaseAck carries an error")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.Grant) {
      assert (source_ok, "'D' channel Grant carries invalid source ID")(sourceInfo)
      assert (sink_ok, "'D' channel Grant carries invalid sink ID")(sourceInfo)
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'D' channel Grant smaller than a beat")(sourceInfo)
      assert (TLPermissions.isCap(bundle.param), "'D' channel Grant carries invalid cap param")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.GrantData) {
      assert (source_ok, "'D' channel GrantData carries invalid source ID")(sourceInfo)
      assert (sink_ok, "'D' channel GrantData carries invalid sink ID")(sourceInfo)
      assert (bundle.size >= UInt(log2Ceil(edge.manager.beatBytes)), "'D' channel GrantData smaller than a beat")(sourceInfo)
      assert (TLPermissions.isCap(bundle.param), "'D' channel GrantData carries invalid cap param")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.AccessAck) {
      assert (source_ok, "'D' channel AccessAck carries invalid source ID")(sourceInfo)
      // sink is ignored
      // size is ignored
      assert (bundle.param === UInt(0), "'D' channel AccessAck carries invalid param")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.AccessAckData) {
      assert (source_ok, "'D' channel AccessAckData carries invalid source ID")(sourceInfo)
      // sink is ignored
      // size is ignored
      assert (bundle.param === UInt(0), "'D' channel AccessAckData carries invalid param")(sourceInfo)
    }
    
    when (bundle.opcode === TLMessages.HintAck) {
      assert (source_ok, "'D' channel HintAck carries invalid source ID")(sourceInfo)
      // sink is ignored
      // size is ignored
      assert (bundle.param === UInt(0), "'D' channel HintAck carries invalid param")(sourceInfo)
      assert (!bundle.error, "'D' channel HintAck carries an error")(sourceInfo)
    }
  }

  def legalizeE(bundle: TLBundleE, edge: TLEdgeOut, sourceInfo: SourceInfo) = {
    assert (edge.manager.containsById(bundle.sink), "'E' channels carries invalid sink ID")(sourceInfo)
  }
  
  def legalize(bundleOut: TLBundle, edgeOut: TLEdgeOut, bundleIn: TLBundle, edgeIn: TLEdgeIn, sourceInfo: SourceInfo) = {
    when (bundleOut.a.valid) { legalizeA(bundleOut.a.bits, edgeOut, sourceInfo) }
    when (bundleIn .b.valid) { legalizeB(bundleIn .b.bits, edgeIn,  sourceInfo) }
    when (bundleOut.c.valid) { legalizeC(bundleOut.c.bits, edgeOut, sourceInfo) }
    when (bundleIn .d.valid) { legalizeD(bundleIn .d.bits, edgeIn,  sourceInfo) }
    when (bundleOut.e.valid) { legalizeE(bundleOut.e.bits, edgeOut, sourceInfo) }
  }
}