| Message ID | 20190724173446.35188-3-michal.wajdeczko@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/3] drm/i915: Fix GuC documentation links | expand |
On 7/24/19 10:34 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. > > Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> > Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> > --- > drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h | 25 +++++++++----------- > 1 file changed, 11 insertions(+), 14 deletions(-) > > diff --git a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h > index 3ca535534151..e25271aac765 100644 > --- a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h > +++ b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h > @@ -11,21 +11,18 @@ > /** > * DOC: GuC Firmware Layout > * > - * The GuC firmware layout looks like this: > + * The GuC firmware layout looks like this:: > * > - * +-------------------------------+ > - * | uc_css_header | > - * | | > - * | contains major/minor version | > - * +-------------------------------+ > - * | uCode | > - * +-------------------------------+ > - * | RSA signature | > - * +-------------------------------+ > - * | modulus key | > - * +-------------------------------+ > - * | exponent val | > - * +-------------------------------+ > + * +======================================================================+ > + * | Firmware blob | > + * +===============+===============+============+============+============+ > + * | CSS header | uCode | key | modulus | exponent | > + * +===============+===============+============+============+============+ What about the RSA? Daniele > + * <-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. >
On Wed, 24 Jul 2019 19:44:46 +0200, Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> wrote: > > > On 7/24/19 10:34 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. >> Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> >> Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> >> --- >> drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h | 25 +++++++++----------- >> 1 file changed, 11 insertions(+), 14 deletions(-) >> diff --git a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >> b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >> index 3ca535534151..e25271aac765 100644 >> --- a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >> +++ b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >> @@ -11,21 +11,18 @@ >> /** >> * DOC: GuC Firmware Layout >> * >> - * The GuC firmware layout looks like this: >> + * The GuC firmware layout looks like this:: >> * >> - * +-------------------------------+ >> - * | uc_css_header | >> - * | | >> - * | contains major/minor version | >> - * +-------------------------------+ >> - * | uCode | >> - * +-------------------------------+ >> - * | RSA signature | >> - * +-------------------------------+ >> - * | modulus key | >> - * +-------------------------------+ >> - * | exponent val | >> - * +-------------------------------+ >> + * >> +======================================================================+ >> + * | Firmware >> blob | >> + * >> +===============+===============+============+============+============+ >> + * | CSS header | uCode | key | modulus | >> exponent | >> + * >> +===============+===============+============+============+============+ > > What about the RSA? key == RSA key == RSA signature I followed notation from our header definition which uses "key_size" but maybe it was too brave. What about "RSA key" to have a match ? > > Daniele > >> + * <-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.
On 7/24/19 1:09 PM, Michal Wajdeczko wrote: > On Wed, 24 Jul 2019 19:44:46 +0200, Daniele Ceraolo Spurio > <daniele.ceraolospurio@intel.com> wrote: > >> >> >> On 7/24/19 10:34 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. >>> Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> >>> Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> >>> --- >>> drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h | 25 +++++++++----------- >>> 1 file changed, 11 insertions(+), 14 deletions(-) >>> diff --git a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >>> b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >>> index 3ca535534151..e25271aac765 100644 >>> --- a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >>> +++ b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h >>> @@ -11,21 +11,18 @@ >>> /** >>> * DOC: GuC Firmware Layout >>> * >>> - * The GuC firmware layout looks like this: >>> + * The GuC firmware layout looks like this:: >>> * >>> - * +-------------------------------+ >>> - * | uc_css_header | >>> - * | | >>> - * | contains major/minor version | >>> - * +-------------------------------+ >>> - * | uCode | >>> - * +-------------------------------+ >>> - * | RSA signature | >>> - * +-------------------------------+ >>> - * | modulus key | >>> - * +-------------------------------+ >>> - * | exponent val | >>> - * +-------------------------------+ >>> + * >>> +======================================================================+ >>> + * | Firmware >>> blob | >>> + * >>> +===============+===============+============+============+============+ >>> + * | CSS header | uCode | key | modulus | >>> exponent | >>> + * >>> +===============+===============+============+============+============+ >> >> What about the RSA? > > key == RSA key == RSA signature > > I followed notation from our header definition which uses "key_size" > but maybe it was too brave. What about "RSA key" to have a match ? > Works for me. Daniele >> >> Daniele >> >>> + * <-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.
diff --git a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h index 3ca535534151..e25271aac765 100644 --- a/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h +++ b/drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h @@ -11,21 +11,18 @@ /** * DOC: GuC Firmware Layout * - * The GuC firmware layout looks like this: + * The GuC firmware layout looks like this:: * - * +-------------------------------+ - * | uc_css_header | - * | | - * | contains major/minor version | - * +-------------------------------+ - * | uCode | - * +-------------------------------+ - * | RSA signature | - * +-------------------------------+ - * | modulus key | - * +-------------------------------+ - * | exponent val | - * +-------------------------------+ + * +======================================================================+ + * | Firmware blob | + * +===============+===============+============+============+============+ + * | CSS header | uCode | 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.
Sphinx was rendering firmware layout as html table, but since we want to add sizes relations switch to plain text graphics. Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> --- drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h | 25 +++++++++----------- 1 file changed, 11 insertions(+), 14 deletions(-)