€•       Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ&/translations/zh_CN/gpu/xe/xe_firmware”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/zh_TW/gpu/xe/xe_firmware”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/it_IT/gpu/xe/xe_firmware”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/ja_JP/gpu/xe/xe_firmware”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/ko_KR/gpu/xe/xe_firmware”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/sp_SP/gpu/xe/xe_firmware”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ*SPDX-License-Identifier: (GPL-2.0+ OR MIT)”h]”hŒ*SPDX-License-Identifier: (GPL-2.0+ OR MIT)”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒ@/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒFirmware”h]”hŒFirmware”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒFirmware Layout”h]”hŒFirmware Layout”…””}”(hhÌhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hhÉhžhhŸh³h KubhŒ	paragraph”“”)”}”(hŒÏThe CSS-based firmware structure is used for GuC releases on all platforms
and for HuC releases up to DG1. Starting from DG2/MTL the HuC uses the GSC
layout instead.
The CSS firmware layout looks like this::”h]”hŒÎThe CSS-based firmware structure is used for GuC releases on all platforms
and for HuC releases up to DG1. Starting from DG2/MTL the HuC uses the GSC
layout instead.
The CSS firmware layout looks like this:”…””}”(hhÜhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KhhÉhžhubhŒliteral_block”“”)”}”(hX­  +======================================================================+
|  Firmware blob                                                       |
+===============+===============+============+============+============+
|  CSS header   |     uCode     |  RSA key   |  modulus   |  exponent  |
+===============+===============+============+============+============+
 <-header size->                 <---header size continued ----------->
 <--- size ----------------------------------------------------------->
                                 <-key size->
                                              <-mod size->
                                                           <-exp size->”h]”hX­  +======================================================================+
