chipsec-chipsec/chipsec/cfg/template.xml

<?xml version="1.0"?>
<configuration platform="[PLATFORM_CODE]" req_pch="BOOLEAN">
<!--
Template for XML configuration file
-->
  <!-- #################################### -->
  <!--                                      -->
  <!-- Integrated devices                   -->
  <!--                                      -->
  <!-- #################################### -->
  <pci>
    <device name="[DEVICE NAME]" bus="[BUS#]" dev="[DEVICE#]" fun="[FUNCTION#]" vid="[VENDOR ID]" />
  </pci>

  <!-- #################################### -->
  <!--                                      -->
  <!-- Memory Mapped I/O spaces (MMIO BARs) -->
  <!--                                      -->
  <!-- #################################### -->
  <mmio>
    <!-- use this definition -->
    <bar name="[BAR NAME]" register="[BAR REGISTER NAME]" base_field="[BAR BASE BIT FIELD]" enable_field="[BAR ENABLE BIT FIELD]" size="[BAR SIZE]" desc="[BAR DESCRIPTION]"/>
    <!-- or (old definition) -->
    <bar name="[BAR NAME]" bus="[BUS#]" dev="[DEVICE#]" fun="[FUNCTION#]" reg="[BAR REGISTER OFFSET]" width="[BAR REGISTER WIDTH]" mask="[BAR REGISTER MASK]" size="[BAR SIZE]" enable_bit="[BAR ENABLE BIT POSITION]" desc="[BAR DESCRIPTION]"/>
  </mmio>

  <!-- #################################### -->
  <!--                                      -->
  <!-- I/O spaces (I/O BARs)                -->
  <!--                                      -->
  <!-- #################################### -->
  <io>
    <!-- use this definition -->
    <bar name="[BAR NAME]" register="[BAR REGISTER NAME]" base_field="[BAR BASE BIT FIELD]" enable_field="[BAR ENABLE BIT FIELD]" size="[BAR SIZE]" desc="[BAR DESCRIPTION]"/>
    <!-- or (old definition) -->
    <bar name="[BAR NAME]" bus="[BUS#]" dev="[DEVICE#]" fun="[FUNCTION#]" reg="[BAR REGISTER OFFSET]" mask="[BAR REGISTER MASK]" size="[BAR SIZE]" desc="[BAR DESCRIPTION]"/>
  </io>

  <!-- #################################### -->
  <!--                                      -->
  <!-- Memory ranges                        -->
  <!--                                      -->
  <!-- #################################### -->
  <memory>
    <range name="[RANGE NAME]" access="dram|mmio" address="[PHYS ADDRESS]" size="[RANGE SIZE]"/>
  </memory>

  <!-- #################################### -->
  <!--                                      -->
  <!-- Configuration registers              -->
  <!--                                      -->
  <!-- #################################### -->
  <registers>
    <register name="[UNIQUE REGISTER NAME]" type="msr|mmio|io|iobar|pcicfg|mmcfg|msgbus|memory" desc="[REGISTER DESCRIPTION]" lockedby="[LOCK NAME]" />
  </registers>

  <!-- #################################### -->
  <!--                                      -->
  <!-- Controls                             -->
  <!--                                      -->
  <!-- #################################### -->
  <controls>
    <control name="[UNIQUE CONTROL NAME]" register="[REGISTER NAME WITH THIS CONTROL]" field="[CONTROL FIELD NAME WITHIN REGISTER]" desc="[CONTROL DESCRIPTION]" />
  </controls>

  <!-- #################################### -->
  <!--                                      -->
  <!-- Locks                                -->
  <!--                                      -->
  <!-- #################################### -->
  <locks>
    <lock name="[UNIQUE LOCK NAME]" register="[REGISTER NAME WITH THIS LOCK]" field="[LOCK FIELD NAME WITHIN REGISTER]" value="[VALUE TO INDICATE LOCK IS SET]" desc="[LOCK DESCRIPTION]" />
  </locks>

</configuration>