On Mon, Nov 29, 2021 at 3:48 PM <ydirson@xxxxxxx> wrote: > > Hi Rodrigo, > > That will really be helpful! > > I know drawing the line is a difficult problem (and can even make things > harder when searching), but maybe it would make sense to keep generic > acronyms not specific to amdgpu in a separate list. I bet a number of > them would be useful in the scope of other drm drivers (e.g. CRTC, DCC, > MST), and some are not restricted to the drm subsystem at all (e.g. FEC, > LUT), but still have value as not necessarily easy to look up. > > Maybe "DC glossary" should just be "Glossary", since quite some entries > help to read adm/amdgpu/ too. Which brings me to the result of my recent > searches as suggested entries: > > KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware > queue descriptor), EOP (still no clue :) > > Maybe some more specific ones just to be spelled out in clear where they > are used ? KCQ (compute queue?), KGQ (gfx queue?) Kernel Compute Queue and Kernel Graphics Queue. Alex > > More suggestions inlined. > > Best regards, > -- > Yann > > > On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira > > <Rodrigo.Siqueira@xxxxxxx> wrote: > > > > > > In the DC driver, we have multiple acronyms that are not obvious > > > most of > > > the time. This commit introduces a DC glossary in order to make it > > > easier to navigate through our driver. > > > > > > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@xxxxxxx> > > > --- > > > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +- > > > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 > > > ++++++++++++++++++++ > > > 2 files changed, 258 insertions(+), 1 deletion(-) > > > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst > > > > > > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > > > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > > > index 2e45e83d9a2a..15405c43786a 100644 > > > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > > > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > > > @@ -26,4 +26,4 @@ table of content: > > > amdgpu-dcn-overview.rst > > > amdgpu-dm.rst > > > amdgpu-dc-debug.rst > > > - > > > + dc-glossary.rst > > > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst > > > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst > > > new file mode 100644 > > > index 000000000000..48698fc1799f > > > --- /dev/null > > > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst > > > @@ -0,0 +1,257 @@ > > > +=========== > > > +DC Glossary > > > +=========== > > > + > > > +.. 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 > > > + * CPLIB: Content Protection Library > > > > CPLIB is not a clock. It should be split out as its own item. > > > > > + > > > + 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 > > I recall this as the old name for DC, maybe this should be mentioned ? > > > > + > > > + 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 > > > + > > > + DFS > > > + Digital Frequency Synthesizer > > > + > > > + 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 > > > > Make Micro Controller vs. Micro-Controller consistent for these. > > > > > + > > > + DPCD > > > + DisplayPort Configuration Data > > > + > > > + DPM(S) > > > + Display Power Management (Signaling) > > > + > > > + DRR > > > + Dynamic Refresh Rate > > > + > > > + DWB > > > + Display writeback > > > + > > > + ECP > > > + Enhanced Content Protection > > > + > > > + 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 > > > + > > > + PPLib > > > + PowerPlay Library > > > > Maybe say that powerplay is the power management component. > > > > > + > > > + PSR > > > + Panel Self Refresh > > > + > > > + SCL > > > + Scaler > > > + > > > + SDP > > > + Scalable Data Port > > > + > > > + SMU > > > + System Management Unit > > > + > > > + 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 > > > + > > > + VCE > > > + Video Compression Engine > > > + > > > + VCN > > > + Video Codec Next > > > -- > > > 2.25.1 > > > > >