|  Firmware blob                                                       |
+===============+===============+============+============+============+
|  CSS header   |     uCode     |  RSA key   |  modulus   |  exponent  |
+===============+===============+============+============+============+
 <-header size->                 <---header size continued ----------->
 <--- size ----------------------------------------------------------->
                                 <-key size->
                                              <-mod size->
                                                           <-exp size->”…””}”hhísbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hëhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KhhÉhžhubhÛ)”}”(hXb  The firmware may or may not have modulus key and exponent data. The header,
uCode and RSA signature are must-have components that will be used by driver.
Length of each components, which is all in dwords, can be found in header.
In the case that modulus and exponent are not present in fw, a.k.a truncated
image, the length value still appears in header.”h]”hXb  The firmware may or may not have modulus key and exponent data. The header,
uCode and RSA signature are must-have components that will be used by driver.
Length of each components, which is all in dwords, can be found in header.
In the case that modulus and exponent are not present in fw, a.k.a truncated
image, the length value still appears in header.”…””}”(hhühžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KhhÉhžhubhÛ)”}”(hŒJDriver will do some basic fw size validation based on the following rules:”h]”hŒJDriver will do some basic fw size validation based on the following rules:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h K#hhÉhžhubhŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ/Header, uCode and RSA are must-have components.”h]”hÛ)”}”(hj#  h]”hŒ/Header, uCode and RSA are must-have components.”…””}”(hj%  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h K%hj!  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubj   )”}”(hŒdAll firmware components, if they present, are in the sequence illustrated
in the layout table above.”h]”hÛ)”}”(hŒdAll firmware components, if they present, are in the sequence illustrated
in the layout table above.”h]”hŒdAll firmware components, if they present, are in the sequence illustrated
in the layout table above.”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h K&hj9  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubj   )”}”(hŒ@Length info of each component can be found in header, in dwords.”h]”hÛ)”}”(hjT  h]”hŒ@Length info of each component can be found in header, in dwords.”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h K(hjR  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubj   )”}”(hŒ‡Modulus and exponent key are not required by driver. They may not appear
in fw. So driver will load a truncated firmware in this case.
”h]”hÛ)”}”(hŒ†Modulus and exponent key are not required by driver. They may not appear
in fw. So driver will load a truncated firmware in this case.”h]”hŒ†Modulus and exponent key are not required by driver. They may not appear
in fw. So driver will load a truncated firmware in this case.”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:10: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h K)hjj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1j  hhÉhžhhŸNh NubhÛ)”}”(hXƒ  The GSC-based firmware structure is used for GSC releases on all platforms
and for HuC releases starting from DG2/MTL. Older HuC releases use the
CSS-based layout instead. Differently from the CSS headers, the GSC headers
uses a directory + entries structure (i.e., there is array of addresses
pointing to specific header extensions identified by a name). Although the
header structures are the same, some of the entries are specific to GSC while
others are specific to HuC. The manifest header entry, which includes basic
information about the binary (like the version) is always present, but it is
named differently based on the binary type.”h]”hXƒ  The GSC-based firmware structure is used for GSC releases on all platforms
and for HuC releases starting from DG2/MTL. Older HuC releases use the
CSS-based layout instead. Differently from the CSS headers, the GSC headers
uses a directory + entries structure (i.e., there is array of addresses
pointing to specific header extensions identified by a name). Although the
header structures are the same, some of the entries are specific to GSC while
others are specific to HuC. The manifest header entry, which includes basic
information about the binary (like the version) is always present, but it is
named differently based on the binary type.”…””}”(hjŽ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KYhhÉhžhubhÛ)”}”(hŒ~The HuC binary starts with a Code Partition Directory (CPD) header. The
entries we're interested in for use in the driver are:”h]”hŒ€The HuC binary starts with a Code Partition Directory (CPD) header. The
entries weâ€™re interested in for use in the driver are:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KchhÉhžhubj  )”}”(hhh]”(j   )”}”(hŒ6"HUCP.man": points to the manifest header for the HuC.”h]”hÛ)”}”(hj±  h]”hŒ:â€œHUCP.manâ€: points to the manifest header for the HuC.”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h Kfhj¯  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj¬  ubj   )”}”(hX   "huc_fw": points to the FW code. On platforms that support load via DMA
and 2-step HuC authentication (i.e. MTL+) this is a full CSS-based binary,
while if the GSC is the one doing the load (which only happens on DG2)
this section only contains the uCode.
”h]”hÛ)”}”(hŒÿ"huc_fw": points to the FW code. On platforms that support load via DMA
and 2-step HuC authentication (i.e. MTL+) this is a full CSS-based binary,
while if the GSC is the one doing the load (which only happens on DG2)
this section only contains the uCode.”h]”hX  â€œhuc_fwâ€: points to the FW code. On platforms that support load via DMA
and 2-step HuC authentication (i.e. MTL+) this is a full CSS-based binary,
while if the GSC is the one doing the load (which only happens on DG2)
this section only contains the uCode.”…””}”(hjË  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KghjÇ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj¬  ubeh}”(h]”h ]”h"]”h$]”h&]”j‰  jŠ  j‹  hjŒ  j  uh1j  hhÉhžhhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h NubhÛ)”}”(hŒ3The GSC-based HuC firmware layout looks like this::”h]”hŒ2The GSC-based HuC firmware layout looks like this:”…””}”(hjç  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KlhhÉhžhubhì)”}”(hXÓ  +================================================+
|  CPD Header                                    |
+================================================+
|  CPD entries[]                                 |
|      entry1                                    |
|      ...                                       |
|      entryX                                    |
|          "HUCP.man"                            |
|           ...                                  |
|           offset  >----------------------------|------o
|      ...                                       |      |
|      entryY                                    |      |
|          "huc_fw"                              |      |
|           ...                                  |      |
|           offset  >----------------------------|----------o
+================================================+      |   |
                                                        |   |
+================================================+      |   |
|  Manifest Header                               |<-----o   |
|      ...                                       |          |
|      FW version                                |          |
|      ...                                       |          |
+================================================+          |
                                                            |
+================================================+          |
|  FW binary                                     |<---------o
|      CSS (MTL+ only)                           |
|      uCode                                     |
|      RSA Key (MTL+ only)                       |
|      ...                                       |
+================================================+”h]”hXÓ  +================================================+
|  CPD Header                                    |
+================================================+
|  CPD entries[]                                 |
|      entry1                                    |
|      ...                                       |
|      entryX                                    |
|          "HUCP.man"                            |
|           ...                                  |
|           offset  >----------------------------|------o
|      ...                                       |      |
|      entryY                                    |      |
|          "huc_fw"                              |      |
|           ...                                  |      |
|           offset  >----------------------------|----------o
+================================================+      |   |
                                                        |   |
+================================================+      |   |
|  Manifest Header                               |<-----o   |
|      ...                                       |          |
|      FW version                                |          |
|      ...                                       |          |
+================================================+          |
                                                            |
+================================================+          |
|  FW binary                                     |<---------o
|      CSS (MTL+ only)                           |
|      uCode                                     |
|      RSA Key (MTL+ only)                       |
|      ...                                       |
+================================================+”…””}”hjö  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hëhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KnhhÉhžhubhÛ)”}”(hX†  The GSC binary starts instead with a layout header, which contains the
locations of the various partitions of the binary. The one we're interested
in is the boot1 partition, where we can find a BPDT header followed by
entries, one of which points to the RBE sub-section of the partition, which
contains the CPD. The GSC blob does not contain a CSS-based binary, so we
only need to look for the manifest, which is under the "RBEP.man" CPD entry.
Note that we have no need to find where the actual FW code is inside the
image because the GSC ROM will itself parse the headers to find it and load
it.
The GSC firmware header layout looks like this::”h]”hX‹  The GSC binary starts instead with a layout header, which contains the
locations of the various partitions of the binary. The one weâ€™re interested
in is the boot1 partition, where we can find a BPDT header followed by
entries, one of which points to the RBE sub-section of the partition, which
contains the CPD. The GSC blob does not contain a CSS-based binary, so we
only need to look for the manifest, which is under the â€œRBEP.manâ€ CPD entry.
Note that we have no need to find where the actual FW code is inside the
image because the GSC ROM will itself parse the headers to find it and load
it.
The GSC firmware header layout looks like this:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h KŽhhÉhžhubhì)”}”(hXu  +================================================+
|  Layout Pointers                               |
|      ...                                       |
|      Boot1 offset  >---------------------------|------o
|      ...                                       |      |
+================================================+      |
                                                        |
+================================================+      |
|  BPDT header                                   |<-----o
+================================================+
|  BPDT entries[]                                |
|      entry1                                    |
|      ...                                       |
|      entryX                                    |
|          type == GSC_RBE                       |
|          offset  >-----------------------------|------o
|      ...                                       |      |
+================================================+      |
                                                        |
+================================================+      |
|  CPD Header                                    |<-----o
+================================================+
|  CPD entries[]                                 |
|      entry1                                    |
|      ...                                       |
|      entryX                                    |
|          "RBEP.man"                            |
|           ...                                  |
|           offset  >----------------------------|------o
|      ...                                       |      |
+================================================+      |
                                                        |
+================================================+      |
| Manifest Header                                |<-----o
|  ...                                           |
|  FW version                                    |
|  ...                                           |
|  Security version                              |
|  ...                                           |
+================================================+”h]”hXu  +================================================+
|  Layout Pointers                               |
|      ...                                       |
|      Boot1 offset  >---------------------------|------o
|      ...                                       |      |
+================================================+      |
                                                        |
+================================================+      |
|  BPDT header                                   |<-----o
+================================================+
|  BPDT entries[]                                |
|      entry1                                    |
|      ...                                       |
|      entryX                                    |
|          type == GSC_RBE                       |
|          offset  >-----------------------------|------o
|      ...                                       |      |
+================================================+      |
                                                        |
+================================================+      |
|  CPD Header                                    |<-----o
+================================================+
|  CPD entries[]                                 |
|      entry1                                    |
|      ...                                       |
|      entryX                                    |
|          "RBEP.man"                            |
|           ...                                  |
|           offset  >----------------------------|------o
|      ...                                       |      |
+================================================+      |
                                                        |
