Commit 22554020 authored by Jani Nikula's avatar Jani Nikula Committed by Daniel Vetter

Documentation/gpu: use recommended order of heading markers

While splitting the document up, the headings "shifted" from what pandoc
generated. Use the following order for headings for consistency:

==============
Document title
==============

First
=====

Second
------

Third
~~~~~

Leave the lower level headings as they are; I think those are less
important. Although RST doesn't mandate a specific order ("Rather than
imposing a fixed number and order of section title adornment styles, the
order enforced will be the order as encountered."), having the higher
levels the same overall makes it easier to follow the documents.

[I'm sort of kind of writing the recommendation for docs-next in the
mean time, but this order seems sensible, and is what I'm proposing.]
Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/126f42734defac6cbb8496a481d58db7b38461dd.1466506505.git.jani.nikula@intel.com
parent 621c5474
This diff is collapsed.
===================
Userland interfaces Userland interfaces
=================== ===================
...@@ -14,7 +15,7 @@ Cover generic ioctls and sysfs layout here. We only need high-level ...@@ -14,7 +15,7 @@ Cover generic ioctls and sysfs layout here. We only need high-level
info, since man pages should cover the rest. info, since man pages should cover the rest.
Render nodes Render nodes
------------ ============
DRM core provides multiple character-devices for user-space to use. DRM core provides multiple character-devices for user-space to use.
Depending on which device is opened, user-space can perform a different Depending on which device is opened, user-space can perform a different
...@@ -67,7 +68,7 @@ visible to user-space and accessible beyond open-file boundaries, they ...@@ -67,7 +68,7 @@ visible to user-space and accessible beyond open-file boundaries, they
cannot support render nodes. cannot support render nodes.
VBlank event handling VBlank event handling
--------------------- =====================
The DRM core exposes two vertical blank related ioctls: The DRM core exposes two vertical blank related ioctls:
......
drm/i915 Intel GFX Driver ===========================
========================= drm/i915 Intel GFX Driver
===========================
The drm/i915 driver supports all (with the exception of some very early The drm/i915 driver supports all (with the exception of some very early
models) integrated GFX chipsets with both Intel display and rendering models) integrated GFX chipsets with both Intel display and rendering
...@@ -7,13 +8,13 @@ blocks. This excludes a set of SoC platforms with an SGX rendering unit, ...@@ -7,13 +8,13 @@ blocks. This excludes a set of SoC platforms with an SGX rendering unit,
those have basic support through the gma500 drm driver. those have basic support through the gma500 drm driver.
Core Driver Infrastructure Core Driver Infrastructure
-------------------------- ==========================
This section covers core driver infrastructure used by both the display This section covers core driver infrastructure used by both the display
and the GEM parts of the driver. and the GEM parts of the driver.
Runtime Power Management Runtime Power Management
~~~~~~~~~~~~~~~~~~~~~~~~ ------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c .. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c
:doc: runtime pm :doc: runtime pm
...@@ -25,7 +26,7 @@ Runtime Power Management ...@@ -25,7 +26,7 @@ Runtime Power Management
:internal: :internal:
Interrupt Handling Interrupt Handling
~~~~~~~~~~~~~~~~~~ ------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
:doc: interrupt handling :doc: interrupt handling
...@@ -40,7 +41,7 @@ Interrupt Handling ...@@ -40,7 +41,7 @@ Interrupt Handling
:functions: intel_runtime_pm_enable_interrupts :functions: intel_runtime_pm_enable_interrupts
Intel GVT-g Guest Support(vGPU) Intel GVT-g Guest Support(vGPU)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c .. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c
:doc: Intel GVT-g guest support :doc: Intel GVT-g guest support
...@@ -49,14 +50,14 @@ Intel GVT-g Guest Support(vGPU) ...@@ -49,14 +50,14 @@ Intel GVT-g Guest Support(vGPU)
:internal: :internal:
Display Hardware Handling Display Hardware Handling
------------------------- =========================
This section covers everything related to the display hardware including This section covers everything related to the display hardware including
the mode setting infrastructure, plane, sprite and cursor handling and the mode setting infrastructure, plane, sprite and cursor handling and
display, output probing and related topics. display, output probing and related topics.
Mode Setting Infrastructure Mode Setting Infrastructure
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ---------------------------
The i915 driver is thus far the only DRM driver which doesn't use the The i915 driver is thus far the only DRM driver which doesn't use the
common DRM helper code to implement mode setting sequences. Thus it has common DRM helper code to implement mode setting sequences. Thus it has
...@@ -64,7 +65,7 @@ its own tailor-made infrastructure for executing a display configuration ...@@ -64,7 +65,7 @@ its own tailor-made infrastructure for executing a display configuration
change. change.
Frontbuffer Tracking Frontbuffer Tracking
~~~~~~~~~~~~~~~~~~~~ --------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c
:doc: frontbuffer tracking :doc: frontbuffer tracking
...@@ -76,7 +77,7 @@ Frontbuffer Tracking ...@@ -76,7 +77,7 @@ Frontbuffer Tracking
:functions: i915_gem_track_fb :functions: i915_gem_track_fb
Display FIFO Underrun Reporting Display FIFO Underrun Reporting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c .. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c
:doc: fifo underrun handling :doc: fifo underrun handling
...@@ -85,7 +86,7 @@ Display FIFO Underrun Reporting ...@@ -85,7 +86,7 @@ Display FIFO Underrun Reporting
:internal: :internal:
Plane Configuration Plane Configuration
~~~~~~~~~~~~~~~~~~~ -------------------
This section covers plane configuration and composition with the primary This section covers plane configuration and composition with the primary
plane, sprites, cursors and overlays. This includes the infrastructure plane, sprites, cursors and overlays. This includes the infrastructure
...@@ -94,7 +95,7 @@ topics like watermark setup and computation, framebuffer compression and ...@@ -94,7 +95,7 @@ topics like watermark setup and computation, framebuffer compression and
panel self refresh. panel self refresh.
Atomic Plane Helpers Atomic Plane Helpers
~~~~~~~~~~~~~~~~~~~~ --------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c .. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c
:doc: atomic plane helpers :doc: atomic plane helpers
...@@ -103,7 +104,7 @@ Atomic Plane Helpers ...@@ -103,7 +104,7 @@ Atomic Plane Helpers
:internal: :internal:
Output Probing Output Probing
~~~~~~~~~~~~~~ --------------
This section covers output probing and related infrastructure like the This section covers output probing and related infrastructure like the
hotplug interrupt storm detection and mitigation code. Note that the hotplug interrupt storm detection and mitigation code. Note that the
...@@ -111,7 +112,7 @@ i915 driver still uses most of the common DRM helper code for output ...@@ -111,7 +112,7 @@ i915 driver still uses most of the common DRM helper code for output
probing, so those sections fully apply. probing, so those sections fully apply.
Hotplug Hotplug
~~~~~~~ -------
.. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c .. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c
:doc: Hotplug :doc: Hotplug
...@@ -120,7 +121,7 @@ Hotplug ...@@ -120,7 +121,7 @@ Hotplug
:internal: :internal:
High Definition Audio High Definition Audio
~~~~~~~~~~~~~~~~~~~~~ ---------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
:doc: High Definition Audio over HDMI and Display Port :doc: High Definition Audio over HDMI and Display Port
...@@ -132,7 +133,7 @@ High Definition Audio ...@@ -132,7 +133,7 @@ High Definition Audio
:internal: :internal:
Panel Self Refresh PSR (PSR/SRD) Panel Self Refresh PSR (PSR/SRD)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c .. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
:doc: Panel Self Refresh (PSR/SRD) :doc: Panel Self Refresh (PSR/SRD)
...@@ -141,7 +142,7 @@ Panel Self Refresh PSR (PSR/SRD) ...@@ -141,7 +142,7 @@ Panel Self Refresh PSR (PSR/SRD)
:internal: :internal:
Frame Buffer Compression (FBC) Frame Buffer Compression (FBC)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c .. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
:doc: Frame Buffer Compression (FBC) :doc: Frame Buffer Compression (FBC)
...@@ -150,7 +151,7 @@ Frame Buffer Compression (FBC) ...@@ -150,7 +151,7 @@ Frame Buffer Compression (FBC)
:internal: :internal:
Display Refresh Rate Switching (DRRS) Display Refresh Rate Switching (DRRS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -------------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
:doc: Display Refresh Rate Switching (DRRS) :doc: Display Refresh Rate Switching (DRRS)
...@@ -174,13 +175,13 @@ Display Refresh Rate Switching (DRRS) ...@@ -174,13 +175,13 @@ Display Refresh Rate Switching (DRRS)
:functions: intel_dp_drrs_init :functions: intel_dp_drrs_init
DPIO DPIO
~~~~ ----
.. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
:doc: DPIO :doc: DPIO
CSR firmware support for DMC CSR firmware support for DMC
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ----------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c .. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
:doc: csr support for dmc :doc: csr support for dmc
...@@ -189,7 +190,7 @@ CSR firmware support for DMC ...@@ -189,7 +190,7 @@ CSR firmware support for DMC
:internal: :internal:
Video BIOS Table (VBT) Video BIOS Table (VBT)
~~~~~~~~~~~~~~~~~~~~~~ ----------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c .. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
:doc: Video BIOS Table (VBT) :doc: Video BIOS Table (VBT)
...@@ -201,13 +202,13 @@ Video BIOS Table (VBT) ...@@ -201,13 +202,13 @@ Video BIOS Table (VBT)
:internal: :internal:
Memory Management and Command Submission Memory Management and Command Submission
---------------------------------------- ========================================
This sections covers all things related to the GEM implementation in the This sections covers all things related to the GEM implementation in the
i915 driver. i915 driver.
Batchbuffer Parsing Batchbuffer Parsing
~~~~~~~~~~~~~~~~~~~ -------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
:doc: batch buffer command parser :doc: batch buffer command parser
...@@ -216,7 +217,7 @@ Batchbuffer Parsing ...@@ -216,7 +217,7 @@ Batchbuffer Parsing
:internal: :internal:
Batchbuffer Pools Batchbuffer Pools
~~~~~~~~~~~~~~~~~ -----------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
:doc: batch pool :doc: batch pool
...@@ -225,7 +226,7 @@ Batchbuffer Pools ...@@ -225,7 +226,7 @@ Batchbuffer Pools
:internal: :internal:
Logical Rings, Logical Ring Contexts and Execlists Logical Rings, Logical Ring Contexts and Execlists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------------------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c .. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
:doc: Logical Rings, Logical Ring Contexts and Execlists :doc: Logical Rings, Logical Ring Contexts and Execlists
...@@ -234,7 +235,7 @@ Logical Rings, Logical Ring Contexts and Execlists ...@@ -234,7 +235,7 @@ Logical Rings, Logical Ring Contexts and Execlists
:internal: :internal:
Global GTT views Global GTT views
~~~~~~~~~~~~~~~~ ----------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
:doc: Global GTT views :doc: Global GTT views
...@@ -243,25 +244,25 @@ Global GTT views ...@@ -243,25 +244,25 @@ Global GTT views
:internal: :internal:
GTT Fences and Swizzling GTT Fences and Swizzling
~~~~~~~~~~~~~~~~~~~~~~~~ ------------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c
:internal: :internal:
Global GTT Fence Handling Global GTT Fence Handling
^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c
:doc: fence register handling :doc: fence register handling
Hardware Tiling and Swizzling Details Hardware Tiling and Swizzling Details
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c
:doc: tiling swizzling details :doc: tiling swizzling details
Object Tiling IOCTLs Object Tiling IOCTLs
~~~~~~~~~~~~~~~~~~~~ --------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
:internal: :internal:
...@@ -270,7 +271,7 @@ Object Tiling IOCTLs ...@@ -270,7 +271,7 @@ Object Tiling IOCTLs
:doc: buffer object tiling :doc: buffer object tiling
Buffer Object Eviction Buffer Object Eviction
~~~~~~~~~~~~~~~~~~~~~~ ----------------------
This section documents the interface functions for evicting buffer This section documents the interface functions for evicting buffer
objects to make space available in the virtual gpu address spaces. Note objects to make space available in the virtual gpu address spaces. Note
...@@ -282,7 +283,7 @@ unified memory architecture) available. ...@@ -282,7 +283,7 @@ unified memory architecture) available.
:internal: :internal:
Buffer Object Memory Shrinking Buffer Object Memory Shrinking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ------------------------------
This section documents the interface function for shrinking memory usage This section documents the interface function for shrinking memory usage
of buffer object caches. Shrinking is used to make main memory of buffer object caches. Shrinking is used to make main memory
...@@ -293,10 +294,10 @@ objects, which has the goal to make space in gpu virtual address spaces. ...@@ -293,10 +294,10 @@ objects, which has the goal to make space in gpu virtual address spaces.
:internal: :internal:
GuC GuC
--- ===
GuC-specific firmware loader GuC-specific firmware loader
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ----------------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
:doc: GuC-specific firmware loader :doc: GuC-specific firmware loader
...@@ -305,7 +306,7 @@ GuC-specific firmware loader ...@@ -305,7 +306,7 @@ GuC-specific firmware loader
:internal: :internal:
GuC-based command submission GuC-based command submission
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ----------------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c .. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
:doc: GuC-based command submission :doc: GuC-based command submission
...@@ -314,31 +315,31 @@ GuC-based command submission ...@@ -314,31 +315,31 @@ GuC-based command submission
:internal: :internal:
GuC Firmware Layout GuC Firmware Layout
~~~~~~~~~~~~~~~~~~~ -------------------
.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
:doc: GuC Firmware Layout :doc: GuC Firmware Layout
Tracing Tracing
------- =======
This sections covers all things related to the tracepoints implemented This sections covers all things related to the tracepoints implemented
in the i915 driver. in the i915 driver.
i915_ppgtt_create and i915_ppgtt_release i915_ppgtt_create and i915_ppgtt_release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ----------------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
:doc: i915_ppgtt_create and i915_ppgtt_release tracepoints :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
i915_context_create and i915_context_free i915_context_create and i915_context_free
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -----------------------------------------
.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
:doc: i915_context_create and i915_context_free tracepoints :doc: i915_context_create and i915_context_free tracepoints
switch_mm switch_mm
~~~~~~~~~~ ---------
.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
:doc: switch_mm tracepoint :doc: switch_mm tracepoint
......
============
Introduction Introduction
============ ============
...@@ -16,7 +17,7 @@ found in current kernels. ...@@ -16,7 +17,7 @@ found in current kernels.
[Insert diagram of typical DRM stack here] [Insert diagram of typical DRM stack here]
Style Guidelines Style Guidelines
---------------- ================
For consistency this documentation uses American English. Abbreviations For consistency this documentation uses American English. Abbreviations
are written as all-uppercase, for example: DRM, KMS, IOCTL, CRTC, and so are written as all-uppercase, for example: DRM, KMS, IOCTL, CRTC, and so
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment