diff options
| author | Jani Nikula <jani.nikula@intel.com> | 2016-06-21 07:49:00 -0400 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-06-21 08:15:18 -0400 |
| commit | 22554020409f6febcce2790380e46cd483ae04bb (patch) | |
| tree | 355dfc9c00ced4b9d312457e6c80beb470e159d7 /Documentation/gpu | |
| parent | 621c5474744ce780a5485284273de77b66f4cae2 (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.rst | 127 | ||||
| -rw-r--r-- | Documentation/gpu/drm-uapi.rst | 5 | ||||
| -rw-r--r-- | Documentation/gpu/i915.rst | 81 | ||||
| -rw-r--r-- | Documentation/gpu/introduction.rst | 3 |
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 | ============= | ||
| 1 | DRM Internals | 2 | DRM Internals |
| 2 | ============= | 3 | ============= |
| 3 | 4 | ||
| @@ -18,7 +19,7 @@ management, command submission & fencing, suspend/resume support, and | |||
| 18 | DMA services. | 19 | DMA services. |
| 19 | 20 | ||
| 20 | Driver Initialization | 21 | Driver Initialization |
| 21 | --------------------- | 22 | ===================== |
| 22 | 23 | ||
| 23 | At the core of every DRM driver is a :c:type:`struct drm_driver | 24 | At 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 | |||
| 36 | sections. | 37 | sections. |
| 37 | 38 | ||
| 38 | Driver Information | 39 | Driver Information |
| 39 | ~~~~~~~~~~~~~~~~~~ | 40 | ------------------ |
| 40 | 41 | ||
| 41 | Driver Features | 42 | Driver Features |
| 42 | ^^^^^^^^^^^^^^^ | 43 | ^^^^^^^^^^^^^^^ |
| @@ -131,7 +132,7 @@ kernel log at initialization time and passes it to userspace through the | |||
| 131 | DRM_IOCTL_VERSION ioctl. | 132 | DRM_IOCTL_VERSION ioctl. |
| 132 | 133 | ||
| 133 | Device Instance and Driver Handling | 134 | Device 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 | ||
| 142 | Driver Load | 143 | Driver Load |
| 143 | ~~~~~~~~~~~ | 144 | ----------- |
| 144 | 145 | ||
| 145 | IRQ Registration | 146 | IRQ Registration |
| 146 | ^^^^^^^^^^^^^^^^ | 147 | ^^^^^^^^^^^^^^^^ |
| @@ -221,7 +222,7 @@ other BARs, so leaving it mapped could cause undesired behaviour like | |||
| 221 | hangs or memory corruption. | 222 | hangs or memory corruption. |
| 222 | 223 | ||
| 223 | Bus-specific Device Registration and PCI Support | 224 | Bus-specific Device Registration and PCI Support |
| 224 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 225 | ------------------------------------------------ |
| 225 | 226 | ||
| 226 | A number of functions are provided to help with device registration. The | 227 | A number of functions are provided to help with device registration. The |
| 227 | functions deal with PCI and platform devices respectively and are only | 228 | functions deal with PCI and platform devices respectively and are only |
| @@ -236,7 +237,7 @@ drivers. | |||
| 236 | :export: | 237 | :export: |
| 237 | 238 | ||
| 238 | Memory management | 239 | Memory management |
| 239 | ----------------- | 240 | ================= |
| 240 | 241 | ||
| 241 | Modern Linux systems require large amount of graphics memory to store | 242 | Modern Linux systems require large amount of graphics memory to store |
| 242 | frame buffers, textures, vertices and other graphics-related data. Given | 243 | frame 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 | |||
| 262 | UMA devices. | 263 | UMA devices. |
| 263 | 264 | ||
| 264 | The Translation Table Manager (TTM) | 265 | The Translation Table Manager (TTM) |
| 265 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 266 | ----------------------------------- |
| 266 | 267 | ||
| 267 | TTM design background and information belongs here. | 268 | TTM design background and information belongs here. |
| 268 | 269 | ||
| @@ -313,7 +314,7 @@ object, ttm_global_item_ref() is used to create an initial reference | |||
| 313 | count for the TTM, which will call your initialization function. | 314 | count for the TTM, which will call your initialization function. |
| 314 | 315 | ||
| 315 | The Graphics Execution Manager (GEM) | 316 | The Graphics Execution Manager (GEM) |
| 316 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 317 | ------------------------------------ |
| 317 | 318 | ||
| 318 | The GEM design approach has resulted in a memory manager that doesn't | 319 | The GEM design approach has resulted in a memory manager that doesn't |
| 319 | provide full coverage of all (or even all common) use cases in its | 320 | provide 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 | |||
| 576 | from the client in libdrm. | 577 | from the client in libdrm. |
| 577 | 578 | ||
| 578 | GEM Function Reference | 579 | GEM 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 | ||
| 587 | VMA Offset Manager | 588 | VMA 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 | ||
| 599 | PRIME Buffer Sharing | 600 | PRIME Buffer Sharing |
| 600 | ~~~~~~~~~~~~~~~~~~~~ | 601 | -------------------- |
| 601 | 602 | ||
| 602 | PRIME is the cross device buffer sharing framework in drm, originally | 603 | PRIME is the cross device buffer sharing framework in drm, originally |
| 603 | created for the OPTIMUS range of multi-gpu platforms. To userspace PRIME | 604 | created 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 | ||
| 650 | PRIME Function References | 651 | PRIME 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 | ||
| 656 | DRM MM Range Allocator | 657 | DRM MM Range Allocator |
| 657 | ~~~~~~~~~~~~~~~~~~~~~~ | 658 | ---------------------- |
| 658 | 659 | ||
| 659 | Overview | 660 | Overview |
| 660 | ^^^^^^^^ | 661 | ^^^^^^^^ |
| @@ -669,7 +670,7 @@ LRU Scan/Eviction Support | |||
| 669 | :doc: lru scan roaster | 670 | :doc: lru scan roaster |
| 670 | 671 | ||
| 671 | DRM MM Range Allocator Function References | 672 | DRM 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 | ||
| 680 | CMA Helper Functions Reference | 681 | CMA 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 | ||
| 692 | Mode Setting | 693 | Mode Setting |
| 693 | ------------ | 694 | ============ |
| 694 | 695 | ||
| 695 | Drivers must initialize the mode setting core by calling | 696 | Drivers 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 | ||
| 708 | Display Modes Function Reference | 709 | Display 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: | ||