+================================================+      |
| Manifest Header                                |<-----o
|  ...                                           |
|  FW version                                    |
|  ...                                           |
|  Security version                              |
|  ...                                           |
+================================================+”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hëhŸŒd/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:13: ./drivers/gpu/drm/xe/xe_uc_fw_abi.h”h K™hhÉhžhubeh}”(h]”Œfirmware-layout”ah ]”h"]”Œfirmware layout”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒ2Write Once Protected Content Memory (WOPCM) Layout”h]”hŒ2Write Once Protected Content Memory (WOPCM) Layout”…””}”(hj.  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj+  hžhhŸh³h KubhÛ)”}”(hŒÜThe layout of the WOPCM will be fixed after writing to GuC WOPCM size and
offset registers whose values are calculated and determined by HuC/GuC
firmware size and set of hardware requirements/restrictions as shown below:”h]”hŒÜThe layout of the WOPCM will be fixed after writing to GuC WOPCM size and
offset registers whose values are calculated and determined by HuC/GuC
firmware size and set of hardware requirements/restrictions as shown below:”…””}”(hj<  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒ`/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:19: ./drivers/gpu/drm/xe/xe_wopcm.c”h Khj+  hžhubhì)”}”(hX    +=========> +====================+ <== WOPCM Top
  ^           |  HW contexts RSVD  |
  |     +===> +====================+ <== GuC WOPCM Top
  |     ^     |                    |
  |     |     |                    |
  |     |     |                    |
  |    GuC    |                    |
  |   WOPCM   |                    |
  |    Size   +--------------------+
WOPCM   |     |    GuC FW RSVD     |
  |     |     +--------------------+
  |     |     |   GuC Stack RSVD   |
  |     |     +------------------- +
  |     v     |   GuC WOPCM RSVD   |
  |     +===> +====================+ <== GuC WOPCM base
  |           |     WOPCM RSVD     |
  |           +------------------- + <== HuC Firmware Top
  v           |      HuC FW        |
  +=========> +====================+ <== WOPCM Base”h]”hX    +=========> +====================+ <== WOPCM Top
  ^           |  HW contexts RSVD  |
  |     +===> +====================+ <== GuC WOPCM Top
  |     ^     |                    |
  |     |     |                    |
  |     |     |                    |
  |    GuC    |                    |
  |   WOPCM   |                    |
  |    Size   +--------------------+
WOPCM   |     |    GuC FW RSVD     |
  |     |     +--------------------+
  |     |     |   GuC Stack RSVD   |
  |     |     +------------------- +
  |     v     |   GuC WOPCM RSVD   |
  |     +===> +====================+ <== GuC WOPCM base
  |           |     WOPCM RSVD     |
  |           +------------------- + <== HuC Firmware Top
  v           |      HuC FW        |
  +=========> +====================+ <== WOPCM Base”…””}”hjK  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hëhŸŒ`/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:19: ./drivers/gpu/drm/xe/xe_wopcm.c”h Khj+  hžhubhÛ)”}”(hŒ˜GuC accessible WOPCM starts at GuC WOPCM base and ends at GuC WOPCM top.
The top part of the WOPCM is reserved for hardware contexts (e.g. RC6
context).”h]”hŒ˜GuC accessible WOPCM starts at GuC WOPCM base and ends at GuC WOPCM top.
The top part of the WOPCM is reserved for hardware contexts (e.g. RC6
context).”…””}”(hjZ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒ`/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:19: ./drivers/gpu/drm/xe/xe_wopcm.c”h K,hj+  hžhubeh}”(h]”Œ0write-once-protected-content-memory-wopcm-layout”ah ]”h"]”Œ2write once protected content memory (wopcm) layout”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒGuC CTB Blob”h]”hŒGuC CTB Blob”…””}”(hjt  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjq  hžhhŸh³h KubhÛ)”}”(hŒAWe allocate single blob to hold both CTB descriptors and buffers:”h]”hŒAWe allocate single blob to hold both CTB descriptors and buffers:”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h Kzhjq  hžhubhŒblock_quote”“”)”}”(hXZ  +--------+-----------------------------------------------+------+
| offset | contents                                      | size |
+========+===============================================+======+
| 0x0000 | H2G CTB Descriptor (send)                     |      |
+--------+-----------------------------------------------+  4K  |
| 0x0800 | G2H CTB Descriptor (g2h)                      |      |
+--------+-----------------------------------------------+------+
| 0x1000 | H2G CT Buffer (send)                          | n*4K |
|        |                                               |      |
+--------+-----------------------------------------------+------+
| 0x1000 | G2H CT Buffer (g2h)                           | m*4K |
| + n*4K |                                               |      |
+--------+-----------------------------------------------+------+
”h]”hŒtable”“”)”}”(hhh]”hŒtgroup”“”)”}”(hhh]”(hŒcolspec”“”)”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j¡  hjž  ubj¢  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K/uh1j¡  hjž  ubj¢  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j¡  hjž  ubhŒthead”“”)”}”(hhh]”hŒrow”“”)”}”(hhh]”(hŒentry”“”)”}”(hhh]”hÛ)”}”(hŒoffset”h]”hŒoffset”…””}”(hjÐ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h K}hjÍ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hjÈ  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒcontents”h]”hŒcontents”…””}”(hjè  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸjÞ  h K}hjå  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hjÈ  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒsize”h]”hŒsize”…””}”(hjÿ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸjÞ  h K}hjü  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hjÈ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjÃ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÁ  hjž  ubhŒtbody”“”)”}”(hhh]”(jÇ  )”}”(hhh]”(jÌ  )”}”(hhh]”hÛ)”}”(hŒ0x0000”h]”hŒ0x0000”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h Khj'  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hj$  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒH2G CTB Descriptor (send)”h]”hŒH2G CTB Descriptor (send)”…””}”(hjB  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸj8  h Khj?  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hj$  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒ4K”h]”hŒ4K”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h K€hjV  ubah}”(h]”h ]”h"]”h$]”h&]”Œmorerows”Kuh1jË  hj$  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj!  ubjÇ  )”}”(hhh]”(jÌ  )”}”(hhh]”hÛ)”}”(hŒ0x0800”h]”hŒ0x0800”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h Khjx  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hju  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒG2H CTB Descriptor (g2h)”h]”hŒG2H CTB Descriptor (g2h)”…””}”(hj“  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸj‰  h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hju  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj!  ubjÇ  )”}”(hhh]”(jÌ  )”}”(hhh]”hÛ)”}”(hŒ0x1000”h]”hŒ0x1000”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h Kƒhj°  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hj­  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒH2G CT Buffer (send)”h]”hŒH2G CT Buffer (send)”…””}”(hjË  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸjÁ  h KƒhjÈ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hj­  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒn*4K”h]”hŒn*4K”…””}”(hjâ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸjÁ  h Kƒhjß  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hj­  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj!  ubjÇ  )”}”(hhh]”(jÌ  )”}”(hhh]”hÛ)”}”(hŒ0x1000
+ n*4K”h]”hŒ0x1000
+ n*4K”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h K†hjÿ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hjü  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒG2H CT Buffer (g2h)”h]”hŒG2H CT Buffer (g2h)”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸj  h K†hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hjü  ubjÌ  )”}”(hhh]”hÛ)”}”(hŒm*4K”h]”hŒm*4K”…””}”(hj1  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸj  h K†hj.  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jË  hjü  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj!  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j  hjž  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1jœ  hj™  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j—  hj“  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j‘  hŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h K|hjq  hžhubhÛ)”}”(hX¬  Size of each ``CT Buffer`` must be multiple of 4K.
We don't expect too many messages in flight at any time, unless we are
using the GuC submission. In that case each request requires a minimum
2 dwords which gives us a maximum 256 queue'd requests. Hopefully this
enough space to avoid backpressure on the driver. We increase the size
of the receive buffer (relative to the send) to ensure a G2H response
CTB has a landing spot.”h]”(hŒSize of each ”…””}”(hje  hžhhŸNh NubhŒliteral”“”)”}”(hŒ``CT Buffer``”h]”hŒ	CT Buffer”…””}”(hjo  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jm  hje  ubhX–   must be multiple of 4K.
We donâ€™t expect too many messages in flight at any time, unless we are
using the GuC submission. In that case each request requires a minimum
2 dwords which gives us a maximum 256 queueâ€™d requests. Hopefully this
enough space to avoid backpressure on the driver. We increase the size
of the receive buffer (relative to the send) to ensure a G2H response
CTB has a landing spot.”…””}”(hje  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h KŠhjq  hžhubhÛ)”}”(hXÛ  In addition to submissions, the G2H buffer needs to be able to hold
enough space for recoverable page fault notifications. The number of
page faults is interrupt driven and can be as much as the number of
compute resources available. However, most of the actual work for these
is in a separate page fault worker thread. Therefore we only need to
make sure the queue has enough space to handle all of the submissions
and responses and an extra buffer for incoming page faults.”h]”hXÛ  In addition to submissions, the G2H buffer needs to be able to hold
enough space for recoverable page fault notifications. The number of
page faults is interrupt driven and can be as much as the number of
compute resources available. However, most of the actual work for these
is in a separate page fault worker thread. Therefore we only need to
make sure the queue has enough space to handle all of the submissions
and responses and an extra buffer for incoming page faults.”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:25: ./drivers/gpu/drm/xe/xe_guc_ct.c”h K’hjq  hžhubeh}”(h]”Œguc-ctb-blob”ah ]”h"]”Œguc ctb blob”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒGuC Power Conservation (PC)”h]”hŒGuC Power Conservation (PC)”…””}”(hj¢  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjŸ  hžhhŸh³h KubhÛ)”}”(hŒòGuC Power Conservation (PC) supports multiple features for the most
efficient and performing use of the GT when GuC submission is enabled,
including frequency management, Render-C states management, and various
algorithms for power balancing.”h]”hŒòGuC Power Conservation (PC) supports multiple features for the most
efficient and performing use of the GT when GuC submission is enabled,
including frequency management, Render-C states management, and various
algorithms for power balancing.”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:31: ./drivers/gpu/drm/xe/xe_guc_pc.c”h K;hjŸ  hžhubhÛ)”}”(hŒÔSingle Loop Power Conservation (SLPC) is the name given to the suite of
connected power conservation features in the GuC firmware. The firmware
exposes a programming interface to the host for the control of SLPC.”h]”hŒÔSingle Loop Power Conservation (SLPC) is the name given to the suite of
connected power conservation features in the GuC firmware. The firmware
exposes a programming interface to the host for the control of SLPC.”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸŒa/var/lib/git/docbuild/linux/Documentation/gpu/xe/xe_firmware:31: ./drivers/gpu/drm/xe/xe_guc_pc.c”h K@hjŸ  hžhubeh}”(h]”Œguc-power-conservation-pc”ah ]”h"]”Œguc power conservation (pc)”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒInternal API”h]”hŒInternal API”…””}”(hjÙ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÖ  hžhhŸh³h K#ubhÛ)”}”(hŒTODO”h]”hŒTODO”…””}”(hjç  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÚhŸh³h K%hjÖ  hžhubeh}”(h]”Œinternal-api”ah ]”h"]”Œinternal api”ah$]”h&]”uh1h´hh¶hžhhŸh³h K#ubeh}”(h]”Œfirmware”ah ]”h"]”Œfirmware”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”jË  Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j'  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j  jÿ  j(  j%  jn  jk  jœ  j™  jÓ  jÐ  jú  j÷  uŒ	nametypes”}”(j  ‰j(  ‰jn  ‰jœ  ‰jÓ  ‰jú  ‰uh}”(jÿ  h¶j%  hÉjk  j+  j™  jq  jÐ  jŸ  j÷  jÖ  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.