| 1 |
/* |
| 2 |
* Copyright (C) 2014 Red Hat |
| 3 |
* Copyright (C) 2014 Intel Corp. |
| 4 |
* |
| 5 |
* Permission is hereby granted, free of charge, to any person obtaining a |
| 6 |
* copy of this software and associated documentation files (the "Software"), |
| 7 |
* to deal in the Software without restriction, including without limitation |
| 8 |
* the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 9 |
* and/or sell copies of the Software, and to permit persons to whom the |
| 10 |
* Software is furnished to do so, subject to the following conditions: |
| 11 |
* |
| 12 |
* The above copyright notice and this permission notice shall be included in |
| 13 |
* all copies or substantial portions of the Software. |
| 14 |
* |
| 15 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 16 |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 17 |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 18 |
* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 19 |
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 20 |
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 21 |
* OTHER DEALINGS IN THE SOFTWARE. |
| 22 |
* |
| 23 |
* Authors: |
| 24 |
* Rob Clark <[email protected]> |
| 25 |
* Daniel Vetter <[email protected]> |
| 26 |
*/ |
| 27 |
|
| 28 |
#ifndef DRM_ATOMIC_H_ |
| 29 |
#define DRM_ATOMIC_H_ |
| 30 |
|
| 31 |
#include <drm/drm_crtc.h> |
| 32 |
#include <drm/drm_util.h> |
| 33 |
|
| 34 |
/** |
| 35 |
* struct drm_crtc_commit - track modeset commits on a CRTC |
| 36 |
* |
| 37 |
* This structure is used to track pending modeset changes and atomic commit on |
| 38 |
* a per-CRTC basis. Since updating the list should never block, this structure |
| 39 |
* is reference counted to allow waiters to safely wait on an event to complete, |
| 40 |
* without holding any locks. |
| 41 |
* |
| 42 |
* It has 3 different events in total to allow a fine-grained synchronization |
| 43 |
* between outstanding updates:: |
| 44 |
* |
| 45 |
* atomic commit thread hardware |
| 46 |
* |
| 47 |
* write new state into hardware ----> ... |
| 48 |
* signal hw_done |
| 49 |
* switch to new state on next |
| 50 |
* ... v/hblank |
| 51 |
* |
| 52 |
* wait for buffers to show up ... |
| 53 |
* |
| 54 |
* ... send completion irq |
| 55 |
* irq handler signals flip_done |
| 56 |
* cleanup old buffers |
| 57 |
* |
| 58 |
* signal cleanup_done |
| 59 |
* |
| 60 |
* wait for flip_done <---- |
| 61 |
* clean up atomic state |
| 62 |
* |
| 63 |
* The important bit to know is that &cleanup_done is the terminal event, but the |
| 64 |
* ordering between &flip_done and &hw_done is entirely up to the specific driver |
| 65 |
* and modeset state change. |
| 66 |
* |
| 67 |
* For an implementation of how to use this look at |
| 68 |
* drm_atomic_helper_setup_commit() from the atomic helper library. |
| 69 |
* |
| 70 |
* See also drm_crtc_commit_wait(). |
| 71 |
*/ |
| 72 |
struct drm_crtc_commit { |
| 73 |
/** |
| 74 |
* @crtc: |
| 75 |
* |
| 76 |
* DRM CRTC for this commit. |
| 77 |
*/ |
| 78 |
struct drm_crtc *crtc; |
| 79 |
|
| 80 |
/** |
| 81 |
* @ref: |
| 82 |
* |
| 83 |
* Reference count for this structure. Needed to allow blocking on |
| 84 |
* completions without the risk of the completion disappearing |
| 85 |
* meanwhile. |
| 86 |
*/ |
| 87 |
struct kref ref; |
| 88 |
|
| 89 |
/** |
| 90 |
* @flip_done: |
| 91 |
* |
| 92 |
* Will be signaled when the hardware has flipped to the new set of |
| 93 |
* buffers. Signals at the same time as when the drm event for this |
| 94 |
* commit is sent to userspace, or when an out-fence is singalled. Note |
| 95 |
* that for most hardware, in most cases this happens after @hw_done is |
| 96 |
* signalled. |
| 97 |
* |
| 98 |
* Completion of this stage is signalled implicitly by calling |
| 99 |
* drm_crtc_send_vblank_event() on &drm_crtc_state.event. |
| 100 |
*/ |
| 101 |
struct completion flip_done; |
| 102 |
|
| 103 |
/** |
| 104 |
* @hw_done: |
| 105 |
* |
| 106 |
* Will be signalled when all hw register changes for this commit have |
| 107 |
* been written out. Especially when disabling a pipe this can be much |
| 108 |
* later than @flip_done, since that can signal already when the |
| 109 |
* screen goes black, whereas to fully shut down a pipe more register |
| 110 |
* I/O is required. |
| 111 |
* |
| 112 |
* Note that this does not need to include separately reference-counted |
| 113 |
* resources like backing storage buffer pinning, or runtime pm |
| 114 |
* management. |
| 115 |
* |
| 116 |
* Drivers should call drm_atomic_helper_commit_hw_done() to signal |
| 117 |
* completion of this stage. |
| 118 |
*/ |
| 119 |
struct completion hw_done; |
| 120 |
|
| 121 |
/** |
| 122 |
* @cleanup_done: |
| 123 |
* |
| 124 |
* Will be signalled after old buffers have been cleaned up by calling |
| 125 |
* drm_atomic_helper_cleanup_planes(). Since this can only happen after |
| 126 |
* a vblank wait completed it might be a bit later. This completion is |
| 127 |
* useful to throttle updates and avoid hardware updates getting ahead |
| 128 |
* of the buffer cleanup too much. |
| 129 |
* |
| 130 |
* Drivers should call drm_atomic_helper_commit_cleanup_done() to signal |
| 131 |
* completion of this stage. |
| 132 |
*/ |
| 133 |
struct completion cleanup_done; |
| 134 |
|
| 135 |
/** |
| 136 |
* @commit_entry: |
| 137 |
* |
| 138 |
* Entry on the per-CRTC &drm_crtc.commit_list. Protected by |
| 139 |
* $drm_crtc.commit_lock. |
| 140 |
*/ |
| 141 |
struct list_head commit_entry; |
| 142 |
|
| 143 |
/** |
| 144 |
* @event: |
| 145 |
* |
| 146 |
* &drm_pending_vblank_event pointer to clean up private events. |
| 147 |
*/ |
| 148 |
struct drm_pending_vblank_event *event; |
| 149 |
|
| 150 |
/** |
| 151 |
* @abort_completion: |
| 152 |
* |
| 153 |
* A flag that's set after drm_atomic_helper_setup_commit() takes a |
| 154 |
* second reference for the completion of $drm_crtc_state.event. It's |
| 155 |
* used by the free code to remove the second reference if commit fails. |
| 156 |
*/ |
| 157 |
bool abort_completion; |
| 158 |
}; |
| 159 |
|
| 160 |
struct __drm_colorops_state { |
| 161 |
struct drm_colorop *ptr; |
| 162 |
struct drm_colorop_state *state, *old_state, *new_state; |
| 163 |
}; |
| 164 |
|
| 165 |
struct __drm_planes_state { |
| 166 |
struct drm_plane *ptr; |
| 167 |
|
| 168 |
/** |
| 169 |
* @state_to_destroy: |
| 170 |
* |
| 171 |
* Used to track the @drm_plane_state we will need to free when |
| 172 |
* tearing down the associated &drm_atomic_state in |
| 173 |
* $drm_mode_config_funcs.atomic_state_clear or |
| 174 |
* drm_atomic_state_default_clear(). |
| 175 |
* |
| 176 |
* Before a commit, and the call to |
| 177 |
* drm_atomic_helper_swap_state() in particular, it points to |
| 178 |
* the same state than @new_state. After a commit, it points to |
| 179 |
* the same state than @old_state. |
| 180 |
*/ |
| 181 |
struct drm_plane_state *state_to_destroy; |
| 182 |
|
| 183 |
struct drm_plane_state *old_state, *new_state; |
| 184 |
}; |
| 185 |
|
| 186 |
struct __drm_crtcs_state { |
| 187 |
struct drm_crtc *ptr; |
| 188 |
|
| 189 |
/** |
| 190 |
* @state_to_destroy: |
| 191 |
* |
| 192 |
* Used to track the @drm_crtc_state we will need to free when |
| 193 |
* tearing down the associated &drm_atomic_state in |
| 194 |
* $drm_mode_config_funcs.atomic_state_clear or |
| 195 |
* drm_atomic_state_default_clear(). |
| 196 |
* |
| 197 |
* Before a commit, and the call to |
| 198 |
* drm_atomic_helper_swap_state() in particular, it points to |
| 199 |
* the same state than @new_state. After a commit, it points to |
| 200 |
* the same state than @old_state. |
| 201 |
*/ |
| 202 |
struct drm_crtc_state *state_to_destroy; |
| 203 |
|
| 204 |
struct drm_crtc_state *old_state, *new_state; |
| 205 |
|
| 206 |
/** |
| 207 |
* @commit: |
| 208 |
* |
| 209 |
* A reference to the CRTC commit object that is kept for use by |
| 210 |
* drm_atomic_helper_wait_for_flip_done() after |
| 211 |
* drm_atomic_helper_commit_hw_done() is called. This ensures that a |
| 212 |
* concurrent commit won't free a commit object that is still in use. |
| 213 |
*/ |
| 214 |
struct drm_crtc_commit *commit; |
| 215 |
|
| 216 |
s32 __user *out_fence_ptr; |
| 217 |
u64 last_vblank_count; |
| 218 |
}; |
| 219 |
|
| 220 |
struct __drm_connnectors_state { |
| 221 |
struct drm_connector *ptr; |
| 222 |
|
| 223 |
/** |
| 224 |
* @state_to_destroy: |
| 225 |
* |
| 226 |
* Used to track the @drm_connector_state we will need to free |
| 227 |
* when tearing down the associated &drm_atomic_state in |
| 228 |
* $drm_mode_config_funcs.atomic_state_clear or |
| 229 |
* drm_atomic_state_default_clear(). |
| 230 |
* |
| 231 |
* Before a commit, and the call to |
| 232 |
* drm_atomic_helper_swap_state() in particular, it points to |
| 233 |
* the same state than @new_state. After a commit, it points to |
| 234 |
* the same state than @old_state. |
| 235 |
*/ |
| 236 |
struct drm_connector_state *state_to_destroy; |
| 237 |
|
| 238 |
struct drm_connector_state *old_state, *new_state; |
| 239 |
|
| 240 |
/** |
| 241 |
* @out_fence_ptr: |
| 242 |
* |
| 243 |
* User-provided pointer which the kernel uses to return a sync_file |
| 244 |
* file descriptor. Used by writeback connectors to signal completion of |
| 245 |
* the writeback. |
| 246 |
*/ |
| 247 |
s32 __user *out_fence_ptr; |
| 248 |
}; |
| 249 |
|
| 250 |
struct drm_private_obj; |
| 251 |
struct drm_private_state; |
| 252 |
|
| 253 |
/** |
| 254 |
* struct drm_private_state_funcs - atomic state functions for private objects |
| 255 |
* |
| 256 |
* These hooks are used by atomic helpers to create, swap and destroy states of |
| 257 |
* private objects. The structure itself is used as a vtable to identify the |
| 258 |
* associated private object type. Each private object type that needs to be |
| 259 |
* added to the atomic states is expected to have an implementation of these |
| 260 |
* hooks and pass a pointer to its drm_private_state_funcs struct to |
| 261 |
* drm_atomic_get_private_obj_state(). |
| 262 |
*/ |
| 263 |
struct drm_private_state_funcs { |
| 264 |
/** |
| 265 |
* @atomic_duplicate_state: |
| 266 |
* |
| 267 |
* Duplicate the current state of the private object and return it. It |
| 268 |
* is an error to call this before obj->state has been initialized. |
| 269 |
* |
| 270 |
* RETURNS: |
| 271 |
* |
| 272 |
* Duplicated atomic state or NULL when obj->state is not |
| 273 |
* initialized or allocation failed. |
| 274 |
*/ |
| 275 |
struct drm_private_state *(*atomic_duplicate_state)(struct drm_private_obj *obj); |
| 276 |
|
| 277 |
/** |
| 278 |
* @atomic_destroy_state: |
| 279 |
* |
| 280 |
* Frees the private object state created with @atomic_duplicate_state. |
| 281 |
*/ |
| 282 |
void (*atomic_destroy_state)(struct drm_private_obj *obj, |
| 283 |
struct drm_private_state *state); |
| 284 |
|
| 285 |
/** |
| 286 |
* @atomic_print_state: |
| 287 |
* |
| 288 |
* If driver subclasses &struct drm_private_state, it should implement |
| 289 |
* this optional hook for printing additional driver specific state. |
| 290 |
* |
| 291 |
* Do not call this directly, use drm_atomic_private_obj_print_state() |
| 292 |
* instead. |
| 293 |
*/ |
| 294 |
void (*atomic_print_state)(struct drm_printer *p, |
| 295 |
const struct drm_private_state *state); |
| 296 |
}; |
| 297 |
|
| 298 |
/** |
| 299 |
* struct drm_private_obj - base struct for driver private atomic object |
| 300 |
* |
| 301 |
* A driver private object is initialized by calling |
| 302 |
* drm_atomic_private_obj_init() and cleaned up by calling |
| 303 |
* drm_atomic_private_obj_fini(). |
| 304 |
* |
| 305 |
* Currently only tracks the state update functions and the opaque driver |
| 306 |
* private state itself, but in the future might also track which |
| 307 |
* &drm_modeset_lock is required to duplicate and update this object's state. |
| 308 |
* |
| 309 |
* All private objects must be initialized before the DRM device they are |
| 310 |
* attached to is registered to the DRM subsystem (call to drm_dev_register()) |
| 311 |
* and should stay around until this DRM device is unregistered (call to |
| 312 |
* drm_dev_unregister()). In other words, private objects lifetime is tied |
| 313 |
* to the DRM device lifetime. This implies that: |
| 314 |
* |
| 315 |
* 1/ all calls to drm_atomic_private_obj_init() must be done before calling |
| 316 |
* drm_dev_register() |
| 317 |
* 2/ all calls to drm_atomic_private_obj_fini() must be done after calling |
| 318 |
* drm_dev_unregister() |
| 319 |
* |
| 320 |
* If that private object is used to store a state shared by multiple |
| 321 |
* CRTCs, proper care must be taken to ensure that non-blocking commits are |
| 322 |
* properly ordered to avoid a use-after-free issue. |
| 323 |
* |
| 324 |
* Indeed, assuming a sequence of two non-blocking &drm_atomic_commit on two |
| 325 |
* different &drm_crtc using different &drm_plane and &drm_connector, so with no |
| 326 |
* resources shared, there's no guarantee on which commit is going to happen |
| 327 |
* first. However, the second &drm_atomic_commit will consider the first |
| 328 |
* &drm_private_obj its old state, and will be in charge of freeing it whenever |
| 329 |
* the second &drm_atomic_commit is done. |
| 330 |
* |
| 331 |
* If the first &drm_atomic_commit happens after it, it will consider its |
| 332 |
* &drm_private_obj the new state and will be likely to access it, resulting in |
| 333 |
* an access to a freed memory region. Drivers should store (and get a reference |
| 334 |
* to) the &drm_crtc_commit structure in our private state in |
| 335 |
* &drm_mode_config_helper_funcs.atomic_commit_setup, and then wait for that |
| 336 |
* commit to complete as the first step of |
| 337 |
* &drm_mode_config_helper_funcs.atomic_commit_tail, similar to |
| 338 |
* drm_atomic_helper_wait_for_dependencies(). |
| 339 |
*/ |
| 340 |
struct drm_private_obj { |
| 341 |
/** |
| 342 |
* @dev: parent DRM device |
| 343 |
*/ |
| 344 |
struct drm_device *dev; |
| 345 |
|
| 346 |
/** |
| 347 |
* @head: List entry used to attach a private object to a &drm_device |
| 348 |
* (queued to &drm_mode_config.privobj_list). |
| 349 |
*/ |
| 350 |
struct list_head head; |
| 351 |
|
| 352 |
/** |
| 353 |
* @lock: Modeset lock to protect the state object. |
| 354 |
*/ |
| 355 |
struct drm_modeset_lock lock; |
| 356 |
|
| 357 |
/** |
| 358 |
* @state: Current atomic state for this driver private object. |
| 359 |
*/ |
| 360 |
struct drm_private_state *state; |
| 361 |
|
| 362 |
/** |
| 363 |
* @funcs: |
| 364 |
* |
| 365 |
* Functions to manipulate the state of this driver private object, see |
| 366 |
* &drm_private_state_funcs. |
| 367 |
*/ |
| 368 |
const struct drm_private_state_funcs *funcs; |
| 369 |
}; |
| 370 |
|
| 371 |
/** |
| 372 |
* drm_for_each_privobj() - private object iterator |
| 373 |
* |
| 374 |
* @privobj: pointer to the current private object. Updated after each |
| 375 |
* iteration |
| 376 |
* @dev: the DRM device we want get private objects from |
| 377 |
* |
| 378 |
* Allows one to iterate over all private objects attached to @dev |
| 379 |
*/ |
| 380 |
#define drm_for_each_privobj(privobj, dev) \ |
| 381 |
list_for_each_entry(privobj, &(dev)->mode_config.privobj_list, head) |
| 382 |
|
| 383 |
/** |
| 384 |
* struct drm_private_state - base struct for driver private object state |
| 385 |
* |
| 386 |
* Currently only contains a backpointer to the overall atomic update, |
| 387 |
* and the relevant private object but in the future also might hold |
| 388 |
* synchronization information similar to e.g. &drm_crtc.commit. |
| 389 |
*/ |
| 390 |
struct drm_private_state { |
| 391 |
/** |
| 392 |
* @state: backpointer to global drm_atomic_state |
| 393 |
*/ |
| 394 |
struct drm_atomic_state *state; |
| 395 |
|
| 396 |
/** |
| 397 |
* @obj: backpointer to the private object |
| 398 |
*/ |
| 399 |
struct drm_private_obj *obj; |
| 400 |
}; |
| 401 |
|
| 402 |
struct __drm_private_objs_state { |
| 403 |
struct drm_private_obj *ptr; |
| 404 |
|
| 405 |
/** |
| 406 |
* @state_to_destroy: |
| 407 |
* |
| 408 |
* Used to track the @drm_private_state we will need to free |
| 409 |
* when tearing down the associated &drm_atomic_state in |
| 410 |
* $drm_mode_config_funcs.atomic_state_clear or |
| 411 |
* drm_atomic_state_default_clear(). |
| 412 |
* |
| 413 |
* Before a commit, and the call to |
| 414 |
* drm_atomic_helper_swap_state() in particular, it points to |
| 415 |
* the same state than @new_state. After a commit, it points to |
| 416 |
* the same state than @old_state. |
| 417 |
*/ |
| 418 |
struct drm_private_state *state_to_destroy; |
| 419 |
|
| 420 |
struct drm_private_state *old_state, *new_state; |
| 421 |
}; |
| 422 |
|
| 423 |
/** |
| 424 |
* struct drm_atomic_state - Atomic commit structure |
| 425 |
* |
| 426 |
* This structure is the kernel counterpart of @drm_mode_atomic and represents |
| 427 |
* an atomic commit that transitions from an old to a new display state. It |
| 428 |
* contains all the objects affected by the atomic commit and both the new |
| 429 |
* state structures and pointers to the old state structures for |
| 430 |
* these. |
| 431 |
* |
| 432 |
* States are added to an atomic update by calling drm_atomic_get_crtc_state(), |
| 433 |
* drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for |
| 434 |
* private state structures, drm_atomic_get_private_obj_state(). |
| 435 |
* |
| 436 |
* NOTE: struct drm_atomic_state first started as a single collection of |
| 437 |
* entities state pointers (drm_plane_state, drm_crtc_state, etc.). |
| 438 |
* |
| 439 |
* At atomic_check time, you could get the state about to be committed |
| 440 |
* from drm_atomic_state, and the one currently running from the |
| 441 |
* entities state pointer (drm_crtc.state, for example). After the call |
| 442 |
* to drm_atomic_helper_swap_state(), the entities state pointer would |
| 443 |
* contain the state previously checked, and the drm_atomic_state |
| 444 |
* structure the old state. |
| 445 |
* |
| 446 |
* Over time, and in order to avoid confusion, drm_atomic_state has |
| 447 |
* grown to have both the old state (ie, the state we replace) and the |
| 448 |
* new state (ie, the state we want to apply). Those names are stable |
| 449 |
* during the commit process, which makes it easier to reason about. |
| 450 |
* |
| 451 |
* You can still find some traces of that evolution through some hooks |
| 452 |
* or callbacks taking a drm_atomic_state parameter called names like |
| 453 |
* "old_state". This doesn't necessarily mean that the previous |
| 454 |
* drm_atomic_state is passed, but rather that this used to be the state |
| 455 |
* collection we were replacing after drm_atomic_helper_swap_state(), |
| 456 |
* but the variable name was never updated. |
| 457 |
* |
| 458 |
* Some atomic operations implementations followed a similar process. We |
| 459 |
* first started to pass the entity state only. However, it was pretty |
| 460 |
* cumbersome for drivers, and especially CRTCs, to retrieve the states |
| 461 |
* of other components. Thus, we switched to passing the whole |
| 462 |
* drm_atomic_state as a parameter to those operations. Similarly, the |
| 463 |
* transition isn't complete yet, and one might still find atomic |
| 464 |
* operations taking a drm_atomic_state pointer, or a component state |
| 465 |
* pointer. The former is the preferred form. |
| 466 |
*/ |
| 467 |
struct drm_atomic_state { |
| 468 |
/** |
| 469 |
* @ref: |
| 470 |
* |
| 471 |
* Count of all references to this update (will not be freed until zero). |
| 472 |
*/ |
| 473 |
struct kref ref; |
| 474 |
|
| 475 |
/** |
| 476 |
* @dev: Parent DRM Device. |
| 477 |
*/ |
| 478 |
struct drm_device *dev; |
| 479 |
|
| 480 |
/** |
| 481 |
* @allow_modeset: |
| 482 |
* |
| 483 |
* Allow full modeset. This is used by the ATOMIC IOCTL handler to |
| 484 |
* implement the DRM_MODE_ATOMIC_ALLOW_MODESET flag. Drivers should |
| 485 |
* generally not consult this flag, but instead look at the output of |
| 486 |
* drm_atomic_crtc_needs_modeset(). The detailed rules are: |
| 487 |
* |
| 488 |
* - Drivers must not consult @allow_modeset in the atomic commit path. |
| 489 |
* Use drm_atomic_crtc_needs_modeset() instead. |
| 490 |
* |
| 491 |
* - Drivers must consult @allow_modeset before adding unrelated struct |
| 492 |
* drm_crtc_state to this commit by calling |
| 493 |
* drm_atomic_get_crtc_state(). See also the warning in the |
| 494 |
* documentation for that function. |
| 495 |
* |
| 496 |
* - Drivers must never change this flag, it is under the exclusive |
| 497 |
* control of userspace. |
| 498 |
* |
| 499 |
* - Drivers may consult @allow_modeset in the atomic check path, if |
| 500 |
* they have the choice between an optimal hardware configuration |
| 501 |
* which requires a modeset, and a less optimal configuration which |
| 502 |
* can be committed without a modeset. An example would be suboptimal |
| 503 |
* scanout FIFO allocation resulting in increased idle power |
| 504 |
* consumption. This allows userspace to avoid flickering and delays |
| 505 |
* for the normal composition loop at reasonable cost. |
| 506 |
*/ |
| 507 |
bool allow_modeset : 1; |
| 508 |
/** |
| 509 |
* @legacy_cursor_update: |
| 510 |
* |
| 511 |
* Hint to enforce legacy cursor IOCTL semantics. |
| 512 |
* |
| 513 |
* WARNING: This is thoroughly broken and pretty much impossible to |
| 514 |
* implement correctly. Drivers must ignore this and should instead |
| 515 |
* implement &drm_plane_helper_funcs.atomic_async_check and |
| 516 |
* &drm_plane_helper_funcs.atomic_async_commit hooks. New users of this |
| 517 |
* flag are not allowed. |
| 518 |
*/ |
| 519 |
bool legacy_cursor_update : 1; |
| 520 |
|
| 521 |
/** |
| 522 |
* @async_update: hint for asynchronous plane update |
| 523 |
*/ |
| 524 |
bool async_update : 1; |
| 525 |
|
| 526 |
/** |
| 527 |
* @duplicated: |
| 528 |
* |
| 529 |
* Indicates whether or not this atomic state was duplicated using |
| 530 |
* drm_atomic_helper_duplicate_state(). Drivers and atomic helpers |
| 531 |
* should use this to fixup normal inconsistencies in duplicated |
| 532 |
* states. |
| 533 |
*/ |
| 534 |
bool duplicated : 1; |
| 535 |
|
| 536 |
/** |
| 537 |
* @checked: |
| 538 |
* |
| 539 |
* Indicates the state has been checked and thus must no longer |
| 540 |
* be mutated. For internal use only, do not consult from drivers. |
| 541 |
*/ |
| 542 |
bool checked : 1; |
| 543 |
|
| 544 |
/** |
| 545 |
* @plane_color_pipeline: |
| 546 |
* |
| 547 |
* Indicates whether this atomic state originated with a client that |
| 548 |
* set the DRM_CLIENT_CAP_PLANE_COLOR_PIPELINE. |
| 549 |
* |
| 550 |
* Drivers and helper functions should use this to ignore legacy |
| 551 |
* properties that are incompatible with the drm_plane COLOR_PIPELINE |
| 552 |
* behavior, such as: |
| 553 |
* |
| 554 |
* - COLOR_RANGE |
| 555 |
* - COLOR_ENCODING |
| 556 |
* |
| 557 |
* or any other driver-specific properties that might affect pixel |
| 558 |
* values. |
| 559 |
*/ |
| 560 |
bool plane_color_pipeline : 1; |
| 561 |
|
| 562 |
/** |
| 563 |
* @colorops: |
| 564 |
* |
| 565 |
* Pointer to array of @drm_colorop and @drm_colorop_state part of this |
| 566 |
* update. |
| 567 |
*/ |
| 568 |
struct __drm_colorops_state *colorops; |
| 569 |
|
| 570 |
/** |
| 571 |
* @planes: |
| 572 |
* |
| 573 |
* Pointer to array of @drm_plane and @drm_plane_state part of this |
| 574 |
* update. |
| 575 |
*/ |
| 576 |
struct __drm_planes_state *planes; |
| 577 |
|
| 578 |
/** |
| 579 |
* @crtcs: |
| 580 |
* |
| 581 |
* Pointer to array of @drm_crtc and @drm_crtc_state part of this |
| 582 |
* update. |
| 583 |
*/ |
| 584 |
struct __drm_crtcs_state *crtcs; |
| 585 |
|
| 586 |
/** |
| 587 |
* @num_connector: size of the @connectors array |
| 588 |
*/ |
| 589 |
int num_connector; |
| 590 |
|
| 591 |
/** |
| 592 |
* @connectors: |
| 593 |
* |
| 594 |
* Pointer to array of @drm_connector and @drm_connector_state part of |
| 595 |
* this update. |
| 596 |
*/ |
| 597 |
struct __drm_connnectors_state *connectors; |
| 598 |
|
| 599 |
/** |
| 600 |
* @num_private_objs: size of the @private_objs array |
| 601 |
*/ |
| 602 |
int num_private_objs; |
| 603 |
|
| 604 |
/** |
| 605 |
* @private_objs: |
| 606 |
* |
| 607 |
* Pointer to array of @drm_private_obj and @drm_private_obj_state part |
| 608 |
* of this update. |
| 609 |
*/ |
| 610 |
struct __drm_private_objs_state *private_objs; |
| 611 |
|
| 612 |
/** |
| 613 |
* @acquire_ctx: acquire context for this atomic modeset state update |
| 614 |
*/ |
| 615 |
struct drm_modeset_acquire_ctx *acquire_ctx; |
| 616 |
|
| 617 |
/** |
| 618 |
* @fake_commit: |
| 619 |
* |
| 620 |
* Used for signaling unbound planes/connectors. |
| 621 |
* When a connector or plane is not bound to any CRTC, it's still important |
| 622 |
* to preserve linearity to prevent the atomic states from being freed too early. |
| 623 |
* |
| 624 |
* This commit (if set) is not bound to any CRTC, but will be completed when |
| 625 |
* drm_atomic_helper_commit_hw_done() is called. |
| 626 |
*/ |
| 627 |
struct drm_crtc_commit *fake_commit; |
| 628 |
|
| 629 |
/** |
| 630 |
* @commit_work: |
| 631 |
* |
| 632 |
* Work item which can be used by the driver or helpers to execute the |
| 633 |
* commit without blocking. |
| 634 |
*/ |
| 635 |
struct work_struct commit_work; |
| 636 |
}; |
| 637 |
|
| 638 |
void __drm_crtc_commit_free(struct kref *kref); |
| 639 |
|
| 640 |
/** |
| 641 |
* drm_crtc_commit_get - acquire a reference to the CRTC commit |
| 642 |
* @commit: CRTC commit |
| 643 |
* |
| 644 |
* Increases the reference of @commit. |
| 645 |
* |
| 646 |
* Returns: |
| 647 |
* The pointer to @commit, with reference increased. |
| 648 |
*/ |
| 649 |
static inline struct drm_crtc_commit *drm_crtc_commit_get(struct drm_crtc_commit *commit) |
| 650 |
{ |
| 651 |
kref_get(&commit->ref); |
| 652 |
return commit; |
| 653 |
} |
| 654 |
|
| 655 |
/** |
| 656 |
* drm_crtc_commit_put - release a reference to the CRTC commmit |
| 657 |
* @commit: CRTC commit |
| 658 |
* |
| 659 |
* This releases a reference to @commit which is freed after removing the |
| 660 |
* final reference. No locking required and callable from any context. |
| 661 |
*/ |
| 662 |
static inline void drm_crtc_commit_put(struct drm_crtc_commit *commit) |
| 663 |
{ |
| 664 |
kref_put(&commit->ref, __drm_crtc_commit_free); |
| 665 |
} |
| 666 |
|
| 667 |
int drm_crtc_commit_wait(struct drm_crtc_commit *commit); |
| 668 |
|
| 669 |
struct drm_atomic_state * __must_check |
| 670 |
drm_atomic_state_alloc(struct drm_device *dev); |
| 671 |
void drm_atomic_state_clear(struct drm_atomic_state *state); |
| 672 |
|
| 673 |
/** |
| 674 |
* drm_atomic_state_get - acquire a reference to the atomic state |
| 675 |
* @state: The atomic state |
| 676 |
* |
| 677 |
* Returns a new reference to the @state |
| 678 |
*/ |
| 679 |
static inline struct drm_atomic_state * |
| 680 |
drm_atomic_state_get(struct drm_atomic_state *state) |
| 681 |
{ |
| 682 |
kref_get(&state->ref); |
| 683 |
return state; |
| 684 |
} |
| 685 |
|
| 686 |
void __drm_atomic_state_free(struct kref *ref); |
| 687 |
|
| 688 |
/** |
| 689 |
* drm_atomic_state_put - release a reference to the atomic state |
| 690 |
* @state: The atomic state |
| 691 |
* |
| 692 |
* This releases a reference to @state which is freed after removing the |
| 693 |
* final reference. No locking required and callable from any context. |
| 694 |
*/ |
| 695 |
static inline void drm_atomic_state_put(struct drm_atomic_state *state) |
| 696 |
{ |
| 697 |
kref_put(&state->ref, __drm_atomic_state_free); |
| 698 |
} |
| 699 |
|
| 700 |
int __must_check |
| 701 |
drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state); |
| 702 |
void drm_atomic_state_default_clear(struct drm_atomic_state *state); |
| 703 |
void drm_atomic_state_default_release(struct drm_atomic_state *state); |
| 704 |
|
| 705 |
struct drm_crtc_state * __must_check |
| 706 |
drm_atomic_get_crtc_state(struct drm_atomic_state *state, |
| 707 |
struct drm_crtc *crtc); |
| 708 |
struct drm_plane_state * __must_check |
| 709 |
drm_atomic_get_plane_state(struct drm_atomic_state *state, |
| 710 |
struct drm_plane *plane); |
| 711 |
struct drm_colorop_state * |
| 712 |
drm_atomic_get_colorop_state(struct drm_atomic_state *state, |
| 713 |
struct drm_colorop *colorop); |
| 714 |
|
| 715 |
struct drm_colorop_state * |
| 716 |
drm_atomic_get_old_colorop_state(struct drm_atomic_state *state, |
| 717 |
struct drm_colorop *colorop); |
| 718 |
struct drm_colorop_state * |
| 719 |
drm_atomic_get_new_colorop_state(struct drm_atomic_state *state, |
| 720 |
struct drm_colorop *colorop); |
| 721 |
|
| 722 |
struct drm_connector_state * __must_check |
| 723 |
drm_atomic_get_connector_state(struct drm_atomic_state *state, |
| 724 |
struct drm_connector *connector); |
| 725 |
|
| 726 |
void drm_atomic_private_obj_init(struct drm_device *dev, |
| 727 |
struct drm_private_obj *obj, |
| 728 |
struct drm_private_state *state, |
| 729 |
const struct drm_private_state_funcs *funcs); |
| 730 |
void drm_atomic_private_obj_fini(struct drm_private_obj *obj); |
| 731 |
|
| 732 |
struct drm_private_state * __must_check |
| 733 |
drm_atomic_get_private_obj_state(struct drm_atomic_state *state, |
| 734 |
struct drm_private_obj *obj); |
| 735 |
struct drm_private_state * |
| 736 |
drm_atomic_get_old_private_obj_state(const struct drm_atomic_state *state, |
| 737 |
struct drm_private_obj *obj); |
| 738 |
struct drm_private_state * |
| 739 |
drm_atomic_get_new_private_obj_state(const struct drm_atomic_state *state, |
| 740 |
struct drm_private_obj *obj); |
| 741 |
|
| 742 |
struct drm_connector * |
| 743 |
drm_atomic_get_old_connector_for_encoder(const struct drm_atomic_state *state, |
| 744 |
struct drm_encoder *encoder); |
| 745 |
struct drm_connector * |
| 746 |
drm_atomic_get_new_connector_for_encoder(const struct drm_atomic_state *state, |
| 747 |
struct drm_encoder *encoder); |
| 748 |
struct drm_connector * |
| 749 |
drm_atomic_get_connector_for_encoder(const struct drm_encoder *encoder, |
| 750 |
struct drm_modeset_acquire_ctx *ctx); |
| 751 |
|
| 752 |
struct drm_crtc * |
| 753 |
drm_atomic_get_old_crtc_for_encoder(struct drm_atomic_state *state, |
| 754 |
struct drm_encoder *encoder); |
| 755 |
struct drm_crtc * |
| 756 |
drm_atomic_get_new_crtc_for_encoder(struct drm_atomic_state *state, |
| 757 |
struct drm_encoder *encoder); |
| 758 |
|
| 759 |
/** |
| 760 |
* drm_atomic_get_old_crtc_state - get old CRTC state, if it exists |
| 761 |
* @state: global atomic state object |
| 762 |
* @crtc: CRTC to grab |
| 763 |
* |
| 764 |
* This function returns the old CRTC state for the given CRTC, or |
| 765 |
* NULL if the CRTC is not part of the global atomic state. |
| 766 |
*/ |
| 767 |
static inline struct drm_crtc_state * |
| 768 |
drm_atomic_get_old_crtc_state(const struct drm_atomic_state *state, |
| 769 |
struct drm_crtc *crtc) |
| 770 |
{ |
| 771 |
return state->crtcs[drm_crtc_index(crtc)].old_state; |
| 772 |
} |
| 773 |
/** |
| 774 |
* drm_atomic_get_new_crtc_state - get new CRTC state, if it exists |
| 775 |
* @state: global atomic state object |
| 776 |
* @crtc: CRTC to grab |
| 777 |
* |
| 778 |
* This function returns the new CRTC state for the given CRTC, or |
| 779 |
* NULL if the CRTC is not part of the global atomic state. |
| 780 |
*/ |
| 781 |
static inline struct drm_crtc_state * |
| 782 |
drm_atomic_get_new_crtc_state(const struct drm_atomic_state *state, |
| 783 |
struct drm_crtc *crtc) |
| 784 |
{ |
| 785 |
return state->crtcs[drm_crtc_index(crtc)].new_state; |
| 786 |
} |
| 787 |
|
| 788 |
/** |
| 789 |
* drm_atomic_get_old_plane_state - get plane state, if it exists |
| 790 |
* @state: global atomic state object |
| 791 |
* @plane: plane to grab |
| 792 |
* |
| 793 |
* This function returns the old plane state for the given plane, or |
| 794 |
* NULL if the plane is not part of the global atomic state. |
| 795 |
*/ |
| 796 |
static inline struct drm_plane_state * |
| 797 |
drm_atomic_get_old_plane_state(const struct drm_atomic_state *state, |
| 798 |
struct drm_plane *plane) |
| 799 |
{ |
| 800 |
return state->planes[drm_plane_index(plane)].old_state; |
| 801 |
} |
| 802 |
|
| 803 |
/** |
| 804 |
* drm_atomic_get_new_plane_state - get plane state, if it exists |
| 805 |
* @state: global atomic state object |
| 806 |
* @plane: plane to grab |
| 807 |
* |
| 808 |
* This function returns the new plane state for the given plane, or |
| 809 |
* NULL if the plane is not part of the global atomic state. |
| 810 |
*/ |
| 811 |
static inline struct drm_plane_state * |
| 812 |
drm_atomic_get_new_plane_state(const struct drm_atomic_state *state, |
| 813 |
struct drm_plane *plane) |
| 814 |
{ |
| 815 |
return state->planes[drm_plane_index(plane)].new_state; |
| 816 |
} |
| 817 |
|
| 818 |
/** |
| 819 |
* drm_atomic_get_old_connector_state - get connector state, if it exists |
| 820 |
* @state: global atomic state object |
| 821 |
* @connector: connector to grab |
| 822 |
* |
| 823 |
* This function returns the old connector state for the given connector, |
| 824 |
* or NULL if the connector is not part of the global atomic state. |
| 825 |
*/ |
| 826 |
static inline struct drm_connector_state * |
| 827 |
drm_atomic_get_old_connector_state(const struct drm_atomic_state *state, |
| 828 |
struct drm_connector *connector) |
| 829 |
{ |
| 830 |
int index = drm_connector_index(connector); |
| 831 |
|
| 832 |
if (index >= state->num_connector) |
| 833 |
return NULL; |
| 834 |
|
| 835 |
return state->connectors[index].old_state; |
| 836 |
} |
| 837 |
|
| 838 |
/** |
| 839 |
* drm_atomic_get_new_connector_state - get connector state, if it exists |
| 840 |
* @state: global atomic state object |
| 841 |
* @connector: connector to grab |
| 842 |
* |
| 843 |
* This function returns the new connector state for the given connector, |
| 844 |
* or NULL if the connector is not part of the global atomic state. |
| 845 |
*/ |
| 846 |
static inline struct drm_connector_state * |
| 847 |
drm_atomic_get_new_connector_state(const struct drm_atomic_state *state, |
| 848 |
struct drm_connector *connector) |
| 849 |
{ |
| 850 |
int index = drm_connector_index(connector); |
| 851 |
|
| 852 |
if (index >= state->num_connector) |
| 853 |
return NULL; |
| 854 |
|
| 855 |
return state->connectors[index].new_state; |
| 856 |
} |
| 857 |
|
| 858 |
/** |
| 859 |
* __drm_atomic_get_current_plane_state - get current plane state |
| 860 |
* @state: global atomic state object |
| 861 |
* @plane: plane to grab |
| 862 |
* |
| 863 |
* This function returns the plane state for the given plane, either the |
| 864 |
* new plane state from @state, or if the plane isn't part of the atomic |
| 865 |
* state update, from @plane. This is useful in atomic check callbacks, |
| 866 |
* when drivers need to peek at, but not change, state of other planes, |
| 867 |
* since it avoids threading an error code back up the call chain. |
| 868 |
* |
| 869 |
* WARNING: |
| 870 |
* |
| 871 |
* Note that this function is in general unsafe since it doesn't check for the |
| 872 |
* required locking for access state structures. Drivers must ensure that it is |
| 873 |
* safe to access the returned state structure through other means. One common |
| 874 |
* example is when planes are fixed to a single CRTC, and the driver knows that |
| 875 |
* the CRTC lock is held already. In that case holding the CRTC lock gives a |
| 876 |
* read-lock on all planes connected to that CRTC. But if planes can be |
| 877 |
* reassigned things get more tricky. In that case it's better to use |
| 878 |
* drm_atomic_get_plane_state and wire up full error handling. |
| 879 |
* |
| 880 |
* Returns: |
| 881 |
* |
| 882 |
* Read-only pointer to the current plane state. |
| 883 |
*/ |
| 884 |
static inline const struct drm_plane_state * |
| 885 |
__drm_atomic_get_current_plane_state(const struct drm_atomic_state *state, |
| 886 |
struct drm_plane *plane) |
| 887 |
{ |
| 888 |
struct drm_plane_state *plane_state; |
| 889 |
|
| 890 |
plane_state = drm_atomic_get_new_plane_state(state, plane); |
| 891 |
if (plane_state) |
| 892 |
return plane_state; |
| 893 |
|
| 894 |
/* |
| 895 |
* If the plane isn't part of the state, fallback to the currently active one. |
| 896 |
*/ |
| 897 |
return plane->state; |
| 898 |
} |
| 899 |
|
| 900 |
int __must_check |
| 901 |
drm_atomic_add_encoder_bridges(struct drm_atomic_state *state, |
| 902 |
struct drm_encoder *encoder); |
| 903 |
int __must_check |
| 904 |
drm_atomic_add_affected_connectors(struct drm_atomic_state *state, |
| 905 |
struct drm_crtc *crtc); |
| 906 |
int __must_check |
| 907 |
drm_atomic_add_affected_planes(struct drm_atomic_state *state, |
| 908 |
struct drm_crtc *crtc); |
| 909 |
int __must_check |
| 910 |
drm_atomic_add_affected_colorops(struct drm_atomic_state *state, |
| 911 |
struct drm_plane *plane); |
| 912 |
|
| 913 |
int __must_check drm_atomic_check_only(struct drm_atomic_state *state); |
| 914 |
int __must_check drm_atomic_commit(struct drm_atomic_state *state); |
| 915 |
int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state); |
| 916 |
|
| 917 |
void drm_state_dump(struct drm_device *dev, struct drm_printer *p); |
| 918 |
|
| 919 |
/** |
| 920 |
* for_each_oldnew_connector_in_state - iterate over all connectors in an atomic update |
| 921 |
* @__state: &struct drm_atomic_state pointer |
| 922 |
* @connector: &struct drm_connector iteration cursor |
| 923 |
* @old_connector_state: &struct drm_connector_state iteration cursor for the |
| 924 |
* old state |
| 925 |
* @new_connector_state: &struct drm_connector_state iteration cursor for the |
| 926 |
* new state |
| 927 |
* @__i: int iteration cursor, for macro-internal use |
| 928 |
* |
| 929 |
* This iterates over all connectors in an atomic update, tracking both old and |
| 930 |
* new state. This is useful in places where the state delta needs to be |
| 931 |
* considered, for example in atomic check functions. |
| 932 |
*/ |
| 933 |
#define for_each_oldnew_connector_in_state(__state, connector, old_connector_state, new_connector_state, __i) \ |
| 934 |
for ((__i) = 0; \ |
| 935 |
(__i) < (__state)->num_connector; \ |
| 936 |
(__i)++) \ |
| 937 |
for_each_if ((__state)->connectors[__i].ptr && \ |
| 938 |
((connector) = (__state)->connectors[__i].ptr, \ |
| 939 |
(void)(connector) /* Only to avoid unused-but-set-variable warning */, \ |
| 940 |
(old_connector_state) = (__state)->connectors[__i].old_state, \ |
| 941 |
(new_connector_state) = (__state)->connectors[__i].new_state, 1)) |
| 942 |
|
| 943 |
/** |
| 944 |
* for_each_old_connector_in_state - iterate over all connectors in an atomic update |
| 945 |
* @__state: &struct drm_atomic_state pointer |
| 946 |
* @connector: &struct drm_connector iteration cursor |
| 947 |
* @old_connector_state: &struct drm_connector_state iteration cursor for the |
| 948 |
* old state |
| 949 |
* @__i: int iteration cursor, for macro-internal use |
| 950 |
* |
| 951 |
* This iterates over all connectors in an atomic update, tracking only the old |
| 952 |
* state. This is useful in disable functions, where we need the old state the |
| 953 |
* hardware is still in. |
| 954 |
*/ |
| 955 |
#define for_each_old_connector_in_state(__state, connector, old_connector_state, __i) \ |
| 956 |
for ((__i) = 0; \ |
| 957 |
(__i) < (__state)->num_connector; \ |
| 958 |
(__i)++) \ |
| 959 |
for_each_if ((__state)->connectors[__i].ptr && \ |
| 960 |
((connector) = (__state)->connectors[__i].ptr, \ |
| 961 |
(void)(connector) /* Only to avoid unused-but-set-variable warning */, \ |
| 962 |
(old_connector_state) = (__state)->connectors[__i].old_state, 1)) |
| 963 |
|
| 964 |
/** |
| 965 |
* for_each_new_connector_in_state - iterate over all connectors in an atomic update |
| 966 |
* @__state: &struct drm_atomic_state pointer |
| 967 |
* @connector: &struct drm_connector iteration cursor |
| 968 |
* @new_connector_state: &struct drm_connector_state iteration cursor for the |
| 969 |
* new state |
| 970 |
* @__i: int iteration cursor, for macro-internal use |
| 971 |
* |
| 972 |
* This iterates over all connectors in an atomic update, tracking only the new |
| 973 |
* state. This is useful in enable functions, where we need the new state the |
| 974 |
* hardware should be in when the atomic commit operation has completed. |
| 975 |
*/ |
| 976 |
#define for_each_new_connector_in_state(__state, connector, new_connector_state, __i) \ |
| 977 |
for ((__i) = 0; \ |
| 978 |
(__i) < (__state)->num_connector; \ |
| 979 |
(__i)++) \ |
| 980 |
for_each_if ((__state)->connectors[__i].ptr && \ |
| 981 |
((connector) = (__state)->connectors[__i].ptr, \ |
| 982 |
(void)(connector) /* Only to avoid unused-but-set-variable warning */, \ |
| 983 |
(new_connector_state) = (__state)->connectors[__i].new_state, \ |
| 984 |
(void)(new_connector_state) /* Only to avoid unused-but-set-variable warning */, 1)) |
| 985 |
|
| 986 |
/** |
| 987 |
* for_each_oldnew_crtc_in_state - iterate over all CRTCs in an atomic update |
| 988 |
* @__state: &struct drm_atomic_state pointer |
| 989 |
* @crtc: &struct drm_crtc iteration cursor |
| 990 |
* @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state |
| 991 |
* @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state |
| 992 |
* @__i: int iteration cursor, for macro-internal use |
| 993 |
* |
| 994 |
* This iterates over all CRTCs in an atomic update, tracking both old and |
| 995 |
* new state. This is useful in places where the state delta needs to be |
| 996 |
* considered, for example in atomic check functions. |
| 997 |
*/ |
| 998 |
#define for_each_oldnew_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \ |
| 999 |
for ((__i) = 0; \ |
| 1000 |
(__i) < (__state)->dev->mode_config.num_crtc; \ |
| 1001 |
(__i)++) \ |
| 1002 |
for_each_if ((__state)->crtcs[__i].ptr && \ |
| 1003 |
((crtc) = (__state)->crtcs[__i].ptr, \ |
| 1004 |
(void)(crtc) /* Only to avoid unused-but-set-variable warning */, \ |
| 1005 |
(old_crtc_state) = (__state)->crtcs[__i].old_state, \ |
| 1006 |
(void)(old_crtc_state) /* Only to avoid unused-but-set-variable warning */, \ |
| 1007 |
(new_crtc_state) = (__state)->crtcs[__i].new_state, \ |
| 1008 |
(void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1)) |
| 1009 |
|
| 1010 |
/** |
| 1011 |
* for_each_old_crtc_in_state - iterate over all CRTCs in an atomic update |
| 1012 |
* @__state: &struct drm_atomic_state pointer |
| 1013 |
* @crtc: &struct drm_crtc iteration cursor |
| 1014 |
* @old_crtc_state: &struct drm_crtc_state iteration cursor for the old state |
| 1015 |
* @__i: int iteration cursor, for macro-internal use |
| 1016 |
* |
| 1017 |
* This iterates over all CRTCs in an atomic update, tracking only the old |
| 1018 |
* state. This is useful in disable functions, where we need the old state the |
| 1019 |
* hardware is still in. |
| 1020 |
*/ |
| 1021 |
#define for_each_old_crtc_in_state(__state, crtc, old_crtc_state, __i) \ |
| 1022 |
for ((__i) = 0; \ |
| 1023 |
(__i) < (__state)->dev->mode_config.num_crtc; \ |
| 1024 |
(__i)++) \ |
| 1025 |
for_each_if ((__state)->crtcs[__i].ptr && \ |
| 1026 |
((crtc) = (__state)->crtcs[__i].ptr, \ |
| 1027 |
(void)(crtc) /* Only to avoid unused-but-set-variable warning */, \ |
| 1028 |
(old_crtc_state) = (__state)->crtcs[__i].old_state, 1)) |
| 1029 |
|
| 1030 |
/** |
| 1031 |
* for_each_new_crtc_in_state - iterate over all CRTCs in an atomic update |
| 1032 |
* @__state: &struct drm_atomic_state pointer |
| 1033 |
* @crtc: &struct drm_crtc iteration cursor |
| 1034 |
* @new_crtc_state: &struct drm_crtc_state iteration cursor for the new state |
| 1035 |
* @__i: int iteration cursor, for macro-internal use |
| 1036 |
* |
| 1037 |
* This iterates over all CRTCs in an atomic update, tracking only the new |
| 1038 |
* state. This is useful in enable functions, where we need the new state the |
| 1039 |
* hardware should be in when the atomic commit operation has completed. |
| 1040 |
*/ |
| 1041 |
#define for_each_new_crtc_in_state(__state, crtc, new_crtc_state, __i) \ |
| 1042 |
for ((__i) = 0; \ |
| 1043 |
(__i) < (__state)->dev->mode_config.num_crtc; \ |
| 1044 |
(__i)++) \ |
| 1045 |
for_each_if ((__state)->crtcs[__i].ptr && \ |
| 1046 |
((crtc) = (__state)->crtcs[__i].ptr, \ |
| 1047 |
(void)(crtc) /* Only to avoid unused-but-set-variable warning */, \ |
| 1048 |
(new_crtc_state) = (__state)->crtcs[__i].new_state, \ |
| 1049 |
(void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1)) |
| 1050 |
|
| 1051 |
/** |
| 1052 |
* for_each_oldnew_colorop_in_state - iterate over all colorops in an atomic update |
| 1053 |
* @__state: &struct drm_atomic_state pointer |
| 1054 |
* @colorop: &struct drm_colorop iteration cursor |
| 1055 |
* @old_colorop_state: &struct drm_colorop_state iteration cursor for the old state |
| 1056 |
* @new_colorop_state: &struct drm_colorop_state iteration cursor for the new state |
| 1057 |
* @__i: int iteration cursor, for macro-internal use |
| 1058 |
* |
| 1059 |
* This iterates over all colorops in an atomic update, tracking both old and |
| 1060 |
* new state. This is useful in places where the state delta needs to be |
| 1061 |
* considered, for example in atomic check functions. |
| 1062 |
*/ |
| 1063 |
#define for_each_oldnew_colorop_in_state(__state, colorop, old_colorop_state, \ |
| 1064 |
new_colorop_state, __i) \ |
| 1065 |
for ((__i) = 0; \ |
| 1066 |
(__i) < (__state)->dev->mode_config.num_colorop; \ |
| 1067 |
(__i)++) \ |
| 1068 |
for_each_if ((__state)->colorops[__i].ptr && \ |
| 1069 |
((colorop) = (__state)->colorops[__i].ptr, \ |
| 1070 |
(void)(colorop) /* Only to avoid unused-but-set-variable warning */, \ |
| 1071 |
(old_colorop_state) = (__state)->colorops[__i].old_state,\ |
| 1072 |
(new_colorop_state) = (__state)->colorops[__i].new_state, 1)) |
| 1073 |
|
| 1074 |
/** |
| 1075 |
* for_each_new_colorop_in_state - iterate over all colorops in an atomic update |
| 1076 |
* @__state: &struct drm_atomic_state pointer |
| 1077 |
* @colorop: &struct drm_colorop iteration cursor |
| 1078 |
* @new_colorop_state: &struct drm_colorop_state iteration cursor for the new state |
| 1079 |
* @__i: int iteration cursor, for macro-internal use |
| 1080 |
* |
| 1081 |
* This iterates over all colorops in an atomic update, tracking new state. This is |
| 1082 |
* useful in places where the state delta needs to be considered, for example in |
| 1083 |
* atomic check functions. |
| 1084 |
*/ |
| 1085 |
#define for_each_new_colorop_in_state(__state, colorop, new_colorop_state, __i) \ |
| 1086 |
for ((__i) = 0; \ |
| 1087 |
(__i) < (__state)->dev->mode_config.num_colorop; \ |
| 1088 |
(__i)++) \ |
| 1089 |
for_each_if ((__state)->colorops[__i].ptr && \ |
| 1090 |
((colorop) = (__state)->colorops[__i].ptr, \ |
| 1091 |
(void)(colorop) /* Only to avoid unused-but-set-variable warning */, \ |
| 1092 |
(new_colorop_state) = (__state)->colorops[__i].new_state, 1)) |
| 1093 |
|
| 1094 |
/** |
| 1095 |
* for_each_oldnew_plane_in_state - iterate over all planes in an atomic update |
| 1096 |
* @__state: &struct drm_atomic_state pointer |
| 1097 |
* @plane: &struct drm_plane iteration cursor |
| 1098 |
* @old_plane_state: &struct drm_plane_state iteration cursor for the old state |
| 1099 |
* @new_plane_state: &struct drm_plane_state iteration cursor for the new state |
| 1100 |
* @__i: int iteration cursor, for macro-internal use |
| 1101 |
* |
| 1102 |
* This iterates over all planes in an atomic update, tracking both old and |
| 1103 |
* new state. This is useful in places where the state delta needs to be |
| 1104 |
* considered, for example in atomic check functions. |
| 1105 |
*/ |
| 1106 |
#define for_each_oldnew_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \ |
| 1107 |
for ((__i) = 0; \ |
| 1108 |
(__i) < (__state)->dev->mode_config.num_total_plane; \ |
| 1109 |
(__i)++) \ |
| 1110 |
for_each_if ((__state)->planes[__i].ptr && \ |
| 1111 |
((plane) = (__state)->planes[__i].ptr, \ |
| 1112 |
(void)(plane) /* Only to avoid unused-but-set-variable warning */, \ |
| 1113 |
(old_plane_state) = (__state)->planes[__i].old_state,\ |
| 1114 |
(new_plane_state) = (__state)->planes[__i].new_state, 1)) |
| 1115 |
|
| 1116 |
/** |
| 1117 |
* for_each_oldnew_plane_in_state_reverse - iterate over all planes in an atomic |
| 1118 |
* update in reverse order |
| 1119 |
* @__state: &struct drm_atomic_state pointer |
| 1120 |
* @plane: &struct drm_plane iteration cursor |
| 1121 |
* @old_plane_state: &struct drm_plane_state iteration cursor for the old state |
| 1122 |
* @new_plane_state: &struct drm_plane_state iteration cursor for the new state |
| 1123 |
* @__i: int iteration cursor, for macro-internal use |
| 1124 |
* |
| 1125 |
* This iterates over all planes in an atomic update in reverse order, |
| 1126 |
* tracking both old and new state. This is useful in places where the |
| 1127 |
* state delta needs to be considered, for example in atomic check functions. |
| 1128 |
*/ |
| 1129 |
#define for_each_oldnew_plane_in_state_reverse(__state, plane, old_plane_state, new_plane_state, __i) \ |
| 1130 |
for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \ |
| 1131 |
(__i) >= 0; \ |
| 1132 |
(__i)--) \ |
| 1133 |
for_each_if ((__state)->planes[__i].ptr && \ |
| 1134 |
((plane) = (__state)->planes[__i].ptr, \ |
| 1135 |
(old_plane_state) = (__state)->planes[__i].old_state,\ |
| 1136 |
(new_plane_state) = (__state)->planes[__i].new_state, 1)) |
| 1137 |
|
| 1138 |
/** |
| 1139 |
* for_each_new_plane_in_state_reverse - other than only tracking new state, |
| 1140 |
* it's the same as for_each_oldnew_plane_in_state_reverse |
| 1141 |
* @__state: &struct drm_atomic_state pointer |
| 1142 |
* @plane: &struct drm_plane iteration cursor |
| 1143 |
* @new_plane_state: &struct drm_plane_state iteration cursor for the new state |
| 1144 |
* @__i: int iteration cursor, for macro-internal use |
| 1145 |
*/ |
| 1146 |
#define for_each_new_plane_in_state_reverse(__state, plane, new_plane_state, __i) \ |
| 1147 |
for ((__i) = ((__state)->dev->mode_config.num_total_plane - 1); \ |
| 1148 |
(__i) >= 0; \ |
| 1149 |
(__i)--) \ |
| 1150 |
for_each_if ((__state)->planes[__i].ptr && \ |
| 1151 |
((plane) = (__state)->planes[__i].ptr, \ |
| 1152 |
(new_plane_state) = (__state)->planes[__i].new_state, 1)) |
| 1153 |
|
| 1154 |
/** |
| 1155 |
* for_each_old_plane_in_state - iterate over all planes in an atomic update |
| 1156 |
* @__state: &struct drm_atomic_state pointer |
| 1157 |
* @plane: &struct drm_plane iteration cursor |
| 1158 |
* @old_plane_state: &struct drm_plane_state iteration cursor for the old state |
| 1159 |
* @__i: int iteration cursor, for macro-internal use |
| 1160 |
* |
| 1161 |
* This iterates over all planes in an atomic update, tracking only the old |
| 1162 |
* state. This is useful in disable functions, where we need the old state the |
| 1163 |
* hardware is still in. |
| 1164 |
*/ |
| 1165 |
#define for_each_old_plane_in_state(__state, plane, old_plane_state, __i) \ |
| 1166 |
for ((__i) = 0; \ |
| 1167 |
(__i) < (__state)->dev->mode_config.num_total_plane; \ |
| 1168 |
(__i)++) \ |
| 1169 |
for_each_if ((__state)->planes[__i].ptr && \ |
| 1170 |
((plane) = (__state)->planes[__i].ptr, \ |
| 1171 |
(old_plane_state) = (__state)->planes[__i].old_state, 1)) |
| 1172 |
/** |
| 1173 |
* for_each_new_plane_in_state - iterate over all planes in an atomic update |
| 1174 |
* @__state: &struct drm_atomic_state pointer |
| 1175 |
* @plane: &struct drm_plane iteration cursor |
| 1176 |
* @new_plane_state: &struct drm_plane_state iteration cursor for the new state |
| 1177 |
* @__i: int iteration cursor, for macro-internal use |
| 1178 |
* |
| 1179 |
* This iterates over all planes in an atomic update, tracking only the new |
| 1180 |
* state. This is useful in enable functions, where we need the new state the |
| 1181 |
* hardware should be in when the atomic commit operation has completed. |
| 1182 |
*/ |
| 1183 |
#define for_each_new_plane_in_state(__state, plane, new_plane_state, __i) \ |
| 1184 |
for ((__i) = 0; \ |
| 1185 |
(__i) < (__state)->dev->mode_config.num_total_plane; \ |
| 1186 |
(__i)++) \ |
| 1187 |
for_each_if ((__state)->planes[__i].ptr && \ |
| 1188 |
((plane) = (__state)->planes[__i].ptr, \ |
| 1189 |
(void)(plane) /* Only to avoid unused-but-set-variable warning */, \ |
| 1190 |
(new_plane_state) = (__state)->planes[__i].new_state, \ |
| 1191 |
(void)(new_plane_state) /* Only to avoid unused-but-set-variable warning */, 1)) |
| 1192 |
|
| 1193 |
/** |
| 1194 |
* for_each_oldnew_private_obj_in_state - iterate over all private objects in an atomic update |
| 1195 |
* @__state: &struct drm_atomic_state pointer |
| 1196 |
* @obj: &struct drm_private_obj iteration cursor |
| 1197 |
* @old_obj_state: &struct drm_private_state iteration cursor for the old state |
| 1198 |
* @new_obj_state: &struct drm_private_state iteration cursor for the new state |
| 1199 |
* @__i: int iteration cursor, for macro-internal use |
| 1200 |
* |
| 1201 |
* This iterates over all private objects in an atomic update, tracking both |
| 1202 |
* old and new state. This is useful in places where the state delta needs |
| 1203 |
* to be considered, for example in atomic check functions. |
| 1204 |
*/ |
| 1205 |
#define for_each_oldnew_private_obj_in_state(__state, obj, old_obj_state, new_obj_state, __i) \ |
| 1206 |
for ((__i) = 0; \ |
| 1207 |
(__i) < (__state)->num_private_objs && \ |
| 1208 |
((obj) = (__state)->private_objs[__i].ptr, \ |
| 1209 |
(old_obj_state) = (__state)->private_objs[__i].old_state, \ |
| 1210 |
(new_obj_state) = (__state)->private_objs[__i].new_state, 1); \ |
| 1211 |
(__i)++) |
| 1212 |
|
| 1213 |
/** |
| 1214 |
* for_each_old_private_obj_in_state - iterate over all private objects in an atomic update |
| 1215 |
* @__state: &struct drm_atomic_state pointer |
| 1216 |
* @obj: &struct drm_private_obj iteration cursor |
| 1217 |
* @old_obj_state: &struct drm_private_state iteration cursor for the old state |
| 1218 |
* @__i: int iteration cursor, for macro-internal use |
| 1219 |
* |
| 1220 |
* This iterates over all private objects in an atomic update, tracking only |
| 1221 |
* the old state. This is useful in disable functions, where we need the old |
| 1222 |
* state the hardware is still in. |
| 1223 |
*/ |
| 1224 |
#define for_each_old_private_obj_in_state(__state, obj, old_obj_state, __i) \ |
| 1225 |
for ((__i) = 0; \ |
| 1226 |
(__i) < (__state)->num_private_objs && \ |
| 1227 |
((obj) = (__state)->private_objs[__i].ptr, \ |
| 1228 |
(old_obj_state) = (__state)->private_objs[__i].old_state, 1); \ |
| 1229 |
(__i)++) |
| 1230 |
|
| 1231 |
/** |
| 1232 |
* for_each_new_private_obj_in_state - iterate over all private objects in an atomic update |
| 1233 |
* @__state: &struct drm_atomic_state pointer |
| 1234 |
* @obj: &struct drm_private_obj iteration cursor |
| 1235 |
* @new_obj_state: &struct drm_private_state iteration cursor for the new state |
| 1236 |
* @__i: int iteration cursor, for macro-internal use |
| 1237 |
* |
| 1238 |
* This iterates over all private objects in an atomic update, tracking only |
| 1239 |
* the new state. This is useful in enable functions, where we need the new state the |
| 1240 |
* hardware should be in when the atomic commit operation has completed. |
| 1241 |
*/ |
| 1242 |
#define for_each_new_private_obj_in_state(__state, obj, new_obj_state, __i) \ |
| 1243 |
for ((__i) = 0; \ |
| 1244 |
(__i) < (__state)->num_private_objs && \ |
| 1245 |
((obj) = (__state)->private_objs[__i].ptr, \ |
| 1246 |
(void)(obj) /* Only to avoid unused-but-set-variable warning */, \ |
| 1247 |
(new_obj_state) = (__state)->private_objs[__i].new_state, 1); \ |
| 1248 |
(__i)++) |
| 1249 |
|
| 1250 |
/** |
| 1251 |
* drm_atomic_crtc_needs_modeset - compute combined modeset need |
| 1252 |
* @state: &drm_crtc_state for the CRTC |
| 1253 |
* |
| 1254 |
* To give drivers flexibility &struct drm_crtc_state has 3 booleans to track |
| 1255 |
* whether the state CRTC changed enough to need a full modeset cycle: |
| 1256 |
* mode_changed, active_changed and connectors_changed. This helper simply |
| 1257 |
* combines these three to compute the overall need for a modeset for @state. |
| 1258 |
* |
| 1259 |
* The atomic helper code sets these booleans, but drivers can and should |
| 1260 |
* change them appropriately to accurately represent whether a modeset is |
| 1261 |
* really needed. In general, drivers should avoid full modesets whenever |
| 1262 |
* possible. |
| 1263 |
* |
| 1264 |
* For example if the CRTC mode has changed, and the hardware is able to enact |
| 1265 |
* the requested mode change without going through a full modeset, the driver |
| 1266 |
* should clear mode_changed in its &drm_mode_config_funcs.atomic_check |
| 1267 |
* implementation. |
| 1268 |
*/ |
| 1269 |
static inline bool |
| 1270 |
drm_atomic_crtc_needs_modeset(const struct drm_crtc_state *state) |
| 1271 |
{ |
| 1272 |
return state->mode_changed || state->active_changed || |
| 1273 |
state->connectors_changed; |
| 1274 |
} |
| 1275 |
|
| 1276 |
/** |
| 1277 |
* drm_atomic_crtc_effectively_active - compute whether CRTC is actually active |
| 1278 |
* @state: &drm_crtc_state for the CRTC |
| 1279 |
* |
| 1280 |
* When in self refresh mode, the crtc_state->active value will be false, since |
| 1281 |
* the CRTC is off. However in some cases we're interested in whether the CRTC |
| 1282 |
* is active, or effectively active (ie: it's connected to an active display). |
| 1283 |
* In these cases, use this function instead of just checking active. |
| 1284 |
*/ |
| 1285 |
static inline bool |
| 1286 |
drm_atomic_crtc_effectively_active(const struct drm_crtc_state *state) |
| 1287 |
{ |
| 1288 |
return state->active || state->self_refresh_active; |
| 1289 |
} |
| 1290 |
|
| 1291 |
/** |
| 1292 |
* struct drm_bus_cfg - bus configuration |
| 1293 |
* |
| 1294 |
* This structure stores the configuration of a physical bus between two |
| 1295 |
* components in an output pipeline, usually between two bridges, an encoder |
| 1296 |
* and a bridge, or a bridge and a connector. |
| 1297 |
* |
| 1298 |
* The bus configuration is stored in &drm_bridge_state separately for the |
| 1299 |
* input and output buses, as seen from the point of view of each bridge. The |
| 1300 |
* bus configuration of a bridge output is usually identical to the |
| 1301 |
* configuration of the next bridge's input, but may differ if the signals are |
| 1302 |
* modified between the two bridges, for instance by an inverter on the board. |
| 1303 |
* The input and output configurations of a bridge may differ if the bridge |
| 1304 |
* modifies the signals internally, for instance by performing format |
| 1305 |
* conversion, or modifying signals polarities. |
| 1306 |
*/ |
| 1307 |
struct drm_bus_cfg { |
| 1308 |
/** |
| 1309 |
* @format: format used on this bus (one of the MEDIA_BUS_FMT_* format) |
| 1310 |
* |
| 1311 |
* This field should not be directly modified by drivers |
| 1312 |
* (drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus |
| 1313 |
* format negotiation). |
| 1314 |
*/ |
| 1315 |
u32 format; |
| 1316 |
|
| 1317 |
/** |
| 1318 |
* @flags: DRM_BUS_* flags used on this bus |
| 1319 |
*/ |
| 1320 |
u32 flags; |
| 1321 |
}; |
| 1322 |
|
| 1323 |
/** |
| 1324 |
* struct drm_bridge_state - Atomic bridge state object |
| 1325 |
*/ |
| 1326 |
struct drm_bridge_state { |
| 1327 |
/** |
| 1328 |
* @base: inherit from &drm_private_state |
| 1329 |
*/ |
| 1330 |
struct drm_private_state base; |
| 1331 |
|
| 1332 |
/** |
| 1333 |
* @bridge: the bridge this state refers to |
| 1334 |
*/ |
| 1335 |
struct drm_bridge *bridge; |
| 1336 |
|
| 1337 |
/** |
| 1338 |
* @input_bus_cfg: input bus configuration |
| 1339 |
*/ |
| 1340 |
struct drm_bus_cfg input_bus_cfg; |
| 1341 |
|
| 1342 |
/** |
| 1343 |
* @output_bus_cfg: output bus configuration |
| 1344 |
*/ |
| 1345 |
struct drm_bus_cfg output_bus_cfg; |
| 1346 |
}; |
| 1347 |
|
| 1348 |
static inline struct drm_bridge_state * |
| 1349 |
drm_priv_to_bridge_state(struct drm_private_state *priv) |
| 1350 |
{ |
| 1351 |
return container_of(priv, struct drm_bridge_state, base); |
| 1352 |
} |
| 1353 |
|
| 1354 |
struct drm_bridge_state * |
| 1355 |
drm_atomic_get_bridge_state(struct drm_atomic_state *state, |
| 1356 |
struct drm_bridge *bridge); |
| 1357 |
struct drm_bridge_state * |
| 1358 |
drm_atomic_get_old_bridge_state(const struct drm_atomic_state *state, |
| 1359 |
struct drm_bridge *bridge); |
| 1360 |
struct drm_bridge_state * |
| 1361 |
drm_atomic_get_new_bridge_state(const struct drm_atomic_state *state, |
| 1362 |
struct drm_bridge *bridge); |
| 1363 |
|
| 1364 |
#endif /* DRM_ATOMIC_H_ */ |