Commit | Line | Data |
---|---|---|
f453ba04 DA |
1 | /* |
2 | * Copyright © 2006 Keith Packard | |
3 | * Copyright © 2007-2008 Dave Airlie | |
4 | * Copyright © 2007-2008 Intel Corporation | |
5 | * Jesse Barnes <jesse.barnes@intel.com> | |
6 | * | |
7 | * Permission is hereby granted, free of charge, to any person obtaining a | |
8 | * copy of this software and associated documentation files (the "Software"), | |
9 | * to deal in the Software without restriction, including without limitation | |
10 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
11 | * and/or sell copies of the Software, and to permit persons to whom the | |
12 | * Software is furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
20 | * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR | |
21 | * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | |
22 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | |
23 | * OTHER DEALINGS IN THE SOFTWARE. | |
24 | */ | |
25 | #ifndef __DRM_CRTC_H__ | |
26 | #define __DRM_CRTC_H__ | |
27 | ||
28 | #include <linux/i2c.h> | |
29 | #include <linux/spinlock.h> | |
30 | #include <linux/types.h> | |
31 | #include <linux/idr.h> | |
f453ba04 | 32 | #include <linux/fb.h> |
985e5dc2 | 33 | #include <linux/hdmi.h> |
b5571e9d | 34 | #include <linux/media-bus-format.h> |
d7d2c48e DH |
35 | #include <uapi/drm/drm_mode.h> |
36 | #include <uapi/drm/drm_fourcc.h> | |
51fd371b | 37 | #include <drm/drm_modeset_lock.h> |
308e5bcb | 38 | |
f453ba04 DA |
39 | struct drm_device; |
40 | struct drm_mode_set; | |
41 | struct drm_framebuffer; | |
7e3bdf4a | 42 | struct drm_object_properties; |
595887eb TR |
43 | struct drm_file; |
44 | struct drm_clip_rect; | |
7e435aad | 45 | struct device_node; |
e2330f07 | 46 | struct fence; |
81065548 | 47 | struct edid; |
f453ba04 | 48 | |
f453ba04 DA |
49 | struct drm_mode_object { |
50 | uint32_t id; | |
51 | uint32_t type; | |
7e3bdf4a | 52 | struct drm_object_properties *properties; |
d0f37cf6 DA |
53 | struct kref refcount; |
54 | void (*free_cb)(struct kref *kref); | |
7e3bdf4a PZ |
55 | }; |
56 | ||
fe456168 | 57 | #define DRM_OBJECT_MAX_PROPERTY 24 |
7e3bdf4a | 58 | struct drm_object_properties { |
88a48e29 | 59 | int count, atomic_count; |
b17cd757 RC |
60 | /* NOTE: if we ever start dynamically destroying properties (ie. |
61 | * not at drm_mode_config_cleanup() time), then we'd have to do | |
62 | * a better job of detaching property from mode objects to avoid | |
63 | * dangling property pointers: | |
64 | */ | |
65 | struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY]; | |
22b8b13b RC |
66 | /* do not read/write values directly, but use drm_object_property_get_value() |
67 | * and drm_object_property_set_value(): | |
68 | */ | |
7e3bdf4a | 69 | uint64_t values[DRM_OBJECT_MAX_PROPERTY]; |
f453ba04 DA |
70 | }; |
71 | ||
ebc44cf3 RC |
72 | static inline int64_t U642I64(uint64_t val) |
73 | { | |
74 | return (int64_t)*((int64_t *)&val); | |
75 | } | |
76 | static inline uint64_t I642U64(int64_t val) | |
77 | { | |
78 | return (uint64_t)*((uint64_t *)&val); | |
79 | } | |
80 | ||
d9c38242 RF |
81 | /* |
82 | * Rotation property bits. DRM_ROTATE_<degrees> rotates the image by the | |
83 | * specified amount in degrees in counter clockwise direction. DRM_REFLECT_X and | |
84 | * DRM_REFLECT_Y reflects the image along the specified axis prior to rotation | |
85 | */ | |
62209070 | 86 | #define DRM_ROTATE_MASK 0x0f |
06596961 VS |
87 | #define DRM_ROTATE_0 0 |
88 | #define DRM_ROTATE_90 1 | |
89 | #define DRM_ROTATE_180 2 | |
90 | #define DRM_ROTATE_270 3 | |
62209070 | 91 | #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK) |
06596961 VS |
92 | #define DRM_REFLECT_X 4 |
93 | #define DRM_REFLECT_Y 5 | |
94 | ||
55310008 DV |
95 | enum drm_connector_force { |
96 | DRM_FORCE_UNSPECIFIED, | |
97 | DRM_FORCE_OFF, | |
98 | DRM_FORCE_ON, /* force on analog part normally */ | |
99 | DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */ | |
f453ba04 DA |
100 | }; |
101 | ||
55310008 | 102 | #include <drm/drm_modes.h> |
4aa17cf0 | 103 | |
f453ba04 DA |
104 | enum drm_connector_status { |
105 | connector_status_connected = 1, | |
106 | connector_status_disconnected = 2, | |
107 | connector_status_unknown = 3, | |
108 | }; | |
109 | ||
110 | enum subpixel_order { | |
111 | SubPixelUnknown = 0, | |
112 | SubPixelHorizontalRGB, | |
113 | SubPixelHorizontalBGR, | |
114 | SubPixelVerticalRGB, | |
115 | SubPixelVerticalBGR, | |
116 | SubPixelNone, | |
117 | }; | |
118 | ||
da05a5a7 JB |
119 | #define DRM_COLOR_FORMAT_RGB444 (1<<0) |
120 | #define DRM_COLOR_FORMAT_YCRCB444 (1<<1) | |
121 | #define DRM_COLOR_FORMAT_YCRCB422 (1<<2) | |
f0aa0838 SA |
122 | |
123 | #define DRM_BUS_FLAG_DE_LOW (1<<0) | |
124 | #define DRM_BUS_FLAG_DE_HIGH (1<<1) | |
125 | /* drive data on pos. edge */ | |
126 | #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2) | |
127 | /* drive data on neg. edge */ | |
128 | #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3) | |
129 | ||
f453ba04 DA |
130 | /* |
131 | * Describes a given display (e.g. CRT or flat panel) and its limitations. | |
132 | */ | |
133 | struct drm_display_info { | |
134 | char name[DRM_DISPLAY_INFO_LEN]; | |
fb439640 | 135 | |
f453ba04 DA |
136 | /* Physical size */ |
137 | unsigned int width_mm; | |
138 | unsigned int height_mm; | |
139 | ||
f453ba04 DA |
140 | /* Clock limits FIXME: storage format */ |
141 | unsigned int min_vfreq, max_vfreq; | |
142 | unsigned int min_hfreq, max_hfreq; | |
143 | unsigned int pixel_clock; | |
3b11228b | 144 | unsigned int bpc; |
f453ba04 | 145 | |
f453ba04 | 146 | enum subpixel_order subpixel_order; |
da05a5a7 | 147 | u32 color_formats; |
f453ba04 | 148 | |
b5571e9d BB |
149 | const u32 *bus_formats; |
150 | unsigned int num_bus_formats; | |
f0aa0838 | 151 | u32 bus_flags; |
b5571e9d | 152 | |
5d02626d MK |
153 | /* Mask of supported hdmi deep color modes */ |
154 | u8 edid_hdmi_dc_modes; | |
155 | ||
ebec9a7b | 156 | u8 cea_rev; |
f453ba04 DA |
157 | }; |
158 | ||
138f9ebb DA |
159 | /* data corresponds to displayid vend/prod/serial */ |
160 | struct drm_tile_group { | |
161 | struct kref refcount; | |
162 | struct drm_device *dev; | |
163 | int id; | |
164 | u8 group_data[8]; | |
165 | }; | |
166 | ||
c6b0ca3e DV |
167 | /** |
168 | * struct drm_framebuffer_funcs - framebuffer hooks | |
169 | */ | |
f453ba04 | 170 | struct drm_framebuffer_funcs { |
c6b0ca3e DV |
171 | /** |
172 | * @destroy: | |
173 | * | |
174 | * Clean up framebuffer resources, specifically also unreference the | |
175 | * backing storage. The core guarantees to call this function for every | |
176 | * framebuffer successfully created by ->fb_create() in | |
d55f5320 DV |
177 | * &drm_mode_config_funcs. Drivers must also call |
178 | * drm_framebuffer_cleanup() to release DRM core resources for this | |
179 | * framebuffer. | |
c6b0ca3e | 180 | */ |
f453ba04 | 181 | void (*destroy)(struct drm_framebuffer *framebuffer); |
c6b0ca3e DV |
182 | |
183 | /** | |
184 | * @create_handle: | |
185 | * | |
186 | * Create a buffer handle in the driver-specific buffer manager (either | |
187 | * GEM or TTM) valid for the passed-in struct &drm_file. This is used by | |
188 | * the core to implement the GETFB IOCTL, which returns (for | |
189 | * sufficiently priviledged user) also a native buffer handle. This can | |
190 | * be used for seamless transitions between modesetting clients by | |
191 | * copying the current screen contents to a private buffer and blending | |
192 | * between that and the new contents. | |
193 | * | |
d55f5320 DV |
194 | * GEM based drivers should call drm_gem_handle_create() to create the |
195 | * handle. | |
196 | * | |
c6b0ca3e DV |
197 | * RETURNS: |
198 | * | |
199 | * 0 on success or a negative error code on failure. | |
200 | */ | |
f453ba04 DA |
201 | int (*create_handle)(struct drm_framebuffer *fb, |
202 | struct drm_file *file_priv, | |
203 | unsigned int *handle); | |
c6b0ca3e DV |
204 | /** |
205 | * @dirty: | |
884840aa | 206 | * |
c6b0ca3e | 207 | * Optional callback for the dirty fb IOCTL. |
884840aa | 208 | * |
c6b0ca3e DV |
209 | * Userspace can notify the driver via this callback that an area of the |
210 | * framebuffer has changed and should be flushed to the display | |
211 | * hardware. This can also be used internally, e.g. by the fbdev | |
212 | * emulation, though that's not the case currently. | |
213 | * | |
214 | * See documentation in drm_mode.h for the struct drm_mode_fb_dirty_cmd | |
215 | * for more information as all the semantics and arguments have a one to | |
216 | * one mapping on this function. | |
217 | * | |
218 | * RETURNS: | |
219 | * | |
220 | * 0 on success or a negative error code on failure. | |
884840aa | 221 | */ |
02b00162 TH |
222 | int (*dirty)(struct drm_framebuffer *framebuffer, |
223 | struct drm_file *file_priv, unsigned flags, | |
884840aa JB |
224 | unsigned color, struct drm_clip_rect *clips, |
225 | unsigned num_clips); | |
f453ba04 DA |
226 | }; |
227 | ||
228 | struct drm_framebuffer { | |
229 | struct drm_device *dev; | |
f7eff60e RC |
230 | /* |
231 | * Note that the fb is refcounted for the benefit of driver internals, | |
232 | * for example some hw, disabling a CRTC/plane is asynchronous, and | |
233 | * scanout does not actually complete until the next vblank. So some | |
234 | * cleanup (like releasing the reference(s) on the backing GEM bo(s)) | |
235 | * should be deferred. In cases like this, the driver would like to | |
236 | * hold a ref to the fb even though it has already been removed from | |
237 | * userspace perspective. | |
d0f37cf6 | 238 | * The refcount is stored inside the mode object. |
f7eff60e | 239 | */ |
4b096ac1 DV |
240 | /* |
241 | * Place on the dev->mode_config.fb_list, access protected by | |
242 | * dev->mode_config.fb_lock. | |
243 | */ | |
f453ba04 DA |
244 | struct list_head head; |
245 | struct drm_mode_object base; | |
246 | const struct drm_framebuffer_funcs *funcs; | |
01f2c773 VS |
247 | unsigned int pitches[4]; |
248 | unsigned int offsets[4]; | |
e3eb3250 | 249 | uint64_t modifier[4]; |
f453ba04 DA |
250 | unsigned int width; |
251 | unsigned int height; | |
252 | /* depth can be 15 or 16 */ | |
253 | unsigned int depth; | |
254 | int bits_per_pixel; | |
255 | int flags; | |
308e5bcb | 256 | uint32_t pixel_format; /* fourcc format */ |
dd546591 GH |
257 | int hot_x; |
258 | int hot_y; | |
f453ba04 DA |
259 | struct list_head filp_head; |
260 | }; | |
261 | ||
262 | struct drm_property_blob { | |
263 | struct drm_mode_object base; | |
6bcacf51 | 264 | struct drm_device *dev; |
e2f5d2ea DS |
265 | struct list_head head_global; |
266 | struct list_head head_file; | |
ecbbe59b | 267 | size_t length; |
d63f5e6b | 268 | unsigned char data[]; |
f453ba04 DA |
269 | }; |
270 | ||
271 | struct drm_property_enum { | |
272 | uint64_t value; | |
273 | struct list_head head; | |
274 | char name[DRM_PROP_NAME_LEN]; | |
275 | }; | |
276 | ||
277 | struct drm_property { | |
278 | struct list_head head; | |
279 | struct drm_mode_object base; | |
280 | uint32_t flags; | |
281 | char name[DRM_PROP_NAME_LEN]; | |
282 | uint32_t num_values; | |
283 | uint64_t *values; | |
98f75de4 | 284 | struct drm_device *dev; |
f453ba04 | 285 | |
3758b341 | 286 | struct list_head enum_list; |
f453ba04 DA |
287 | }; |
288 | ||
289 | struct drm_crtc; | |
290 | struct drm_connector; | |
291 | struct drm_encoder; | |
d91d8a3f | 292 | struct drm_pending_vblank_event; |
8cf5c917 | 293 | struct drm_plane; |
3b336ec4 | 294 | struct drm_bridge; |
144ecb97 DV |
295 | struct drm_atomic_state; |
296 | ||
4490d4c7 DV |
297 | struct drm_crtc_helper_funcs; |
298 | struct drm_encoder_helper_funcs; | |
299 | struct drm_connector_helper_funcs; | |
300 | struct drm_plane_helper_funcs; | |
301 | ||
144ecb97 | 302 | /** |
cc4ceb48 | 303 | * struct drm_crtc_state - mutable CRTC state |
07cc0ef6 | 304 | * @crtc: backpointer to the CRTC |
144ecb97 | 305 | * @enable: whether the CRTC should be enabled, gates all other state |
d9b13620 | 306 | * @active: whether the CRTC is actively displaying (used for DPMS) |
fc596660 ML |
307 | * @planes_changed: planes on this crtc are updated |
308 | * @mode_changed: crtc_state->mode or crtc_state->enable has been changed | |
309 | * @active_changed: crtc_state->active has been toggled. | |
310 | * @connectors_changed: connectors to this crtc have been updated | |
44d1240d | 311 | * @zpos_changed: zpos values of planes on this crtc have been updated |
5488dc16 LL |
312 | * @color_mgmt_changed: color management properties have changed (degamma or |
313 | * gamma LUT or CSC matrix) | |
6ddd388a | 314 | * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes |
4cd9fa52 | 315 | * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors |
e87a52b3 | 316 | * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders |
623369e5 DV |
317 | * @last_vblank_count: for helpers and drivers to capture the vblank of the |
318 | * update to ensure framebuffer cleanup isn't done too early | |
2f324b42 | 319 | * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings |
144ecb97 | 320 | * @mode: current mode timings |
ac3ba4a5 | 321 | * @mode_blob: &drm_property_blob for @mode |
5488dc16 LL |
322 | * @degamma_lut: Lookup table for converting framebuffer pixel data |
323 | * before apply the conversion matrix | |
324 | * @ctm: Transformation matrix | |
325 | * @gamma_lut: Lookup table for converting pixel data after the | |
326 | * conversion matrix | |
144ecb97 DV |
327 | * @event: optional pointer to a DRM event to signal upon completion of the |
328 | * state update | |
329 | * @state: backpointer to global drm_atomic_state | |
d9b13620 DV |
330 | * |
331 | * Note that the distinction between @enable and @active is rather subtile: | |
332 | * Flipping @active while @enable is set without changing anything else may | |
333 | * never return in a failure from the ->atomic_check callback. Userspace assumes | |
334 | * that a DPMS On will always succeed. In other words: @enable controls resource | |
335 | * assignment, @active controls the actual hardware state. | |
144ecb97 DV |
336 | */ |
337 | struct drm_crtc_state { | |
07cc0ef6 DV |
338 | struct drm_crtc *crtc; |
339 | ||
cc4ceb48 | 340 | bool enable; |
d9b13620 | 341 | bool active; |
144ecb97 | 342 | |
c2fcd274 DV |
343 | /* computed state bits used by helpers and drivers */ |
344 | bool planes_changed : 1; | |
623369e5 | 345 | bool mode_changed : 1; |
eab3bbef | 346 | bool active_changed : 1; |
fc596660 | 347 | bool connectors_changed : 1; |
44d1240d | 348 | bool zpos_changed : 1; |
5488dc16 | 349 | bool color_mgmt_changed : 1; |
623369e5 | 350 | |
6ddd388a RC |
351 | /* attached planes bitmask: |
352 | * WARNING: transitional helpers do not maintain plane_mask so | |
353 | * drivers not converted over to atomic helpers should not rely | |
354 | * on plane_mask being accurate! | |
355 | */ | |
356 | u32 plane_mask; | |
357 | ||
4cd9fa52 | 358 | u32 connector_mask; |
e87a52b3 | 359 | u32 encoder_mask; |
4cd9fa52 | 360 | |
623369e5 DV |
361 | /* last_vblank_count: for vblank waits before cleanup */ |
362 | u32 last_vblank_count; | |
c2fcd274 | 363 | |
2f324b42 DV |
364 | /* adjusted_mode: for use by helpers and drivers */ |
365 | struct drm_display_mode adjusted_mode; | |
366 | ||
144ecb97 DV |
367 | struct drm_display_mode mode; |
368 | ||
99cf4a29 DS |
369 | /* blob property to expose current mode to atomic userspace */ |
370 | struct drm_property_blob *mode_blob; | |
371 | ||
5488dc16 LL |
372 | /* blob property to expose color management to userspace */ |
373 | struct drm_property_blob *degamma_lut; | |
374 | struct drm_property_blob *ctm; | |
375 | struct drm_property_blob *gamma_lut; | |
376 | ||
144ecb97 DV |
377 | struct drm_pending_vblank_event *event; |
378 | ||
379 | struct drm_atomic_state *state; | |
380 | }; | |
f453ba04 DA |
381 | |
382 | /** | |
3bf0401c | 383 | * struct drm_crtc_funcs - control CRTCs for a given device |
f453ba04 DA |
384 | * |
385 | * The drm_crtc_funcs structure is the central CRTC management structure | |
386 | * in the DRM. Each CRTC controls one or more connectors (note that the name | |
387 | * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc. | |
388 | * connectors, not just CRTs). | |
389 | * | |
390 | * Each driver is responsible for filling out this structure at startup time, | |
391 | * in addition to providing other modesetting features, like i2c and DDC | |
392 | * bus accessors. | |
393 | */ | |
394 | struct drm_crtc_funcs { | |
88548636 DV |
395 | /** |
396 | * @reset: | |
397 | * | |
398 | * Reset CRTC hardware and software state to off. This function isn't | |
399 | * called by the core directly, only through drm_mode_config_reset(). | |
400 | * It's not a helper hook only for historical reasons. | |
401 | * | |
402 | * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset | |
403 | * atomic state using this hook. | |
404 | */ | |
eb033556 | 405 | void (*reset)(struct drm_crtc *crtc); |
f453ba04 | 406 | |
f6da8c6e DV |
407 | /** |
408 | * @cursor_set: | |
409 | * | |
410 | * Update the cursor image. The cursor position is relative to the CRTC | |
411 | * and can be partially or fully outside of the visible area. | |
412 | * | |
413 | * Note that contrary to all other KMS functions the legacy cursor entry | |
414 | * points don't take a framebuffer object, but instead take directly a | |
415 | * raw buffer object id from the driver's buffer manager (which is | |
416 | * either GEM or TTM for current drivers). | |
417 | * | |
418 | * This entry point is deprecated, drivers should instead implement | |
419 | * universal plane support and register a proper cursor plane using | |
420 | * drm_crtc_init_with_planes(). | |
421 | * | |
422 | * This callback is optional | |
423 | * | |
424 | * RETURNS: | |
425 | * | |
426 | * 0 on success or a negative error code on failure. | |
427 | */ | |
f453ba04 DA |
428 | int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv, |
429 | uint32_t handle, uint32_t width, uint32_t height); | |
f6da8c6e DV |
430 | |
431 | /** | |
432 | * @cursor_set2: | |
433 | * | |
434 | * Update the cursor image, including hotspot information. The hotspot | |
435 | * must not affect the cursor position in CRTC coordinates, but is only | |
436 | * meant as a hint for virtualized display hardware to coordinate the | |
437 | * guests and hosts cursor position. The cursor hotspot is relative to | |
438 | * the cursor image. Otherwise this works exactly like @cursor_set. | |
439 | * | |
440 | * This entry point is deprecated, drivers should instead implement | |
441 | * universal plane support and register a proper cursor plane using | |
442 | * drm_crtc_init_with_planes(). | |
443 | * | |
444 | * This callback is optional. | |
445 | * | |
446 | * RETURNS: | |
447 | * | |
448 | * 0 on success or a negative error code on failure. | |
449 | */ | |
4c813d4d DA |
450 | int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv, |
451 | uint32_t handle, uint32_t width, uint32_t height, | |
452 | int32_t hot_x, int32_t hot_y); | |
f6da8c6e DV |
453 | |
454 | /** | |
455 | * @cursor_move: | |
456 | * | |
457 | * Update the cursor position. The cursor does not need to be visible | |
458 | * when this hook is called. | |
459 | * | |
460 | * This entry point is deprecated, drivers should instead implement | |
461 | * universal plane support and register a proper cursor plane using | |
462 | * drm_crtc_init_with_planes(). | |
463 | * | |
464 | * This callback is optional. | |
465 | * | |
466 | * RETURNS: | |
467 | * | |
468 | * 0 on success or a negative error code on failure. | |
469 | */ | |
f453ba04 DA |
470 | int (*cursor_move)(struct drm_crtc *crtc, int x, int y); |
471 | ||
f6da8c6e DV |
472 | /** |
473 | * @gamma_set: | |
474 | * | |
475 | * Set gamma on the CRTC. | |
476 | * | |
477 | * This callback is optional. | |
478 | * | |
479 | * NOTE: | |
480 | * | |
481 | * Drivers that support gamma tables and also fbdev emulation through | |
482 | * the provided helper library need to take care to fill out the gamma | |
483 | * hooks for both. Currently there's a bit an unfortunate duplication | |
484 | * going on, which should eventually be unified to just one set of | |
485 | * hooks. | |
486 | */ | |
7ea77283 ML |
487 | int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b, |
488 | uint32_t size); | |
88548636 DV |
489 | |
490 | /** | |
491 | * @destroy: | |
492 | * | |
493 | * Clean up plane resources. This is only called at driver unload time | |
494 | * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged | |
495 | * in DRM. | |
496 | */ | |
f453ba04 DA |
497 | void (*destroy)(struct drm_crtc *crtc); |
498 | ||
f6da8c6e DV |
499 | /** |
500 | * @set_config: | |
501 | * | |
502 | * This is the main legacy entry point to change the modeset state on a | |
503 | * CRTC. All the details of the desired configuration are passed in a | |
504 | * struct &drm_mode_set - see there for details. | |
505 | * | |
506 | * Drivers implementing atomic modeset should use | |
507 | * drm_atomic_helper_set_config() to implement this hook. | |
508 | * | |
509 | * RETURNS: | |
510 | * | |
511 | * 0 on success or a negative error code on failure. | |
512 | */ | |
f453ba04 | 513 | int (*set_config)(struct drm_mode_set *set); |
d91d8a3f | 514 | |
f6da8c6e DV |
515 | /** |
516 | * @page_flip: | |
517 | * | |
518 | * Legacy entry point to schedule a flip to the given framebuffer. | |
519 | * | |
520 | * Page flipping is a synchronization mechanism that replaces the frame | |
521 | * buffer being scanned out by the CRTC with a new frame buffer during | |
522 | * vertical blanking, avoiding tearing (except when requested otherwise | |
523 | * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application | |
524 | * requests a page flip the DRM core verifies that the new frame buffer | |
525 | * is large enough to be scanned out by the CRTC in the currently | |
526 | * configured mode and then calls the CRTC ->page_flip() operation with a | |
527 | * pointer to the new frame buffer. | |
528 | * | |
529 | * The driver must wait for any pending rendering to the new framebuffer | |
530 | * to complete before executing the flip. It should also wait for any | |
531 | * pending rendering from other drivers if the underlying buffer is a | |
532 | * shared dma-buf. | |
533 | * | |
534 | * An application can request to be notified when the page flip has | |
535 | * completed. The drm core will supply a struct &drm_event in the event | |
536 | * parameter in this case. This can be handled by the | |
537 | * drm_crtc_send_vblank_event() function, which the driver should call on | |
538 | * the provided event upon completion of the flip. Note that if | |
539 | * the driver supports vblank signalling and timestamping the vblank | |
540 | * counters and timestamps must agree with the ones returned from page | |
541 | * flip events. With the current vblank helper infrastructure this can | |
542 | * be achieved by holding a vblank reference while the page flip is | |
543 | * pending, acquired through drm_crtc_vblank_get() and released with | |
544 | * drm_crtc_vblank_put(). Drivers are free to implement their own vblank | |
545 | * counter and timestamp tracking though, e.g. if they have accurate | |
546 | * timestamp registers in hardware. | |
547 | * | |
548 | * FIXME: | |
549 | * | |
550 | * Up to that point drivers need to manage events themselves and can use | |
551 | * even->base.list freely for that. Specifically they need to ensure | |
552 | * that they don't send out page flip (or vblank) events for which the | |
553 | * corresponding drm file has been closed already. The drm core | |
554 | * unfortunately does not (yet) take care of that. Therefore drivers | |
555 | * currently must clean up and release pending events in their | |
556 | * ->preclose driver function. | |
557 | * | |
558 | * This callback is optional. | |
559 | * | |
560 | * NOTE: | |
561 | * | |
562 | * Very early versions of the KMS ABI mandated that the driver must | |
563 | * block (but not reject) any rendering to the old framebuffer until the | |
564 | * flip operation has completed and the old framebuffer is no longer | |
565 | * visible. This requirement has been lifted, and userspace is instead | |
566 | * expected to request delivery of an event and wait with recycling old | |
567 | * buffers until such has been received. | |
568 | * | |
569 | * RETURNS: | |
570 | * | |
571 | * 0 on success or a negative error code on failure. Note that if a | |
572 | * ->page_flip() operation is already pending the callback should return | |
573 | * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode | |
574 | * or just runtime disabled through DPMS respectively the new atomic | |
4cba6850 DV |
575 | * "ACTIVE" state) should result in an -EINVAL error code. Note that |
576 | * drm_atomic_helper_page_flip() checks this already for atomic drivers. | |
d91d8a3f KH |
577 | */ |
578 | int (*page_flip)(struct drm_crtc *crtc, | |
579 | struct drm_framebuffer *fb, | |
ed8d1975 KP |
580 | struct drm_pending_vblank_event *event, |
581 | uint32_t flags); | |
bffd9de0 | 582 | |
88548636 DV |
583 | /** |
584 | * @set_property: | |
585 | * | |
586 | * This is the legacy entry point to update a property attached to the | |
587 | * CRTC. | |
588 | * | |
589 | * Drivers implementing atomic modeset should use | |
590 | * drm_atomic_helper_crtc_set_property() to implement this hook. | |
591 | * | |
592 | * This callback is optional if the driver does not support any legacy | |
593 | * driver-private properties. | |
594 | * | |
595 | * RETURNS: | |
596 | * | |
597 | * 0 on success or a negative error code on failure. | |
598 | */ | |
bffd9de0 PZ |
599 | int (*set_property)(struct drm_crtc *crtc, |
600 | struct drm_property *property, uint64_t val); | |
144ecb97 | 601 | |
88548636 DV |
602 | /** |
603 | * @atomic_duplicate_state: | |
604 | * | |
605 | * Duplicate the current atomic state for this CRTC and return it. | |
606 | * The core and helpers gurantee that any atomic state duplicated with | |
607 | * this hook and still owned by the caller (i.e. not transferred to the | |
608 | * driver by calling ->atomic_commit() from struct | |
609 | * &drm_mode_config_funcs) will be cleaned up by calling the | |
610 | * @atomic_destroy_state hook in this structure. | |
611 | * | |
612 | * Atomic drivers which don't subclass struct &drm_crtc should use | |
613 | * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the | |
614 | * state structure to extend it with driver-private state should use | |
615 | * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is | |
616 | * duplicated in a consistent fashion across drivers. | |
617 | * | |
618 | * It is an error to call this hook before crtc->state has been | |
619 | * initialized correctly. | |
620 | * | |
621 | * NOTE: | |
622 | * | |
623 | * If the duplicate state references refcounted resources this hook must | |
624 | * acquire a reference for each of them. The driver must release these | |
625 | * references again in @atomic_destroy_state. | |
626 | * | |
627 | * RETURNS: | |
628 | * | |
629 | * Duplicated atomic state or NULL when the allocation failed. | |
630 | */ | |
144ecb97 | 631 | struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc); |
88548636 DV |
632 | |
633 | /** | |
634 | * @atomic_destroy_state: | |
635 | * | |
636 | * Destroy a state duplicated with @atomic_duplicate_state and release | |
637 | * or unreference all resources it references | |
638 | */ | |
144ecb97 | 639 | void (*atomic_destroy_state)(struct drm_crtc *crtc, |
cc4ceb48 | 640 | struct drm_crtc_state *state); |
88548636 DV |
641 | |
642 | /** | |
643 | * @atomic_set_property: | |
644 | * | |
645 | * Decode a driver-private property value and store the decoded value | |
646 | * into the passed-in state structure. Since the atomic core decodes all | |
647 | * standardized properties (even for extensions beyond the core set of | |
648 | * properties which might not be implemented by all drivers) this | |
649 | * requires drivers to subclass the state structure. | |
650 | * | |
651 | * Such driver-private properties should really only be implemented for | |
652 | * truly hardware/vendor specific state. Instead it is preferred to | |
653 | * standardize atomic extension and decode the properties used to expose | |
654 | * such an extension in the core. | |
655 | * | |
656 | * Do not call this function directly, use | |
657 | * drm_atomic_crtc_set_property() instead. | |
658 | * | |
659 | * This callback is optional if the driver does not support any | |
660 | * driver-private atomic properties. | |
661 | * | |
662 | * NOTE: | |
663 | * | |
664 | * This function is called in the state assembly phase of atomic | |
665 | * modesets, which can be aborted for any reason (including on | |
666 | * userspace's request to just check whether a configuration would be | |
667 | * possible). Drivers MUST NOT touch any persistent state (hardware or | |
668 | * software) or data structures except the passed in @state parameter. | |
669 | * | |
670 | * Also since userspace controls in which order properties are set this | |
671 | * function must not do any input validation (since the state update is | |
672 | * incomplete and hence likely inconsistent). Instead any such input | |
673 | * validation must be done in the various atomic_check callbacks. | |
674 | * | |
675 | * RETURNS: | |
676 | * | |
677 | * 0 if the property has been found, -EINVAL if the property isn't | |
678 | * implemented by the driver (which should never happen, the core only | |
679 | * asks for properties attached to this CRTC). No other validation is | |
680 | * allowed by the driver. The core already checks that the property | |
681 | * value is within the range (integer, valid enum value, ...) the driver | |
682 | * set when registering the property. | |
683 | */ | |
144ecb97 DV |
684 | int (*atomic_set_property)(struct drm_crtc *crtc, |
685 | struct drm_crtc_state *state, | |
686 | struct drm_property *property, | |
687 | uint64_t val); | |
88548636 DV |
688 | /** |
689 | * @atomic_get_property: | |
690 | * | |
691 | * Reads out the decoded driver-private property. This is used to | |
c6b0ca3e | 692 | * implement the GETCRTC IOCTL. |
88548636 DV |
693 | * |
694 | * Do not call this function directly, use | |
695 | * drm_atomic_crtc_get_property() instead. | |
696 | * | |
697 | * This callback is optional if the driver does not support any | |
698 | * driver-private atomic properties. | |
699 | * | |
700 | * RETURNS: | |
701 | * | |
702 | * 0 on success, -EINVAL if the property isn't implemented by the | |
703 | * driver (which should never happen, the core only asks for | |
704 | * properties attached to this CRTC). | |
705 | */ | |
ac9c9256 RC |
706 | int (*atomic_get_property)(struct drm_crtc *crtc, |
707 | const struct drm_crtc_state *state, | |
708 | struct drm_property *property, | |
709 | uint64_t *val); | |
79190ea2 BG |
710 | |
711 | /** | |
712 | * @late_register: | |
713 | * | |
714 | * This optional hook can be used to register additional userspace | |
715 | * interfaces attached to the crtc like debugfs interfaces. | |
716 | * It is called late in the driver load sequence from drm_dev_register(). | |
717 | * Everything added from this callback should be unregistered in | |
718 | * the early_unregister callback. | |
719 | * | |
720 | * Returns: | |
721 | * | |
722 | * 0 on success, or a negative error code on failure. | |
723 | */ | |
724 | int (*late_register)(struct drm_crtc *crtc); | |
725 | ||
726 | /** | |
727 | * @early_unregister: | |
728 | * | |
729 | * This optional hook should be used to unregister the additional | |
730 | * userspace interfaces attached to the crtc from | |
731 | * late_unregister(). It is called from drm_dev_unregister(), | |
732 | * early in the driver unload sequence to disable userspace access | |
733 | * before data structures are torndown. | |
734 | */ | |
735 | void (*early_unregister)(struct drm_crtc *crtc); | |
f453ba04 DA |
736 | }; |
737 | ||
738 | /** | |
3bf0401c | 739 | * struct drm_crtc - central CRTC control structure |
7749163e | 740 | * @dev: parent DRM device |
2c0c33d4 | 741 | * @port: OF node used by drm_of_find_possible_crtcs() |
7749163e | 742 | * @head: list management |
ac3ba4a5 | 743 | * @name: human readable name, can be overwritten by the driver |
51fd371b | 744 | * @mutex: per-CRTC locking |
7749163e | 745 | * @base: base KMS object for ID tracking etc. |
e13161af MR |
746 | * @primary: primary plane for this CRTC |
747 | * @cursor: cursor plane for this CRTC | |
2c0c33d4 DV |
748 | * @cursor_x: current x position of the cursor, used for universal cursor planes |
749 | * @cursor_y: current y position of the cursor, used for universal cursor planes | |
f453ba04 | 750 | * @enabled: is this CRTC enabled? |
7749163e JB |
751 | * @mode: current mode timings |
752 | * @hwmode: mode timings as programmed to hw regs | |
f453ba04 DA |
753 | * @x: x position on screen |
754 | * @y: y position on screen | |
f453ba04 | 755 | * @funcs: CRTC control functions |
7749163e JB |
756 | * @gamma_size: size of gamma ramp |
757 | * @gamma_store: gamma ramp values | |
7749163e | 758 | * @helper_private: mid-layer private data |
bffd9de0 | 759 | * @properties: property tracking for this CRTC |
f453ba04 DA |
760 | * |
761 | * Each CRTC may have one or more connectors associated with it. This structure | |
762 | * allows the CRTC to be controlled. | |
763 | */ | |
764 | struct drm_crtc { | |
765 | struct drm_device *dev; | |
7e435aad | 766 | struct device_node *port; |
f453ba04 DA |
767 | struct list_head head; |
768 | ||
fa3ab4c2 VS |
769 | char *name; |
770 | ||
ac3ba4a5 DV |
771 | /** |
772 | * @mutex: | |
29494c17 DV |
773 | * |
774 | * This provides a read lock for the overall crtc state (mode, dpms | |
775 | * state, ...) and a write lock for everything which can be update | |
ac3ba4a5 DV |
776 | * without a full modeset (fb, cursor data, crtc properties ...). Full |
777 | * modeset also need to grab dev->mode_config.connection_mutex. | |
29494c17 | 778 | */ |
51fd371b | 779 | struct drm_modeset_lock mutex; |
29494c17 | 780 | |
f453ba04 DA |
781 | struct drm_mode_object base; |
782 | ||
e13161af MR |
783 | /* primary and cursor planes for CRTC */ |
784 | struct drm_plane *primary; | |
785 | struct drm_plane *cursor; | |
786 | ||
96094081 DV |
787 | /** |
788 | * @index: Position inside the mode_config.list, can be used as an array | |
789 | * index. It is invariant over the lifetime of the CRTC. | |
790 | */ | |
490d3d1b CW |
791 | unsigned index; |
792 | ||
161d0dc1 MR |
793 | /* position of cursor plane on crtc */ |
794 | int cursor_x; | |
795 | int cursor_y; | |
796 | ||
f453ba04 DA |
797 | bool enabled; |
798 | ||
27641c3f | 799 | /* Requested mode from modesetting. */ |
f453ba04 DA |
800 | struct drm_display_mode mode; |
801 | ||
27641c3f MK |
802 | /* Programmed mode in hw, after adjustments for encoders, |
803 | * crtc, panel scaling etc. Needed for timestamping etc. | |
804 | */ | |
805 | struct drm_display_mode hwmode; | |
806 | ||
f453ba04 | 807 | int x, y; |
f453ba04 DA |
808 | const struct drm_crtc_funcs *funcs; |
809 | ||
5488dc16 | 810 | /* Legacy FB CRTC gamma size for reporting to userspace */ |
f453ba04 DA |
811 | uint32_t gamma_size; |
812 | uint16_t *gamma_store; | |
813 | ||
814 | /* if you are using the helper */ | |
4490d4c7 | 815 | const struct drm_crtc_helper_funcs *helper_private; |
bffd9de0 PZ |
816 | |
817 | struct drm_object_properties properties; | |
d059f652 | 818 | |
3b24f7d6 DV |
819 | /** |
820 | * @state: | |
821 | * | |
822 | * Current atomic state for this CRTC. | |
823 | */ | |
144ecb97 DV |
824 | struct drm_crtc_state *state; |
825 | ||
3b24f7d6 DV |
826 | /** |
827 | * @commit_list: | |
828 | * | |
829 | * List of &drm_crtc_commit structures tracking pending commits. | |
830 | * Protected by @commit_lock. This list doesn't hold its own full | |
831 | * reference, but burrows it from the ongoing commit. Commit entries | |
832 | * must be removed from this list once the commit is fully completed, | |
833 | * but before it's correspoding &drm_atomic_state gets destroyed. | |
834 | */ | |
835 | struct list_head commit_list; | |
836 | ||
837 | /** | |
838 | * @commit_lock: | |
839 | * | |
840 | * Spinlock to protect @commit_list. | |
841 | */ | |
842 | spinlock_t commit_lock; | |
843 | ||
844 | /** | |
845 | * @acquire_ctx: | |
846 | * | |
847 | * Per-CRTC implicit acquire context used by atomic drivers for legacy | |
848 | * IOCTLs, so that atomic drivers can get at the locking acquire | |
849 | * context. | |
d059f652 DV |
850 | */ |
851 | struct drm_modeset_acquire_ctx *acquire_ctx; | |
f453ba04 DA |
852 | }; |
853 | ||
144ecb97 DV |
854 | /** |
855 | * struct drm_connector_state - mutable connector state | |
07cc0ef6 | 856 | * @connector: backpointer to the connector |
cc4ceb48 | 857 | * @crtc: CRTC to connect connector to, NULL if disabled |
623369e5 | 858 | * @best_encoder: can be used by helpers and drivers to select the encoder |
144ecb97 DV |
859 | * @state: backpointer to global drm_atomic_state |
860 | */ | |
861 | struct drm_connector_state { | |
07cc0ef6 DV |
862 | struct drm_connector *connector; |
863 | ||
6ddd388a | 864 | struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_connector() */ |
144ecb97 | 865 | |
623369e5 DV |
866 | struct drm_encoder *best_encoder; |
867 | ||
144ecb97 DV |
868 | struct drm_atomic_state *state; |
869 | }; | |
f453ba04 DA |
870 | |
871 | /** | |
3bf0401c | 872 | * struct drm_connector_funcs - control connectors on a given device |
144ecb97 | 873 | * |
f453ba04 DA |
874 | * Each CRTC may have one or more connectors attached to it. The functions |
875 | * below allow the core DRM code to control connectors, enumerate available modes, | |
876 | * etc. | |
877 | */ | |
878 | struct drm_connector_funcs { | |
6fe14acd DV |
879 | /** |
880 | * @dpms: | |
881 | * | |
882 | * Legacy entry point to set the per-connector DPMS state. Legacy DPMS | |
883 | * is exposed as a standard property on the connector, but diverted to | |
884 | * this callback in the drm core. Note that atomic drivers don't | |
885 | * implement the 4 level DPMS support on the connector any more, but | |
886 | * instead only have an on/off "ACTIVE" property on the CRTC object. | |
887 | * | |
888 | * Drivers implementing atomic modeset should use | |
889 | * drm_atomic_helper_connector_dpms() to implement this hook. | |
890 | * | |
891 | * RETURNS: | |
892 | * | |
893 | * 0 on success or a negative error code on failure. | |
894 | */ | |
9a69a9ac | 895 | int (*dpms)(struct drm_connector *connector, int mode); |
88548636 DV |
896 | |
897 | /** | |
898 | * @reset: | |
899 | * | |
900 | * Reset connector hardware and software state to off. This function isn't | |
901 | * called by the core directly, only through drm_mode_config_reset(). | |
902 | * It's not a helper hook only for historical reasons. | |
903 | * | |
904 | * Atomic drivers can use drm_atomic_helper_connector_reset() to reset | |
905 | * atomic state using this hook. | |
906 | */ | |
eb033556 | 907 | void (*reset)(struct drm_connector *connector); |
930a9e28 | 908 | |
6fe14acd DV |
909 | /** |
910 | * @detect: | |
911 | * | |
912 | * Check to see if anything is attached to the connector. The parameter | |
913 | * force is set to false whilst polling, true when checking the | |
914 | * connector due to a user request. force can be used by the driver to | |
915 | * avoid expensive, destructive operations during automated probing. | |
916 | * | |
917 | * FIXME: | |
918 | * | |
919 | * Note that this hook is only called by the probe helper. It's not in | |
920 | * the helper library vtable purely for historical reasons. The only DRM | |
921 | * core entry point to probe connector state is @fill_modes. | |
922 | * | |
923 | * RETURNS: | |
924 | * | |
925 | * drm_connector_status indicating the connector's status. | |
930a9e28 | 926 | */ |
7b334fcb | 927 | enum drm_connector_status (*detect)(struct drm_connector *connector, |
930a9e28 | 928 | bool force); |
6fe14acd DV |
929 | |
930 | /** | |
931 | * @force: | |
932 | * | |
933 | * This function is called to update internal encoder state when the | |
934 | * connector is forced to a certain state by userspace, either through | |
935 | * the sysfs interfaces or on the kernel cmdline. In that case the | |
936 | * @detect callback isn't called. | |
937 | * | |
938 | * FIXME: | |
939 | * | |
940 | * Note that this hook is only called by the probe helper. It's not in | |
941 | * the helper library vtable purely for historical reasons. The only DRM | |
942 | * core entry point to probe connector state is @fill_modes. | |
943 | */ | |
944 | void (*force)(struct drm_connector *connector); | |
945 | ||
946 | /** | |
947 | * @fill_modes: | |
948 | * | |
949 | * Entry point for output detection and basic mode validation. The | |
950 | * driver should reprobe the output if needed (e.g. when hotplug | |
951 | * handling is unreliable), add all detected modes to connector->modes | |
952 | * and filter out any the device can't support in any configuration. It | |
953 | * also needs to filter out any modes wider or higher than the | |
954 | * parameters max_width and max_height indicate. | |
955 | * | |
956 | * The drivers must also prune any modes no longer valid from | |
957 | * connector->modes. Furthermore it must update connector->status and | |
958 | * connector->edid. If no EDID has been received for this output | |
959 | * connector->edid must be NULL. | |
960 | * | |
961 | * Drivers using the probe helpers should use | |
962 | * drm_helper_probe_single_connector_modes() or | |
963 | * drm_helper_probe_single_connector_modes_nomerge() to implement this | |
964 | * function. | |
965 | * | |
966 | * RETURNS: | |
967 | * | |
968 | * The number of modes detected and filled into connector->modes. | |
969 | */ | |
40a518d9 | 970 | int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height); |
88548636 DV |
971 | |
972 | /** | |
973 | * @set_property: | |
974 | * | |
975 | * This is the legacy entry point to update a property attached to the | |
976 | * connector. | |
977 | * | |
978 | * Drivers implementing atomic modeset should use | |
979 | * drm_atomic_helper_connector_set_property() to implement this hook. | |
980 | * | |
981 | * This callback is optional if the driver does not support any legacy | |
982 | * driver-private properties. | |
983 | * | |
984 | * RETURNS: | |
985 | * | |
986 | * 0 on success or a negative error code on failure. | |
987 | */ | |
f453ba04 DA |
988 | int (*set_property)(struct drm_connector *connector, struct drm_property *property, |
989 | uint64_t val); | |
88548636 | 990 | |
aaf285e2 CW |
991 | /** |
992 | * @late_register: | |
993 | * | |
994 | * This optional hook can be used to register additional userspace | |
995 | * interfaces attached to the connector, light backlight control, i2c, | |
996 | * DP aux or similar interfaces. It is called late in the driver load | |
997 | * sequence from drm_connector_register() when registering all the | |
998 | * core drm connector interfaces. Everything added from this callback | |
999 | * should be unregistered in the early_unregister callback. | |
1000 | * | |
1001 | * Returns: | |
1002 | * | |
1003 | * 0 on success, or a negative error code on failure. | |
1004 | */ | |
1005 | int (*late_register)(struct drm_connector *connector); | |
1006 | ||
1007 | /** | |
1008 | * @early_unregister: | |
1009 | * | |
1010 | * This optional hook should be used to unregister the additional | |
1011 | * userspace interfaces attached to the connector from | |
1012 | * late_unregister(). It is called from drm_connector_unregister(), | |
1013 | * early in the driver unload sequence to disable userspace access | |
1014 | * before data structures are torndown. | |
1015 | */ | |
1016 | void (*early_unregister)(struct drm_connector *connector); | |
1017 | ||
88548636 DV |
1018 | /** |
1019 | * @destroy: | |
1020 | * | |
1021 | * Clean up connector resources. This is called at driver unload time | |
1022 | * through drm_mode_config_cleanup(). It can also be called at runtime | |
1023 | * when a connector is being hot-unplugged for drivers that support | |
1024 | * connector hotplugging (e.g. DisplayPort MST). | |
1025 | */ | |
f453ba04 | 1026 | void (*destroy)(struct drm_connector *connector); |
144ecb97 | 1027 | |
88548636 DV |
1028 | /** |
1029 | * @atomic_duplicate_state: | |
1030 | * | |
1031 | * Duplicate the current atomic state for this connector and return it. | |
1032 | * The core and helpers gurantee that any atomic state duplicated with | |
1033 | * this hook and still owned by the caller (i.e. not transferred to the | |
1034 | * driver by calling ->atomic_commit() from struct | |
1035 | * &drm_mode_config_funcs) will be cleaned up by calling the | |
1036 | * @atomic_destroy_state hook in this structure. | |
1037 | * | |
1038 | * Atomic drivers which don't subclass struct &drm_connector_state should use | |
1039 | * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the | |
1040 | * state structure to extend it with driver-private state should use | |
1041 | * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is | |
1042 | * duplicated in a consistent fashion across drivers. | |
1043 | * | |
1044 | * It is an error to call this hook before connector->state has been | |
1045 | * initialized correctly. | |
1046 | * | |
1047 | * NOTE: | |
1048 | * | |
1049 | * If the duplicate state references refcounted resources this hook must | |
1050 | * acquire a reference for each of them. The driver must release these | |
1051 | * references again in @atomic_destroy_state. | |
1052 | * | |
1053 | * RETURNS: | |
1054 | * | |
1055 | * Duplicated atomic state or NULL when the allocation failed. | |
1056 | */ | |
144ecb97 | 1057 | struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector); |
88548636 DV |
1058 | |
1059 | /** | |
1060 | * @atomic_destroy_state: | |
1061 | * | |
1062 | * Destroy a state duplicated with @atomic_duplicate_state and release | |
1063 | * or unreference all resources it references | |
1064 | */ | |
144ecb97 | 1065 | void (*atomic_destroy_state)(struct drm_connector *connector, |
cc4ceb48 | 1066 | struct drm_connector_state *state); |
88548636 DV |
1067 | |
1068 | /** | |
1069 | * @atomic_set_property: | |
1070 | * | |
1071 | * Decode a driver-private property value and store the decoded value | |
1072 | * into the passed-in state structure. Since the atomic core decodes all | |
1073 | * standardized properties (even for extensions beyond the core set of | |
1074 | * properties which might not be implemented by all drivers) this | |
1075 | * requires drivers to subclass the state structure. | |
1076 | * | |
1077 | * Such driver-private properties should really only be implemented for | |
1078 | * truly hardware/vendor specific state. Instead it is preferred to | |
1079 | * standardize atomic extension and decode the properties used to expose | |
1080 | * such an extension in the core. | |
1081 | * | |
1082 | * Do not call this function directly, use | |
1083 | * drm_atomic_connector_set_property() instead. | |
1084 | * | |
1085 | * This callback is optional if the driver does not support any | |
1086 | * driver-private atomic properties. | |
1087 | * | |
1088 | * NOTE: | |
1089 | * | |
1090 | * This function is called in the state assembly phase of atomic | |
1091 | * modesets, which can be aborted for any reason (including on | |
1092 | * userspace's request to just check whether a configuration would be | |
1093 | * possible). Drivers MUST NOT touch any persistent state (hardware or | |
1094 | * software) or data structures except the passed in @state parameter. | |
1095 | * | |
1096 | * Also since userspace controls in which order properties are set this | |
1097 | * function must not do any input validation (since the state update is | |
1098 | * incomplete and hence likely inconsistent). Instead any such input | |
1099 | * validation must be done in the various atomic_check callbacks. | |
1100 | * | |
1101 | * RETURNS: | |
1102 | * | |
1103 | * 0 if the property has been found, -EINVAL if the property isn't | |
1104 | * implemented by the driver (which shouldn't ever happen, the core only | |
1105 | * asks for properties attached to this connector). No other validation | |
1106 | * is allowed by the driver. The core already checks that the property | |
1107 | * value is within the range (integer, valid enum value, ...) the driver | |
1108 | * set when registering the property. | |
1109 | */ | |
144ecb97 DV |
1110 | int (*atomic_set_property)(struct drm_connector *connector, |
1111 | struct drm_connector_state *state, | |
1112 | struct drm_property *property, | |
1113 | uint64_t val); | |
88548636 DV |
1114 | |
1115 | /** | |
1116 | * @atomic_get_property: | |
1117 | * | |
1118 | * Reads out the decoded driver-private property. This is used to | |
c6b0ca3e | 1119 | * implement the GETCONNECTOR IOCTL. |
88548636 DV |
1120 | * |
1121 | * Do not call this function directly, use | |
1122 | * drm_atomic_connector_get_property() instead. | |
1123 | * | |
1124 | * This callback is optional if the driver does not support any | |
1125 | * driver-private atomic properties. | |
1126 | * | |
1127 | * RETURNS: | |
1128 | * | |
1129 | * 0 on success, -EINVAL if the property isn't implemented by the | |
1130 | * driver (which shouldn't ever happen, the core only asks for | |
1131 | * properties attached to this connector). | |
1132 | */ | |
ac9c9256 RC |
1133 | int (*atomic_get_property)(struct drm_connector *connector, |
1134 | const struct drm_connector_state *state, | |
1135 | struct drm_property *property, | |
1136 | uint64_t *val); | |
f453ba04 DA |
1137 | }; |
1138 | ||
6c3db920 | 1139 | /** |
3bf0401c | 1140 | * struct drm_encoder_funcs - encoder controls |
6c3db920 JB |
1141 | * |
1142 | * Encoders sit between CRTCs and connectors. | |
1143 | */ | |
f453ba04 | 1144 | struct drm_encoder_funcs { |
88548636 DV |
1145 | /** |
1146 | * @reset: | |
1147 | * | |
1148 | * Reset encoder hardware and software state to off. This function isn't | |
1149 | * called by the core directly, only through drm_mode_config_reset(). | |
1150 | * It's not a helper hook only for historical reasons. | |
1151 | */ | |
eb033556 | 1152 | void (*reset)(struct drm_encoder *encoder); |
88548636 DV |
1153 | |
1154 | /** | |
1155 | * @destroy: | |
1156 | * | |
1157 | * Clean up encoder resources. This is only called at driver unload time | |
1158 | * through drm_mode_config_cleanup() since an encoder cannot be | |
1159 | * hotplugged in DRM. | |
1160 | */ | |
f453ba04 | 1161 | void (*destroy)(struct drm_encoder *encoder); |
79190ea2 BG |
1162 | |
1163 | /** | |
1164 | * @late_register: | |
1165 | * | |
1166 | * This optional hook can be used to register additional userspace | |
1167 | * interfaces attached to the encoder like debugfs interfaces. | |
1168 | * It is called late in the driver load sequence from drm_dev_register(). | |
1169 | * Everything added from this callback should be unregistered in | |
1170 | * the early_unregister callback. | |
1171 | * | |
1172 | * Returns: | |
1173 | * | |
1174 | * 0 on success, or a negative error code on failure. | |
1175 | */ | |
1176 | int (*late_register)(struct drm_encoder *encoder); | |
1177 | ||
1178 | /** | |
1179 | * @early_unregister: | |
1180 | * | |
1181 | * This optional hook should be used to unregister the additional | |
1182 | * userspace interfaces attached to the encoder from | |
1183 | * late_unregister(). It is called from drm_dev_unregister(), | |
1184 | * early in the driver unload sequence to disable userspace access | |
1185 | * before data structures are torndown. | |
1186 | */ | |
1187 | void (*early_unregister)(struct drm_encoder *encoder); | |
f453ba04 DA |
1188 | }; |
1189 | ||
afe887df | 1190 | #define DRM_CONNECTOR_MAX_ENCODER 3 |
f453ba04 DA |
1191 | |
1192 | /** | |
3bf0401c | 1193 | * struct drm_encoder - central DRM encoder structure |
db3e4499 JB |
1194 | * @dev: parent DRM device |
1195 | * @head: list management | |
1196 | * @base: base KMS object | |
ac3ba4a5 | 1197 | * @name: human readable name, can be overwritten by the driver |
db3e4499 JB |
1198 | * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h |
1199 | * @possible_crtcs: bitmask of potential CRTC bindings | |
1200 | * @possible_clones: bitmask of potential sibling encoders for cloning | |
1201 | * @crtc: currently bound CRTC | |
3b336ec4 | 1202 | * @bridge: bridge associated to the encoder |
db3e4499 JB |
1203 | * @funcs: control functions |
1204 | * @helper_private: mid-layer private data | |
1205 | * | |
1206 | * CRTCs drive pixels to encoders, which convert them into signals | |
1207 | * appropriate for a given connector or set of connectors. | |
f453ba04 DA |
1208 | */ |
1209 | struct drm_encoder { | |
1210 | struct drm_device *dev; | |
1211 | struct list_head head; | |
1212 | ||
1213 | struct drm_mode_object base; | |
e5748946 | 1214 | char *name; |
f453ba04 | 1215 | int encoder_type; |
490d3d1b | 1216 | |
96094081 DV |
1217 | /** |
1218 | * @index: Position inside the mode_config.list, can be used as an array | |
1219 | * index. It is invariant over the lifetime of the encoder. | |
1220 | */ | |
490d3d1b CW |
1221 | unsigned index; |
1222 | ||
f453ba04 DA |
1223 | uint32_t possible_crtcs; |
1224 | uint32_t possible_clones; | |
1225 | ||
1226 | struct drm_crtc *crtc; | |
3b336ec4 | 1227 | struct drm_bridge *bridge; |
f453ba04 | 1228 | const struct drm_encoder_funcs *funcs; |
4490d4c7 | 1229 | const struct drm_encoder_helper_funcs *helper_private; |
f453ba04 DA |
1230 | }; |
1231 | ||
eb1f8e4f DA |
1232 | /* should we poll this connector for connects and disconnects */ |
1233 | /* hot plug detectable */ | |
1234 | #define DRM_CONNECTOR_POLL_HPD (1 << 0) | |
1235 | /* poll for connections */ | |
1236 | #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) | |
1237 | /* can cleanly poll for disconnections without flickering the screen */ | |
1238 | /* DACs should rarely do this without a lot of testing */ | |
1239 | #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) | |
1240 | ||
76adaa34 WF |
1241 | #define MAX_ELD_BYTES 128 |
1242 | ||
f453ba04 | 1243 | /** |
3bf0401c | 1244 | * struct drm_connector - central DRM connector control structure |
72252548 JB |
1245 | * @dev: parent DRM device |
1246 | * @kdev: kernel device for sysfs attributes | |
1247 | * @attr: sysfs attributes | |
1248 | * @head: list management | |
1249 | * @base: base KMS object | |
ac3ba4a5 | 1250 | * @name: human readable name, can be overwritten by the driver |
72252548 JB |
1251 | * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h |
1252 | * @connector_type_id: index into connector type enum | |
f453ba04 DA |
1253 | * @interlace_allowed: can this connector handle interlaced modes? |
1254 | * @doublescan_allowed: can this connector handle doublescan? | |
2c0c33d4 | 1255 | * @stereo_allowed: can this connector handle stereo modes? |
40daac61 | 1256 | * @registered: is this connector exposed (registered) with userspace? |
72252548 JB |
1257 | * @modes: modes available on this connector (from fill_modes() + user) |
1258 | * @status: one of the drm_connector_status enums (connected, not, or unknown) | |
1259 | * @probed_modes: list of modes derived directly from the display | |
1260 | * @display_info: information about attached display (e.g. from EDID) | |
f453ba04 | 1261 | * @funcs: connector control functions |
72252548 | 1262 | * @edid_blob_ptr: DRM property containing EDID if present |
7e3bdf4a | 1263 | * @properties: property tracking for this connector |
72252548 JB |
1264 | * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling |
1265 | * @dpms: current dpms state | |
1266 | * @helper_private: mid-layer private data | |
2c0c33d4 | 1267 | * @cmdline_mode: mode line parsed from the kernel cmdline for this connector |
72252548 | 1268 | * @force: a %DRM_FORCE_<foo> state for forced mode sets |
2c0c33d4 | 1269 | * @override_edid: has the EDID been overwritten through debugfs for testing? |
72252548 JB |
1270 | * @encoder_ids: valid encoders for this connector |
1271 | * @encoder: encoder driving this connector, if any | |
1272 | * @eld: EDID-like data, if present | |
1273 | * @dvi_dual: dual link DVI, if found | |
1274 | * @max_tmds_clock: max clock rate, if found | |
1275 | * @latency_present: AV delay info from ELD, if found | |
1276 | * @video_latency: video latency info from ELD, if found | |
1277 | * @audio_latency: audio latency info from ELD, if found | |
1278 | * @null_edid_counter: track sinks that give us all zeros for the EDID | |
2c0c33d4 | 1279 | * @bad_edid_counter: track sinks that give us an EDID with invalid checksum |
ac6f2e29 | 1280 | * @edid_corrupt: indicates whether the last read EDID was corrupt |
2c0c33d4 | 1281 | * @debugfs_entry: debugfs directory for this connector |
144ecb97 | 1282 | * @state: current atomic state for this connector |
40d9b043 DA |
1283 | * @has_tile: is this connector connected to a tiled monitor |
1284 | * @tile_group: tile group for the connected monitor | |
1285 | * @tile_is_single_monitor: whether the tile is one monitor housing | |
1286 | * @num_h_tile: number of horizontal tiles in the tile group | |
1287 | * @num_v_tile: number of vertical tiles in the tile group | |
1288 | * @tile_h_loc: horizontal location of this tile | |
1289 | * @tile_v_loc: vertical location of this tile | |
1290 | * @tile_h_size: horizontal size of this tile. | |
1291 | * @tile_v_size: vertical size of this tile. | |
f453ba04 DA |
1292 | * |
1293 | * Each connector may be connected to one or more CRTCs, or may be clonable by | |
1294 | * another connector if they can share a CRTC. Each connector also has a specific | |
1295 | * position in the broader display (referred to as a 'screen' though it could | |
1296 | * span multiple monitors). | |
1297 | */ | |
1298 | struct drm_connector { | |
1299 | struct drm_device *dev; | |
5bdebb18 | 1300 | struct device *kdev; |
f453ba04 DA |
1301 | struct device_attribute *attr; |
1302 | struct list_head head; | |
1303 | ||
1304 | struct drm_mode_object base; | |
1305 | ||
2abdd313 | 1306 | char *name; |
69425599 DV |
1307 | |
1308 | /** | |
1309 | * @index: Compacted connector index, which matches the position inside | |
1310 | * the mode_config.list for drivers not supporting hot-add/removing. Can | |
1311 | * be used as an array index. It is invariant over the lifetime of the | |
1312 | * connector. | |
1313 | */ | |
1314 | unsigned index; | |
1315 | ||
f453ba04 DA |
1316 | int connector_type; |
1317 | int connector_type_id; | |
1318 | bool interlace_allowed; | |
1319 | bool doublescan_allowed; | |
560a067a | 1320 | bool stereo_allowed; |
40daac61 | 1321 | bool registered; |
f453ba04 DA |
1322 | struct list_head modes; /* list of modes on this connector */ |
1323 | ||
f453ba04 DA |
1324 | enum drm_connector_status status; |
1325 | ||
1326 | /* these are modes added by probing with DDC or the BIOS */ | |
1327 | struct list_head probed_modes; | |
1328 | ||
1329 | struct drm_display_info display_info; | |
1330 | const struct drm_connector_funcs *funcs; | |
1331 | ||
f453ba04 | 1332 | struct drm_property_blob *edid_blob_ptr; |
7e3bdf4a | 1333 | struct drm_object_properties properties; |
f453ba04 | 1334 | |
ac3ba4a5 DV |
1335 | /** |
1336 | * @path_blob_ptr: | |
1337 | * | |
1338 | * DRM blob property data for the DP MST path property. | |
1339 | */ | |
43aba7eb DA |
1340 | struct drm_property_blob *path_blob_ptr; |
1341 | ||
ac3ba4a5 DV |
1342 | /** |
1343 | * @tile_blob_ptr: | |
1344 | * | |
1345 | * DRM blob property data for the tile property (used mostly by DP MST). | |
1346 | * This is meant for screens which are driven through separate display | |
1347 | * pipelines represented by &drm_crtc, which might not be running with | |
1348 | * genlocked clocks. For tiled panels which are genlocked, like | |
1349 | * dual-link LVDS or dual-link DSI, the driver should try to not expose | |
1350 | * the tiling and virtualize both &drm_crtc and &drm_plane if needed. | |
1351 | */ | |
6f134d7b DA |
1352 | struct drm_property_blob *tile_blob_ptr; |
1353 | ||
eb1f8e4f DA |
1354 | uint8_t polled; /* DRM_CONNECTOR_POLL_* */ |
1355 | ||
c9fb15f6 KP |
1356 | /* requested DPMS state */ |
1357 | int dpms; | |
1358 | ||
4490d4c7 | 1359 | const struct drm_connector_helper_funcs *helper_private; |
f453ba04 | 1360 | |
d50ba256 | 1361 | /* forced on connector */ |
eaf99c74 | 1362 | struct drm_cmdline_mode cmdline_mode; |
d50ba256 | 1363 | enum drm_connector_force force; |
4cf2b281 | 1364 | bool override_edid; |
f453ba04 | 1365 | uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER]; |
f453ba04 | 1366 | struct drm_encoder *encoder; /* currently active encoder */ |
4a9a8b71 | 1367 | |
76adaa34 WF |
1368 | /* EDID bits */ |
1369 | uint8_t eld[MAX_ELD_BYTES]; | |
1370 | bool dvi_dual; | |
1371 | int max_tmds_clock; /* in MHz */ | |
1372 | bool latency_present[2]; | |
1373 | int video_latency[2]; /* [0]: progressive, [1]: interlaced */ | |
1374 | int audio_latency[2]; | |
4a9a8b71 | 1375 | int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */ |
0b2443ed | 1376 | unsigned bad_edid_counter; |
30f65707 | 1377 | |
6ba2bd3d TP |
1378 | /* Flag for raw EDID header corruption - used in Displayport |
1379 | * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6 | |
1380 | */ | |
1381 | bool edid_corrupt; | |
1382 | ||
30f65707 | 1383 | struct dentry *debugfs_entry; |
144ecb97 DV |
1384 | |
1385 | struct drm_connector_state *state; | |
40d9b043 DA |
1386 | |
1387 | /* DisplayID bits */ | |
1388 | bool has_tile; | |
1389 | struct drm_tile_group *tile_group; | |
1390 | bool tile_is_single_monitor; | |
1391 | ||
1392 | uint8_t num_h_tile, num_v_tile; | |
1393 | uint8_t tile_h_loc, tile_v_loc; | |
1394 | uint16_t tile_h_size, tile_v_size; | |
144ecb97 DV |
1395 | }; |
1396 | ||
1397 | /** | |
1398 | * struct drm_plane_state - mutable plane state | |
07cc0ef6 | 1399 | * @plane: backpointer to the plane |
144ecb97 | 1400 | * @crtc: currently bound CRTC, NULL if disabled |
cc4ceb48 | 1401 | * @fb: currently bound framebuffer |
e2330f07 | 1402 | * @fence: optional fence to wait for before scanning out @fb |
144ecb97 DV |
1403 | * @crtc_x: left position of visible portion of plane on crtc |
1404 | * @crtc_y: upper position of visible portion of plane on crtc | |
1405 | * @crtc_w: width of visible portion of plane on crtc | |
1406 | * @crtc_h: height of visible portion of plane on crtc | |
1407 | * @src_x: left position of visible portion of plane within | |
1408 | * plane (in 16.16) | |
1409 | * @src_y: upper position of visible portion of plane within | |
1410 | * plane (in 16.16) | |
1411 | * @src_w: width of visible portion of plane (in 16.16) | |
1412 | * @src_h: height of visible portion of plane (in 16.16) | |
ac3ba4a5 | 1413 | * @rotation: rotation of the plane |
44d1240d MS |
1414 | * @zpos: priority of the given plane on crtc (optional) |
1415 | * @normalized_zpos: normalized value of zpos: unique, range from 0 to N-1 | |
1416 | * where N is the number of active planes for given crtc | |
144ecb97 DV |
1417 | * @state: backpointer to global drm_atomic_state |
1418 | */ | |
1419 | struct drm_plane_state { | |
07cc0ef6 DV |
1420 | struct drm_plane *plane; |
1421 | ||
6ddd388a RC |
1422 | struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */ |
1423 | struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */ | |
e2330f07 | 1424 | struct fence *fence; |
144ecb97 DV |
1425 | |
1426 | /* Signed dest location allows it to be partially off screen */ | |
1427 | int32_t crtc_x, crtc_y; | |
1428 | uint32_t crtc_w, crtc_h; | |
1429 | ||
1430 | /* Source values are 16.16 fixed point */ | |
1431 | uint32_t src_x, src_y; | |
1432 | uint32_t src_h, src_w; | |
1433 | ||
1da30627 MR |
1434 | /* Plane rotation */ |
1435 | unsigned int rotation; | |
1436 | ||
44d1240d MS |
1437 | /* Plane zpos */ |
1438 | unsigned int zpos; | |
1439 | unsigned int normalized_zpos; | |
1440 | ||
144ecb97 | 1441 | struct drm_atomic_state *state; |
f453ba04 DA |
1442 | }; |
1443 | ||
144ecb97 | 1444 | |
8cf5c917 | 1445 | /** |
3bf0401c | 1446 | * struct drm_plane_funcs - driver plane control functions |
8cf5c917 JB |
1447 | */ |
1448 | struct drm_plane_funcs { | |
88548636 DV |
1449 | /** |
1450 | * @update_plane: | |
1451 | * | |
1452 | * This is the legacy entry point to enable and configure the plane for | |
1453 | * the given CRTC and framebuffer. It is never called to disable the | |
1454 | * plane, i.e. the passed-in crtc and fb paramters are never NULL. | |
1455 | * | |
1456 | * The source rectangle in frame buffer memory coordinates is given by | |
1457 | * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point | |
1458 | * values). Devices that don't support subpixel plane coordinates can | |
1459 | * ignore the fractional part. | |
1460 | * | |
1461 | * The destination rectangle in CRTC coordinates is given by the | |
1462 | * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values). | |
1463 | * Devices scale the source rectangle to the destination rectangle. If | |
1464 | * scaling is not supported, and the source rectangle size doesn't match | |
1465 | * the destination rectangle size, the driver must return a | |
1466 | * -<errorname>EINVAL</errorname> error. | |
1467 | * | |
1468 | * Drivers implementing atomic modeset should use | |
1469 | * drm_atomic_helper_update_plane() to implement this hook. | |
1470 | * | |
1471 | * RETURNS: | |
1472 | * | |
1473 | * 0 on success or a negative error code on failure. | |
1474 | */ | |
8cf5c917 JB |
1475 | int (*update_plane)(struct drm_plane *plane, |
1476 | struct drm_crtc *crtc, struct drm_framebuffer *fb, | |
1477 | int crtc_x, int crtc_y, | |
1478 | unsigned int crtc_w, unsigned int crtc_h, | |
1479 | uint32_t src_x, uint32_t src_y, | |
1480 | uint32_t src_w, uint32_t src_h); | |
88548636 DV |
1481 | |
1482 | /** | |
1483 | * @disable_plane: | |
1484 | * | |
1485 | * This is the legacy entry point to disable the plane. The DRM core | |
c6b0ca3e | 1486 | * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call |
88548636 DV |
1487 | * with the frame buffer ID set to 0. Disabled planes must not be |
1488 | * processed by the CRTC. | |
1489 | * | |
1490 | * Drivers implementing atomic modeset should use | |
1491 | * drm_atomic_helper_disable_plane() to implement this hook. | |
1492 | * | |
1493 | * RETURNS: | |
1494 | * | |
1495 | * 0 on success or a negative error code on failure. | |
1496 | */ | |
8cf5c917 | 1497 | int (*disable_plane)(struct drm_plane *plane); |
88548636 DV |
1498 | |
1499 | /** | |
1500 | * @destroy: | |
1501 | * | |
1502 | * Clean up plane resources. This is only called at driver unload time | |
1503 | * through drm_mode_config_cleanup() since a plane cannot be hotplugged | |
1504 | * in DRM. | |
1505 | */ | |
8cf5c917 | 1506 | void (*destroy)(struct drm_plane *plane); |
88548636 DV |
1507 | |
1508 | /** | |
1509 | * @reset: | |
1510 | * | |
1511 | * Reset plane hardware and software state to off. This function isn't | |
1512 | * called by the core directly, only through drm_mode_config_reset(). | |
1513 | * It's not a helper hook only for historical reasons. | |
1514 | * | |
1515 | * Atomic drivers can use drm_atomic_helper_plane_reset() to reset | |
1516 | * atomic state using this hook. | |
1517 | */ | |
2a0d7cfd | 1518 | void (*reset)(struct drm_plane *plane); |
4d93914a | 1519 | |
88548636 DV |
1520 | /** |
1521 | * @set_property: | |
1522 | * | |
1523 | * This is the legacy entry point to update a property attached to the | |
1524 | * plane. | |
1525 | * | |
1526 | * Drivers implementing atomic modeset should use | |
1527 | * drm_atomic_helper_plane_set_property() to implement this hook. | |
1528 | * | |
1529 | * This callback is optional if the driver does not support any legacy | |
1530 | * driver-private properties. | |
1531 | * | |
1532 | * RETURNS: | |
1533 | * | |
1534 | * 0 on success or a negative error code on failure. | |
1535 | */ | |
4d93914a RC |
1536 | int (*set_property)(struct drm_plane *plane, |
1537 | struct drm_property *property, uint64_t val); | |
144ecb97 | 1538 | |
88548636 DV |
1539 | /** |
1540 | * @atomic_duplicate_state: | |
1541 | * | |
1542 | * Duplicate the current atomic state for this plane and return it. | |
1543 | * The core and helpers gurantee that any atomic state duplicated with | |
1544 | * this hook and still owned by the caller (i.e. not transferred to the | |
1545 | * driver by calling ->atomic_commit() from struct | |
1546 | * &drm_mode_config_funcs) will be cleaned up by calling the | |
1547 | * @atomic_destroy_state hook in this structure. | |
1548 | * | |
1549 | * Atomic drivers which don't subclass struct &drm_plane_state should use | |
1550 | * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the | |
1551 | * state structure to extend it with driver-private state should use | |
1552 | * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is | |
1553 | * duplicated in a consistent fashion across drivers. | |
1554 | * | |
1555 | * It is an error to call this hook before plane->state has been | |
1556 | * initialized correctly. | |
1557 | * | |
1558 | * NOTE: | |
1559 | * | |
1560 | * If the duplicate state references refcounted resources this hook must | |
1561 | * acquire a reference for each of them. The driver must release these | |
1562 | * references again in @atomic_destroy_state. | |
1563 | * | |
1564 | * RETURNS: | |
1565 | * | |
1566 | * Duplicated atomic state or NULL when the allocation failed. | |
1567 | */ | |
144ecb97 | 1568 | struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane); |
88548636 DV |
1569 | |
1570 | /** | |
1571 | * @atomic_destroy_state: | |
1572 | * | |
1573 | * Destroy a state duplicated with @atomic_duplicate_state and release | |
1574 | * or unreference all resources it references | |
1575 | */ | |
144ecb97 | 1576 | void (*atomic_destroy_state)(struct drm_plane *plane, |
cc4ceb48 | 1577 | struct drm_plane_state *state); |
88548636 DV |
1578 | |
1579 | /** | |
1580 | * @atomic_set_property: | |
1581 | * | |
1582 | * Decode a driver-private property value and store the decoded value | |
1583 | * into the passed-in state structure. Since the atomic core decodes all | |
1584 | * standardized properties (even for extensions beyond the core set of | |
1585 | * properties which might not be implemented by all drivers) this | |
1586 | * requires drivers to subclass the state structure. | |
1587 | * | |
1588 | * Such driver-private properties should really only be implemented for | |
1589 | * truly hardware/vendor specific state. Instead it is preferred to | |
1590 | * standardize atomic extension and decode the properties used to expose | |
1591 | * such an extension in the core. | |
1592 | * | |
1593 | * Do not call this function directly, use | |
1594 | * drm_atomic_plane_set_property() instead. | |
1595 | * | |
1596 | * This callback is optional if the driver does not support any | |
1597 | * driver-private atomic properties. | |
1598 | * | |
1599 | * NOTE: | |
1600 | * | |
1601 | * This function is called in the state assembly phase of atomic | |
1602 | * modesets, which can be aborted for any reason (including on | |
1603 | * userspace's request to just check whether a configuration would be | |
1604 | * possible). Drivers MUST NOT touch any persistent state (hardware or | |
1605 | * software) or data structures except the passed in @state parameter. | |
1606 | * | |
1607 | * Also since userspace controls in which order properties are set this | |
1608 | * function must not do any input validation (since the state update is | |
1609 | * incomplete and hence likely inconsistent). Instead any such input | |
1610 | * validation must be done in the various atomic_check callbacks. | |
1611 | * | |
1612 | * RETURNS: | |
1613 | * | |
1614 | * 0 if the property has been found, -EINVAL if the property isn't | |
1615 | * implemented by the driver (which shouldn't ever happen, the core only | |
1616 | * asks for properties attached to this plane). No other validation is | |
1617 | * allowed by the driver. The core already checks that the property | |
1618 | * value is within the range (integer, valid enum value, ...) the driver | |
1619 | * set when registering the property. | |
1620 | */ | |
144ecb97 DV |
1621 | int (*atomic_set_property)(struct drm_plane *plane, |
1622 | struct drm_plane_state *state, | |
1623 | struct drm_property *property, | |
1624 | uint64_t val); | |
88548636 DV |
1625 | |
1626 | /** | |
1627 | * @atomic_get_property: | |
1628 | * | |
1629 | * Reads out the decoded driver-private property. This is used to | |
c6b0ca3e | 1630 | * implement the GETPLANE IOCTL. |
88548636 DV |
1631 | * |
1632 | * Do not call this function directly, use | |
1633 | * drm_atomic_plane_get_property() instead. | |
1634 | * | |
1635 | * This callback is optional if the driver does not support any | |
1636 | * driver-private atomic properties. | |
1637 | * | |
1638 | * RETURNS: | |
1639 | * | |
1640 | * 0 on success, -EINVAL if the property isn't implemented by the | |
1641 | * driver (which should never happen, the core only asks for | |
1642 | * properties attached to this plane). | |
1643 | */ | |
ac9c9256 RC |
1644 | int (*atomic_get_property)(struct drm_plane *plane, |
1645 | const struct drm_plane_state *state, | |
1646 | struct drm_property *property, | |
1647 | uint64_t *val); | |
79190ea2 BG |
1648 | /** |
1649 | * @late_register: | |
1650 | * | |
1651 | * This optional hook can be used to register additional userspace | |
1652 | * interfaces attached to the plane like debugfs interfaces. | |
1653 | * It is called late in the driver load sequence from drm_dev_register(). | |
1654 | * Everything added from this callback should be unregistered in | |
1655 | * the early_unregister callback. | |
1656 | * | |
1657 | * Returns: | |
1658 | * | |
1659 | * 0 on success, or a negative error code on failure. | |
1660 | */ | |
1661 | int (*late_register)(struct drm_plane *plane); | |
1662 | ||
1663 | /** | |
1664 | * @early_unregister: | |
1665 | * | |
1666 | * This optional hook should be used to unregister the additional | |
1667 | * userspace interfaces attached to the plane from | |
1668 | * late_unregister(). It is called from drm_dev_unregister(), | |
1669 | * early in the driver unload sequence to disable userspace access | |
1670 | * before data structures are torndown. | |
1671 | */ | |
1672 | void (*early_unregister)(struct drm_plane *plane); | |
8cf5c917 JB |
1673 | }; |
1674 | ||
e27dde3e MR |
1675 | enum drm_plane_type { |
1676 | DRM_PLANE_TYPE_OVERLAY, | |
1677 | DRM_PLANE_TYPE_PRIMARY, | |
1678 | DRM_PLANE_TYPE_CURSOR, | |
1679 | }; | |
1680 | ||
88548636 | 1681 | |
8cf5c917 | 1682 | /** |
3bf0401c | 1683 | * struct drm_plane - central DRM plane control structure |
8cf5c917 JB |
1684 | * @dev: DRM device this plane belongs to |
1685 | * @head: for list management | |
ac3ba4a5 | 1686 | * @name: human readable name, can be overwritten by the driver |
8cf5c917 JB |
1687 | * @base: base mode object |
1688 | * @possible_crtcs: pipes this plane can be bound to | |
1689 | * @format_types: array of formats supported by this plane | |
1690 | * @format_count: number of formats supported | |
7eb5f302 | 1691 | * @format_default: driver hasn't supplied supported formats for the plane |
8cf5c917 JB |
1692 | * @crtc: currently bound CRTC |
1693 | * @fb: currently bound fb | |
2c0c33d4 DV |
1694 | * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by |
1695 | * drm_mode_set_config_internal() to implement correct refcounting. | |
8cf5c917 | 1696 | * @funcs: helper functions |
4d93914a | 1697 | * @properties: property tracking for this plane |
e27dde3e | 1698 | * @type: type of plane (overlay, primary, cursor) |
144ecb97 | 1699 | * @state: current atomic state for this plane |
44d1240d | 1700 | * @zpos_property: zpos property for this plane |
ac3ba4a5 | 1701 | * @helper_private: mid-layer private data |
8cf5c917 JB |
1702 | */ |
1703 | struct drm_plane { | |
1704 | struct drm_device *dev; | |
1705 | struct list_head head; | |
1706 | ||
9f4c97a2 VS |
1707 | char *name; |
1708 | ||
ac3ba4a5 DV |
1709 | /** |
1710 | * @mutex: | |
1711 | * | |
1712 | * Protects modeset plane state, together with the mutex of &drm_crtc | |
1713 | * this plane is linked to (when active, getting actived or getting | |
1714 | * disabled). | |
1715 | */ | |
4d02e2de DV |
1716 | struct drm_modeset_lock mutex; |
1717 | ||
8cf5c917 JB |
1718 | struct drm_mode_object base; |
1719 | ||
1720 | uint32_t possible_crtcs; | |
1721 | uint32_t *format_types; | |
45e3743a | 1722 | unsigned int format_count; |
7eb5f302 | 1723 | bool format_default; |
8cf5c917 JB |
1724 | |
1725 | struct drm_crtc *crtc; | |
1726 | struct drm_framebuffer *fb; | |
1727 | ||
3d30a59b DV |
1728 | struct drm_framebuffer *old_fb; |
1729 | ||
8cf5c917 | 1730 | const struct drm_plane_funcs *funcs; |
4d93914a RC |
1731 | |
1732 | struct drm_object_properties properties; | |
e27dde3e MR |
1733 | |
1734 | enum drm_plane_type type; | |
144ecb97 | 1735 | |
96094081 DV |
1736 | /** |
1737 | * @index: Position inside the mode_config.list, can be used as an array | |
1738 | * index. It is invariant over the lifetime of the plane. | |
1739 | */ | |
490d3d1b CW |
1740 | unsigned index; |
1741 | ||
4490d4c7 | 1742 | const struct drm_plane_helper_funcs *helper_private; |
c2fcd274 | 1743 | |
144ecb97 | 1744 | struct drm_plane_state *state; |
44d1240d MS |
1745 | |
1746 | struct drm_property *zpos_property; | |
8cf5c917 JB |
1747 | }; |
1748 | ||
3b336ec4 | 1749 | /** |
3bf0401c | 1750 | * struct drm_bridge_funcs - drm_bridge control functions |
3d3f8b1f | 1751 | * @attach: Called during drm_bridge_attach |
3b336ec4 SP |
1752 | */ |
1753 | struct drm_bridge_funcs { | |
3d3f8b1f | 1754 | int (*attach)(struct drm_bridge *bridge); |
da024fe5 DV |
1755 | |
1756 | /** | |
1757 | * @mode_fixup: | |
1758 | * | |
1759 | * This callback is used to validate and adjust a mode. The paramater | |
1760 | * mode is the display mode that should be fed to the next element in | |
1761 | * the display chain, either the final &drm_connector or the next | |
1762 | * &drm_bridge. The parameter adjusted_mode is the input mode the bridge | |
1763 | * requires. It can be modified by this callback and does not need to | |
1764 | * match mode. | |
1765 | * | |
1766 | * This is the only hook that allows a bridge to reject a modeset. If | |
1767 | * this function passes all other callbacks must succeed for this | |
1768 | * configuration. | |
1769 | * | |
1770 | * NOTE: | |
1771 | * | |
1772 | * This function is called in the check phase of atomic modesets, which | |
1773 | * can be aborted for any reason (including on userspace's request to | |
1774 | * just check whether a configuration would be possible). Drivers MUST | |
1775 | * NOT touch any persistent state (hardware or software) or data | |
88548636 | 1776 | * structures except the passed in @state parameter. |
da024fe5 DV |
1777 | * |
1778 | * RETURNS: | |
1779 | * | |
1780 | * True if an acceptable configuration is possible, false if the modeset | |
1781 | * operation should be rejected. | |
1782 | */ | |
3b336ec4 SP |
1783 | bool (*mode_fixup)(struct drm_bridge *bridge, |
1784 | const struct drm_display_mode *mode, | |
1785 | struct drm_display_mode *adjusted_mode); | |
da024fe5 DV |
1786 | /** |
1787 | * @disable: | |
1788 | * | |
1789 | * This callback should disable the bridge. It is called right before | |
1790 | * the preceding element in the display pipe is disabled. If the | |
1791 | * preceding element is a bridge this means it's called before that | |
1792 | * bridge's ->disable() function. If the preceding element is a | |
1793 | * &drm_encoder it's called right before the encoder's ->disable(), | |
1794 | * ->prepare() or ->dpms() hook from struct &drm_encoder_helper_funcs. | |
1795 | * | |
1796 | * The bridge can assume that the display pipe (i.e. clocks and timing | |
1797 | * signals) feeding it is still running when this callback is called. | |
c8a3b2ae LP |
1798 | * |
1799 | * The disable callback is optional. | |
da024fe5 | 1800 | */ |
3b336ec4 | 1801 | void (*disable)(struct drm_bridge *bridge); |
da024fe5 DV |
1802 | |
1803 | /** | |
1804 | * @post_disable: | |
1805 | * | |
1806 | * This callback should disable the bridge. It is called right after | |
1807 | * the preceding element in the display pipe is disabled. If the | |
1808 | * preceding element is a bridge this means it's called after that | |
1809 | * bridge's ->post_disable() function. If the preceding element is a | |
1810 | * &drm_encoder it's called right after the encoder's ->disable(), | |
1811 | * ->prepare() or ->dpms() hook from struct &drm_encoder_helper_funcs. | |
1812 | * | |
1813 | * The bridge must assume that the display pipe (i.e. clocks and timing | |
1814 | * singals) feeding it is no longer running when this callback is | |
1815 | * called. | |
c8a3b2ae LP |
1816 | * |
1817 | * The post_disable callback is optional. | |
da024fe5 | 1818 | */ |
3b336ec4 | 1819 | void (*post_disable)(struct drm_bridge *bridge); |
da024fe5 DV |
1820 | |
1821 | /** | |
1822 | * @mode_set: | |
1823 | * | |
1824 | * This callback should set the given mode on the bridge. It is called | |
1825 | * after the ->mode_set() callback for the preceding element in the | |
1826 | * display pipeline has been called already. The display pipe (i.e. | |
1827 | * clocks and timing signals) is off when this function is called. | |
1828 | */ | |
3b336ec4 SP |
1829 | void (*mode_set)(struct drm_bridge *bridge, |
1830 | struct drm_display_mode *mode, | |
1831 | struct drm_display_mode *adjusted_mode); | |
da024fe5 DV |
1832 | /** |
1833 | * @pre_enable: | |
1834 | * | |
1835 | * This callback should enable the bridge. It is called right before | |
1836 | * the preceding element in the display pipe is enabled. If the | |
1837 | * preceding element is a bridge this means it's called before that | |
1838 | * bridge's ->pre_enable() function. If the preceding element is a | |
1839 | * &drm_encoder it's called right before the encoder's ->enable(), | |
1840 | * ->commit() or ->dpms() hook from struct &drm_encoder_helper_funcs. | |
1841 | * | |
1842 | * The display pipe (i.e. clocks and timing signals) feeding this bridge | |
1843 | * will not yet be running when this callback is called. The bridge must | |
1844 | * not enable the display link feeding the next bridge in the chain (if | |
1845 | * there is one) when this callback is called. | |
c8a3b2ae LP |
1846 | * |
1847 | * The pre_enable callback is optional. | |
da024fe5 | 1848 | */ |
3b336ec4 | 1849 | void (*pre_enable)(struct drm_bridge *bridge); |
da024fe5 DV |
1850 | |
1851 | /** | |
1852 | * @enable: | |
1853 | * | |
1854 | * This callback should enable the bridge. It is called right after | |
1855 | * the preceding element in the display pipe is enabled. If the | |
1856 | * preceding element is a bridge this means it's called after that | |
1857 | * bridge's ->enable() function. If the preceding element is a | |
1858 | * &drm_encoder it's called right after the encoder's ->enable(), | |
1859 | * ->commit() or ->dpms() hook from struct &drm_encoder_helper_funcs. | |
1860 | * | |
1861 | * The bridge can assume that the display pipe (i.e. clocks and timing | |
1862 | * signals) feeding it is running when this callback is called. This | |
1863 | * callback must enable the display link feeding the next bridge in the | |
1864 | * chain if there is one. | |
c8a3b2ae LP |
1865 | * |
1866 | * The enable callback is optional. | |
da024fe5 | 1867 | */ |
3b336ec4 | 1868 | void (*enable)(struct drm_bridge *bridge); |
3b336ec4 SP |
1869 | }; |
1870 | ||
1871 | /** | |
3bf0401c | 1872 | * struct drm_bridge - central DRM bridge control structure |
3b336ec4 | 1873 | * @dev: DRM device this bridge belongs to |
862e686c AT |
1874 | * @encoder: encoder to which this bridge is connected |
1875 | * @next: the next bridge in the encoder chain | |
3d3f8b1f AK |
1876 | * @of_node: device node pointer to the bridge |
1877 | * @list: to keep track of all added bridges | |
3b336ec4 SP |
1878 | * @funcs: control functions |
1879 | * @driver_private: pointer to the bridge driver's internal context | |
1880 | */ | |
1881 | struct drm_bridge { | |
1882 | struct drm_device *dev; | |
3d3f8b1f | 1883 | struct drm_encoder *encoder; |
862e686c | 1884 | struct drm_bridge *next; |
3d3f8b1f AK |
1885 | #ifdef CONFIG_OF |
1886 | struct device_node *of_node; | |
1887 | #endif | |
1888 | struct list_head list; | |
3b336ec4 SP |
1889 | |
1890 | const struct drm_bridge_funcs *funcs; | |
1891 | void *driver_private; | |
1892 | }; | |
1893 | ||
3b24f7d6 DV |
1894 | /** |
1895 | * struct drm_crtc_commit - track modeset commits on a CRTC | |
1896 | * | |
1897 | * This structure is used to track pending modeset changes and atomic commit on | |
1898 | * a per-CRTC basis. Since updating the list should never block this structure | |
1899 | * is reference counted to allow waiters to safely wait on an event to complete, | |
1900 | * without holding any locks. | |
1901 | * | |
1902 | * It has 3 different events in total to allow a fine-grained synchronization | |
1903 | * between outstanding updates:: | |
1904 | * | |
1905 | * atomic commit thread hardware | |
1906 | * | |
1907 | * write new state into hardware ----> ... | |
1908 | * signal hw_done | |
1909 | * switch to new state on next | |
1910 | * ... v/hblank | |
1911 | * | |
1912 | * wait for buffers to show up ... | |
1913 | * | |
1914 | * ... send completion irq | |
1915 | * irq handler signals flip_done | |
1916 | * cleanup old buffers | |
1917 | * | |
1918 | * signal cleanup_done | |
1919 | * | |
1920 | * wait for flip_done <---- | |
1921 | * clean up atomic state | |
1922 | * | |
1923 | * The important bit to know is that cleanup_done is the terminal event, but the | |
1924 | * ordering between flip_done and hw_done is entirely up to the specific driver | |
1925 | * and modeset state change. | |
1926 | * | |
1927 | * For an implementation of how to use this look at | |
1928 | * drm_atomic_helper_setup_commit() from the atomic helper library. | |
1929 | */ | |
1930 | struct drm_crtc_commit { | |
1931 | /** | |
1932 | * @crtc: | |
1933 | * | |
1934 | * DRM CRTC for this commit. | |
1935 | */ | |
1936 | struct drm_crtc *crtc; | |
1937 | ||
1938 | /** | |
1939 | * @ref: | |
1940 | * | |
1941 | * Reference count for this structure. Needed to allow blocking on | |
1942 | * completions without the risk of the completion disappearing | |
1943 | * meanwhile. | |
1944 | */ | |
1945 | struct kref ref; | |
1946 | ||
1947 | /** | |
1948 | * @flip_done: | |
1949 | * | |
1950 | * Will be signaled when the hardware has flipped to the new set of | |
1951 | * buffers. Signals at the same time as when the drm event for this | |
1952 | * commit is sent to userspace, or when an out-fence is singalled. Note | |
1953 | * that for most hardware, in most cases this happens after @hw_done is | |
1954 | * signalled. | |
1955 | */ | |
1956 | struct completion flip_done; | |
1957 | ||
1958 | /** | |
1959 | * @hw_done: | |
1960 | * | |
1961 | * Will be signalled when all hw register changes for this commit have | |
1962 | * been written out. Especially when disabling a pipe this can be much | |
1963 | * later than than @flip_done, since that can signal already when the | |
1964 | * screen goes black, whereas to fully shut down a pipe more register | |
1965 | * I/O is required. | |
1966 | * | |
1967 | * Note that this does not need to include separately reference-counted | |
1968 | * resources like backing storage buffer pinning, or runtime pm | |
1969 | * management. | |
1970 | */ | |
1971 | struct completion hw_done; | |
1972 | ||
1973 | /** | |
1974 | * @cleanup_done: | |
1975 | * | |
1976 | * Will be signalled after old buffers have been cleaned up by calling | |
1977 | * drm_atomic_helper_cleanup_planes(). Since this can only happen after | |
1978 | * a vblank wait completed it might be a bit later. This completion is | |
1979 | * useful to throttle updates and avoid hardware updates getting ahead | |
1980 | * of the buffer cleanup too much. | |
1981 | */ | |
1982 | struct completion cleanup_done; | |
1983 | ||
1984 | /** | |
1985 | * @commit_entry: | |
1986 | * | |
1987 | * Entry on the per-CRTC commit_list. Protected by crtc->commit_lock. | |
1988 | */ | |
1989 | struct list_head commit_entry; | |
1990 | ||
1991 | /** | |
1992 | * @event: | |
1993 | * | |
1994 | * &drm_pending_vblank_event pointer to clean up private events. | |
1995 | */ | |
1996 | struct drm_pending_vblank_event *event; | |
1997 | }; | |
1998 | ||
b8b5342b DV |
1999 | struct __drm_planes_state { |
2000 | struct drm_plane *ptr; | |
2001 | struct drm_plane_state *state; | |
2002 | }; | |
2003 | ||
5d943aa6 DV |
2004 | struct __drm_crtcs_state { |
2005 | struct drm_crtc *ptr; | |
2006 | struct drm_crtc_state *state; | |
3b24f7d6 | 2007 | struct drm_crtc_commit *commit; |
5d943aa6 DV |
2008 | }; |
2009 | ||
63e83c1d DV |
2010 | struct __drm_connnectors_state { |
2011 | struct drm_connector *ptr; | |
2012 | struct drm_connector_state *state; | |
2013 | }; | |
2014 | ||
cc4ceb48 | 2015 | /** |
08855fae | 2016 | * struct drm_atomic_state - the global state object for atomic updates |
cc4ceb48 | 2017 | * @dev: parent DRM device |
d34f20d6 | 2018 | * @allow_modeset: allow full modeset |
c6b0ca3e | 2019 | * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics |
40616a26 | 2020 | * @legacy_set_config: Disable conflicting encoders instead of failing with -EINVAL. |
b8b5342b | 2021 | * @planes: pointer to array of structures with per-plane data |
cc4ceb48 | 2022 | * @crtcs: pointer to array of CRTC pointers |
f52b69f1 | 2023 | * @num_connector: size of the @connectors and @connector_states arrays |
63e83c1d | 2024 | * @connectors: pointer to array of structures with per-connector data |
cc4ceb48 DV |
2025 | * @acquire_ctx: acquire context for this atomic modeset state update |
2026 | */ | |
2027 | struct drm_atomic_state { | |
2028 | struct drm_device *dev; | |
d34f20d6 | 2029 | bool allow_modeset : 1; |
f02ad907 | 2030 | bool legacy_cursor_update : 1; |
40616a26 | 2031 | bool legacy_set_config : 1; |
b8b5342b | 2032 | struct __drm_planes_state *planes; |
5d943aa6 | 2033 | struct __drm_crtcs_state *crtcs; |
f52b69f1 | 2034 | int num_connector; |
63e83c1d | 2035 | struct __drm_connnectors_state *connectors; |
cc4ceb48 DV |
2036 | |
2037 | struct drm_modeset_acquire_ctx *acquire_ctx; | |
3b24f7d6 DV |
2038 | |
2039 | /** | |
2040 | * @commit_work: | |
2041 | * | |
2042 | * Work item which can be used by the driver or helpers to execute the | |
2043 | * commit without blocking. | |
2044 | */ | |
2045 | struct work_struct commit_work; | |
cc4ceb48 DV |
2046 | }; |
2047 | ||
2048 | ||
f453ba04 | 2049 | /** |
3bf0401c | 2050 | * struct drm_mode_set - new values for a CRTC config change |
ef27351a JB |
2051 | * @fb: framebuffer to use for new config |
2052 | * @crtc: CRTC whose configuration we're about to change | |
2053 | * @mode: mode timings to use | |
2054 | * @x: position of this CRTC relative to @fb | |
2055 | * @y: position of this CRTC relative to @fb | |
2056 | * @connectors: array of connectors to drive with this CRTC if possible | |
2057 | * @num_connectors: size of @connectors array | |
f453ba04 DA |
2058 | * |
2059 | * Represents a single crtc the connectors that it drives with what mode | |
2060 | * and from which framebuffer it scans out from. | |
2061 | * | |
2062 | * This is used to set modes. | |
2063 | */ | |
2064 | struct drm_mode_set { | |
f453ba04 DA |
2065 | struct drm_framebuffer *fb; |
2066 | struct drm_crtc *crtc; | |
2067 | struct drm_display_mode *mode; | |
2068 | ||
2069 | uint32_t x; | |
2070 | uint32_t y; | |
2071 | ||
2072 | struct drm_connector **connectors; | |
2073 | size_t num_connectors; | |
2074 | }; | |
2075 | ||
2076 | /** | |
550cebcd | 2077 | * struct drm_mode_config_funcs - basic driver provided mode setting functions |
550cebcd JB |
2078 | * |
2079 | * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that | |
2080 | * involve drivers. | |
f453ba04 DA |
2081 | */ |
2082 | struct drm_mode_config_funcs { | |
9953f417 DV |
2083 | /** |
2084 | * @fb_create: | |
2085 | * | |
2086 | * Create a new framebuffer object. The core does basic checks on the | |
2087 | * requested metadata, but most of that is left to the driver. See | |
2088 | * struct &drm_mode_fb_cmd2 for details. | |
2089 | * | |
d55f5320 DV |
2090 | * If the parameters are deemed valid and the backing storage objects in |
2091 | * the underlying memory manager all exist, then the driver allocates | |
2092 | * a new &drm_framebuffer structure, subclassed to contain | |
2093 | * driver-specific information (like the internal native buffer object | |
2094 | * references). It also needs to fill out all relevant metadata, which | |
2095 | * should be done by calling drm_helper_mode_fill_fb_struct(). | |
2096 | * | |
2097 | * The initialization is finalized by calling drm_framebuffer_init(), | |
2098 | * which registers the framebuffer and makes it accessible to other | |
2099 | * threads. | |
2100 | * | |
9953f417 DV |
2101 | * RETURNS: |
2102 | * | |
2103 | * A new framebuffer with an initial reference count of 1 or a negative | |
2104 | * error code encoded with ERR_PTR(). | |
2105 | */ | |
550cebcd JB |
2106 | struct drm_framebuffer *(*fb_create)(struct drm_device *dev, |
2107 | struct drm_file *file_priv, | |
1eb83451 | 2108 | const struct drm_mode_fb_cmd2 *mode_cmd); |
9953f417 DV |
2109 | |
2110 | /** | |
2111 | * @output_poll_changed: | |
2112 | * | |
2113 | * Callback used by helpers to inform the driver of output configuration | |
2114 | * changes. | |
2115 | * | |
2116 | * Drivers implementing fbdev emulation with the helpers can call | |
2117 | * drm_fb_helper_hotplug_changed from this hook to inform the fbdev | |
2118 | * helper of output changes. | |
2119 | * | |
2120 | * FIXME: | |
2121 | * | |
2122 | * Except that there's no vtable for device-level helper callbacks | |
2123 | * there's no reason this is a core function. | |
2124 | */ | |
eb1f8e4f | 2125 | void (*output_poll_changed)(struct drm_device *dev); |
cc4ceb48 | 2126 | |
9953f417 DV |
2127 | /** |
2128 | * @atomic_check: | |
2129 | * | |
2130 | * This is the only hook to validate an atomic modeset update. This | |
2131 | * function must reject any modeset and state changes which the hardware | |
2132 | * or driver doesn't support. This includes but is of course not limited | |
2133 | * to: | |
2134 | * | |
2135 | * - Checking that the modes, framebuffers, scaling and placement | |
2136 | * requirements and so on are within the limits of the hardware. | |
2137 | * | |
2138 | * - Checking that any hidden shared resources are not oversubscribed. | |
2139 | * This can be shared PLLs, shared lanes, overall memory bandwidth, | |
2140 | * display fifo space (where shared between planes or maybe even | |
2141 | * CRTCs). | |
2142 | * | |
2143 | * - Checking that virtualized resources exported to userspace are not | |
2144 | * oversubscribed. For various reasons it can make sense to expose | |
2145 | * more planes, crtcs or encoders than which are physically there. One | |
2146 | * example is dual-pipe operations (which generally should be hidden | |
2147 | * from userspace if when lockstepped in hardware, exposed otherwise), | |
2148 | * where a plane might need 1 hardware plane (if it's just on one | |
2149 | * pipe), 2 hardware planes (when it spans both pipes) or maybe even | |
2150 | * shared a hardware plane with a 2nd plane (if there's a compatible | |
2151 | * plane requested on the area handled by the other pipe). | |
2152 | * | |
2153 | * - Check that any transitional state is possible and that if | |
2154 | * requested, the update can indeed be done in the vblank period | |
2155 | * without temporarily disabling some functions. | |
2156 | * | |
2157 | * - Check any other constraints the driver or hardware might have. | |
2158 | * | |
2159 | * - This callback also needs to correctly fill out the &drm_crtc_state | |
2160 | * in this update to make sure that drm_atomic_crtc_needs_modeset() | |
2161 | * reflects the nature of the possible update and returns true if and | |
2162 | * only if the update cannot be applied without tearing within one | |
2163 | * vblank on that CRTC. The core uses that information to reject | |
2164 | * updates which require a full modeset (i.e. blanking the screen, or | |
2165 | * at least pausing updates for a substantial amount of time) if | |
2166 | * userspace has disallowed that in its request. | |
2167 | * | |
2168 | * - The driver also does not need to repeat basic input validation | |
2169 | * like done for the corresponding legacy entry points. The core does | |
2170 | * that before calling this hook. | |
2171 | * | |
2172 | * See the documentation of @atomic_commit for an exhaustive list of | |
2173 | * error conditions which don't have to be checked at the | |
2174 | * ->atomic_check() stage? | |
2175 | * | |
2176 | * See the documentation for struct &drm_atomic_state for how exactly | |
2177 | * an atomic modeset update is described. | |
2178 | * | |
2179 | * Drivers using the atomic helpers can implement this hook using | |
2180 | * drm_atomic_helper_check(), or one of the exported sub-functions of | |
2181 | * it. | |
2182 | * | |
2183 | * RETURNS: | |
2184 | * | |
2185 | * 0 on success or one of the below negative error codes: | |
2186 | * | |
2187 | * - -EINVAL, if any of the above constraints are violated. | |
2188 | * | |
2189 | * - -EDEADLK, when returned from an attempt to acquire an additional | |
2190 | * &drm_modeset_lock through drm_modeset_lock(). | |
2191 | * | |
2192 | * - -ENOMEM, if allocating additional state sub-structures failed due | |
2193 | * to lack of memory. | |
2194 | * | |
2195 | * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted. | |
2196 | * This can either be due to a pending signal, or because the driver | |
2197 | * needs to completely bail out to recover from an exceptional | |
2198 | * situation like a GPU hang. From a userspace point all errors are | |
2199 | * treated equally. | |
2200 | */ | |
cc4ceb48 | 2201 | int (*atomic_check)(struct drm_device *dev, |
9953f417 DV |
2202 | struct drm_atomic_state *state); |
2203 | ||
2204 | /** | |
2205 | * @atomic_commit: | |
2206 | * | |
2207 | * This is the only hook to commit an atomic modeset update. The core | |
2208 | * guarantees that @atomic_check has been called successfully before | |
2209 | * calling this function, and that nothing has been changed in the | |
2210 | * interim. | |
2211 | * | |
2212 | * See the documentation for struct &drm_atomic_state for how exactly | |
2213 | * an atomic modeset update is described. | |
2214 | * | |
2215 | * Drivers using the atomic helpers can implement this hook using | |
2216 | * drm_atomic_helper_commit(), or one of the exported sub-functions of | |
2217 | * it. | |
2218 | * | |
286dbb8d | 2219 | * Nonblocking commits (as indicated with the nonblock parameter) must |
9953f417 DV |
2220 | * do any preparatory work which might result in an unsuccessful commit |
2221 | * in the context of this callback. The only exceptions are hardware | |
2222 | * errors resulting in -EIO. But even in that case the driver must | |
2223 | * ensure that the display pipe is at least running, to avoid | |
2224 | * compositors crashing when pageflips don't work. Anything else, | |
2225 | * specifically committing the update to the hardware, should be done | |
2226 | * without blocking the caller. For updates which do not require a | |
2227 | * modeset this must be guaranteed. | |
2228 | * | |
2229 | * The driver must wait for any pending rendering to the new | |
2230 | * framebuffers to complete before executing the flip. It should also | |
2231 | * wait for any pending rendering from other drivers if the underlying | |
286dbb8d | 2232 | * buffer is a shared dma-buf. Nonblocking commits must not wait for |
9953f417 DV |
2233 | * rendering in the context of this callback. |
2234 | * | |
2235 | * An application can request to be notified when the atomic commit has | |
2236 | * completed. These events are per-CRTC and can be distinguished by the | |
2237 | * CRTC index supplied in &drm_event to userspace. | |
2238 | * | |
2239 | * The drm core will supply a struct &drm_event in the event | |
2240 | * member of each CRTC's &drm_crtc_state structure. This can be handled by the | |
2241 | * drm_crtc_send_vblank_event() function, which the driver should call on | |
2242 | * the provided event upon completion of the atomic commit. Note that if | |
2243 | * the driver supports vblank signalling and timestamping the vblank | |
2244 | * counters and timestamps must agree with the ones returned from page | |
2245 | * flip events. With the current vblank helper infrastructure this can | |
2246 | * be achieved by holding a vblank reference while the page flip is | |
2247 | * pending, acquired through drm_crtc_vblank_get() and released with | |
2248 | * drm_crtc_vblank_put(). Drivers are free to implement their own vblank | |
2249 | * counter and timestamp tracking though, e.g. if they have accurate | |
2250 | * timestamp registers in hardware. | |
2251 | * | |
2252 | * NOTE: | |
2253 | * | |
2254 | * Drivers are not allowed to shut down any display pipe successfully | |
2255 | * enabled through an atomic commit on their own. Doing so can result in | |
2256 | * compositors crashing if a page flip is suddenly rejected because the | |
2257 | * pipe is off. | |
2258 | * | |
2259 | * RETURNS: | |
2260 | * | |
2261 | * 0 on success or one of the below negative error codes: | |
2262 | * | |
286dbb8d | 2263 | * - -EBUSY, if a nonblocking updated is requested and there is |
9953f417 DV |
2264 | * an earlier updated pending. Drivers are allowed to support a queue |
2265 | * of outstanding updates, but currently no driver supports that. | |
2266 | * Note that drivers must wait for preceding updates to complete if a | |
2267 | * synchronous update is requested, they are not allowed to fail the | |
2268 | * commit in that case. | |
2269 | * | |
2270 | * - -ENOMEM, if the driver failed to allocate memory. Specifically | |
2271 | * this can happen when trying to pin framebuffers, which must only | |
2272 | * be done when committing the state. | |
2273 | * | |
2274 | * - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate | |
2275 | * that the driver has run out of vram, iommu space or similar GPU | |
2276 | * address space needed for framebuffer. | |
2277 | * | |
2278 | * - -EIO, if the hardware completely died. | |
2279 | * | |
2280 | * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted. | |
2281 | * This can either be due to a pending signal, or because the driver | |
2282 | * needs to completely bail out to recover from an exceptional | |
2283 | * situation like a GPU hang. From a userspace point of view all errors are | |
2284 | * treated equally. | |
2285 | * | |
2286 | * This list is exhaustive. Specifically this hook is not allowed to | |
2287 | * return -EINVAL (any invalid requests should be caught in | |
2288 | * @atomic_check) or -EDEADLK (this function must not acquire | |
2289 | * additional modeset locks). | |
2290 | */ | |
cc4ceb48 | 2291 | int (*atomic_commit)(struct drm_device *dev, |
9953f417 | 2292 | struct drm_atomic_state *state, |
286dbb8d | 2293 | bool nonblock); |
9953f417 DV |
2294 | |
2295 | /** | |
2296 | * @atomic_state_alloc: | |
2297 | * | |
2298 | * This optional hook can be used by drivers that want to subclass struct | |
2299 | * &drm_atomic_state to be able to track their own driver-private global | |
2300 | * state easily. If this hook is implemented, drivers must also | |
2301 | * implement @atomic_state_clear and @atomic_state_free. | |
2302 | * | |
2303 | * RETURNS: | |
2304 | * | |
2305 | * A new &drm_atomic_state on success or NULL on failure. | |
2306 | */ | |
036ef573 | 2307 | struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev); |
9953f417 DV |
2308 | |
2309 | /** | |
2310 | * @atomic_state_clear: | |
2311 | * | |
2312 | * This hook must clear any driver private state duplicated into the | |
2313 | * passed-in &drm_atomic_state. This hook is called when the caller | |
2314 | * encountered a &drm_modeset_lock deadlock and needs to drop all | |
2315 | * already acquired locks as part of the deadlock avoidance dance | |
2316 | * implemented in drm_modeset_lock_backoff(). | |
2317 | * | |
2318 | * Any duplicated state must be invalidated since a concurrent atomic | |
2319 | * update might change it, and the drm atomic interfaces always apply | |
2320 | * updates as relative changes to the current state. | |
2321 | * | |
2322 | * Drivers that implement this must call drm_atomic_state_default_clear() | |
2323 | * to clear common state. | |
2324 | */ | |
036ef573 | 2325 | void (*atomic_state_clear)(struct drm_atomic_state *state); |
9953f417 DV |
2326 | |
2327 | /** | |
2328 | * @atomic_state_free: | |
2329 | * | |
2330 | * This hook needs driver private resources and the &drm_atomic_state | |
2331 | * itself. Note that the core first calls drm_atomic_state_clear() to | |
2332 | * avoid code duplicate between the clear and free hooks. | |
2333 | * | |
2334 | * Drivers that implement this must call drm_atomic_state_default_free() | |
2335 | * to release common resources. | |
2336 | */ | |
036ef573 | 2337 | void (*atomic_state_free)(struct drm_atomic_state *state); |
f453ba04 DA |
2338 | }; |
2339 | ||
f453ba04 | 2340 | /** |
2c0c33d4 | 2341 | * struct drm_mode_config - Mode configuration control structure |
a62c93d5 | 2342 | * @mutex: mutex protecting KMS related lists and structures |
2c0c33d4 DV |
2343 | * @connection_mutex: ww mutex protecting connector state and routing |
2344 | * @acquire_ctx: global implicit acquire context used by atomic drivers for | |
c6b0ca3e | 2345 | * legacy IOCTLs |
2c0c33d4 | 2346 | * @fb_lock: mutex to protect fb state and lists |
a62c93d5 JB |
2347 | * @num_fb: number of fbs available |
2348 | * @fb_list: list of framebuffers available | |
a62c93d5 JB |
2349 | * @num_encoder: number of encoders on this device |
2350 | * @encoder_list: list of encoder objects | |
2c0c33d4 DV |
2351 | * @num_overlay_plane: number of overlay planes on this device |
2352 | * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device | |
2353 | * @plane_list: list of plane objects | |
a62c93d5 JB |
2354 | * @num_crtc: number of CRTCs on this device |
2355 | * @crtc_list: list of CRTC objects | |
2c0c33d4 | 2356 | * @property_list: list of property objects |
a62c93d5 JB |
2357 | * @min_width: minimum pixel width on this device |
2358 | * @min_height: minimum pixel height on this device | |
2359 | * @max_width: maximum pixel width on this device | |
2360 | * @max_height: maximum pixel height on this device | |
2361 | * @funcs: core driver provided mode setting functions | |
2362 | * @fb_base: base address of the framebuffer | |
2c0c33d4 DV |
2363 | * @poll_enabled: track polling support for this device |
2364 | * @poll_running: track polling status for this device | |
ac3ba4a5 | 2365 | * @delayed_event: track delayed poll uevent deliver for this device |
a62c93d5 | 2366 | * @output_poll_work: delayed work for polling in process context |
2c0c33d4 | 2367 | * @property_blob_list: list of all the blob property objects |
8fb6e7a5 | 2368 | * @blob_lock: mutex for blob property allocation and management |
a62c93d5 | 2369 | * @*_property: core property tracking |
2c0c33d4 DV |
2370 | * @preferred_depth: preferred RBG pixel depth, used by fb helpers |
2371 | * @prefer_shadow: hint to userspace to prefer shadow-fb rendering | |
2c0c33d4 DV |
2372 | * @cursor_width: hint to userspace for max cursor width |
2373 | * @cursor_height: hint to userspace for max cursor height | |
9f2a7950 | 2374 | * @helper_private: mid-layer private data |
f453ba04 | 2375 | * |
a62c93d5 JB |
2376 | * Core mode resource tracking structure. All CRTC, encoders, and connectors |
2377 | * enumerated by the driver are added here, as are global properties. Some | |
2378 | * global restrictions are also here, e.g. dimension restrictions. | |
f453ba04 DA |
2379 | */ |
2380 | struct drm_mode_config { | |
ad2563c2 | 2381 | struct mutex mutex; /* protects configuration (mode lists etc.) */ |
51fd371b RC |
2382 | struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */ |
2383 | struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */ | |
ac3ba4a5 DV |
2384 | |
2385 | /** | |
2386 | * @idr_mutex: | |
2387 | * | |
2388 | * Mutex for KMS ID allocation and management. Protects both @crtc_idr | |
2389 | * and @tile_idr. | |
2390 | */ | |
2391 | struct mutex idr_mutex; | |
2392 | ||
2393 | /** | |
2394 | * @crtc_idr: | |
2395 | * | |
2396 | * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc, | |
2397 | * connector, modes - just makes life easier to have only one. | |
2398 | */ | |
2399 | struct idr crtc_idr; | |
2400 | ||
2401 | /** | |
2402 | * @tile_idr: | |
2403 | * | |
2404 | * Use this idr for allocating new IDs for tiled sinks like use in some | |
2405 | * high-res DP MST screens. | |
2406 | */ | |
2407 | struct idr tile_idr; | |
4b096ac1 | 2408 | |
2c0c33d4 | 2409 | struct mutex fb_lock; /* proctects global and per-file fb lists */ |
f453ba04 DA |
2410 | int num_fb; |
2411 | struct list_head fb_list; | |
4b096ac1 | 2412 | |
96094081 DV |
2413 | /** |
2414 | * @num_connector: Number of connectors on this device. | |
2415 | */ | |
f453ba04 | 2416 | int num_connector; |
96094081 DV |
2417 | /** |
2418 | * @connector_ida: ID allocator for connector indices. | |
2419 | */ | |
5fff80bb | 2420 | struct ida connector_ida; |
96094081 DV |
2421 | /** |
2422 | * @connector_list: List of connector objects. | |
2423 | */ | |
f453ba04 DA |
2424 | struct list_head connector_list; |
2425 | int num_encoder; | |
2426 | struct list_head encoder_list; | |
e27dde3e MR |
2427 | |
2428 | /* | |
2429 | * Track # of overlay planes separately from # of total planes. By | |
2430 | * default we only advertise overlay planes to userspace; if userspace | |
2431 | * sets the "universal plane" capability bit, we'll go ahead and | |
2432 | * expose all planes. | |
2433 | */ | |
2434 | int num_overlay_plane; | |
2435 | int num_total_plane; | |
8cf5c917 | 2436 | struct list_head plane_list; |
f453ba04 DA |
2437 | |
2438 | int num_crtc; | |
2439 | struct list_head crtc_list; | |
2440 | ||
2441 | struct list_head property_list; | |
2442 | ||
f453ba04 DA |
2443 | int min_width, min_height; |
2444 | int max_width, max_height; | |
e6ecefaa | 2445 | const struct drm_mode_config_funcs *funcs; |
d883f7f1 | 2446 | resource_size_t fb_base; |
f453ba04 | 2447 | |
eb1f8e4f DA |
2448 | /* output poll support */ |
2449 | bool poll_enabled; | |
905bc9ff | 2450 | bool poll_running; |
162b6a57 | 2451 | bool delayed_event; |
991ea75c | 2452 | struct delayed_work output_poll_work; |
eb1f8e4f | 2453 | |
8fb6e7a5 DS |
2454 | struct mutex blob_lock; |
2455 | ||
f453ba04 DA |
2456 | /* pointers to standard properties */ |
2457 | struct list_head property_blob_list; | |
9a6bc03c DV |
2458 | /** |
2459 | * @edid_property: Default connector property to hold the EDID of the | |
2460 | * currently connected sink, if any. | |
2461 | */ | |
f453ba04 | 2462 | struct drm_property *edid_property; |
9a6bc03c DV |
2463 | /** |
2464 | * @dpms_property: Default connector property to control the | |
2465 | * connector's DPMS state. | |
2466 | */ | |
f453ba04 | 2467 | struct drm_property *dpms_property; |
9a6bc03c DV |
2468 | /** |
2469 | * @path_property: Default connector property to hold the DP MST path | |
2470 | * for the port. | |
2471 | */ | |
43aba7eb | 2472 | struct drm_property *path_property; |
9a6bc03c DV |
2473 | /** |
2474 | * @tile_property: Default connector property to store the tile | |
2475 | * position of a tiled screen, for sinks which need to be driven with | |
2476 | * multiple CRTCs. | |
2477 | */ | |
6f134d7b | 2478 | struct drm_property *tile_property; |
9a6bc03c DV |
2479 | /** |
2480 | * @plane_type_property: Default plane property to differentiate | |
2481 | * CURSOR, PRIMARY and OVERLAY legacy uses of planes. | |
2482 | */ | |
9922ab5a | 2483 | struct drm_property *plane_type_property; |
9a6bc03c DV |
2484 | /** |
2485 | * @rotation_property: Optional property for planes or CRTCs to specifiy | |
2486 | * rotation. | |
2487 | */ | |
2a297cce | 2488 | struct drm_property *rotation_property; |
9a6bc03c DV |
2489 | /** |
2490 | * @prop_src_x: Default atomic plane property for the plane source | |
2491 | * position in the connected &drm_framebuffer. | |
2492 | */ | |
6b4959f4 | 2493 | struct drm_property *prop_src_x; |
9a6bc03c DV |
2494 | /** |
2495 | * @prop_src_y: Default atomic plane property for the plane source | |
2496 | * position in the connected &drm_framebuffer. | |
2497 | */ | |
6b4959f4 | 2498 | struct drm_property *prop_src_y; |
9a6bc03c DV |
2499 | /** |
2500 | * @prop_src_w: Default atomic plane property for the plane source | |
2501 | * position in the connected &drm_framebuffer. | |
2502 | */ | |
6b4959f4 | 2503 | struct drm_property *prop_src_w; |
9a6bc03c DV |
2504 | /** |
2505 | * @prop_src_h: Default atomic plane property for the plane source | |
2506 | * position in the connected &drm_framebuffer. | |
2507 | */ | |
6b4959f4 | 2508 | struct drm_property *prop_src_h; |
9a6bc03c DV |
2509 | /** |
2510 | * @prop_crtc_x: Default atomic plane property for the plane destination | |
2511 | * position in the &drm_crtc is is being shown on. | |
2512 | */ | |
6b4959f4 | 2513 | struct drm_property *prop_crtc_x; |
9a6bc03c DV |
2514 | /** |
2515 | * @prop_crtc_y: Default atomic plane property for the plane destination | |
2516 | * position in the &drm_crtc is is being shown on. | |
2517 | */ | |
6b4959f4 | 2518 | struct drm_property *prop_crtc_y; |
9a6bc03c DV |
2519 | /** |
2520 | * @prop_crtc_w: Default atomic plane property for the plane destination | |
2521 | * position in the &drm_crtc is is being shown on. | |
2522 | */ | |
6b4959f4 | 2523 | struct drm_property *prop_crtc_w; |
9a6bc03c DV |
2524 | /** |
2525 | * @prop_crtc_h: Default atomic plane property for the plane destination | |
2526 | * position in the &drm_crtc is is being shown on. | |
2527 | */ | |
6b4959f4 | 2528 | struct drm_property *prop_crtc_h; |
9a6bc03c DV |
2529 | /** |
2530 | * @prop_fb_id: Default atomic plane property to specify the | |
2531 | * &drm_framebuffer. | |
2532 | */ | |
6b4959f4 | 2533 | struct drm_property *prop_fb_id; |
9a6bc03c DV |
2534 | /** |
2535 | * @prop_crtc_id: Default atomic plane property to specify the | |
2536 | * &drm_crtc. | |
2537 | */ | |
6b4959f4 | 2538 | struct drm_property *prop_crtc_id; |
9a6bc03c DV |
2539 | /** |
2540 | * @prop_active: Default atomic CRTC property to control the active | |
2541 | * state, which is the simplified implementation for DPMS in atomic | |
2542 | * drivers. | |
2543 | */ | |
eab3bbef | 2544 | struct drm_property *prop_active; |
9a6bc03c DV |
2545 | /** |
2546 | * @prop_mode_id: Default atomic CRTC property to set the mode for a | |
2547 | * CRTC. A 0 mode implies that the CRTC is entirely disabled - all | |
2548 | * connectors must be of and active must be set to disabled, too. | |
2549 | */ | |
955f3c33 | 2550 | struct drm_property *prop_mode_id; |
f453ba04 | 2551 | |
9a6bc03c DV |
2552 | /** |
2553 | * @dvi_i_subconnector_property: Optional DVI-I property to | |
2554 | * differentiate between analog or digital mode. | |
2555 | */ | |
f453ba04 | 2556 | struct drm_property *dvi_i_subconnector_property; |
9a6bc03c DV |
2557 | /** |
2558 | * @dvi_i_select_subconnector_property: Optional DVI-I property to | |
2559 | * select between analog or digital mode. | |
2560 | */ | |
f453ba04 DA |
2561 | struct drm_property *dvi_i_select_subconnector_property; |
2562 | ||
9a6bc03c DV |
2563 | /** |
2564 | * @tv_subconnector_property: Optional TV property to differentiate | |
2565 | * between different TV connector types. | |
2566 | */ | |
f453ba04 | 2567 | struct drm_property *tv_subconnector_property; |
9a6bc03c DV |
2568 | /** |
2569 | * @tv_select_subconnector_property: Optional TV property to select | |
2570 | * between different TV connector types. | |
2571 | */ | |
f453ba04 | 2572 | struct drm_property *tv_select_subconnector_property; |
9a6bc03c DV |
2573 | /** |
2574 | * @tv_mode_property: Optional TV property to select | |
2575 | * the output TV mode. | |
2576 | */ | |
f453ba04 | 2577 | struct drm_property *tv_mode_property; |
9a6bc03c DV |
2578 | /** |
2579 | * @tv_left_margin_property: Optional TV property to set the left | |
2580 | * margin. | |
2581 | */ | |
f453ba04 | 2582 | struct drm_property *tv_left_margin_property; |
9a6bc03c DV |
2583 | /** |
2584 | * @tv_right_margin_property: Optional TV property to set the right | |
2585 | * margin. | |
2586 | */ | |
f453ba04 | 2587 | struct drm_property *tv_right_margin_property; |
9a6bc03c DV |
2588 | /** |
2589 | * @tv_top_margin_property: Optional TV property to set the right | |
2590 | * margin. | |
2591 | */ | |
f453ba04 | 2592 | struct drm_property *tv_top_margin_property; |
9a6bc03c DV |
2593 | /** |
2594 | * @tv_bottom_margin_property: Optional TV property to set the right | |
2595 | * margin. | |
2596 | */ | |
f453ba04 | 2597 | struct drm_property *tv_bottom_margin_property; |
9a6bc03c DV |
2598 | /** |
2599 | * @tv_brightness_property: Optional TV property to set the | |
2600 | * brightness. | |
2601 | */ | |
b6b7902e | 2602 | struct drm_property *tv_brightness_property; |
9a6bc03c DV |
2603 | /** |
2604 | * @tv_contrast_property: Optional TV property to set the | |
2605 | * contrast. | |
2606 | */ | |
b6b7902e | 2607 | struct drm_property *tv_contrast_property; |
9a6bc03c DV |
2608 | /** |
2609 | * @tv_flicker_reduction_property: Optional TV property to control the | |
2610 | * flicker reduction mode. | |
2611 | */ | |
b6b7902e | 2612 | struct drm_property *tv_flicker_reduction_property; |
9a6bc03c DV |
2613 | /** |
2614 | * @tv_overscan_property: Optional TV property to control the overscan | |
2615 | * setting. | |
2616 | */ | |
a75f0236 | 2617 | struct drm_property *tv_overscan_property; |
9a6bc03c DV |
2618 | /** |
2619 | * @tv_saturation_property: Optional TV property to set the | |
2620 | * saturation. | |
2621 | */ | |
a75f0236 | 2622 | struct drm_property *tv_saturation_property; |
9a6bc03c DV |
2623 | /** |
2624 | * @tv_hue_property: Optional TV property to set the hue. | |
2625 | */ | |
a75f0236 | 2626 | struct drm_property *tv_hue_property; |
f453ba04 | 2627 | |
9a6bc03c DV |
2628 | /** |
2629 | * @scaling_mode_property: Optional connector property to control the | |
2630 | * upscaling, mostly used for built-in panels. | |
2631 | */ | |
f453ba04 | 2632 | struct drm_property *scaling_mode_property; |
9a6bc03c DV |
2633 | /** |
2634 | * @aspect_ratio_property: Optional connector property to control the | |
2635 | * HDMI infoframe aspect ratio setting. | |
2636 | */ | |
ff587e45 | 2637 | struct drm_property *aspect_ratio_property; |
9a6bc03c DV |
2638 | /** |
2639 | * @dirty_info_property: Optional connector property to give userspace a | |
2640 | * hint that the DIRTY_FB ioctl should be used. | |
2641 | */ | |
884840aa | 2642 | struct drm_property *dirty_info_property; |
019d96cb | 2643 | |
9a6bc03c DV |
2644 | /** |
2645 | * @degamma_lut_property: Optional CRTC property to set the LUT used to | |
2646 | * convert the framebuffer's colors to linear gamma. | |
2647 | */ | |
5488dc16 | 2648 | struct drm_property *degamma_lut_property; |
9a6bc03c DV |
2649 | /** |
2650 | * @degamma_lut_size_property: Optional CRTC property for the size of | |
2651 | * the degamma LUT as supported by the driver (read-only). | |
2652 | */ | |
5488dc16 | 2653 | struct drm_property *degamma_lut_size_property; |
9a6bc03c DV |
2654 | /** |
2655 | * @ctm_property: Optional CRTC property to set the | |
2656 | * matrix used to convert colors after the lookup in the | |
2657 | * degamma LUT. | |
2658 | */ | |
5488dc16 | 2659 | struct drm_property *ctm_property; |
9a6bc03c DV |
2660 | /** |
2661 | * @gamma_lut_property: Optional CRTC property to set the LUT used to | |
2662 | * convert the colors, after the CTM matrix, to the gamma space of the | |
2663 | * connected screen. | |
2664 | */ | |
5488dc16 | 2665 | struct drm_property *gamma_lut_property; |
9a6bc03c DV |
2666 | /** |
2667 | * @gamma_lut_size_property: Optional CRTC property for the size of the | |
2668 | * gamma LUT as supported by the driver (read-only). | |
2669 | */ | |
5488dc16 LL |
2670 | struct drm_property *gamma_lut_size_property; |
2671 | ||
9a6bc03c DV |
2672 | /** |
2673 | * @suggested_x_property: Optional connector property with a hint for | |
2674 | * the position of the output on the host's screen. | |
2675 | */ | |
5bb2bbf5 | 2676 | struct drm_property *suggested_x_property; |
9a6bc03c DV |
2677 | /** |
2678 | * @suggested_y_property: Optional connector property with a hint for | |
2679 | * the position of the output on the host's screen. | |
2680 | */ | |
5bb2bbf5 DA |
2681 | struct drm_property *suggested_y_property; |
2682 | ||
019d96cb DA |
2683 | /* dumb ioctl parameters */ |
2684 | uint32_t preferred_depth, prefer_shadow; | |
62f2104f | 2685 | |
9a6bc03c DV |
2686 | /** |
2687 | * @async_page_flip: Does this device support async flips on the primary | |
2688 | * plane? | |
2689 | */ | |
62f2104f | 2690 | bool async_page_flip; |
8716ed4e | 2691 | |
ac3ba4a5 DV |
2692 | /** |
2693 | * @allow_fb_modifiers: | |
2694 | * | |
2695 | * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call. | |
2696 | */ | |
e3eb3250 RC |
2697 | bool allow_fb_modifiers; |
2698 | ||
8716ed4e AD |
2699 | /* cursor size */ |
2700 | uint32_t cursor_width, cursor_height; | |
9f2a7950 DV |
2701 | |
2702 | struct drm_mode_config_helper_funcs *helper_private; | |
f453ba04 DA |
2703 | }; |
2704 | ||
dd275956 RC |
2705 | /** |
2706 | * drm_for_each_plane_mask - iterate over planes specified by bitmask | |
2707 | * @plane: the loop cursor | |
2708 | * @dev: the DRM device | |
2709 | * @plane_mask: bitmask of plane indices | |
2710 | * | |
2711 | * Iterate over all planes specified by bitmask. | |
2712 | */ | |
2713 | #define drm_for_each_plane_mask(plane, dev, plane_mask) \ | |
2714 | list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \ | |
373701b1 | 2715 | for_each_if ((plane_mask) & (1 << drm_plane_index(plane))) |
dd275956 | 2716 | |
ead8b665 ML |
2717 | /** |
2718 | * drm_for_each_encoder_mask - iterate over encoders specified by bitmask | |
2719 | * @encoder: the loop cursor | |
2720 | * @dev: the DRM device | |
2721 | * @encoder_mask: bitmask of encoder indices | |
2722 | * | |
2723 | * Iterate over all encoders specified by bitmask. | |
2724 | */ | |
2725 | #define drm_for_each_encoder_mask(encoder, dev, encoder_mask) \ | |
2726 | list_for_each_entry((encoder), &(dev)->mode_config.encoder_list, head) \ | |
2727 | for_each_if ((encoder_mask) & (1 << drm_encoder_index(encoder))) | |
dd275956 | 2728 | |
f453ba04 DA |
2729 | #define obj_to_crtc(x) container_of(x, struct drm_crtc, base) |
2730 | #define obj_to_connector(x) container_of(x, struct drm_connector, base) | |
2731 | #define obj_to_encoder(x) container_of(x, struct drm_encoder, base) | |
2732 | #define obj_to_mode(x) container_of(x, struct drm_display_mode, base) | |
2733 | #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base) | |
2734 | #define obj_to_property(x) container_of(x, struct drm_property, base) | |
2735 | #define obj_to_blob(x) container_of(x, struct drm_property_blob, base) | |
8cf5c917 | 2736 | #define obj_to_plane(x) container_of(x, struct drm_plane, base) |
f453ba04 | 2737 | |
4a67d391 SH |
2738 | struct drm_prop_enum_list { |
2739 | int type; | |
2740 | char *name; | |
2741 | }; | |
f453ba04 | 2742 | |
f9882876 VS |
2743 | extern __printf(6, 7) |
2744 | int drm_crtc_init_with_planes(struct drm_device *dev, | |
2745 | struct drm_crtc *crtc, | |
2746 | struct drm_plane *primary, | |
2747 | struct drm_plane *cursor, | |
2748 | const struct drm_crtc_funcs *funcs, | |
2749 | const char *name, ...); | |
f453ba04 | 2750 | extern void drm_crtc_cleanup(struct drm_crtc *crtc); |
490d3d1b CW |
2751 | |
2752 | /** | |
2753 | * drm_crtc_index - find the index of a registered CRTC | |
2754 | * @crtc: CRTC to find index for | |
2755 | * | |
2756 | * Given a registered CRTC, return the index of that CRTC within a DRM | |
2757 | * device's list of CRTCs. | |
2758 | */ | |
2759 | static inline unsigned int drm_crtc_index(struct drm_crtc *crtc) | |
2760 | { | |
2761 | return crtc->index; | |
2762 | } | |
db5f7a6e RK |
2763 | |
2764 | /** | |
2765 | * drm_crtc_mask - find the mask of a registered CRTC | |
2766 | * @crtc: CRTC to find mask for | |
2767 | * | |
2768 | * Given a registered CRTC, return the mask bit of that CRTC for an | |
2769 | * encoder's possible_crtcs field. | |
2770 | */ | |
2771 | static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc) | |
2772 | { | |
2773 | return 1 << drm_crtc_index(crtc); | |
2774 | } | |
f453ba04 | 2775 | |
81065548 DV |
2776 | int drm_connector_init(struct drm_device *dev, |
2777 | struct drm_connector *connector, | |
2778 | const struct drm_connector_funcs *funcs, | |
2779 | int connector_type); | |
34ea3d38 TW |
2780 | int drm_connector_register(struct drm_connector *connector); |
2781 | void drm_connector_unregister(struct drm_connector *connector); | |
f453ba04 DA |
2782 | |
2783 | extern void drm_connector_cleanup(struct drm_connector *connector); | |
5fff80bb ML |
2784 | static inline unsigned drm_connector_index(struct drm_connector *connector) |
2785 | { | |
69425599 | 2786 | return connector->index; |
5fff80bb ML |
2787 | } |
2788 | ||
13a3d91f VS |
2789 | extern __printf(5, 6) |
2790 | int drm_encoder_init(struct drm_device *dev, | |
2791 | struct drm_encoder *encoder, | |
2792 | const struct drm_encoder_funcs *funcs, | |
2793 | int encoder_type, const char *name, ...); | |
490d3d1b CW |
2794 | |
2795 | /** | |
2796 | * drm_encoder_index - find the index of a registered encoder | |
2797 | * @encoder: encoder to find index for | |
2798 | * | |
2799 | * Given a registered encoder, return the index of that encoder within a DRM | |
2800 | * device's list of encoders. | |
2801 | */ | |
2802 | static inline unsigned int drm_encoder_index(struct drm_encoder *encoder) | |
2803 | { | |
2804 | return encoder->index; | |
2805 | } | |
f453ba04 | 2806 | |
3d887368 TR |
2807 | /** |
2808 | * drm_encoder_crtc_ok - can a given crtc drive a given encoder? | |
2809 | * @encoder: encoder to test | |
2810 | * @crtc: crtc to test | |
2811 | * | |
2812 | * Return false if @encoder can't be driven by @crtc, true otherwise. | |
2813 | */ | |
2814 | static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder, | |
2815 | struct drm_crtc *crtc) | |
2816 | { | |
2817 | return !!(encoder->possible_crtcs & drm_crtc_mask(crtc)); | |
2818 | } | |
2819 | ||
b0b3b795 VS |
2820 | extern __printf(8, 9) |
2821 | int drm_universal_plane_init(struct drm_device *dev, | |
2822 | struct drm_plane *plane, | |
2823 | unsigned long possible_crtcs, | |
2824 | const struct drm_plane_funcs *funcs, | |
2825 | const uint32_t *formats, | |
2826 | unsigned int format_count, | |
2827 | enum drm_plane_type type, | |
2828 | const char *name, ...); | |
8cf5c917 JB |
2829 | extern int drm_plane_init(struct drm_device *dev, |
2830 | struct drm_plane *plane, | |
2831 | unsigned long possible_crtcs, | |
2832 | const struct drm_plane_funcs *funcs, | |
45e3743a | 2833 | const uint32_t *formats, unsigned int format_count, |
dc415ff9 | 2834 | bool is_primary); |
8cf5c917 | 2835 | extern void drm_plane_cleanup(struct drm_plane *plane); |
490d3d1b CW |
2836 | |
2837 | /** | |
2838 | * drm_plane_index - find the index of a registered plane | |
2839 | * @plane: plane to find index for | |
2840 | * | |
2841 | * Given a registered plane, return the index of that plane within a DRM | |
2842 | * device's list of planes. | |
2843 | */ | |
2844 | static inline unsigned int drm_plane_index(struct drm_plane *plane) | |
2845 | { | |
2846 | return plane->index; | |
2847 | } | |
f81338a5 | 2848 | extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx); |
9125e618 | 2849 | extern void drm_plane_force_disable(struct drm_plane *plane); |
ecb7e16b GP |
2850 | extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode, |
2851 | int *hdisplay, int *vdisplay); | |
6a0d9528 LW |
2852 | extern int drm_crtc_force_disable(struct drm_crtc *crtc); |
2853 | extern int drm_crtc_force_disable_all(struct drm_device *dev); | |
8cf5c917 | 2854 | |
f453ba04 DA |
2855 | extern void drm_encoder_cleanup(struct drm_encoder *encoder); |
2856 | ||
d20d3174 | 2857 | extern const char *drm_get_connector_status_name(enum drm_connector_status status); |
ac1bb36c | 2858 | extern const char *drm_get_subpixel_order_name(enum subpixel_order order); |
d20d3174 VS |
2859 | extern const char *drm_get_dpms_name(int val); |
2860 | extern const char *drm_get_dvi_i_subconnector_name(int val); | |
2861 | extern const char *drm_get_dvi_i_select_name(int val); | |
2862 | extern const char *drm_get_tv_subconnector_name(int val); | |
2863 | extern const char *drm_get_tv_select_name(int val); | |
f453ba04 | 2864 | extern void drm_mode_config_init(struct drm_device *dev); |
eb033556 | 2865 | extern void drm_mode_config_reset(struct drm_device *dev); |
f453ba04 | 2866 | extern void drm_mode_config_cleanup(struct drm_device *dev); |
55310008 | 2867 | |
43aba7eb | 2868 | extern int drm_mode_connector_set_path_property(struct drm_connector *connector, |
12e6cecd | 2869 | const char *path); |
6f134d7b | 2870 | int drm_mode_connector_set_tile_property(struct drm_connector *connector); |
f453ba04 | 2871 | extern int drm_mode_connector_update_edid_property(struct drm_connector *connector, |
12e6cecd | 2872 | const struct edid *edid); |
5ea22f24 | 2873 | |
b5571e9d BB |
2874 | extern int drm_display_info_set_bus_formats(struct drm_display_info *info, |
2875 | const u32 *formats, | |
2876 | unsigned int num_formats); | |
2877 | ||
5ea22f24 RC |
2878 | static inline bool drm_property_type_is(struct drm_property *property, |
2879 | uint32_t type) | |
2880 | { | |
2881 | /* instanceof for props.. handles extended type vs original types: */ | |
2882 | if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) | |
2883 | return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type; | |
2884 | return property->flags & type; | |
2885 | } | |
2886 | ||
c543188a PZ |
2887 | extern int drm_object_property_set_value(struct drm_mode_object *obj, |
2888 | struct drm_property *property, | |
2889 | uint64_t val); | |
2890 | extern int drm_object_property_get_value(struct drm_mode_object *obj, | |
2891 | struct drm_property *property, | |
2892 | uint64_t *value); | |
f453ba04 DA |
2893 | extern int drm_framebuffer_init(struct drm_device *dev, |
2894 | struct drm_framebuffer *fb, | |
2895 | const struct drm_framebuffer_funcs *funcs); | |
786b99ed DV |
2896 | extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev, |
2897 | uint32_t id); | |
f7eff60e | 2898 | extern void drm_framebuffer_remove(struct drm_framebuffer *fb); |
f453ba04 | 2899 | extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb); |
36206361 | 2900 | extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb); |
f453ba04 | 2901 | |
c543188a PZ |
2902 | extern void drm_object_attach_property(struct drm_mode_object *obj, |
2903 | struct drm_property *property, | |
2904 | uint64_t init_val); | |
f453ba04 DA |
2905 | extern struct drm_property *drm_property_create(struct drm_device *dev, int flags, |
2906 | const char *name, int num_values); | |
4a67d391 SH |
2907 | extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags, |
2908 | const char *name, | |
49e27545 RC |
2909 | const struct drm_prop_enum_list *props, |
2910 | int num_values); | |
2911 | struct drm_property *drm_property_create_bitmask(struct drm_device *dev, | |
2912 | int flags, const char *name, | |
4a67d391 | 2913 | const struct drm_prop_enum_list *props, |
7689ffb3 VS |
2914 | int num_props, |
2915 | uint64_t supported_bits); | |
d9bc3c02 SH |
2916 | struct drm_property *drm_property_create_range(struct drm_device *dev, int flags, |
2917 | const char *name, | |
2918 | uint64_t min, uint64_t max); | |
ebc44cf3 RC |
2919 | struct drm_property *drm_property_create_signed_range(struct drm_device *dev, |
2920 | int flags, const char *name, | |
2921 | int64_t min, int64_t max); | |
98f75de4 RC |
2922 | struct drm_property *drm_property_create_object(struct drm_device *dev, |
2923 | int flags, const char *name, uint32_t type); | |
960cd9d4 DV |
2924 | struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags, |
2925 | const char *name); | |
6bcacf51 DS |
2926 | struct drm_property_blob *drm_property_create_blob(struct drm_device *dev, |
2927 | size_t length, | |
2928 | const void *data); | |
2929 | struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev, | |
2930 | uint32_t id); | |
2931 | struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob); | |
2932 | void drm_property_unreference_blob(struct drm_property_blob *blob); | |
f453ba04 DA |
2933 | extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property); |
2934 | extern int drm_property_add_enum(struct drm_property *property, int index, | |
2935 | uint64_t value, const char *name); | |
2936 | extern int drm_mode_create_dvi_i_properties(struct drm_device *dev); | |
2f763312 TR |
2937 | extern int drm_mode_create_tv_properties(struct drm_device *dev, |
2938 | unsigned int num_modes, | |
b7c914b3 | 2939 | const char * const modes[]); |
f453ba04 | 2940 | extern int drm_mode_create_scaling_mode_property(struct drm_device *dev); |
ff587e45 | 2941 | extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev); |
884840aa | 2942 | extern int drm_mode_create_dirty_info_property(struct drm_device *dev); |
5bb2bbf5 | 2943 | extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev); |
f453ba04 DA |
2944 | |
2945 | extern int drm_mode_connector_attach_encoder(struct drm_connector *connector, | |
2946 | struct drm_encoder *encoder); | |
4cae5b84 | 2947 | extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc, |
f453ba04 | 2948 | int gamma_size); |
98f75de4 | 2949 | |
2d13b679 | 2950 | extern int drm_mode_set_config_internal(struct drm_mode_set *set); |
81065548 | 2951 | |
308e5bcb | 2952 | extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); |
138f9ebb DA |
2953 | |
2954 | extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev, | |
2955 | char topology[8]); | |
2956 | extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev, | |
2957 | char topology[8]); | |
2958 | extern void drm_mode_put_tile_group(struct drm_device *dev, | |
2959 | struct drm_tile_group *tg); | |
ff72145b | 2960 | |
3a5f87c2 TW |
2961 | extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane, |
2962 | struct drm_property *property, | |
2963 | uint64_t value); | |
248dbc23 | 2964 | |
c1df5f3c VS |
2965 | extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev, |
2966 | unsigned int supported_rotations); | |
3c9855f6 VS |
2967 | extern unsigned int drm_rotation_simplify(unsigned int rotation, |
2968 | unsigned int supported_rotations); | |
f8ed34ac JS |
2969 | extern void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc, |
2970 | uint degamma_lut_size, | |
2971 | bool has_ctm, | |
2972 | uint gamma_lut_size); | |
44d1240d MS |
2973 | |
2974 | int drm_plane_create_zpos_property(struct drm_plane *plane, | |
2975 | unsigned int zpos, | |
2976 | unsigned int min, unsigned int max); | |
2977 | ||
2978 | int drm_plane_create_zpos_immutable_property(struct drm_plane *plane, | |
2979 | unsigned int zpos); | |
2980 | ||
96f60e37 | 2981 | /* Helpers */ |
81065548 DV |
2982 | struct drm_mode_object *drm_mode_object_find(struct drm_device *dev, |
2983 | uint32_t id, uint32_t type); | |
2984 | void drm_mode_object_reference(struct drm_mode_object *obj); | |
2985 | void drm_mode_object_unreference(struct drm_mode_object *obj); | |
a2b34e22 RC |
2986 | |
2987 | static inline struct drm_plane *drm_plane_find(struct drm_device *dev, | |
2988 | uint32_t id) | |
2989 | { | |
2990 | struct drm_mode_object *mo; | |
2991 | mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE); | |
2992 | return mo ? obj_to_plane(mo) : NULL; | |
2993 | } | |
2994 | ||
96f60e37 RK |
2995 | static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev, |
2996 | uint32_t id) | |
2997 | { | |
2998 | struct drm_mode_object *mo; | |
2999 | mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC); | |
3000 | return mo ? obj_to_crtc(mo) : NULL; | |
3001 | } | |
3002 | ||
3003 | static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev, | |
3004 | uint32_t id) | |
3005 | { | |
3006 | struct drm_mode_object *mo; | |
3007 | mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER); | |
3008 | return mo ? obj_to_encoder(mo) : NULL; | |
3009 | } | |
3010 | ||
b164d31f DA |
3011 | /** |
3012 | * drm_connector_lookup - lookup connector object | |
3013 | * @dev: DRM device | |
3014 | * @id: connector object id | |
3015 | * | |
3016 | * This function looks up the connector object specified by id | |
3017 | * add takes a reference to it. | |
3018 | */ | |
3019 | static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev, | |
a2b34e22 RC |
3020 | uint32_t id) |
3021 | { | |
3022 | struct drm_mode_object *mo; | |
3023 | mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR); | |
3024 | return mo ? obj_to_connector(mo) : NULL; | |
3025 | } | |
3026 | ||
3027 | static inline struct drm_property *drm_property_find(struct drm_device *dev, | |
3028 | uint32_t id) | |
3029 | { | |
3030 | struct drm_mode_object *mo; | |
3031 | mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY); | |
3032 | return mo ? obj_to_property(mo) : NULL; | |
3033 | } | |
3034 | ||
5488dc16 LL |
3035 | /* |
3036 | * Extract a degamma/gamma LUT value provided by user and round it to the | |
3037 | * precision supported by the hardware. | |
3038 | */ | |
3039 | static inline uint32_t drm_color_lut_extract(uint32_t user_input, | |
3040 | uint32_t bit_precision) | |
3041 | { | |
644a8050 | 3042 | uint32_t val = user_input; |
5488dc16 LL |
3043 | uint32_t max = 0xffff >> (16 - bit_precision); |
3044 | ||
644a8050 LL |
3045 | /* Round only if we're not using full precision. */ |
3046 | if (bit_precision < 16) { | |
3047 | val += 1UL << (16 - bit_precision - 1); | |
3048 | val >>= 16 - bit_precision; | |
3049 | } | |
5488dc16 LL |
3050 | |
3051 | return clamp_val(val, 0, max); | |
3052 | } | |
3053 | ||
e76d399f | 3054 | /** |
d0f37cf6 DA |
3055 | * drm_framebuffer_reference - incr the fb refcnt |
3056 | * @fb: framebuffer | |
3057 | * | |
3058 | * This functions increments the fb's refcount. | |
3059 | */ | |
3060 | static inline void drm_framebuffer_reference(struct drm_framebuffer *fb) | |
3061 | { | |
3062 | drm_mode_object_reference(&fb->base); | |
3063 | } | |
3064 | ||
3065 | /** | |
3066 | * drm_framebuffer_unreference - unref a framebuffer | |
3067 | * @fb: framebuffer to unref | |
3068 | * | |
3069 | * This functions decrements the fb's refcount and frees it if it drops to zero. | |
3070 | */ | |
3071 | static inline void drm_framebuffer_unreference(struct drm_framebuffer *fb) | |
3072 | { | |
3073 | drm_mode_object_unreference(&fb->base); | |
3074 | } | |
3075 | ||
747a598f DA |
3076 | /** |
3077 | * drm_framebuffer_read_refcount - read the framebuffer reference count. | |
3078 | * @fb: framebuffer | |
3079 | * | |
3080 | * This functions returns the framebuffer's reference count. | |
3081 | */ | |
3082 | static inline uint32_t drm_framebuffer_read_refcount(struct drm_framebuffer *fb) | |
3083 | { | |
d0f37cf6 | 3084 | return atomic_read(&fb->base.refcount.refcount); |
747a598f DA |
3085 | } |
3086 | ||
b164d31f DA |
3087 | /** |
3088 | * drm_connector_reference - incr the connector refcnt | |
3089 | * @connector: connector | |
3090 | * | |
3091 | * This function increments the connector's refcount. | |
3092 | */ | |
3093 | static inline void drm_connector_reference(struct drm_connector *connector) | |
3094 | { | |
3095 | drm_mode_object_reference(&connector->base); | |
3096 | } | |
3097 | ||
3098 | /** | |
3099 | * drm_connector_unreference - unref a connector | |
3100 | * @connector: connector to unref | |
3101 | * | |
3102 | * This function decrements the connector's refcount and frees it if it drops to zero. | |
3103 | */ | |
3104 | static inline void drm_connector_unreference(struct drm_connector *connector) | |
3105 | { | |
3106 | drm_mode_object_unreference(&connector->base); | |
3107 | } | |
3108 | ||
e27dde3e | 3109 | /* Plane list iterator for legacy (overlay only) planes. */ |
4ea50e99 DV |
3110 | #define drm_for_each_legacy_plane(plane, dev) \ |
3111 | list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \ | |
373701b1 | 3112 | for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY) |
e27dde3e | 3113 | |
6295d607 DV |
3114 | #define drm_for_each_plane(plane, dev) \ |
3115 | list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) | |
3116 | ||
3117 | #define drm_for_each_crtc(crtc, dev) \ | |
3118 | list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head) | |
3119 | ||
7a3f3d66 DV |
3120 | static inline void |
3121 | assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config) | |
3122 | { | |
cff20ba2 DV |
3123 | /* |
3124 | * The connector hotadd/remove code currently grabs both locks when | |
3125 | * updating lists. Hence readers need only hold either of them to be | |
3126 | * safe and the check amounts to | |
3127 | * | |
3128 | * WARN_ON(not_holding(A) && not_holding(B)). | |
3129 | */ | |
3130 | WARN_ON(!mutex_is_locked(&mode_config->mutex) && | |
3131 | !drm_modeset_is_locked(&mode_config->connection_mutex)); | |
7a3f3d66 DV |
3132 | } |
3133 | ||
6295d607 | 3134 | #define drm_for_each_connector(connector, dev) \ |
7a3f3d66 DV |
3135 | for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \ |
3136 | connector = list_first_entry(&(dev)->mode_config.connector_list, \ | |
3137 | struct drm_connector, head); \ | |
3138 | &connector->head != (&(dev)->mode_config.connector_list); \ | |
3139 | connector = list_next_entry(connector, head)) | |
6295d607 DV |
3140 | |
3141 | #define drm_for_each_encoder(encoder, dev) \ | |
3142 | list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head) | |
3143 | ||
3144 | #define drm_for_each_fb(fb, dev) \ | |
4676ba0b DV |
3145 | for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \ |
3146 | fb = list_first_entry(&(dev)->mode_config.fb_list, \ | |
3147 | struct drm_framebuffer, head); \ | |
3148 | &fb->head != (&(dev)->mode_config.fb_list); \ | |
3149 | fb = list_next_entry(fb, head)) | |
6295d607 | 3150 | |
81065548 DV |
3151 | /* drm_edid.c */ |
3152 | bool drm_probe_ddc(struct i2c_adapter *adapter); | |
3153 | struct edid *drm_get_edid(struct drm_connector *connector, | |
3154 | struct i2c_adapter *adapter); | |
3155 | struct edid *drm_get_edid_switcheroo(struct drm_connector *connector, | |
3156 | struct i2c_adapter *adapter); | |
3157 | struct edid *drm_edid_duplicate(const struct edid *edid); | |
3158 | int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid); | |
3159 | ||
3160 | u8 drm_match_cea_mode(const struct drm_display_mode *to_match); | |
3161 | enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code); | |
3162 | bool drm_detect_hdmi_monitor(struct edid *edid); | |
3163 | bool drm_detect_monitor_audio(struct edid *edid); | |
3164 | bool drm_rgb_quant_range_selectable(struct edid *edid); | |
3165 | int drm_add_modes_noedid(struct drm_connector *connector, | |
3166 | int hdisplay, int vdisplay); | |
3167 | void drm_set_preferred_mode(struct drm_connector *connector, | |
3168 | int hpref, int vpref); | |
3169 | ||
3170 | int drm_edid_header_is_valid(const u8 *raw_edid); | |
3171 | bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid, | |
3172 | bool *edid_corrupt); | |
3173 | bool drm_edid_is_valid(struct edid *edid); | |
3174 | void drm_edid_get_monitor_name(struct edid *edid, char *name, | |
3175 | int buflen); | |
3176 | struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev, | |
3177 | int hsize, int vsize, int fresh, | |
3178 | bool rb); | |
3179 | ||
3180 | /* drm_bridge.c */ | |
3181 | extern int drm_bridge_add(struct drm_bridge *bridge); | |
3182 | extern void drm_bridge_remove(struct drm_bridge *bridge); | |
3183 | extern struct drm_bridge *of_drm_find_bridge(struct device_node *np); | |
3184 | extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge); | |
3185 | ||
3186 | bool drm_bridge_mode_fixup(struct drm_bridge *bridge, | |
3187 | const struct drm_display_mode *mode, | |
3188 | struct drm_display_mode *adjusted_mode); | |
3189 | void drm_bridge_disable(struct drm_bridge *bridge); | |
3190 | void drm_bridge_post_disable(struct drm_bridge *bridge); | |
3191 | void drm_bridge_mode_set(struct drm_bridge *bridge, | |
3192 | struct drm_display_mode *mode, | |
3193 | struct drm_display_mode *adjusted_mode); | |
3194 | void drm_bridge_pre_enable(struct drm_bridge *bridge); | |
3195 | void drm_bridge_enable(struct drm_bridge *bridge); | |
3196 | ||
f453ba04 | 3197 | #endif /* __DRM_CRTC_H__ */ |