[PATCH v2 6/6] Documentation/gpu: Add amdgpu and dc glossary

Yann Dirson ydirson at free.fr
Wed Dec 8 16:16:25 UTC 2021


Hi Rodrigo,

> On 2021-12-07 2:49 p.m., Yann Dirson wrote:
> > 
> >> On Thu, Dec 02, 2021 at 11:01:32AM -0500, Rodrigo Siqueira wrote:
> >>> In the DC driver, we have multiple acronyms that are not obvious
> >>> most of
> >>> the time; the same idea is valid for amdgpu. This commit
> >>> introduces
> >>> a DC
> >>> and amdgpu glossary in order to make it easier to navigate
> >>> through
> >>> our
> >>> driver.
> >>>
> >>> Changes since V1:
> >>>   - Yann: Divide glossary based on driver context.
> >>>   - Alex: Make terms more consistent and update CPLIB
> >>>   - Add new acronyms to the glossary
> > 
> > If you're rerolling, it could be a good time to include the
> > additional
> > (and detailed) entries from Alex's answer to "Looking for
> > clarifications
> > around gfx/kcq/kiq".  Finding a way to fit the other details not
> > fitting directly in the glossary will likely take more rounds,
> > though,
> > so we can wait for the first round to be merged before dealing with
> > them.
> 
> Hi Yann,
> 
> I will send another version to address Daniel's comment, and I'll
> also
> expand the amdgpu acronyms glossary based on your mail thread with
> Alex.
> However, I don't want to add more details about that discussion in
> this
> series because I don't want to lose focus in this patchset since my
> main
> goal is to start to expand display documentation.

fair enough


> By the way, I think you could consider writing a kernel-doc based on
> your discussion with Alex. This way, you can try to consolidate what
> you
> discover and get reviews in the content.

that's the idea, though I'm not sure I have enough material to start with
yet :)

