[PATCH] Documentation/gpu: Add acronyms for some firmware components

[Alex Deucher]

On Fri, Feb 14, 2025 at 6:38 PM Rodrigo Siqueira <siqueira at igalia.com> wrote:
>
> On 02/14, Alex Deucher wrote:
> > On Fri, Feb 14, 2025 at 6:00 PM Rodrigo Siqueira <siqueira at igalia.com> wrote:
> > >
> > > Users can check the file "/sys/kernel/debug/dri/0/amdgpu_firmware_info"
> > > to get information on the firmware loaded in the system. This file has
> > > multiple acronyms that are not documented in the glossary. This commit
> > > introduces some missing acronyms to the AMD glossary documentation. The
> > > meaning of each acronym in this commit was extracted from code
> > > documentation available in the following files:
> > >
> > > - drivers/gpu/drm/amd/amdgpu/gfx_v7_0.c
> > > - drivers/gpu/drm/amd/include/amd_shared.h
> > >
> > > Cc: Mario Limonciello <mario.limonciello at amd.com>
> > > Signed-off-by: Rodrigo Siqueira <siqueira at igalia.com>
> > > ---
> > >  Documentation/gpu/amdgpu/amdgpu-glossary.rst | 21 ++++++++++++++++++++
> > >  1 file changed, 21 insertions(+)
> > >
> > > diff --git a/Documentation/gpu/amdgpu/amdgpu-glossary.rst b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> > > index 00a47ebb0b0f..3242db32b020 100644
> > > --- a/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> > > +++ b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> > > @@ -12,6 +12,9 @@ we have a dedicated glossary for Display Core at
> > >        The number of CUs that are active on the system.  The number of active
> > >        CUs may be less than SE * SH * CU depending on the board configuration.
> > >
> > > +    CE
> > > +      Constant Engine
> > > +
> > >      CP
> > >        Command Processor
> > >
> > > @@ -80,6 +83,9 @@ we have a dedicated glossary for Display Core at
> > >      KIQ
> > >        Kernel Interface Queue
> > >
> > > +    ME
> > > +      Micro Engine
> >
> > This is part of Graphics so maybe something like:
> >
> > ME
> >     MicroEngine (Graphics)
> >
> > > +
> > >      MEC
> > >        MicroEngine Compute
> > >
> > > @@ -92,6 +98,9 @@ we have a dedicated glossary for Display Core at
> > >      MQD
> > >        Memory Queue Descriptor
> > >
> > > +    PFP
> > > +      Pre-Fetch Parser
> >
> > This is also part of GFX.
> >
> > PFP
> > Pre-Fetch Parser (Graphics)
> >
> > > +
> > >      PPLib
> > >        PowerPlay Library - PowerPlay is the power management component.
> > >
> > > @@ -110,14 +119,26 @@ we have a dedicated glossary for Display Core at
> > >      SH
> > >        SHader array
> > >
> > > +    SMC
> > > +      System Management Controller
> > > +
> > >      SMU
> > >        System Management Unit
> >
> > These two are synonyms.
> >
> > How about
> > SMU / SMC
> > System Management Unit / System Management Controller
> >
> > Other than that, looks good.
> >
>
> Thanks a lot for all the suggestions; I'll make those changes for the
> V2.
>
> btw, from the amdgpu_firmware_info, I did not find the meaning of the
> below acronyms, could you help me with that?
>
> MC

Memory Controller

> SRL(C|G|S)

RLC = RunList Controller
The name is a remnant of ages past and doesn't really have much
meaning today.  It's a group of general purpose helper engines for the
GFX block.  It's involved in GFX power management and SR-IOV among
other things.

SRLC = SAVE/RESTORE LIST CNTL
SRLG = SAVE/RESTORE LIST GPM_MEM
SRLS = SAVE/RESTORE LIST SRM_MEM


> IMU

Integrated Management Unit

Another engine which helps with power management tasks.

> ASD

I can't remember what this stands for off hand.  Will need to look it up.

> TOC

Table of Contents

>
> Thanks
> Siqueira
>
> > Alex
> >
> > >
> > >      SS
> > >        Spread Spectrum
> > >
> > > +    TA
> > > +      Trusted Application
> > > +
> > > +    UVD
> > > +      Unified Video Decoder
> > > +
> > >      VCE
> > >        Video Compression Engine
> > >
> > >      VCN
> > >        Video Codec Next
> > > +
> > > +    VPE
> > > +      Video Processing Engine
> > > --
> > > 2.48.1
> > >