drm_atomic_helper.h 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  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 <robdclark@gmail.com>
  25. * Daniel Vetter <daniel.vetter@ffwll.ch>
  26. */
  27. #ifndef DRM_ATOMIC_HELPER_H_
  28. #define DRM_ATOMIC_HELPER_H_
  29. #include <drm/drm_crtc.h>
  30. #include <drm/drm_modeset_helper_vtables.h>
  31. #include <drm/drm_modeset_helper.h>
  32. #include <drm/drm_atomic_state_helper.h>
  33. #include <drm/drm_util.h>
  34. struct drm_atomic_state;
  35. struct drm_private_obj;
  36. struct drm_private_state;
  37. int drm_atomic_helper_check_modeset(struct drm_device *dev,
  38. struct drm_atomic_state *state);
  39. int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
  40. const struct drm_crtc_state *crtc_state,
  41. int min_scale,
  42. int max_scale,
  43. bool can_position,
  44. bool can_update_disabled);
  45. int drm_atomic_helper_check_planes(struct drm_device *dev,
  46. struct drm_atomic_state *state);
  47. int drm_atomic_helper_check(struct drm_device *dev,
  48. struct drm_atomic_state *state);
  49. void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
  50. void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
  51. int drm_atomic_helper_commit(struct drm_device *dev,
  52. struct drm_atomic_state *state,
  53. bool nonblock);
  54. int drm_atomic_helper_async_check(struct drm_device *dev,
  55. struct drm_atomic_state *state);
  56. void drm_atomic_helper_async_commit(struct drm_device *dev,
  57. struct drm_atomic_state *state);
  58. int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
  59. struct drm_atomic_state *state,
  60. bool pre_swap);
  61. void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
  62. struct drm_atomic_state *old_state);
  63. void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
  64. struct drm_atomic_state *old_state);
  65. void
  66. drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
  67. struct drm_atomic_state *old_state);
  68. void
  69. drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state);
  70. void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
  71. struct drm_atomic_state *state);
  72. void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
  73. struct drm_atomic_state *old_state);
  74. int drm_atomic_helper_prepare_planes(struct drm_device *dev,
  75. struct drm_atomic_state *state);
  76. #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
  77. #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
  78. void drm_atomic_helper_commit_planes(struct drm_device *dev,
  79. struct drm_atomic_state *state,
  80. uint32_t flags);
  81. void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
  82. struct drm_atomic_state *old_state);
  83. void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
  84. void
  85. drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
  86. bool atomic);
  87. int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
  88. bool stall);
  89. /* nonblocking commit helpers */
  90. int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
  91. bool nonblock);
  92. void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
  93. void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);
  94. void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
  95. void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
  96. /* implementations for legacy interfaces */
  97. int drm_atomic_helper_update_plane(struct drm_plane *plane,
  98. struct drm_crtc *crtc,
  99. struct drm_framebuffer *fb,
  100. int crtc_x, int crtc_y,
  101. unsigned int crtc_w, unsigned int crtc_h,
  102. uint32_t src_x, uint32_t src_y,
  103. uint32_t src_w, uint32_t src_h,
  104. struct drm_modeset_acquire_ctx *ctx);
  105. int drm_atomic_helper_disable_plane(struct drm_plane *plane,
  106. struct drm_modeset_acquire_ctx *ctx);
  107. int drm_atomic_helper_set_config(struct drm_mode_set *set,
  108. struct drm_modeset_acquire_ctx *ctx);
  109. int drm_atomic_helper_disable_all(struct drm_device *dev,
  110. struct drm_modeset_acquire_ctx *ctx);
  111. void drm_atomic_helper_shutdown(struct drm_device *dev);
  112. struct drm_atomic_state *
  113. drm_atomic_helper_duplicate_state(struct drm_device *dev,
  114. struct drm_modeset_acquire_ctx *ctx);
  115. struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
  116. int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
  117. struct drm_modeset_acquire_ctx *ctx);
  118. int drm_atomic_helper_resume(struct drm_device *dev,
  119. struct drm_atomic_state *state);
  120. int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
  121. struct drm_framebuffer *fb,
  122. struct drm_pending_vblank_event *event,
  123. uint32_t flags,
  124. struct drm_modeset_acquire_ctx *ctx);
  125. int drm_atomic_helper_page_flip_target(
  126. struct drm_crtc *crtc,
  127. struct drm_framebuffer *fb,
  128. struct drm_pending_vblank_event *event,
  129. uint32_t flags,
  130. uint32_t target,
  131. struct drm_modeset_acquire_ctx *ctx);
  132. int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
  133. u16 *red, u16 *green, u16 *blue,
  134. uint32_t size,
  135. struct drm_modeset_acquire_ctx *ctx);
  136. /**
  137. * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
  138. * @plane: the loop cursor
  139. * @crtc: the CRTC whose planes are iterated
  140. *
  141. * This iterates over the current state, useful (for example) when applying
  142. * atomic state after it has been checked and swapped. To iterate over the
  143. * planes which *will* be attached (more useful in code called from
  144. * &drm_mode_config_funcs.atomic_check) see
  145. * drm_atomic_crtc_state_for_each_plane().
  146. */
  147. #define drm_atomic_crtc_for_each_plane(plane, crtc) \
  148. drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
  149. /**
  150. * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
  151. * @plane: the loop cursor
  152. * @crtc_state: the incoming CRTC state
  153. *
  154. * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
  155. * attached if the specified state is applied. Useful during for example
  156. * in code called from &drm_mode_config_funcs.atomic_check operations, to
  157. * validate the incoming state.
  158. */
  159. #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
  160. drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
  161. /**
  162. * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
  163. * @plane: the loop cursor
  164. * @plane_state: loop cursor for the plane's state, must be const
  165. * @crtc_state: the incoming CRTC state
  166. *
  167. * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
  168. * attached if the specified state is applied. Useful during for example
  169. * in code called from &drm_mode_config_funcs.atomic_check operations, to
  170. * validate the incoming state.
  171. *
  172. * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
  173. * const plane_state. This is useful when a driver just wants to peek at other
  174. * active planes on this CRTC, but does not need to change it.
  175. */
  176. #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
  177. drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
  178. for_each_if ((plane_state = \
  179. __drm_atomic_get_current_plane_state((crtc_state)->state, \
  180. plane)))
  181. /**
  182. * drm_atomic_plane_disabling - check whether a plane is being disabled
  183. * @old_plane_state: old atomic plane state
  184. * @new_plane_state: new atomic plane state
  185. *
  186. * Checks the atomic state of a plane to determine whether it's being disabled
  187. * or not. This also WARNs if it detects an invalid state (both CRTC and FB
  188. * need to either both be NULL or both be non-NULL).
  189. *
  190. * RETURNS:
  191. * True if the plane is being disabled, false otherwise.
  192. */
  193. static inline bool
  194. drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
  195. struct drm_plane_state *new_plane_state)
  196. {
  197. /*
  198. * When disabling a plane, CRTC and FB should always be NULL together.
  199. * Anything else should be considered a bug in the atomic core, so we
  200. * gently warn about it.
  201. */
  202. WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
  203. (new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
  204. return old_plane_state->crtc && !new_plane_state->crtc;
  205. }
  206. u32 *
  207. drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
  208. struct drm_bridge_state *bridge_state,
  209. struct drm_crtc_state *crtc_state,
  210. struct drm_connector_state *conn_state,
  211. u32 output_fmt,
  212. unsigned int *num_input_fmts);
  213. #endif /* DRM_ATOMIC_HELPER_H_ */