> 
> Thanks
> Siqueira
> 
> > 
> > 
> >>>
> >>> Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>
> >>> ---
> >>>   Documentation/gpu/amdgpu/amdgpu-glossary.rst  |  47 ++++
> >>>   .../gpu/amdgpu/display/dc-glossary.rst        | 243
> >>>   ++++++++++++++++++
> >>>   Documentation/gpu/amdgpu/display/index.rst    |   1 +
> >>>   Documentation/gpu/amdgpu/index.rst            |   7 +
> >>>   4 files changed, 298 insertions(+)
> >>>   create mode 100644 Documentation/gpu/amdgpu/amdgpu-glossary.rst
> >>>   create mode 100644
> >>>   Documentation/gpu/amdgpu/display/dc-glossary.rst
> >>>
> >>> diff --git a/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> >>> b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> >>> new file mode 100644
> >>> index 000000000000..e635851025e7
> >>> --- /dev/null
> >>> +++ b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> >>> @@ -0,0 +1,47 @@
> >>> +===============
> >>> +AMDGPU Glossary
> >>> +===============
> >>> +
> >>> +Here you can find some generic acronyms used in the amdgpu
> >>> driver.
> >>> Notice that
> >>> +we have a dedicated glossary for Display Core.
> >>
> >> Maybe add a link to that here so it's easier to find? sphinx
> >> autogenerates
> >> header targets so pretty easy (if the heading is unique at least).
> >> -Daniel
> >>
> >>> +
> >>> +.. glossary::
> >>> +
> >>> +    CPLIB
> >>> +      Content Protection Library
> >>> +
> >>> +    DFS
> >>> +      Digital Frequency Synthesizer
> >>> +
> >>> +    ECP
> >>> +      Enhanced Content Protection
> >>> +
> >>> +    EOP
> >>> +      End Of Pipe/Pipeline
> >>> +
> >>> +    HQD
> >>> +      Hardware Queue Descriptor
> >>> +
> >>> +    KCQ
> >>> +      Kernel Compute Queue
> >>> +
> >>> +    KGQ
> >>> +      Kernel Graphics Queue
> >>> +
> >>> +    KIQ
> >>> +      Kernel Interface Queue
> >>> +
> >>> +    MQD
> >>> +      Memory Queue Descriptor
> >>> +
> >>> +    PPLib
> >>> +      PowerPlay Library - PowerPlay is the power management
> >>> component.
> >>> +
> >>> +    SMU
> >>> +      System Management Unit
> >>> +
> >>> +    VCE
> >>> +      Video Compression Engine
> >>> +
> >>> +    VCN
> >>> +      Video Codec Next
> >>> diff --git a/Documentation/gpu/amdgpu/display/dc-glossary.rst
> >>> b/Documentation/gpu/amdgpu/display/dc-glossary.rst
> >>> new file mode 100644
> >>> index 000000000000..547c0bfbb3e2
> >>> --- /dev/null
> >>> +++ b/Documentation/gpu/amdgpu/display/dc-glossary.rst
> >>> @@ -0,0 +1,243 @@
> >>> +===========
> >>> +DC Glossary
> >>> +===========
> >>> +
> >>> +On this page, we try to keep track of acronyms related to the
> >>> display
> >>> +component. If you do not find what you are looking for, look at
> >>> the amdgpu
> >>> +glossary; if you cannot find it anywhere, consider asking in the
> >>> amdgfx and
> >>> +update this page.
> >>> +
> >>> +.. glossary::
> >>> +
> >>> +    ABM
> >>> +      Adaptive Backlight Modulation
> >>> +
> >>> +    APU
> >>> +      Accelerated Processing Unit
> >>> +
> >>> +    ASIC
> >>> +      Application-Specific Integrated Circuit
> >>> +
> >>> +    ASSR
> >>> +      Alternate Scrambler Seed Reset
> >>> +
> >>> +    AZ
> >>> +      Azalia (HD audio DMA engine)
> >>> +
> >>> +    BPC
> >>> +      Bits Per Colour/Component
> >>> +
> >>> +    BPP
> >>> +      Bits Per Pixel
> >>> +
> >>> +    Clocks
> >>> +      * PCLK: Pixel Clock
> >>> +      * SYMCLK: Symbol Clock
> >>> +      * SOCCLK: GPU Engine Clock
> >>> +      * DISPCLK: Display Clock
> >>> +      * DPPCLK: DPP Clock
> >>> +      * DCFCLK: Display Controller Fabric Clock
> >>> +      * REFCLK: Real Time Reference Clock
> >>> +      * PPLL: Pixel PLL
> >>> +      * FCLK: Fabric Clock
> >>> +      * MCLK: Memory Clock
> >>> +
> >>> +    CRC
> >>> +      Cyclic Redundancy Check
> >>> +
> >>> +    CRTC
> >>> +      Cathode Ray Tube Controller - commonly called "Controller"
> >>> -
> >>> Generates
> >>> +      raw stream of pixels, clocked at pixel clock
> >>> +
> >>> +    CVT
> >>> +      Coordinated Video Timings
> >>> +
> >>> +    DAL
> >>> +      Display Abstraction layer
> >>> +
> >>> +    DC (Software)
> >>> +      Display Core
> >>> +
> >>> +    DC (Hardware)
> >>> +      Display Controller
> >>> +
> >>> +    DCC
> >>> +      Delta Colour Compression
> >>> +
> >>> +    DCE
> >>> +      Display Controller Engine
> >>> +
> >>> +    DCHUB
> >>> +      Display Controller HUB
> >>> +
> >>> +    ARB
> >>> +      Arbiter
> >>> +
> >>> +    VTG
> >>> +      Vertical Timing Generator
> >>> +
> >>> +    DCN
> >>> +      Display Core Next
> >>> +
> >>> +    DCCG
> >>> +      Display Clock Generator block
> >>> +
> >>> +    DDC
> >>> +      Display Data Channel
> >>> +
> >>> +    DIO
> >>> +      Display IO
> >>> +
> >>> +    DPP
> >>> +      Display Pipes and Planes
> >>> +
> >>> +    DSC
> >>> +      Display Stream Compression (Reduce the amount of bits to
> >>> represent pixel
> >>> +      count while at the same pixel clock)
> >>> +
> >>> +    dGPU
> >>> +      discrete GPU
> >>> +
> >>> +    DMIF
> >>> +      Display Memory Interface
> >>> +
> >>> +    DML
> >>> +      Display Mode Library
> >>> +
> >>> +    DMCU
> >>> +      Display Micro-Controller Unit
> >>> +
> >>> +    DMCUB
> >>> +      Display Micro-Controller Unit, version B
> >>> +
> >>> +    DPCD
> >>> +      DisplayPort Configuration Data
> >>> +
> >>> +    DPM(S)
> >>> +      Display Power Management (Signaling)
> >>> +
> >>> +    DRR
> >>> +      Dynamic Refresh Rate
> >>> +
> >>> +    DWB
> >>> +      Display Writeback
> >>> +
> >>> +    FB
> >>> +      Frame Buffer
> >>> +
> >>> +    FBC
> >>> +      Frame Buffer Compression
> >>> +
> >>> +    FEC
> >>> +      Forward Error Correction
> >>> +
> >>> +    FRL
> >>> +      Fixed Rate Link
> >>> +
> >>> +    GCO
> >>> +      Graphical Controller Object
> >>> +
> >>> +    GMC
> >>> +      Graphic Memory Controller
> >>> +
> >>> +    GSL
> >>> +      Global Swap Lock
> >>> +
> >>> +    iGPU
> >>> +      integrated GPU
> >>> +
> >>> +    IH
> >>> +      Interrupt Handler
> >>> +
> >>> +    ISR
> >>> +      Interrupt Service Request
> >>> +
> >>> +    ISV
> >>> +      Independent Software Vendor
> >>> +
> >>> +    KMD
> >>> +      Kernel Mode Driver
> >>> +
> >>> +    LB
> >>> +      Line Buffer
> >>> +
> >>> +    LFC
> >>> +      Low Framerate Compensation
> >>> +
> >>> +    LTTPR
> >>> +      Link Training Tunable Phy Repeater
> >>> +
> >>> +    LUT
> >>> +      Lookup Table
> >>> +
> >>> +    MALL
> >>> +      Memory Access at Last Level
> >>> +
> >>> +    MC
> >>> +      Memory Controller
> >>> +
> >>> +    MPC
> >>> +      Multiple pipes and plane combine
> >>> +
> >>> +    MPO
> >>> +      Multi Plane Overlay
> >>> +
> >>> +    MST
> >>> +      Multi Stream Transport
> >>> +
> >>> +    NBP State
> >>> +      Northbridge Power State
> >>> +
> >>> +    NBIO
> >>> +      North Bridge Input/Output
> >>> +
> >>> +    ODM
> >>> +      Output Data Mapping
> >>> +
> >>> +    OPM
> >>> +      Output Protection Manager
> >>> +
> >>> +    OPP
> >>> +      Output Plane Processor
> >>> +
> >>> +    OPTC
> >>> +      Output Pipe Timing Combiner
> >>> +
> >>> +    OTG
> >>> +      Output Timing Generator
> >>> +
> >>> +    PCON
> >>> +      Power Controller
> >>> +
> >>> +    PGFSM
> >>> +      Power Gate Finite State Machine
> >>> +
> >>> +    PSR
> >>> +      Panel Self Refresh
> >>> +
> >>> +    SCL
> >>> +      Scaler
> >>> +
> >>> +    SDP
> >>> +      Scalable Data Port
> >>> +
> >>> +    SLS
> >>> +      Single Large Surface
> >>> +
> >>> +    SST
> >>> +      Single Stream Transport
> >>> +
> >>> +    TMDS
> >>> +      Transition-Minimized Differential Signaling
> >>> +
> >>> +    TMZ
> >>> +      Trusted Memory Zone
> >>> +
> >>> +    TTU
> >>> +      Time to Underflow
> >>> +
> >>> +    VRR
> >>> +      Variable Refresh Rate
> >>> +
> >>> +    UVD
> >>> +      Unified Video Decoder
> >>> diff --git a/Documentation/gpu/amdgpu/display/index.rst
> >>> b/Documentation/gpu/amdgpu/display/index.rst
> >>> index fe2ecad8df81..e23c752ee5f5 100644
> >>> --- a/Documentation/gpu/amdgpu/display/index.rst
> >>> +++ b/Documentation/gpu/amdgpu/display/index.rst
> >>> @@ -26,3 +26,4 @@ table of content:
> >>>      display-manager.rst
> >>>      dc-debug.rst
> >>>      dcn-overview.rst
> >>> +   dc-glossary.rst
> >>> diff --git a/Documentation/gpu/amdgpu/index.rst
> >>> b/Documentation/gpu/amdgpu/index.rst
> >>> index 5c8cbf514097..ff38c360b04e 100644
> >>> --- a/Documentation/gpu/amdgpu/index.rst
> >>> +++ b/Documentation/gpu/amdgpu/index.rst
> >>> @@ -334,3 +334,10 @@ smartshift_bias
> >>>   
> >>>   .. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
> >>>      :doc: smartshift_bias
> >>> +
> >>> +AMDGPU Glossary
> >>> +===============
> >>> +
> >>> +.. toctree::
> >>> +
> >>> +   amdgpu-glossary.rst
> >>> --
> >>> 2.25.1
> >>>
> >>
> >> --
> >> Daniel Vetter
> >> Software Engineer, Intel Corporation
> >> http://blog.ffwll.ch/>>>
> 
> 


More information about the amd-gfx mailing list