xref: /XiangShan/src/main/scala/top/YamlParser.scala (revision 53bd4e1cb2bbe049a6887a8f3c75c296803c14b0)

/***************************************************************************************
* Copyright (c) 2025 Beijing Institute of Open Source Chip (BOSC)
* Copyright (c) 2025 Institute of Computing Technology, Chinese Academy of Sciences
*
* XiangShan is licensed under Mulan PSL v2.
* You can use this software according to the terms and conditions of the Mulan PSL v2.
* You may obtain a copy of Mulan PSL v2 at:
*          http://license.coscl.org.cn/MulanPSL2
*
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
*
* See the Mulan PSL v2 for more details.
***************************************************************************************/

package top

import io.circe.generic.extras.Configuration
import io.circe.generic.extras.auto._

import aia.IMSICParams
import org.chipsalliance.cde.config.Parameters
import system.SoCParamsKey
import xiangshan.backend.fu.{MemoryRange, PMAConfigEntry}
import xiangshan.XSTileKey
import freechips.rocketchip.devices.debug.{DebugAttachParams, ExportDebug}
import freechips.rocketchip.devices.debug.{DMI, JTAG, CJTAG, APB}
import freechips.rocketchip.devices.debug.{DebugModuleKey, DebugModuleParams}
import freechips.rocketchip.diplomacy.AddressSet
import freechips.rocketchip.tile.MaxHartIdBits
import freechips.rocketchip.util.AsyncQueueParams
import device.IMSICBusType

case class YamlConfig(
  Config: Option[String],
  PmemRanges: Option[List[MemoryRange]],
  PMAConfigs: Option[List[PMAConfigEntry]],
  EnableCHIAsyncBridge: Option[Boolean],
  L2CacheConfig: Option[L2CacheConfig],
  L3CacheConfig: Option[L3CacheConfig],
  HartIDBits: Option[Int],
  DebugAttachProtocals: Option[List[String]],
  DebugModuleParams: Option[DebugModuleParams],
  WFIResume: Option[Boolean],
  SeperateDM: Option[Boolean],
  SeperateTLBus: Option[Boolean],
  SeperateTLBusRanges: Option[List[AddressSet]],
  EnableSeperateTLBusAsyncBridge: Option[Boolean],
  IMSICBusType: Option[String],
  IMSICParams: Option[IMSICParams],
  CHIIssue: Option[String],
  WFIClockGate: Option[Boolean],
  EnablePowerDown: Option[Boolean],
  XSTopPrefix: Option[String],
  EnableDFX: Option[Boolean],
  EnableSramCtl: Option[Boolean],
  EnableCHINS: Option[Boolean],
  CHIAddrWidth: Option[Int],
)

object YamlParser {
  implicit val customParserConfig: Configuration = Configuration.default.withDefaults
  def parseYaml(config: Parameters, yamlFile: String): Parameters = {
    val yaml = scala.io.Source.fromFile(yamlFile).mkString
    val json = io.circe.yaml.parser.parse(yaml) match {
      case Left(value) => throw value
      case Right(value) => value
    }
    val yamlConfig = json.as[YamlConfig] match {
      case Left(value) => throw value
      case Right(value) => value
    }
    var newConfig = config
    yamlConfig.Config.foreach { config =>
      newConfig = ArgParser.getConfigByName(config)
    }
    yamlConfig.PmemRanges.foreach { ranges =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(PmemRanges = ranges)
      })
    }
    yamlConfig.PMAConfigs.foreach { pmaConfigs =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(PMAConfigs = pmaConfigs)
      })
    }
    yamlConfig.EnableCHIAsyncBridge.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(
          EnableCHIAsyncBridge = Option.when(enable)(AsyncQueueParams(depth = 16, sync = 3, safe = false))
        )
      })
    }
    yamlConfig.L2CacheConfig.foreach(l2 => newConfig = newConfig.alter(l2))
    yamlConfig.L3CacheConfig.foreach(l3 => newConfig = newConfig.alter(l3))
    yamlConfig.DebugAttachProtocals.foreach { protocols =>
      newConfig = newConfig.alter((site, here, up) => {
        case ExportDebug => DebugAttachParams(protocols = protocols.map {
          case "DMI" => DMI
          case "JTAG" => JTAG
          case "CJTAG" => CJTAG
          case "APB" => APB
        }.toSet)
      })
    }
    yamlConfig.HartIDBits.foreach { bits =>
      newConfig = newConfig.alter((site, here, up) => {
        case MaxHartIdBits => bits
      })
    }
    yamlConfig.DebugModuleParams.foreach { params =>
      newConfig = newConfig.alter((site, here, up) => {
        case DebugModuleKey => Some(params)
      })
    }
    yamlConfig.WFIResume.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case XSTileKey => up(XSTileKey).map(_.copy(wfiResume = enable))
      })
    }
    yamlConfig.SeperateDM.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(SeperateDM = enable)
      })
    }
    yamlConfig.SeperateTLBus.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(SeperateTLBus = enable)
      })
    }
    yamlConfig.SeperateTLBusRanges.foreach { ranges =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(SeperateTLBusRanges = ranges)
      })
    }
    yamlConfig.EnableSeperateTLBusAsyncBridge.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(
          SeperateTLAsyncBridge = Option.when(enable)(AsyncQueueParams(depth = 1, sync = 3, safe = false))
        )
      })
    }
    yamlConfig.IMSICBusType.foreach { busType =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(IMSICBusType = device.IMSICBusType.withName(busType))
      })
    }
    yamlConfig.IMSICParams.foreach { params =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(IMSICParams = params)
      })
    }
    yamlConfig.CHIIssue.foreach { issue =>
      newConfig = newConfig.alter((site, here, up) => {
        case coupledL2.tl2chi.CHIIssue => issue
      })
    }
    yamlConfig.WFIClockGate.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(WFIClockGate = enable)
      })
    }
    yamlConfig.EnablePowerDown.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(EnablePowerDown = enable)
      })
    }
    yamlConfig.XSTopPrefix.foreach { prefix =>
      newConfig = newConfig.alter((site, here, up) => {
        case SoCParamsKey => up(SoCParamsKey).copy(XSTopPrefix = Option.when(prefix.nonEmpty)(prefix))
      })
    }
    yamlConfig.EnableDFX.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case XSTileKey => up(XSTileKey).map(_.copy(hasMbist = enable))
      })
    }
    yamlConfig.EnableSramCtl.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case XSTileKey => up(XSTileKey).map(_.copy(hasSramCtl = enable))
      })
    }
    yamlConfig.EnableCHINS.foreach { enable =>
      newConfig = newConfig.alter((site, here, up) => {
        case coupledL2.tl2chi.NonSecureKey => enable
      })
    }
    yamlConfig.CHIAddrWidth.foreach { width =>
      newConfig = newConfig.alter((site, here, up) => {
        case coupledL2.tl2chi.CHIAddrWidthKey => width
      })
    }
    newConfig
  }
}