include/drm/gud.h

1 /* SPDX-License-Identifier: MIT */
12  * struct gud_display_descriptor_req - Display descriptor
16  *         - STATUS_ON_SET: Always do a status request after a SET request.
18  *                          no way to control the status stage of a control OUT
19  *                          request that has a payload.
20  *         - FULL_UPDATE:   Always send the entire framebuffer when flushing changes.
24  *                          a chance to reset its state machine if needed.
27  *               - GUD_COMPRESSION_LZ4: LZ4 lossless compression.
29  *                   This is useful for devices that don't have a big enough
36  * Devices that have only one display mode will have min_width == max_width
56  * struct gud_property_req - Property
66  * struct gud_display_mode_req - Display mode
68  * @hdisplay: Horizontal display size
72  * @vdisplay: Vertical display size
76  * @flags: Bits 0-13 are the same as in the RandR protocol and also what DRM uses.
79  *         - FLAG_PREFERRED: Set on the preferred display mode.
117  * struct gud_connector_descriptor_req - Connector descriptor
121  *         - POLL_STATUS: Connector status can change (polled every 10 seconds)
122  *         - INTERLACE: Interlaced modes are supported
123  *         - DOUBLESCAN: Doublescan modes are supported
142  * struct gud_set_buffer_req - Set buffer transfer info
166  * struct gud_state_req - Display state
167  * @mode: Display mode
172  * The entire state is transferred each time there's a change.
183 /* Margins in pixels to deal with overscan, range 0-100 */
189 /* Brightness in percent, range 0-100 */
191 /* Contrast in percent, range 0-100 */
193 /* Flicker reduction in percent, range 0-100 */
195 /* Overscan in percent, range 0-100 */
197 /* Saturation in percent, range 0-100 */
199 /* Hue in percent, range 0-100 */
203  * Backlight brightness is in the range 0-100 inclusive. The value represents the human perceptual
204  * brightness and not a linear PWM value. 0 is minimum brightness which should not turn the
206  * trigger a GUD_REQ_SET_DISPLAY_ENABLE request.
208  * This does not map to a DRM property, it is used with the backlight device.
218  * Note: This is not display rotation so 90/270 will need scaling to make it fit (unless squared).
243 /* Get display descriptor as a &gud_display_descriptor_req */
246 /* Get supported pixel formats as a byte array of GUD_PIXEL_FORMAT_* */
249   #define GUD_PIXEL_FORMAT_R1			0x01 /* 1-bit monochrome */
250   #define GUD_PIXEL_FORMAT_R8			0x08 /* 8-bit greyscale */
259  * Get supported properties that are not connector propeties as a &gud_property_req array.
272  * Get properties supported by the connector as a &gud_property_req array.
279  * Issued when there's a TV_MODE property present.
281  * GUD_CONNECTOR_TV_MODE_NAME_LEN. Names must be NUL-terminated.
293  * Userspace will get a HOTPLUG uevent if one of the following is true:
294  * - Connection status has changed since last
295  * - CHANGED is set
305  * Display modes can be fetched as either EDID data or an array of &gud_display_mode_req.
307  * If GUD_REQ_GET_CONNECTOR_MODES returns zero, EDID is used to create display modes.
308  * If both display modes and EDID are returned, EDID is just passed on to userspace
312 /* Get &gud_display_mode_req array of supported display modes */
316 /* Get Extended Display Identification Data */
323 /* Check display configuration as &gud_state_req */
329 /* Enable/disable the display controller, value is u8: 0/1 */
332 /* Enable/disable display/output (DPMS), value is u8: 0/1 */