Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-22 12:11:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

drm/doc: document how userspace should find out CRTC index

Browse Source 
In this patch we add a section to document what userspace should do to
find out the CRTC index. This is important as they may be many places in
the documentation that need this, so it's better to just point to this
section and avoid repetition.

Signed-off-by: Leandro Ribeiro <leandro.ribeiro@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20210609230039.73307-2-leandro.ribeiro@collabora.com
This commit is contained in:
Leandro Ribeiro 2021-06-09 20:00:38 -03:00 committed by Daniel Vetter
parent 86441fa29e
commit 26594678d0
3 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/gpu/drm-uapi.rst
View File

@ -457,6 +457,19 @@ Userspace API Structures
.. kernel-doc:: include/uapi/drm/drm_mode.h .. kernel-doc:: include/uapi/drm/drm_mode.h
:doc: overview :doc: overview
.. _crtc_index:
CRTC index
----------
CRTC's have both an object ID and an index, and they are not the same thing.
The index is used in cases where a densely packed identifier for a CRTC is
needed, for instance a bitmask of CRTC's. The member possible_crtcs of struct
drm_mode_get_plane is an example.
DRM_IOCTL_MODE_GETRESOURCES populates a structure with an array of CRTC ID's,
and the CRTC index is its position in this array.
.. kernel-doc:: include/uapi/drm/drm.h .. kernel-doc:: include/uapi/drm/drm.h
:internal: :internal:

8
drivers/gpu/drm/drm_debugfs_crc.c
View File

@ -46,10 +46,10 @@
* it reached a given hardware component (a CRC sampling "source"). * it reached a given hardware component (a CRC sampling "source").
* *
* Userspace can control generation of CRCs in a given CRTC by writing to the * Userspace can control generation of CRCs in a given CRTC by writing to the
* file dri/0/crtc-N/crc/control in debugfs, with N being the index of the CRTC. * file dri/0/crtc-N/crc/control in debugfs, with N being the :ref:`index of
* Accepted values are source names (which are driver-specific) and the "auto" * the CRTC<crtc_index>`. Accepted values are source names (which are
* keyword, which will let the driver select a default source of frame CRCs * driver-specific) and the "auto" keyword, which will let the driver select a
* for this CRTC. * default source of frame CRCs for this CRTC.
* *
* Once frame CRC generation is enabled, userspace can capture them by reading * Once frame CRC generation is enabled, userspace can capture them by reading
* the dri/0/crtc-N/crc/data file. Each line in that file contains the frame * the dri/0/crtc-N/crc/data file. Each line in that file contains the frame

4
include/uapi/drm/drm.h
View File

@ -635,8 +635,8 @@ struct drm_gem_open {
/** /**
* DRM_CAP_VBLANK_HIGH_CRTC * DRM_CAP_VBLANK_HIGH_CRTC
* *
* If set to 1, the kernel supports specifying a CRTC index in the high bits of * If set to 1, the kernel supports specifying a :ref:`CRTC index<crtc_index>`
* &drm_wait_vblank_request.type. * in the high bits of &drm_wait_vblank_request.type.
* *
* Starting kernel version 2.6.39, this capability is always set to 1. * Starting kernel version 2.6.39, this capability is always set to 1.
*/ */