| Message ID | 20190725141308.24660-2-michal.wajdeczko@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2,1/3] drm/i915: Fix GuC documentation links | expand |
On 7/25/19 7:13 AM, Michal Wajdeczko wrote: > Sphinx was rendering firmware layout as html table, but since > we want to add sizes relations switch to plain text graphics. > > v2: also update text and do it before move (Daniele) > > Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> > Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> Reviewed-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> > --- > Documentation/gpu/i915.rst | 12 ++++---- > drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h | 31 ++++++++++----------- > 2 files changed, 20 insertions(+), 23 deletions(-) > > diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst > index c2173d120492..3e233f9d675f 100644 > --- a/Documentation/gpu/i915.rst > +++ b/Documentation/gpu/i915.rst > @@ -430,6 +430,12 @@ WOPCM Layout > GuC > === > > +Firmware Layout > +------------------- > + > +.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h > + :doc: Firmware Layout > + > GuC-specific firmware loader > ---------------------------- > > @@ -445,12 +451,6 @@ GuC-based command submission > .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c > :internal: > > -GuC Firmware Layout > -------------------- > - > -.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h > - :doc: GuC Firmware Layout > - > GuC Address Space > ----------------- > > diff --git a/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h b/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h > index 30cca3a29323..108b386c52ec 100644 > --- a/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h > +++ b/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h > @@ -122,23 +122,20 @@ > #define GUC_CTL_MAX_DWORDS (SOFT_SCRATCH_COUNT - 2) /* [1..14] */ > > /** > - * DOC: GuC Firmware Layout > + * DOC: Firmware Layout > * > - * The GuC firmware layout looks like this: > + * The GuC/HuC firmware layout looks like this:: > * > - * +-------------------------------+ > - * | uc_css_header | > - * | | > - * | contains major/minor version | > - * +-------------------------------+ > - * | uCode | > - * +-------------------------------+ > - * | RSA signature | > - * +-------------------------------+ > - * | modulus key | > - * +-------------------------------+ > - * | exponent val | > - * +-------------------------------+ > + * +======================================================================+ > + * | Firmware blob | > + * +===============+===============+============+============+============+ > + * | CSS header | uCode | RSA key | modulus | exponent | > + * +===============+===============+============+============+============+ > + * <-header size-> <---header size continued -----------> > + * <--- size -----------------------------------------------------------> > + * <-key size-> > + * <-mod size-> > + * <-exp size-> > * > * 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. > @@ -155,8 +152,8 @@ > * 4. 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. > * > - * HuC firmware layout is same as GuC firmware. > - * Only HuC version information is saved in a different way. > + * The only difference between GuC and HuC firmwares is how the version > + * information is saved. > */ > > struct uc_css_header { >
Quoting Daniele Ceraolo Spurio (2019-07-25 21:16:23) > > > On 7/25/19 7:13 AM, Michal Wajdeczko wrote: > > Sphinx was rendering firmware layout as html table, but since > > we want to add sizes relations switch to plain text graphics. > > > > v2: also update text and do it before move (Daniele) > > > > Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> > > Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> > > Reviewed-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> And pushed, thanks for the fixes and updates. -Chris
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst index c2173d120492..3e233f9d675f 100644 --- a/Documentation/gpu/i915.rst +++ b/Documentation/gpu/i915.rst @@ -430,6 +430,12 @@ WOPCM Layout GuC === +Firmware Layout +------------------- + +.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h + :doc: Firmware Layout + GuC-specific firmware loader ---------------------------- @@ -445,12 +451,6 @@ GuC-based command submission .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c :internal: -GuC Firmware Layout -------------------- - -.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h - :doc: GuC Firmware Layout - GuC Address Space ----------------- diff --git a/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h b/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h index 30cca3a29323..108b386c52ec 100644 --- a/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h +++ b/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h @@ -122,23 +122,20 @@ #define GUC_CTL_MAX_DWORDS (SOFT_SCRATCH_COUNT - 2) /* [1..14] */ /** - * DOC: GuC Firmware Layout + * DOC: Firmware Layout * - * The GuC firmware layout looks like this: + * The GuC/HuC firmware layout looks like this:: * - * +-------------------------------+ - * | uc_css_header | - * | | - * | contains major/minor version | - * +-------------------------------+ - * | uCode | - * +-------------------------------+ - * | RSA signature | - * +-------------------------------+ - * | modulus key | - * +-------------------------------+ - * | exponent val | - * +-------------------------------+ + * +======================================================================+ + * | Firmware blob | + * +===============+===============+============+============+============+ + * | CSS header | uCode | RSA key | modulus | exponent | + * +===============+===============+============+============+============+ + * <-header size-> <---header size continued -----------> + * <--- size -----------------------------------------------------------> + * <-key size-> + * <-mod size-> + * <-exp size-> * * 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. @@ -155,8 +152,8 @@ * 4. 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. * - * HuC firmware layout is same as GuC firmware. - * Only HuC version information is saved in a different way. + * The only difference between GuC and HuC firmwares is how the version + * information is saved. */ struct uc_css_header {
Sphinx was rendering firmware layout as html table, but since we want to add sizes relations switch to plain text graphics. v2: also update text and do it before move (Daniele) Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> --- Documentation/gpu/i915.rst | 12 ++++---- drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h | 31 ++++++++++----------- 2 files changed, 20 insertions(+), 23 deletions(-)