aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/gpu
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2016-06-21 07:49:00 -0400
committerDaniel Vetter <daniel.vetter@ffwll.ch>2016-06-21 08:15:18 -0400
commit22554020409f6febcce2790380e46cd483ae04bb (patch)
tree355dfc9c00ced4b9d312457e6c80beb470e159d7 /Documentation/gpu
parent621c5474744ce780a5485284273de77b66f4cae2 (diff)
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: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: http://patchwork.freedesktop.org/patch/msgid/126f42734defac6cbb8496a481d58db7b38461dd.1466506505.git.jani.nikula@intel.com
Diffstat (limited to 'Documentation/gpu')
-rw-r--r--Documentation/gpu/drm-internals.rst127
-rw-r--r--Documentation/gpu/drm-uapi.rst5
-rw-r--r--Documentation/gpu/i915.rst81
-rw-r--r--Documentation/gpu/introduction.rst3
4 files changed, 110 insertions, 106 deletions
diff --git a/Documentation/gpu/drm-internals.rst b/Documentation/gpu/drm-internals.rst
index 8b8257891396..ee01a4fbd657 100644
--- a/Documentation/gpu/drm-internals.rst
+++ b/Documentation/gpu/drm-internals.rst
@@ -1,3 +1,4 @@
1=============
1DRM Internals 2DRM Internals
2============= 3=============
3 4
@@ -18,7 +19,7 @@ management, command submission & fencing, suspend/resume support, and
18DMA services. 19DMA services.
19 20
20Driver Initialization 21Driver Initialization
21--------------------- 22=====================
22 23
23At the core of every DRM driver is a :c:type:`struct drm_driver 24At the core of every DRM driver is a :c:type:`struct drm_driver
24<drm_driver>` structure. Drivers typically statically initialize 25<drm_driver>` structure. Drivers typically statically initialize
@@ -36,7 +37,7 @@ then describe individual operations in details as they get used in later
36sections. 37sections.
37 38
38Driver Information 39Driver Information
39~~~~~~~~~~~~~~~~~~ 40------------------
40 41
41Driver Features 42Driver Features
42^^^^^^^^^^^^^^^ 43^^^^^^^^^^^^^^^
@@ -131,7 +132,7 @@ kernel log at initialization time and passes it to userspace through the
131DRM_IOCTL_VERSION ioctl. 132DRM_IOCTL_VERSION ioctl.
132 133
133Device Instance and Driver Handling 134Device Instance and Driver Handling
134~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 135-----------------------------------
135 136
136.. kernel-doc:: drivers/gpu/drm/drm_drv.c 137.. kernel-doc:: drivers/gpu/drm/drm_drv.c
137 :doc: driver instance overview 138 :doc: driver instance overview
@@ -140,7 +141,7 @@ Device Instance and Driver Handling
140 :export: 141 :export:
141 142
142Driver Load 143Driver Load
143~~~~~~~~~~~ 144-----------
144 145
145IRQ Registration 146IRQ Registration
146^^^^^^^^^^^^^^^^ 147^^^^^^^^^^^^^^^^
@@ -221,7 +222,7 @@ other BARs, so leaving it mapped could cause undesired behaviour like
221hangs or memory corruption. 222hangs or memory corruption.
222 223
223Bus-specific Device Registration and PCI Support 224Bus-specific Device Registration and PCI Support
224~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 225------------------------------------------------
225 226
226A number of functions are provided to help with device registration. The 227A number of functions are provided to help with device registration. The
227functions deal with PCI and platform devices respectively and are only 228functions deal with PCI and platform devices respectively and are only
@@ -236,7 +237,7 @@ drivers.
236 :export: 237 :export:
237 238
238Memory management 239Memory management
239----------------- 240=================
240 241
241Modern Linux systems require large amount of graphics memory to store 242Modern Linux systems require large amount of graphics memory to store
242frame buffers, textures, vertices and other graphics-related data. Given 243frame buffers, textures, vertices and other graphics-related data. Given
@@ -262,7 +263,7 @@ TTM, but has no video RAM management capabilities and is thus limited to
262UMA devices. 263UMA devices.
263 264
264The Translation Table Manager (TTM) 265The Translation Table Manager (TTM)
265~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 266-----------------------------------
266 267
267TTM design background and information belongs here. 268TTM design background and information belongs here.
268 269
@@ -313,7 +314,7 @@ object, ttm_global_item_ref() is used to create an initial reference
313count for the TTM, which will call your initialization function. 314count for the TTM, which will call your initialization function.
314 315
315The Graphics Execution Manager (GEM) 316The Graphics Execution Manager (GEM)
316~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 317------------------------------------
317 318
318The GEM design approach has resulted in a memory manager that doesn't 319The GEM design approach has resulted in a memory manager that doesn't
319provide full coverage of all (or even all common) use cases in its 320provide full coverage of all (or even all common) use cases in its
@@ -576,7 +577,7 @@ available to the client. Such resource management should be abstracted
576from the client in libdrm. 577from the client in libdrm.
577 578
578GEM Function Reference 579GEM Function Reference
579~~~~~~~~~~~~~~~~~~~~~~ 580----------------------
580 581
581.. kernel-doc:: drivers/gpu/drm/drm_gem.c 582.. kernel-doc:: drivers/gpu/drm/drm_gem.c
582 :export: 583 :export:
@@ -585,7 +586,7 @@ GEM Function Reference
585 :internal: 586 :internal:
586 587
587VMA Offset Manager 588VMA Offset Manager
588~~~~~~~~~~~~~~~~~~ 589------------------
589 590
590.. kernel-doc:: drivers/gpu/drm/drm_vma_manager.c 591.. kernel-doc:: drivers/gpu/drm/drm_vma_manager.c
591 :doc: vma offset manager 592 :doc: vma offset manager
@@ -597,7 +598,7 @@ VMA Offset Manager
597 :internal: 598 :internal:
598 599
599PRIME Buffer Sharing 600PRIME Buffer Sharing
600~~~~~~~~~~~~~~~~~~~~ 601--------------------
601 602
602PRIME is the cross device buffer sharing framework in drm, originally 603PRIME is the cross device buffer sharing framework in drm, originally
603created for the OPTIMUS range of multi-gpu platforms. To userspace PRIME 604created for the OPTIMUS range of multi-gpu platforms. To userspace PRIME
@@ -648,13 +649,13 @@ PRIME Helper Functions
648 :doc: PRIME Helpers 649 :doc: PRIME Helpers
649 650
650PRIME Function References 651PRIME Function References
651~~~~~~~~~~~~~~~~~~~~~~~~~ 652-------------------------
652 653
653.. kernel-doc:: drivers/gpu/drm/drm_prime.c 654.. kernel-doc:: drivers/gpu/drm/drm_prime.c
654 :export: 655 :export:
655 656
656DRM MM Range Allocator 657DRM MM Range Allocator
657~~~~~~~~~~~~~~~~~~~~~~ 658----------------------
658 659
659Overview 660Overview
660^^^^^^^^ 661^^^^^^^^
@@ -669,7 +670,7 @@ LRU Scan/Eviction Support
669 :doc: lru scan roaster 670 :doc: lru scan roaster
670 671
671DRM MM Range Allocator Function References 672DRM MM Range Allocator Function References
672~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 673------------------------------------------
673 674
674.. kernel-doc:: drivers/gpu/drm/drm_mm.c 675.. kernel-doc:: drivers/gpu/drm/drm_mm.c
675 :export: 676 :export:
@@ -678,7 +679,7 @@ DRM MM Range Allocator Function References
678 :internal: 679 :internal:
679 680
680CMA Helper Functions Reference 681CMA Helper Functions Reference
681~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 682------------------------------
682 683
683.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c 684.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c
684 :doc: cma helpers 685 :doc: cma helpers
@@ -690,7 +691,7 @@ CMA Helper Functions Reference
690 :internal: 691 :internal:
691 692
692Mode Setting 693Mode Setting
693------------ 694============
694 695
695Drivers must initialize the mode setting core by calling 696Drivers must initialize the mode setting core by calling
696:c:func:`drm_mode_config_init()` on the DRM device. The function 697:c:func:`drm_mode_config_init()` on the DRM device. The function
@@ -706,7 +707,7 @@ be setup by initializing the following fields.
706 Mode setting functions. 707 Mode setting functions.
707 708
708Display Modes Function Reference 709Display Modes Function Reference
709~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 710--------------------------------
710 711
711.. kernel-doc:: include/drm/drm_modes.h 712.. kernel-doc:: include/drm/drm_modes.h
712 :internal: