drm/doc: Reorg for drm-kms.rst
- Again adjust headings a bit, and don't mix up the initialization sections with other stuff. - Remove the doc for output polling, that vfunc is now properly documented in the vfunc reference sections. - Move the grab-bag with all the core stuff (i.e. drm_crtc.[hc]) to the front for a more prominent place. Reviewed-by: Sean Paul <seanpaul@chromium.org> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Link: http://patchwork.freedesktop.org/patch/msgid/1471034937-651-5-git-send-email-daniel.vetter@ffwll.ch
This commit is contained in:
parent
8febdf0d59
commit
311b62d94c
|
@ -2,9 +2,6 @@
|
||||||
Kernel Mode Setting (KMS)
|
Kernel Mode Setting (KMS)
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
Mode Setting
|
|
||||||
============
|
|
||||||
|
|
||||||
Drivers must initialize the mode setting core by calling
|
Drivers must initialize the mode setting core by calling
|
||||||
:c:func:`drm_mode_config_init()` on the DRM device. The function
|
:c:func:`drm_mode_config_init()` on the DRM device. The function
|
||||||
initializes the :c:type:`struct drm_device <drm_device>`
|
initializes the :c:type:`struct drm_device <drm_device>`
|
||||||
|
@ -18,17 +15,20 @@ be setup by initializing the following fields.
|
||||||
- struct drm_mode_config_funcs \*funcs;
|
- struct drm_mode_config_funcs \*funcs;
|
||||||
Mode setting functions.
|
Mode setting functions.
|
||||||
|
|
||||||
Display Modes Function Reference
|
KMS Data Structures
|
||||||
--------------------------------
|
===================
|
||||||
|
|
||||||
.. kernel-doc:: include/drm/drm_modes.h
|
.. kernel-doc:: include/drm/drm_crtc.h
|
||||||
:internal:
|
:internal:
|
||||||
|
|
||||||
.. kernel-doc:: drivers/gpu/drm/drm_modes.c
|
KMS API Functions
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/drm_crtc.c
|
||||||
:export:
|
:export:
|
||||||
|
|
||||||
Atomic Mode Setting Function Reference
|
Atomic Mode Setting Function Reference
|
||||||
--------------------------------------
|
======================================
|
||||||
|
|
||||||
.. kernel-doc:: drivers/gpu/drm/drm_atomic.c
|
.. kernel-doc:: drivers/gpu/drm/drm_atomic.c
|
||||||
:export:
|
:export:
|
||||||
|
@ -37,7 +37,7 @@ Atomic Mode Setting Function Reference
|
||||||
:internal:
|
:internal:
|
||||||
|
|
||||||
Frame Buffer Abstraction
|
Frame Buffer Abstraction
|
||||||
------------------------
|
========================
|
||||||
|
|
||||||
Frame buffers are abstract memory objects that provide a source of
|
Frame buffers are abstract memory objects that provide a source of
|
||||||
pixels to scanout to a CRTC. Applications explicitly request the
|
pixels to scanout to a CRTC. Applications explicitly request the
|
||||||
|
@ -65,13 +65,13 @@ drivers can manually clean up a framebuffer at module unload time with
|
||||||
:c:func:`drm_framebuffer_unregister_private()`.
|
:c:func:`drm_framebuffer_unregister_private()`.
|
||||||
|
|
||||||
DRM Format Handling
|
DRM Format Handling
|
||||||
-------------------
|
===================
|
||||||
|
|
||||||
.. kernel-doc:: drivers/gpu/drm/drm_fourcc.c
|
.. kernel-doc:: drivers/gpu/drm/drm_fourcc.c
|
||||||
:export:
|
:export:
|
||||||
|
|
||||||
Dumb Buffer Objects
|
Dumb Buffer Objects
|
||||||
-------------------
|
===================
|
||||||
|
|
||||||
The KMS API doesn't standardize backing storage object creation and
|
The KMS API doesn't standardize backing storage object creation and
|
||||||
leaves it to driver-specific ioctls. Furthermore actually creating a
|
leaves it to driver-specific ioctls. Furthermore actually creating a
|
||||||
|
@ -114,14 +114,14 @@ Note that dumb objects may not be used for gpu acceleration, as has been
|
||||||
attempted on some ARM embedded platforms. Such drivers really must have
|
attempted on some ARM embedded platforms. Such drivers really must have
|
||||||
a hardware-specific ioctl to allocate suitable buffer objects.
|
a hardware-specific ioctl to allocate suitable buffer objects.
|
||||||
|
|
||||||
Output Polling
|
Display Modes Function Reference
|
||||||
--------------
|
================================
|
||||||
|
|
||||||
void (\*output_poll_changed)(struct drm_device \*dev);
|
.. kernel-doc:: include/drm/drm_modes.h
|
||||||
This operation notifies the driver that the status of one or more
|
:internal:
|
||||||
connectors has changed. Drivers that use the fb helper can just call the
|
|
||||||
:c:func:`drm_fb_helper_hotplug_event()` function to handle this
|
.. kernel-doc:: drivers/gpu/drm/drm_modes.c
|
||||||
operation.
|
:export:
|
||||||
|
|
||||||
KMS Initialization and Cleanup
|
KMS Initialization and Cleanup
|
||||||
==============================
|
==============================
|
||||||
|
@ -463,20 +463,8 @@ created for fetching EDID data and performing monitor detection. Once
|
||||||
the process is complete, the new connector is registered with sysfs to
|
the process is complete, the new connector is registered with sysfs to
|
||||||
make its properties available to applications.
|
make its properties available to applications.
|
||||||
|
|
||||||
KMS API Functions
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. kernel-doc:: drivers/gpu/drm/drm_crtc.c
|
|
||||||
:export:
|
|
||||||
|
|
||||||
KMS Data Structures
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
.. kernel-doc:: include/drm/drm_crtc.h
|
|
||||||
:internal:
|
|
||||||
|
|
||||||
KMS Locking
|
KMS Locking
|
||||||
-----------
|
===========
|
||||||
|
|
||||||
.. kernel-doc:: drivers/gpu/drm/drm_modeset_lock.c
|
.. kernel-doc:: drivers/gpu/drm/drm_modeset_lock.c
|
||||||
:doc: kms locking
|
:doc: kms locking
|
||||||
|
|
Loading…
Reference in New Issue