sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget /translations/zh_CN/gpu/drm-uapimodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget /translations/zh_TW/gpu/drm-uapimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget /translations/it_IT/gpu/drm-uapimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget /translations/ja_JP/gpu/drm-uapimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget /translations/ko_KR/gpu/drm-uapimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget /translations/sp_SP/gpu/drm-uapimodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h$Copyright 2020 DisplayLink (UK) Ltd.h]h$Copyright 2020 DisplayLink (UK) Ltd.}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhh:/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi.rsthKubhsection)}(hhh](htitle)}(hUserland interfacesh]hUserland interfaces}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hXThe DRM core exports several interfaces to applications, generally intended to be used through corresponding libdrm wrapper functions. In addition, drivers export device-specific interfaces for use by userspace drivers & device-aware applications through ioctls and sysfs files.h]hXThe DRM core exports several interfaces to applications, generally intended to be used through corresponding libdrm wrapper functions. In addition, drivers export device-specific interfaces for use by userspace drivers & device-aware applications through ioctls and sysfs files.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hExternal interfaces include: memory mapping, context management, DMA operations, AGP management, vblank control, fence management, memory management, and output management.h]hExternal interfaces include: memory mapping, context management, DMA operations, AGP management, vblank control, fence management, memory management, and output management.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hpCover generic ioctls and sysfs layout here. We only need high-level info, since man pages should cover the rest.h]hpCover generic ioctls and sysfs layout here. We only need high-level info, since man pages should cover the rest.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(hlibdrm Device Lookuph]hlibdrm Device Lookup}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(h'BEWARE THE DRAGONS! MIND THE TRAPDOORS!h]h'BEWARE THE DRAGONS! MIND THE TRAPDOORS!}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chK/hhhhubh)}(hIn an attempt to warn anyone else who's trying to figure out what's going on here, I'll try to summarize the story. First things first, let's clear up the names, because the kernel internals, libdrm and the ioctls are all named differently:h]hIn an attempt to warn anyone else who’s trying to figure out what’s going on here, I’ll try to summarize the story. First things first, let’s clear up the names, because the kernel internals, libdrm and the ioctls are all named differently:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chK1hhhhubh block_quote)}(hX- GET_UNIQUE ioctl, implemented by drm_getunique is wrapped up in libdrm through the drmGetBusid function. - The libdrm drmSetBusid function is backed by the SET_UNIQUE ioctl. All that code is nerved in the kernel with drm_invalid_op(). - The internal set_busid kernel functions and driver callbacks are exclusively use by the SET_VERSION ioctl, because only drm 1.0 (which is nerved) allowed userspace to set the busid through the above ioctl. - Other ioctls and functions involved are named consistently. h]h bullet_list)}(hhh](h list_item)}(hhGET_UNIQUE ioctl, implemented by drm_getunique is wrapped up in libdrm through the drmGetBusid function.h]h)}(hhGET_UNIQUE ioctl, implemented by drm_getunique is wrapped up in libdrm through the drmGetBusid function.h]hhGET_UNIQUE ioctl, implemented by drm_getunique is wrapped up in libdrm through the drmGetBusid function.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chK6hj1ubah}(h]h ]h"]h$]h&]uh1j/hj,ubj0)}(hThe libdrm drmSetBusid function is backed by the SET_UNIQUE ioctl. All that code is nerved in the kernel with drm_invalid_op().h]h)}(hThe libdrm drmSetBusid function is backed by the SET_UNIQUE ioctl. All that code is nerved in the kernel with drm_invalid_op().h]hThe libdrm drmSetBusid function is backed by the SET_UNIQUE ioctl. All that code is nerved in the kernel with drm_invalid_op().}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chK8hjJubah}(h]h ]h"]h$]h&]uh1j/hj,ubj0)}(hThe internal set_busid kernel functions and driver callbacks are exclusively use by the SET_VERSION ioctl, because only drm 1.0 (which is nerved) allowed userspace to set the busid through the above ioctl.h]h)}(hThe internal set_busid kernel functions and driver callbacks are exclusively use by the SET_VERSION ioctl, because only drm 1.0 (which is nerved) allowed userspace to set the busid through the above ioctl.h]hThe internal set_busid kernel functions and driver callbacks are exclusively use by the SET_VERSION ioctl, because only drm 1.0 (which is nerved) allowed userspace to set the busid through the above ioctl.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chK:hjcubah}(h]h ]h"]h$]h&]uh1j/hj,ubj0)}(hubah}(h]h ]h"]h$]h&]uh1j/hj"ubj0)}(hXTCall GET_UNIQUE, and check whether the unique name has length zero (by checking that the first byte in the string is 0). If that's not the case libdrm skips and proceeds to the next device node. Probably this is just copypasta from drm 1.0 times where a set unique name meant that the driver was in use already, but that's just conjecture. h]h)}(hXSCall GET_UNIQUE, and check whether the unique name has length zero (by checking that the first byte in the string is 0). If that's not the case libdrm skips and proceeds to the next device node. Probably this is just copypasta from drm 1.0 times where a set unique name meant that the driver was in use already, but that's just conjecture.h]hXWCall GET_UNIQUE, and check whether the unique name has length zero (by checking that the first byte in the string is 0). If that’s not the case libdrm skips and proceeds to the next device node. Probably this is just copypasta from drm 1.0 times where a set unique name meant that the driver was in use already, but that’s just conjecture.}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chKWhjVubah}(h]h ]h"]h$]h&]uh1j/hj"ubeh}(h]h ]h"]h$]h&]j jjhjjuh1jhhhhhjhNubh)}(hXLong story short: To keep the open by name logic working, GET_UNIQUE must _not_ return a unique string when SET_VERSION hasn't been called yet, otherwise libdrm breaks. Even when that unique string can't ever change, and is totally irrelevant for actually opening the device because runtime assignable device instances were only support in drm 1.0, which is long dead. But the libdrm code in drmOpenByName somehow survived, hence this can't be broken.h]hXLong story short: To keep the open by name logic working, GET_UNIQUE must _not_ return a unique string when SET_VERSION hasn’t been called yet, otherwise libdrm breaks. Even when that unique string can’t ever change, and is totally irrelevant for actually opening the device because runtime assignable device instances were only support in drm 1.0, which is long dead. But the libdrm code in drmOpenByName somehow survived, hence this can’t be broken.}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:22: ./drivers/gpu/drm/drm_ioctl.chK]hhhhubhtarget)}(h.. _drm_primary_node:h]h}(h]h ]h"]h$]h&]refiddrm-primary-nodeuh1jhKhhhhhhubeh}(h]libdrm-device-lookupah ]h"]libdrm device lookupah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h,Primary Nodes, DRM Master and Authenticationh]h,Primary Nodes, DRM Master and Authentication}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hX':c:type:`struct drm_master ` is used to track groups of clients with open primary device nodes. For every :c:type:`struct drm_file ` which has had at least once successfully became the device master (either through the SET_MASTER IOCTL, or implicitly through opening the primary device node when no one else is the current master that time) there exists one :c:type:`drm_master`. This is noted in :c:type:`drm_file.is_master `. All other clients have just a pointer to the :c:type:`drm_master` they are associated with.h](h)}(h(:c:type:`struct drm_master `h]hliteral)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdoc gpu/drm-uapi refdomainjreftypetype refexplicitrefwarn reftarget drm_masteruh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:31: ./drivers/gpu/drm/drm_auth.chK*hjubhN is used to track groups of clients with open primary device nodes. For every }(hjhhhNhNubh)}(h$:c:type:`struct drm_file `h]j)}(hjh]hstruct drm_file}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjdrm_fileuh1hhjhK*hjubh which has had at least once successfully became the device master (either through the SET_MASTER IOCTL, or implicitly through opening the primary device node when no one else is the current master that time) there exists one }(hjhhhNhNubh)}(h:c:type:`drm_master`h]j)}(hjh]h drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj drm_masteruh1hhjhK*hjubh. This is noted in }(hjhhhNhNubh)}(h':c:type:`drm_file.is_master `h]j)}(hj!h]hdrm_file.is_master}(hj#hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjdrm_fileuh1hhjhK*hjubh/. All other clients have just a pointer to the }(hjhhhNhNubh)}(h:c:type:`drm_master`h]j)}(hjDh]h drm_master}(hjFhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj drm_masteruh1hhjhK*hjubh they are associated with.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK*hjhhubh)}(hXIn addition only one :c:type:`drm_master` can be the current master for a :c:type:`drm_device`. It can be switched through the DROP_MASTER and SET_MASTER IOCTL, or implicitly through closing/opening the primary device node. See also drm_is_current_master().h](hIn addition only one }(hjkhhhNhNubh)}(h:c:type:`drm_master`h]j)}(hjuh]h drm_master}(hjwhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj drm_masteruh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:31: ./drivers/gpu/drm/drm_auth.chK2hjkubh! can be the current master for a }(hjkhhhNhNubh)}(h:c:type:`drm_device`h]j)}(hjh]h drm_device}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj drm_deviceuh1hhjhK2hjkubh. It can be switched through the DROP_MASTER and SET_MASTER IOCTL, or implicitly through closing/opening the primary device node. See also drm_is_current_master().}(hjkhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK2hjhhubh)}(hClients can authenticate against the current master (if it matches their own) using the GETMAGIC and AUTHMAGIC IOCTLs. Together with exchanging masters, this allows controlled access to the device for an entire group of mutually trusted clients.h]hClients can authenticate against the current master (if it matches their own) using the GETMAGIC and AUTHMAGIC IOCTLs. Together with exchanging masters, this allows controlled access to the device for an entire group of mutually trusted clients.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:31: ./drivers/gpu/drm/drm_auth.chK7hjhhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](single"drm_is_current_master (C function)c.drm_is_current_masterhNtauh1jhjhhhNhNubhdesc)}(hhh](hdesc_signature)}(h3bool drm_is_current_master (struct drm_file *fpriv)h]hdesc_signature_line)}(h2bool drm_is_current_master(struct drm_file *fpriv)h](hdesc_sig_keyword_type)}(hboolh]hbool}(hjhhhNhNubah}(h]h ]ktah"]h$]h&]uh1jhjhhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKQubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjhhhjhKQubh desc_name)}(hdrm_is_current_masterh]h desc_sig_name)}(hdrm_is_current_masterh]hdrm_is_current_master}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhjubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1jhjhhhjhKQubhdesc_parameterlist)}(h(struct drm_file *fpriv)h]hdesc_parameter)}(hstruct drm_file *fprivh](hdesc_sig_keyword)}(hstructh]hstruct}(hjAhhhNhNubah}(h]h ]kah"]h$]h&]uh1j?hj;ubj)}(h h]h }(hjPhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubh)}(hhh]j)}(hdrm_fileh]hdrm_file}(hjahhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&] refdomainjreftype identifier reftargetjcmodnameN classnameN c:parent_keysphinx.domains.c LookupKey)}data]j| ASTIdentifier)}jwjsbc.drm_is_current_masterasbuh1hhj;ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubhdesc_sig_punctuation)}(h*h]h*}(hjhhhNhNubah}(h]h ]pah"]h$]h&]uh1jhj;ubj)}(hfprivh]hfpriv}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj5ubah}(h]h ]h"]h$]h&]hhuh1j3hjhhhjhKQubeh}(h]h ]h"]h$]h&]hh add_permalinkuh1jsphinx_line_type declaratorhjhhhjhKQubah}(h]jah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jhjhKQhjhhubh desc_content)}(hhh]h)}(h-checks whether **priv** is the current masterh](hchecks whether }(hjhhhNhNubhstrong)}(h**priv**h]hpriv}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh is the current master}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKHhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKQubeh}(h]h ](jfunctioneh"]h$]h&]domainjobjtypejdesctypejnoindex noindexentrynocontentsentryuh1jhhhjhNhNubh container)}(hXe**Parameters** ``struct drm_file *fpriv`` DRM file private **Description** Checks whether **fpriv** is current master on its device. This decides whether a client is allowed to run DRM_MASTER IOCTLs. Most of the modern IOCTL which require DRM_MASTER are for kernel modesetting - the current master is assumed to own the non-shareable display hardware.h](h)}(h**Parameters**h]j)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKLhjubhdefinition_list)}(hhh]hdefinition_list_item)}(h,``struct drm_file *fpriv`` DRM file private h](hterm)}(h``struct drm_file *fpriv``h]j)}(hj?h]hstruct drm_file *fpriv}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKIhj7ubh definition)}(hhh]h)}(hDRM file privateh]hDRM file private}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjThKIhjWubah}(h]h ]h"]h$]h&]uh1jUhj7ubeh}(h]h ]h"]h$]h&]uh1j5hjThKIhj2ubah}(h]h ]h"]h$]h&]uh1j0hjubh)}(h**Description**h]j)}(hj|h]h Description}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKKhjubh)}(h|Checks whether **fpriv** is current master on its device. This decides whether a client is allowed to run DRM_MASTER IOCTLs.h](hChecks whether }(hjhhhNhNubj)}(h **fpriv**h]hfpriv}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhd is current master on its device. This decides whether a client is allowed to run DRM_MASTER IOCTLs.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKKhjubh)}(hMost of the modern IOCTL which require DRM_MASTER are for kernel modesetting - the current master is assumed to own the non-shareable display hardware.h]hMost of the modern IOCTL which require DRM_MASTER are for kernel modesetting - the current master is assumed to own the non-shareable display hardware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chKNhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_master_get (C function)c.drm_master_gethNtauh1jhjhhhNhNubj)}(hhh](j)}(h>struct drm_master * drm_master_get (struct drm_master *master)h]j)}(h` **Description** Increments the reference count of **master** and returns a pointer to **master**.h](h)}(h**Parameters**h]j)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjubj1)}(hhh]j6)}(hG``struct drm_master *master`` :c:type:`struct drm_master ` h](j<)}(h``struct drm_master *master``h]j)}(hjh]hstruct drm_master *master}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjubjV)}(hhh]h)}(h(:c:type:`struct drm_master `h]h)}(hj9h]j)}(hj9h]hstruct drm_master}(hj>hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{j~)}j]sbj drm_masteruh1hhj3hMhj7ubah}(h]h ]h"]h$]h&]uh1hhj3hMhj4ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj3hMhjubah}(h]h ]h"]h$]h&]uh1j0hjubh)}(h**Description**h]j)}(hjvh]h Description}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjubh)}(hQIncrements the reference count of **master** and returns a pointer to **master**.h](h"Increments the reference count of }(hjhhhNhNubj)}(h **master**h]hmaster}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and returns a pointer to }(hjhhhNhNubj)}(h **master**h]hmaster}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j drm_file_get_master (C function)c.drm_file_get_masterhNtauh1jhjhhhNhNubj)}(hhh](j)}(hDstruct drm_master * drm_file_get_master (struct drm_file *file_priv)h]j)}(hBstruct drm_master *drm_file_get_master(struct drm_file *file_priv)h](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubh)}(hhh]j)}(h drm_masterh]h drm_master}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjmodnameN classnameNj{j~)}j]j)}jwdrm_file_get_mastersbc.drm_file_get_masterasbuh1hhjhhhjhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj)}(hjh]h*}(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj)}(hdrm_file_get_masterh]j)}(hjh]hdrm_file_get_master}(hj>hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj:ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjhMubj4)}(h(struct drm_file *file_priv)h]j:)}(hstruct drm_file *file_privh](j@)}(hjCh]hstruct}(hjYhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjUubj)}(h h]h }(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUubh)}(hhh]j)}(hdrm_fileh]hdrm_file}(hjwhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjymodnameN classnameNj{j~)}j]jc.drm_file_get_masterasbuh1hhjUubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUubj)}(h file_privh]h file_priv}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjUubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjQubah}(h]h ]h"]h$]h&]hhuh1j3hjhhhjhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjhMhjhhubj)}(hhh]h)}(h?reference :c:type:`drm_file.master ` of **file_priv**h](h reference }(hjhhhNhNubh)}(h$:c:type:`drm_file.master `h]j)}(hjh]hdrm_file.master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{j~)}j]jc.drm_file_get_masterasbjdrm_fileuh1hhjhKQhjubh of }(hjhhhNhNubj)}(h **file_priv**h]h file_priv}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j( jj( jjjuh1jhhhjhNhNubj)}(hX**Parameters** ``struct drm_file *file_priv`` DRM file private **Description** Increments the reference count of **file_priv**'s :c:type:`drm_file.master ` and returns the :c:type:`drm_file.master `. If **file_priv** has no :c:type:`drm_file.master `, returns NULL. Master pointers returned from this function should be unreferenced using drm_master_put().h](h)}(h**Parameters**h]j)}(hj2 h]h Parameters}(hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0 ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhj, ubj1)}(hhh]j6)}(h0``struct drm_file *file_priv`` DRM file private h](j<)}(h``struct drm_file *file_priv``h]j)}(hjQ h]hstruct drm_file *file_priv}(hjS hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjO ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjK ubjV)}(hhh]h)}(hDRM file privateh]hDRM file private}(hjj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjf hMhjg ubah}(h]h ]h"]h$]h&]uh1jUhjK ubeh}(h]h ]h"]h$]h&]uh1j5hjf hMhjH ubah}(h]h ]h"]h$]h&]uh1j0hj, ubh)}(h**Description**h]j)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhj, ubh)}(hIncrements the reference count of **file_priv**'s :c:type:`drm_file.master ` and returns the :c:type:`drm_file.master `. If **file_priv** has no :c:type:`drm_file.master `, returns NULL.h](h"Increments the reference count of }(hj hhhNhNubj)}(h **file_priv**h]h file_priv}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh’s }(hj hhhNhNubh)}(h$:c:type:`drm_file.master `h]j)}(hj h]hdrm_file.master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_fileuh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhj ubh and returns the }(hj hhhNhNubh)}(h$:c:type:`drm_file.master `h]j)}(hj h]hdrm_file.master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_fileuh1hhj hMhj ubh. If }(hj hhhNhNubj)}(h **file_priv**h]h file_priv}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh has no }(hj hhhNhNubh)}(h$:c:type:`drm_file.master `h]j)}(hj h]hdrm_file.master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_fileuh1hhj hMhj ubh, returns NULL.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj hMhj, ubh)}(hZMaster pointers returned from this function should be unreferenced using drm_master_put().h]hZMaster pointers returned from this function should be unreferenced using drm_master_put().}(hj> hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhj, ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_master_put (C function)c.drm_master_puthNtauh1jhjhhhNhNubj)}(hhh](j)}(h0void drm_master_put (struct drm_master **master)h]j)}(h/void drm_master_put(struct drm_master **master)h](j)}(hvoidh]hvoid}(hjm hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhji hhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMubj)}(h h]h }(hj| hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhji hhhj{ hMubj)}(hdrm_master_puth]j)}(hdrm_master_puth]hdrm_master_put}(hj hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhji hhhj{ hMubj4)}(h(struct drm_master **master)h]j:)}(hstruct drm_master **masterh](j@)}(hjCh]hstruct}(hj hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj ubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubh)}(hhh]j)}(h drm_masterh]h drm_master}(hj hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj modnameN classnameNj{j~)}j]j)}jwj sbc.drm_master_putasbuh1hhj ubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(hjh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(hjh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(hmasterh]hmaster}(hj hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj ubah}(h]h ]h"]h$]h&]hhuh1j3hji hhhj{ hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhje hhhj{ hMubah}(h]j` ah ](jjeh"]h$]h&]jj)jhuh1jhj{ hMhjb hhubj)}(hhh]h)}(h&unreference and clear a master pointerh]h&unreference and clear a master pointer}(hj: hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhj7 hhubah}(h]h ]h"]h$]h&]uh1jhjb hhhj{ hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jR jjR jjjuh1jhhhjhNhNubj)}(h**Parameters** ``struct drm_master **master`` pointer to a pointer of :c:type:`struct drm_master ` **Description** This decrements the :c:type:`drm_master` behind **master** and sets it to NULL.h](h)}(h**Parameters**h]j)}(hj\ h]h Parameters}(hj^ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZ ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjV ubj1)}(hhh]j6)}(h```struct drm_master **master`` pointer to a pointer of :c:type:`struct drm_master ` h](j<)}(h``struct drm_master **master``h]j)}(hj{ h]hstruct drm_master **master}(hj} hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhju ubjV)}(hhh]h)}(h@pointer to a pointer of :c:type:`struct drm_master `h](hpointer to a pointer of }(hj hhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hj h]hstruct drm_master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhj hMhj ubeh}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jUhju ubeh}(h]h ]h"]h$]h&]uh1j5hj hMhjr ubah}(h]h ]h"]h$]h&]uh1j0hjV ubh)}(h**Description**h]j)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhjV ubh)}(hOThis decrements the :c:type:`drm_master` behind **master** and sets it to NULL.h](hThis decrements the }(hj hhhNhNubh)}(h:c:type:`drm_master`h]j)}(hj h]h drm_master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:34: ./drivers/gpu/drm/drm_auth.chMhj ubh behind }(hj hhhNhNubj)}(h **master**h]hmaster}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh and sets it to NULL.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj hMhjV ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_master (C struct) c.drm_masterhNtauh1jhjhhhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhNubj)}(hhh](j)}(h drm_masterh]j)}(hstruct drm_masterh](j@)}(hjCh]hstruct}(hjP hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjL hhhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKubj)}(h h]h }(hj^ hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjL hhhj] hKubj)}(h drm_masterh]j)}(hjJ h]h drm_master}(hjp hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjl ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjL hhhj] hKubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjH hhhj] hKubah}(h]jB ah ](jjeh"]h$]h&]jj)jhuh1jhj] hKhjE hhubj)}(hhh]h)}(hdrm master structureh]hdrm master structure}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK&hj hhubah}(h]h ]h"]h$]h&]uh1jhjE hhhj] hKubeh}(h]h ](jstructeh"]h$]h&]j jj j jj jjjuh1jhhhjhjD hNubj)}(hXB **Definition**:: struct drm_master { struct kref refcount; struct drm_device *dev; char *unique; int unique_len; struct idr magic_map; void *driver_priv; struct drm_master *lessor; int lessee_id; struct list_head lessee_list; struct list_head lessees; struct idr leases; struct idr lessee_idr; }; **Members** ``refcount`` Refcount for this master object. ``dev`` Link back to the DRM device ``unique`` Unique identifier: e.g. busid. Protected by :c:type:`drm_device.master_mutex `. ``unique_len`` Length of unique field. Protected by :c:type:`drm_device.master_mutex `. ``magic_map`` Map of used authentication tokens. Protected by :c:type:`drm_device.master_mutex `. ``driver_priv`` Pointer to driver-private information. ``lessor`` Lease grantor, only set if this :c:type:`struct drm_master ` represents a lessee holding a lease of objects from **lessor**. Full owners of the device have this set to NULL. The lessor does not change once it's set in drm_lease_create(), and each lessee holds a reference to its lessor that it releases upon being destroyed in drm_lease_destroy(). See also the :ref:`section on display resource leasing `. ``lessee_id`` ID for lessees. Owners (i.e. **lessor** is NULL) always have ID 0. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. ``lessee_list`` List entry of lessees of **lessor**, where they are linked to **lessees**. Not used for owners. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. ``lessees`` List of drm_masters leasing from this one. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. This list is empty if no leases have been granted, or if all lessees have been destroyed. Since lessors are referenced by all their lessees, this master cannot be destroyed unless the list is empty. ``leases`` Objects leased to this drm_master. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. Objects are leased all together in drm_lease_create(), and are removed all together when the lease is revoked. ``lessee_idr`` All lessees under this owner (only used where **lessor** is NULL). Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK*hj ubh literal_block)}(hXGstruct drm_master { struct kref refcount; struct drm_device *dev; char *unique; int unique_len; struct idr magic_map; void *driver_priv; struct drm_master *lessor; int lessee_id; struct list_head lessee_list; struct list_head lessees; struct idr leases; struct idr lessee_idr; };h]hXGstruct drm_master { struct kref refcount; struct drm_device *dev; char *unique; int unique_len; struct idr magic_map; void *driver_priv; struct drm_master *lessor; int lessee_id; struct list_head lessee_list; struct list_head lessees; struct idr leases; struct idr lessee_idr; };}hj sbah}(h]h ]h"]h$]h&]hhuh1j hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK,hj ubh)}(h **Members**h]j)}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK;hj ubj1)}(hhh](j6)}(h.``refcount`` Refcount for this master object. h](j<)}(h ``refcount``h]j)}(hj h]hrefcount}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK)hj ubjV)}(hhh]h)}(h Refcount for this master object.h]h Refcount for this master object.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK)hj ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hj hK)hj ubj6)}(h$``dev`` Link back to the DRM device h](j<)}(h``dev``h]j)}(hj: h]hdev}(hj< hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK*hj4 ubjV)}(hhh]h)}(hLink back to the DRM deviceh]hLink back to the DRM device}(hjS hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjO hK*hjP ubah}(h]h ]h"]h$]h&]uh1jUhj4 ubeh}(h]h ]h"]h$]h&]uh1j5hjO hK*hj ubj6)}(hg``unique`` Unique identifier: e.g. busid. Protected by :c:type:`drm_device.master_mutex `. h](j<)}(h ``unique``h]j)}(hjs h]hunique}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjq ubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK5hjm ubjV)}(hhh]h)}(h[Unique identifier: e.g. busid. Protected by :c:type:`drm_device.master_mutex `.h](h,Unique identifier: e.g. busid. Protected by }(hj hhhNhNubh)}(h.:c:type:`drm_device.master_mutex `h]j)}(hj h]hdrm_device.master_mutex}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK4hj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj hK4hj ubah}(h]h ]h"]h$]h&]uh1jUhjm ubeh}(h]h ]h"]h$]h&]uh1j5hj hK5hj ubj6)}(hd``unique_len`` Length of unique field. Protected by :c:type:`drm_device.master_mutex `. h](j<)}(h``unique_len``h]j)}(hj h]h unique_len}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK:hj ubjV)}(hhh]h)}(hTLength of unique field. Protected by :c:type:`drm_device.master_mutex `.h](h%Length of unique field. Protected by }(hj hhhNhNubh)}(h.:c:type:`drm_device.master_mutex `h]j)}(hj h]hdrm_device.master_mutex}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK9hj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK9hj ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hj hK:hj ubj6)}(hn``magic_map`` Map of used authentication tokens. Protected by :c:type:`drm_device.master_mutex `. h](j<)}(h ``magic_map``h]j)}(hj-h]h magic_map}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK?hj'ubjV)}(hhh]h)}(h_Map of used authentication tokens. Protected by :c:type:`drm_device.master_mutex `.h](h0Map of used authentication tokens. Protected by }(hjFhhhNhNubh)}(h.:c:type:`drm_device.master_mutex `h]j)}(hjPh]hdrm_device.master_mutex}(hjRhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK>hjFubh.}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjmhK>hjCubah}(h]h ]h"]h$]h&]uh1jUhj'ubeh}(h]h ]h"]h$]h&]uh1j5hjBhK?hj ubj6)}(h7``driver_priv`` Pointer to driver-private information. h](j<)}(h``driver_priv``h]j)}(hjh]h driver_priv}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK+hjubjV)}(hhh]h)}(h&Pointer to driver-private information.h]h&Pointer to driver-private information.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK+hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhK+hj ubj6)}(hX``lessor`` Lease grantor, only set if this :c:type:`struct drm_master ` represents a lessee holding a lease of objects from **lessor**. Full owners of the device have this set to NULL. The lessor does not change once it's set in drm_lease_create(), and each lessee holds a reference to its lessor that it releases upon being destroyed in drm_lease_destroy(). See also the :ref:`section on display resource leasing `. h](j<)}(h ``lessor``h]j)}(hjh]hlessor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKNhjubjV)}(hhh](h)}(hLease grantor, only set if this :c:type:`struct drm_master ` represents a lessee holding a lease of objects from **lessor**. Full owners of the device have this set to NULL.h](h Lease grantor, only set if this }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKEhjubh5 represents a lessee holding a lease of objects from }(hjhhhNhNubj)}(h **lessor**h]hlessor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh2. Full owners of the device have this set to NULL.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKEhjubh)}(hThe lessor does not change once it's set in drm_lease_create(), and each lessee holds a reference to its lessor that it releases upon being destroyed in drm_lease_destroy().h]hThe lessor does not change once it’s set in drm_lease_create(), and each lessee holds a reference to its lessor that it releases upon being destroyed in drm_lease_destroy().}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKIhjubh)}(hFSee also the :ref:`section on display resource leasing `.h](h See also the }(hj/hhhNhNubh)}(h8:ref:`section on display resource leasing `h]hinline)}(hj9h]h#section on display resource leasing}(hj=hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hj7ubah}(h]h ]h"]h$]h&]refdocj refdomainjGreftyperef refexplicitrefwarnj drm_leasinguh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKMhj/ubh.}(hj/hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjYhKMhjubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKNhj ubj6)}(h``lessee_id`` ID for lessees. Owners (i.e. **lessor** is NULL) always have ID 0. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. h](j<)}(h ``lessee_id``h]j)}(hjvh]h lessee_id}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKVhjpubjV)}(hhh]h)}(hID for lessees. Owners (i.e. **lessor** is NULL) always have ID 0. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](hID for lessees. Owners (i.e. }(hjhhhNhNubj)}(h **lessor**h]hlessor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh) is NULL) always have ID 0. Protected by }(hjhhhNhNubh)}(h-:c:type:`drm_device.mode_config `h]j)}(hjh]hdrm_device.mode_config}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKUhjubh’s }(hjhhhNhNubh)}(h5:c:type:`drm_mode_config.idr_mutex `h]j)}(hjh]hdrm_mode_config.idr_mutex}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_configuh1hhjhKUhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKUhjubah}(h]h ]h"]h$]h&]uh1jUhjpubeh}(h]h ]h"]h$]h&]uh1j5hjhKVhj ubj6)}(h``lessee_list`` List entry of lessees of **lessor**, where they are linked to **lessees**. Not used for owners. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. h](j<)}(h``lessee_list``h]j)}(hjh]h lessee_list}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK_hjubjV)}(hhh]h)}(hList entry of lessees of **lessor**, where they are linked to **lessees**. Not used for owners. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](hList entry of lessees of }(hj!hhhNhNubj)}(h **lessor**h]hlessor}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh, where they are linked to }(hj!hhhNhNubj)}(h **lessees**h]hlessees}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh$. Not used for owners. Protected by }(hj!hhhNhNubh)}(h-:c:type:`drm_device.mode_config `h]j)}(hjOh]hdrm_device.mode_config}(hjQhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK]hj!ubh’s }(hj!hhhNhNubh)}(h5:c:type:`drm_mode_config.idr_mutex `h]j)}(hjsh]hdrm_mode_config.idr_mutex}(hjuhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_configuh1hhjlhK]hj!ubh.}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjlhK]hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhK_hj ubj6)}(hXs``lessees`` List of drm_masters leasing from this one. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. This list is empty if no leases have been granted, or if all lessees have been destroyed. Since lessors are referenced by all their lessees, this master cannot be destroyed unless the list is empty. h](j<)}(h ``lessees``h]j)}(hjh]hlessees}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKkhjubjV)}(hhh](h)}(hList of drm_masters leasing from this one. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](h8List of drm_masters leasing from this one. Protected by }(hjhhhNhNubh)}(h-:c:type:`drm_device.mode_config `h]j)}(hjh]hdrm_device.mode_config}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKfhjubh’s }(hjhhhNhNubh)}(h5:c:type:`drm_mode_config.idr_mutex `h]j)}(hjh]hdrm_mode_config.idr_mutex}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_configuh1hhjhKfhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKfhjubh)}(hThis list is empty if no leases have been granted, or if all lessees have been destroyed. Since lessors are referenced by all their lessees, this master cannot be destroyed unless the list is empty.h]hThis list is empty if no leases have been granted, or if all lessees have been destroyed. Since lessors are referenced by all their lessees, this master cannot be destroyed unless the list is empty.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKihjubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKkhj ubj6)}(hX``leases`` Objects leased to this drm_master. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `. Objects are leased all together in drm_lease_create(), and are removed all together when the lease is revoked. h](j<)}(h ``leases``h]j)}(hj;h]hleases}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKvhj5ubjV)}(hhh](h)}(hObjects leased to this drm_master. Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](h0Objects leased to this drm_master. Protected by }(hjThhhNhNubh)}(h-:c:type:`drm_device.mode_config `h]j)}(hj^h]hdrm_device.mode_config}(hj`hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKrhjTubh’s }(hjThhhNhNubh)}(h5:c:type:`drm_mode_config.idr_mutex `h]j)}(hjh]hdrm_mode_config.idr_mutex}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_configuh1hhj{hKrhjTubh.}(hjThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj{hKrhjQubh)}(hnObjects are leased all together in drm_lease_create(), and are removed all together when the lease is revoked.h]hnObjects are leased all together in drm_lease_create(), and are removed all together when the lease is revoked.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKuhjQubeh}(h]h ]h"]h$]h&]uh1jUhj5ubeh}(h]h ]h"]h$]h&]uh1j5hjPhKvhj ubj6)}(h``lessee_idr`` All lessees under this owner (only used where **lessor** is NULL). Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](j<)}(h``lessee_idr``h]j)}(hjh]h lessee_idr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK}hjubjV)}(hhh]h)}(hAll lessees under this owner (only used where **lessor** is NULL). Protected by :c:type:`drm_device.mode_config `'s :c:type:`drm_mode_config.idr_mutex `.h](h.All lessees under this owner (only used where }(hjhhhNhNubj)}(h **lessor**h]hlessor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh is NULL). Protected by }(hjhhhNhNubh)}(h-:c:type:`drm_device.mode_config `h]j)}(hjh]hdrm_device.mode_config}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhjhK}hjubh’s }(hjhhhNhNubh)}(h5:c:type:`drm_mode_config.idr_mutex `h]j)}(hj"h]hdrm_mode_config.idr_mutex}(hj$hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_configuh1hhjhK}hjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK}hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhK}hj ubeh}(h]h ]h"]h$]h&]uh1j0hj ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjhhhjD hNubh)}(h**Description**h]j)}(hjdh]h Description}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhKhjhhubh)}(hNote that master structures are only relevant for the legacy/primary device nodes, hence there can only be one per device, not one per drm_minor.h]hNote that master structures are only relevant for the legacy/primary device nodes, hence there can only be one per device, not one per drm_minor.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhS/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:37: ./include/drm/drm_auth.hhK,hjhhubj)}(h.. _drm_leasing:h]h}(h]h ]h"]h$]h&]j drm-leasinguh1jhK)hjhhhhubeh}(h](+primary-nodes-drm-master-and-authenticationjeh ]h"](,primary nodes, drm master and authenticationdrm_primary_nodeeh$]h&]uh1hhhhhhhhKexpect_referenced_by_name}jjsexpect_referenced_by_id}jjsubh)}(hhh](h)}(hDRM Display Resource Leasingh]hDRM Display Resource Leasing}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK,ubh)}(hDRM leases provide information about whether a DRM master may control a DRM mode setting object. This enables the creation of multiple DRM masters that manage subsets of display resources.h]hDRM leases provide information about whether a DRM master may control a DRM mode setting object. This enables the creation of multiple DRM masters that manage subsets of display resources.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chKhjhhubh)}(hXIThe original DRM master of a device 'owns' the available drm resources. It may create additional DRM masters and 'lease' resources which it controls to the new DRM master. This gives the new DRM master control over the leased resources until the owner revokes the lease, or the new DRM master is closed. Some helpful terminology:h]hXQThe original DRM master of a device ‘owns’ the available drm resources. It may create additional DRM masters and ‘lease’ resources which it controls to the new DRM master. This gives the new DRM master control over the leased resources until the owner revokes the lease, or the new DRM master is closed. Some helpful terminology:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chKhjhhubj+)}(hhh](j0)}(hX2An 'owner' is a :c:type:`struct drm_master ` that is not leasing objects from another :c:type:`struct drm_master `, and hence 'owns' the objects. The owner can be identified as the :c:type:`struct drm_master ` for which :c:type:`drm_master.lessor ` is NULL. h]h)}(hX1An 'owner' is a :c:type:`struct drm_master ` that is not leasing objects from another :c:type:`struct drm_master `, and hence 'owns' the objects. The owner can be identified as the :c:type:`struct drm_master ` for which :c:type:`drm_master.lessor ` is NULL.h](hAn ‘owner’ is a }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chKhjubh* that is not leasing objects from another }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhKhjubhG, and hence ‘owns’ the objects. The owner can be identified as the }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hj(h]hstruct drm_master}(hj*hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhKhjubh for which }(hjhhhNhNubh)}(h(:c:type:`drm_master.lessor `h]j)}(hjKh]hdrm_master.lessor}(hjMhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhKhjubh is NULL.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1j/hjubj0)}(hA 'lessor' is a :c:type:`struct drm_master ` which is leasing objects to one or more other :c:type:`struct drm_master `. Currently, lessees are not allowed to create sub-leases, hence the lessor is the same as the owner. h]h)}(hA 'lessor' is a :c:type:`struct drm_master ` which is leasing objects to one or more other :c:type:`struct drm_master `. Currently, lessees are not allowed to create sub-leases, hence the lessor is the same as the owner.h](hA ‘lessor’ is a }(hj|hhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chK!hj|ubh/ which is leasing objects to one or more other }(hj|hhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhK!hj|ubhe. Currently, lessees are not allowed to create sub-leases, hence the lessor is the same as the owner.}(hj|hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK!hjxubah}(h]h ]h"]h$]h&]uh1j/hjubj0)}(hXVA 'lessee' is a :c:type:`struct drm_master ` which is leasing objects from some other :c:type:`struct drm_master `. Each lessee only leases resources from a single lessor recorded in :c:type:`drm_master.lessor `, and holds the set of objects that it is leasing in :c:type:`drm_master.leases `. h]h)}(hXUA 'lessee' is a :c:type:`struct drm_master ` which is leasing objects from some other :c:type:`struct drm_master `. Each lessee only leases resources from a single lessor recorded in :c:type:`drm_master.lessor `, and holds the set of objects that it is leasing in :c:type:`drm_master.leases `.h](hA ‘lessee’ is a }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chK%hjubh* which is leasing objects from some other }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hj h]hstruct drm_master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhK%hjubhE. Each lessee only leases resources from a single lessor recorded in }(hjhhhNhNubh)}(h(:c:type:`drm_master.lessor `h]j)}(hj,h]hdrm_master.lessor}(hj.hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhK%hjubh5, and holds the set of objects that it is leasing in }(hjhhhNhNubh)}(h(:c:type:`drm_master.leases `h]j)}(hjOh]hdrm_master.leases}(hjQhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhjhK%hjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK%hjubah}(h]h ]h"]h$]h&]uh1j/hjubj0)}(hXA 'lease' is a contract between the lessor and lessee that identifies which resources may be controlled by the lessee. All of the resources that are leased must be owned by or leased to the lessor, and lessors are not permitted to lease the same object to multiple lessees. h]h)}(hXA 'lease' is a contract between the lessor and lessee that identifies which resources may be controlled by the lessee. All of the resources that are leased must be owned by or leased to the lessor, and lessors are not permitted to lease the same object to multiple lessees.h]hXA ‘lease’ is a contract between the lessor and lessee that identifies which resources may be controlled by the lessee. All of the resources that are leased must be owned by or leased to the lessor, and lessors are not permitted to lease the same object to multiple lessees.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chK*hj|ubah}(h]h ]h"]h$]h&]uh1j/hjubeh}(h]h ]h"]h$]h&]jjuh1j*hjhKhjhhubh)}(hThe set of objects any :c:type:`struct drm_master ` 'controls' is limited to the set of objects it leases (for lessees) or all objects (for owners).h](hThe set of objects any }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chK/hjubhe ‘controls’ is limited to the set of objects it leases (for lessees) or all objects (for owners).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK/hjhhubh)}(hXSObjects not controlled by a :c:type:`struct drm_master ` cannot be modified through the various state manipulating ioctls, and any state reported back to user space will be edited to make them appear idle and/or unusable. For instance, connectors always report 'disconnected', while encoders report no possible crtcs or clones.h](hObjects not controlled by a }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjh]hstruct drm_master}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chK2hjubhX cannot be modified through the various state manipulating ioctls, and any state reported back to user space will be edited to make them appear idle and/or unusable. For instance, connectors always report ‘disconnected’, while encoders report no possible crtcs or clones.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK2hjhhubh)}(hXSince each lessee may lease objects from a single lessor, display resource leases form a tree of :c:type:`struct drm_master `. As lessees are currently not allowed to create sub-leases, the tree depth is limited to 1. All of these get activated simultaneously when the top level device owner changes through the SETMASTER or DROPMASTER IOCTL, so :c:type:`drm_device.master ` points to the owner at the top of the lease tree (i.e. the :c:type:`struct drm_master ` for which :c:type:`drm_master.lessor ` is NULL). The full list of lessees that are leasing objects from the owner can be searched via the owner's :c:type:`drm_master.lessee_idr `.h](haSince each lessee may lease objects from a single lessor, display resource leases form a tree of }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hj h]hstruct drm_master}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhX/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:46: ./drivers/gpu/drm/drm_lease.chK8hjubh. As lessees are currently not allowed to create sub-leases, the tree depth is limited to 1. All of these get activated simultaneously when the top level device owner changes through the SETMASTER or DROPMASTER IOCTL, so }(hjhhhNhNubh)}(h(:c:type:`drm_device.master `h]j)}(hj-h]hdrm_device.master}(hj/hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhj&hK8hjubh< points to the owner at the top of the lease tree (i.e. the }(hjhhhNhNubh)}(h(:c:type:`struct drm_master `h]j)}(hjPh]hstruct drm_master}(hjRhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhj&hK8hjubh for which }(hjhhhNhNubh)}(h(:c:type:`drm_master.lessor `h]j)}(hjsh]hdrm_master.lessor}(hjuhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhj&hK8hjubhn is NULL). The full list of lessees that are leasing objects from the owner can be searched via the owner’s }(hjhhhNhNubh)}(h,:c:type:`drm_master.lessee_idr `h]j)}(hjh]hdrm_master.lessee_idr}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_masteruh1hhj&hK8hjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj&hK8hjhhubeh}(h](drm-display-resource-leasingjeh ]h"](drm display resource leasing drm_leasingeh$]h&]uh1hhhhhhhhK,j}jjsj}jjsubh)}(hhh](h)}(h"Open-Source Userspace Requirementsh]h"Open-Source Userspace Requirements}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK2ubh)}(hThe DRM subsystem has stricter requirements than most other kernel subsystems on what the userspace side for new uAPI needs to look like. This section here explains what exactly those requirements are, and why they exist.h]hThe DRM subsystem has stricter requirements than most other kernel subsystems on what the userspace side for new uAPI needs to look like. This section here explains what exactly those requirements are, and why they exist.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjhhubh)}(hThe short summary is that any addition of DRM uAPI requires corresponding open-sourced userspace patches, and those patches must be reviewed and ready for merging into a suitable and canonical upstream project.h]hThe short summary is that any addition of DRM uAPI requires corresponding open-sourced userspace patches, and those patches must be reviewed and ready for merging into a suitable and canonical upstream project.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK8hjhhubh)}(hXXGFX devices (both display and render/GPU side) are really complex bits of hardware, with userspace and kernel by necessity having to work together really closely. The interfaces, for rendering and modesetting, must be extremely wide and flexible, and therefore it is almost always impossible to precisely define them for every possible corner case. This in turn makes it really practically infeasible to differentiate between behaviour that's required by userspace, and which must not be changed to avoid regressions, and behaviour which is only an accidental artifact of the current implementation.h]hXZGFX devices (both display and render/GPU side) are really complex bits of hardware, with userspace and kernel by necessity having to work together really closely. The interfaces, for rendering and modesetting, must be extremely wide and flexible, and therefore it is almost always impossible to precisely define them for every possible corner case. This in turn makes it really practically infeasible to differentiate between behaviour that’s required by userspace, and which must not be changed to avoid regressions, and behaviour which is only an accidental artifact of the current implementation.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK. Additionally, a currently unused control node, called controlD is also created. The primary node provides all legacy operations and historically was the only interface used by userspace. With KMS, the control node was introduced. However, the planned KMS control interface has never been written and so the control node stays unused to date.h]hXBDRM core provides multiple character-devices for user-space to use. Depending on which device is opened, user-space can perform a different set of operations (mainly ioctls). The primary node is always created and called card. Additionally, a currently unused control node, called controlD is also created. The primary node provides all legacy operations and historically was the only interface used by userspace. With KMS, the control node was introduced. However, the planned KMS control interface has never been written and so the control node stays unused to date.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK~hjhhubh)}(hXWith the increased use of offscreen renderers and GPGPU applications, clients no longer require running compositors or graphics servers to make use of a GPU. But the DRM API required unprivileged clients to authenticate to a DRM-Master prior to getting GPU access. To avoid this step and to grant clients GPU access without authenticating, render nodes were introduced. Render nodes solely serve render clients, that is, no modesetting or privileged ioctls can be issued on render nodes. Only non-global rendering commands are allowed. If a driver supports render nodes, it must advertise it via the DRIVER_RENDER DRM driver capability. If not supported, the primary node must be used for render clients together with the legacy drmAuth authentication procedure.h]hXWith the increased use of offscreen renderers and GPGPU applications, clients no longer require running compositors or graphics servers to make use of a GPU. But the DRM API required unprivileged clients to authenticate to a DRM-Master prior to getting GPU access. To avoid this step and to grant clients GPU access without authenticating, render nodes were introduced. Render nodes solely serve render clients, that is, no modesetting or privileged ioctls can be issued on render nodes. Only non-global rendering commands are allowed. If a driver supports render nodes, it must advertise it via the DRIVER_RENDER DRM driver capability. If not supported, the primary node must be used for render clients together with the legacy drmAuth authentication procedure.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hX If a driver advertises render node support, DRM core will create a separate render node called renderD. There will be one render node per device. No ioctls except PRIME-related ioctls will be allowed on this node. Especially GEM_OPEN will be explicitly prohibited. For a complete list of driver-independent ioctls that can be used on render nodes, see the ioctls marked DRM_RENDER_ALLOW in drm_ioctl.c Render nodes are designed to avoid the buffer-leaks, which occur if clients guess the flink names or mmap offsets on the legacy interface. Additionally to this basic interface, drivers must mark their driver-dependent render-only ioctls as DRM_RENDER_ALLOW so render clients can use them. Driver authors must be careful not to allow any privileged ioctls on render nodes.h]hX If a driver advertises render node support, DRM core will create a separate render node called renderD. There will be one render node per device. No ioctls except PRIME-related ioctls will be allowed on this node. Especially GEM_OPEN will be explicitly prohibited. For a complete list of driver-independent ioctls that can be used on render nodes, see the ioctls marked DRM_RENDER_ALLOW in drm_ioctl.c Render nodes are designed to avoid the buffer-leaks, which occur if clients guess the flink names or mmap offsets on the legacy interface. Additionally to this basic interface, drivers must mark their driver-dependent render-only ioctls as DRM_RENDER_ALLOW so render clients can use them. Driver authors must be careful not to allow any privileged ioctls on render nodes.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hXWith render nodes, user-space can now control access to the render node via basic file-system access-modes. A running graphics server which authenticates clients on the privileged primary/legacy node is no longer required. Instead, a client can open the render node and is immediately granted GPU access. Communication between clients (or servers) is done via PRIME. FLINK from render node to legacy node is not supported. New clients must not use the insecure FLINK interface.h]hXWith render nodes, user-space can now control access to the render node via basic file-system access-modes. A running graphics server which authenticates clients on the privileged primary/legacy node is no longer required. Instead, a client can open the render node and is immediately granted GPU access. Communication between clients (or servers) is done via PRIME. FLINK from render node to legacy node is not supported. New clients must not use the insecure FLINK interface.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hX Besides dropping all modeset/global ioctls, render nodes also drop the DRM-Master concept. There is no reason to associate render clients with a DRM-Master as they are independent of any graphics server. Besides, they must work without any running master, anyway. Drivers must be able to run without a master object if they support render nodes. If, on the other hand, a driver requires shared state between clients which is visible to user-space and accessible beyond open-file boundaries, they cannot support render nodes.h]hX Besides dropping all modeset/global ioctls, render nodes also drop the DRM-Master concept. There is no reason to associate render clients with a DRM-Master as they are independent of any graphics server. Besides, they must work without any running master, anyway. Drivers must be able to run without a master object if they support render nodes. If, on the other hand, a driver requires shared state between clients which is visible to user-space and accessible beyond open-file boundaries, they cannot support render nodes.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]( render-nodesjeh ]h"]( render nodesdrm_render_nodeeh$]h&]uh1hhhhhhhhK|j}jcjsj}jjsubh)}(hhh](h)}(hDevice Hot-Unplugh]hDevice Hot-Unplug}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhhKubhnote)}(hFThe following is the plan. Implementation is not there yet (2020 May).h]h)}(hFThe following is the plan. Implementation is not there yet (2020 May).h]hFThe following is the plan. Implementation is not there yet (2020 May).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj{ubah}(h]h ]h"]h$]h&]uh1jyhjhhhhhhNubh)}(hXGraphics devices (display and/or render) may be connected via USB (e.g. display adapters or docking stations) or Thunderbolt (e.g. eGPU). An end user is able to hot-unplug this kind of devices while they are being used, and expects that the very least the machine does not crash. Any damage from hot-unplugging a DRM device needs to be limited as much as possible and userspace must be given the chance to handle it if it wants to. Ideally, unplugging a DRM device still lets a desktop continue to run, but that is going to need explicit support throughout the whole graphics stack: from kernel and userspace drivers, through display servers, via window system protocols, and in applications and libraries.h]hXGraphics devices (display and/or render) may be connected via USB (e.g. display adapters or docking stations) or Thunderbolt (e.g. eGPU). An end user is able to hot-unplug this kind of devices while they are being used, and expects that the very least the machine does not crash. Any damage from hot-unplugging a DRM device needs to be limited as much as possible and userspace must be given the chance to handle it if it wants to. Ideally, unplugging a DRM device still lets a desktop continue to run, but that is going to need explicit support throughout the whole graphics stack: from kernel and userspace drivers, through display servers, via window system protocols, and in applications and libraries.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hOther scenarios that should lead to the same are: unrecoverable GPU crash, PCI device disappearing off the bus, or forced unbind of a driver from the physical device.h]hOther scenarios that should lead to the same are: unrecoverable GPU crash, PCI device disappearing off the bus, or forced unbind of a driver from the physical device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hXoIn other words, from userspace perspective everything needs to keep on working more or less, until userspace stops using the disappeared DRM device and closes it completely. Userspace will learn of the device disappearance from the device removed uevent, ioctls returning ENODEV (or driver-specific ioctls returning driver-specific things), or open() returning ENXIO.h]hXoIn other words, from userspace perspective everything needs to keep on working more or less, until userspace stops using the disappeared DRM device and closes it completely. Userspace will learn of the device disappearance from the device removed uevent, ioctls returning ENODEV (or driver-specific ioctls returning driver-specific things), or open() returning ENXIO.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hXOnly after userspace has closed all relevant DRM device and dmabuf file descriptors and removed all mmaps, the DRM driver can tear down its instance for the device that no longer exists. If the same physical device somehow comes back in the mean time, it shall be a new DRM device.h]hXOnly after userspace has closed all relevant DRM device and dmabuf file descriptors and removed all mmaps, the DRM driver can tear down its instance for the device that no longer exists. If the same physical device somehow comes back in the mean time, it shall be a new DRM device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hSimilar to PIDs, chardev minor numbers are not recycled immediately. A new DRM device always picks the next free minor number compared to the previous one allocated, and wraps around when minor numbers are exhausted.h]hSimilar to PIDs, chardev minor numbers are not recycled immediately. A new DRM device always picks the next free minor number compared to the previous one allocated, and wraps around when minor numbers are exhausted.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hOThe goal raises at least the following requirements for the kernel and drivers.h]hOThe goal raises at least the following requirements for the kernel and drivers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hhh](h)}(hRequirements for KMS UAPIh]hRequirements for KMS UAPI}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubj+)}(hhh](j0)}(h9KMS connectors must change their status to disconnected. h]h)}(h8KMS connectors must change their status to disconnected.h]h8KMS connectors must change their status to disconnected.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hLegacy modesets and pageflips, and atomic commits, both real and TEST_ONLY, and any other ioctls either fail with ENODEV or fake success. h]h)}(hLegacy modesets and pageflips, and atomic commits, both real and TEST_ONLY, and any other ioctls either fail with ENODEV or fake success.h]hLegacy modesets and pageflips, and atomic commits, both real and TEST_ONLY, and any other ioctls either fail with ENODEV or fake success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hPending non-blocking KMS operations deliver the DRM events userspace is expecting. This applies also to ioctls that faked success. h]h)}(hPending non-blocking KMS operations deliver the DRM events userspace is expecting. This applies also to ioctls that faked success.h]hPending non-blocking KMS operations deliver the DRM events userspace is expecting. This applies also to ioctls that faked success.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj+ubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hVopen() on a device node whose underlying device has disappeared will fail with ENXIO. h]h)}(hUopen() on a device node whose underlying device has disappeared will fail with ENXIO.h]hUopen() on a device node whose underlying device has disappeared will fail with ENXIO.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjCubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hAttempting to create a DRM lease on a disappeared DRM device will fail with ENODEV. Existing DRM leases remain and work as listed above. h]h)}(hAttempting to create a DRM lease on a disappeared DRM device will fail with ENODEV. Existing DRM leases remain and work as listed above.h]hAttempting to create a DRM lease on a disappeared DRM device will fail with ENODEV. Existing DRM leases remain and work as listed above.}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj[ubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubeh}(h]h ]h"]h$]h&]jjuh1j*hhhKhjhhubeh}(h]requirements-for-kms-uapiah ]h"]requirements for kms uapiah$]h&]uh1hhjhhhhhhKubh)}(hhh](h)}(h-Requirements for Render and Cross-Device UAPIh]h-Requirements for Render and Cross-Device UAPI}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubj+)}(hhh](j0)}(hAll GPU jobs that can no longer run must have their fences force-signalled to avoid inflicting hangs on userspace. The associated error code is ENODEV. h]h)}(hAll GPU jobs that can no longer run must have their fences force-signalled to avoid inflicting hangs on userspace. The associated error code is ENODEV.h]hAll GPU jobs that can no longer run must have their fences force-signalled to avoid inflicting hangs on userspace. The associated error code is ENODEV.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hXaSome userspace APIs already define what should happen when the device disappears (OpenGL, GL ES: `GL_KHR_robustness`_; `Vulkan`_: VK_ERROR_DEVICE_LOST; etc.). DRM drivers are free to implement this behaviour the way they see best, e.g. returning failures in driver-specific ioctls and handling those in userspace drivers, or rely on uevents, and so on. h]h)}(hX`Some userspace APIs already define what should happen when the device disappears (OpenGL, GL ES: `GL_KHR_robustness`_; `Vulkan`_: VK_ERROR_DEVICE_LOST; etc.). DRM drivers are free to implement this behaviour the way they see best, e.g. returning failures in driver-specific ioctls and handling those in userspace drivers, or rely on uevents, and so on.h](haSome userspace APIs already define what should happen when the device disappears (OpenGL, GL ES: }(hjhhhNhNubh reference)}(h`GL_KHR_robustness`_h]hGL_KHR_robustness}(hjhhhNhNubah}(h]h ]h"]h$]h&]nameGL_KHR_robustnessrefuriIhttps://www.khronos.org/registry/OpenGL/extensions/KHR/KHR_robustness.txtuh1jhjresolvedKubh; }(hjhhhNhNubj)}(h `Vulkan`_h]hVulkan}(hjhhhNhNubah}(h]h ]h"]h$]h&]nameVulkanjhttps://www.khronos.org/vulkan/uh1jhjjKubh: VK_ERROR_DEVICE_LOST; etc.). DRM drivers are free to implement this behaviour the way they see best, e.g. returning failures in driver-specific ioctls and handling those in userspace drivers, or rely on uevents, and so on.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hdmabuf which point to memory that has disappeared will either fail to import with ENODEV or continue to be successfully imported if it would have succeeded before the disappearance. See also about memory maps below for already imported dmabufs. h]h)}(hdmabuf which point to memory that has disappeared will either fail to import with ENODEV or continue to be successfully imported if it would have succeeded before the disappearance. See also about memory maps below for already imported dmabufs.h]hdmabuf which point to memory that has disappeared will either fail to import with ENODEV or continue to be successfully imported if it would have succeeded before the disappearance. See also about memory maps below for already imported dmabufs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hAttempting to import a dmabuf to a disappeared device will either fail with ENODEV or succeed if it would have succeeded without the disappearance. h]h)}(hAttempting to import a dmabuf to a disappeared device will either fail with ENODEV or succeed if it would have succeeded without the disappearance.h]hAttempting to import a dmabuf to a disappeared device will either fail with ENODEV or succeed if it would have succeeded without the disappearance.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubj0)}(hVopen() on a device node whose underlying device has disappeared will fail with ENXIO. h]h)}(hUopen() on a device node whose underlying device has disappeared will fail with ENXIO.h]hUopen() on a device node whose underlying device has disappeared will fail with ENXIO.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#ubah}(h]h ]h"]h$]h&]uh1j/hjhhhhhNubeh}(h]h ]h"]h$]h&]jjuh1j*hhhKhjhhubj)}(h`.. _GL_KHR_robustness: https://www.khronos.org/registry/OpenGL/extensions/KHR/KHR_robustness.txth]h}(h]gl-khr-robustnessah ]h"]gl_khr_robustnessah$]h&]jjuh1jhM hjhhhh referencedKubj)}(h+.. _Vulkan: https://www.khronos.org/vulkan/h]h}(h]vulkanah ]h"]vulkanah$]h&]jjuh1jhM hjhhhhjMKubeh}(h]-requirements-for-render-and-cross-device-uapiah ]h"]-requirements for render and cross-device uapiah$]h&]uh1hhjhhhhhhKubh)}(hhh](h)}(hRequirements for Memory Mapsh]hRequirements for Memory Maps}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhjbhhhhhMubh)}(hXMemory maps have further requirements that apply to both existing maps and maps created after the device has disappeared. If the underlying memory disappears, the map is created or modified such that reads and writes will still complete successfully but the result is undefined. This applies to both userspace mmap()'d memory and memory pointed to by dmabuf which might be mapped to other devices (cross-device dmabuf imports).h]hXMemory maps have further requirements that apply to both existing maps and maps created after the device has disappeared. If the underlying memory disappears, the map is created or modified such that reads and writes will still complete successfully but the result is undefined. This applies to both userspace mmap()’d memory and memory pointed to by dmabuf which might be mapped to other devices (cross-device dmabuf imports).}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubh)}(hXRaising SIGBUS is not an option, because userspace cannot realistically handle it. Signal handlers are global, which makes them extremely difficult to use correctly from libraries like those that Mesa produces. Signal handlers are not composable, you can't have different handlers for GPU1 and GPU2 from different vendors, and a third handler for mmapped regular files. Threads cause additional pain with signal handling as well.h]hXRaising SIGBUS is not an option, because userspace cannot realistically handle it. Signal handlers are global, which makes them extremely difficult to use correctly from libraries like those that Mesa produces. Signal handlers are not composable, you can’t have different handlers for GPU1 and GPU2 from different vendors, and a third handler for mmapped regular files. Threads cause additional pain with signal handling as well.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubeh}(h]requirements-for-memory-mapsah ]h"]requirements for memory mapsah$]h&]uh1hhjhhhhhhMubeh}(h]device-hot-unplugah ]h"]device hot-unplugah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Device reseth]h Device reset}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM!ubh)}(hX^The GPU stack is really complex and is prone to errors, from hardware bugs, faulty applications and everything in between the many layers. Some errors require resetting the device in order to make the device usable again. This section describes the expectations for DRM and usermode drivers when a device resets and how to propagate the reset status.h]hX^The GPU stack is really complex and is prone to errors, from hardware bugs, faulty applications and everything in between the many layers. Some errors require resetting the device in order to make the device usable again. This section describes the expectations for DRM and usermode drivers when a device resets and how to propagate the reset status.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM#hjhhubh)}(hXDevice resets can not be disabled without tainting the kernel, which can lead to hanging the entire kernel through shrinkers/mmu_notifiers. Userspace role in device resets is to propagate the message to the application and apply any special policy for blocking guilty applications, if any. Corollary is that debugging a hung GPU context require hardware support to be able to preempt such a GPU context while it's stopped.h]hXDevice resets can not be disabled without tainting the kernel, which can lead to hanging the entire kernel through shrinkers/mmu_notifiers. Userspace role in device resets is to propagate the message to the application and apply any special policy for blocking guilty applications, if any. Corollary is that debugging a hung GPU context require hardware support to be able to preempt such a GPU context while it’s stopped.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM)hjhhubh)}(hhh](h)}(hKernel Mode Driverh]hKernel Mode Driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM1ubh)}(hThe KMD is responsible for checking if the device needs a reset, and to perform it as needed. Usually a hang is detected when a job gets stuck executing.h]hThe KMD is responsible for checking if the device needs a reset, and to perform it as needed. Usually a hang is detected when a job gets stuck executing.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM3hjhhubh)}(hXPropagation of errors to userspace has proven to be tricky since it goes in the opposite direction of the usual flow of commands. Because of this vendor independent error handling was added to the &dma_fence object, this way drivers can add an error code to their fences before signaling them. See function dma_fence_set_error() on how to do this and for examples of error codes to use.h]hXPropagation of errors to userspace has proven to be tricky since it goes in the opposite direction of the usual flow of commands. Because of this vendor independent error handling was added to the &dma_fence object, this way drivers can add an error code to their fences before signaling them. See function dma_fence_set_error() on how to do this and for examples of error codes to use.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM6hjhhubh)}(hXThe DRM scheduler also allows setting error codes on all pending fences when hardware submissions are restarted after an reset. Error codes are also forwarded from the hardware fence to the scheduler fence to bubble up errors to the higher levels of the stack and eventually userspace.h]hXThe DRM scheduler also allows setting error codes on all pending fences when hardware submissions are restarted after an reset. Error codes are also forwarded from the hardware fence to the scheduler fence to bubble up errors to the higher levels of the stack and eventually userspace.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM<hjhhubh)}(hFence errors can be queried by userspace through the generic SYNC_IOC_FILE_INFO IOCTL as well as through driver specific interfaces.h]hFence errors can be queried by userspace through the generic SYNC_IOC_FILE_INFO IOCTL as well as through driver specific interfaces.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMAhjhhubh)}(hXAdditional to setting fence errors drivers should also keep track of resets per context, the DRM scheduler provides the drm_sched_entity_error() function as helper for this use case. After a reset, KMD should reject new command submissions for affected contexts.h]hXAdditional to setting fence errors drivers should also keep track of resets per context, the DRM scheduler provides the drm_sched_entity_error() function as helper for this use case. After a reset, KMD should reject new command submissions for affected contexts.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMDhjhhubeh}(h]kernel-mode-driverah ]h"]kernel mode driverah$]h&]uh1hhjhhhhhM1ubh)}(hhh](h)}(hUser Mode Driverh]hUser Mode Driver}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hhhhhMJubh)}(hXAfter command submission, UMD should check if the submission was accepted or rejected. After a reset, KMD should reject submissions, and UMD can issue an ioctl to the KMD to check the reset status, and this can be checked more often if the UMD requires it. After detecting a reset, UMD will then proceed to report it to the application using the appropriate API error code, as explained in the section below about robustness.h]hXAfter command submission, UMD should check if the submission was accepted or rejected. After a reset, KMD should reject submissions, and UMD can issue an ioctl to the KMD to check the reset status, and this can be checked more often if the UMD requires it. After detecting a reset, UMD will then proceed to report it to the application using the appropriate API error code, as explained in the section below about robustness.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhj+hhubeh}(h]user-mode-driverah ]h"]user mode driverah$]h&]uh1hhjhhhhhMJubh)}(hhh](h)}(h Robustnessh]h Robustness}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhhhhhMTubh)}(hThe only way to try to keep a graphical API context working after a reset is if it complies with the robustness aspects of the graphical API that it is using.h]hThe only way to try to keep a graphical API context working after a reset is if it complies with the robustness aspects of the graphical API that it is using.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMVhjRhhubh)}(hXGraphical APIs provide ways to applications to deal with device resets. However, there is no guarantee that the app will use such features correctly, and a userspace that doesn't support robust interfaces (like a non-robust OpenGL context or API without any robustness support like libva) leave the robustness handling entirely to the userspace driver. There is no strong community consensus on what the userspace driver should do in that case, since all reasonable approaches have some clear downsides.h]hXGraphical APIs provide ways to applications to deal with device resets. However, there is no guarantee that the app will use such features correctly, and a userspace that doesn’t support robust interfaces (like a non-robust OpenGL context or API without any robustness support like libva) leave the robustness handling entirely to the userspace driver. There is no strong community consensus on what the userspace driver should do in that case, since all reasonable approaches have some clear downsides.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMYhjRhhubh)}(hhh](h)}(hOpenGLh]hOpenGL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMbubh)}(hX`Apps using OpenGL should use the available robust interfaces, like the extension ``GL_ARB_robustness`` (or ``GL_EXT_robustness`` for OpenGL ES). This interface tells if a reset has happened, and if so, all the context state is considered lost and the app proceeds by creating new ones. There's no consensus on what to do to if robustness is not in use.h](hQApps using OpenGL should use the available robust interfaces, like the extension }(hjhhhNhNubj)}(h``GL_ARB_robustness``h]hGL_ARB_robustness}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh (or }(hjhhhNhNubj)}(h``GL_EXT_robustness``h]hGL_EXT_robustness}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh for OpenGL ES). This interface tells if a reset has happened, and if so, all the context state is considered lost and the app proceeds by creating new ones. There’s no consensus on what to do to if robustness is not in use.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMdhjhhubeh}(h]openglah ]h"]openglah$]h&]uh1hhjRhhhhhMbubh)}(hhh](h)}(hVulkanh]hVulkan}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMkubh)}(hApps using Vulkan should check for ``VK_ERROR_DEVICE_LOST`` for submissions. This error code means, among other things, that a device reset has happened and it needs to recreate the contexts to keep going.h](h#Apps using Vulkan should check for }(hjhhhNhNubj)}(h``VK_ERROR_DEVICE_LOST``h]hVK_ERROR_DEVICE_LOST}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh for submissions. This error code means, among other things, that a device reset has happened and it needs to recreate the contexts to keep going.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMmhjhhubeh}(h]id1ah ]h"]h$]vulkanah&]uh1hhjRhhhhhMkjMKubeh}(h] robustnessah ]h"] robustnessah$]h&]uh1hhjhhhhhMTubh)}(hhh](h)}(hReporting causes of resetsh]hReporting causes of resets}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMrubh)}(hXApart from propagating the reset through the stack so apps can recover, it's really useful for driver developers to learn more about what caused the reset in the first place. For this, drivers can make use of devcoredump to store relevant information about the reset and send device wedged event with ``none`` recovery method (as explained in "Device Wedging" chapter) to notify userspace, so this information can be collected and added to user bug reports.h](hX/Apart from propagating the reset through the stack so apps can recover, it’s really useful for driver developers to learn more about what caused the reset in the first place. For this, drivers can make use of devcoredump to store relevant information about the reset and send device wedged event with }(hjhhhNhNubj)}(h``none``h]hnone}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh recovery method (as explained in “Device Wedging” chapter) to notify userspace, so this information can be collected and added to user bug reports.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMthj hhubeh}(h]reporting-causes-of-resetsah ]h"]reporting causes of resetsah$]h&]uh1hhjhhhhhMrubeh}(h] device-resetah ]h"] device resetah$]h&]uh1hhhhhhhhM!ubh)}(hhh](h)}(hDevice Wedgingh]hDevice Wedging}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhhhhhM|ubh)}(hXsDrivers can optionally make use of device wedged event (implemented as drm_dev_wedged_event() in DRM subsystem), which notifies userspace of 'wedged' (hanged/unusable) state of the DRM device through a uevent. This is useful especially in cases where the device is no longer operating as expected and has become unrecoverable from driver context. Purpose of this implementation is to provide drivers a generic way to recover the device with the help of userspace intervention, without taking any drastic measures (like resetting or re-enumerating the full bus, on which the underlying physical device is sitting) in the driver.h]hXwDrivers can optionally make use of device wedged event (implemented as drm_dev_wedged_event() in DRM subsystem), which notifies userspace of ‘wedged’ (hanged/unusable) state of the DRM device through a uevent. This is useful especially in cases where the device is no longer operating as expected and has become unrecoverable from driver context. Purpose of this implementation is to provide drivers a generic way to recover the device with the help of userspace intervention, without taking any drastic measures (like resetting or re-enumerating the full bus, on which the underlying physical device is sitting) in the driver.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM~hjLhhubh)}(hXA 'wedged' device is basically a device that is declared dead by the driver after exhausting all possible attempts to recover it from driver context. The uevent is the notification that is sent to userspace along with a hint about what could possibly be attempted to recover the device from userspace and bring it back to usable state. Different drivers may have different ideas of a 'wedged' device depending on hardware implementation of the underlying physical device, and hence the vendor agnostic nature of the event. It is up to the drivers to decide when they see the need for device recovery and how they want to recover from the available methods.h]hXA ‘wedged’ device is basically a device that is declared dead by the driver after exhausting all possible attempts to recover it from driver context. The uevent is the notification that is sent to userspace along with a hint about what could possibly be attempted to recover the device from userspace and bring it back to usable state. Different drivers may have different ideas of a ‘wedged’ device depending on hardware implementation of the underlying physical device, and hence the vendor agnostic nature of the event. It is up to the drivers to decide when they see the need for device recovery and how they want to recover from the available methods.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjLhhubh)}(hhh](h)}(hDriver prerequisitesh]hDriver prerequisites}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhhhhhMubh)}(hXSThe driver, before opting for recovery, needs to make sure that the 'wedged' device doesn't harm the system as a whole by taking care of the prerequisites. Necessary actions must include disabling DMA to system memory as well as any communication channels with other devices. Further, the driver must ensure that all dma_fences are signalled and any device state that the core kernel might depend on is cleaned up. All existing mmaps should be invalidated and page faults should be redirected to a dummy page. Once the event is sent, the device must be kept in 'wedged' state until the recovery is performed. New accesses to the device (IOCTLs) should be rejected, preferably with an error code that resembles the type of failure the device has encountered. This will signify the reason for wedging, which can be reported to the application if needed.h]hX]The driver, before opting for recovery, needs to make sure that the ‘wedged’ device doesn’t harm the system as a whole by taking care of the prerequisites. Necessary actions must include disabling DMA to system memory as well as any communication channels with other devices. Further, the driver must ensure that all dma_fences are signalled and any device state that the core kernel might depend on is cleaned up. All existing mmaps should be invalidated and page faults should be redirected to a dummy page. Once the event is sent, the device must be kept in ‘wedged’ state until the recovery is performed. New accesses to the device (IOCTLs) should be rejected, preferably with an error code that resembles the type of failure the device has encountered. This will signify the reason for wedging, which can be reported to the application if needed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjyhhubeh}(h]driver-prerequisitesah ]h"]driver prerequisitesah$]h&]uh1hhjLhhhhhMubh)}(hhh](h)}(hRecoveryh]hRecovery}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hXCurrent implementation defines three recovery methods, out of which, drivers can use any one, multiple or none. Method(s) of choice will be sent in the uevent environment as ``WEDGED=[,..,]`` in order of less to more side-effects. If driver is unsure about recovery or method is unknown (like soft/hard system reboot, firmware flashing, physical device replacement or any other procedure which can't be attempted on the fly), ``WEDGED=unknown`` will be sent instead.h](hCurrent implementation defines three recovery methods, out of which, drivers can use any one, multiple or none. Method(s) of choice will be sent in the uevent environment as }(hjhhhNhNubj)}(h#``WEDGED=[,..,]``h]hWEDGED=[,..,]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh in order of less to more side-effects. If driver is unsure about recovery or method is unknown (like soft/hard system reboot, firmware flashing, physical device replacement or any other procedure which can’t be attempted on the fly), }(hjhhhNhNubj)}(h``WEDGED=unknown``h]hWEDGED=unknown}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be sent instead.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h`Userspace consumers can parse this event and attempt recovery as per the following expectations.h]h`Userspace consumers can parse this event and attempt recovery as per the following expectations.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj%)}(hX}=============== ======================================== Recovery method Consumer expectations =============== ======================================== none optional telemetry collection rebind unbind + bind driver bus-reset unbind + bus reset/re-enumeration + bind unknown consumer policy =============== ======================================== h]htable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthK(uh1jhjubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(hRecovery methodh]hRecovery method}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj!ubah}(h]h ]h"]h$]h&]uh1jhjubj )}(hhh]h)}(hConsumer expectationsh]hConsumer expectations}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj8ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubhtbody)}(hhh](j)}(hhh](j )}(hhh]h)}(hnoneh]hnone}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjcubah}(h]h ]h"]h$]h&]uh1jhj`ubj )}(hhh]h)}(hoptional telemetry collectionh]hoptional telemetry collection}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjzubah}(h]h ]h"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]uh1jhj]ubj)}(hhh](j )}(hhh]h)}(hrebindh]hrebind}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj )}(hhh]h)}(hunbind + bind driverh]hunbind + bind driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj]ubj)}(hhh](j )}(hhh]h)}(h bus-reseth]h bus-reset}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj )}(hhh]h)}(h(unbind + bus reset/re-enumeration + bindh]h(unbind + bus reset/re-enumeration + bind}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj]ubj)}(hhh](j )}(hhh]h)}(hunknownh]hunknown}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj )}(hhh]h)}(hconsumer policyh]hconsumer policy}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj]ubeh}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j$hhhMhjhhubh)}(hXThe only exception to this is ``WEDGED=none``, which signifies that the device was temporarily 'wedged' at some point but was recovered from driver context using device specific methods like reset. No explicit recovery is expected from the consumer in this case, but it can still take additional steps like gathering telemetry information (devcoredump, syslog). This is useful because the first hang is usually the most critical one which can result in consequential hangs or complete wedging.h](hThe only exception to this is }(hjUhhhNhNubj)}(h``WEDGED=none``h]h WEDGED=none}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubhX, which signifies that the device was temporarily ‘wedged’ at some point but was recovered from driver context using device specific methods like reset. No explicit recovery is expected from the consumer in this case, but it can still take additional steps like gathering telemetry information (devcoredump, syslog). This is useful because the first hang is usually the most critical one which can result in consequential hangs or complete wedging.}(hjUhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]recoveryah ]h"]recoveryah$]h&]uh1hhjLhhhhhMubh)}(hhh](h)}(hConsumer prerequisitesh]hConsumer prerequisites}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj}hhhhhMubh)}(hXIt is the responsibility of the consumer to make sure that the device or its resources are not in use by any process before attempting recovery. With IOCTLs erroring out, all device memory should be unmapped and file descriptors should be closed to prevent leaks or undefined behaviour. The idea here is to clear the device of all user context beforehand and set the stage for a clean recovery.h]hXIt is the responsibility of the consumer to make sure that the device or its resources are not in use by any process before attempting recovery. With IOCTLs erroring out, all device memory should be unmapped and file descriptors should be closed to prevent leaks or undefined behaviour. The idea here is to clear the device of all user context beforehand and set the stage for a clean recovery.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj}hhubeh}(h]consumer-prerequisitesah ]h"]consumer prerequisitesah$]h&]uh1hhjLhhhhhMubh)}(hhh](h)}(hExampleh]hExample}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(h Udev rule::h]h Udev rule:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj )}(hlSUBSYSTEM=="drm", ENV{WEDGED}=="rebind", DEVPATH=="*/drm/card[0-9]", RUN+="/path/to/rebind.sh $env{DEVPATH}"h]hlSUBSYSTEM=="drm", ENV{WEDGED}=="rebind", DEVPATH=="*/drm/card[0-9]", RUN+="/path/to/rebind.sh $env{DEVPATH}"}hjsbah}(h]h ]h"]h$]h&]hhuh1j hhhMhjhhubh)}(hRecovery script::h]hRecovery script:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj )}(h#!/bin/sh DEVPATH=$(readlink -f /sys/$1/device) DEVICE=$(basename $DEVPATH) DRIVER=$(readlink -f $DEVPATH/driver) echo -n $DEVICE > $DRIVER/unbind echo -n $DEVICE > $DRIVER/bindh]h#!/bin/sh DEVPATH=$(readlink -f /sys/$1/device) DEVICE=$(basename $DEVPATH) DRIVER=$(readlink -f $DEVPATH/driver) echo -n $DEVICE > $DRIVER/unbind echo -n $DEVICE > $DRIVER/bind}hjsbah}(h]h ]h"]h$]h&]hhuh1j hhhMhjhhubeh}(h]exampleah ]h"]exampleah$]h&]uh1hhjLhhhhhMubh)}(hhh](h)}(h Customizationh]h Customization}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hXAlthough basic recovery is possible with a simple script, consumers can define custom policies around recovery. For example, if the driver supports multiple recovery methods, consumers can opt for the suitable one depending on scenarios like repeat offences or vendor specific failures. Consumers can also choose to have the device available for debugging or telemetry collection and base their recovery decision on the findings. This is useful especially when the driver is unsure about recovery or method is unknown.h]hXAlthough basic recovery is possible with a simple script, consumers can define custom policies around recovery. For example, if the driver supports multiple recovery methods, consumers can opt for the suitable one depending on scenarios like repeat offences or vendor specific failures. Consumers can also choose to have the device available for debugging or telemetry collection and base their recovery decision on the findings. This is useful especially when the driver is unsure about recovery or method is unknown.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h.. _drm_driver_ioctl:h]h}(h]h ]h"]h$]h&]jdrm-driver-ioctluh1jhMhjhhhhubeh}(h] customizationah ]h"] customizationah$]h&]uh1hhjLhhhhhMubeh}(h]device-wedgingah ]h"]device wedgingah$]h&]uh1hhhhhhhhM|ubh)}(hhh](h)}(hIOCTL Support on Device Nodesh]hIOCTL Support on Device Nodes}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hhhhhMubh)}(hX6First things first, driver private IOCTLs should only be needed for drivers supporting rendering. Kernel modesetting is all standardized, and extended through properties. There are a few exceptions in some existing drivers, which define IOCTL for use by the display DRM master, but they all predate properties.h]hX6First things first, driver private IOCTLs should only be needed for drivers supporting rendering. Kernel modesetting is all standardized, and extended through properties. There are a few exceptions in some existing drivers, which define IOCTL for use by the display DRM master, but they all predate properties.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubh)}(hNow if you do have a render driver you always have to support it through driver private properties. There's a few steps needed to wire all the things up.h]hNow if you do have a render driver you always have to support it through driver private properties. There’s a few steps needed to wire all the things up.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubh)}(hFirst you need to define the structure for your IOCTL in your driver private UAPI header in ``include/uapi/drm/my_driver_drm.h``::h](h\First you need to define the structure for your IOCTL in your driver private UAPI header in }(hj^hhhNhNubj)}(h$``include/uapi/drm/my_driver_drm.h``h]h include/uapi/drm/my_driver_drm.h}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubh:}(hj^hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubj )}(hRstruct my_driver_operation { u32 some_thing; u32 another_thing; };h]hRstruct my_driver_operation { u32 some_thing; u32 another_thing; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubh)}(hX Please make sure that you follow all the best practices from ``Documentation/process/botching-up-ioctls.rst``. Note that drm_ioctl() automatically zero-extends structures, hence make sure you can add more stuff at the end, i.e. don't put a variable sized array there.h](h=Please make sure that you follow all the best practices from }(hjhhhNhNubj)}(h0``Documentation/process/botching-up-ioctls.rst``h]h,Documentation/process/botching-up-ioctls.rst}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. Note that drm_ioctl() automatically zero-extends structures, hence make sure you can add more stuff at the end, i.e. don’t put a variable sized array there.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubh)}(hThen you need to define your IOCTL number, using one of DRM_IO(), DRM_IOR(), DRM_IOW() or DRM_IOWR(). It must start with the DRM_IOCTL\_ prefix::h]hThen you need to define your IOCTL number, using one of DRM_IO(), DRM_IOR(), DRM_IOW() or DRM_IOWR(). It must start with the DRM_IOCTL_ prefix:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubj )}(hb##define DRM_IOCTL_MY_DRIVER_OPERATION \ DRM_IOW(DRM_COMMAND_BASE, struct my_driver_operation)h]hb##define DRM_IOCTL_MY_DRIVER_OPERATION \ DRM_IOW(DRM_COMMAND_BASE, struct my_driver_operation)}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubh)}(hDRM driver private IOCTL must be in the range from DRM_COMMAND_BASE to DRM_COMMAND_END. Finally you need an array of :c:type:`struct drm_ioctl_desc ` to wire up the handlers and set the access rights::h](huDRM driver private IOCTL must be in the range from DRM_COMMAND_BASE to DRM_COMMAND_END. Finally you need an array of }(hjhhhNhNubh)}(h0:c:type:`struct drm_ioctl_desc `h]j)}(hjh]hstruct drm_ioctl_desc}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_ioctl_descuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhjubh3 to wire up the handlers and set the access rights:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMhj/hhubj )}(hstatic const struct drm_ioctl_desc my_driver_ioctls[] = { DRM_IOCTL_DEF_DRV(MY_DRIVER_OPERATION, my_driver_operation, DRM_AUTH|DRM_RENDER_ALLOW), };h]hstatic const struct drm_ioctl_desc my_driver_ioctls[] = { DRM_IOCTL_DEF_DRV(MY_DRIVER_OPERATION, my_driver_operation, DRM_AUTH|DRM_RENDER_ALLOW), };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj/hhubh)}(hdAnd then assign this to the :c:type:`drm_driver.ioctls ` field in your driver structure.h](hAnd then assign this to the }(hjhhhNhNubh)}(h(:c:type:`drm_driver.ioctls `h]j)}(hjh]hdrm_driver.ioctls}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_driveruh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhjubh field in your driver structure.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj5hMhj/hhubh)}(htSee the separate chapter on :ref:`file operations` for how the driver-specific IOCTLs are wired up.h](hSee the separate chapter on }(hj@hhhNhNubh)}(h':ref:`file operations`h]j<)}(hjJh]hfile operations}(hjLhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hjHubah}(h]h ]h"]h$]h&]refdocj refdomainjVreftyperef refexplicitrefwarnjdrm_driver_fopsuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:493: ./drivers/gpu/drm/drm_ioctl.chMhj@ubh1 for how the driver-specific IOCTLs are wired up.}(hj@hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhhMhj/hhubh)}(hhh](h)}(hRecommended IOCTL Return Valuesh]hRecommended IOCTL Return Values}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshhhhhMubh)}(hIn theory a driver's IOCTL callback is only allowed to return very few error codes. In practice it's good to abuse a few more. This section documents common practice within the DRM subsystem:h]hIn theory a driver’s IOCTL callback is only allowed to return very few error codes. In practice it’s good to abuse a few more. This section documents common practice within the DRM subsystem:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjshhubj1)}(hhh](j6)}(hENOENT: Strictly this should only be used when a file doesn't exist e.g. when calling the open() syscall. We reuse that to signal any kind of object lookup failure, e.g. for unknown GEM buffer object handles, unknown KMS object handles and similar cases. h](j<)}(hENOENT:h]hENOENT:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhMhjubjV)}(hhh]h)}(hStrictly this should only be used when a file doesn't exist e.g. when calling the open() syscall. We reuse that to signal any kind of object lookup failure, e.g. for unknown GEM buffer object handles, unknown KMS object handles and similar cases.h]hStrictly this should only be used when a file doesn’t exist e.g. when calling the open() syscall. We reuse that to signal any kind of object lookup failure, e.g. for unknown GEM buffer object handles, unknown KMS object handles and similar cases.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hhhMhjubj6)}(hXENOSPC: Some drivers use this to differentiate "out of kernel memory" from "out of VRAM". Sometimes also applies to other limited gpu resources used for rendering (e.g. when you have a special limited compression buffer). Sometimes resource allocation/reservation issues in command submission IOCTLs are also signalled through EDEADLK. Simply running out of kernel/system memory is signalled through ENOMEM. h](j<)}(hENOSPC:h]hENOSPC:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhMhjubjV)}(hhh](h)}(hXGSome drivers use this to differentiate "out of kernel memory" from "out of VRAM". Sometimes also applies to other limited gpu resources used for rendering (e.g. when you have a special limited compression buffer). Sometimes resource allocation/reservation issues in command submission IOCTLs are also signalled through EDEADLK.h]hXOSome drivers use this to differentiate “out of kernel memory” from “out of VRAM”. Sometimes also applies to other limited gpu resources used for rendering (e.g. when you have a special limited compression buffer). Sometimes resource allocation/reservation issues in command submission IOCTLs are also signalled through EDEADLK.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hGSimply running out of kernel/system memory is signalled through ENOMEM.h]hGSimply running out of kernel/system memory is signalled through ENOMEM.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hhhMhjhhubj6)}(hEPERM/EACCES: Returned for an operation that is valid, but needs more privileges. E.g. root-only or much more common, DRM master-only operations return this when called by unpriviledged clients. There's no clear difference between EACCES and EPERM. h](j<)}(h EPERM/EACCES:h]h EPERM/EACCES:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhM hj ubjV)}(hhh]h)}(hReturned for an operation that is valid, but needs more privileges. E.g. root-only or much more common, DRM master-only operations return this when called by unpriviledged clients. There's no clear difference between EACCES and EPERM.h]hReturned for an operation that is valid, but needs more privileges. E.g. root-only or much more common, DRM master-only operations return this when called by unpriviledged clients. There’s no clear difference between EACCES and EPERM.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hhhM hjhhubj6)}(hKENODEV: The device is not present anymore or is not yet fully initialized. h](j<)}(hENODEV:h]hENODEV:}(hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhM hj0 ubjV)}(hhh]h)}(hBThe device is not present anymore or is not yet fully initialized.h]hBThe device is not present anymore or is not yet fully initialized.}(hjE hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjB ubah}(h]h ]h"]h$]h&]uh1jUhj0 ubeh}(h]h ]h"]h$]h&]uh1j5hhhM hjhhubj6)}(hSEOPNOTSUPP: Feature (like PRIME, modesetting, GEM) is not supported by the driver. h](j<)}(h EOPNOTSUPP:h]h EOPNOTSUPP:}(hjc hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhMhj_ ubjV)}(hhh]h)}(hFFeature (like PRIME, modesetting, GEM) is not supported by the driver.h]hFFeature (like PRIME, modesetting, GEM) is not supported by the driver.}(hjt hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjq ubah}(h]h ]h"]h$]h&]uh1jUhj_ ubeh}(h]h ]h"]h$]h&]uh1j5hhhMhjhhubj6)}(hENXIO: Remote failure, either a hardware transaction (like i2c), but also used when the exporting driver of a shared dma-buf or fence doesn't support a feature needed. h](j<)}(hENXIO:h]hENXIO:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhMhj ubjV)}(hhh]h)}(hRemote failure, either a hardware transaction (like i2c), but also used when the exporting driver of a shared dma-buf or fence doesn't support a feature needed.h]hRemote failure, either a hardware transaction (like i2c), but also used when the exporting driver of a shared dma-buf or fence doesn’t support a feature needed.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hhhMhjhhubj6)}(hEINTR: DRM drivers assume that userspace restarts all IOCTLs. Any DRM IOCTL can return EINTR and in such a case should be restarted with the IOCTL parameters left unchanged. h](j<)}(hEINTR:h]hEINTR:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhMhj ubjV)}(hhh]h)}(hDRM drivers assume that userspace restarts all IOCTLs. Any DRM IOCTL can return EINTR and in such a case should be restarted with the IOCTL parameters left unchanged.h]hDRM drivers assume that userspace restarts all IOCTLs. Any DRM IOCTL can return EINTR and in such a case should be restarted with the IOCTL parameters left unchanged.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hhhMhjhhubj6)}(hEIO: The GPU died and couldn't be resurrected through a reset. Modesetting hardware failures are signalled through the "link status" connector property. h](j<)}(hEIO:h]hEIO:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhMhj ubjV)}(hhh]h)}(hThe GPU died and couldn't be resurrected through a reset. Modesetting hardware failures are signalled through the "link status" connector property.h]hThe GPU died and couldn’t be resurrected through a reset. Modesetting hardware failures are signalled through the “link status” connector property.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hhhMhjhhubj6)}(hZEINVAL: Catch-all for anything that is an invalid argument combination which cannot work. h](j<)}(hEINVAL:h]hEINVAL:}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hhhM#hj!ubjV)}(hhh]h)}(hQCatch-all for anything that is an invalid argument combination which cannot work.h]hQCatch-all for anything that is an invalid argument combination which cannot work.}(hj0!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj-!ubah}(h]h ]h"]h$]h&]uh1jUhj!ubeh}(h]h ]h"]h$]h&]uh1j5hhhM#hjhhubeh}(h]h ]h"]h$]h&]uh1j0hjshhhhhNubh)}(hX.IOCTL also use other error codes like ETIME, EFAULT, EBUSY, ENOTTY but their usage is in line with the common meanings. The above list tries to just document DRM specific patterns. Note that ENOTTY has the slightly unintuitive meaning of "this IOCTL does not exist", and is used exactly as such in DRM.h]hX2IOCTL also use other error codes like ETIME, EFAULT, EBUSY, ENOTTY but their usage is in line with the common meanings. The above list tries to just document DRM specific patterns. Note that ENOTTY has the slightly unintuitive meaning of “this IOCTL does not exist”, and is used exactly as such in DRM.}(hjP!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM%hjshhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_ioctl_t (C macro) c.drm_ioctl_thNtauh1jhjshhhNhNubj)}(hhh](j)}(h drm_ioctl_th]j)}(h drm_ioctl_th]j)}(h drm_ioctl_th]j)}(hjq!h]h drm_ioctl_t}(hj{!hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjw!ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjs!hhhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK6ubah}(h]h ]h"]h$]h&]hhjuh1jjjhjo!hhhj!hK6ubah}(h]jj!ah ](jjeh"]h$]h&]jj)jhuh1jhj!hK6hjl!hhubj)}(hhh]h)}(h%**Typedef**: DRM ioctl function type.h](j)}(h **Typedef**h]hTypedef}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh: DRM ioctl function type.}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK-hj!hhubah}(h]h ]h"]h$]h&]uh1jhjl!hhhj!hK6ubeh}(h]h ](jmacroeh"]h$]h&]j jj j!jj!jjjuh1jhhhjshNhNubh)}(h **Syntax**h]j)}(hj!h]hSyntax}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK0hjshhubj%)}(h]``typedef int drm_ioctl_t (struct drm_device *dev, void *data, struct drm_file *file_priv)`` h]h)}(h\``typedef int drm_ioctl_t (struct drm_device *dev, void *data, struct drm_file *file_priv)``h]j)}(hj!h]hXtypedef int drm_ioctl_t (struct drm_device *dev, void *data, struct drm_file *file_priv)}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK2hj!ubah}(h]h ]h"]h$]h&]uh1j$hj!hK2hjshhubj)}(hX**Parameters** ``struct drm_device *dev`` DRM device inode ``void *data`` private pointer of the ioctl call ``struct drm_file *file_priv`` DRM file this ioctl was made on **Description** This is the DRM ioctl typedef. Note that drm_ioctl() has alrady copied **data** into kernel-space, and will also copy it back, depending upon the read/write settings in the ioctl command code.h](h)}(h**Parameters**h]j)}(hj"h]h Parameters}(hj "hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK6hj"ubj1)}(hhh](j6)}(h,``struct drm_device *dev`` DRM device inode h](j<)}(h``struct drm_device *dev``h]j)}(hj'"h]hstruct drm_device *dev}(hj)"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%"ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK.hj!"ubjV)}(hhh]h)}(hDRM device inodeh]hDRM device inode}(hj@"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj<"hK.hj="ubah}(h]h ]h"]h$]h&]uh1jUhj!"ubeh}(h]h ]h"]h$]h&]uh1j5hj<"hK.hj"ubj6)}(h1``void *data`` private pointer of the ioctl call h](j<)}(h``void *data``h]j)}(hj`"h]h void *data}(hjb"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^"ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK/hjZ"ubjV)}(hhh]h)}(h!private pointer of the ioctl callh]h!private pointer of the ioctl call}(hjy"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhju"hK/hjv"ubah}(h]h ]h"]h$]h&]uh1jUhjZ"ubeh}(h]h ]h"]h$]h&]uh1j5hju"hK/hj"ubj6)}(h?``struct drm_file *file_priv`` DRM file this ioctl was made on h](j<)}(h``struct drm_file *file_priv``h]j)}(hj"h]hstruct drm_file *file_priv}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK0hj"ubjV)}(hhh]h)}(hDRM file this ioctl was made onh]hDRM file this ioctl was made on}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hK0hj"ubah}(h]h ]h"]h$]h&]uh1jUhj"ubeh}(h]h ]h"]h$]h&]uh1j5hj"hK0hj"ubeh}(h]h ]h"]h$]h&]uh1j0hj"ubh)}(h**Description**h]j)}(hj"h]h Description}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK2hj"ubh)}(hThis is the DRM ioctl typedef. Note that drm_ioctl() has alrady copied **data** into kernel-space, and will also copy it back, depending upon the read/write settings in the ioctl command code.h](hGThis is the DRM ioctl typedef. Note that drm_ioctl() has alrady copied }(hj"hhhNhNubj)}(h**data**h]hdata}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubhq into kernel-space, and will also copy it back, depending upon the read/write settings in the ioctl command code.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK2hj"ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_ioctl_compat_t (C macro)c.drm_ioctl_compat_thNtauh1jhjshhhNhNubj)}(hhh](j)}(hdrm_ioctl_compat_th]j)}(hdrm_ioctl_compat_th]j)}(hdrm_ioctl_compat_th]j)}(hj%#h]hdrm_ioctl_compat_t}(hj/#hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj+#ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj'#hhhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKCubah}(h]h ]h"]h$]h&]hhjuh1jjjhj##hhhjB#hKCubah}(h]j#ah ](jjeh"]h$]h&]jj)jhuh1jhjB#hKChj #hhubj)}(hhh]h)}(h3**Typedef**: compatibility DRM ioctl function type.h](j)}(h **Typedef**h]hTypedef}(hjV#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjR#ubh(: compatibility DRM ioctl function type.}(hjR#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK:hjO#hhubah}(h]h ]h"]h$]h&]uh1jhj #hhhjB#hKCubeh}(h]h ](jmacroeh"]h$]h&]j jj jx#jjx#jjjuh1jhhhjshNhNubh)}(h **Syntax**h]j)}(hj~#h]hSyntax}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|#ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK=hjshhubj%)}(h\``typedef int drm_ioctl_compat_t (struct file *filp, unsigned int cmd, unsigned long arg)`` h]h)}(h[``typedef int drm_ioctl_compat_t (struct file *filp, unsigned int cmd, unsigned long arg)``h]j)}(hj#h]hWtypedef int drm_ioctl_compat_t (struct file *filp, unsigned int cmd, unsigned long arg)}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK?hj#ubah}(h]h ]h"]h$]h&]uh1j$hj#hK?hjshhubj)}(hX`**Parameters** ``struct file *filp`` file pointer ``unsigned int cmd`` ioctl command code ``unsigned long arg`` DRM file this ioctl was made on **Description** Just a typedef to make declaring an array of compatibility handlers easier. New drivers shouldn't screw up the structure layout for their ioctl structures and hence never need this.h](h)}(h**Parameters**h]j)}(hj#h]h Parameters}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKChj#ubj1)}(hhh](j6)}(h#``struct file *filp`` file pointer h](j<)}(h``struct file *filp``h]j)}(hj#h]hstruct file *filp}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK;hj#ubjV)}(hhh]h)}(h file pointerh]h file pointer}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hK;hj#ubah}(h]h ]h"]h$]h&]uh1jUhj#ubeh}(h]h ]h"]h$]h&]uh1j5hj#hK;hj#ubj6)}(h(``unsigned int cmd`` ioctl command code h](j<)}(h``unsigned int cmd``h]j)}(hj$h]hunsigned int cmd}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK` to control how userspace can use a given ioctl.h](h!Various flags that can be set in }(hju&hhhNhNubh)}(h/:c:type:`drm_ioctl_desc.flags `h]j)}(hj&h]hdrm_ioctl_desc.flags}(hj&hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj}&ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_ioctl_descuh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKLhju&ubh0 to control how userspace can use a given ioctl.}(hju&hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj&hKLhjshhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_ioctl_desc (C struct)c.drm_ioctl_deschNtauh1jhjshhhNhNubj)}(hhh](j)}(hdrm_ioctl_desch]j)}(hstruct drm_ioctl_desch](j@)}(hjCh]hstruct}(hj&hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj&hhhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKRubj)}(h h]h }(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&hhhj&hKRubj)}(hdrm_ioctl_desch]j)}(hj&h]hdrm_ioctl_desc}(hj&hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj&ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj&hhhj&hKRubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj&hhhj&hKRubah}(h]j&ah ](jjeh"]h$]h&]jj)jhuh1jhj&hKRhj&hhubj)}(hhh]h)}(hDRM driver ioctl entryh]hDRM driver ioctl entry}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhK}hj&hhubah}(h]h ]h"]h$]h&]uh1jhj&hhhj&hKRubeh}(h]h ](jstructeh"]h$]h&]j jj j'jj'jjjuh1jhhhjshNhNubj)}(hXu**Definition**:: struct drm_ioctl_desc { unsigned int cmd; enum drm_ioctl_flags flags; drm_ioctl_t *func; const char *name; }; **Members** ``cmd`` ioctl command number, without flags ``flags`` a bitmask of :c:type:`enum drm_ioctl_flags ` ``func`` handler for this ioctl ``name`` user-readable name for debug outputh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj&'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"'ubh:}(hj"'hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj'ubj )}(h}struct drm_ioctl_desc { unsigned int cmd; enum drm_ioctl_flags flags; drm_ioctl_t *func; const char *name; };h]h}struct drm_ioctl_desc { unsigned int cmd; enum drm_ioctl_flags flags; drm_ioctl_t *func; const char *name; };}hj?'sbah}(h]h ]h"]h$]h&]hhuh1j hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj'ubh)}(h **Members**h]j)}(hjP'h]hMembers}(hjR'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjN'ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj'ubj1)}(hhh](j6)}(h,``cmd`` ioctl command number, without flags h](j<)}(h``cmd``h]j)}(hjo'h]hcmd}(hjq'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjm'ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhji'ubjV)}(hhh]h)}(h#ioctl command number, without flagsh]h#ioctl command number, without flags}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj'hKhj'ubah}(h]h ]h"]h$]h&]uh1jUhji'ubeh}(h]h ]h"]h$]h&]uh1j5hj'hKhjf'ubj6)}(hH``flags`` a bitmask of :c:type:`enum drm_ioctl_flags ` h](j<)}(h ``flags``h]j)}(hj'h]hflags}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj'ubjV)}(hhh]h)}(h=a bitmask of :c:type:`enum drm_ioctl_flags `h](h a bitmask of }(hj'hhhNhNubh)}(h0:c:type:`enum drm_ioctl_flags `h]j)}(hj'h]henum drm_ioctl_flags}(hj'hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_ioctl_flagsuh1hhj'hKhj'ubeh}(h]h ]h"]h$]h&]uh1hhj'hKhj'ubah}(h]h ]h"]h$]h&]uh1jUhj'ubeh}(h]h ]h"]h$]h&]uh1j5hj'hKhjf'ubj6)}(h ``func`` handler for this ioctl h](j<)}(h``func``h]j)}(hj(h]hfunc}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj'ubjV)}(hhh]h)}(hhandler for this ioctlh]hhandler for this ioctl}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hKhj(ubah}(h]h ]h"]h$]h&]uh1jUhj'ubeh}(h]h ]h"]h$]h&]uh1j5hj(hKhjf'ubj6)}(h,``name`` user-readable name for debug outputh](j<)}(h``name``h]j)}(hj9(h]hname}(hj;(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7(ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj3(ubjV)}(hhh]h)}(h#user-readable name for debug outputh]h#user-readable name for debug output}(hjR(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhjO(ubah}(h]h ]h"]h$]h&]uh1jUhj3(ubeh}(h]h ]h"]h$]h&]uh1j5hjN(hKhjf'ubeh}(h]h ]h"]h$]h&]uh1j0hj'ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubh)}(h**Description**h]j)}(hj|(h]h Description}(hj~(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjz(ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhjshhubh)}(hPFor convenience it's easier to create these using the DRM_IOCTL_DEF_DRV() macro.h]hRFor convenience it’s easier to create these using the DRM_IOCTL_DEF_DRV() macro.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhjshhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_IOCTL_DEF_DRV (C macro)c.DRM_IOCTL_DEF_DRVhNtauh1jhjshhhNhNubj)}(hhh](j)}(hDRM_IOCTL_DEF_DRVh]j)}(hDRM_IOCTL_DEF_DRVh]j)}(hDRM_IOCTL_DEF_DRVh]j)}(hj(h]hDRM_IOCTL_DEF_DRV}(hj(hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj(ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj(hhhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKubah}(h]h ]h"]h$]h&]hhjuh1jjjhj(hhhj(hKubah}(h]j(ah ](jjeh"]h$]h&]jj)jhuh1jhj(hKhj(hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj(hhhj(hKubeh}(h]h ](jmacroeh"]h$]h&]j jj j(jj(jjjuh1jhhhjshNhNubh)}(h,``DRM_IOCTL_DEF_DRV (ioctl, _func, _flags)``h]j)}(hj(h]h(DRM_IOCTL_DEF_DRV (ioctl, _func, _flags)}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhjshhubj%)}(hLhelper macro to fill out a :c:type:`struct drm_ioctl_desc ` h]h)}(hKhelper macro to fill out a :c:type:`struct drm_ioctl_desc `h](hhelper macro to fill out a }(hj )hhhNhNubh)}(h0:c:type:`struct drm_ioctl_desc `h]j)}(hj)h]hstruct drm_ioctl_desc}(hj)hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_ioctl_descuh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj )ubeh}(h]h ]h"]h$]h&]uh1hhj1)hKhj)ubah}(h]h ]h"]h$]h&]uh1j$hj1)hKhjshhubj)}(hXr**Parameters** ``ioctl`` ioctl command suffix ``_func`` handler for the ioctl ``_flags`` a bitmask of :c:type:`enum drm_ioctl_flags ` **Description** Small helper macro to create a :c:type:`struct drm_ioctl_desc ` entry. The ioctl command number is constructed by prepending ``DRM_IOCTL\_`` and passing that to DRM_IOCTL_NR().h](h)}(h**Parameters**h]j)}(hjD)h]h Parameters}(hjF)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjB)ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj>)ubj1)}(hhh](j6)}(h``ioctl`` ioctl command suffix h](j<)}(h ``ioctl``h]j)}(hjc)h]hioctl}(hje)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhja)ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj])ubjV)}(hhh]h)}(hioctl command suffixh]hioctl command suffix}(hj|)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjx)hKhjy)ubah}(h]h ]h"]h$]h&]uh1jUhj])ubeh}(h]h ]h"]h$]h&]uh1j5hjx)hKhjZ)ubj6)}(h ``_func`` handler for the ioctl h](j<)}(h ``_func``h]j)}(hj)h]h_func}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj)ubjV)}(hhh]h)}(hhandler for the ioctlh]hhandler for the ioctl}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hKhj)ubah}(h]h ]h"]h$]h&]uh1jUhj)ubeh}(h]h ]h"]h$]h&]uh1j5hj)hKhjZ)ubj6)}(hI``_flags`` a bitmask of :c:type:`enum drm_ioctl_flags ` h](j<)}(h ``_flags``h]j)}(hj)h]h_flags}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1j;hU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj)ubjV)}(hhh]h)}(h=a bitmask of :c:type:`enum drm_ioctl_flags `h](h a bitmask of }(hj)hhhNhNubh)}(h0:c:type:`enum drm_ioctl_flags `h]j)}(hj)h]henum drm_ioctl_flags}(hj)hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_ioctl_flagsuh1hhj)hKhj)ubeh}(h]h ]h"]h$]h&]uh1hhj)hKhj)ubah}(h]h ]h"]h$]h&]uh1jUhj)ubeh}(h]h ]h"]h$]h&]uh1j5hj)hKhjZ)ubeh}(h]h ]h"]h$]h&]uh1j0hj>)ubh)}(h**Description**h]j)}(hj/*h]h Description}(hj1*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-*ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhj>)ubh)}(hSmall helper macro to create a :c:type:`struct drm_ioctl_desc ` entry. The ioctl command number is constructed by prepending ``DRM_IOCTL\_`` and passing that to DRM_IOCTL_NR().h](hSmall helper macro to create a }(hjE*hhhNhNubh)}(h0:c:type:`struct drm_ioctl_desc `h]j)}(hjO*h]hstruct drm_ioctl_desc}(hjQ*hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjM*ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_ioctl_descuh1hhU/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:554: ./include/drm/drm_ioctl.hhKhjE*ubh> entry. The ioctl command number is constructed by prepending }(hjE*hhhNhNubj)}(h``DRM_IOCTL\_``h]h DRM_IOCTL\_}(hjq*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjE*ubh$ and passing that to DRM_IOCTL_NR().}(hjE*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjl*hKhj>)ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_noop (C function) c.drm_noophNtauh1jhjshhhNhNubj)}(hhh](j)}(hMint drm_noop (struct drm_device *dev, void *data, struct drm_file *file_priv)h]j)}(hLint drm_noop(struct drm_device *dev, void *data, struct drm_file *file_priv)h](j)}(hinth]hint}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMubj)}(h h]h }(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*hhhj*hMubj)}(hdrm_nooph]j)}(hdrm_nooph]hdrm_noop}(hj*hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj*ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj*hhhj*hMubj4)}(h@(struct drm_device *dev, void *data, struct drm_file *file_priv)h](j:)}(hstruct drm_device *devh](j@)}(hjCh]hstruct}(hj*hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj*ubj)}(h h]h }(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubh)}(hhh]j)}(h drm_deviceh]h drm_device}(hj+hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj+modnameN classnameNj{j~)}j]j)}jwj*sb c.drm_noopasbuh1hhj*ubj)}(h h]h }(hj$+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubj)}(hjh]h*}(hj2+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubj)}(hdevh]hdev}(hj?+hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj*ubj:)}(h void *datah](j)}(hvoidh]hvoid}(hjX+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjT+ubj)}(h h]h }(hjf+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjT+ubj)}(hjh]h*}(hjt+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjT+ubj)}(hdatah]hdata}(hj+hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjT+ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj*ubj:)}(hstruct drm_file *file_privh](j@)}(hjCh]hstruct}(hj+hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj+ubj)}(h h]h }(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubh)}(hhh]j)}(hdrm_fileh]hdrm_file}(hj+hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj+modnameN classnameNj{j~)}j]j + c.drm_noopasbuh1hhj+ubj)}(h h]h }(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubj)}(hjh]h*}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubj)}(h file_privh]h file_priv}(hj+hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj*ubeh}(h]h ]h"]h$]h&]hhuh1j3hj*hhhj*hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj*hhhj*hMubah}(h]j*ah ](jjeh"]h$]h&]jj)jhuh1jhj*hMhj*hhubj)}(hhh]h)}(hDRM no-op ioctl implementationh]hDRM no-op ioctl implementation}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj,hhubah}(h]h ]h"]h$]h&]uh1jhj*hhhj*hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j3,jj3,jjjuh1jhhhjshNhNubj)}(hX**Parameters** ``struct drm_device *dev`` DRM device for the ioctl ``void *data`` data pointer for the ioctl ``struct drm_file *file_priv`` DRM file for the ioctl call **Description** This no-op implementation for drm ioctls is useful for deprecated functionality where we can't return a failure code because existing userspace checks the result of the ioctl, but doesn't care about the action. Always returns successfully with 0.h](h)}(h**Parameters**h]j)}(hj=,h]h Parameters}(hj?,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;,ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj7,ubj1)}(hhh](j6)}(h4``struct drm_device *dev`` DRM device for the ioctl h](j<)}(h``struct drm_device *dev``h]j)}(hj\,h]hstruct drm_device *dev}(hj^,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZ,ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhjV,ubjV)}(hhh]h)}(hDRM device for the ioctlh]hDRM device for the ioctl}(hju,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjq,hMhjr,ubah}(h]h ]h"]h$]h&]uh1jUhjV,ubeh}(h]h ]h"]h$]h&]uh1j5hjq,hMhjS,ubj6)}(h*``void *data`` data pointer for the ioctl h](j<)}(h``void *data``h]j)}(hj,h]h void *data}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj,ubjV)}(hhh]h)}(hdata pointer for the ioctlh]hdata pointer for the ioctl}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jUhj,ubeh}(h]h ]h"]h$]h&]uh1j5hj,hMhjS,ubj6)}(h;``struct drm_file *file_priv`` DRM file for the ioctl call h](j<)}(h``struct drm_file *file_priv``h]j)}(hj,h]hstruct drm_file *file_priv}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj,ubjV)}(hhh]h)}(hDRM file for the ioctl callh]hDRM file for the ioctl call}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jUhj,ubeh}(h]h ]h"]h$]h&]uh1j5hj,hMhjS,ubeh}(h]h ]h"]h$]h&]uh1j0hj7,ubh)}(h**Description**h]j)}(hj -h]h Description}(hj -hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj7,ubh)}(hThis no-op implementation for drm ioctls is useful for deprecated functionality where we can't return a failure code because existing userspace checks the result of the ioctl, but doesn't care about the action.h]hThis no-op implementation for drm ioctls is useful for deprecated functionality where we can’t return a failure code because existing userspace checks the result of the ioctl, but doesn’t care about the action.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj7,ubh)}(h#Always returns successfully with 0.h]h#Always returns successfully with 0.}(hj.-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj7,ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_invalid_op (C function)c.drm_invalid_ophNtauh1jhjshhhNhNubj)}(hhh](j)}(hSint drm_invalid_op (struct drm_device *dev, void *data, struct drm_file *file_priv)h]j)}(hRint drm_invalid_op(struct drm_device *dev, void *data, struct drm_file *file_priv)h](j)}(hinth]hint}(hj]-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjY-hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMubj)}(h h]h }(hjl-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjY-hhhjk-hMubj)}(hdrm_invalid_oph]j)}(hdrm_invalid_oph]hdrm_invalid_op}(hj~-hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjz-ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjY-hhhjk-hMubj4)}(h@(struct drm_device *dev, void *data, struct drm_file *file_priv)h](j:)}(hstruct drm_device *devh](j@)}(hjCh]hstruct}(hj-hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj-ubj)}(h h]h }(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubh)}(hhh]j)}(h drm_deviceh]h drm_device}(hj-hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj-modnameN classnameNj{j~)}j]j)}jwj-sbc.drm_invalid_opasbuh1hhj-ubj)}(h h]h }(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubj)}(hjh]h*}(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubj)}(hdevh]hdev}(hj-hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj-ubj:)}(h void *datah](j)}(hvoidh]hvoid}(hj .hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubj)}(h h]h }(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubj)}(hjh]h*}(hj(.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubj)}(hdatah]hdata}(hj5.hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj.ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj-ubj:)}(hstruct drm_file *file_privh](j@)}(hjCh]hstruct}(hjN.hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjJ.ubj)}(h h]h }(hj[.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ.ubh)}(hhh]j)}(hdrm_fileh]hdrm_file}(hjl.hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhji.ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjn.modnameN classnameNj{j~)}j]j-c.drm_invalid_opasbuh1hhjJ.ubj)}(h h]h }(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ.ubj)}(hjh]h*}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ.ubj)}(h file_privh]h file_priv}(hj.hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjJ.ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj-ubeh}(h]h ]h"]h$]h&]hhuh1j3hjY-hhhjk-hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjU-hhhjk-hMubah}(h]jP-ah ](jjeh"]h$]h&]jj)jhuh1jhjk-hMhjR-hhubj)}(hhh]h)}(h DRM invalid ioctl implementationh]h DRM invalid ioctl implementation}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj.hhubah}(h]h ]h"]h$]h&]uh1jhjR-hhhjk-hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j.jj.jjjuh1jhhhjshNhNubj)}(hXp**Parameters** ``struct drm_device *dev`` DRM device for the ioctl ``void *data`` data pointer for the ioctl ``struct drm_file *file_priv`` DRM file for the ioctl call **Description** This no-op implementation for drm ioctls is useful for deprecated functionality where we really don't want to allow userspace to call the ioctl any more. This is the case for old ums interfaces for drivers that transitioned to kms gradually and so kept the old legacy tables around. This only applies to radeon and i915 kms drivers, other drivers shouldn't need to use this function. Always fails with a return value of -EINVAL.h](h)}(h**Parameters**h]j)}(hj.h]h Parameters}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj.ubj1)}(hhh](j6)}(h4``struct drm_device *dev`` DRM device for the ioctl h](j<)}(h``struct drm_device *dev``h]j)}(hj/h]hstruct drm_device *dev}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj /ubjV)}(hhh]h)}(hDRM device for the ioctlh]hDRM device for the ioctl}(hj)/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%/hMhj&/ubah}(h]h ]h"]h$]h&]uh1jUhj /ubeh}(h]h ]h"]h$]h&]uh1j5hj%/hMhj/ubj6)}(h*``void *data`` data pointer for the ioctl h](j<)}(h``void *data``h]j)}(hjI/h]h void *data}(hjK/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjG/ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhjC/ubjV)}(hhh]h)}(hdata pointer for the ioctlh]hdata pointer for the ioctl}(hjb/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^/hMhj_/ubah}(h]h ]h"]h$]h&]uh1jUhjC/ubeh}(h]h ]h"]h$]h&]uh1j5hj^/hMhj/ubj6)}(h;``struct drm_file *file_priv`` DRM file for the ioctl call h](j<)}(h``struct drm_file *file_priv``h]j)}(hj/h]hstruct drm_file *file_priv}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj|/ubjV)}(hhh]h)}(hDRM file for the ioctl callh]hDRM file for the ioctl call}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hMhj/ubah}(h]h ]h"]h$]h&]uh1jUhj|/ubeh}(h]h ]h"]h$]h&]uh1j5hj/hMhj/ubeh}(h]h ]h"]h$]h&]uh1j0hj.ubh)}(h**Description**h]j)}(hj/h]h Description}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj.ubh)}(hXThis no-op implementation for drm ioctls is useful for deprecated functionality where we really don't want to allow userspace to call the ioctl any more. This is the case for old ums interfaces for drivers that transitioned to kms gradually and so kept the old legacy tables around. This only applies to radeon and i915 kms drivers, other drivers shouldn't need to use this function.h]hXThis no-op implementation for drm ioctls is useful for deprecated functionality where we really don’t want to allow userspace to call the ioctl any more. This is the case for old ums interfaces for drivers that transitioned to kms gradually and so kept the old legacy tables around. This only applies to radeon and i915 kms drivers, other drivers shouldn’t need to use this function.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj.ubh)}(h,Always fails with a return value of -EINVAL.h]h,Always fails with a return value of -EINVAL.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj.ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_ioctl (C function) c.drm_ioctlhNtauh1jhjshhhNhNubj)}(hhh](j)}(hGlong drm_ioctl (struct file *filp, unsigned int cmd, unsigned long arg)h]j)}(hFlong drm_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)h](j)}(hlongh]hlong}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 0hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM-ubj)}(h h]h }(hj 0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 0hhhj0hM-ubj)}(h drm_ioctlh]j)}(h drm_ioctlh]h drm_ioctl}(hj20hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj.0ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj 0hhhj0hM-ubj4)}(h8(struct file *filp, unsigned int cmd, unsigned long arg)h](j:)}(hstruct file *filph](j@)}(hjCh]hstruct}(hjN0hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjJ0ubj)}(h h]h }(hj[0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ0ubh)}(hhh]j)}(hfileh]hfile}(hjl0hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhji0ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjn0modnameN classnameNj{j~)}j]j)}jwj40sb c.drm_ioctlasbuh1hhjJ0ubj)}(h h]h }(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ0ubj)}(hjh]h*}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ0ubj)}(hfilph]hfilp}(hj0hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjJ0ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjF0ubj:)}(hunsigned int cmdh](j)}(hunsignedh]hunsigned}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubj)}(h h]h }(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubj)}(hinth]hint}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubj)}(h h]h }(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubj)}(hcmdh]hcmd}(hj0hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj0ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjF0ubj:)}(hunsigned long argh](j)}(hunsignedh]hunsigned}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 1ubj)}(h h]h }(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 1ubj)}(hlongh]hlong}(hj-1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 1ubj)}(h h]h }(hj;1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 1ubj)}(hargh]harg}(hjI1hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj 1ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjF0ubeh}(h]h ]h"]h$]h&]hhuh1j3hj 0hhhj0hM-ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj 0hhhj0hM-ubah}(h]j0ah ](jjeh"]h$]h&]jj)jhuh1jhj0hM-hj0hhubj)}(hhh]h)}(h-ioctl callback implementation for DRM driversh]h-ioctl callback implementation for DRM drivers}(hjs1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM!hjp1hhubah}(h]h ]h"]h$]h&]uh1jhj0hhhj0hM-ubeh}(h]h ](jfunctioneh"]h$]h&]j jj j1jj1jjjuh1jhhhjshNhNubj)}(hX**Parameters** ``struct file *filp`` file this ioctl is called on ``unsigned int cmd`` ioctl cmd number ``unsigned long arg`` user argument **Description** Looks up the ioctl function in the DRM core and the driver dispatch table, stored in :c:type:`drm_driver.ioctls `. It checks for necessary permission by calling drm_ioctl_permit(), and dispatches to the respective function. **Return** Zero on success, negative error code on failure.h](h)}(h**Parameters**h]j)}(hj1h]h Parameters}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM%hj1ubj1)}(hhh](j6)}(h3``struct file *filp`` file this ioctl is called on h](j<)}(h``struct file *filp``h]j)}(hj1h]hstruct file *filp}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM"hj1ubjV)}(hhh]h)}(hfile this ioctl is called onh]hfile this ioctl is called on}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hM"hj1ubah}(h]h ]h"]h$]h&]uh1jUhj1ubeh}(h]h ]h"]h$]h&]uh1j5hj1hM"hj1ubj6)}(h&``unsigned int cmd`` ioctl cmd number h](j<)}(h``unsigned int cmd``h]j)}(hj1h]hunsigned int cmd}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM#hj1ubjV)}(hhh]h)}(hioctl cmd numberh]hioctl cmd number}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hM#hj2ubah}(h]h ]h"]h$]h&]uh1jUhj1ubeh}(h]h ]h"]h$]h&]uh1j5hj2hM#hj1ubj6)}(h$``unsigned long arg`` user argument h](j<)}(h``unsigned long arg``h]j)}(hj&2h]hunsigned long arg}(hj(2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$2ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM$hj 2ubjV)}(hhh]h)}(h user argumenth]h user argument}(hj?2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;2hM$hj<2ubah}(h]h ]h"]h$]h&]uh1jUhj 2ubeh}(h]h ]h"]h$]h&]uh1j5hj;2hM$hj1ubeh}(h]h ]h"]h$]h&]uh1j0hj1ubh)}(h**Description**h]j)}(hja2h]h Description}(hjc2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_2ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM&hj1ubh)}(hLooks up the ioctl function in the DRM core and the driver dispatch table, stored in :c:type:`drm_driver.ioctls `. It checks for necessary permission by calling drm_ioctl_permit(), and dispatches to the respective function.h](hULooks up the ioctl function in the DRM core and the driver dispatch table, stored in }(hjw2hhhNhNubh)}(h(:c:type:`drm_driver.ioctls `h]j)}(hj2h]hdrm_driver.ioctls}(hj2hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_driveruh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM&hjw2ubhn. It checks for necessary permission by calling drm_ioctl_permit(), and dispatches to the respective function.}(hjw2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj2hM&hj1ubh)}(h **Return**h]j)}(hj2h]hReturn}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM*hj1ubh)}(h0Zero on success, negative error code on failure.h]h0Zero on success, negative error code on failure.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chM*hj1ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_ioctl_flags (C function)c.drm_ioctl_flagshNtauh1jhjshhhNhNubj)}(hhh](j)}(h;bool drm_ioctl_flags (unsigned int nr, unsigned int *flags)h]j)}(h:bool drm_ioctl_flags(unsigned int nr, unsigned int *flags)h](j)}(hjh]hbool}(hj2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMubj)}(h h]h }(hj2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2hhhj2hMubj)}(hdrm_ioctl_flagsh]j)}(hdrm_ioctl_flagsh]hdrm_ioctl_flags}(hj3hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj 3ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj2hhhj2hMubj4)}(h&(unsigned int nr, unsigned int *flags)h](j:)}(hunsigned int nrh](j)}(hunsignedh]hunsigned}(hj,3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(3ubj)}(h h]h }(hj:3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(3ubj)}(hinth]hint}(hjH3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(3ubj)}(h h]h }(hjV3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(3ubj)}(hnrh]hnr}(hjd3hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj(3ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj$3ubj:)}(hunsigned int *flagsh](j)}(hunsignedh]hunsigned}(hj}3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjy3ubj)}(h h]h }(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjy3ubj)}(hinth]hint}(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjy3ubj)}(h h]h }(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjy3ubj)}(hjh]h*}(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjy3ubj)}(hflagsh]hflags}(hj3hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjy3ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj$3ubeh}(h]h ]h"]h$]h&]hhuh1j3hj2hhhj2hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj2hhhj2hMubah}(h]h ](jjeh"]h$]h&]jj)jhuh1jhj2hMhj2hhubj)}(hhh]h)}(h6Check for core ioctl and return ioctl permission flagsh]h6Check for core ioctl and return ioctl permission flags}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj3hhubah}(h]h ]h"]h$]h&]uh1jhj2hhhj2hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j4jj4jjjuh1jhhhjshNhNubj)}(hX**Parameters** ``unsigned int nr`` ioctl number ``unsigned int *flags`` where to return the ioctl permission flags **Description** This ioctl is only used by the vmwgfx driver to augment the access checks done by the drm core and insofar a pretty decent layering violation. This shouldn't be used by any drivers. **Return** True if the **nr** corresponds to a DRM core ioctl number, false otherwise.h](h)}(h**Parameters**h]j)}(hj4h]h Parameters}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj 4ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj4ubj1)}(hhh](j6)}(h!``unsigned int nr`` ioctl number h](j<)}(h``unsigned int nr``h]j)}(hj-4h]hunsigned int nr}(hj/4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+4ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj'4ubjV)}(hhh]h)}(h ioctl numberh]h ioctl number}(hjF4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjB4hMhjC4ubah}(h]h ]h"]h$]h&]uh1jUhj'4ubeh}(h]h ]h"]h$]h&]uh1j5hjB4hMhj$4ubj6)}(hC``unsigned int *flags`` where to return the ioctl permission flags h](j<)}(h``unsigned int *flags``h]j)}(hjf4h]hunsigned int *flags}(hjh4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjd4ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj`4ubjV)}(hhh]h)}(h*where to return the ioctl permission flagsh]h*where to return the ioctl permission flags}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{4hMhj|4ubah}(h]h ]h"]h$]h&]uh1jUhj`4ubeh}(h]h ]h"]h$]h&]uh1j5hj{4hMhj$4ubeh}(h]h ]h"]h$]h&]uh1j0hj4ubh)}(h**Description**h]j)}(hj4h]h Description}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj4ubh)}(hThis ioctl is only used by the vmwgfx driver to augment the access checks done by the drm core and insofar a pretty decent layering violation. This shouldn't be used by any drivers.h]hThis ioctl is only used by the vmwgfx driver to augment the access checks done by the drm core and insofar a pretty decent layering violation. This shouldn’t be used by any drivers.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj4ubh)}(h **Return**h]j)}(hj4h]hReturn}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj4ubh)}(hKTrue if the **nr** corresponds to a DRM core ioctl number, false otherwise.h](h True if the }(hj4hhhNhNubj)}(h**nr**h]hnr}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubh9 corresponds to a DRM core ioctl number, false otherwise.}(hj4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:557: ./drivers/gpu/drm/drm_ioctl.chMhj4ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_compat_ioctl (C function)c.drm_compat_ioctlhNtauh1jhjshhhNhNubj)}(hhh](j)}(hNlong drm_compat_ioctl (struct file *filp, unsigned int cmd, unsigned long arg)h]j)}(hMlong drm_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)h](j)}(hlongh]hlong}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chMjubj)}(h h]h }(hj.5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhj-5hMjubj)}(hdrm_compat_ioctlh]j)}(hdrm_compat_ioctlh]hdrm_compat_ioctl}(hj@5hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj<5ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj5hhhj-5hMjubj4)}(h8(struct file *filp, unsigned int cmd, unsigned long arg)h](j:)}(hstruct file *filph](j@)}(hjCh]hstruct}(hj\5hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjX5ubj)}(h h]h }(hji5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjX5ubh)}(hhh]j)}(hfileh]hfile}(hjz5hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjw5ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj|5modnameN classnameNj{j~)}j]j)}jwjB5sbc.drm_compat_ioctlasbuh1hhjX5ubj)}(h h]h }(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjX5ubj)}(hjh]h*}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjX5ubj)}(hfilph]hfilp}(hj5hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjX5ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjT5ubj:)}(hunsigned int cmdh](j)}(hunsignedh]hunsigned}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(h h]h }(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(hinth]hint}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(h h]h }(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(hcmdh]hcmd}(hj6hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjT5ubj:)}(hunsigned long argh](j)}(hunsignedh]hunsigned}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(h h]h }(hj-6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(hlongh]hlong}(hj;6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(h h]h }(hjI6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(hargh]harg}(hjW6hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj6ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjT5ubeh}(h]h ]h"]h$]h&]hhuh1j3hj5hhhj-5hMjubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj5hhhj-5hMjubah}(h]j5ah ](jjeh"]h$]h&]jj)jhuh1jhj-5hMjhj5hhubj)}(hhh]h)}(h132bit IOCTL compatibility handler for DRM driversh]h132bit IOCTL compatibility handler for DRM drivers}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chM]hj~6hhubah}(h]h ]h"]h$]h&]uh1jhj5hhhj-5hMjubeh}(h]h ](jfunctioneh"]h$]h&]j jj j6jj6jjjuh1jhhhjshNhNubj)}(hX**Parameters** ``struct file *filp`` file this ioctl is called on ``unsigned int cmd`` ioctl cmd number ``unsigned long arg`` user argument **Description** Compatibility handler for 32 bit userspace running on 64 kernels. All actual IOCTL handling is forwarded to drm_ioctl(), while marshalling structures as appropriate. Note that this only handles DRM core IOCTLs, if the driver has botched IOCTL itself, it must handle those by wrapping this function. **Return** Zero on success, negative error code on failure.h](h)}(h**Parameters**h]j)}(hj6h]h Parameters}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chMahj6ubj1)}(hhh](j6)}(h3``struct file *filp`` file this ioctl is called on h](j<)}(h``struct file *filp``h]j)}(hj6h]hstruct file *filp}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chM^hj6ubjV)}(hhh]h)}(hfile this ioctl is called onh]hfile this ioctl is called on}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hM^hj6ubah}(h]h ]h"]h$]h&]uh1jUhj6ubeh}(h]h ]h"]h$]h&]uh1j5hj6hM^hj6ubj6)}(h&``unsigned int cmd`` ioctl cmd number h](j<)}(h``unsigned int cmd``h]j)}(hj6h]hunsigned int cmd}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chM_hj6ubjV)}(hhh]h)}(hioctl cmd numberh]hioctl cmd number}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hM_hj7ubah}(h]h ]h"]h$]h&]uh1jUhj6ubeh}(h]h ]h"]h$]h&]uh1j5hj7hM_hj6ubj6)}(h$``unsigned long arg`` user argument h](j<)}(h``unsigned long arg``h]j)}(hj47h]hunsigned long arg}(hj67hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj27ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chM`hj.7ubjV)}(hhh]h)}(h user argumenth]h user argument}(hjM7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjI7hM`hjJ7ubah}(h]h ]h"]h$]h&]uh1jUhj.7ubeh}(h]h ]h"]h$]h&]uh1j5hjI7hM`hj6ubeh}(h]h ]h"]h$]h&]uh1j0hj6ubh)}(h**Description**h]j)}(hjo7h]h Description}(hjq7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjm7ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chMbhj6ubh)}(hX*Compatibility handler for 32 bit userspace running on 64 kernels. All actual IOCTL handling is forwarded to drm_ioctl(), while marshalling structures as appropriate. Note that this only handles DRM core IOCTLs, if the driver has botched IOCTL itself, it must handle those by wrapping this function.h]hX*Compatibility handler for 32 bit userspace running on 64 kernels. All actual IOCTL handling is forwarded to drm_ioctl(), while marshalling structures as appropriate. Note that this only handles DRM core IOCTLs, if the driver has botched IOCTL itself, it must handle those by wrapping this function.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chMbhj6ubh)}(h **Return**h]j)}(hj7h]hReturn}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chMghj6ubh)}(h0Zero on success, negative error code on failure.h]h0Zero on success, negative error code on failure.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:560: ./drivers/gpu/drm/drm_ioc32.chMghj6ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhjshhhNhNubeh}(h]recommended-ioctl-return-valuesah ]h"]recommended ioctl return valuesah$]h&]uh1hhj/hhhhhMubeh}(h](ioctl-support-on-device-nodesjeh ]h"](ioctl support on device nodesdrm_driver_ioctleh$]h&]uh1hhhhhhhhMj}j7jsj}jjsubh)}(hhh](h)}(hTesting and validationh]hTesting and validation}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hhhhhM4ubh)}(hhh](h)}(h&Testing Requirements for userspace APIh]h&Testing Requirements for userspace API}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hhhhhM7ubh)}(hXNew cross-driver userspace interface extensions, like new IOCTL, new KMS properties, new files in sysfs or anything else that constitutes an API change should have driver-agnostic testcases in IGT for that feature, if such a test can be reasonably made using IGT for the target hardware.h]hXNew cross-driver userspace interface extensions, like new IOCTL, new KMS properties, new files in sysfs or anything else that constitutes an API change should have driver-agnostic testcases in IGT for that feature, if such a test can be reasonably made using IGT for the target hardware.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM9hj7hhubeh}(h]&testing-requirements-for-userspace-apiah ]h"]&testing requirements for userspace apiah$]h&]uh1hhj7hhhhhM7ubh)}(hhh](h)}(hValidating changes with IGTh]hValidating changes with IGT}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj 8hhhhhM?ubh)}(hXSThere's a collection of tests that aims to cover the whole functionality of DRM drivers and that can be used to check that changes to DRM drivers or the core don't regress existing functionality. This test suite is called IGT and its code and instructions to build and run can be found in https://gitlab.freedesktop.org/drm/igt-gpu-tools/.h](hX%There’s a collection of tests that aims to cover the whole functionality of DRM drivers and that can be used to check that changes to DRM drivers or the core don’t regress existing functionality. This test suite is called IGT and its code and instructions to build and run can be found in }(hj8hhhNhNubj)}(h1https://gitlab.freedesktop.org/drm/igt-gpu-tools/h]h1https://gitlab.freedesktop.org/drm/igt-gpu-tools/}(hj&8hhhNhNubah}(h]h ]h"]h$]h&]refurij(8uh1jhj8ubh.}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMAhj 8hhubeh}(h]validating-changes-with-igtah ]h"]validating changes with igtah$]h&]uh1hhj7hhhhhM?ubh)}(hhh](h)}(hUsing VKMS to test DRM APIh]hUsing VKMS to test DRM API}(hjJ8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjG8hhhhhMHubh)}(hXVKMS is a software-only model of a KMS driver that is useful for testing and for running compositors. VKMS aims to enable a virtual display without the need for a hardware display capability. These characteristics made VKMS a perfect tool for validating the DRM core behavior and also support the compositor developer. VKMS makes it possible to test DRM functions in a virtual machine without display, simplifying the validation of some of the core changes.h]hXVKMS is a software-only model of a KMS driver that is useful for testing and for running compositors. VKMS aims to enable a virtual display without the need for a hardware display capability. These characteristics made VKMS a perfect tool for validating the DRM core behavior and also support the compositor developer. VKMS makes it possible to test DRM functions in a virtual machine without display, simplifying the validation of some of the core changes.}(hjX8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMJhjG8hhubh)}(hXBTo Validate changes in DRM API with VKMS, start setting the kernel: make sure to enable VKMS module; compile the kernel with the VKMS enabled and install it in the target machine. VKMS can be run in a Virtual Machine (QEMU, virtme or similar). It's recommended the use of KVM with the minimum of 1GB of RAM and four cores.h]hXDTo Validate changes in DRM API with VKMS, start setting the kernel: make sure to enable VKMS module; compile the kernel with the VKMS enabled and install it in the target machine. VKMS can be run in a Virtual Machine (QEMU, virtme or similar). It’s recommended the use of KVM with the minimum of 1GB of RAM and four cores.}(hjf8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMRhjG8hhubh)}(h7It's possible to run the IGT-tests in a VM in two ways:h]h9It’s possible to run the IGT-tests in a VM in two ways:}(hjt8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMXhjG8hhubj%)}(he1. Use IGT inside a VM 2. Use IGT from the host machine and write the results in a shared directory. h]j)}(hhh](j0)}(hUse IGT inside a VMh]h)}(hj8h]hUse IGT inside a VM}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMZhj8ubah}(h]h ]h"]h$]h&]uh1j/hj8ubj0)}(hKUse IGT from the host machine and write the results in a shared directory. h]h)}(hJUse IGT from the host machine and write the results in a shared directory.h]hJUse IGT from the host machine and write the results in a shared directory.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM[hj8ubah}(h]h ]h"]h$]h&]uh1j/hj8ubeh}(h]h ]h"]h$]h&]j jjhjjuh1jhj8ubah}(h]h ]h"]h$]h&]uh1j$hhhMZhjG8hhubh)}(hFollowing is an example of using a VM with a shared directory with the host machine to run igt-tests. This example uses virtme::h]hFollowing is an example of using a VM with a shared directory with the host machine to run igt-tests. This example uses virtme:}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM]hjG8hhubj )}(hV$ virtme-run --rwdir /path/for/shared_dir --kdir=path/for/kernel/directory --mods=autoh]hV$ virtme-run --rwdir /path/for/shared_dir --kdir=path/for/kernel/directory --mods=auto}hj8sbah}(h]h ]h"]h$]h&]hhuh1j hhhM`hjG8hhubh)}(hPRun the igt-tests in the guest machine. This example runs the 'kms_flip' tests::h]hSRun the igt-tests in the guest machine. This example runs the ‘kms_flip’ tests:}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMbhjG8hhubj )}(hG$ /path/for/igt-gpu-tools/scripts/run-tests.sh -p -s -t "kms_flip.*" -vh]hG$ /path/for/igt-gpu-tools/scripts/run-tests.sh -p -s -t "kms_flip.*" -v}hj8sbah}(h]h ]h"]h$]h&]hhuh1j hhhMehjG8hhubh)}(hIn this example, instead of building the igt_runner, Piglit is used (-p option). It creates an HTML summary of the test results and saves them in the folder "igt-gpu-tools/results". It executes only the igt-tests matching the -t option.h]hIn this example, instead of building the igt_runner, Piglit is used (-p option). It creates an HTML summary of the test results and saves them in the folder “igt-gpu-tools/results”. It executes only the igt-tests matching the -t option.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMghjG8hhubeh}(h]using-vkms-to-test-drm-apiah ]h"]using vkms to test drm apiah$]h&]uh1hhj7hhhhhMHubh)}(hhh](h)}(hDisplay CRC Supporth]hDisplay CRC Support}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hhhhhMmubh)}(hDRM device drivers can provide to userspace CRC information of each frame as it reached a given hardware component (a CRC sampling "source").h]hDRM device drivers can provide to userspace CRC information of each frame as it reached a given hardware component (a CRC sampling “source”).}(hj#9hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:623: ./drivers/gpu/drm/drm_debugfs_crc.chK+hj9hhubh)}(hXOUserspace 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 :ref:`index of the CRTC`. Accepted values are source names (which are driver-specific) and the "auto" keyword, which will let the driver select a default source of frame CRCs for this CRTC.h](hUserspace 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 }(hj29hhhNhNubh)}(h$:ref:`index of the CRTC`h]j<)}(hj<9h]hindex of the CRTC}(hj>9hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hj:9ubah}(h]h ]h"]h$]h&]refdocj refdomainjH9reftyperef refexplicitrefwarnj crtc_indexuh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:623: ./drivers/gpu/drm/drm_debugfs_crc.chK.hj29ubh. Accepted values are source names (which are driver-specific) and the “auto” keyword, which will let the driver select a default source of frame CRCs for this CRTC.}(hj29hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjZ9hK.hj9hhubh)}(hXMOnce 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 number in the first field and then a number of unsigned integer fields containing the CRC data. Fields are separated by a single space and the number of CRC fields is source-specific.h]hXMOnce 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 number in the first field and then a number of unsigned integer fields containing the CRC data. Fields are separated by a single space and the number of CRC fields is source-specific.}(hje9hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:623: ./drivers/gpu/drm/drm_debugfs_crc.chK4hj9hhubh)}(hX Note that though in some cases the CRC is computed in a specified way and on the frame contents as supplied by userspace (eDP 1.3), in general the CRC computation is performed in an unspecified way and on frame contents that have been already processed in also an unspecified way and thus userspace cannot rely on being able to generate matching CRC values for the frame contents that it submits. In this general case, the maximum userspace can do is to compare the reported CRCs of frames that should have the same contents.h]hX Note that though in some cases the CRC is computed in a specified way and on the frame contents as supplied by userspace (eDP 1.3), in general the CRC computation is performed in an unspecified way and on frame contents that have been already processed in also an unspecified way and thus userspace cannot rely on being able to generate matching CRC values for the frame contents that it submits. In this general case, the maximum userspace can do is to compare the reported CRCs of frames that should have the same contents.}(hjt9hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:623: ./drivers/gpu/drm/drm_debugfs_crc.chK:hj9hhubh)}(hXOn the driver side the implementation effort is minimal, drivers only need to implement :c:type:`drm_crtc_funcs.set_crc_source ` and :c:type:`drm_crtc_funcs.verify_crc_source `. The debugfs files are automatically set up if those vfuncs are set. CRC samples need to be captured in the driver by calling drm_crtc_add_crc_entry(). Depending on the driver and HW requirements, :c:type:`drm_crtc_funcs.set_crc_source ` may result in a commit (even a full modeset).h](hXOn the driver side the implementation effort is minimal, drivers only need to implement }(hj9hhhNhNubh)}(h8:c:type:`drm_crtc_funcs.set_crc_source `h]j)}(hj9h]hdrm_crtc_funcs.set_crc_source}(hj9hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_crtc_funcsuh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:623: ./drivers/gpu/drm/drm_debugfs_crc.chKBhj9ubh and }(hj9hhhNhNubh)}(h;:c:type:`drm_crtc_funcs.verify_crc_source `h]j)}(hj9h]h drm_crtc_funcs.verify_crc_source}(hj9hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_crtc_funcsuh1hhj9hKBhj9ubh. The debugfs files are automatically set up if those vfuncs are set. CRC samples need to be captured in the driver by calling drm_crtc_add_crc_entry(). Depending on the driver and HW requirements, }(hj9hhhNhNubh)}(h8:c:type:`drm_crtc_funcs.set_crc_source `h]j)}(hj9h]hdrm_crtc_funcs.set_crc_source}(hj9hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_crtc_funcsuh1hhj9hKBhj9ubh. may result in a commit (even a full modeset).}(hj9hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj9hKBhj9hhubh)}(hXCRC results must be reliable across non-full-modeset atomic commits, so if a commit via DRM_IOCTL_MODE_ATOMIC would disable or otherwise interfere with CRC generation, then the driver must mark that commit as a full modeset (drm_atomic_crtc_needs_modeset() should return true). As a result, to ensure consistent results, generic userspace must re-setup CRC generation after a legacy SETCRTC or an atomic commit with DRM_MODE_ATOMIC_ALLOW_MODESET.h]hXCRC results must be reliable across non-full-modeset atomic commits, so if a commit via DRM_IOCTL_MODE_ATOMIC would disable or otherwise interfere with CRC generation, then the driver must mark that commit as a full modeset (drm_atomic_crtc_needs_modeset() should return true). As a result, to ensure consistent results, generic userspace must re-setup CRC generation after a legacy SETCRTC or an atomic commit with DRM_MODE_ATOMIC_ALLOW_MODESET.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:623: ./drivers/gpu/drm/drm_debugfs_crc.chKIhj9hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#drm_crtc_add_crc_entry (C function)c.drm_crtc_add_crc_entryhNtauh1jhj9hhhNhNubj)}(hhh](j)}(hbint drm_crtc_add_crc_entry (struct drm_crtc *crtc, bool has_frame, uint32_t frame, uint32_t *crcs)h]j)}(haint drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame, uint32_t frame, uint32_t *crcs)h](j)}(hinth]hint}(hj#:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:hhh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMubj)}(h h]h }(hj2:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:hhhj1:hMubj)}(hdrm_crtc_add_crc_entryh]j)}(hdrm_crtc_add_crc_entryh]hdrm_crtc_add_crc_entry}(hjD:hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj@:ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj:hhhj1:hMubj4)}(hG(struct drm_crtc *crtc, bool has_frame, uint32_t frame, uint32_t *crcs)h](j:)}(hstruct drm_crtc *crtch](j@)}(hjCh]hstruct}(hj`:hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj\:ubj)}(h h]h }(hjm:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\:ubh)}(hhh]j)}(hdrm_crtch]hdrm_crtc}(hj~:hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj{:ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj:modnameN classnameNj{j~)}j]j)}jwjF:sbc.drm_crtc_add_crc_entryasbuh1hhj\:ubj)}(h h]h }(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\:ubj)}(hjh]h*}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\:ubj)}(hcrtch]hcrtc}(hj:hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj\:ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjX:ubj:)}(hbool has_frameh](j)}(hjh]hbool}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubj)}(h h]h }(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubj)}(h has_frameh]h has_frame}(hj:hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj:ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjX:ubj:)}(huint32_t frameh](h)}(hhh]j)}(huint32_th]huint32_t}(hj ;hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj ;modnameN classnameNj{j~)}j]j:c.drm_crtc_add_crc_entryasbuh1hhj;ubj)}(h h]h }(hj';hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubj)}(hframeh]hframe}(hj5;hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjX:ubj:)}(huint32_t *crcsh](h)}(hhh]j)}(huint32_th]huint32_t}(hjQ;hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjN;ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjS;modnameN classnameNj{j~)}j]j:c.drm_crtc_add_crc_entryasbuh1hhjJ;ubj)}(h h]h }(hjo;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ;ubj)}(hjh]h*}(hj};hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJ;ubj)}(hcrcsh]hcrcs}(hj;hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjJ;ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjX:ubeh}(h]h ]h"]h$]h&]hhuh1j3hj:hhhj1:hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj:hhhj1:hMubah}(h]j:ah ](jjeh"]h$]h&]jj)jhuh1jhj1:hMhj:hhubj)}(hhh]h)}(h*Add entry with CRC information for a frameh]h*Add entry with CRC information for a frame}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj;hhubah}(h]h ]h"]h$]h&]uh1jhj:hhhj1:hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j;jj;jjjuh1jhhhj9hNhNubj)}(hX**Parameters** ``struct drm_crtc *crtc`` CRTC to which the frame belongs ``bool has_frame`` whether this entry has a frame number to go with ``uint32_t frame`` number of the frame these CRCs are about ``uint32_t *crcs`` array of CRC values, with length matching #drm_crtc_crc.values_cnt **Description** For each frame, the driver polls the source of CRCs for new data and calls this function to add them to the buffer from where userspace reads.h](h)}(h**Parameters**h]j)}(hj;h]h Parameters}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj;ubj1)}(hhh](j6)}(h:``struct drm_crtc *crtc`` CRTC to which the frame belongs h](j<)}(h``struct drm_crtc *crtc``h]j)}(hj;h]hstruct drm_crtc *crtc}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1j;h_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj;ubjV)}(hhh]h)}(hCRTC to which the frame belongsh]hCRTC to which the frame belongs}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj <hMhj <ubah}(h]h ]h"]h$]h&]uh1jUhj;ubeh}(h]h ]h"]h$]h&]uh1j5hj <hMhj;ubj6)}(hD``bool has_frame`` whether this entry has a frame number to go with h](j<)}(h``bool has_frame``h]j)}(hj.<h]hbool has_frame}(hj0<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,<ubah}(h]h ]h"]h$]h&]uh1j;h_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj(<ubjV)}(hhh]h)}(h0whether this entry has a frame number to go withh]h0whether this entry has a frame number to go with}(hjG<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjC<hMhjD<ubah}(h]h ]h"]h$]h&]uh1jUhj(<ubeh}(h]h ]h"]h$]h&]uh1j5hjC<hMhj;ubj6)}(h<``uint32_t frame`` number of the frame these CRCs are about h](j<)}(h``uint32_t frame``h]j)}(hjg<h]huint32_t frame}(hji<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhje<ubah}(h]h ]h"]h$]h&]uh1j;h_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhja<ubjV)}(hhh]h)}(h(number of the frame these CRCs are abouth]h(number of the frame these CRCs are about}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|<hMhj}<ubah}(h]h ]h"]h$]h&]uh1jUhja<ubeh}(h]h ]h"]h$]h&]uh1j5hj|<hMhj;ubj6)}(hV``uint32_t *crcs`` array of CRC values, with length matching #drm_crtc_crc.values_cnt h](j<)}(h``uint32_t *crcs``h]j)}(hj<h]huint32_t *crcs}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1j;h_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj<ubjV)}(hhh]h)}(hBarray of CRC values, with length matching #drm_crtc_crc.values_cnth]hBarray of CRC values, with length matching #drm_crtc_crc.values_cnt}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj<hMhj<ubah}(h]h ]h"]h$]h&]uh1jUhj<ubeh}(h]h ]h"]h$]h&]uh1j5hj<hMhj;ubeh}(h]h ]h"]h$]h&]uh1j0hj;ubh)}(h**Description**h]j)}(hj<h]h Description}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj;ubh)}(hFor each frame, the driver polls the source of CRCs for new data and calls this function to add them to the buffer from where userspace reads.h]hFor each frame, the driver polls the source of CRCs for new data and calls this function to add them to the buffer from where userspace reads.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:626: ./drivers/gpu/drm/drm_debugfs_crc.chMhj;ubeh}(h]h ] kernelindenta$h"]h$]h&]uh1jhj9hhhNhNubeh}(h]display-crc-supportah ]h"]display crc supportah$]h&]uh1hhj7hhhhhMmubh)}(hhh](h)}(hDebugfs Supporth]hDebugfs Support}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hhhhhMvubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j DRM_DEBUGFS_GPUVA_INFO (C macro)c.DRM_DEBUGFS_GPUVA_INFOhNtauh1jhj=hhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhNubj)}(hhh](j)}(hDRM_DEBUGFS_GPUVA_INFOh]j)}(hDRM_DEBUGFS_GPUVA_INFOh]j)}(hDRM_DEBUGFS_GPUVA_INFOh]j)}(hj4=h]hDRM_DEBUGFS_GPUVA_INFO}(hj>=hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj:=ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj6=hhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK3ubah}(h]h ]h"]h$]h&]hhjuh1jjjhj2=hhhjQ=hK3ubah}(h]j,=ah ](jjeh"]h$]h&]jj)jhuh1jhjQ=hK3hj/=hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj/=hhhjQ=hK3ubeh}(h]h ](jmacroeh"]h$]h&]j jj jj=jjj=jjjuh1jhhhj=hj.=hNubh)}(h'``DRM_DEBUGFS_GPUVA_INFO (show, data)``h]j)}(hjp=h]h#DRM_DEBUGFS_GPUVA_INFO (show, data)}(hjr=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjn=ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK5hj=hhubj%)}(h5:c:type:`drm_info_list` entry to dump a GPU VA space h]h)}(h4:c:type:`drm_info_list` entry to dump a GPU VA spaceh](h)}(h:c:type:`drm_info_list`h]j)}(hj=h]h drm_info_list}(hj=hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_info_listuh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK)hj=ubh entry to dump a GPU VA space}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj=hK)hj=ubah}(h]h ]h"]h$]h&]uh1j$hj=hK)hj=hhubj)}(hXs**Parameters** ``show`` the :c:type:`drm_info_list`'s show callback ``data`` driver private data **Description** Drivers should use this macro to define a :c:type:`drm_info_list` entry to provide a debugfs file for dumping the GPU VA space regions and mappings. For each DRM GPU VA space drivers should call drm_debugfs_gpuva_info() from their **show** callback.h](h)}(h**Parameters**h]j)}(hj=h]h Parameters}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK-hj=ubj1)}(hhh](j6)}(h5``show`` the :c:type:`drm_info_list`'s show callback h](j<)}(h``show``h]j)}(hj=h]hshow}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK*hj=ubjV)}(hhh]h)}(h+the :c:type:`drm_info_list`'s show callbackh](hthe }(hj=hhhNhNubh)}(h:c:type:`drm_info_list`h]j)}(hj>h]h drm_info_list}(hj>hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj>ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_info_listuh1hhj=hK*hj=ubh’s show callback}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj=hK*hj=ubah}(h]h ]h"]h$]h&]uh1jUhj=ubeh}(h]h ]h"]h$]h&]uh1j5hj=hK*hj=ubj6)}(h``data`` driver private data h](j<)}(h``data``h]j)}(hj?>h]hdata}(hjA>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=>ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK+hj9>ubjV)}(hhh]h)}(hdriver private datah]hdriver private data}(hjX>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjT>hK+hjU>ubah}(h]h ]h"]h$]h&]uh1jUhj9>ubeh}(h]h ]h"]h$]h&]uh1j5hjT>hK+hj=ubeh}(h]h ]h"]h$]h&]uh1j0hj=ubh)}(h**Description**h]j)}(hjz>h]h Description}(hj|>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjx>ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK-hj=ubh)}(hDrivers should use this macro to define a :c:type:`drm_info_list` entry to provide a debugfs file for dumping the GPU VA space regions and mappings.h](h*Drivers should use this macro to define a }(hj>hhhNhNubh)}(h:c:type:`drm_info_list`h]j)}(hj>h]h drm_info_list}(hj>hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj>ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_info_listuh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK-hj>ubhS entry to provide a debugfs file for dumping the GPU VA space regions and mappings.}(hj>hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj>hK-hj=ubh)}(hdFor each DRM GPU VA space drivers should call drm_debugfs_gpuva_info() from their **show** callback.h](hRFor each DRM GPU VA space drivers should call drm_debugfs_gpuva_info() from their }(hj>hhhNhNubj)}(h**show**h]hshow}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubh callback.}(hj>hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK0hj=ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhj.=hNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_info_list (C struct)c.drm_info_listhNtauh1jhj=hhhj.=hNubj)}(hhh](j)}(h drm_info_listh]j)}(hstruct drm_info_listh](j@)}(hjCh]hstruct}(hj?hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj>hhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK6ubj)}(h h]h }(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>hhhj?hK6ubj)}(h drm_info_listh]j)}(hj>h]h drm_info_list}(hj#?hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj?ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj>hhhj?hK6ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj>hhhj?hK6ubah}(h]j>ah ](jjeh"]h$]h&]jj)jhuh1jhj?hK6hj>hhubj)}(hhh]h)}(hdebugfs info list entryh]hdebugfs info list entry}(hjE?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK6hjB?hhubah}(h]h ]h"]h$]h&]uh1jhj>hhhj?hK6ubeh}(h]h ](jstructeh"]h$]h&]j jj j]?jj]?jjjuh1jhhhj=hj.=hNubj)}(hX(**Definition**:: struct drm_info_list { const char *name; int (*show)(struct seq_file*, void*); u32 driver_features; void *data; }; **Members** ``name`` file name ``show`` Show callback. :c:type:`seq_file->private ` will be set to the :c:type:`struct drm_info_node ` corresponding to the instance of this info on a given :c:type:`struct drm_minor `. ``driver_features`` Required driver features for this entry ``data`` Driver-private data, should not be device-specific.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hji?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhje?ubh:}(hje?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK:hja?ubj )}(hstruct drm_info_list { const char *name; int (*show)(struct seq_file*, void*); u32 driver_features; void *data; };h]hstruct drm_info_list { const char *name; int (*show)(struct seq_file*, void*); u32 driver_features; void *data; };}hj?sbah}(h]h ]h"]h$]h&]hhuh1j hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKprivate ` will be set to the :c:type:`struct drm_info_node ` corresponding to the instance of this info on a given :c:type:`struct drm_minor `. h](j<)}(h``show``h]j)}(hj?h]hshow}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKBhj?ubjV)}(hhh]h)}(hShow callback. :c:type:`seq_file->private ` will be set to the :c:type:`struct drm_info_node ` corresponding to the instance of this info on a given :c:type:`struct drm_minor `.h](hShow callback. }(hj@hhhNhNubh)}(h&:c:type:`seq_file->private `h]j)}(hj@h]hseq_file->private}(hj@hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj @ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjseq_fileuh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK@hj@ubh will be set to the }(hj@hhhNhNubh)}(h.:c:type:`struct drm_info_node `h]j)}(hj2@h]hstruct drm_info_node}(hj4@hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj0@ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_info_nodeuh1hhj+@hK@hj@ubh7 corresponding to the instance of this info on a given }(hj@hhhNhNubh)}(h&:c:type:`struct drm_minor `h]j)}(hjU@h]hstruct drm_minor}(hjW@hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjS@ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_minoruh1hhj+@hK@hj@ubh.}(hj@hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj+@hK@hj@ubah}(h]h ]h"]h$]h&]uh1jUhj?ubeh}(h]h ]h"]h$]h&]uh1j5hj@hKBhj?ubj6)}(h<``driver_features`` Required driver features for this entry h](j<)}(h``driver_features``h]j)}(hj@h]hdriver_features}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj@ubjV)}(hhh]h)}(h'Required driver features for this entryh]h'Required driver features for this entry}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hKhj@ubah}(h]h ]h"]h$]h&]uh1jUhj@ubeh}(h]h ]h"]h$]h&]uh1j5hj@hKhj?ubj6)}(h<``data`` Driver-private data, should not be device-specific.h](j<)}(h``data``h]j)}(hj@h]hdata}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj@ubjV)}(hhh]h)}(h3Driver-private data, should not be device-specific.h]h3Driver-private data, should not be device-specific.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj@ubah}(h]h ]h"]h$]h&]uh1jUhj@ubeh}(h]h ]h"]h$]h&]uh1j5hj@hKhj?ubeh}(h]h ]h"]h$]h&]uh1j0hja?ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhj.=hNubh)}(h**Description**h]j)}(hj Ah]h Description}(hj AhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj=hhubh)}(hGThis structure represents a debugfs file to be created by the drm core.h]hGThis structure represents a debugfs file to be created by the drm core.}(hj AhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK7hj=hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_info_node (C struct)c.drm_info_nodehNtauh1jhj=hhhj.=hNubj)}(hhh](j)}(h drm_info_nodeh]j)}(hstruct drm_info_nodeh](j@)}(hjCh]hstruct}(hjHAhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjDAhhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK=ubj)}(h h]h }(hjVAhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjDAhhhjUAhK=ubj)}(h drm_info_nodeh]j)}(hjBAh]h drm_info_node}(hjhAhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjdAubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjDAhhhjUAhK=ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj@AhhhjUAhK=ubah}(h]j;Aah ](jjeh"]h$]h&]jj)jhuh1jhjUAhK=hj=Ahhubj)}(hhh]h)}(h Per-minor debugfs node structureh]h Per-minor debugfs node structure}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKMhjAhhubah}(h]h ]h"]h$]h&]uh1jhj=AhhhjUAhK=ubeh}(h]h ](jstructeh"]h$]h&]j jj jAjjAjjjuh1jhhhj=hj.=hNubj)}(h**Definition**:: struct drm_info_node { struct drm_minor *minor; const struct drm_info_list *info_ent; }; **Members** ``minor`` :c:type:`struct drm_minor ` for this node. ``info_ent`` template for this node.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubh:}(hjAhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKQhjAubj )}(h`struct drm_info_node { struct drm_minor *minor; const struct drm_info_list *info_ent; };h]h`struct drm_info_node { struct drm_minor *minor; const struct drm_info_list *info_ent; };}hjAsbah}(h]h ]h"]h$]h&]hhuh1j hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKShjAubh)}(h **Members**h]j)}(hjAh]hMembers}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKXhjAubj1)}(hhh](j6)}(h@``minor`` :c:type:`struct drm_minor ` for this node. h](j<)}(h ``minor``h]j)}(hjAh]hminor}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKYhjAubjV)}(hhh]h)}(h5:c:type:`struct drm_minor ` for this node.h](h)}(h&:c:type:`struct drm_minor `h]j)}(hjBh]hstruct drm_minor}(hjBhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_minoruh1hhj BhKYhjBubh for this node.}(hjBhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj BhKYhj Bubah}(h]h ]h"]h$]h&]uh1jUhjAubeh}(h]h ]h"]h$]h&]uh1j5hj BhKYhjAubj6)}(h$``info_ent`` template for this node.h](j<)}(h ``info_ent``h]j)}(hjOBh]hinfo_ent}(hjQBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMBubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjIBubjV)}(hhh]h)}(htemplate for this node.h]htemplate for this node.}(hjhBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjeBubah}(h]h ]h"]h$]h&]uh1jUhjIBubeh}(h]h ]h"]h$]h&]uh1j5hjdBhKhjAubeh}(h]h ]h"]h$]h&]uh1j0hjAubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhj.=hNubh)}(h**Description**h]j)}(hjBh]h Description}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj=hhubh)}(hThis structure represents a debugfs file, as an instantiation of a :c:type:`struct drm_info_list ` on a :c:type:`struct drm_minor `.h](hCThis structure represents a debugfs file, as an instantiation of a }(hjBhhhNhNubh)}(h.:c:type:`struct drm_info_list `h]j)}(hjBh]hstruct drm_info_list}(hjBhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_info_listuh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKNhjBubh on a }(hjBhhhNhNubh)}(h&:c:type:`struct drm_minor `h]j)}(hjBh]hstruct drm_minor}(hjBhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_minoruh1hhjBhKNhjBubh.}(hjBhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjBhKNhj=hhubh)}(hFIXME:h]hFIXME:}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKQhj=hhubh)}(hNo it doesn't make a hole lot of sense that we duplicate debugfs entries for both the render and the primary nodes, but that's how this has organically grown. It should probably be fixed, with a compatibility link, if needed.h]hNo it doesn’t make a hole lot of sense that we duplicate debugfs entries for both the render and the primary nodes, but that’s how this has organically grown. It should probably be fixed, with a compatibility link, if needed.}(hj ChhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKShj=hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_debugfs_info (C struct)c.drm_debugfs_infohNtauh1jhj=hhhj.=hNubj)}(hhh](j)}(hdrm_debugfs_infoh]j)}(hstruct drm_debugfs_infoh](j@)}(hjCh]hstruct}(hj4ChhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj0ChhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKZubj)}(h h]h }(hjBChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ChhhjAChKZubj)}(hdrm_debugfs_infoh]j)}(hj.Ch]hdrm_debugfs_info}(hjTChhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjPCubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj0ChhhjAChKZubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj,ChhhjAChKZubah}(h]j'Cah ](jjeh"]h$]h&]jj)jhuh1jhjAChKZhj)Chhubj)}(hhh]h)}(hdebugfs info list entryh]hdebugfs info list entry}(hjvChhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKchjsChhubah}(h]h ]h"]h$]h&]uh1jhj)ChhhjAChKZubeh}(h]h ](jstructeh"]h$]h&]j jj jCjjCjjjuh1jhhhj=hj.=hNubj)}(hX6**Definition**:: struct drm_debugfs_info { const char *name; int (*show)(struct seq_file*, void*); u32 driver_features; void *data; }; **Members** ``name`` File name ``show`` Show callback. :c:type:`seq_file->private ` will be set to the :c:type:`struct drm_debugfs_entry ` corresponding to the instance of this info on a given :c:type:`struct drm_device `. ``driver_features`` Required driver features for this entry. ``data`` Driver-private data, should not be device-specific.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubh:}(hjChhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKghjCubj )}(hstruct drm_debugfs_info { const char *name; int (*show)(struct seq_file*, void*); u32 driver_features; void *data; };h]hstruct drm_debugfs_info { const char *name; int (*show)(struct seq_file*, void*); u32 driver_features; void *data; };}hjCsbah}(h]h ]h"]h$]h&]hhuh1j hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKihjCubh)}(h **Members**h]j)}(hjCh]hMembers}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKphjCubj1)}(hhh](j6)}(h``name`` File name h](j<)}(h``name``h]j)}(hjCh]hname}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKihjCubjV)}(hhh]h)}(h File nameh]h File name}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjChKihjCubah}(h]h ]h"]h$]h&]uh1jUhjCubeh}(h]h ]h"]h$]h&]uh1j5hjChKihjCubj6)}(h``show`` Show callback. :c:type:`seq_file->private ` will be set to the :c:type:`struct drm_debugfs_entry ` corresponding to the instance of this info on a given :c:type:`struct drm_device `. h](j<)}(h``show``h]j)}(hjDh]hshow}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKphjDubjV)}(hhh]h)}(hShow callback. :c:type:`seq_file->private ` will be set to the :c:type:`struct drm_debugfs_entry ` corresponding to the instance of this info on a given :c:type:`struct drm_device `.h](hShow callback. }(hj5DhhhNhNubh)}(h&:c:type:`seq_file->private `h]j)}(hj?Dh]hseq_file->private}(hjADhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj=Dubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjseq_fileuh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKnhj5Dubh will be set to the }(hj5DhhhNhNubh)}(h6:c:type:`struct drm_debugfs_entry `h]j)}(hjcDh]hstruct drm_debugfs_entry}(hjeDhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjaDubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_debugfs_entryuh1hhj\DhKnhj5Dubh7 corresponding to the instance of this info on a given }(hj5DhhhNhNubh)}(h(:c:type:`struct drm_device `h]j)}(hjDh]hstruct drm_device}(hjDhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhj\DhKnhj5Dubh.}(hj5DhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj\DhKnhj2Dubah}(h]h ]h"]h$]h&]uh1jUhjDubeh}(h]h ]h"]h$]h&]uh1j5hj1DhKphjCubj6)}(h=``driver_features`` Required driver features for this entry. h](j<)}(h``driver_features``h]j)}(hjDh]hdriver_features}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjDubjV)}(hhh]h)}(h(Required driver features for this entry.h]h(Required driver features for this entry.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhKhjDubah}(h]h ]h"]h$]h&]uh1jUhjDubeh}(h]h ]h"]h$]h&]uh1j5hjDhKhjCubj6)}(h<``data`` Driver-private data, should not be device-specific.h](j<)}(h``data``h]j)}(hjDh]hdata}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjDubjV)}(hhh]h)}(h3Driver-private data, should not be device-specific.h]h3Driver-private data, should not be device-specific.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjEubah}(h]h ]h"]h$]h&]uh1jUhjDubeh}(h]h ]h"]h$]h&]uh1j5hj EhKhjCubeh}(h]h ]h"]h$]h&]uh1j0hjCubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhj.=hNubh)}(h**Description**h]j)}(hj;Eh]h Description}(hj=EhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9Eubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj=hhubh)}(hGThis structure represents a debugfs file to be created by the drm core.h]hGThis structure represents a debugfs file to be created by the drm core.}(hjQEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKdhj=hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_debugfs_entry (C struct)c.drm_debugfs_entryhNtauh1jhj=hhhj.=hNubj)}(hhh](j)}(hdrm_debugfs_entryh]j)}(hstruct drm_debugfs_entryh](j@)}(hjCh]hstruct}(hjyEhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjuEhhhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKjubj)}(h h]h }(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuEhhhjEhKjubj)}(hdrm_debugfs_entryh]j)}(hjsEh]hdrm_debugfs_entry}(hjEhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjEubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjuEhhhjEhKjubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjqEhhhjEhKjubah}(h]jlEah ](jjeh"]h$]h&]jj)jhuh1jhjEhKjhjnEhhubj)}(hhh]h)}(h!Per-device debugfs node structureh]h!Per-device debugfs node structure}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK}hjEhhubah}(h]h ]h"]h$]h&]uh1jhjnEhhhjEhKjubeh}(h]h ](jstructeh"]h$]h&]j jj jEjjEjjjuh1jhhhj=hj.=hNubj)}(hX3**Definition**:: struct drm_debugfs_entry { struct drm_device *dev; struct drm_debugfs_info file; struct list_head list; }; **Members** ``dev`` :c:type:`struct drm_device ` for this node. ``file`` Template for this node. ``list`` Linked list of all device nodes.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjEubh:}(hjEhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjEubj )}(hvstruct drm_debugfs_entry { struct drm_device *dev; struct drm_debugfs_info file; struct list_head list; };h]hvstruct drm_debugfs_entry { struct drm_device *dev; struct drm_debugfs_info file; struct list_head list; };}hjEsbah}(h]h ]h"]h$]h&]hhuh1j hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjEubh)}(h **Members**h]j)}(hj Fh]hMembers}(hj FhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjEubj1)}(hhh](j6)}(h@``dev`` :c:type:`struct drm_device ` for this node. h](j<)}(h``dev``h]j)}(hj(Fh]hdev}(hj*FhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&Fubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj"FubjV)}(hhh]h)}(h7:c:type:`struct drm_device ` for this node.h](h)}(h(:c:type:`struct drm_device `h]j)}(hjGFh]hstruct drm_device}(hjIFhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjEFubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhj=FhKhjAFubh for this node.}(hjAFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj=FhKhj>Fubah}(h]h ]h"]h$]h&]uh1jUhj"Fubeh}(h]h ]h"]h$]h&]uh1j5hj=FhKhjFubj6)}(h!``file`` Template for this node. h](j<)}(h``file``h]j)}(hjFh]hfile}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~Fubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjzFubjV)}(hhh]h)}(hTemplate for this node.h]hTemplate for this node.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhKhjFubah}(h]h ]h"]h$]h&]uh1jUhjzFubeh}(h]h ]h"]h$]h&]uh1j5hjFhKhjFubj6)}(h)``list`` Linked list of all device nodes.h](j<)}(h``list``h]j)}(hjFh]hlist}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1j;hW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjFubjV)}(hhh]h)}(h Linked list of all device nodes.h]h Linked list of all device nodes.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhjFubah}(h]h ]h"]h$]h&]uh1jUhjFubeh}(h]h ]h"]h$]h&]uh1j5hjFhKhjFubeh}(h]h ]h"]h$]h&]uh1j0hjEubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhj.=hNubh)}(h**Description**h]j)}(hjFh]h Description}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhKhj=hhubh)}(hThis structure represents a debugfs file, as an instantiation of a :c:type:`struct drm_debugfs_info ` on a :c:type:`struct drm_device `.h](hCThis structure represents a debugfs file, as an instantiation of a }(hjGhhhNhNubh)}(h4:c:type:`struct drm_debugfs_info `h]j)}(hjGh]hstruct drm_debugfs_info}(hjGhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_debugfs_infouh1hhW/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:632: ./include/drm/drm_debugfs.hhK~hjGubh on a }(hjGhhhNhNubh)}(h(:c:type:`struct drm_device `h]j)}(hj@Gh]hstruct drm_device}(hjBGhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj>Gubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhj9GhK~hjGubh.}(hjGhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj9GhK~hj=hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#drm_debugfs_gpuva_info (C function)c.drm_debugfs_gpuva_infohNtauh1jhj=hhhNhNubj)}(hhh](j)}(hHint drm_debugfs_gpuva_info (struct seq_file *m, struct drm_gpuvm *gpuvm)h]j)}(hGint drm_debugfs_gpuva_info(struct seq_file *m, struct drm_gpuvm *gpuvm)h](j)}(hinth]hint}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|Ghhh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKubj)}(h h]h }(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|GhhhjGhKubj)}(hdrm_debugfs_gpuva_infoh]j)}(hdrm_debugfs_gpuva_infoh]hdrm_debugfs_gpuva_info}(hjGhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjGubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj|GhhhjGhKubj4)}(h-(struct seq_file *m, struct drm_gpuvm *gpuvm)h](j:)}(hstruct seq_file *mh](j@)}(hjCh]hstruct}(hjGhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjGubj)}(h h]h }(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubh)}(hhh]j)}(hseq_fileh]hseq_file}(hjGhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjGmodnameN classnameNj{j~)}j]j)}jwjGsbc.drm_debugfs_gpuva_infoasbuh1hhjGubj)}(h h]h }(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubj)}(hjh]h*}(hj HhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubj)}(hmh]hm}(hjHhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjGubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjGubj:)}(hstruct drm_gpuvm *gpuvmh](j@)}(hjCh]hstruct}(hj/HhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj+Hubj)}(h h]h }(hj` in the given root directory. These files will be removed automatically on drm_debugfs_dev_fini().h](h)}(h**Parameters**h]j)}(hjLh]h Parameters}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}Lubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhjyLubj1)}(hhh](j6)}(hC``const struct drm_info_list *files`` The array of files to create h](j<)}(h%``const struct drm_info_list *files``h]j)}(hjLh]h!const struct drm_info_list *files}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhjLubjV)}(hhh]h)}(hThe array of files to createh]hThe array of files to create}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhKhjLubah}(h]h ]h"]h$]h&]uh1jUhjLubeh}(h]h ]h"]h$]h&]uh1j5hjLhKhjLubj6)}(h(``int count`` The number of files given h](j<)}(h ``int count``h]j)}(hjLh]h int count}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhjLubjV)}(hhh]h)}(hThe number of files givenh]hThe number of files given}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhKhjLubah}(h]h ]h"]h$]h&]uh1jUhjLubeh}(h]h ]h"]h$]h&]uh1j5hjLhKhjLubj6)}(h/``struct dentry *root`` DRI debugfs dir entry. h](j<)}(h``struct dentry *root``h]j)}(hjMh]hstruct dentry *root}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhj MubjV)}(hhh]h)}(hDRI debugfs dir entry.h]hDRI debugfs dir entry.}(hj)MhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%MhKhj&Mubah}(h]h ]h"]h$]h&]uh1jUhj Mubeh}(h]h ]h"]h$]h&]uh1j5hj%MhKhjLubj6)}(h0``struct drm_minor *minor`` device minor number h](j<)}(h``struct drm_minor *minor``h]j)}(hjIMh]hstruct drm_minor *minor}(hjKMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGMubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhjCMubjV)}(hhh]h)}(hdevice minor numberh]hdevice minor number}(hjbMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^MhKhj_Mubah}(h]h ]h"]h$]h&]uh1jUhjCMubeh}(h]h ]h"]h$]h&]uh1j5hj^MhKhjLubeh}(h]h ]h"]h$]h&]uh1j0hjyLubh)}(h**Description**h]j)}(hjMh]h Description}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhjyLubh)}(hCreate a given set of debugfs files represented by an array of :c:type:`struct drm_info_list ` in the given root directory. These files will be removed automatically on drm_debugfs_dev_fini().h](h?Create a given set of debugfs files represented by an array of }(hjMhhhNhNubh)}(h.:c:type:`struct drm_info_list `h]j)}(hjMh]hstruct drm_info_list}(hjMhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_info_listuh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chKhjMubhb in the given root directory. These files will be removed automatically on drm_debugfs_dev_fini().}(hjMhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjMhKhjyLubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!drm_debugfs_add_file (C function)c.drm_debugfs_add_filehNtauh1jhj=hhhNhNubj)}(hhh](j)}(hvvoid drm_debugfs_add_file (struct drm_device *dev, const char *name, int (*show)(struct seq_file*, void*), void *data)h]j)}(huvoid drm_debugfs_add_file(struct drm_device *dev, const char *name, int (*show)(struct seq_file*, void*), void *data)h](j)}(hvoidh]hvoid}(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMhhh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMgubj)}(h h]h }(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMhhhjMhMgubj)}(hdrm_debugfs_add_fileh]j)}(hdrm_debugfs_add_fileh]hdrm_debugfs_add_file}(hj NhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj Nubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjMhhhjMhMgubj4)}(h\(struct drm_device *dev, const char *name, int (*show)(struct seq_file*, void*), void *data)h](j:)}(hstruct drm_device *devh](j@)}(hjCh]hstruct}(hj)NhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj%Nubj)}(h h]h }(hj6NhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%Nubh)}(hhh]j)}(h drm_deviceh]h drm_device}(hjGNhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjDNubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjINmodnameN classnameNj{j~)}j]j)}jwjNsbc.drm_debugfs_add_fileasbuh1hhj%Nubj)}(h h]h }(hjgNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%Nubj)}(hjh]h*}(hjuNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%Nubj)}(hdevh]hdev}(hjNhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj%Nubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj!Nubj:)}(hconst char *nameh](j@)}(hjJh]hconst}(hjNhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjNubj)}(h h]h }(hjNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hcharh]hchar}(hjNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(h h]h }(hjNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hjh]h*}(hjNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hnameh]hname}(hjNhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjNubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj!Nubj:)}(h$int (*show)(struct seq_file*, void*)h](j)}(hinth]hint}(hjNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(h h]h }(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(h(h]h(}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hjh]h*}(hj"OhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hshowh]hshow}(hj/OhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjNubj)}(h)h]h)}(hj=OhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hjOh]h(}(hjKOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj@)}(hjCh]hstruct}(hjXOhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjNubj)}(h h]h }(hjeOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubh)}(hhh]j)}(hseq_fileh]hseq_file}(hjvOhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjsOubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjxOmodnameN classnameNj{j~)}j]jcNc.drm_debugfs_add_fileasbuh1hhjNubj)}(hjh]h*}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(h,h]h,}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(h h]h }(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hvoidh]hvoid}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hjh]h*}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubj)}(hj?Oh]h)}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj!Nubj:)}(h void *datah](j)}(hvoidh]hvoid}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubj)}(h h]h }(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubj)}(hjh]h*}(hj PhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubj)}(hdatah]hdata}(hjPhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj!Nubeh}(h]h ]h"]h$]h&]hhuh1j3hjMhhhjMhMgubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjMhhhjMhMgubah}(h]jMah ](jjeh"]h$]h&]jj)jhuh1jhjMhMghjMhhubj)}(hhh]h)}(h4Add a given file to the DRM device debugfs file listh]h4Add a given file to the DRM device debugfs file list}(hjCPhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM^hj@Phhubah}(h]h ]h"]h$]h&]uh1jhjMhhhjMhMgubeh}(h]h ](jfunctioneh"]h$]h&]j jj j[Pjj[Pjjjuh1jhhhj=hNhNubj)}(hX^**Parameters** ``struct drm_device *dev`` drm device for the ioctl ``const char *name`` debugfs file name ``int (*show)(struct seq_file*, void*)`` show callback ``void *data`` driver-private data, should not be device-specific **Description** Add a given file entry to the DRM device debugfs file list to be created on drm_debugfs_init.h](h)}(h**Parameters**h]j)}(hjePh]h Parameters}(hjgPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcPubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMbhj_Pubj1)}(hhh](j6)}(h4``struct drm_device *dev`` drm device for the ioctl h](j<)}(h``struct drm_device *dev``h]j)}(hjPh]hstruct drm_device *dev}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM_hj~PubjV)}(hhh]h)}(hdrm device for the ioctlh]hdrm device for the ioctl}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPhM_hjPubah}(h]h ]h"]h$]h&]uh1jUhj~Pubeh}(h]h ]h"]h$]h&]uh1j5hjPhM_hj{Pubj6)}(h'``const char *name`` debugfs file name h](j<)}(h``const char *name``h]j)}(hjPh]hconst char *name}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM`hjPubjV)}(hhh]h)}(hdebugfs file nameh]hdebugfs file name}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPhM`hjPubah}(h]h ]h"]h$]h&]uh1jUhjPubeh}(h]h ]h"]h$]h&]uh1j5hjPhM`hj{Pubj6)}(h7``int (*show)(struct seq_file*, void*)`` show callback h](j<)}(h(``int (*show)(struct seq_file*, void*)``h]j)}(hjPh]h$int (*show)(struct seq_file*, void*)}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMahjPubjV)}(hhh]h)}(h show callbackh]h show callback}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj QhMahj Qubah}(h]h ]h"]h$]h&]uh1jUhjPubeh}(h]h ]h"]h$]h&]uh1j5hj QhMahj{Pubj6)}(hB``void *data`` driver-private data, should not be device-specific h](j<)}(h``void *data``h]j)}(hj/Qh]h void *data}(hj1QhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-Qubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMbhj)QubjV)}(hhh]h)}(h2driver-private data, should not be device-specifich]h2driver-private data, should not be device-specific}(hjHQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDQhMbhjEQubah}(h]h ]h"]h$]h&]uh1jUhj)Qubeh}(h]h ]h"]h$]h&]uh1j5hjDQhMbhj{Pubeh}(h]h ]h"]h$]h&]uh1j0hj_Pubh)}(h**Description**h]j)}(hjjQh]h Description}(hjlQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhQubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMdhj_Pubh)}(h]Add a given file entry to the DRM device debugfs file list to be created on drm_debugfs_init.h]h]Add a given file entry to the DRM device debugfs file list to be created on drm_debugfs_init.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMdhj_Pubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"drm_debugfs_add_files (C function)c.drm_debugfs_add_fileshNtauh1jhj=hhhNhNubj)}(hhh](j)}(hdvoid drm_debugfs_add_files (struct drm_device *dev, const struct drm_debugfs_info *files, int count)h]j)}(hcvoid drm_debugfs_add_files(struct drm_device *dev, const struct drm_debugfs_info *files, int count)h](j)}(hvoidh]hvoid}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQhhh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMubj)}(h h]h }(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQhhhjQhMubj)}(hdrm_debugfs_add_filesh]j)}(hdrm_debugfs_add_filesh]hdrm_debugfs_add_files}(hjQhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjQubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjQhhhjQhMubj4)}(hI(struct drm_device *dev, const struct drm_debugfs_info *files, int count)h](j:)}(hstruct drm_device *devh](j@)}(hjCh]hstruct}(hjQhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjQubj)}(h h]h }(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubh)}(hhh]j)}(h drm_deviceh]h drm_device}(hj RhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj RmodnameN classnameNj{j~)}j]j)}jwjQsbc.drm_debugfs_add_filesasbuh1hhjQubj)}(h h]h }(hj*RhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubj)}(hjh]h*}(hj8RhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubj)}(hdevh]hdev}(hjERhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjQubj:)}(h$const struct drm_debugfs_info *filesh](j@)}(hjJh]hconst}(hj^RhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjZRubj)}(h h]h }(hjkRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZRubj@)}(hjCh]hstruct}(hjyRhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjZRubj)}(h h]h }(hjRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZRubh)}(hhh]j)}(hdrm_debugfs_infoh]hdrm_debugfs_info}(hjRhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjRmodnameN classnameNj{j~)}j]j&Rc.drm_debugfs_add_filesasbuh1hhjZRubj)}(h h]h }(hjRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZRubj)}(hjh]h*}(hjRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZRubj)}(hfilesh]hfiles}(hjRhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjZRubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjQubj:)}(h int counth](j)}(hinth]hint}(hjRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjRubj)}(h h]h }(hjRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjRubj)}(hcounth]hcount}(hjShhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjRubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjQubeh}(h]h ]h"]h$]h&]hhuh1j3hjQhhhjQhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjQhhhjQhMubah}(h]jQah ](jjeh"]h$]h&]jj)jhuh1jhjQhMhjQhhubj)}(hhh]h)}(h9Add an array of files to the DRM device debugfs file listh]h9Add an array of files to the DRM device debugfs file list}(hj/ShhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMzhj,Shhubah}(h]h ]h"]h$]h&]uh1jhjQhhhjQhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jGSjjGSjjjuh1jhhhj=hNhNubj)}(hXa**Parameters** ``struct drm_device *dev`` drm device for the ioctl ``const struct drm_debugfs_info *files`` The array of files to create ``int count`` The number of files given **Description** Add a given set of debugfs files represented by an array of :c:type:`struct drm_debugfs_info ` in the DRM device debugfs file list.h](h)}(h**Parameters**h]j)}(hjQSh]h Parameters}(hjSShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOSubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM~hjKSubj1)}(hhh](j6)}(h4``struct drm_device *dev`` drm device for the ioctl h](j<)}(h``struct drm_device *dev``h]j)}(hjpSh]hstruct drm_device *dev}(hjrShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnSubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM{hjjSubjV)}(hhh]h)}(hdrm device for the ioctlh]hdrm device for the ioctl}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShM{hjSubah}(h]h ]h"]h$]h&]uh1jUhjjSubeh}(h]h ]h"]h$]h&]uh1j5hjShM{hjgSubj6)}(hF``const struct drm_debugfs_info *files`` The array of files to create h](j<)}(h(``const struct drm_debugfs_info *files``h]j)}(hjSh]h$const struct drm_debugfs_info *files}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM|hjSubjV)}(hhh]h)}(hThe array of files to createh]hThe array of files to create}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShM|hjSubah}(h]h ]h"]h$]h&]uh1jUhjSubeh}(h]h ]h"]h$]h&]uh1j5hjShM|hjgSubj6)}(h(``int count`` The number of files given h](j<)}(h ``int count``h]j)}(hjSh]h int count}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1j;h[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chM}hjSubjV)}(hhh]h)}(hThe number of files givenh]hThe number of files given}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShM}hjSubah}(h]h ]h"]h$]h&]uh1jUhjSubeh}(h]h ]h"]h$]h&]uh1j5hjShM}hjgSubeh}(h]h ]h"]h$]h&]uh1j0hjKSubh)}(h**Description**h]j)}(hjTh]h Description}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMhjKSubh)}(hAdd a given set of debugfs files represented by an array of :c:type:`struct drm_debugfs_info ` in the DRM device debugfs file list.h](h`h]j)}(hj=Th]hstruct drm_debugfs_info}(hj?ThhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj;Tubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_debugfs_infouh1hh[/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:635: ./drivers/gpu/drm/drm_debugfs.chMhj3Tubh% in the DRM device debugfs file list.}(hj3ThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjZThMhjKSubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj=hhhNhNubeh}(h]debugfs-supportah ]h"]debugfs supportah$]h&]uh1hhj7hhhhhMvubeh}(h]testing-and-validationah ]h"]testing and validationah$]h&]uh1hhhhhhhhM4ubh)}(hhh](h)}(h Sysfs Supporth]h Sysfs Support}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|ThhhhhMubh)}(hX.DRM provides very little additional support to drivers for sysfs interactions, beyond just all the standard stuff. Drivers who want to expose additional sysfs properties and property groups can attach them at either :c:type:`drm_device.dev ` or :c:type:`drm_connector.kdev `.h](hDRM provides very little additional support to drivers for sysfs interactions, beyond just all the standard stuff. Drivers who want to expose additional sysfs properties and property groups can attach them at either }(hjThhhNhNubh)}(h%:c:type:`drm_device.dev `h]j)}(hjTh]hdrm_device.dev}(hjThhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_deviceuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:641: ./drivers/gpu/drm/drm_sysfs.chK(hjTubh or }(hjThhhNhNubh)}(h,:c:type:`drm_connector.kdev `h]j)}(hjTh]hdrm_connector.kdev}(hjThhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_connectoruh1hhjThK(hjTubh.}(hjThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjThK(hj|Thhubh)}(hRegistration is automatically handled when calling drm_dev_register(), or drm_connector_register() in case of hot-plugged connectors. Unregistration is also automatically handled by drm_dev_unregister() and drm_connector_unregister().h]hRegistration is automatically handled when calling drm_dev_register(), or drm_connector_register() in case of hot-plugged connectors. Unregistration is also automatically handled by drm_dev_unregister() and drm_connector_unregister().}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:641: ./drivers/gpu/drm/drm_sysfs.chK-hj|Thhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$drm_sysfs_hotplug_event (C function)c.drm_sysfs_hotplug_eventhNtauh1jhj|ThhhNhNubj)}(hhh](j)}(h5void drm_sysfs_hotplug_event (struct drm_device *dev)h]j)}(h4void drm_sysfs_hotplug_event(struct drm_device *dev)h](j)}(hvoidh]hvoid}(hj UhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMubj)}(h h]h }(hjUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUhhhjUhMubj)}(hdrm_sysfs_hotplug_eventh]j)}(hdrm_sysfs_hotplug_eventh]hdrm_sysfs_hotplug_event}(hj+UhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj'Uubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjUhhhjUhMubj4)}(h(struct drm_device *dev)h]j:)}(hstruct drm_device *devh](j@)}(hjCh]hstruct}(hjGUhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjCUubj)}(h h]h }(hjTUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCUubh)}(hhh]j)}(h drm_deviceh]h drm_device}(hjeUhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjbUubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjgUmodnameN classnameNj{j~)}j]j)}jwj-Usbc.drm_sysfs_hotplug_eventasbuh1hhjCUubj)}(h h]h }(hjUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCUubj)}(hjh]h*}(hjUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCUubj)}(hdevh]hdev}(hjUhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjCUubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hj?Uubah}(h]h ]h"]h$]h&]hhuh1j3hjUhhhjUhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjUhhhjUhMubah}(h]jTah ](jjeh"]h$]h&]jj)jhuh1jhjUhMhjThhubj)}(hhh]h)}(hgenerate a DRM ueventh]hgenerate a DRM uevent}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjUhhubah}(h]h ]h"]h$]h&]uh1jhjThhhjUhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jUjjUjjjuh1jhhhj|ThNhNubj)}(hXh**Parameters** ``struct drm_device *dev`` DRM device **Description** Send a uevent for the DRM device specified by **dev**. Currently we only set HOTPLUG=1 in the uevent environment, but this could be expanded to deal with other types of events. Any new uapi should be using the drm_sysfs_connector_status_event() for uevents on connector status change.h](h)}(h**Parameters**h]j)}(hjUh]h Parameters}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjUubj1)}(hhh]j6)}(h&``struct drm_device *dev`` DRM device h](j<)}(h``struct drm_device *dev``h]j)}(hj Vh]hstruct drm_device *dev}(hj VhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj Vubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjVubjV)}(hhh]h)}(h DRM deviceh]h DRM device}(hj$VhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj VhMhj!Vubah}(h]h ]h"]h$]h&]uh1jUhjVubeh}(h]h ]h"]h$]h&]uh1j5hj VhMhjVubah}(h]h ]h"]h$]h&]uh1j0hjUubh)}(h**Description**h]j)}(hjFVh]h Description}(hjHVhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDVubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjUubh)}(hSend a uevent for the DRM device specified by **dev**. Currently we only set HOTPLUG=1 in the uevent environment, but this could be expanded to deal with other types of events.h](h.Send a uevent for the DRM device specified by }(hj\VhhhNhNubj)}(h**dev**h]hdev}(hjdVhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\Vubh|. Currently we only set HOTPLUG=1 in the uevent environment, but this could be expanded to deal with other types of events.}(hj\VhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjUubh)}(hkAny new uapi should be using the drm_sysfs_connector_status_event() for uevents on connector status change.h]hkAny new uapi should be using the drm_sysfs_connector_status_event() for uevents on connector status change.}(hj}VhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjUubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj|ThhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j.drm_sysfs_connector_hotplug_event (C function)#c.drm_sysfs_connector_hotplug_eventhNtauh1jhj|ThhhNhNubj)}(hhh](j)}(hHvoid drm_sysfs_connector_hotplug_event (struct drm_connector *connector)h]j)}(hGvoid drm_sysfs_connector_hotplug_event(struct drm_connector *connector)h](j)}(hvoidh]hvoid}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMubj)}(h h]h }(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVhhhjVhMubj)}(h!drm_sysfs_connector_hotplug_eventh]j)}(h!drm_sysfs_connector_hotplug_eventh]h!drm_sysfs_connector_hotplug_event}(hjVhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjVubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjVhhhjVhMubj4)}(h!(struct drm_connector *connector)h]j:)}(hstruct drm_connector *connectorh](j@)}(hjCh]hstruct}(hjVhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjVubj)}(h h]h }(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubh)}(hhh]j)}(h drm_connectorh]h drm_connector}(hjWhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetj WmodnameN classnameNj{j~)}j]j)}jwjVsb#c.drm_sysfs_connector_hotplug_eventasbuh1hhjVubj)}(h h]h }(hj'WhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubj)}(hjh]h*}(hj5WhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubj)}(h connectorh]h connector}(hjBWhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjVubah}(h]h ]h"]h$]h&]hhuh1j3hjVhhhjVhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjVhhhjVhMubah}(h]jVah ](jjeh"]h$]h&]jj)jhuh1jhjVhMhjVhhubj)}(hhh]h)}(h.generate a DRM uevent for any connector changeh]h.generate a DRM uevent for any connector change}(hjlWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjiWhhubah}(h]h ]h"]h$]h&]uh1jhjVhhhjVhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jWjjWjjjuh1jhhhj|ThNhNubj)}(h**Parameters** ``struct drm_connector *connector`` connector which has changed **Description** Send a uevent for the DRM connector specified by **connector**. This will send a uevent with the properties HOTPLUG=1 and CONNECTOR.h](h)}(h**Parameters**h]j)}(hjWh]h Parameters}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjWubj1)}(hhh]j6)}(h@``struct drm_connector *connector`` connector which has changed h](j<)}(h#``struct drm_connector *connector``h]j)}(hjWh]hstruct drm_connector *connector}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjWubjV)}(hhh]h)}(hconnector which has changedh]hconnector which has changed}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWhMhjWubah}(h]h ]h"]h$]h&]uh1jUhjWubeh}(h]h ]h"]h$]h&]uh1j5hjWhMhjWubah}(h]h ]h"]h$]h&]uh1j0hjWubh)}(h**Description**h]j)}(hjWh]h Description}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjWubh)}(hSend a uevent for the DRM connector specified by **connector**. This will send a uevent with the properties HOTPLUG=1 and CONNECTOR.h](h1Send a uevent for the DRM connector specified by }(hjWhhhNhNubj)}(h **connector**h]h connector}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubhF. This will send a uevent with the properties HOTPLUG=1 and CONNECTOR.}(hjWhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjWubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj|ThhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j/drm_sysfs_connector_property_event (C function)$c.drm_sysfs_connector_property_eventhNtauh1jhj|ThhhNhNubj)}(hhh](j)}(hhvoid drm_sysfs_connector_property_event (struct drm_connector *connector, struct drm_property *property)h]j)}(hgvoid drm_sysfs_connector_property_event(struct drm_connector *connector, struct drm_property *property)h](j)}(hvoidh]hvoid}(hj?XhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;XhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMubj)}(h h]h }(hjNXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;XhhhjMXhMubj)}(h"drm_sysfs_connector_property_eventh]j)}(h"drm_sysfs_connector_property_eventh]h"drm_sysfs_connector_property_event}(hj`XhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj\Xubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj;XhhhjMXhMubj4)}(h@(struct drm_connector *connector, struct drm_property *property)h](j:)}(hstruct drm_connector *connectorh](j@)}(hjCh]hstruct}(hj|XhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjxXubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxXubh)}(hhh]j)}(h drm_connectorh]h drm_connector}(hjXhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjXmodnameN classnameNj{j~)}j]j)}jwjbXsb$c.drm_sysfs_connector_property_eventasbuh1hhjxXubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxXubj)}(hjh]h*}(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxXubj)}(h connectorh]h connector}(hjXhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjxXubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjtXubj:)}(hstruct drm_property *propertyh](j@)}(hjCh]hstruct}(hjXhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjXubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubh)}(hhh]j)}(h drm_propertyh]h drm_property}(hj YhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj Yubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjYmodnameN classnameNj{j~)}j]jX$c.drm_sysfs_connector_property_eventasbuh1hhjXubj)}(h h]h }(hj*YhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubj)}(hjh]h*}(hj8YhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubj)}(hpropertyh]hproperty}(hjEYhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjXubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjtXubeh}(h]h ]h"]h$]h&]hhuh1j3hj;XhhhjMXhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj7XhhhjMXhMubah}(h]j2Xah ](jjeh"]h$]h&]jj)jhuh1jhjMXhMhj4Xhhubj)}(hhh]h)}(h3generate a DRM uevent for connector property changeh]h3generate a DRM uevent for connector property change}(hjoYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjlYhhubah}(h]h ]h"]h$]h&]uh1jhj4XhhhjMXhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jYjjYjjjuh1jhhhj|ThNhNubj)}(hXZ**Parameters** ``struct drm_connector *connector`` connector on which property changed ``struct drm_property *property`` connector property which has changed. **Description** Send a uevent for the specified DRM connector and property. Currently we set HOTPLUG=1 and connector id along with the attached property id related to the change.h](h)}(h**Parameters**h]j)}(hjYh]h Parameters}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjYubj1)}(hhh](j6)}(hH``struct drm_connector *connector`` connector on which property changed h](j<)}(h#``struct drm_connector *connector``h]j)}(hjYh]hstruct drm_connector *connector}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjYubjV)}(hhh]h)}(h#connector on which property changedh]h#connector on which property changed}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYhMhjYubah}(h]h ]h"]h$]h&]uh1jUhjYubeh}(h]h ]h"]h$]h&]uh1j5hjYhMhjYubj6)}(hH``struct drm_property *property`` connector property which has changed. h](j<)}(h!``struct drm_property *property``h]j)}(hjYh]hstruct drm_property *property}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjYubjV)}(hhh]h)}(h%connector property which has changed.h]h%connector property which has changed.}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYhMhjYubah}(h]h ]h"]h$]h&]uh1jUhjYubeh}(h]h ]h"]h$]h&]uh1j5hjYhMhjYubeh}(h]h ]h"]h$]h&]uh1j0hjYubh)}(h**Description**h]j)}(hj$Zh]h Description}(hj&ZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"Zubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjYubh)}(hSend a uevent for the specified DRM connector and property. Currently we set HOTPLUG=1 and connector id along with the attached property id related to the change.h]hSend a uevent for the specified DRM connector and property. Currently we set HOTPLUG=1 and connector id along with the attached property id related to the change.}(hj:ZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMhjYubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj|ThhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&drm_class_device_register (C function)c.drm_class_device_registerhNtauh1jhj|ThhhNhNubj)}(hhh](j)}(h2int drm_class_device_register (struct device *dev)h]j)}(h1int drm_class_device_register(struct device *dev)h](j)}(hinth]hint}(hjiZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeZhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM0ubj)}(h h]h }(hjxZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeZhhhjwZhM0ubj)}(hdrm_class_device_registerh]j)}(hdrm_class_device_registerh]hdrm_class_device_register}(hjZhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjZubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjeZhhhjwZhM0ubj4)}(h(struct device *dev)h]j:)}(hstruct device *devh](j@)}(hjCh]hstruct}(hjZhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjZubj)}(h h]h }(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubh)}(hhh]j)}(hdeviceh]hdevice}(hjZhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjZmodnameN classnameNj{j~)}j]j)}jwjZsbc.drm_class_device_registerasbuh1hhjZubj)}(h h]h }(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubj)}(hjh]h*}(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubj)}(hdevh]hdev}(hjZhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjZubah}(h]h ]h"]h$]h&]hhuh1j3hjeZhhhjwZhM0ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjaZhhhjwZhM0ubah}(h]j\Zah ](jjeh"]h$]h&]jj)jhuh1jhjwZhM0hj^Zhhubj)}(hhh]h)}(h,register new device with the DRM sysfs classh]h,register new device with the DRM sysfs class}(hj)[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM)hj&[hhubah}(h]h ]h"]h$]h&]uh1jhj^ZhhhjwZhM0ubeh}(h]h ](jfunctioneh"]h$]h&]j jj jA[jjA[jjjuh1jhhhj|ThNhNubj)}(h**Parameters** ``struct device *dev`` device to register **Description** Registers a new :c:type:`struct device ` within the DRM sysfs class. Essentially only used by ttm to have a place for its global settings. Drivers should never use this.h](h)}(h**Parameters**h]j)}(hjK[h]h Parameters}(hjM[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjI[ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM-hjE[ubj1)}(hhh]j6)}(h*``struct device *dev`` device to register h](j<)}(h``struct device *dev``h]j)}(hjj[h]hstruct device *dev}(hjl[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjh[ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM*hjd[ubjV)}(hhh]h)}(hdevice to registerh]hdevice to register}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[hM*hj[ubah}(h]h ]h"]h$]h&]uh1jUhjd[ubeh}(h]h ]h"]h$]h&]uh1j5hj[hM*hja[ubah}(h]h ]h"]h$]h&]uh1j0hjE[ubh)}(h**Description**h]j)}(hj[h]h Description}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM,hjE[ubh)}(hRegisters a new :c:type:`struct device ` within the DRM sysfs class. Essentially only used by ttm to have a place for its global settings. Drivers should never use this.h](hRegisters a new }(hj[hhhNhNubh)}(h :c:type:`struct device `h]j)}(hj[h]h struct device}(hj[hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdeviceuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM,hj[ubh within the DRM sysfs class. Essentially only used by ttm to have a place for its global settings. Drivers should never use this.}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj[hM,hjE[ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj|ThhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(drm_class_device_unregister (C function)c.drm_class_device_unregisterhNtauh1jhj|ThhhNhNubj)}(hhh](j)}(h5void drm_class_device_unregister (struct device *dev)h]j)}(h4void drm_class_device_unregister(struct device *dev)h](j)}(hvoidh]hvoid}(hj \hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj \hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chMBubj)}(h h]h }(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj \hhhj\hMBubj)}(hdrm_class_device_unregisterh]j)}(hdrm_class_device_unregisterh]hdrm_class_device_unregister}(hj.\hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj*\ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj \hhhj\hMBubj4)}(h(struct device *dev)h]j:)}(hstruct device *devh](j@)}(hjCh]hstruct}(hjJ\hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjF\ubj)}(h h]h }(hjW\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjF\ubh)}(hhh]j)}(hdeviceh]hdevice}(hjh\hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhje\ubah}(h]h ]h"]h$]h&] refdomainjreftypejw reftargetjj\modnameN classnameNj{j~)}j]j)}jwj0\sbc.drm_class_device_unregisterasbuh1hhjF\ubj)}(h h]h }(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjF\ubj)}(hjh]h*}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjF\ubj)}(hdevh]hdev}(hj\hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjF\ubeh}(h]h ]h"]h$]h&]noemphhhuh1j9hjB\ubah}(h]h ]h"]h$]h&]hhuh1j3hj \hhhj\hMBubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj\hhhj\hMBubah}(h]j\ah ](jjeh"]h$]h&]jj)jhuh1jhj\hMBhj\hhubj)}(hhh]h)}(h*unregister device with the DRM sysfs classh]h*unregister device with the DRM sysfs class}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM;hj\hhubah}(h]h ]h"]h$]h&]uh1jhj\hhhj\hMBubeh}(h]h ](jfunctioneh"]h$]h&]j jj j\jj\jjjuh1jhhhj|ThNhNubj)}(h**Parameters** ``struct device *dev`` device to unregister **Description** Unregisters a :c:type:`struct device ` from the DRM sysfs class. Essentially only used by ttm to have a place for its global settings. Drivers should never use this.h](h)}(h**Parameters**h]j)}(hj\h]h Parameters}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM?hj\ubj1)}(hhh]j6)}(h,``struct device *dev`` device to unregister h](j<)}(h``struct device *dev``h]j)}(hj]h]hstruct device *dev}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ]ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM<hj]ubjV)}(hhh]h)}(hdevice to unregisterh]hdevice to unregister}(hj']hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#]hM<hj$]ubah}(h]h ]h"]h$]h&]uh1jUhj]ubeh}(h]h ]h"]h$]h&]uh1j5hj#]hM<hj]ubah}(h]h ]h"]h$]h&]uh1j0hj\ubh)}(h**Description**h]j)}(hjI]h]h Description}(hjK]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjG]ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM>hj\ubh)}(hUnregisters a :c:type:`struct device ` from the DRM sysfs class. Essentially only used by ttm to have a place for its global settings. Drivers should never use this.h](hUnregisters a }(hj_]hhhNhNubh)}(h :c:type:`struct device `h]j)}(hji]h]h struct device}(hjk]hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjg]ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdeviceuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:644: ./drivers/gpu/drm/drm_sysfs.chM>hj_]ubh from the DRM sysfs class. Essentially only used by ttm to have a place for its global settings. Drivers should never use this.}(hj_]hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj]hM>hj\ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj|ThhhNhNubeh}(h] sysfs-supportah ]h"] sysfs supportah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hVBlank event handlingh]hVBlank event handling}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]hhhhhMubh)}(h7The DRM core exposes two vertical blank related ioctls:h]h7The DRM core exposes two vertical blank related ioctls:}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj]hhubj1)}(hhh](j6)}(h:c:macro:`DRM_IOCTL_WAIT_VBLANK` This takes a struct drm_wait_vblank structure as its argument, and it is used to block or request a signal when a specified vblank event occurs. h](j<)}(h :c:macro:`DRM_IOCTL_WAIT_VBLANK`h]h)}(hj]h]j)}(hj]h]hDRM_IOCTL_WAIT_VBLANK}(hj]hhhNhNubah}(h]h ](jjc-macroeh"]h$]h&]uh1jhj]ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypemacro refexplicitrefwarnj{jXjDRM_IOCTL_WAIT_VBLANKuh1hhhhMhj]ubah}(h]h ]h"]h$]h&]uh1j;hhhMhj]ubjV)}(hhh]h)}(hThis takes a struct drm_wait_vblank structure as its argument, and it is used to block or request a signal when a specified vblank event occurs.h]hThis takes a struct drm_wait_vblank structure as its argument, and it is used to block or request a signal when a specified vblank event occurs.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj]ubah}(h]h ]h"]h$]h&]uh1jUhj]ubeh}(h]h ]h"]h$]h&]uh1j5hhhMhj]ubj6)}(hXl:c:macro:`DRM_IOCTL_MODESET_CTL` This was only used for user-mode-settind drivers around modesetting changes to allow the kernel to update the vblank interrupt after mode setting, since on many devices the vertical blank counter is reset to 0 at some point during modeset. Modern drivers should not call this any more since with kernel mode setting it is a no-op. h](j<)}(h :c:macro:`DRM_IOCTL_MODESET_CTL`h]h)}(hj^h]j)}(hj^h]hDRM_IOCTL_MODESET_CTL}(hj^hhhNhNubah}(h]h ](jjc-macroeh"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypemacro refexplicitrefwarnj{jXjDRM_IOCTL_MODESET_CTLuh1hhhhMhj^ubah}(h]h ]h"]h$]h&]uh1j;hhhMhj ^ubjV)}(hhh]h)}(hXJThis was only used for user-mode-settind drivers around modesetting changes to allow the kernel to update the vblank interrupt after mode setting, since on many devices the vertical blank counter is reset to 0 at some point during modeset. Modern drivers should not call this any more since with kernel mode setting it is a no-op.h]hXJThis was only used for user-mode-settind drivers around modesetting changes to allow the kernel to update the vblank interrupt after mode setting, since on many devices the vertical blank counter is reset to 0 at some point during modeset. Modern drivers should not call this any more since with kernel mode setting it is a no-op.}(hj:^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj7^ubah}(h]h ]h"]h$]h&]uh1jUhj ^ubeh}(h]h ]h"]h$]h&]uh1j5hhhMhj]hhubeh}(h]h ]h"]h$]h&]uh1j0hj]hhhhhNubeh}(h]vblank-event-handlingah ]h"]vblank event handlingah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hUserspace API Structuresh]hUserspace API Structures}(hje^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjb^hhhhhMubh)}(hDRM exposes many UAPI and structure definitions to have a consistent and standardized interface with users. Userspace can refer to these structure definitions and UAPI formats to communicate to drivers.h]hDRM exposes many UAPI and structure definitions to have a consistent and standardized interface with users. Userspace can refer to these structure definitions and UAPI formats to communicate to drivers.}(hjs^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:668: ./include/uapi/drm/drm_mode.hhK%hjb^hhubj)}(h.. _crtc_index:h]h}(h]h ]h"]h$]h&]j crtc-indexuh1jhMhjb^hhhhubh)}(hhh](h)}(h CRTC indexh]h CRTC index}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^hhhhhMubh)}(hXCRTC'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.h]hX 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.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj^hhubh)}(h:c:macro:`DRM_IOCTL_MODE_GETRESOURCES` populates a structure with an array of CRTC ID's, and the CRTC index is its position in this array.h](h)}(h&:c:macro:`DRM_IOCTL_MODE_GETRESOURCES`h]j)}(hj^h]hDRM_IOCTL_MODE_GETRESOURCES}(hj^hhhNhNubah}(h]h ](jjc-macroeh"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypemacro refexplicitrefwarnj{jXjDRM_IOCTL_MODE_GETRESOURCESuh1hhhhMhj^ubhf populates a structure with an array of CRTC ID’s, and the CRTC index is its position in this array.}(hj^hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_CAP_DUMB_BUFFER (C macro)c.DRM_CAP_DUMB_BUFFERhNtauh1jhj^hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhNubj)}(hhh](j)}(hDRM_CAP_DUMB_BUFFERh]j)}(hDRM_CAP_DUMB_BUFFERh]j)}(hDRM_CAP_DUMB_BUFFERh]j)}(hj^h]hDRM_CAP_DUMB_BUFFER}(hj^hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj^ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj^hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMzubah}(h]h ]h"]h$]h&]hhjuh1jjjhj^hhhj _hMzubah}(h]j^ah ](jjeh"]h$]h&]jj)jhuh1jhj _hMzhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj^hhhj _hMzubeh}(h]h ](jmacroeh"]h$]h&]j jj j#_jj#_jjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_DUMB_BUFFER``h]j)}(hj)_h]hDRM_CAP_DUMB_BUFFER}(hj+_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'_ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM|hj^hhubj%)}(h}**Description** If set to 1, the driver supports creating dumb buffers via the :c:type:`DRM_IOCTL_MODE_CREATE_DUMB` ioctl. h](h)}(h**Description**h]j)}(hjE_h]h Description}(hjG_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjC_ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMvhj?_ubh)}(hjIf set to 1, the driver supports creating dumb buffers via the :c:type:`DRM_IOCTL_MODE_CREATE_DUMB` ioctl.h](h?If set to 1, the driver supports creating dumb buffers via the }(hj[_hhhNhNubh)}(h$:c:type:`DRM_IOCTL_MODE_CREATE_DUMB`h]j)}(hje_h]hDRM_IOCTL_MODE_CREATE_DUMB}(hjg_hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjc_ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_CREATE_DUMBuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMvhj[_ubh ioctl.}(hj[_hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj_hMvhj?_ubeh}(h]h ]h"]h$]h&]uh1j$hjZ_hMvhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"DRM_CAP_VBLANK_HIGH_CRTC (C macro)c.DRM_CAP_VBLANK_HIGH_CRTChNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_VBLANK_HIGH_CRTCh]j)}(hDRM_CAP_VBLANK_HIGH_CRTCh]j)}(hDRM_CAP_VBLANK_HIGH_CRTCh]j)}(hj_h]hDRM_CAP_VBLANK_HIGH_CRTC}(hj_hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj_ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj_hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhj_hhhj_hMubah}(h]j_ah ](jjeh"]h$]h&]jj)jhuh1jhj_hMhj_hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj_hhhj_hMubeh}(h]h ](jmacroeh"]h$]h&]j jj j_jj_jjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_VBLANK_HIGH_CRTC``h]j)}(hj_h]hDRM_CAP_VBLANK_HIGH_CRTC}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(h**Description** If set to 1, the kernel supports specifying a :ref:`CRTC index` in the high bits of :c:type:`drm_wait_vblank_request.type `. Starting kernel version 2.6.39, this capability is always set to 1. h](h)}(h**Description**h]j)}(hj_h]h Description}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM}hj_ubh)}(hIf set to 1, the kernel supports specifying a :ref:`CRTC index` in the high bits of :c:type:`drm_wait_vblank_request.type `.h](h.If set to 1, the kernel supports specifying a }(hj`hhhNhNubh)}(h:ref:`CRTC index`h]j<)}(hj`h]h CRTC index}(hj `hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hj`ubah}(h]h ]h"]h$]h&]refdocj refdomainj*`reftyperef refexplicitrefwarnj crtc_indexuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM}hj`ubh in the high bits of }(hj`hhhNhNubh)}(h@:c:type:`drm_wait_vblank_request.type `h]j)}(hjC`h]hdrm_wait_vblank_request.type}(hjE`hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjA`ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_wait_vblank_requestuh1hhj<`hM}hj`ubh.}(hj`hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj<`hM}hj_ubh)}(hCStarting kernel version 2.6.39, this capability is always set to 1.h]hCStarting kernel version 2.6.39, this capability is always set to 1.}(hjj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj_ubeh}(h]h ]h"]h$]h&]uh1j$hj`hM}hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&DRM_CAP_DUMB_PREFERRED_DEPTH (C macro)c.DRM_CAP_DUMB_PREFERRED_DEPTHhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_DUMB_PREFERRED_DEPTHh]j)}(hDRM_CAP_DUMB_PREFERRED_DEPTHh]j)}(hDRM_CAP_DUMB_PREFERRED_DEPTHh]j)}(hj`h]hDRM_CAP_DUMB_PREFERRED_DEPTH}(hj`hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj`ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj`hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhj`hhhj`hMubah}(h]j`ah ](jjeh"]h$]h&]jj)jhuh1jhj`hMhj`hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj`hhhj`hMubeh}(h]h ](jmacroeh"]h$]h&]j jj j`jj`jjjuh1jhhhj^hj^hNubh)}(h ``DRM_CAP_DUMB_PREFERRED_DEPTH``h]j)}(hj`h]hDRM_CAP_DUMB_PREFERRED_DEPTH}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hX**Description** The preferred bit depth for dumb buffers. The bit depth is the number of bits used to indicate the color of a single pixel excluding any padding. This is different from the number of bits per pixel. For instance, XRGB8888 has a bit depth of 24 but has 32 bits per pixel. Note that this preference only applies to dumb buffers, it's irrelevant for other types of buffers. h](h)}(h**Description**h]j)}(hj`h]h Description}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj`ubh)}(h)The preferred bit depth for dumb buffers.h]h)The preferred bit depth for dumb buffers.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj`ubh)}(hThe bit depth is the number of bits used to indicate the color of a single pixel excluding any padding. This is different from the number of bits per pixel. For instance, XRGB8888 has a bit depth of 24 but has 32 bits per pixel.h]hThe bit depth is the number of bits used to indicate the color of a single pixel excluding any padding. This is different from the number of bits per pixel. For instance, XRGB8888 has a bit depth of 24 but has 32 bits per pixel.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj`ubh)}(hcNote that this preference only applies to dumb buffers, it's irrelevant for other types of buffers.h]heNote that this preference only applies to dumb buffers, it’s irrelevant for other types of buffers.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj`ubeh}(h]h ]h"]h$]h&]uh1j$hj`hMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$DRM_CAP_DUMB_PREFER_SHADOW (C macro)c.DRM_CAP_DUMB_PREFER_SHADOWhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_DUMB_PREFER_SHADOWh]j)}(hDRM_CAP_DUMB_PREFER_SHADOWh]j)}(hDRM_CAP_DUMB_PREFER_SHADOWh]j)}(hjFah]hDRM_CAP_DUMB_PREFER_SHADOW}(hjPahhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjLaubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjHahhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjDahhhjcahMubah}(h]j?aah ](jjeh"]h$]h&]jj)jhuh1jhjcahMhjAahhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjAahhhjcahMubeh}(h]h ](jmacroeh"]h$]h&]j jj j|ajj|ajjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_DUMB_PREFER_SHADOW``h]j)}(hjah]hDRM_CAP_DUMB_PREFER_SHADOW}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hX_**Description** If set to 1, the driver prefers userspace to render to a shadow buffer instead of directly rendering to a dumb buffer. For best speed, userspace should do streaming ordered memory copies into the dumb buffer and never read from it. Note that this preference only applies to dumb buffers, it's irrelevant for other types of buffers. h](h)}(h**Description**h]j)}(hjah]h Description}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjaubh)}(hIf set to 1, the driver prefers userspace to render to a shadow buffer instead of directly rendering to a dumb buffer. For best speed, userspace should do streaming ordered memory copies into the dumb buffer and never read from it.h]hIf set to 1, the driver prefers userspace to render to a shadow buffer instead of directly rendering to a dumb buffer. For best speed, userspace should do streaming ordered memory copies into the dumb buffer and never read from it.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjaubh)}(hcNote that this preference only applies to dumb buffers, it's irrelevant for other types of buffers.h]heNote that this preference only applies to dumb buffers, it’s irrelevant for other types of buffers.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjaubeh}(h]h ]h"]h$]h&]uh1j$hjahMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_CAP_PRIME (C macro)c.DRM_CAP_PRIMEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(h DRM_CAP_PRIMEh]j)}(h DRM_CAP_PRIMEh]j)}(h DRM_CAP_PRIMEh]j)}(hjah]h DRM_CAP_PRIME}(hjahhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjaubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjahhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjahhhjbhMubah}(h]jaah ](jjeh"]h$]h&]jj)jhuh1jhjbhMhjahhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjahhhjbhMubeh}(h]h ](jmacroeh"]h$]h&]j jj j!bjj!bjjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_PRIME``h]j)}(hj'bh]h DRM_CAP_PRIME}(hj)bhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%bubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hXe**Description** Bitfield of supported PRIME sharing capabilities. See :c:type:`DRM_PRIME_CAP_IMPORT` and :c:type:`DRM_PRIME_CAP_EXPORT`. Starting from kernel version 6.6, both :c:type:`DRM_PRIME_CAP_IMPORT` and :c:type:`DRM_PRIME_CAP_EXPORT` are always advertised. PRIME buffers are exposed as dma-buf file descriptors. See :ref:`prime_buffer_sharing`. h](h)}(h**Description**h]j)}(hjCbh]h Description}(hjEbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAbubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj=bubh)}(hxBitfield of supported PRIME sharing capabilities. See :c:type:`DRM_PRIME_CAP_IMPORT` and :c:type:`DRM_PRIME_CAP_EXPORT`.h](h6Bitfield of supported PRIME sharing capabilities. See }(hjYbhhhNhNubh)}(h:c:type:`DRM_PRIME_CAP_IMPORT`h]j)}(hjcbh]hDRM_PRIME_CAP_IMPORT}(hjebhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjabubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_PRIME_CAP_IMPORTuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjYbubh and }(hjYbhhhNhNubh)}(h:c:type:`DRM_PRIME_CAP_EXPORT`h]j)}(hjbh]hDRM_PRIME_CAP_EXPORT}(hjbhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_PRIME_CAP_EXPORTuh1hhjbhMhjYbubh.}(hjYbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjbhMhj=bubh)}(hStarting from kernel version 6.6, both :c:type:`DRM_PRIME_CAP_IMPORT` and :c:type:`DRM_PRIME_CAP_EXPORT` are always advertised.h](h'Starting from kernel version 6.6, both }(hjbhhhNhNubh)}(h:c:type:`DRM_PRIME_CAP_IMPORT`h]j)}(hjbh]hDRM_PRIME_CAP_IMPORT}(hjbhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_PRIME_CAP_IMPORTuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjbubh and }(hjbhhhNhNubh)}(h:c:type:`DRM_PRIME_CAP_EXPORT`h]j)}(hjbh]hDRM_PRIME_CAP_EXPORT}(hjbhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_PRIME_CAP_EXPORTuh1hhjbhMhjbubh are always advertised.}(hjbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjbhMhj=bubh)}(hWPRIME buffers are exposed as dma-buf file descriptors. See :ref:`prime_buffer_sharing`.h](h;PRIME buffers are exposed as dma-buf file descriptors. See }(hjchhhNhNubh)}(h:ref:`prime_buffer_sharing`h]j<)}(hj ch]hprime_buffer_sharing}(hjchhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hj cubah}(h]h ]h"]h$]h&]refdocj refdomainjcreftyperef refexplicitrefwarnjprime_buffer_sharinguh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjcubh.}(hjchhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj+chMhj=bubeh}(h]h ]h"]h$]h&]uh1j$hjXbhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_PRIME_CAP_IMPORT (C macro)c.DRM_PRIME_CAP_IMPORThNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_PRIME_CAP_IMPORTh]j)}(hDRM_PRIME_CAP_IMPORTh]j)}(hDRM_PRIME_CAP_IMPORTh]j)}(hjOch]hDRM_PRIME_CAP_IMPORT}(hjYchhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjUcubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjQchhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjMchhhjlchMubah}(h]jHcah ](jjeh"]h$]h&]jj)jhuh1jhjlchMhjJchhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjJchhhjlchMubeh}(h]h ](jmacroeh"]h$]h&]j jj jcjjcjjjuh1jhhhj^hj^hNubh)}(h``DRM_PRIME_CAP_IMPORT``h]j)}(hjch]hDRM_PRIME_CAP_IMPORT}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(h**Description** If this bit is set in :c:type:`DRM_CAP_PRIME`, the driver supports importing PRIME buffers via the :c:type:`DRM_IOCTL_PRIME_FD_TO_HANDLE` ioctl. Starting from kernel version 6.6, this bit is always set in :c:type:`DRM_CAP_PRIME`. h](h)}(h**Description**h]j)}(hjch]h Description}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjcubh)}(hIf this bit is set in :c:type:`DRM_CAP_PRIME`, the driver supports importing PRIME buffers via the :c:type:`DRM_IOCTL_PRIME_FD_TO_HANDLE` ioctl.h](hIf this bit is set in }(hjchhhNhNubh)}(h:c:type:`DRM_CAP_PRIME`h]j)}(hjch]h DRM_CAP_PRIME}(hjchhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj DRM_CAP_PRIMEuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjcubh6, the driver supports importing PRIME buffers via the }(hjchhhNhNubh)}(h&:c:type:`DRM_IOCTL_PRIME_FD_TO_HANDLE`h]j)}(hjch]hDRM_IOCTL_PRIME_FD_TO_HANDLE}(hjchhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_PRIME_FD_TO_HANDLEuh1hhjchMhjcubh ioctl.}(hjchhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjchMhjcubh)}(hTStarting from kernel version 6.6, this bit is always set in :c:type:`DRM_CAP_PRIME`.h](hhubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CAP_CURSOR_WIDTHuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj6hubh.}(hj6hhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj]hhMhjhubeh}(h]h ]h"]h$]h&]uh1j$hj5hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"DRM_CAP_ADDFB2_MODIFIERS (C macro)c.DRM_CAP_ADDFB2_MODIFIERShNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_ADDFB2_MODIFIERSh]j)}(hDRM_CAP_ADDFB2_MODIFIERSh]j)}(hDRM_CAP_ADDFB2_MODIFIERSh]j)}(hjhh]hDRM_CAP_ADDFB2_MODIFIERS}(hjhhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjhubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhhjhhMubah}(h]jzhah ](jjeh"]h$]h&]jj)jhuh1jhjhhMhj|hhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj|hhhhjhhMubeh}(h]h ](jmacroeh"]h$]h&]j jj jhjjhjjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_ADDFB2_MODIFIERS``h]j)}(hjhh]hDRM_CAP_ADDFB2_MODIFIERS}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hu**Description** If set to 1, the driver supports supplying modifiers in the :c:type:`DRM_IOCTL_MODE_ADDFB2` ioctl. h](h)}(h**Description**h]j)}(hjhh]h Description}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjhubh)}(hbIf set to 1, the driver supports supplying modifiers in the :c:type:`DRM_IOCTL_MODE_ADDFB2` ioctl.h](h` for the :c:type:`DRM_IOCTL_MODE_PAGE_FLIP` ioctl. h](h)}(h**Description**h]j)}(hjih]h Description}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjiubh)}(hX If set to 1, the driver supports the :c:type:`DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE` and :c:type:`DRM_MODE_PAGE_FLIP_TARGET_RELATIVE` flags in :c:type:`drm_mode_crtc_page_flip_target.flags ` for the :c:type:`DRM_IOCTL_MODE_PAGE_FLIP` ioctl.h](h%If set to 1, the driver supports the }(hjihhhNhNubh)}(h,:c:type:`DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE`h]j)}(hjih]h"DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE}(hjihhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj"DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTEuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjiubh and }(hjihhhNhNubh)}(h,:c:type:`DRM_MODE_PAGE_FLIP_TARGET_RELATIVE`h]j)}(hjih]h"DRM_MODE_PAGE_FLIP_TARGET_RELATIVE}(hjihhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj"DRM_MODE_PAGE_FLIP_TARGET_RELATIVEuh1hhjihMhjiubh flags in }(hjihhhNhNubh)}(hO:c:type:`drm_mode_crtc_page_flip_target.flags `h]j)}(hjih]h$drm_mode_crtc_page_flip_target.flags}(hjihhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_crtc_page_flip_targetuh1hhjihMhjiubh for the }(hjihhhNhNubh)}(h":c:type:`DRM_IOCTL_MODE_PAGE_FLIP`h]j)}(hjjh]hDRM_IOCTL_MODE_PAGE_FLIP}(hjjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_PAGE_FLIPuh1hhjihMhjiubh ioctl.}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjihMhjiubeh}(h]h ]h"]h$]h&]uh1j$hjihMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&DRM_CAP_CRTC_IN_VBLANK_EVENT (C macro)c.DRM_CAP_CRTC_IN_VBLANK_EVENThNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_CRTC_IN_VBLANK_EVENTh]j)}(hDRM_CAP_CRTC_IN_VBLANK_EVENTh]j)}(hDRM_CAP_CRTC_IN_VBLANK_EVENTh]j)}(hj\jh]hDRM_CAP_CRTC_IN_VBLANK_EVENT}(hjfjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjbjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj^jhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjZjhhhjyjhMubah}(h]jUjah ](jjeh"]h$]h&]jj)jhuh1jhjyjhMhjWjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjWjhhhjyjhMubeh}(h]h ](jmacroeh"]h$]h&]j jj jjjjjjjjuh1jhhhj^hj^hNubh)}(h ``DRM_CAP_CRTC_IN_VBLANK_EVENT``h]j)}(hjjh]hDRM_CAP_CRTC_IN_VBLANK_EVENT}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hX**Description** If set to 1, the kernel supports reporting the CRTC ID in :c:type:`drm_event_vblank.crtc_id ` for the :c:type:`DRM_EVENT_VBLANK` and :c:type:`DRM_EVENT_FLIP_COMPLETE` events. Starting kernel version 4.12, this capability is always set to 1. h](h)}(h**Description**h]j)}(hjjh]h Description}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjjubh)}(hIf set to 1, the kernel supports reporting the CRTC ID in :c:type:`drm_event_vblank.crtc_id ` for the :c:type:`DRM_EVENT_VBLANK` and :c:type:`DRM_EVENT_FLIP_COMPLETE` events.h](h:If set to 1, the kernel supports reporting the CRTC ID in }(hjjhhhNhNubh)}(h5:c:type:`drm_event_vblank.crtc_id `h]j)}(hjjh]hdrm_event_vblank.crtc_id}(hjjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_event_vblankuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjjubh for the }(hjjhhhNhNubh)}(h:c:type:`DRM_EVENT_VBLANK`h]j)}(hjjh]hDRM_EVENT_VBLANK}(hjjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_EVENT_VBLANKuh1hhjjhMhjjubh and }(hjjhhhNhNubh)}(h!:c:type:`DRM_EVENT_FLIP_COMPLETE`h]j)}(hjkh]hDRM_EVENT_FLIP_COMPLETE}(hjkhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_EVENT_FLIP_COMPLETEuh1hhjjhMhjjubh events.}(hjjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjjhMhjjubh)}(hAStarting kernel version 4.12, this capability is always set to 1.h]hAStarting kernel version 4.12, this capability is always set to 1.}(hjBkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjjubeh}(h]h ]h"]h$]h&]uh1j$hjjhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_CAP_SYNCOBJ (C macro)c.DRM_CAP_SYNCOBJhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_SYNCOBJh]j)}(hDRM_CAP_SYNCOBJh]j)}(hDRM_CAP_SYNCOBJh]j)}(hjjkh]hDRM_CAP_SYNCOBJ}(hjtkhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjpkubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjlkhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjhkhhhjkhMubah}(h]jckah ](jjeh"]h$]h&]jj)jhuh1jhjkhMhjekhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjekhhhjkhMubeh}(h]h ](jmacroeh"]h$]h&]j jj jkjjkjjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_SYNCOBJ``h]j)}(hjkh]hDRM_CAP_SYNCOBJ}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(h^**Description** If set to 1, the driver supports sync objects. See :ref:`drm_sync_objects`. h](h)}(h**Description**h]j)}(hjkh]h Description}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjkubh)}(hKIf set to 1, the driver supports sync objects. See :ref:`drm_sync_objects`.h](h3If set to 1, the driver supports sync objects. See }(hjkhhhNhNubh)}(h:ref:`drm_sync_objects`h]j<)}(hjkh]hdrm_sync_objects}(hjkhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hjkubah}(h]h ]h"]h$]h&]refdocj refdomainjkreftyperef refexplicitrefwarnjdrm_sync_objectsuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjkubh.}(hjkhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjlhMhjkubeh}(h]h ]h"]h$]h&]uh1j$hjkhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"DRM_CAP_SYNCOBJ_TIMELINE (C macro)c.DRM_CAP_SYNCOBJ_TIMELINEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_SYNCOBJ_TIMELINEh]j)}(hDRM_CAP_SYNCOBJ_TIMELINEh]j)}(hDRM_CAP_SYNCOBJ_TIMELINEh]j)}(hj$lh]hDRM_CAP_SYNCOBJ_TIMELINE}(hj.lhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj*lubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj&lhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhj"lhhhjAlhMubah}(h]jlah ](jjeh"]h$]h&]jj)jhuh1jhjAlhMhjlhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjlhhhjAlhMubeh}(h]h ](jmacroeh"]h$]h&]j jj jZljjZljjjuh1jhhhj^hj^hNubh)}(h``DRM_CAP_SYNCOBJ_TIMELINE``h]j)}(hj`lh]hDRM_CAP_SYNCOBJ_TIMELINE}(hjblhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^lubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM hj^hhubj%)}(hu**Description** If set to 1, the driver supports timeline operations on sync objects. See :ref:`drm_sync_objects`. h](h)}(h**Description**h]j)}(hj|lh]h Description}(hj~lhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzlubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjvlubh)}(hbIf set to 1, the driver supports timeline operations on sync objects. See :ref:`drm_sync_objects`.h](hJIf set to 1, the driver supports timeline operations on sync objects. See }(hjlhhhNhNubh)}(h:ref:`drm_sync_objects`h]j<)}(hjlh]hdrm_sync_objects}(hjlhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hjlubah}(h]h ]h"]h$]h&]refdocj refdomainjlreftyperef refexplicitrefwarnjdrm_sync_objectsuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjlubh.}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjlhMhjvlubeh}(h]h ]h"]h$]h&]uh1j$hjlhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(DRM_CAP_ATOMIC_ASYNC_PAGE_FLIP (C macro) c.DRM_CAP_ATOMIC_ASYNC_PAGE_FLIPhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CAP_ATOMIC_ASYNC_PAGE_FLIPh]j)}(hDRM_CAP_ATOMIC_ASYNC_PAGE_FLIPh]j)}(hDRM_CAP_ATOMIC_ASYNC_PAGE_FLIPh]j)}(hjlh]hDRM_CAP_ATOMIC_ASYNC_PAGE_FLIP}(hjlhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjlubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjlhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjlhhhjlhMubah}(h]jlah ](jjeh"]h$]h&]jj)jhuh1jhjlhMhjlhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjlhhhjlhMubeh}(h]h ](jmacroeh"]h$]h&]j jj jmjjmjjjuh1jhhhj^hj^hNubh)}(h"``DRM_CAP_ATOMIC_ASYNC_PAGE_FLIP``h]j)}(hjmh]hDRM_CAP_ATOMIC_ASYNC_PAGE_FLIP}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hj**Description** If set to 1, the driver supports :c:type:`DRM_MODE_PAGE_FLIP_ASYNC` for atomic commits. h](h)}(h**Description**h]j)}(hj6mh]h Description}(hj8mhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4mubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM hj0mubh)}(hWIf set to 1, the driver supports :c:type:`DRM_MODE_PAGE_FLIP_ASYNC` for atomic commits.h](h!If set to 1, the driver supports }(hjLmhhhNhNubh)}(h":c:type:`DRM_MODE_PAGE_FLIP_ASYNC`h]j)}(hjVmh]hDRM_MODE_PAGE_FLIP_ASYNC}(hjXmhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjTmubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PAGE_FLIP_ASYNCuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM hjLmubh for atomic commits.}(hjLmhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjsmhM hj0mubeh}(h]h ]h"]h$]h&]uh1j$hjKmhM hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"DRM_CLIENT_CAP_STEREO_3D (C macro)c.DRM_CLIENT_CAP_STEREO_3DhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CLIENT_CAP_STEREO_3Dh]j)}(hDRM_CLIENT_CAP_STEREO_3Dh]j)}(hDRM_CLIENT_CAP_STEREO_3Dh]j)}(hjmh]hDRM_CLIENT_CAP_STEREO_3D}(hjmhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjmubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjmhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM!ubah}(h]h ]h"]h$]h&]hhjuh1jjjhjmhhhjmhM!ubah}(h]jmah ](jjeh"]h$]h&]jj)jhuh1jhjmhM!hjmhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjmhhhjmhM!ubeh}(h]h ](jmacroeh"]h$]h&]j jj jmjjmjjjuh1jhhhj^hj^hNubh)}(h``DRM_CLIENT_CAP_STEREO_3D``h]j)}(hjmh]hDRM_CLIENT_CAP_STEREO_3D}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM#hj^hhubj%)}(hX(**Description** If set to 1, the DRM core will expose the stereo 3D capabilities of the monitor by advertising the supported 3D layouts in the flags of struct drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``. This capability is always supported for all drivers starting from kernel version 3.13. h](h)}(h**Description**h]j)}(hjmh]h Description}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjmubh)}(hIf set to 1, the DRM core will expose the stereo 3D capabilities of the monitor by advertising the supported 3D layouts in the flags of struct drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``.h](hIf set to 1, the DRM core will expose the stereo 3D capabilities of the monitor by advertising the supported 3D layouts in the flags of struct drm_mode_modeinfo. See }(hjnhhhNhNubj)}(h``DRM_MODE_FLAG_3D_*``h]hDRM_MODE_FLAG_3D_*}(hj nhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubh.}(hjnhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjmubh)}(hVThis capability is always supported for all drivers starting from kernel version 3.13.h]hVThis capability is always supported for all drivers starting from kernel version 3.13.}(hj&nhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjmubeh}(h]h ]h"]h$]h&]uh1j$hjnhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)DRM_CLIENT_CAP_UNIVERSAL_PLANES (C macro)!c.DRM_CLIENT_CAP_UNIVERSAL_PLANEShNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CLIENT_CAP_UNIVERSAL_PLANESh]j)}(hDRM_CLIENT_CAP_UNIVERSAL_PLANESh]j)}(hDRM_CLIENT_CAP_UNIVERSAL_PLANESh]j)}(hjNnh]hDRM_CLIENT_CAP_UNIVERSAL_PLANES}(hjXnhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjTnubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjPnhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM,ubah}(h]h ]h"]h$]h&]hhjuh1jjjhjLnhhhjknhM,ubah}(h]jGnah ](jjeh"]h$]h&]jj)jhuh1jhjknhM,hjInhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjInhhhjknhM,ubeh}(h]h ](jmacroeh"]h$]h&]j jj jnjjnjjjuh1jhhhj^hj^hNubh)}(h#``DRM_CLIENT_CAP_UNIVERSAL_PLANES``h]j)}(hjnh]hDRM_CLIENT_CAP_UNIVERSAL_PLANES}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM.hj^hhubj%)}(hX**Description** If set to 1, the DRM core will expose all planes (overlay, primary, and cursor) to userspace. This capability has been introduced in kernel version 3.15. Starting from kernel version 3.17, this capability is always supported for all drivers. h](h)}(h**Description**h]j)}(hjnh]h Description}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM%hjnubh)}(h]If set to 1, the DRM core will expose all planes (overlay, primary, and cursor) to userspace.h]h]If set to 1, the DRM core will expose all planes (overlay, primary, and cursor) to userspace.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM%hjnubh)}(hThis capability has been introduced in kernel version 3.15. Starting from kernel version 3.17, this capability is always supported for all drivers.h]hThis capability has been introduced in kernel version 3.15. Starting from kernel version 3.17, this capability is always supported for all drivers.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM(hjnubeh}(h]h ]h"]h$]h&]uh1j$hjnhM%hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_CLIENT_CAP_ATOMIC (C macro)c.DRM_CLIENT_CAP_ATOMIChNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CLIENT_CAP_ATOMICh]j)}(hDRM_CLIENT_CAP_ATOMICh]j)}(hDRM_CLIENT_CAP_ATOMICh]j)}(hjnh]hDRM_CLIENT_CAP_ATOMIC}(hjnhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjnubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjnhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM<ubah}(h]h ]h"]h$]h&]hhjuh1jjjhjnhhhjohM<ubah}(h]jnah ](jjeh"]h$]h&]jj)jhuh1jhjohM<hjnhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjnhhhjohM<ubeh}(h]h ](jmacroeh"]h$]h&]j jj j)ojj)ojjjuh1jhhhj^hj^hNubh)}(h``DRM_CLIENT_CAP_ATOMIC``h]j)}(hj/oh]hDRM_CLIENT_CAP_ATOMIC}(hj1ohhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-oubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM>hj^hhubj%)}(hX**Description** If set to 1, the DRM core will expose atomic properties to userspace. This implicitly enables :c:type:`DRM_CLIENT_CAP_UNIVERSAL_PLANES` and :c:type:`DRM_CLIENT_CAP_ASPECT_RATIO`. If the driver doesn't support atomic mode-setting, enabling this capability will fail with -EOPNOTSUPP. This capability has been introduced in kernel version 4.0. Starting from kernel version 4.2, this capability is always supported for atomic-capable drivers. h](h)}(h**Description**h]j)}(hjKoh]h Description}(hjMohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIoubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM0hjEoubh)}(hIf set to 1, the DRM core will expose atomic properties to userspace. This implicitly enables :c:type:`DRM_CLIENT_CAP_UNIVERSAL_PLANES` and :c:type:`DRM_CLIENT_CAP_ASPECT_RATIO`.h](h^If set to 1, the DRM core will expose atomic properties to userspace. This implicitly enables }(hjaohhhNhNubh)}(h):c:type:`DRM_CLIENT_CAP_UNIVERSAL_PLANES`h]j)}(hjkoh]hDRM_CLIENT_CAP_UNIVERSAL_PLANES}(hjmohhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjioubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CLIENT_CAP_UNIVERSAL_PLANESuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM0hjaoubh and }(hjaohhhNhNubh)}(h%:c:type:`DRM_CLIENT_CAP_ASPECT_RATIO`h]j)}(hjoh]hDRM_CLIENT_CAP_ASPECT_RATIO}(hjohhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjoubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CLIENT_CAP_ASPECT_RATIOuh1hhjohM0hjaoubh.}(hjaohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjohM0hjEoubh)}(hgIf the driver doesn't support atomic mode-setting, enabling this capability will fail with -EOPNOTSUPP.h]hiIf the driver doesn’t support atomic mode-setting, enabling this capability will fail with -EOPNOTSUPP.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM4hjEoubh)}(hThis capability has been introduced in kernel version 4.0. Starting from kernel version 4.2, this capability is always supported for atomic-capable drivers.h]hThis capability has been introduced in kernel version 4.0. Starting from kernel version 4.2, this capability is always supported for atomic-capable drivers.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM7hjEoubeh}(h]h ]h"]h$]h&]uh1j$hj`ohM0hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%DRM_CLIENT_CAP_ASPECT_RATIO (C macro)c.DRM_CLIENT_CAP_ASPECT_RATIOhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_CLIENT_CAP_ASPECT_RATIOh]j)}(hDRM_CLIENT_CAP_ASPECT_RATIOh]j)}(hDRM_CLIENT_CAP_ASPECT_RATIOh]j)}(hjoh]hDRM_CLIENT_CAP_ASPECT_RATIO}(hjohhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjoubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjohhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMGubah}(h]h ]h"]h$]h&]hhjuh1jjjhjohhhj phMGubah}(h]joah ](jjeh"]h$]h&]jj)jhuh1jhj phMGhjohhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjohhhj phMGubeh}(h]h ](jmacroeh"]h$]h&]j jj j#pjj#pjjjuh1jhhhj^hj^hNubh)}(h``DRM_CLIENT_CAP_ASPECT_RATIO``h]j)}(hj)ph]hDRM_CLIENT_CAP_ASPECT_RATIO}(hj+phhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'pubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMIhj^hhubj%)}(h**Description** If set to 1, the DRM core will provide aspect ratio information in modes. See ``DRM_MODE_FLAG_PIC_AR_*``. This capability is always supported for all drivers starting from kernel version 4.18. h](h)}(h**Description**h]j)}(hjEph]h Description}(hjGphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCpubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM@hj?pubh)}(hiIf set to 1, the DRM core will provide aspect ratio information in modes. See ``DRM_MODE_FLAG_PIC_AR_*``.h](hNIf set to 1, the DRM core will provide aspect ratio information in modes. See }(hj[phhhNhNubj)}(h``DRM_MODE_FLAG_PIC_AR_*``h]hDRM_MODE_FLAG_PIC_AR_*}(hjcphhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[pubh.}(hj[phhhNhNubeh}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM@hj?pubh)}(hVThis capability is always supported for all drivers starting from kernel version 4.18.h]hVThis capability is always supported for all drivers starting from kernel version 4.18.}(hj|phhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMChj?pubeh}(h]h ]h"]h$]h&]uh1j$hjZphM@hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-DRM_CLIENT_CAP_WRITEBACK_CONNECTORS (C macro)%c.DRM_CLIENT_CAP_WRITEBACK_CONNECTORShNtauh1jhj^hhhj^hNubj)}(hhh](j)}(h#DRM_CLIENT_CAP_WRITEBACK_CONNECTORSh]j)}(h#DRM_CLIENT_CAP_WRITEBACK_CONNECTORSh]j)}(h#DRM_CLIENT_CAP_WRITEBACK_CONNECTORSh]j)}(hjph]h#DRM_CLIENT_CAP_WRITEBACK_CONNECTORS}(hjphhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjpubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjphhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMSubah}(h]h ]h"]h$]h&]hhjuh1jjjhjphhhjphMSubah}(h]jpah ](jjeh"]h$]h&]jj)jhuh1jhjphMShjphhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjphhhjphMSubeh}(h]h ](jmacroeh"]h$]h&]j jj jpjjpjjjuh1jhhhj^hj^hNubh)}(h'``DRM_CLIENT_CAP_WRITEBACK_CONNECTORS``h]j)}(hjph]h#DRM_CLIENT_CAP_WRITEBACK_CONNECTORS}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMUhj^hhubj%)}(hX1**Description** If set to 1, the DRM core will expose special connectors to be used for writing back to memory the scene setup in the commit. The client must enable :c:type:`DRM_CLIENT_CAP_ATOMIC` first. This capability is always supported for atomic-capable drivers starting from kernel version 4.19. h](h)}(h**Description**h]j)}(hjph]h Description}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMKhjpubh)}(hIf set to 1, the DRM core will expose special connectors to be used for writing back to memory the scene setup in the commit. The client must enable :c:type:`DRM_CLIENT_CAP_ATOMIC` first.h](hIf set to 1, the DRM core will expose special connectors to be used for writing back to memory the scene setup in the commit. The client must enable }(hjqhhhNhNubh)}(h:c:type:`DRM_CLIENT_CAP_ATOMIC`h]j)}(hjqh]hDRM_CLIENT_CAP_ATOMIC}(hjqhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CLIENT_CAP_ATOMICuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMKhjqubh first.}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj9qhMKhjpubh)}(haThis capability is always supported for atomic-capable drivers starting from kernel version 4.19.h]haThis capability is always supported for atomic-capable drivers starting from kernel version 4.19.}(hjDqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMOhjpubeh}(h]h ]h"]h$]h&]uh1j$hjqhMKhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT (C macro)%c.DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOThNtauh1jhj^hhhj^hNubj)}(hhh](j)}(h#DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOTh]j)}(h#DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOTh]j)}(h#DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOTh]j)}(hjlqh]h#DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT}(hjvqhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjrqubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjnqhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMlubah}(h]h ]h"]h$]h&]hhjuh1jjjhjjqhhhjqhMlubah}(h]jeqah ](jjeh"]h$]h&]jj)jhuh1jhjqhMlhjgqhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjgqhhhjqhMlubeh}(h]h ](jmacroeh"]h$]h&]j jj jqjjqjjjuh1jhhhj^hj^hNubh)}(h'``DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT``h]j)}(hjqh]h#DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMnhj^hhubj%)}(hX**Description** Drivers for para-virtualized hardware (e.g. vmwgfx, qxl, virtio and virtualbox) have additional restrictions for cursor planes (thus making cursor planes on those drivers not truly universal,) e.g. they need cursor planes to act like one would expect from a mouse cursor and have correctly set hotspot properties. If this client cap is not set the DRM core will hide cursor plane on those virtualized drivers because not setting it implies that the client is not capable of dealing with those extra restictions. Clients which do set cursor hotspot and treat the cursor plane like a mouse cursor should set this property. The client must enable :c:type:`DRM_CLIENT_CAP_ATOMIC` first. Setting this property on drivers which do not special case cursor planes (i.e. non-virtualized drivers) will return EOPNOTSUPP, which can be used by userspace to gauge requirements of the hardware/drivers they're running on. This capability is always supported for atomic-capable virtualized drivers starting from kernel version 6.6. h](h)}(h**Description**h]j)}(hjqh]h Description}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMWhjqubh)}(hXDrivers for para-virtualized hardware (e.g. vmwgfx, qxl, virtio and virtualbox) have additional restrictions for cursor planes (thus making cursor planes on those drivers not truly universal,) e.g. they need cursor planes to act like one would expect from a mouse cursor and have correctly set hotspot properties. If this client cap is not set the DRM core will hide cursor plane on those virtualized drivers because not setting it implies that the client is not capable of dealing with those extra restictions. Clients which do set cursor hotspot and treat the cursor plane like a mouse cursor should set this property. The client must enable :c:type:`DRM_CLIENT_CAP_ATOMIC` first.h](hXDrivers for para-virtualized hardware (e.g. vmwgfx, qxl, virtio and virtualbox) have additional restrictions for cursor planes (thus making cursor planes on those drivers not truly universal,) e.g. they need cursor planes to act like one would expect from a mouse cursor and have correctly set hotspot properties. If this client cap is not set the DRM core will hide cursor plane on those virtualized drivers because not setting it implies that the client is not capable of dealing with those extra restictions. Clients which do set cursor hotspot and treat the cursor plane like a mouse cursor should set this property. The client must enable }(hjqhhhNhNubh)}(h:c:type:`DRM_CLIENT_CAP_ATOMIC`h]j)}(hjqh]hDRM_CLIENT_CAP_ATOMIC}(hjqhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CLIENT_CAP_ATOMICuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMWhjqubh first.}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjrhMWhjqubh)}(hSetting this property on drivers which do not special case cursor planes (i.e. non-virtualized drivers) will return EOPNOTSUPP, which can be used by userspace to gauge requirements of the hardware/drivers they're running on.h]hSetting this property on drivers which do not special case cursor planes (i.e. non-virtualized drivers) will return EOPNOTSUPP, which can be used by userspace to gauge requirements of the hardware/drivers they’re running on.}(hj rhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMchjqubh)}(hlThis capability is always supported for atomic-capable virtualized drivers starting from kernel version 6.6.h]hlThis capability is always supported for atomic-capable virtualized drivers starting from kernel version 6.6.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhhjqubeh}(h]h ]h"]h$]h&]uh1j$hjqhMWhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_syncobj_eventfd (C struct)c.drm_syncobj_eventfdhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hdrm_syncobj_eventfdh]j)}(hstruct drm_syncobj_eventfdh](j@)}(hjCh]hstruct}(hjIrhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjErhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMnubj)}(h h]h }(hjWrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjErhhhjVrhMnubj)}(hdrm_syncobj_eventfdh]j)}(hjCrh]hdrm_syncobj_eventfd}(hjirhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjerubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjErhhhjVrhMnubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjArhhhjVrhMnubah}(h]jrhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj>rhhhjVrhMnubeh}(h]h ](jstructeh"]h$]h&]j jj jrjjrjjjuh1jhhhj^hj^hNubj)}(hX**Definition**:: struct drm_syncobj_eventfd { __u32 handle; __u32 flags; __u64 point; __s32 fd; __u32 pad; }; **Members** ``handle`` syncobj handle. ``flags`` Zero to wait for the point to be signalled, or :c:type:`DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE` to wait for a fence to be available for the point. ``point`` syncobj timeline point (set to zero for binary syncobjs). ``fd`` Existing eventfd to sent events to. ``pad`` Must be zero.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubh:}(hjrhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjrubj )}(hpstruct drm_syncobj_eventfd { __u32 handle; __u32 flags; __u64 point; __s32 fd; __u32 pad; };h]hpstruct drm_syncobj_eventfd { __u32 handle; __u32 flags; __u64 point; __s32 fd; __u32 pad; };}hjrsbah}(h]h ]h"]h$]h&]hhuh1j hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjrubh)}(h **Members**h]j)}(hjrh]hMembers}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjrubj1)}(hhh](j6)}(h``handle`` syncobj handle. h](j<)}(h ``handle``h]j)}(hjrh]hhandle}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjrubjV)}(hhh]h)}(hsyncobj handle.h]hsyncobj handle.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjrhMhjrubah}(h]h ]h"]h$]h&]uh1jUhjrubeh}(h]h ]h"]h$]h&]uh1j5hjrhMhjrubj6)}(h``flags`` Zero to wait for the point to be signalled, or :c:type:`DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE` to wait for a fence to be available for the point. h](j<)}(h ``flags``h]j)}(hj"sh]hflags}(hj$shhhNhNubah}(h]h ]h"]h$]h&]uh1jhj subah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjsubjV)}(hhh]h)}(hZero to wait for the point to be signalled, or :c:type:`DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE` to wait for a fence to be available for the point.h](h/Zero to wait for the point to be signalled, or }(hj;shhhNhNubh)}(h/:c:type:`DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE`h]j)}(hjEsh]h%DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE}(hjGshhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjCsubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj%DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLEuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj;subh3 to wait for a fence to be available for the point.}(hj;shhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjbshMhj8subah}(h]h ]h"]h$]h&]uh1jUhjsubeh}(h]h ]h"]h$]h&]uh1j5hj7shMhjrubj6)}(hD``point`` syncobj timeline point (set to zero for binary syncobjs). h](j<)}(h ``point``h]j)}(hjsh]hpoint}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}subah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjysubjV)}(hhh]h)}(h9syncobj timeline point (set to zero for binary syncobjs).h]h9syncobj timeline point (set to zero for binary syncobjs).}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshMhjsubah}(h]h ]h"]h$]h&]uh1jUhjysubeh}(h]h ]h"]h$]h&]uh1j5hjshMhjrubj6)}(h+``fd`` Existing eventfd to sent events to. h](j<)}(h``fd``h]j)}(hjsh]hfd}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjsubjV)}(hhh]h)}(h#Existing eventfd to sent events to.h]h#Existing eventfd to sent events to.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshMhjsubah}(h]h ]h"]h$]h&]uh1jUhjsubeh}(h]h ]h"]h$]h&]uh1j5hjshMhjrubj6)}(h``pad`` Must be zero.h](j<)}(h``pad``h]j)}(hjsh]hpad}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjsubjV)}(hhh]h)}(h Must be zero.h]h Must be zero.}(hj thhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjtubah}(h]h ]h"]h$]h&]uh1jUhjsubeh}(h]h ]h"]h$]h&]uh1j5hjthMhjrubeh}(h]h ]h"]h$]h&]uh1j0hjrubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhj^hNubh)}(h**Description**h]j)}(hj4th]h Description}(hj6thhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2tubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubh)}(haRegister an eventfd to be signalled by a syncobj. The eventfd counter will be incremented by one.h]haRegister an eventfd to be signalled by a syncobj. The eventfd counter will be incremented by one.}(hjJthhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_IOCTL_GEM_CLOSE (C macro)c.DRM_IOCTL_GEM_CLOSEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_GEM_CLOSEh]j)}(hDRM_IOCTL_GEM_CLOSEh]j)}(hDRM_IOCTL_GEM_CLOSEh]j)}(hjlth]hDRM_IOCTL_GEM_CLOSE}(hjvthhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjrtubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjnthhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM0ubah}(h]h ]h"]h$]h&]hhjuh1jjjhjjthhhjthM0ubah}(h]jetah ](jjeh"]h$]h&]jj)jhuh1jhjthM0hjgthhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjgthhhjthM0ubeh}(h]h ](jmacroeh"]h$]h&]j jj jtjjtjjjuh1jhhhj^hj^hNubh)}(h``DRM_IOCTL_GEM_CLOSE``h]j)}(hjth]hDRM_IOCTL_GEM_CLOSE}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM2hj^hhubj%)}(hX Close a GEM handle. **Description** GEM handles are not reference-counted by the kernel. User-space is responsible for managing their lifetime. For example, if user-space imports the same memory object twice on the same DRM file description, the same GEM handle is returned by both imports, and user-space needs to ensure :c:type:`DRM_IOCTL_GEM_CLOSE` is performed once only. The same situation can happen when a memory object is allocated, then exported and imported again on the same DRM file description. The :c:type:`DRM_IOCTL_MODE_GETFB2` IOCTL is an exception and always returns fresh new GEM handles even if an existing GEM handle already refers to the same memory object before the IOCTL is performed. h](j%)}(hClose a GEM handle. h]h)}(hClose a GEM handle.h]hClose a GEM handle.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM$hjtubah}(h]h ]h"]h$]h&]uh1j$hjthM$hjtubh)}(h**Description**h]j)}(hjth]h Description}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM&hjtubh)}(hXGEM handles are not reference-counted by the kernel. User-space is responsible for managing their lifetime. For example, if user-space imports the same memory object twice on the same DRM file description, the same GEM handle is returned by both imports, and user-space needs to ensure :c:type:`DRM_IOCTL_GEM_CLOSE` is performed once only. The same situation can happen when a memory object is allocated, then exported and imported again on the same DRM file description. The :c:type:`DRM_IOCTL_MODE_GETFB2` IOCTL is an exception and always returns fresh new GEM handles even if an existing GEM handle already refers to the same memory object before the IOCTL is performed.h](hXGEM handles are not reference-counted by the kernel. User-space is responsible for managing their lifetime. For example, if user-space imports the same memory object twice on the same DRM file description, the same GEM handle is returned by both imports, and user-space needs to ensure }(hjthhhNhNubh)}(h:c:type:`DRM_IOCTL_GEM_CLOSE`h]j)}(hjth]hDRM_IOCTL_GEM_CLOSE}(hjthhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_GEM_CLOSEuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM%hjtubh is performed once only. The same situation can happen when a memory object is allocated, then exported and imported again on the same DRM file description. The }(hjthhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_GETFB2`h]j)}(hj!uh]hDRM_IOCTL_MODE_GETFB2}(hj#uhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_GETFB2uh1hhjuhM%hjtubh IOCTL is an exception and always returns fresh new GEM handles even if an existing GEM handle already refers to the same memory object before the IOCTL is performed.}(hjthhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjuhM%hjtubeh}(h]h ]h"]h$]h&]uh1j$hjthM$hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&DRM_IOCTL_PRIME_HANDLE_TO_FD (C macro)c.DRM_IOCTL_PRIME_HANDLE_TO_FDhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_PRIME_HANDLE_TO_FDh]j)}(hDRM_IOCTL_PRIME_HANDLE_TO_FDh]j)}(hDRM_IOCTL_PRIME_HANDLE_TO_FDh]j)}(hjauh]hDRM_IOCTL_PRIME_HANDLE_TO_FD}(hjkuhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjguubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjcuhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMdubah}(h]h ]h"]h$]h&]hhjuh1jjjhj_uhhhj~uhMdubah}(h]jZuah ](jjeh"]h$]h&]jj)jhuh1jhj~uhMdhj\uhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj\uhhhj~uhMdubeh}(h]h ](jmacroeh"]h$]h&]j jj jujjujjjuh1jhhhj^hj^hNubh)}(h ``DRM_IOCTL_PRIME_HANDLE_TO_FD``h]j)}(hjuh]hDRM_IOCTL_PRIME_HANDLE_TO_FD}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMfhj^hhubj%)}(hX Convert a GEM handle to a DMA-BUF FD. **Description** User-space sets :c:type:`drm_prime_handle.handle ` with the GEM handle to export and :c:type:`drm_prime_handle.flags `, and gets back a DMA-BUF file descriptor in :c:type:`drm_prime_handle.fd `. The export can fail for any driver-specific reason, e.g. because export is not supported for this specific GEM handle (but might be for others). Support for exporting DMA-BUFs is advertised via :c:type:`DRM_PRIME_CAP_EXPORT`. h](j%)}(h&Convert a GEM handle to a DMA-BUF FD. h]h)}(h%Convert a GEM handle to a DMA-BUF FD.h]h%Convert a GEM handle to a DMA-BUF FD.}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMYhjuubah}(h]h ]h"]h$]h&]uh1j$hjuhMYhjuubh)}(h**Description**h]j)}(hjuh]h Description}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM[hjuubh)}(hUser-space sets :c:type:`drm_prime_handle.handle ` with the GEM handle to export and :c:type:`drm_prime_handle.flags `, and gets back a DMA-BUF file descriptor in :c:type:`drm_prime_handle.fd `.h](hUser-space sets }(hjuhhhNhNubh)}(h4:c:type:`drm_prime_handle.handle `h]j)}(hjuh]hdrm_prime_handle.handle}(hjuhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_prime_handleuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMZhjuubh# with the GEM handle to export and }(hjuhhhNhNubh)}(h3:c:type:`drm_prime_handle.flags `h]j)}(hjvh]hdrm_prime_handle.flags}(hjvhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjvubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_prime_handleuh1hhjvhMZhjuubh-, and gets back a DMA-BUF file descriptor in }(hjuhhhNhNubh)}(h0:c:type:`drm_prime_handle.fd `h]j)}(hj9vh]hdrm_prime_handle.fd}(hj;vhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj7vubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_prime_handleuh1hhjvhMZhjuubh.}(hjuhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjvhMZhjuubh)}(hThe export can fail for any driver-specific reason, e.g. because export is not supported for this specific GEM handle (but might be for others).h]hThe export can fail for any driver-specific reason, e.g. because export is not supported for this specific GEM handle (but might be for others).}(hj`vhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM^hjuubh)}(hPSupport for exporting DMA-BUFs is advertised via :c:type:`DRM_PRIME_CAP_EXPORT`.h](h1Support for exporting DMA-BUFs is advertised via }(hjovhhhNhNubh)}(h:c:type:`DRM_PRIME_CAP_EXPORT`h]j)}(hjyvh]hDRM_PRIME_CAP_EXPORT}(hj{vhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjwvubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_PRIME_CAP_EXPORTuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMahjovubh.}(hjovhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjvhMahjuubeh}(h]h ]h"]h$]h&]uh1j$hjuhMYhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&DRM_IOCTL_PRIME_FD_TO_HANDLE (C macro)c.DRM_IOCTL_PRIME_FD_TO_HANDLEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_PRIME_FD_TO_HANDLEh]j)}(hDRM_IOCTL_PRIME_FD_TO_HANDLEh]j)}(hDRM_IOCTL_PRIME_FD_TO_HANDLEh]j)}(hjvh]hDRM_IOCTL_PRIME_FD_TO_HANDLE}(hjvhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjvubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjvhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMwubah}(h]h ]h"]h$]h&]hhjuh1jjjhjvhhhjvhMwubah}(h]jvah ](jjeh"]h$]h&]jj)jhuh1jhjvhMwhjvhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjvhhhjvhMwubeh}(h]h ](jmacroeh"]h$]h&]j jj jvjjvjjjuh1jhhhj^hj^hNubh)}(h ``DRM_IOCTL_PRIME_FD_TO_HANDLE``h]j)}(hjvh]hDRM_IOCTL_PRIME_FD_TO_HANDLE}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMyhj^hhubj%)}(hXP Convert a DMA-BUF FD to a GEM handle. **Description** User-space sets :c:type:`drm_prime_handle.fd ` with a DMA-BUF file descriptor to import, and gets back a GEM handle in :c:type:`drm_prime_handle.handle `. :c:type:`drm_prime_handle.flags ` is unused. If an existing GEM handle refers to the memory object backing the DMA-BUF, that GEM handle is returned. Therefore user-space which needs to handle arbitrary DMA-BUFs must have a user-space lookup data structure to manually reference-count duplicated GEM handles. For more information see :c:type:`DRM_IOCTL_GEM_CLOSE`. The import can fail for any driver-specific reason, e.g. because import is only supported for DMA-BUFs allocated on this DRM device. Support for importing DMA-BUFs is advertised via :c:type:`DRM_PRIME_CAP_IMPORT`. h](j%)}(h&Convert a DMA-BUF FD to a GEM handle. h]h)}(h%Convert a DMA-BUF FD to a GEM handle.h]h%Convert a DMA-BUF FD to a GEM handle.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMfhjwubah}(h]h ]h"]h$]h&]uh1j$hj"whMfhj wubh)}(h**Description**h]j)}(hj+wh]h Description}(hj-whhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)wubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhhj wubh)}(hUser-space sets :c:type:`drm_prime_handle.fd ` with a DMA-BUF file descriptor to import, and gets back a GEM handle in :c:type:`drm_prime_handle.handle `. :c:type:`drm_prime_handle.flags ` is unused.h](hUser-space sets }(hjAwhhhNhNubh)}(h0:c:type:`drm_prime_handle.fd `h]j)}(hjKwh]hdrm_prime_handle.fd}(hjMwhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjIwubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_prime_handleuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMghjAwubhI with a DMA-BUF file descriptor to import, and gets back a GEM handle in }(hjAwhhhNhNubh)}(h4:c:type:`drm_prime_handle.handle `h]j)}(hjowh]hdrm_prime_handle.handle}(hjqwhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjmwubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_prime_handleuh1hhjhwhMghjAwubh. }(hjAwhhhNhNubh)}(h3:c:type:`drm_prime_handle.flags `h]j)}(hjwh]hdrm_prime_handle.flags}(hjwhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_prime_handleuh1hhjhwhMghjAwubh is unused.}(hjAwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhwhMghj wubh)}(hX>If an existing GEM handle refers to the memory object backing the DMA-BUF, that GEM handle is returned. Therefore user-space which needs to handle arbitrary DMA-BUFs must have a user-space lookup data structure to manually reference-count duplicated GEM handles. For more information see :c:type:`DRM_IOCTL_GEM_CLOSE`.h](hX If an existing GEM handle refers to the memory object backing the DMA-BUF, that GEM handle is returned. Therefore user-space which needs to handle arbitrary DMA-BUFs must have a user-space lookup data structure to manually reference-count duplicated GEM handles. For more information see }(hjwhhhNhNubh)}(h:c:type:`DRM_IOCTL_GEM_CLOSE`h]j)}(hjwh]hDRM_IOCTL_GEM_CLOSE}(hjwhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_GEM_CLOSEuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMkhjwubh.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjwhMkhj wubh)}(hThe import can fail for any driver-specific reason, e.g. because import is only supported for DMA-BUFs allocated on this DRM device.h]hThe import can fail for any driver-specific reason, e.g. because import is only supported for DMA-BUFs allocated on this DRM device.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMqhj wubh)}(hPSupport for importing DMA-BUFs is advertised via :c:type:`DRM_PRIME_CAP_IMPORT`.h](h1Support for importing DMA-BUFs is advertised via }(hjwhhhNhNubh)}(h:c:type:`DRM_PRIME_CAP_IMPORT`h]j)}(hjxh]hDRM_PRIME_CAP_IMPORT}(hjxhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_PRIME_CAP_IMPORTuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMthjwubh.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj!xhMthj wubeh}(h]h ]h"]h$]h&]uh1j$hj"whMfhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_IOCTL_MODE_RMFB (C macro)c.DRM_IOCTL_MODE_RMFBhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_MODE_RMFBh]j)}(hDRM_IOCTL_MODE_RMFBh]j)}(hDRM_IOCTL_MODE_RMFBh]j)}(hjExh]hDRM_IOCTL_MODE_RMFB}(hjOxhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjKxubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjGxhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjCxhhhjbxhMubah}(h]j>xah ](jjeh"]h$]h&]jj)jhuh1jhjbxhMhj@xhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj@xhhhjbxhMubeh}(h]h ](jmacroeh"]h$]h&]j jj j{xjj{xjjjuh1jhhhj^hj^hNubh)}(h``DRM_IOCTL_MODE_RMFB``h]j)}(hjxh]hDRM_IOCTL_MODE_RMFB}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hXO Remove a framebuffer. **Description** This removes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL argument is a framebuffer object ID. Warning: removing a framebuffer currently in-use on an enabled plane will disable that plane. The CRTC the plane is linked to may also be disabled (depending on driver capabilities). h](j%)}(hRemove a framebuffer. h]h)}(hRemove a framebuffer.h]hRemove a framebuffer.}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjxubah}(h]h ]h"]h$]h&]uh1j$hjxhMhjxubh)}(h**Description**h]j)}(hjxh]h Description}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjxubh)}(hlThis removes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL argument is a framebuffer object ID.h]hlThis removes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL argument is a framebuffer object ID.}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjxubh)}(hWarning: removing a framebuffer currently in-use on an enabled plane will disable that plane. The CRTC the plane is linked to may also be disabled (depending on driver capabilities).h]hWarning: removing a framebuffer currently in-use on an enabled plane will disable that plane. The CRTC the plane is linked to may also be disabled (depending on driver capabilities).}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjxubeh}(h]h ]h"]h$]h&]uh1j$hjxhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$DRM_IOCTL_MODE_CREATE_DUMB (C macro)c.DRM_IOCTL_MODE_CREATE_DUMBhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_MODE_CREATE_DUMBh]j)}(hDRM_IOCTL_MODE_CREATE_DUMBh]j)}(hDRM_IOCTL_MODE_CREATE_DUMBh]j)}(hjyh]hDRM_IOCTL_MODE_CREATE_DUMB}(hj yhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj yubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjyhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjyhhhj yhMubah}(h]jxah ](jjeh"]h$]h&]jj)jhuh1jhj yhMhjxhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjxhhhj yhMubeh}(h]h ](jmacroeh"]h$]h&]j jj j9yjj9yjjjuh1jhhhj^hj^hNubh)}(h``DRM_IOCTL_MODE_CREATE_DUMB``h]j)}(hj?yh]hDRM_IOCTL_MODE_CREATE_DUMB}(hjAyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=yubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hXk Create a new dumb buffer object. **Description** KMS dumb buffers provide a very primitive way to allocate a buffer object suitable for scanout and map it for software rendering. KMS dumb buffers are not suitable for hardware-accelerated rendering nor video decoding. KMS dumb buffers are not suitable to be displayed on any other device than the KMS device where they were allocated from. Also see :ref:`kms_dumb_buffer_objects`. The IOCTL argument is a struct drm_mode_create_dumb. User-space is expected to create a KMS dumb buffer via this IOCTL, then add it as a KMS framebuffer via :c:type:`DRM_IOCTL_MODE_ADDFB` and map it via :c:type:`DRM_IOCTL_MODE_MAP_DUMB`. :c:type:`DRM_CAP_DUMB_BUFFER` indicates whether this IOCTL is supported. :c:type:`DRM_CAP_DUMB_PREFERRED_DEPTH` and :c:type:`DRM_CAP_DUMB_PREFER_SHADOW` indicate driver preferences for dumb buffers. h](j%)}(h!Create a new dumb buffer object. h]h)}(h Create a new dumb buffer object.h]h Create a new dumb buffer object.}(hj]yhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjYyubah}(h]h ]h"]h$]h&]uh1j$hjkyhMhjUyubh)}(h**Description**h]j)}(hjtyh]h Description}(hjvyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjryubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjUyubh)}(hX}KMS dumb buffers provide a very primitive way to allocate a buffer object suitable for scanout and map it for software rendering. KMS dumb buffers are not suitable for hardware-accelerated rendering nor video decoding. KMS dumb buffers are not suitable to be displayed on any other device than the KMS device where they were allocated from. Also see :ref:`kms_dumb_buffer_objects`.h](hX^KMS dumb buffers provide a very primitive way to allocate a buffer object suitable for scanout and map it for software rendering. KMS dumb buffers are not suitable for hardware-accelerated rendering nor video decoding. KMS dumb buffers are not suitable to be displayed on any other device than the KMS device where they were allocated from. Also see }(hjyhhhNhNubh)}(h:ref:`kms_dumb_buffer_objects`h]j<)}(hjyh]hkms_dumb_buffer_objects}(hjyhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hjyubah}(h]h ]h"]h$]h&]refdocj refdomainjyreftyperef refexplicitrefwarnjkms_dumb_buffer_objectsuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjyubh.}(hjyhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjyhMhjUyubh)}(h4The IOCTL argument is a struct drm_mode_create_dumb.h]h4The IOCTL argument is a struct drm_mode_create_dumb.}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjUyubh)}(hUser-space is expected to create a KMS dumb buffer via this IOCTL, then add it as a KMS framebuffer via :c:type:`DRM_IOCTL_MODE_ADDFB` and map it via :c:type:`DRM_IOCTL_MODE_MAP_DUMB`.h](hhUser-space is expected to create a KMS dumb buffer via this IOCTL, then add it as a KMS framebuffer via }(hjyhhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_ADDFB`h]j)}(hjyh]hDRM_IOCTL_MODE_ADDFB}(hjyhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_ADDFBuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjyubh and map it via }(hjyhhhNhNubh)}(h!:c:type:`DRM_IOCTL_MODE_MAP_DUMB`h]j)}(hjyh]hDRM_IOCTL_MODE_MAP_DUMB}(hjyhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_MAP_DUMBuh1hhjyhMhjyubh.}(hjyhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjyhMhjUyubh)}(h:c:type:`DRM_CAP_DUMB_BUFFER` indicates whether this IOCTL is supported. :c:type:`DRM_CAP_DUMB_PREFERRED_DEPTH` and :c:type:`DRM_CAP_DUMB_PREFER_SHADOW` indicate driver preferences for dumb buffers.h](h)}(h:c:type:`DRM_CAP_DUMB_BUFFER`h]j)}(hj'zh]hDRM_CAP_DUMB_BUFFER}(hj)zhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj%zubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CAP_DUMB_BUFFERuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj!zubh, indicates whether this IOCTL is supported. }(hj!zhhhNhNubh)}(h&:c:type:`DRM_CAP_DUMB_PREFERRED_DEPTH`h]j)}(hjKzh]hDRM_CAP_DUMB_PREFERRED_DEPTH}(hjMzhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjIzubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CAP_DUMB_PREFERRED_DEPTHuh1hhjDzhMhj!zubh and }(hj!zhhhNhNubh)}(h$:c:type:`DRM_CAP_DUMB_PREFER_SHADOW`h]j)}(hjnzh]hDRM_CAP_DUMB_PREFER_SHADOW}(hjpzhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjlzubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CAP_DUMB_PREFER_SHADOWuh1hhjDzhMhj!zubh. indicate driver preferences for dumb buffers.}(hj!zhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjDzhMhjUyubeh}(h]h ]h"]h$]h&]uh1j$hjkyhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_IOCTL_MODE_GETFB2 (C macro)c.DRM_IOCTL_MODE_GETFB2hNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_MODE_GETFB2h]j)}(hDRM_IOCTL_MODE_GETFB2h]j)}(hDRM_IOCTL_MODE_GETFB2h]j)}(hjzh]hDRM_IOCTL_MODE_GETFB2}(hjzhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjzubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjzhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhjzhhhjzhMubah}(h]jzah ](jjeh"]h$]h&]jj)jhuh1jhjzhMhjzhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjzhhhjzhMubeh}(h]h ](jmacroeh"]h$]h&]j jj jzjjzjjjuh1jhhhj^hj^hNubh)}(h``DRM_IOCTL_MODE_GETFB2``h]j)}(hjzh]hDRM_IOCTL_MODE_GETFB2}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hXn Get framebuffer metadata. **Description** This queries metadata about a framebuffer. User-space fills :c:type:`drm_mode_fb_cmd2.fb_id ` as the input, and the kernels fills the rest of the struct as the output. If the client is DRM master or has :c:type:`CAP_SYS_ADMIN`, :c:type:`drm_mode_fb_cmd2.handles ` will be filled with GEM buffer handles. Fresh new GEM handles are always returned, even if another GEM handle referring to the same memory object already exists on the DRM file description. The caller is responsible for removing the new handles, e.g. via the :c:type:`DRM_IOCTL_GEM_CLOSE` IOCTL. The same new handle will be returned for multiple planes in case they use the same memory object. Planes are valid until one has a zero handle -- this can be used to compute the number of planes. Otherwise, :c:type:`drm_mode_fb_cmd2.handles ` will be zeroed and planes are valid until one has a zero :c:type:`drm_mode_fb_cmd2.pitches `. If the framebuffer has a format modifier, :c:type:`DRM_MODE_FB_MODIFIERS` will be set in :c:type:`drm_mode_fb_cmd2.flags ` and :c:type:`drm_mode_fb_cmd2.modifier ` will contain the modifier. Otherwise, user-space must ignore :c:type:`drm_mode_fb_cmd2.modifier `. To obtain DMA-BUF FDs for each plane without leaking GEM handles, user-space can export each handle via :c:type:`DRM_IOCTL_PRIME_HANDLE_TO_FD`, then immediately close each unique handle via :c:type:`DRM_IOCTL_GEM_CLOSE`, making sure to not double-close handles which are specified multiple times in the array. h](j%)}(hGet framebuffer metadata. h]h)}(hGet framebuffer metadata.h]hGet framebuffer metadata.}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj{ubah}(h]h ]h"]h$]h&]uh1j$hj{hMhj{ubh)}(h**Description**h]j)}(hj{h]h Description}(hj!{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj{ubh)}(hThis queries metadata about a framebuffer. User-space fills :c:type:`drm_mode_fb_cmd2.fb_id ` as the input, and the kernels fills the rest of the struct as the output.h](h`h]j)}(hj?{h]hdrm_mode_fb_cmd2.fb_id}(hjA{hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj={ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj5{ubhJ as the input, and the kernels fills the rest of the struct as the output.}(hj5{hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj\{hMhj{ubh)}(hX]If the client is DRM master or has :c:type:`CAP_SYS_ADMIN`, :c:type:`drm_mode_fb_cmd2.handles ` will be filled with GEM buffer handles. Fresh new GEM handles are always returned, even if another GEM handle referring to the same memory object already exists on the DRM file description. The caller is responsible for removing the new handles, e.g. via the :c:type:`DRM_IOCTL_GEM_CLOSE` IOCTL. The same new handle will be returned for multiple planes in case they use the same memory object. Planes are valid until one has a zero handle -- this can be used to compute the number of planes.h](h#If the client is DRM master or has }(hjg{hhhNhNubh)}(h:c:type:`CAP_SYS_ADMIN`h]j)}(hjq{h]h CAP_SYS_ADMIN}(hjs{hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjo{ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj CAP_SYS_ADMINuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhjg{ubh, }(hjg{hhhNhNubh)}(h5:c:type:`drm_mode_fb_cmd2.handles `h]j)}(hj{h]hdrm_mode_fb_cmd2.handles}(hj{hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhj{hMhjg{ubhX will be filled with GEM buffer handles. Fresh new GEM handles are always returned, even if another GEM handle referring to the same memory object already exists on the DRM file description. The caller is responsible for removing the new handles, e.g. via the }(hjg{hhhNhNubh)}(h:c:type:`DRM_IOCTL_GEM_CLOSE`h]j)}(hj{h]hDRM_IOCTL_GEM_CLOSE}(hj{hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_GEM_CLOSEuh1hhj{hMhjg{ubh IOCTL. The same new handle will be returned for multiple planes in case they use the same memory object. Planes are valid until one has a zero handle -- this can be used to compute the number of planes.}(hjg{hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj{hMhj{ubh)}(hOtherwise, :c:type:`drm_mode_fb_cmd2.handles ` will be zeroed and planes are valid until one has a zero :c:type:`drm_mode_fb_cmd2.pitches `.h](h Otherwise, }(hj{hhhNhNubh)}(h5:c:type:`drm_mode_fb_cmd2.handles `h]j)}(hj{h]hdrm_mode_fb_cmd2.handles}(hj{hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj{ubh: will be zeroed and planes are valid until one has a zero }(hj{hhhNhNubh)}(h5:c:type:`drm_mode_fb_cmd2.pitches `h]j)}(hj |h]hdrm_mode_fb_cmd2.pitches}(hj|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj |ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhj|hMhj{ubh.}(hj{hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj|hMhj{ubh)}(hX<If the framebuffer has a format modifier, :c:type:`DRM_MODE_FB_MODIFIERS` will be set in :c:type:`drm_mode_fb_cmd2.flags ` and :c:type:`drm_mode_fb_cmd2.modifier ` will contain the modifier. Otherwise, user-space must ignore :c:type:`drm_mode_fb_cmd2.modifier `.h](h*If the framebuffer has a format modifier, }(hj4|hhhNhNubh)}(h:c:type:`DRM_MODE_FB_MODIFIERS`h]j)}(hj>|h]hDRM_MODE_FB_MODIFIERS}(hj@|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj<|ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_FB_MODIFIERSuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj4|ubh will be set in }(hj4|hhhNhNubh)}(h3:c:type:`drm_mode_fb_cmd2.flags `h]j)}(hjb|h]hdrm_mode_fb_cmd2.flags}(hjd|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj`|ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhj[|hMhj4|ubh and }(hj4|hhhNhNubh)}(h6:c:type:`drm_mode_fb_cmd2.modifier `h]j)}(hj|h]hdrm_mode_fb_cmd2.modifier}(hj|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhj[|hMhj4|ubh> will contain the modifier. Otherwise, user-space must ignore }(hj4|hhhNhNubh)}(h6:c:type:`drm_mode_fb_cmd2.modifier `h]j)}(hj|h]hdrm_mode_fb_cmd2.modifier}(hj|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_fb_cmd2uh1hhj[|hMhj4|ubh.}(hj4|hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj[|hMhj{ubh)}(hX5To obtain DMA-BUF FDs for each plane without leaking GEM handles, user-space can export each handle via :c:type:`DRM_IOCTL_PRIME_HANDLE_TO_FD`, then immediately close each unique handle via :c:type:`DRM_IOCTL_GEM_CLOSE`, making sure to not double-close handles which are specified multiple times in the array.h](hhTo obtain DMA-BUF FDs for each plane without leaking GEM handles, user-space can export each handle via }(hj|hhhNhNubh)}(h&:c:type:`DRM_IOCTL_PRIME_HANDLE_TO_FD`h]j)}(hj|h]hDRM_IOCTL_PRIME_HANDLE_TO_FD}(hj|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_PRIME_HANDLE_TO_FDuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj|ubh0, then immediately close each unique handle via }(hj|hhhNhNubh)}(h:c:type:`DRM_IOCTL_GEM_CLOSE`h]j)}(hj|h]hDRM_IOCTL_GEM_CLOSE}(hj|hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_GEM_CLOSEuh1hhj|hMhj|ubhZ, making sure to not double-close handles which are specified multiple times in the array.}(hj|hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj|hMhj{ubeh}(h]h ]h"]h$]h&]uh1j$hj{hMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j DRM_IOCTL_MODE_CLOSEFB (C macro)c.DRM_IOCTL_MODE_CLOSEFBhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_MODE_CLOSEFBh]j)}(hDRM_IOCTL_MODE_CLOSEFBh]j)}(hDRM_IOCTL_MODE_CLOSEFBh]j)}(hj=}h]hDRM_IOCTL_MODE_CLOSEFB}(hjG}hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjC}ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj?}hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhj;}hhhjZ}hMubah}(h]j6}ah ](jjeh"]h$]h&]jj)jhuh1jhjZ}hMhj8}hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj8}hhhjZ}hMubeh}(h]h ](jmacroeh"]h$]h&]j jj js}jjs}jjjuh1jhhhj^hj^hNubh)}(h``DRM_IOCTL_MODE_CLOSEFB``h]j)}(hjy}h]hDRM_IOCTL_MODE_CLOSEFB}(hj{}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjw}ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hX Close a framebuffer. **Description** This closes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL argument is a framebuffer object ID. This IOCTL is similar to :c:type:`DRM_IOCTL_MODE_RMFB`, except it doesn't disable planes and CRTCs. As long as the framebuffer is used by a plane, it's kept alive. When the plane no longer uses the framebuffer (because the framebuffer is replaced with another one, or the plane is disabled), the framebuffer is cleaned up. This is useful to implement flicker-free transitions between two processes. Depending on the threat model, user-space may want to ensure that the framebuffer doesn't expose any sensitive user information: closed framebuffers attached to a plane can be read back by the next DRM master. h](j%)}(hClose a framebuffer. h]h)}(hClose a framebuffer.h]hClose a framebuffer.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj}ubah}(h]h ]h"]h$]h&]uh1j$hj}hMhj}ubh)}(h**Description**h]j)}(hj}h]h Description}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj}ubh)}(hkThis closes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL argument is a framebuffer object ID.h]hkThis closes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL argument is a framebuffer object ID.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj}ubh)}(hXBThis IOCTL is similar to :c:type:`DRM_IOCTL_MODE_RMFB`, except it doesn't disable planes and CRTCs. As long as the framebuffer is used by a plane, it's kept alive. When the plane no longer uses the framebuffer (because the framebuffer is replaced with another one, or the plane is disabled), the framebuffer is cleaned up.h](hThis IOCTL is similar to }(hj}hhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_RMFB`h]j)}(hj}h]hDRM_IOCTL_MODE_RMFB}(hj}hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_RMFBuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj}ubhX, except it doesn’t disable planes and CRTCs. As long as the framebuffer is used by a plane, it’s kept alive. When the plane no longer uses the framebuffer (because the framebuffer is replaced with another one, or the plane is disabled), the framebuffer is cleaned up.}(hj}hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj}hMhj}ubh)}(hKThis is useful to implement flicker-free transitions between two processes.h]hKThis is useful to implement flicker-free transitions between two processes.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM hj}ubh)}(hDepending on the threat model, user-space may want to ensure that the framebuffer doesn't expose any sensitive user information: closed framebuffers attached to a plane can be read back by the next DRM master.h]hDepending on the threat model, user-space may want to ensure that the framebuffer doesn’t expose any sensitive user information: closed framebuffers attached to a plane can be read back by the next DRM master.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM hj}ubeh}(h]h ]h"]h$]h&]uh1j$hj}hMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#DRM_IOCTL_SET_CLIENT_NAME (C macro)c.DRM_IOCTL_SET_CLIENT_NAMEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_IOCTL_SET_CLIENT_NAMEh]j)}(hDRM_IOCTL_SET_CLIENT_NAMEh]j)}(hDRM_IOCTL_SET_CLIENT_NAMEh]j)}(hj<~h]hDRM_IOCTL_SET_CLIENT_NAME}(hjF~hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjB~ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj>~hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubah}(h]h ]h"]h$]h&]hhjuh1jjjhj:~hhhjY~hMubah}(h]j5~ah ](jjeh"]h$]h&]jj)jhuh1jhjY~hMhj7~hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj7~hhhjY~hMubeh}(h]h ](jmacroeh"]h$]h&]j jj jr~jjr~jjjuh1jhhhj^hj^hNubh)}(h``DRM_IOCTL_SET_CLIENT_NAME``h]j)}(hjx~h]hDRM_IOCTL_SET_CLIENT_NAME}(hjz~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjv~ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj^hhubj%)}(hX  Attach a name to a drm_file **Description** Having a name allows for easier tracking and debugging. The length of the name (without null ending char) must be <= DRM_CLIENT_NAME_MAX_LEN. The call will fail if the name contains whitespaces or non-printable chars. h](j%)}(hAttach a name to a drm_file h]h)}(hAttach a name to a drm_fileh]hAttach a name to a drm_file}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj~ubah}(h]h ]h"]h$]h&]uh1j$hj~hMhj~ubh)}(h**Description**h]j)}(hj~h]h Description}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj~ubh)}(hHaving a name allows for easier tracking and debugging. The length of the name (without null ending char) must be <= DRM_CLIENT_NAME_MAX_LEN. The call will fail if the name contains whitespaces or non-printable chars.h]hHaving a name allows for easier tracking and debugging. The length of the name (without null ending char) must be <= DRM_CLIENT_NAME_MAX_LEN. The call will fail if the name contains whitespaces or non-printable chars.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMhj~ubeh}(h]h ]h"]h$]h&]uh1j$hj~hMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_event (C struct) c.drm_eventhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(h drm_eventh]j)}(hstruct drm_eventh](j@)}(hjCh]hstruct}(hj~hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj~hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMubj)}(h h]h }(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~hhhj~hMubj)}(h drm_eventh]j)}(hj~h]h drm_event}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj~hhhj~hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj~hhhj~hMubah}(h]j~ah ](jjeh"]h$]h&]jj)jhuh1jhj~hMhj~hhubj)}(hhh]h)}(hHeader for DRM eventsh]hHeader for DRM events}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM(hj0hhubah}(h]h ]h"]h$]h&]uh1jhj~hhhj~hMubeh}(h]h ](jstructeh"]h$]h&]j jj jKjjKjjjuh1jhhhj^hj^hNubj)}(h**Definition**:: struct drm_event { __u32 type; __u32 length; }; **Members** ``type`` event type. ``length`` total number of payload bytes (including header).h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubh:}(hjShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM,hjOubj )}(h7struct drm_event { __u32 type; __u32 length; };h]h7struct drm_event { __u32 type; __u32 length; };}hjpsbah}(h]h ]h"]h$]h&]hhuh1j hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM.hjOubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM3hjOubj1)}(hhh](j6)}(h``type`` event type. h](j<)}(h``type``h]j)}(hjh]htype}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM*hjubjV)}(hhh]h)}(h event type.h]h event type.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM*hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhM*hjubj6)}(h<``length`` total number of payload bytes (including header).h](j<)}(h ``length``h]j)}(hjh]hlength}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM*hjubjV)}(hhh]h)}(h1total number of payload bytes (including header).h]h1total number of payload bytes (including header).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM+hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhM*hjubeh}(h]h ]h"]h$]h&]uh1j0hjOubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhj^hNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM.hj^hhubh)}(hThis struct is a header for events written back to user-space on the DRM FD. A read on the DRM FD will always only return complete events: e.g. if the read buffer is 100 bytes large and there are two 64 byte events pending, only one will be returned.h]hThis struct is a header for events written back to user-space on the DRM FD. A read on the DRM FD will always only return complete events: e.g. if the read buffer is 100 bytes large and there are two 64 byte events pending, only one will be returned.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM,hj^hhubh)}(hEvent types 0 - 0x7fffffff are generic DRM events, 0x80000000 and up are chipset specific. Generic DRM events include :c:type:`DRM_EVENT_VBLANK`, :c:type:`DRM_EVENT_FLIP_COMPLETE` and :c:type:`DRM_EVENT_CRTC_SEQUENCE`.h](hvEvent types 0 - 0x7fffffff are generic DRM events, 0x80000000 and up are chipset specific. Generic DRM events include }(hjAhhhNhNubh)}(h:c:type:`DRM_EVENT_VBLANK`h]j)}(hjKh]hDRM_EVENT_VBLANK}(hjMhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_EVENT_VBLANKuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM1hjAubh, }(hjAhhhNhNubh)}(h!:c:type:`DRM_EVENT_FLIP_COMPLETE`h]j)}(hjoh]hDRM_EVENT_FLIP_COMPLETE}(hjqhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_EVENT_FLIP_COMPLETEuh1hhjhhM1hjAubh and }(hjAhhhNhNubh)}(h!:c:type:`DRM_EVENT_CRTC_SEQUENCE`h]j)}(hjh]hDRM_EVENT_CRTC_SEQUENCE}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_EVENT_CRTC_SEQUENCEuh1hhjhhM1hjAubh.}(hjAhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhhM1hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_EVENT_VBLANK (C macro)c.DRM_EVENT_VBLANKhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_EVENT_VBLANKh]j)}(hDRM_EVENT_VBLANKh]j)}(hDRM_EVENT_VBLANKh]j)}(hj̀h]hDRM_EVENT_VBLANK}(hjրhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjҀubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj΀hhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMBubah}(h]h ]h"]h$]h&]hhjuh1jjjhjʀhhhjhMBubah}(h]jŀah ](jjeh"]h$]h&]jj)jhuh1jhjhMBhjǀhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjǀhhhjhMBubeh}(h]h ](jmacroeh"]h$]h&]j jj jjjjjjuh1jhhhj^hj^hNubh)}(h``DRM_EVENT_VBLANK``h]j)}(hjh]hDRM_EVENT_VBLANK}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMDhj^hhubj%)}(h vertical blanking event **Description** This event is sent in response to :c:type:`DRM_IOCTL_WAIT_VBLANK` with the :c:type:`_DRM_VBLANK_EVENT` flag set. The event payload is a struct drm_event_vblank. h](j%)}(hvertical blanking event h]h)}(hvertical blanking eventh]hvertical blanking event}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM;hj"ubah}(h]h ]h"]h$]h&]uh1j$hj4hM;hjubh)}(h**Description**h]j)}(hj=h]h Description}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM=hjubh)}(hpThis event is sent in response to :c:type:`DRM_IOCTL_WAIT_VBLANK` with the :c:type:`_DRM_VBLANK_EVENT` flag set.h](h"This event is sent in response to }(hjShhhNhNubh)}(h:c:type:`DRM_IOCTL_WAIT_VBLANK`h]j)}(hj]h]hDRM_IOCTL_WAIT_VBLANK}(hj_hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_WAIT_VBLANKuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM<hjSubh with the }(hjShhhNhNubh)}(h:c:type:`_DRM_VBLANK_EVENT`h]j)}(hjh]h_DRM_VBLANK_EVENT}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj_DRM_VBLANK_EVENTuh1hhjzhM<hjSubh flag set.}(hjShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhM<hjubh)}(h/The event payload is a struct drm_event_vblank.h]h/The event payload is a struct drm_event_vblank.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhM?hjubeh}(h]h ]h"]h$]h&]uh1j$hj4hM;hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!DRM_EVENT_FLIP_COMPLETE (C macro)c.DRM_EVENT_FLIP_COMPLETEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_EVENT_FLIP_COMPLETEh]j)}(hDRM_EVENT_FLIP_COMPLETEh]j)}(hDRM_EVENT_FLIP_COMPLETEh]j)}(hjЁh]hDRM_EVENT_FLIP_COMPLETE}(hjځhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjցubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjҁhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMKubah}(h]h ]h"]h$]h&]hhjuh1jjjhj΁hhhjhMKubah}(h]jɁah ](jjeh"]h$]h&]jj)jhuh1jhjhMKhjˁhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjˁhhhjhMKubeh}(h]h ](jmacroeh"]h$]h&]j jj jjjjjjuh1jhhhj^hj^hNubh)}(h``DRM_EVENT_FLIP_COMPLETE``h]j)}(hj h]hDRM_EVENT_FLIP_COMPLETE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMMhj^hhubj%)}(h page-flip completion event **Description** This event is sent in response to an atomic commit or legacy page-flip with the :c:type:`DRM_MODE_PAGE_FLIP_EVENT` flag set. The event payload is a struct drm_event_vblank. h](j%)}(hpage-flip completion event h]h)}(hpage-flip completion eventh]hpage-flip completion event}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMDhj&ubah}(h]h ]h"]h$]h&]uh1j$hj8hMDhj"ubh)}(h**Description**h]j)}(hjAh]h Description}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMFhj"ubh)}(h|This event is sent in response to an atomic commit or legacy page-flip with the :c:type:`DRM_MODE_PAGE_FLIP_EVENT` flag set.h](hPThis event is sent in response to an atomic commit or legacy page-flip with the }(hjWhhhNhNubh)}(h":c:type:`DRM_MODE_PAGE_FLIP_EVENT`h]j)}(hjah]hDRM_MODE_PAGE_FLIP_EVENT}(hjchhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PAGE_FLIP_EVENTuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMEhjWubh flag set.}(hjWhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj~hMEhj"ubh)}(h/The event payload is a struct drm_event_vblank.h]h/The event payload is a struct drm_event_vblank.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMHhj"ubeh}(h]h ]h"]h$]h&]uh1j$hj8hMDhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!DRM_EVENT_CRTC_SEQUENCE (C macro)c.DRM_EVENT_CRTC_SEQUENCEhNtauh1jhj^hhhj^hNubj)}(hhh](j)}(hDRM_EVENT_CRTC_SEQUENCEh]j)}(hDRM_EVENT_CRTC_SEQUENCEh]j)}(hDRM_EVENT_CRTC_SEQUENCEh]j)}(hjh]hDRM_EVENT_CRTC_SEQUENCE}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMSubah}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhj΂hMSubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhj΂hMShjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhj΂hMSubeh}(h]h ](jmacroeh"]h$]h&]j jj jjjjjjuh1jhhhj^hj^hNubh)}(h``DRM_EVENT_CRTC_SEQUENCE``h]j)}(hjh]hDRM_EVENT_CRTC_SEQUENCE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMUhj^hhubj%)}(h CRTC sequence event **Description** This event is sent in response to :c:type:`DRM_IOCTL_CRTC_QUEUE_SEQUENCE`. The event payload is a struct drm_event_crtc_sequence. h](j%)}(hCRTC sequence event h]h)}(hCRTC sequence eventh]hCRTC sequence event}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMMhjubah}(h]h ]h"]h$]h&]uh1j$hjhMMhjubh)}(h**Description**h]j)}(hj"h]h Description}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMOhjubh)}(hJThis event is sent in response to :c:type:`DRM_IOCTL_CRTC_QUEUE_SEQUENCE`.h](h"This event is sent in response to }(hj8hhhNhNubh)}(h':c:type:`DRM_IOCTL_CRTC_QUEUE_SEQUENCE`h]j)}(hjBh]hDRM_IOCTL_CRTC_QUEUE_SEQUENCE}(hjDhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_CRTC_QUEUE_SEQUENCEuh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMNhj8ubh.}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj_hMNhjubh)}(h6The event payload is a struct drm_event_crtc_sequence.h]h6The event payload is a struct drm_event_crtc_sequence.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:684: ./include/uapi/drm/drm.hhMPhjubeh}(h]h ]h"]h$]h&]uh1j$hjhMMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_modeinfo (C struct)c.drm_mode_modeinfohNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_modeinfoh]j)}(hstruct drm_mode_modeinfoh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKubj)}(hdrm_mode_modeinfoh]j)}(hjh]hdrm_mode_modeinfo}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjhKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjhKhjhhubj)}(hhh]h)}(hDisplay mode information.h]hDisplay mode information.}(hjڃhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj׃hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKubeh}(h]h ](jstructeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubj)}(hX**Definition**:: struct drm_mode_modeinfo { __u32 clock; __u16 hdisplay; __u16 hsync_start; __u16 hsync_end; __u16 htotal; __u16 hskew; __u16 vdisplay; __u16 vsync_start; __u16 vsync_end; __u16 vtotal; __u16 vscan; __u32 vrefresh; __u32 flags; __u32 type; char name[DRM_DISPLAY_MODE_LEN]; }; **Members** ``clock`` pixel clock in kHz ``hdisplay`` horizontal display size ``hsync_start`` horizontal sync start ``hsync_end`` horizontal sync end ``htotal`` horizontal total size ``hskew`` horizontal skew ``vdisplay`` vertical display size ``vsync_start`` vertical sync start ``vsync_end`` vertical sync end ``vtotal`` vertical total size ``vscan`` vertical scan ``vrefresh`` approximate vertical refresh rate in Hz ``flags`` bitmask of misc. flags, see DRM_MODE_FLAG_* defines ``type`` bitmask of type flags, see DRM_MODE_TYPE_* defines ``name`` string describing the mode resolutionh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubj )}(hXNstruct drm_mode_modeinfo { __u32 clock; __u16 hdisplay; __u16 hsync_start; __u16 hsync_end; __u16 htotal; __u16 hskew; __u16 vdisplay; __u16 vsync_start; __u16 vsync_end; __u16 vtotal; __u16 vscan; __u32 vrefresh; __u32 flags; __u32 type; char name[DRM_DISPLAY_MODE_LEN]; };h]hXNstruct drm_mode_modeinfo { __u32 clock; __u16 hdisplay; __u16 hsync_start; __u16 hsync_end; __u16 htotal; __u16 hskew; __u16 vdisplay; __u16 vsync_start; __u16 vsync_end; __u16 vtotal; __u16 vscan; __u32 vrefresh; __u32 flags; __u32 type; char name[DRM_DISPLAY_MODE_LEN]; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubh)}(h **Members**h]j)}(hj(h]hMembers}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubj1)}(hhh](j6)}(h``clock`` pixel clock in kHz h](j<)}(h ``clock``h]j)}(hjGh]hclock}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjAubjV)}(hhh]h)}(hpixel clock in kHzh]hpixel clock in kHz}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\hKhj]ubah}(h]h ]h"]h$]h&]uh1jUhjAubeh}(h]h ]h"]h$]h&]uh1j5hj\hKhj>ubj6)}(h%``hdisplay`` horizontal display size h](j<)}(h ``hdisplay``h]j)}(hjh]hhdisplay}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjzubjV)}(hhh]h)}(hhorizontal display sizeh]hhorizontal display size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjzubeh}(h]h ]h"]h$]h&]uh1j5hjhKhj>ubj6)}(h&``hsync_start`` horizontal sync start h](j<)}(h``hsync_start``h]j)}(hjh]h hsync_start}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hhorizontal sync starth]hhorizontal sync start}(hj҄hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj΄hKhjτubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj΄hKhj>ubj6)}(h"``hsync_end`` horizontal sync end h](j<)}(h ``hsync_end``h]j)}(hjh]h hsync_end}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hhorizontal sync endh]hhorizontal sync end}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhj>ubj6)}(h!``htotal`` horizontal total size h](j<)}(h ``htotal``h]j)}(hj+h]hhtotal}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj%ubjV)}(hhh]h)}(hhorizontal total sizeh]hhorizontal total size}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hKhjAubah}(h]h ]h"]h$]h&]uh1jUhj%ubeh}(h]h ]h"]h$]h&]uh1j5hj@hKhj>ubj6)}(h``hskew`` horizontal skew h](j<)}(h ``hskew``h]j)}(hjdh]hhskew}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^ubjV)}(hhh]h)}(hhorizontal skewh]hhorizontal skew}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhKhjzubah}(h]h ]h"]h$]h&]uh1jUhj^ubeh}(h]h ]h"]h$]h&]uh1j5hjyhKhj>ubj6)}(h#``vdisplay`` vertical display size h](j<)}(h ``vdisplay``h]j)}(hjh]hvdisplay}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hvertical display sizeh]hvertical display size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhj>ubj6)}(h$``vsync_start`` vertical sync start h](j<)}(h``vsync_start``h]j)}(hjօh]h vsync_start}(hj؅hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjԅubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjЅubjV)}(hhh]h)}(hvertical sync starth]hvertical sync start}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjЅubeh}(h]h ]h"]h$]h&]uh1j5hjhKhj>ubj6)}(h ``vsync_end`` vertical sync end h](j<)}(h ``vsync_end``h]j)}(hjh]h vsync_end}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj ubjV)}(hhh]h)}(hvertical sync endh]hvertical sync end}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hKhj%ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hj$hKhj>ubj6)}(h``vtotal`` vertical total size h](j<)}(h ``vtotal``h]j)}(hjHh]hvtotal}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjBubjV)}(hhh]h)}(hvertical total sizeh]hvertical total size}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]hKhj^ubah}(h]h ]h"]h$]h&]uh1jUhjBubeh}(h]h ]h"]h$]h&]uh1j5hj]hKhj>ubj6)}(h``vscan`` vertical scan h](j<)}(h ``vscan``h]j)}(hjh]hvscan}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj{ubjV)}(hhh]h)}(h vertical scanh]h vertical scan}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhj{ubeh}(h]h ]h"]h$]h&]uh1j5hjhKhj>ubj6)}(h5``vrefresh`` approximate vertical refresh rate in Hz h](j<)}(h ``vrefresh``h]j)}(hjh]hvrefresh}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h'approximate vertical refresh rate in Hzh]h'approximate vertical refresh rate in Hz}(hjӆhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjφhKhjІubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjφhKhj>ubj6)}(h>``flags`` bitmask of misc. flags, see DRM_MODE_FLAG_* defines h](j<)}(h ``flags``h]j)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h3bitmask of misc. flags, see DRM_MODE_FLAG_* definesh]h3bitmask of misc. flags, see DRM_MODE_FLAG_* defines}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhj ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhj>ubj6)}(h<``type`` bitmask of type flags, see DRM_MODE_TYPE_* defines h](j<)}(h``type``h]j)}(hj,h]htype}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj&ubjV)}(hhh]h)}(h2bitmask of type flags, see DRM_MODE_TYPE_* definesh]h2bitmask of type flags, see DRM_MODE_TYPE_* defines}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhKhjBubah}(h]h ]h"]h$]h&]uh1jUhj&ubeh}(h]h ]h"]h$]h&]uh1j5hjAhKhj>ubj6)}(h.``name`` string describing the mode resolutionh](j<)}(h``name``h]j)}(hjeh]hname}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj_ubjV)}(hhh]h)}(h%string describing the mode resolutionh]h%string describing the mode resolution}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj{ubah}(h]h ]h"]h$]h&]uh1jUhj_ubeh}(h]h ]h"]h$]h&]uh1j5hjzhKhj>ubeh}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^hhubh)}(hrThis is the user-space API display mode information structure. For the kernel version see struct drm_display_mode.h]hrThis is the user-space API display mode information structure. For the kernel version see struct drm_display_mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_get_plane (C struct)c.drm_mode_get_planehNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_get_planeh]j)}(hstruct drm_mode_get_planeh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKubj)}(hdrm_mode_get_planeh]j)}(hjh]hdrm_mode_get_plane}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjއhhhjhKubah}(h]jهah ](jjeh"]h$]h&]jj)jhuh1jhjhKhjۇhhubj)}(hhh]h)}(hGet plane metadata.h]hGet plane metadata.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM<hj%hhubah}(h]h ]h"]h$]h&]uh1jhjۇhhhjhKubeh}(h]h ](jstructeh"]h$]h&]j jj j@jj@jjjuh1jhhhj^hNhNubj)}(hX[**Definition**:: struct drm_mode_get_plane { __u32 plane_id; __u32 crtc_id; __u32 fb_id; __u32 possible_crtcs; __u32 gamma_size; __u32 count_format_types; __u64 format_type_ptr; }; **Members** ``plane_id`` Object ID of the plane whose information should be retrieved. Set by caller. ``crtc_id`` Object ID of the current CRTC. ``fb_id`` Object ID of the current fb. ``possible_crtcs`` Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. Bit N corresponds to :ref:`CRTC index` N. ``gamma_size`` Never used. ``count_format_types`` Number of formats. ``format_type_ptr`` Pointer to ``__u32`` array of formats that are supported by the plane. These formats do not require modifiers.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubh:}(hjHhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM@hjDubj )}(hstruct drm_mode_get_plane { __u32 plane_id; __u32 crtc_id; __u32 fb_id; __u32 possible_crtcs; __u32 gamma_size; __u32 count_format_types; __u64 format_type_ptr; };h]hstruct drm_mode_get_plane { __u32 plane_id; __u32 crtc_id; __u32 fb_id; __u32 possible_crtcs; __u32 gamma_size; __u32 count_format_types; __u64 format_type_ptr; };}hjesbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMBhjDubh)}(h **Members**h]j)}(hjvh]hMembers}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMLhjDubj1)}(hhh](j6)}(hZ``plane_id`` Object ID of the plane whose information should be retrieved. Set by caller. h](j<)}(h ``plane_id``h]j)}(hjh]hplane_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMMhjubjV)}(hhh]h)}(hLObject ID of the plane whose information should be retrieved. Set by caller.h]hLObject ID of the plane whose information should be retrieved. Set by caller.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMLhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMMhjubj6)}(h+``crtc_id`` Object ID of the current CRTC. h](j<)}(h ``crtc_id``h]j)}(hjψh]hcrtc_id}(hjшhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj͈ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjɈubjV)}(hhh]h)}(hObject ID of the current CRTC.h]hObject ID of the current CRTC.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjɈubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h'``fb_id`` Object ID of the current fb. h](j<)}(h ``fb_id``h]j)}(hjh]hfb_id}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hObject ID of the current fb.h]hObject ID of the current fb.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h``possible_crtcs`` Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. Bit N corresponds to :ref:`CRTC index` N. h](j<)}(h``possible_crtcs``h]j)}(hjAh]hpossible_crtcs}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMZhj;ubjV)}(hhh]h)}(hBitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. Bit N corresponds to :ref:`CRTC index` N.h](hBitmask of CRTC’s compatible with the plane. CRTC’s are created and they receive an index, which corresponds to their position in the bitmask. Bit N corresponds to }(hjZhhhNhNubh)}(h:ref:`CRTC index`h]j<)}(hjdh]h CRTC index}(hjfhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j;hjbubah}(h]h ]h"]h$]h&]refdocj refdomainjpreftyperef refexplicitrefwarnj crtc_indexuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMWhjZubh N.}(hjZhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMWhjWubah}(h]h ]h"]h$]h&]uh1jUhj;ubeh}(h]h ]h"]h$]h&]uh1j5hjVhMZhjubj6)}(h``gamma_size`` Never used. h](j<)}(h``gamma_size``h]j)}(hjh]h gamma_size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h Never used.h]h Never used.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h*``count_format_types`` Number of formats. h](j<)}(h``count_format_types``h]j)}(hj؉h]hcount_format_types}(hjډhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj։ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj҉ubjV)}(hhh]h)}(hNumber of formats.h]hNumber of formats.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhj҉ubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h``format_type_ptr`` Pointer to ``__u32`` array of formats that are supported by the plane. These formats do not require modifiers.h](j<)}(h``format_type_ptr``h]j)}(hjh]hformat_type_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMchj ubjV)}(hhh]h)}(hnPointer to ``__u32`` array of formats that are supported by the plane. These formats do not require modifiers.h](h Pointer to }(hj*hhhNhNubj)}(h ``__u32``h]h__u32}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubhZ array of formats that are supported by the plane. These formats do not require modifiers.}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj&hMchj'ubah}(h]h ]h"]h$]h&]uh1jUhj ubeh}(h]h ]h"]h$]h&]uh1j5hj&hMchjubeh}(h]h ]h"]h$]h&]uh1j0hjDubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjeh]h Description}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMghj^hhubh)}(hMUserspace can perform a GETPLANE ioctl to retrieve information about a plane.h]hMUserspace can perform a GETPLANE ioctl to retrieve information about a plane.}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM=hj^hhubh)}(hTo retrieve the number of formats supported, set **count_format_types** to zero and call the ioctl. **count_format_types** will be updated with the value.h](h1To retrieve the number of formats supported, set }(hjhhhNhNubj)}(h**count_format_types**h]hcount_format_types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh to zero and call the ioctl. }(hjhhhNhNubj)}(h**count_format_types**h]hcount_format_types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be updated with the value.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM@hj^hhubh)}(hXTo retrieve these formats, allocate an array with the memory needed to store **count_format_types** formats. Point **format_type_ptr** to this array and call the ioctl again (with **count_format_types** still set to the value returned in the first ioctl call).h](hMTo retrieve these formats, allocate an array with the memory needed to store }(hjhhhNhNubj)}(h**count_format_types**h]hcount_format_types}(hjŊhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh formats. Point }(hjhhhNhNubj)}(h**format_type_ptr**h]hformat_type_ptr}(hj׊hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. to this array and call the ioctl again (with }(hjhhhNhNubj)}(h**count_format_types**h]hcount_format_types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh: still set to the value returned in the first ioctl call).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMChj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!drm_mode_get_connector (C struct)c.drm_mode_get_connectorhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_get_connectorh]j)}(hstruct drm_mode_get_connectorh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMKubj)}(h h]h }(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhj(hMKubj)}(hdrm_mode_get_connectorh]j)}(hjh]hdrm_mode_get_connector}(hj;hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj7ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhj(hMKubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhj(hMKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhj(hMKhjhhubj)}(hhh]h)}(hGet connector metadata.h]hGet connector metadata.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjZhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj(hMKubeh}(h]h ](jstructeh"]h$]h&]j jj jujjujjjuh1jhhhj^hNhNubj)}(hX**Definition**:: struct drm_mode_get_connector { __u64 encoders_ptr; __u64 modes_ptr; __u64 props_ptr; __u64 prop_values_ptr; __u32 count_modes; __u32 count_props; __u32 count_encoders; __u32 encoder_id; __u32 connector_id; __u32 connector_type; __u32 connector_type_id; __u32 connection; __u32 mm_width; __u32 mm_height; __u32 subpixel; __u32 pad; }; **Members** ``encoders_ptr`` Pointer to ``__u32`` array of object IDs. ``modes_ptr`` Pointer to struct drm_mode_modeinfo array. ``props_ptr`` Pointer to ``__u32`` array of property IDs. ``prop_values_ptr`` Pointer to ``__u64`` array of property values. ``count_modes`` Number of modes. ``count_props`` Number of properties. ``count_encoders`` Number of encoders. ``encoder_id`` Object ID of the current encoder. ``connector_id`` Object ID of the connector. ``connector_type`` Type of the connector. See DRM_MODE_CONNECTOR_* defines. ``connector_type_id`` Type-specific connector number. This is not an object ID. This is a per-type connector number. Each (type, type_id) combination is unique across all connectors of a DRM device. The (type, type_id) combination is not a stable identifier: the type_id can change depending on the driver probe order. ``connection`` Status of the connector. See enum drm_connector_status. ``mm_width`` Width of the connected sink in millimeters. ``mm_height`` Height of the connected sink in millimeters. ``subpixel`` Subpixel order of the connected sink. See enum subpixel_order. ``pad`` Padding, must be zero.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubh:}(hj}hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjyubj )}(hXstruct drm_mode_get_connector { __u64 encoders_ptr; __u64 modes_ptr; __u64 props_ptr; __u64 prop_values_ptr; __u32 count_modes; __u32 count_props; __u32 count_encoders; __u32 encoder_id; __u32 connector_id; __u32 connector_type; __u32 connector_type_id; __u32 connection; __u32 mm_width; __u32 mm_height; __u32 subpixel; __u32 pad; };h]hXstruct drm_mode_get_connector { __u64 encoders_ptr; __u64 modes_ptr; __u64 props_ptr; __u64 prop_values_ptr; __u32 count_modes; __u32 count_props; __u32 count_encoders; __u32 encoder_id; __u32 connector_id; __u32 connector_type; __u32 connector_type_id; __u32 connection; __u32 mm_width; __u32 mm_height; __u32 subpixel; __u32 pad; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjyubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjyubj1)}(hhh](j6)}(h;``encoders_ptr`` Pointer to ``__u32`` array of object IDs. h](j<)}(h``encoders_ptr``h]j)}(hjʋh]h encoders_ptr}(hj̋hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjȋubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjċubjV)}(hhh]h)}(h)Pointer to ``__u32`` array of object IDs.h](h Pointer to }(hjhhhNhNubj)}(h ``__u32``h]h__u32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh array of object IDs.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjߋhMhjubah}(h]h ]h"]h$]h&]uh1jUhjċubeh}(h]h ]h"]h$]h&]uh1j5hjߋhMhjubj6)}(h9``modes_ptr`` Pointer to struct drm_mode_modeinfo array. h](j<)}(h ``modes_ptr``h]j)}(hjh]h modes_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h*Pointer to struct drm_mode_modeinfo array.h]h*Pointer to struct drm_mode_modeinfo array.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hKhj+ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj*hKhjubj6)}(h:``props_ptr`` Pointer to ``__u32`` array of property IDs. h](j<)}(h ``props_ptr``h]j)}(hjNh]h props_ptr}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjHubjV)}(hhh]h)}(h+Pointer to ``__u32`` array of property IDs.h](h Pointer to }(hjghhhNhNubj)}(h ``__u32``h]h__u32}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubh array of property IDs.}(hjghhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjchKhjdubah}(h]h ]h"]h$]h&]uh1jUhjHubeh}(h]h ]h"]h$]h&]uh1j5hjchKhjubj6)}(hC``prop_values_ptr`` Pointer to ``__u64`` array of property values. h](j<)}(h``prop_values_ptr``h]j)}(hjh]hprop_values_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h.Pointer to ``__u64`` array of property values.h](h Pointer to }(hjhhhNhNubj)}(h ``__u64``h]h__u64}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh array of property values.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h!``count_modes`` Number of modes. h](j<)}(h``count_modes``h]j)}(hjh]h count_modes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjތubjV)}(hhh]h)}(hNumber of modes.h]hNumber of modes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjތubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h&``count_props`` Number of properties. h](j<)}(h``count_props``h]j)}(hjh]h count_props}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hNumber of properties.h]hNumber of properties.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hKhj3ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj2hKhjubj6)}(h'``count_encoders`` Number of encoders. h](j<)}(h``count_encoders``h]j)}(hjVh]hcount_encoders}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjPubjV)}(hhh]h)}(hNumber of encoders.h]hNumber of encoders.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhKhjlubah}(h]h ]h"]h$]h&]uh1jUhjPubeh}(h]h ]h"]h$]h&]uh1j5hjkhKhjubj6)}(h1``encoder_id`` Object ID of the current encoder. h](j<)}(h``encoder_id``h]j)}(hjh]h encoder_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h!Object ID of the current encoder.h]h!Object ID of the current encoder.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h-``connector_id`` Object ID of the connector. h](j<)}(h``connector_id``h]j)}(hjȍh]h connector_id}(hjʍhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjƍubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hObject ID of the connector.h]hObject ID of the connector.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjݍhKhjލubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjݍhKhjubj6)}(hM``connector_type`` Type of the connector. See DRM_MODE_CONNECTOR_* defines. h](j<)}(h``connector_type``h]j)}(hjh]hconnector_type}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh](h)}(hType of the connector.h]hType of the connector.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh)}(h!See DRM_MODE_CONNECTOR_* defines.h]h!See DRM_MODE_CONNECTOR_* defines.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubj6)}(hXA``connector_type_id`` Type-specific connector number. This is not an object ID. This is a per-type connector number. Each (type, type_id) combination is unique across all connectors of a DRM device. The (type, type_id) combination is not a stable identifier: the type_id can change depending on the driver probe order. h](j<)}(h``connector_type_id``h]j)}(hjIh]hconnector_type_id}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjCubjV)}(hhh](h)}(hType-specific connector number.h]hType-specific connector number.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj_ubh)}(hThis is not an object ID. This is a per-type connector number. Each (type, type_id) combination is unique across all connectors of a DRM device.h]hThis is not an object ID. This is a per-type connector number. Each (type, type_id) combination is unique across all connectors of a DRM device.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj_ubh)}(hwThe (type, type_id) combination is not a stable identifier: the type_id can change depending on the driver probe order.h]hwThe (type, type_id) combination is not a stable identifier: the type_id can change depending on the driver probe order.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj_ubeh}(h]h ]h"]h$]h&]uh1jUhjCubeh}(h]h ]h"]h$]h&]uh1j5hj^hMhjubj6)}(hH``connection`` Status of the connector. See enum drm_connector_status. h](j<)}(h``connection``h]j)}(hjh]h connection}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh](h)}(hStatus of the connector.h]hStatus of the connector.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh)}(hSee enum drm_connector_status.h]hSee enum drm_connector_status.}(hjɎhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubj6)}(h9``mm_width`` Width of the connected sink in millimeters. h](j<)}(h ``mm_width``h]j)}(hjh]hmm_width}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h+Width of the connected sink in millimeters.h]h+Width of the connected sink in millimeters.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h;``mm_height`` Height of the connected sink in millimeters. h](j<)}(h ``mm_height``h]j)}(hj"h]h mm_height}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h,Height of the connected sink in millimeters.h]h,Height of the connected sink in millimeters.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hKhj8ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj7hKhjubj6)}(hM``subpixel`` Subpixel order of the connected sink. See enum subpixel_order. h](j<)}(h ``subpixel``h]j)}(hj[h]hsubpixel}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjUubjV)}(hhh](h)}(h%Subpixel order of the connected sink.h]h%Subpixel order of the connected sink.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjqubh)}(hSee enum subpixel_order.h]hSee enum subpixel_order.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjphMhjqubeh}(h]h ]h"]h$]h&]uh1jUhjUubeh}(h]h ]h"]h$]h&]uh1j5hjphMhjubj6)}(h``pad`` Padding, must be zero.h](j<)}(h``pad``h]j)}(hjh]hpad}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hPadding, must be zero.h]hPadding, must be zero.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubeh}(h]h ]h"]h$]h&]uh1j0hjyubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^hhubh)}(hX)User-space can perform a GETCONNECTOR ioctl to retrieve information about a connector. User-space is expected to retrieve encoders, modes and properties by performing this ioctl at least twice: the first time to retrieve the number of elements, the second time to retrieve the elements themselves.h]hX)User-space can perform a GETCONNECTOR ioctl to retrieve information about a connector. User-space is expected to retrieve encoders, modes and properties by performing this ioctl at least twice: the first time to retrieve the number of elements, the second time to retrieve the elements themselves.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hTo retrieve the number of elements, set **count_props** and **count_encoders** to zero, set **count_modes** to 1, and set **modes_ptr** to a temporary struct drm_mode_modeinfo element.h](h(To retrieve the number of elements, set }(hj hhhNhNubj)}(h**count_props**h]h count_props}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh and }(hj hhhNhNubj)}(h**count_encoders**h]hcount_encoders}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh to zero, set }(hj hhhNhNubj)}(h**count_modes**h]h count_modes}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh to 1, and set }(hj hhhNhNubj)}(h **modes_ptr**h]h modes_ptr}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh1 to a temporary struct drm_mode_modeinfo element.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hTo retrieve the elements, allocate arrays for **encoders_ptr**, **modes_ptr**, **props_ptr** and **prop_values_ptr**, then set **count_modes**, **count_props** and **count_encoders** to their capacity.h](h.To retrieve the elements, allocate arrays for }(hjbhhhNhNubj)}(h**encoders_ptr**h]h encoders_ptr}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh, }(hjbhhhNhNubj)}(h **modes_ptr**h]h modes_ptr}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh, }(hjbhhhNhNubj)}(h **props_ptr**h]h props_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh and }(hjbhhhNhNubj)}(h**prop_values_ptr**h]hprop_values_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh , then set }(hjbhhhNhNubj)}(h**count_modes**h]h count_modes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh, }hjbsbj)}(h**count_props**h]h count_props}(hjĐhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh and }(hjbhhhNhNubj)}(h**count_encoders**h]hcount_encoders}(hj֐hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh to their capacity.}(hjbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hX$Performing the ioctl only twice may be racy: the number of elements may have changed with a hotplug event in-between the two ioctls. User-space is expected to retry the last ioctl until the number of elements stabilizes. The kernel won't fill any array which doesn't have the expected length.h]hX(Performing the ioctl only twice may be racy: the number of elements may have changed with a hotplug event in-between the two ioctls. User-space is expected to retry the last ioctl until the number of elements stabilizes. The kernel won’t fill any array which doesn’t have the expected length.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(h**Force-probing a connector**h]j)}(hjh]hForce-probing a connector}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hXIf the **count_modes** field is set to zero and the DRM client is the current DRM master, the kernel will perform a forced probe on the connector to refresh the connector status, modes and EDID. A forced-probe can be slow, might cause flickering and the ioctl will block.h](hIf the }(hjhhhNhNubj)}(h**count_modes**h]h count_modes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh field is set to zero and the DRM client is the current DRM master, the kernel will perform a forced probe on the connector to refresh the connector status, modes and EDID. A forced-probe can be slow, might cause flickering and the ioctl will block.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hXUser-space needs to force-probe connectors to ensure their metadata is up-to-date at startup and after receiving a hot-plug event. User-space may perform a forced-probe when the user explicitly requests it. User-space shouldn't perform a forced-probe in other situations.h]hXUser-space needs to force-probe connectors to ensure their metadata is up-to-date at startup and after receiving a hot-plug event. User-space may perform a forced-probe when the user explicitly requests it. User-space shouldn’t perform a forced-probe in other situations.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!drm_mode_property_enum (C struct)c.drm_mode_property_enumhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_property_enumh]j)}(hstruct drm_mode_property_enumh](j@)}(hjCh]hstruct}(hj_hhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj[hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj[hhhjlhMubj)}(hdrm_mode_property_enumh]j)}(hjYh]hdrm_mode_property_enum}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj{ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj[hhhjlhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjWhhhjlhMubah}(h]jRah ](jjeh"]h$]h&]jj)jhuh1jhjlhMhjThhubj)}(hhh]h)}(h'Description for an enum/bitfield entry.h]h'Description for an enum/bitfield entry.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM$hjhhubah}(h]h ]h"]h$]h&]uh1jhjThhhjlhMubeh}(h]h ](jstructeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubj)}(h**Definition**:: struct drm_mode_property_enum { __u64 value; char name[DRM_PROP_NAME_LEN]; }; **Members** ``value`` numeric value for this enum entry. ``name`` symbolic name for this enum entry.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjőhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM(hjubj )}(hUstruct drm_mode_property_enum { __u64 value; char name[DRM_PROP_NAME_LEN]; };h]hUstruct drm_mode_property_enum { __u64 value; char name[DRM_PROP_NAME_LEN]; };}hjޑsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM*hjubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM/hjubj1)}(hhh](j6)}(h-``value`` numeric value for this enum entry. h](j<)}(h ``value``h]j)}(hjh]hvalue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM&hjubjV)}(hhh]h)}(h"numeric value for this enum entry.h]h"numeric value for this enum entry.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hM&hj$ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj#hM&hjubj6)}(h+``name`` symbolic name for this enum entry.h](j<)}(h``name``h]j)}(hjGh]hname}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM&hjAubjV)}(hhh]h)}(h"symbolic name for this enum entry.h]h"symbolic name for this enum entry.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM'hj]ubah}(h]h ]h"]h$]h&]uh1jUhjAubeh}(h]h ]h"]h$]h&]uh1j5hj\hM&hjubeh}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM*hj^hhubh)}(h)See struct drm_property_enum for details.h]h)See struct drm_property_enum for details.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM(hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j drm_mode_get_property (C struct)c.drm_mode_get_propertyhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_get_propertyh]j)}(hstruct drm_mode_get_propertyh](j@)}(hjCh]hstruct}(hjȒhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjĒhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM-ubj)}(h h]h }(hj֒hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjĒhhhjՒhM-ubj)}(hdrm_mode_get_propertyh]j)}(hj’h]hdrm_mode_get_property}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjĒhhhjՒhM-ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjՒhM-ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjՒhM-hjhhubj)}(hhh]h)}(hGet property metadata.h]hGet property metadata.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM0hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjՒhM-ubeh}(h]h ](jstructeh"]h$]h&]j jj j"jj"jjjuh1jhhhj^hNhNubj)}(hX"**Definition**:: struct drm_mode_get_property { __u64 values_ptr; __u64 enum_blob_ptr; __u32 prop_id; __u32 flags; char name[DRM_PROP_NAME_LEN]; __u32 count_values; __u32 count_enum_blobs; }; **Members** ``values_ptr`` Pointer to a ``__u64`` array. ``enum_blob_ptr`` Pointer to a struct drm_mode_property_enum array. ``prop_id`` Object ID of the property which should be retrieved. Set by the caller. ``flags`` ``DRM_MODE_PROP_*`` bitfield. See :c:type:`drm_property.flags ` for a definition of the flags. ``name`` Symbolic property name. User-space should use this field to recognize properties. ``count_values`` Number of elements in **values_ptr**. ``count_enum_blobs`` Number of elements in **enum_blob_ptr**.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubh:}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM4hj&ubj )}(hstruct drm_mode_get_property { __u64 values_ptr; __u64 enum_blob_ptr; __u32 prop_id; __u32 flags; char name[DRM_PROP_NAME_LEN]; __u32 count_values; __u32 count_enum_blobs; };h]hstruct drm_mode_get_property { __u64 values_ptr; __u64 enum_blob_ptr; __u32 prop_id; __u32 flags; char name[DRM_PROP_NAME_LEN]; __u32 count_values; __u32 count_enum_blobs; };}hjGsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM6hj&ubh)}(h **Members**h]j)}(hjXh]hMembers}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjVubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM@hj&ubj1)}(hhh](j6)}(h-``values_ptr`` Pointer to a ``__u64`` array. h](j<)}(h``values_ptr``h]j)}(hjwh]h values_ptr}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMOhjqubjV)}(hhh]h)}(hPointer to a ``__u64`` array.h](h Pointer to a }(hjhhhNhNubj)}(h ``__u64``h]h__u64}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh array.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMOhjubah}(h]h ]h"]h$]h&]uh1jUhjqubeh}(h]h ]h"]h$]h&]uh1j5hjhMOhjnubj6)}(hD``enum_blob_ptr`` Pointer to a struct drm_mode_property_enum array. h](j<)}(h``enum_blob_ptr``h]j)}(hj“h]h enum_blob_ptr}(hjēhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h1Pointer to a struct drm_mode_property_enum array.h]h1Pointer to a struct drm_mode_property_enum array.}(hjۓhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjדhKhjؓubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjדhKhjnubj6)}(hT``prop_id`` Object ID of the property which should be retrieved. Set by the caller. h](j<)}(h ``prop_id``h]j)}(hjh]hprop_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMWhjubjV)}(hhh]h)}(hGObject ID of the property which should be retrieved. Set by the caller.h]hGObject ID of the property which should be retrieved. Set by the caller.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMVhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMWhjnubj6)}(hw``flags`` ``DRM_MODE_PROP_*`` bitfield. See :c:type:`drm_property.flags ` for a definition of the flags. h](j<)}(h ``flags``h]j)}(hj5h]hflags}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM\hj/ubjV)}(hhh]h)}(hl``DRM_MODE_PROP_*`` bitfield. See :c:type:`drm_property.flags ` for a definition of the flags.h](j)}(h``DRM_MODE_PROP_*``h]hDRM_MODE_PROP_*}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubh bitfield. See }(hjNhhhNhNubh)}(h+:c:type:`drm_property.flags `h]j)}(hjfh]hdrm_property.flags}(hjhhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_propertyuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM[hjNubh for a definition of the flags.}(hjNhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhM[hjKubah}(h]h ]h"]h$]h&]uh1jUhj/ubeh}(h]h ]h"]h$]h&]uh1j5hjJhM\hjnubj6)}(h[``name`` Symbolic property name. User-space should use this field to recognize properties. h](j<)}(h``name``h]j)}(hjh]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMahjubjV)}(hhh]h)}(hQSymbolic property name. User-space should use this field to recognize properties.h]hQSymbolic property name. User-space should use this field to recognize properties.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM`hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMahjnubj6)}(h7``count_values`` Number of elements in **values_ptr**. h](j<)}(h``count_values``h]j)}(hjڔh]h count_values}(hjܔhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjؔubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjԔubjV)}(hhh]h)}(h%Number of elements in **values_ptr**.h](hNumber of elements in }(hjhhhNhNubj)}(h**values_ptr**h]h values_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjԔubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjnubj6)}(h=``count_enum_blobs`` Number of elements in **enum_blob_ptr**.h](j<)}(h``count_enum_blobs``h]j)}(hj%h]hcount_enum_blobs}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h(Number of elements in **enum_blob_ptr**.h](hNumber of elements in }(hj>hhhNhNubj)}(h**enum_blob_ptr**h]h enum_blob_ptr}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubh.}(hj>hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj;ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj:hKhjnubeh}(h]h ]h"]h$]h&]uh1j0hj&ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjzh]h Description}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^hhubh)}(hUser-space can perform a GETPROPERTY ioctl to retrieve information about a property. The same property may be attached to multiple objects, see "Modeset Base Object Abstraction".h]hUser-space can perform a GETPROPERTY ioctl to retrieve information about a property. The same property may be attached to multiple objects, see “Modeset Base Object Abstraction”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM1hj^hhubh)}(hThe meaning of the **values_ptr** field changes depending on the property type. See :c:type:`drm_property.flags ` for more details.h](hThe meaning of the }(hjhhhNhNubj)}(h**values_ptr**h]h values_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh3 field changes depending on the property type. See }(hjhhhNhNubh)}(h+:c:type:`drm_property.flags `h]j)}(hjh]hdrm_property.flags}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXj drm_propertyuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM5hjubh for more details.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjؕhM5hj^hhubh)}(hXThe **enum_blob_ptr** and **count_enum_blobs** fields are only meaningful when the property has the type :c:type:`DRM_MODE_PROP_ENUM` or :c:type:`DRM_MODE_PROP_BITMASK`. For backwards compatibility, the kernel will always set **count_enum_blobs** to zero when the property has the type :c:type:`DRM_MODE_PROP_BLOB`. User-space must ignore these two fields if the property has a different type.h](hThe }(hjhhhNhNubj)}(h**enum_blob_ptr**h]h enum_blob_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h**count_enum_blobs**h]hcount_enum_blobs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh; fields are only meaningful when the property has the type }(hjhhhNhNubh)}(h:c:type:`DRM_MODE_PROP_ENUM`h]j)}(hjh]hDRM_MODE_PROP_ENUM}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_ENUMuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM8hjubh or }(hjhhhNhNubh)}(h:c:type:`DRM_MODE_PROP_BITMASK`h]j)}(hj5h]hDRM_MODE_PROP_BITMASK}(hj7hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_BITMASKuh1hhj.hM8hjubh:. For backwards compatibility, the kernel will always set }(hjhhhNhNubj)}(h**count_enum_blobs**h]hcount_enum_blobs}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh( to zero when the property has the type }(hjhhhNhNubh)}(h:c:type:`DRM_MODE_PROP_BLOB`h]j)}(hjjh]hDRM_MODE_PROP_BLOB}(hjlhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_BLOBuh1hhj.hM8hjubhO. User-space must ignore these two fields if the property has a different type.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj.hM8hj^hhubh)}(hUser-space is expected to retrieve values and enums by performing this ioctl at least twice: the first time to retrieve the number of elements, the second time to retrieve the elements themselves.h]hUser-space is expected to retrieve values and enums by performing this ioctl at least twice: the first time to retrieve the number of elements, the second time to retrieve the elements themselves.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM>hj^hhubh)}(hX9To retrieve the number of elements, set **count_values** and **count_enum_blobs** to zero, then call the ioctl. **count_values** will be updated with the number of elements. If the property has the type :c:type:`DRM_MODE_PROP_ENUM` or :c:type:`DRM_MODE_PROP_BITMASK`, **count_enum_blobs** will be updated as well.h](h(To retrieve the number of elements, set }(hjhhhNhNubj)}(h**count_values**h]h count_values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h**count_enum_blobs**h]hcount_enum_blobs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh to zero, then call the ioctl. }(hjhhhNhNubj)}(h**count_values**h]h count_values}(hj̖hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhK will be updated with the number of elements. If the property has the type }(hjhhhNhNubh)}(h:c:type:`DRM_MODE_PROP_ENUM`h]j)}(hjh]hDRM_MODE_PROP_ENUM}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjޖubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_ENUMuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMBhjubh or }(hjhhhNhNubh)}(h:c:type:`DRM_MODE_PROP_BITMASK`h]j)}(hjh]hDRM_MODE_PROP_BITMASK}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_BITMASKuh1hhjhMBhjubh, }(hjhhhNhNubj)}(h**count_enum_blobs**h]hcount_enum_blobs}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be updated as well.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMBhj^hhubh)}(hXUTo retrieve the elements themselves, allocate an array for **values_ptr** and set **count_values** to its capacity. If the property has the type :c:type:`DRM_MODE_PROP_ENUM` or :c:type:`DRM_MODE_PROP_BITMASK`, allocate an array for **enum_blob_ptr** and set **count_enum_blobs** to its capacity. Calling the ioctl again will fill the arrays.h](h;To retrieve the elements themselves, allocate an array for }(hj=hhhNhNubj)}(h**values_ptr**h]h values_ptr}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh and set }(hj=hhhNhNubj)}(h**count_values**h]h count_values}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh/ to its capacity. If the property has the type }(hj=hhhNhNubh)}(h:c:type:`DRM_MODE_PROP_ENUM`h]j)}(hjkh]hDRM_MODE_PROP_ENUM}(hjmhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_ENUMuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMGhj=ubh or }(hj=hhhNhNubh)}(h:c:type:`DRM_MODE_PROP_BITMASK`h]j)}(hjh]hDRM_MODE_PROP_BITMASK}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_PROP_BITMASKuh1hhjhMGhj=ubh, allocate an array for }(hj=hhhNhNubj)}(h**enum_blob_ptr**h]h enum_blob_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh and set }(hj=hhhNhNubj)}(h**count_enum_blobs**h]hcount_enum_blobs}(hj—hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh? to its capacity. Calling the ioctl again will fill the arrays.}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMGhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_fb_cmd2 (C struct)c.drm_mode_fb_cmd2hNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_fb_cmd2h]j)}(hstruct drm_mode_fb_cmd2h](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMPubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMPubj)}(hdrm_mode_fb_cmd2h]j)}(hjh]hdrm_mode_fb_cmd2}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjhMPubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjhMPubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjhMPhjhhubj)}(hhh]h)}(hFrame-buffer metadata.h]hFrame-buffer metadata.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj2hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMPubeh}(h]h ](jstructeh"]h$]h&]j jj jMjjMjjjuh1jhhhj^hNhNubj)}(hX(**Definition**:: struct drm_mode_fb_cmd2 { __u32 fb_id; __u32 width; __u32 height; __u32 pixel_format; __u32 flags; __u32 handles[4]; __u32 pitches[4]; __u32 offsets[4]; __u64 modifier[4]; }; **Members** ``fb_id`` Object ID of the frame-buffer. ``width`` Width of the frame-buffer. ``height`` Height of the frame-buffer. ``pixel_format`` FourCC format code, see ``DRM_FORMAT_*`` constants in ``drm_fourcc.h``. ``flags`` Frame-buffer flags (see :c:type:`DRM_MODE_FB_INTERLACED` and :c:type:`DRM_MODE_FB_MODIFIERS`). ``handles`` GEM buffer handle, one per plane. Set to 0 if the plane is unused. The same handle can be used for multiple planes. ``pitches`` Pitch (aka. stride) in bytes, one per plane. ``offsets`` Offset into the buffer in bytes, one per plane. ``modifier`` Format modifier, one per plane. See ``DRM_FORMAT_MOD_*`` constants in ``drm_fourcc.h``. All planes must use the same modifier. Ignored unless :c:type:`DRM_MODE_FB_MODIFIERS` is set in **flags**.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubh:}(hjUhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjQubj )}(hstruct drm_mode_fb_cmd2 { __u32 fb_id; __u32 width; __u32 height; __u32 pixel_format; __u32 flags; __u32 handles[4]; __u32 pitches[4]; __u32 offsets[4]; __u64 modifier[4]; };h]hstruct drm_mode_fb_cmd2 { __u32 fb_id; __u32 width; __u32 height; __u32 pixel_format; __u32 flags; __u32 handles[4]; __u32 pitches[4]; __u32 offsets[4]; __u64 modifier[4]; };}hjrsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjQubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjQubj1)}(hhh](j6)}(h)``fb_id`` Object ID of the frame-buffer. h](j<)}(h ``fb_id``h]j)}(hjh]hfb_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh]h)}(hObject ID of the frame-buffer.h]hObject ID of the frame-buffer.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubj6)}(h%``width`` Width of the frame-buffer. h](j<)}(h ``width``h]j)}(hjۘh]hwidth}(hjݘhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj٘ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj՘ubjV)}(hhh]h)}(hWidth of the frame-buffer.h]hWidth of the frame-buffer.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhj՘ubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h'``height`` Height of the frame-buffer. h](j<)}(h ``height``h]j)}(hjh]hheight}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hHeight of the frame-buffer.h]hHeight of the frame-buffer.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hKhj*ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj)hKhjubj6)}(hY``pixel_format`` FourCC format code, see ``DRM_FORMAT_*`` constants in ``drm_fourcc.h``. h](j<)}(h``pixel_format``h]j)}(hjMh]h pixel_format}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjGubjV)}(hhh]h)}(hGFourCC format code, see ``DRM_FORMAT_*`` constants in ``drm_fourcc.h``.h](hFourCC format code, see }(hjfhhhNhNubj)}(h``DRM_FORMAT_*``h]h DRM_FORMAT_*}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjfubh constants in }(hjfhhhNhNubj)}(h``drm_fourcc.h``h]h drm_fourcc.h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjfubh.}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjcubah}(h]h ]h"]h$]h&]uh1jUhjGubeh}(h]h ]h"]h$]h&]uh1j5hjbhMhjubj6)}(hi``flags`` Frame-buffer flags (see :c:type:`DRM_MODE_FB_INTERLACED` and :c:type:`DRM_MODE_FB_MODIFIERS`). h](j<)}(h ``flags``h]j)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh]h)}(h^Frame-buffer flags (see :c:type:`DRM_MODE_FB_INTERLACED` and :c:type:`DRM_MODE_FB_MODIFIERS`).h](hFrame-buffer flags (see }(hjęhhhNhNubh)}(h :c:type:`DRM_MODE_FB_INTERLACED`h]j)}(hjΙh]hDRM_MODE_FB_INTERLACED}(hjЙhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj̙ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_FB_INTERLACEDuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjęubh and }(hjęhhhNhNubh)}(h:c:type:`DRM_MODE_FB_MODIFIERS`h]j)}(hjh]hDRM_MODE_FB_MODIFIERS}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_FB_MODIFIERSuh1hhjhMhjęubh).}(hjęhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubj6)}(h``handles`` GEM buffer handle, one per plane. Set to 0 if the plane is unused. The same handle can be used for multiple planes. h](j<)}(h ``handles``h]j)}(hj+h]hhandles}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj%ubjV)}(hhh]h)}(hsGEM buffer handle, one per plane. Set to 0 if the plane is unused. The same handle can be used for multiple planes.h]hsGEM buffer handle, one per plane. Set to 0 if the plane is unused. The same handle can be used for multiple planes.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjAubah}(h]h ]h"]h$]h&]uh1jUhj%ubeh}(h]h ]h"]h$]h&]uh1j5hj@hMhjubj6)}(h9``pitches`` Pitch (aka. stride) in bytes, one per plane. h](j<)}(h ``pitches``h]j)}(hjeh]hpitches}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj_ubjV)}(hhh]h)}(h,Pitch (aka. stride) in bytes, one per plane.h]h,Pitch (aka. stride) in bytes, one per plane.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjzhKhj{ubah}(h]h ]h"]h$]h&]uh1jUhj_ubeh}(h]h ]h"]h$]h&]uh1j5hjzhKhjubj6)}(h<``offsets`` Offset into the buffer in bytes, one per plane. h](j<)}(h ``offsets``h]j)}(hjh]hoffsets}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h/Offset into the buffer in bytes, one per plane.h]h/Offset into the buffer in bytes, one per plane.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h``modifier`` Format modifier, one per plane. See ``DRM_FORMAT_MOD_*`` constants in ``drm_fourcc.h``. All planes must use the same modifier. Ignored unless :c:type:`DRM_MODE_FB_MODIFIERS` is set in **flags**.h](j<)}(h ``modifier``h]j)}(hjךh]hmodifier}(hjٚhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj՚ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjњubjV)}(hhh]h)}(hFormat modifier, one per plane. See ``DRM_FORMAT_MOD_*`` constants in ``drm_fourcc.h``. All planes must use the same modifier. Ignored unless :c:type:`DRM_MODE_FB_MODIFIERS` is set in **flags**.h](h$Format modifier, one per plane. See }(hjhhhNhNubj)}(h``DRM_FORMAT_MOD_*``h]hDRM_FORMAT_MOD_*}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh constants in }(hjhhhNhNubj)}(h``drm_fourcc.h``h]h drm_fourcc.h}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh8. All planes must use the same modifier. Ignored unless }(hjhhhNhNubh)}(h:c:type:`DRM_MODE_FB_MODIFIERS`h]j)}(hjh]hDRM_MODE_FB_MODIFIERS}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_FB_MODIFIERSuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh is set in }(hjhhhNhNubj)}(h **flags**h]hflags}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj;hMhjubah}(h]h ]h"]h$]h&]uh1jUhjњubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubeh}(h]h ]h"]h$]h&]uh1j0hjQubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjsh]h Description}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hFThis struct holds frame-buffer metadata. There are two ways to use it:h]hFThis struct holds frame-buffer metadata. There are two ways to use it:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj+)}(hhh](j0)}(hUser-space can fill this struct and perform a :c:type:`DRM_IOCTL_MODE_ADDFB2` ioctl to register a new frame-buffer. The new frame-buffer object ID will be set by the kernel in **fb_id**.h]h)}(hUser-space can fill this struct and perform a :c:type:`DRM_IOCTL_MODE_ADDFB2` ioctl to register a new frame-buffer. The new frame-buffer object ID will be set by the kernel in **fb_id**.h](h.User-space can fill this struct and perform a }(hjhhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_ADDFB2`h]j)}(hjh]hDRM_IOCTL_MODE_ADDFB2}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_ADDFB2uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubhc ioctl to register a new frame-buffer. The new frame-buffer object ID will be set by the kernel in }(hjhhhNhNubj)}(h **fb_id**h]hfb_id}(hj˛hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjƛhMhjubah}(h]h ]h"]h$]h&]uh1j/hjubj0)}(hUser-space can set **fb_id** and perform a :c:type:`DRM_IOCTL_MODE_GETFB2` ioctl to fetch metadata about an existing frame-buffer. h]h)}(hUser-space can set **fb_id** and perform a :c:type:`DRM_IOCTL_MODE_GETFB2` ioctl to fetch metadata about an existing frame-buffer.h](hUser-space can set }(hjhhhNhNubj)}(h **fb_id**h]hfb_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and perform a }(hjhhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_GETFB2`h]j)}(hj h]hDRM_IOCTL_MODE_GETFB2}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_GETFB2uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh8 ioctl to fetch metadata about an existing frame-buffer.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj&hMhjubah}(h]h ]h"]h$]h&]uh1j/hjubeh}(h]h ]h"]h$]h&]jjuh1j*hjƛhMhj^hhubh)}(hIn case of planar formats, this struct allows up to 4 buffer objects with offsets and pitches per plane. The pitch and offset order are dictated by the format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as:h](hIn case of planar formats, this struct allows up to 4 buffer objects with offsets and pitches per plane. The pitch and offset order are dictated by the format FourCC as defined by }(hj=hhhNhNubj)}(h``drm_fourcc.h``h]h drm_fourcc.h}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh, e.g. NV12 is described as:}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj%)}(hYUV 4:2:0 image with a plane of 8-bit Y samples followed by an interleaved U/V plane containing 8-bit 2x2 subsampled colour difference samples. h]h)}(hYUV 4:2:0 image with a plane of 8-bit Y samples followed by an interleaved U/V plane containing 8-bit 2x2 subsampled colour difference samples.h]hYUV 4:2:0 image with a plane of 8-bit Y samples followed by an interleaved U/V plane containing 8-bit 2x2 subsampled colour difference samples.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^ubah}(h]h ]h"]h$]h&]uh1j$hjphMhj^hhubh)}(hTSo it would consist of a Y plane at ``offsets[0]`` and a UV plane at ``offsets[1]``.h](h$So it would consist of a Y plane at }(hjwhhhNhNubj)}(h``offsets[0]``h]h offsets[0]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubh and a UV plane at }(hjwhhhNhNubj)}(h``offsets[1]``h]h offsets[1]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubh.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hXzTo accommodate tiled, compressed, etc formats, a modifier can be specified. For more information see the "Format Modifiers" section. Note that even though it looks like we have a modifier per-plane, we in fact do not. The modifier for each plane must be identical. Thus all combinations of different data layouts for multi-plane formats must be enumerated as separate modifiers.h]hX~To accommodate tiled, compressed, etc formats, a modifier can be specified. For more information see the “Format Modifiers” section. Note that even though it looks like we have a modifier per-plane, we in fact do not. The modifier for each plane must be identical. Thus all combinations of different data layouts for multi-plane formats must be enumerated as separate modifiers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hX>All of the entries in **handles**, **pitches**, **offsets** and **modifier** must be zero when unused. Warning, for **offsets** and **modifier** zero can't be used to figure out whether the entry is used or not since it's a valid value (a zero offset is common, and a zero modifier is :c:type:`DRM_FORMAT_MOD_LINEAR`).h](hAll of the entries in }(hjhhhNhNubj)}(h **handles**h]hhandles}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h **pitches**h]hpitches}(hjӜhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h **offsets**h]hoffsets}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h **modifier**h]hmodifier}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh( must be zero when unused. Warning, for }(hjhhhNhNubj)}(h **offsets**h]hoffsets}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }hjsbj)}(h **modifier**h]hmodifier}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh zero can’t be used to figure out whether the entry is used or not since it’s a valid value (a zero offset is common, and a zero modifier is }(hjhhhNhNubh)}(h:c:type:`DRM_FORMAT_MOD_LINEAR`h]j)}(hj/h]hDRM_FORMAT_MOD_LINEAR}(hj1hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_FORMAT_MOD_LINEARuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjLhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_plane_size_hint (C struct)c.drm_plane_size_hinthNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_plane_size_hinth]j)}(hstruct drm_plane_size_hinth](j@)}(hjCh]hstruct}(hjphhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjlhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlhhhj}hMubj)}(hdrm_plane_size_hinth]j)}(hjjh]hdrm_plane_size_hint}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjlhhhj}hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhhj}hMubah}(h]jcah ](jjeh"]h$]h&]jj)jhuh1jhj}hMhjehhubj)}(hhh]h)}(hPlane size hintsh]hPlane size hints}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM]hjhhubah}(h]h ]h"]h$]h&]uh1jhjehhhj}hMubeh}(h]h ](jstructeh"]h$]h&]j jj jʝjjʝjjjuh1jhhhj^hNhNubj)}(h**Definition**:: struct drm_plane_size_hint { __u16 width; __u16 height; }; **Members** ``width`` The width of the plane in pixel ``height`` The height of the plane in pixelh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj֝hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjҝubh:}(hjҝhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMahjΝubj )}(hBstruct drm_plane_size_hint { __u16 width; __u16 height; };h]hBstruct drm_plane_size_hint { __u16 width; __u16 height; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMchjΝubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhhjΝubj1)}(hhh](j6)}(h*``width`` The width of the plane in pixel h](j<)}(h ``width``h]j)}(hjh]hwidth}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM_hjubjV)}(hhh]h)}(hThe width of the plane in pixelh]hThe width of the plane in pixel}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hM_hj5ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj4hM_hjubj6)}(h+``height`` The height of the plane in pixelh](j<)}(h ``height``h]j)}(hjXh]hheight}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjVubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM_hjRubjV)}(hhh]h)}(h The height of the plane in pixelh]h The height of the plane in pixel}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM`hjnubah}(h]h ]h"]h$]h&]uh1jUhjRubeh}(h]h ]h"]h$]h&]uh1j5hjmhM_hjubeh}(h]h ]h"]h$]h&]uh1j0hjΝubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMchj^hhubh)}(hSThe plane SIZE_HINTS property blob contains an array of struct drm_plane_size_hint.h]hSThe plane SIZE_HINTS property blob contains an array of struct drm_plane_size_hint.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMahj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!hdr_metadata_infoframe (C struct)c.hdr_metadata_infoframehNtauh1jhj^hhhNhNubj)}(hhh](j)}(hhdr_metadata_infoframeh]j)}(hstruct hdr_metadata_infoframeh](j@)}(hjCh]hstruct}(hjٞhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj՞hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMgubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj՞hhhjhMgubj)}(hhdr_metadata_infoframeh]j)}(hjӞh]hhdr_metadata_infoframe}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj՞hhhjhMgubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjўhhhjhMgubah}(h]j̞ah ](jjeh"]h$]h&]jj)jhuh1jhjhMghjΞhhubj)}(hhh]h)}(hHDR Metadata Infoframe Data.h]hHDR Metadata Infoframe Data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMjhjhhubah}(h]h ]h"]h$]h&]uh1jhjΞhhhjhMgubeh}(h]h ](jstructeh"]h$]h&]j jj j3jj3jjjuh1jhhhj^hNhNubj)}(hXv**Definition**:: struct hdr_metadata_infoframe { __u8 eotf; __u8 metadata_type; struct { __u16 x, y; } display_primaries[3]; struct { __u16 x, y; } white_point; __u16 max_display_mastering_luminance; __u16 min_display_mastering_luminance; __u16 max_cll; __u16 max_fall; }; **Members** ``eotf`` Electro-Optical Transfer Function (EOTF) used in the stream. ``metadata_type`` Static_Metadata_Descriptor_ID. ``display_primaries`` Color Primaries of the Data. These are coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000. **display_primaries.x**: X coordinate of color primary. **display_primaries.y**: Y coordinate of color primary. ``white_point`` White Point of Colorspace Data. These are coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000. **white_point.x**: X coordinate of whitepoint of color primary. **white_point.y**: Y coordinate of whitepoint of color primary. ``max_display_mastering_luminance`` Max Mastering Display Luminance. This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. ``min_display_mastering_luminance`` Min Mastering Display Luminance. This value is coded as an unsigned 16-bit value in units of 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF represents 6.5535 cd/m2. ``max_cll`` Max Content Light Level. This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. ``max_fall`` Max Frame Average Light Level. This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubh:}(hj;hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMnhj7ubj )}(hX7struct hdr_metadata_infoframe { __u8 eotf; __u8 metadata_type; struct { __u16 x, y; } display_primaries[3]; struct { __u16 x, y; } white_point; __u16 max_display_mastering_luminance; __u16 min_display_mastering_luminance; __u16 max_cll; __u16 max_fall; };h]hX7struct hdr_metadata_infoframe { __u8 eotf; __u8 metadata_type; struct { __u16 x, y; } display_primaries[3]; struct { __u16 x, y; } white_point; __u16 max_display_mastering_luminance; __u16 min_display_mastering_luminance; __u16 max_cll; __u16 max_fall; };}hjXsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMphj7ubh)}(h **Members**h]j)}(hjih]hMembers}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj7ubj1)}(hhh](j6)}(hF``eotf`` Electro-Optical Transfer Function (EOTF) used in the stream. h](j<)}(h``eotf``h]j)}(hjh]heotf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMvhjubjV)}(hhh]h)}(h`. h](h)}(h**Description**h]j)}(hjVh]h Description}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjPubh)}(hnBitmask of flags suitable for :c:type:`drm_mode_crtc_page_flip_target.flags `.h](hBitmask of flags suitable for }(hjlhhhNhNubh)}(hO:c:type:`drm_mode_crtc_page_flip_target.flags `h]j)}(hjvh]h$drm_mode_crtc_page_flip_target.flags}(hjxhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_crtc_page_flip_targetuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjlubh.}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMhjPubeh}(h]h ]h"]h$]h&]uh1j$hjkhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_create_dumb (C struct)c.drm_mode_create_dumbhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_create_dumbh]j)}(hstruct drm_mode_create_dumbh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hj˥hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjʥhMubj)}(hdrm_mode_create_dumbh]j)}(hjh]hdrm_mode_create_dumb}(hjݥhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj٥ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjʥhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjʥhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjʥhMhjhhubj)}(hhh]h)}(h%Create a KMS dumb buffer for scanout.h]h%Create a KMS dumb buffer for scanout.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM"hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjʥhMubeh}(h]h ](jstructeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubj)}(hX**Definition**:: struct drm_mode_create_dumb { __u32 height; __u32 width; __u32 bpp; __u32 flags; __u32 handle; __u32 pitch; __u64 size; }; **Members** ``height`` buffer height in pixels ``width`` buffer width in pixels ``bpp`` bits per pixel ``flags`` must be zero ``handle`` buffer object handle ``pitch`` number of bytes between two consecutive lines ``size`` size of the whole buffer in bytesh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM&hjubj )}(hstruct drm_mode_create_dumb { __u32 height; __u32 width; __u32 bpp; __u32 flags; __u32 handle; __u32 pitch; __u64 size; };h]hstruct drm_mode_create_dumb { __u32 height; __u32 width; __u32 bpp; __u32 flags; __u32 handle; __u32 pitch; __u64 size; };}hj<sbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM(hjubh)}(h **Members**h]j)}(hjMh]hMembers}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM2hjubj1)}(hhh](j6)}(h#``height`` buffer height in pixels h](j<)}(h ``height``h]j)}(hjlh]hheight}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM$hjfubjV)}(hhh]h)}(hbuffer height in pixelsh]hbuffer height in pixels}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM$hjubah}(h]h ]h"]h$]h&]uh1jUhjfubeh}(h]h ]h"]h$]h&]uh1j5hjhM$hjcubj6)}(h!``width`` buffer width in pixels h](j<)}(h ``width``h]j)}(hjh]hwidth}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM%hjubjV)}(hhh]h)}(hbuffer width in pixelsh]hbuffer width in pixels}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM%hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhM%hjcubj6)}(h``bpp`` bits per pixel h](j<)}(h``bpp``h]j)}(hjަh]hbpp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjܦubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM&hjئubjV)}(hhh]h)}(hbits per pixelh]hbits per pixel}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM&hjubah}(h]h ]h"]h$]h&]uh1jUhjئubeh}(h]h ]h"]h$]h&]uh1j5hjhM&hjcubj6)}(h``flags`` must be zero h](j<)}(h ``flags``h]j)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM'hjubjV)}(hhh]h)}(h must be zeroh]h must be zero}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hM'hj-ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj,hM'hjcubj6)}(h ``handle`` buffer object handle h](j<)}(h ``handle``h]j)}(hjPh]hhandle}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM(hjJubjV)}(hhh]h)}(hbuffer object handleh]hbuffer object handle}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjehM(hjfubah}(h]h ]h"]h$]h&]uh1jUhjJubeh}(h]h ]h"]h$]h&]uh1j5hjehM(hjcubj6)}(h8``pitch`` number of bytes between two consecutive lines h](j<)}(h ``pitch``h]j)}(hjh]hpitch}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM)hjubjV)}(hhh]h)}(h-number of bytes between two consecutive linesh]h-number of bytes between two consecutive lines}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM)hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhM)hjcubj6)}(h*``size`` size of the whole buffer in bytesh](j<)}(h``size``h]j)}(hj§h]hsize}(hjħhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM)hjubjV)}(hhh]h)}(h!size of the whole buffer in bytesh]h!size of the whole buffer in bytes}(hjۧhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM*hjاubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjקhM)hjcubeh}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM-hj^hhubh)}(hUser-space fills **height**, **width**, **bpp** and **flags**. If the IOCTL succeeds, the kernel fills **handle**, **pitch** and **size**.h](hUser-space fills }(hjhhhNhNubj)}(h **height**h]hheight}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h **width**h]hwidth}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h**bpp**h]hbpp}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h **flags**h]hflags}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh*. If the IOCTL succeeds, the kernel fills }(hjhhhNhNubj)}(h **handle**h]hhandle}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h **pitch**h]hpitch}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }hjsbj)}(h**size**h]hsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM+hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#DRM_MODE_ATOMIC_TEST_ONLY (C macro)c.DRM_MODE_ATOMIC_TEST_ONLYhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hDRM_MODE_ATOMIC_TEST_ONLY^h]j)}(hDRM_MODE_ATOMIC_TEST_ONLYh]j)}(hDRM_MODE_ATOMIC_TEST_ONLYh]j)}(hjh]hDRM_MODE_ATOMIC_TEST_ONLY}(hjŨhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMSubah}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjبhMSubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjبhMShjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhjبhMSubeh}(h]h ](jmacroeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubh)}(h``DRM_MODE_ATOMIC_TEST_ONLY``h]j)}(hjh]hDRM_MODE_ATOMIC_TEST_ONLY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMUhj^hhubj%)}(h**Description** Do not apply the atomic commit, instead check whether the hardware supports this configuration. See :c:type:`drm_mode_config_funcs.atomic_check ` for more details on test-only commits. h](h)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMLhj ubh)}(h_Do not apply the atomic commit, instead check whether the hardware supports this configuration.h]h_Do not apply the atomic commit, instead check whether the hardware supports this configuration.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMLhj ubh)}(hoSee :c:type:`drm_mode_config_funcs.atomic_check ` for more details on test-only commits.h](hSee }(hj8hhhNhNubh)}(hD:c:type:`drm_mode_config_funcs.atomic_check `h]j)}(hjBh]h"drm_mode_config_funcs.atomic_check}(hjDhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_config_funcsuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMOhj8ubh' for more details on test-only commits.}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj_hMOhj ubeh}(h]h ]h"]h$]h&]uh1j$hj(hMLhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"DRM_MODE_ATOMIC_NONBLOCK (C macro)c.DRM_MODE_ATOMIC_NONBLOCKhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hDRM_MODE_ATOMIC_NONBLOCKh]j)}(hDRM_MODE_ATOMIC_NONBLOCKh]j)}(hDRM_MODE_ATOMIC_NONBLOCKh]j)}(hjh]hDRM_MODE_ATOMIC_NONBLOCK}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM\ubah}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjhM\ubah}(h]j|ah ](jjeh"]h$]h&]jj)jhuh1jhjhM\hj~hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj~hhhjhM\ubeh}(h]h ](jmacroeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubh)}(h``DRM_MODE_ATOMIC_NONBLOCK``h]j)}(hjh]hDRM_MODE_ATOMIC_NONBLOCK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM^hj^hhubj%)}(hX**Description** Do not block while applying the atomic commit. The :c:type:`DRM_IOCTL_MODE_ATOMIC` IOCTL returns immediately instead of waiting for the changes to be applied in hardware. Note, the driver will still check that the update can be applied before retuning. h](h)}(h**Description**h]j)}(hj۩h]h Description}(hjݩhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj٩ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMVhjթubh)}(hDo not block while applying the atomic commit. The :c:type:`DRM_IOCTL_MODE_ATOMIC` IOCTL returns immediately instead of waiting for the changes to be applied in hardware. Note, the driver will still check that the update can be applied before retuning.h](h3Do not block while applying the atomic commit. The }(hjhhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_ATOMIC`h]j)}(hjh]hDRM_IOCTL_MODE_ATOMIC}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_ATOMICuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMVhjubh IOCTL returns immediately instead of waiting for the changes to be applied in hardware. Note, the driver will still check that the update can be applied before retuning.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMVhjթubeh}(h]h ]h"]h$]h&]uh1j$hjhMVhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'DRM_MODE_ATOMIC_ALLOW_MODESET (C macro)c.DRM_MODE_ATOMIC_ALLOW_MODESEThNtauh1jhj^hhhNhNubj)}(hhh](j)}(hDRM_MODE_ATOMIC_ALLOW_MODESETh]j)}(hDRM_MODE_ATOMIC_ALLOW_MODESETh]j)}(hDRM_MODE_ATOMIC_ALLOW_MODESETh]j)}(hj<h]hDRM_MODE_ATOMIC_ALLOW_MODESET}(hjFhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjBubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj>hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMqubah}(h]h ]h"]h$]h&]hhjuh1jjjhj:hhhjYhMqubah}(h]j5ah ](jjeh"]h$]h&]jj)jhuh1jhjYhMqhj7hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj7hhhjYhMqubeh}(h]h ](jmacroeh"]h$]h&]j jj jrjjrjjjuh1jhhhj^hNhNubh)}(h!``DRM_MODE_ATOMIC_ALLOW_MODESET``h]j)}(hjxh]hDRM_MODE_ATOMIC_ALLOW_MODESET}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMshj^hhubj%)}(hX**Description** Allow the update to result in temporary or transient visible artifacts while the update is being applied. Applying the update may also take significantly more time than a page flip. All visual artifacts will disappear by the time the update is completed, as signalled through the vblank event's timestamp (see struct drm_event_vblank). This flag must be set when the KMS update might cause visible artifacts. Without this flag such KMS update will return a EINVAL error. What kind of update may cause visible artifacts depends on the driver and the hardware. User-space that needs to know beforehand if an update might cause visible artifacts can use :c:type:`DRM_MODE_ATOMIC_TEST_ONLY` without :c:type:`DRM_MODE_ATOMIC_ALLOW_MODESET` to see if it fails. To the best of the driver's knowledge, visual artifacts are guaranteed to not appear when this flag is not set. Some sinks might display visual artifacts outside of the driver's control. h](h)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM_hjubh)}(hXOAllow the update to result in temporary or transient visible artifacts while the update is being applied. Applying the update may also take significantly more time than a page flip. All visual artifacts will disappear by the time the update is completed, as signalled through the vblank event's timestamp (see struct drm_event_vblank).h]hXQAllow the update to result in temporary or transient visible artifacts while the update is being applied. Applying the update may also take significantly more time than a page flip. All visual artifacts will disappear by the time the update is completed, as signalled through the vblank event’s timestamp (see struct drm_event_vblank).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM_hjubh)}(hXThis flag must be set when the KMS update might cause visible artifacts. Without this flag such KMS update will return a EINVAL error. What kind of update may cause visible artifacts depends on the driver and the hardware. User-space that needs to know beforehand if an update might cause visible artifacts can use :c:type:`DRM_MODE_ATOMIC_TEST_ONLY` without :c:type:`DRM_MODE_ATOMIC_ALLOW_MODESET` to see if it fails.h](hX;This flag must be set when the KMS update might cause visible artifacts. Without this flag such KMS update will return a EINVAL error. What kind of update may cause visible artifacts depends on the driver and the hardware. User-space that needs to know beforehand if an update might cause visible artifacts can use }(hjhhhNhNubh)}(h#:c:type:`DRM_MODE_ATOMIC_TEST_ONLY`h]j)}(hjêh]hDRM_MODE_ATOMIC_TEST_ONLY}(hjŪhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_ATOMIC_TEST_ONLYuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMehjubh without }(hjhhhNhNubh)}(h':c:type:`DRM_MODE_ATOMIC_ALLOW_MODESET`h]j)}(hjh]hDRM_MODE_ATOMIC_ALLOW_MODESET}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_MODE_ATOMIC_ALLOW_MODESETuh1hhjhMehjubh to see if it fails.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMehjubh)}(hTo the best of the driver's knowledge, visual artifacts are guaranteed to not appear when this flag is not set. Some sinks might display visual artifacts outside of the driver's control.h]hTo the best of the driver’s knowledge, visual artifacts are guaranteed to not appear when this flag is not set. Some sinks might display visual artifacts outside of the driver’s control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMlhjubeh}(h]h ]h"]h$]h&]uh1j$hjhM_hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jDRM_MODE_ATOMIC_FLAGS (C macro)c.DRM_MODE_ATOMIC_FLAGShNtauh1jhj^hhhNhNubj)}(hhh](j)}(hDRM_MODE_ATOMIC_FLAGSh]j)}(hDRM_MODE_ATOMIC_FLAGSh]j)}(hDRM_MODE_ATOMIC_FLAGSh]j)}(hj6h]hDRM_MODE_ATOMIC_FLAGS}(hj@hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj<ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj8hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMyubah}(h]h ]h"]h$]h&]hhjuh1jjjhj4hhhjShMyubah}(h]j/ah ](jjeh"]h$]h&]jj)jhuh1jhjShMyhj1hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj1hhhjShMyubeh}(h]h ](jmacroeh"]h$]h&]j jj jljjljjjuh1jhhhj^hNhNubh)}(h``DRM_MODE_ATOMIC_FLAGS``h]j)}(hjrh]hDRM_MODE_ATOMIC_FLAGS}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM{hj^hhubj%)}(h**Description** Bitfield of flags accepted by the :c:type:`DRM_IOCTL_MODE_ATOMIC` IOCTL in :c:type:`drm_mode_atomic.flags `. h](h)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMuhjubh)}(h}Bitfield of flags accepted by the :c:type:`DRM_IOCTL_MODE_ATOMIC` IOCTL in :c:type:`drm_mode_atomic.flags `.h](h"Bitfield of flags accepted by the }(hjhhhNhNubh)}(h:c:type:`DRM_IOCTL_MODE_ATOMIC`h]j)}(hjh]hDRM_IOCTL_MODE_ATOMIC}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_IOCTL_MODE_ATOMICuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMuhjubh IOCTL in }(hjhhhNhNubh)}(h1:c:type:`drm_mode_atomic.flags `h]j)}(hjҫh]hdrm_mode_atomic.flags}(hjԫhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjЫubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjdrm_mode_atomicuh1hhj˫hMuhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj˫hMuhjubeh}(h]h ]h"]h$]h&]uh1j$hjhMuhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_create_blob (C struct)c.drm_mode_create_blobhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_create_blobh]j)}(hstruct drm_mode_create_blobh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM{ubj)}(h h]h }(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhj%hM{ubj)}(hdrm_mode_create_blobh]j)}(hjh]hdrm_mode_create_blob}(hj8hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj4ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhj%hM{ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhj%hM{ubah}(h]j ah ](jjeh"]h$]h&]jj)jhuh1jhj%hM{hj hhubj)}(hhh]h)}(hCreate New blob propertyh]hCreate New blob property}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjWhhubah}(h]h ]h"]h$]h&]uh1jhj hhhj%hM{ubeh}(h]h ](jstructeh"]h$]h&]j jj jrjjrjjjuh1jhhhj^hNhNubj)}(h**Definition**:: struct drm_mode_create_blob { __u64 data; __u32 length; __u32 blob_id; }; **Members** ``data`` Pointer to data to copy. ``length`` Length of data to copy. ``blob_id`` Return: new property ID.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubh:}(hjzhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjvubj )}(hUstruct drm_mode_create_blob { __u64 data; __u32 length; __u32 blob_id; };h]hUstruct drm_mode_create_blob { __u64 data; __u32 length; __u32 blob_id; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjvubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjvubj1)}(hhh](j6)}(h"``data`` Pointer to data to copy. h](j<)}(h``data``h]j)}(hjǬh]hdata}(hjɬhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjŬubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh]h)}(hPointer to data to copy.h]hPointer to data to copy.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjܬhMhjݬubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjܬhMhjubj6)}(h#``length`` Length of data to copy. h](j<)}(h ``length``h]j)}(hjh]hlength}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hLength of data to copy.h]hLength of data to copy.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h$``blob_id`` Return: new property ID.h](j<)}(h ``blob_id``h]j)}(hj9h]hblob_id}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj3ubjV)}(hhh]h)}(hReturn: new property ID.h]hReturn: new property ID.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjOubah}(h]h ]h"]h$]h&]uh1jUhj3ubeh}(h]h ]h"]h$]h&]uh1j5hjNhKhjubeh}(h]h ]h"]h$]h&]uh1j0hjvubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hj|h]h Description}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^hhubh)}(heCreate a new 'blob' data property, copying length bytes from data pointer, and returning new blob ID.h]hiCreate a new ‘blob’ data property, copying length bytes from data pointer, and returning new blob ID.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j drm_mode_destroy_blob (C struct)c.drm_mode_destroy_blobhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_destroy_blobh]j)}(hstruct drm_mode_destroy_blobh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hjȭhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjǭhMubj)}(hdrm_mode_destroy_blobh]j)}(hjh]hdrm_mode_destroy_blob}(hjڭhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj֭ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjǭhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjǭhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjǭhMhjhhubj)}(hhh]h)}(hDestroy user blobh]hDestroy user blob}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjǭhMubeh}(h]h ](jstructeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubj)}(h{**Definition**:: struct drm_mode_destroy_blob { __u32 blob_id; }; **Members** ``blob_id`` blob_id to destroyh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubj )}(h4struct drm_mode_destroy_blob { __u32 blob_id; };h]h4struct drm_mode_destroy_blob { __u32 blob_id; };}hj9sbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh)}(h **Members**h]j)}(hjJh]hMembers}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubj1)}(hhh]j6)}(h``blob_id`` blob_id to destroyh](j<)}(h ``blob_id``h]j)}(hjih]hblob_id}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjcubjV)}(hhh]h)}(hblob_id to destroyh]hblob_id to destroy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubah}(h]h ]h"]h$]h&]uh1jUhjcubeh}(h]h ]h"]h$]h&]uh1j5hj~hMhj`ubah}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(h%Destroy a user-created blob property.h]h%Destroy a user-created blob property.}(hj®hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hXDUser-space can release blobs as soon as they do not need to refer to them by their blob object ID. For instance, if you are using a MODE_ID blob in an atomic commit and you will not make another commit re-using the same ID, you can destroy the blob as soon as the commit has been issued, without waiting for it to complete.h]hXDUser-space can release blobs as soon as they do not need to refer to them by their blob object ID. For instance, if you are using a MODE_ID blob in an atomic commit and you will not make another commit re-using the same ID, you can destroy the blob as soon as the commit has been issued, without waiting for it to complete.}(hjѮhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j drm_mode_create_lease (C struct)c.drm_mode_create_leasehNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_create_leaseh]j)}(hstruct drm_mode_create_leaseh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj)}(hdrm_mode_create_leaseh]j)}(hjh]hdrm_mode_create_lease}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjhMhjhhubj)}(hhh]h)}(h Create leaseh]h Create lease}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj8hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jstructeh"]h$]h&]j jj jSjjSjjjuh1jhhhj^hNhNubj)}(hX**Definition**:: struct drm_mode_create_lease { __u64 object_ids; __u32 object_count; __u32 flags; __u32 lessee_id; __u32 fd; }; **Members** ``object_ids`` Pointer to array of object ids (__u32) ``object_count`` Number of object ids ``flags`` flags for new FD (O_CLOEXEC, etc) ``lessee_id`` Return: unique identifier for lessee. ``fd`` Return: file descriptor to new drm_master fileh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[ubh:}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjWubj )}(hstruct drm_mode_create_lease { __u64 object_ids; __u32 object_count; __u32 flags; __u32 lessee_id; __u32 fd; };h]hstruct drm_mode_create_lease { __u64 object_ids; __u32 object_count; __u32 flags; __u32 lessee_id; __u32 fd; };}hjxsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjWubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjWubj1)}(hhh](j6)}(h6``object_ids`` Pointer to array of object ids (__u32) h](j<)}(h``object_ids``h]j)}(hjh]h object_ids}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh]h)}(h&Pointer to array of object ids (__u32)h]h&Pointer to array of object ids (__u32)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubj6)}(h&``object_count`` Number of object ids h](j<)}(h``object_count``h]j)}(hjh]h object_count}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj߯ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjۯubjV)}(hhh]h)}(hNumber of object idsh]hNumber of object ids}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jUhjۯubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(h,``flags`` flags for new FD (O_CLOEXEC, etc) h](j<)}(h ``flags``h]j)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h!flags for new FD (O_CLOEXEC, etc)h]h!flags for new FD (O_CLOEXEC, etc)}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hKhj0ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hj/hKhjubj6)}(h4``lessee_id`` Return: unique identifier for lessee. h](j<)}(h ``lessee_id``h]j)}(hjSh]h lessee_id}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjMubjV)}(hhh]h)}(h%Return: unique identifier for lessee.h]h%Return: unique identifier for lessee.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhKhjiubah}(h]h ]h"]h$]h&]uh1jUhjMubeh}(h]h ]h"]h$]h&]uh1j5hjhhKhjubj6)}(h5``fd`` Return: file descriptor to new drm_master fileh](j<)}(h``fd``h]j)}(hjh]hfd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(h.Return: file descriptor to new drm_master fileh]h.Return: file descriptor to new drm_master file}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubeh}(h]h ]h"]h$]h&]uh1j0hjWubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjϰh]h Description}(hjѰhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjͰubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhj^hhubh)}(h2Lease mode resources, creating another drm_master.h]h2Lease mode resources, creating another drm_master.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubh)}(hThe **object_ids** array must reference at least one CRTC, one connector and one plane if :c:type:`DRM_CLIENT_CAP_UNIVERSAL_PLANES` is enabled. Alternatively, the lease can be completely empty.h](hThe }(hjhhhNhNubj)}(h**object_ids**h]h object_ids}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhH array must reference at least one CRTC, one connector and one plane if }(hjhhhNhNubh)}(h):c:type:`DRM_CLIENT_CAP_UNIVERSAL_PLANES`h]j)}(hjh]hDRM_CLIENT_CAP_UNIVERSAL_PLANES}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj{jXjDRM_CLIENT_CAP_UNIVERSAL_PLANESuh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh> is enabled. Alternatively, the lease can be completely empty.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj-hMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j drm_mode_list_lessees (C struct)c.drm_mode_list_lesseeshNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_list_lesseesh]j)}(hstruct drm_mode_list_lesseesh](j@)}(hjCh]hstruct}(hjQhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjMhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMhhhj^hMubj)}(hdrm_mode_list_lesseesh]j)}(hjKh]hdrm_mode_list_lessees}(hjqhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjmubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjMhhhj^hMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjIhhhj^hMubah}(h]jDah ](jjeh"]h$]h&]jj)jhuh1jhj^hMhjFhhubj)}(hhh]h)}(h List lesseesh]h List lessees}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjhhubah}(h]h ]h"]h$]h&]uh1jhjFhhhj^hMubeh}(h]h ](jstructeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubj)}(hX**Definition**:: struct drm_mode_list_lessees { __u32 count_lessees; __u32 pad; __u64 lessees_ptr; }; **Members** ``count_lessees`` Number of lessees. On input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data. ``pad`` Padding. ``lessees_ptr`` Pointer to lessees. Pointer to __u64 array of lessee idsh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubj )}(h`struct drm_mode_list_lessees { __u32 count_lessees; __u32 pad; __u64 lessees_ptr; };h]h`struct drm_mode_list_lessees { __u32 count_lessees; __u32 pad; __u64 lessees_ptr; };}hjбsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj߱ubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubj1)}(hhh](j6)}(h``count_lessees`` Number of lessees. On input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data. h](j<)}(h``count_lessees``h]j)}(hjh]h count_lessees}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh](h)}(hNumber of lessees.h]hNumber of lessees.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh)}(hOn input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data.h]hOn input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhMhjubj6)}(h``pad`` Padding. h](j<)}(h``pad``h]j)}(hjIh]hpad}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjCubjV)}(hhh]h)}(hPadding.h]hPadding.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^hKhj_ubah}(h]h ]h"]h$]h&]uh1jUhjCubeh}(h]h ]h"]h$]h&]uh1j5hj^hKhjubj6)}(hI``lessees_ptr`` Pointer to lessees. Pointer to __u64 array of lessee idsh](j<)}(h``lessees_ptr``h]j)}(hjh]h lessees_ptr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM hj|ubjV)}(hhh](h)}(hPointer to lessees.h]hPointer to lessees.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubh)}(h$Pointer to __u64 array of lessee idsh]h$Pointer to __u64 array of lessee ids}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM hjubeh}(h]h ]h"]h$]h&]uh1jUhj|ubeh}(h]h ]h"]h$]h&]uh1j5hjhM hjubeh}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjԲh]h Description}(hjֲhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjҲubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM hj^hhubh)}(hList lesses from a drm_master.h]hList lesses from a drm_master.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_get_lease (C struct)c.drm_mode_get_leasehNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_get_leaseh]j)}(hstruct drm_mode_get_leaseh](j@)}(hjCh]hstruct}(hjhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj)}(hdrm_mode_get_leaseh]j)}(hj h]hdrm_mode_get_lease}(hj2hhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhj.ubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj hhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjhMhjhhubj)}(hhh]h)}(h Get Leaseh]h Get Lease}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjQhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jstructeh"]h$]h&]j jj jljjljjjuh1jhhhj^hNhNubj)}(hX**Definition**:: struct drm_mode_get_lease { __u32 count_objects; __u32 pad; __u64 objects_ptr; }; **Members** ``count_objects`` Number of leased objects. On input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data. ``pad`` Padding. ``objects_ptr`` Pointer to objects. Pointer to __u32 array of object ids.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubh:}(hjthhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjpubj )}(h]struct drm_mode_get_lease { __u32 count_objects; __u32 pad; __u64 objects_ptr; };h]h]struct drm_mode_get_lease { __u32 count_objects; __u32 pad; __u64 objects_ptr; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjpubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjpubj1)}(hhh](j6)}(h``count_objects`` Number of leased objects. On input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data. h](j<)}(h``count_objects``h]j)}(hjh]h count_objects}(hjóhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhjubjV)}(hhh](h)}(hNumber of leased objects.h]hNumber of leased objects.}(hjڳhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj׳ubh)}(hOn input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data.h]hOn input, provides length of the array. On output, provides total number. No more than the input number will be written back, so two calls can be used to get the size and then the data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj׳ubeh}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjֳhMhjubj6)}(h``pad`` Padding. h](j<)}(h``pad``h]j)}(hj h]hpad}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhKhjubjV)}(hhh]h)}(hPadding.h]hPadding.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhj ubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhKhjubj6)}(hJ``objects_ptr`` Pointer to objects. Pointer to __u32 array of object ids.h](j<)}(h``objects_ptr``h]j)}(hjCh]h objects_ptr}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM$hj=ubjV)}(hhh](h)}(hPointer to objects.h]hPointer to objects.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM#hjYubh)}(h%Pointer to __u32 array of object ids.h]h%Pointer to __u32 array of object ids.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM%hjYubeh}(h]h ]h"]h$]h&]uh1jUhj=ubeh}(h]h ]h"]h$]h&]uh1j5hjXhM$hjubeh}(h]h ]h"]h$]h&]uh1j0hjpubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM(hj^hhubh)}(hGet leased objects.h]hGet leased objects.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMhj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j drm_mode_revoke_lease (C struct)c.drm_mode_revoke_leasehNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_revoke_leaseh]j)}(hstruct drm_mode_revoke_leaseh](j@)}(hjCh]hstruct}(hjӴhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjϴhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjϴhhhjhMubj)}(hdrm_mode_revoke_leaseh]j)}(hjʹh]hdrm_mode_revoke_lease}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjϴhhhjhMubeh}(h]h ]h"]h$]h&]hhjuh1jjjhj˴hhhjhMubah}(h]jƴah ](jjeh"]h$]h&]jj)jhuh1jhjhMhjȴhhubj)}(hhh]h)}(h Revoke leaseh]h Revoke lease}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM*hjhhubah}(h]h ]h"]h$]h&]uh1jhjȴhhhjhMubeh}(h]h ](jstructeh"]h$]h&]j jj j-jj-jjjuh1jhhhj^hNhNubj)}(h**Definition**:: struct drm_mode_revoke_lease { __u32 lessee_id; }; **Members** ``lessee_id`` Unique ID of lesseeh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubh:}(hj5hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM.hj1ubj )}(h6struct drm_mode_revoke_lease { __u32 lessee_id; };h]h6struct drm_mode_revoke_lease { __u32 lessee_id; };}hjRsbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM0hj1ubh)}(h **Members**h]j)}(hjch]hMembers}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM4hj1ubj1)}(hhh]j6)}(h!``lessee_id`` Unique ID of lesseeh](j<)}(h ``lessee_id``h]j)}(hjh]h lessee_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM,hj|ubjV)}(hhh]h)}(hUnique ID of lesseeh]hUnique ID of lessee}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM-hjubah}(h]h ]h"]h$]h&]uh1jUhj|ubeh}(h]h ]h"]h$]h&]uh1j5hjhM,hjyubah}(h]h ]h"]h$]h&]uh1j0hj1ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_rect (C struct)c.drm_mode_recthNtauh1jhj^hhhNhNubj)}(hhh](j)}(h drm_mode_recth]j)}(hstruct drm_mode_recth](j@)}(hjCh]hstruct}(hjܵhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hjصhhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM3ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjصhhhjhM3ubj)}(h drm_mode_recth]j)}(hjֵh]h drm_mode_rect}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhjصhhhjhM3ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjԵhhhjhM3ubah}(h]jϵah ](jjeh"]h$]h&]jj)jhuh1jhjhM3hjѵhhubj)}(hhh]h)}(hTwo dimensional rectangle.h]hTwo dimensional rectangle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM2hjhhubah}(h]h ]h"]h$]h&]uh1jhjѵhhhjhM3ubeh}(h]h ](jstructeh"]h$]h&]j jj j6jj6jjjuh1jhhhj^hNhNubj)}(hXL**Definition**:: struct drm_mode_rect { __s32 x1; __s32 y1; __s32 x2; __s32 y2; }; **Members** ``x1`` Horizontal starting coordinate (inclusive). ``y1`` Vertical starting coordinate (inclusive). ``x2`` Horizontal ending coordinate (exclusive). ``y2`` Vertical ending coordinate (exclusive).h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubh:}(hj>hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM6hj:ubj )}(hQstruct drm_mode_rect { __s32 x1; __s32 y1; __s32 x2; __s32 y2; };h]hQstruct drm_mode_rect { __s32 x1; __s32 y1; __s32 x2; __s32 y2; };}hj[sbah}(h]h ]h"]h$]h&]hhuh1j hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM8hj:ubh)}(h **Members**h]j)}(hjlh]hMembers}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM?hj:ubj1)}(hhh](j6)}(h3``x1`` Horizontal starting coordinate (inclusive). h](j<)}(h``x1``h]j)}(hjh]hx1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM4hjubjV)}(hhh]h)}(h+Horizontal starting coordinate (inclusive).h]h+Horizontal starting coordinate (inclusive).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM4hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhM4hjubj6)}(h1``y1`` Vertical starting coordinate (inclusive). h](j<)}(h``y1``h]j)}(hjĶh]hy1}(hjƶhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj¶ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM5hjubjV)}(hhh]h)}(h)Vertical starting coordinate (inclusive).h]h)Vertical starting coordinate (inclusive).}(hjݶhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjٶhM5hjڶubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjٶhM5hjubj6)}(h1``x2`` Horizontal ending coordinate (exclusive). h](j<)}(h``x2``h]j)}(hjh]hx2}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM6hjubjV)}(hhh]h)}(h)Horizontal ending coordinate (exclusive).h]h)Horizontal ending coordinate (exclusive).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM6hjubah}(h]h ]h"]h$]h&]uh1jUhjubeh}(h]h ]h"]h$]h&]uh1j5hjhM6hjubj6)}(h.``y2`` Vertical ending coordinate (exclusive).h](j<)}(h``y2``h]j)}(hj6h]hy2}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1j;hY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM6hj0ubjV)}(hhh]h)}(h'Vertical ending coordinate (exclusive).h]h'Vertical ending coordinate (exclusive).}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM7hjLubah}(h]h ]h"]h$]h&]uh1jUhj0ubeh}(h]h ]h"]h$]h&]uh1j5hjKhM6hjubeh}(h]h ]h"]h$]h&]uh1j0hj:ubeh}(h]h ] kernelindentah"]h$]h&]uh1jhj^hhhNhNubh)}(h**Description**h]j)}(hjyh]h Description}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM:hj^hhubh)}(haWith drm subsystem using struct drm_rect to manage rectangular area this export it to user-space.h]haWith drm subsystem using struct drm_rect to manage rectangular area this export it to user-space.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM8hj^hhubh)}(h@Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS.h]h@Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM;hj^hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jdrm_mode_closefb (C struct)c.drm_mode_closefbhNtauh1jhj^hhhNhNubj)}(hhh](j)}(hdrm_mode_closefbh]j)}(hstruct drm_mode_closefbh](j@)}(hjCh]hstruct}(hjƷhhhNhNubah}(h]h ]jLah"]h$]h&]uh1j?hj·hhhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhM@ubj)}(h h]h }(hjԷhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj·hhhjӷhM@ubj)}(hdrm_mode_closefbh]j)}(hjh]hdrm_mode_closefb}(hjhhhNhNubah}(h]h ]j'ah"]h$]h&]uh1jhjubah}(h]h ](j.j/eh"]h$]h&]hhuh1jhj·hhhjӷhM@ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhjӷhM@ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhjӷhM@hjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhjӷhM@ubeh}(h]h ](jstructeh"]h$]h&]j jj jjjjjjuh1jhhhj^hNhNubj)}(h**Definition**:: struct drm_mode_closefb { __u32 fb_id; __u32 pad; }; **Members** ``fb_id`` Framebuffer ID. ``pad`` Must be zero.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhY/var/lib/git/docbuild/linux/Documentation/gpu/drm-uapi:687: ./include/uapi/drm/drm_mode.hhMHhjubj )}(hj,j)jjjzjwjjjjj$j!j7jj7j7j7j7jyTjvTj 8j8jD8jA8j9j 9j =j =jqTjnTj]j]j_^j\^jjjj^jjjju nametypes}(jjjjjjjjcjbjj~j_jJjWjjIj(jOjjjAj,jjzjjj$j7j7j7jyTj 8jD8j9j =jqTj]j_^jjjjuh}(jhjhjjjjjjjjjjj` je jB jH jjjjjjjjj_jjjhj{jj\jjGjAjTjNjjbjFjj%jjLj+jjRjjjjj>j j)jLjjyjwjjj}jjj!jjj/j7j/j7jsjj!jo!j#j##j$j$j&j&j(j(j*j*jP-jU-j0j 0j5j5jvTj7j8j7jA8j 8j 9jG8j =j9j:j:jnTj=j,=j2=j>j>j;Aj@Aj'Cj,CjlEjqEjsGjxGj_JjdJjMjMjQjQj]j|TjTjUjVjVj2Xj7Xj\ZjaZj\j\j\^j]jjb^j^j^jj^j^j^j_j_j`j`j?ajDajajajHcjMcjVdj[djdejiej?fjDfjfjfjgjgjzhjhj3ij8ijUjjZjjckjhkjlj"ljljljmjmjGnjLnjnjnjojojpjpjeqjjqjxjCxjxjyjzjzj6}j;}j5~j:~j~j~jŀjʀjɁj΁jjjjjهjއjjjRjWjjjjjcjhj̞jўjjjjjCjHjjjjjjj|jj5j:j/j4j jjjjjjDjIjj jƴj˴jϵjԵjjjju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}jRKsRparse_messages]hsystem_message)}(hhh]h)}(h)Duplicate implicit target name: "vulkan".h]h-Duplicate implicit target name: “vulkan”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]jalevelKtypeINFOsourcehlineMkuh1jhjhhhhhMkubatransform_messages](j)}(hhh]h)}(hhh]h6Hyperlink target "drm-primary-node" is not referenced.}hjҹsbah}(h]h ]h"]h$]h&]uh1hhjϹubah}(h]h ]h"]h$]h&]levelKtypejʹsourcehlineKuh1jubj)}(hhh]h)}(hhh]h1Hyperlink target "drm-leasing" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejʹsourcehlineK)uh1jubj)}(hhh]h)}(hhh]h5Hyperlink target "drm-render-node" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejʹsourcehlineKyuh1jubj)}(hhh]h)}(hhh]h6Hyperlink target "drm-driver-ioctl" is not referenced.}hj sbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejʹsourcehlineMuh1jubj)}(hhh]h)}(hhh]h0Hyperlink target "crtc-index" is not referenced.}hj:sbah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]levelKtypejʹsourcehlineMuh1jube transformerN include_log] decorationNhhub.