Copyright © 2018 NXP Copyright © 2019 Status Research & Development GmbH. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. This protocol is used by Wayland compositors which act as Direct Renderering Manager (DRM) masters to lease DRM resources to Wayland clients. Once leased, the compositor will not use the leased resources until the lease is revoked or the client closes the file descriptor. The lease manager is used to advertise connectors which are available for leasing, and by the client to negotiate a lease request. Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset. Creates a lease request object. See the documentation for zwp_drm_lease_request_v1 for details. Indicates the client no longer wishes to receive connector events. The compositor may still send connector events until it sends the finish event, however. The client must not send any requests after this one. The compositor may choose to advertise 0 or more connectors which may be leased to clients, and will use this event to do so. This object may be passed into a lease request to lease that connector. See zwp_drm_lease_request_v1.add_connector for details. When this global is bound, the compositor will send all connectors available for lease, but may send additional connectors at any time. This event indicates that the compositor is done sending connector events. The compositor will destroy this object immediately after sending this event, and it will become invalid. The client should release any resources associated with this manager after receiving this event. Represents a DRM connector which is available for lease. These objects are created via zwp_drm_lease_manager_v1.connector, and should be passed into lease requests via zwp_drm_lease_request_v1.add_connector. The compositor sends this event once the connector is created to indicate the name of this connector. This will not change for the duration of the Wayland session, but is not guaranteed to be consistent between sessions. If the compositor also supports zxdg_output_manager_v1 and this connector corresponds to a zxdg_output_v1, this name will match the name of this zxdg_output_v1 object. The compositor sends this event once the connector is created to provide a human-readable description for this connector, which may be presented to the user. The compositor will send this event to indicate the DRM ID which represents the underlying connector which is being offered. Note that the final lease may include additional object IDs, such as CRTCs and planes. The compositor may send this event once the connector is created to provide a file descriptor which may be memory-mapped to read the connector's EDID, to assist in selecting the correct connectors for lease. The fd must be mapped with MAP_PRIVATE by the recipient. Note that not all displays have an EDID, and this event will not be sent in such cases. Sent to indicate that the compositor will no longer honor requests for DRM leases which include this connector. The client may still issue a lease request including this connector, but the compositor will send zwp_drm_lease_v1.finished without issuing a lease fd. The client may send this request to indicate that it will not issue a lease request for this connector. Clients are encouraged to send this after receiving the "withdrawn" request so that the server can release the resources associated with this connector offer. A client that wishes to lease DRM resources will attach the list of connectors advertised with zwp_drm_lease_manager_v1.connector that they wish to lease, then use zwp_drm_lease_request_v1.submit to submit the request. Indicates that the client will no longer use this lease request. Indicates that the client would like to lease the given connector. This is only used as a suggestion, the compositor may choose to include any resources in the lease it issues, or change the set of leased resources at any time. Submits the lease request and creates a new zwp_drm_lease_v1 object. After calling submit, issuing any other request than destroy is a protocol error. A DRM lease object is used to transfer the DRM file descriptor to the client and manage the lifetime of the lease. This event returns a file descriptor suitable for use with DRM-related ioctls. The client should use drmModeGetLease to enumerate the DRM objects which have been leased to them. If the compositor cannot or will not grant a lease for the requested connectors, it will not send this event, instead sending the finished event immediately. It is a protocol error for the compositor to send this event more than once for a given lease. When the compositor revokes the lease, it will issue this event to notify clients of the change. If the client requires a new lease, they should destroy this object and submit a new lease request. The compositor will send no further events for this object after sending the finish event. The client should send this to indicate that it no longer wishes to use this lease. The compositor should use drmModeRevokeLease on the appropriate file descriptor, if necessary, then release this object.