drm_encoder.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. /*
  2. * Copyright (c) 2016 Intel Corporation
  3. *
  4. * Permission to use, copy, modify, distribute, and sell this software and its
  5. * documentation for any purpose is hereby granted without fee, provided that
  6. * the above copyright notice appear in all copies and that both that copyright
  7. * notice and this permission notice appear in supporting documentation, and
  8. * that the name of the copyright holders not be used in advertising or
  9. * publicity pertaining to distribution of the software without specific,
  10. * written prior permission. The copyright holders make no representations
  11. * about the suitability of this software for any purpose. It is provided "as
  12. * is" without express or implied warranty.
  13. *
  14. * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15. * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16. * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17. * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18. * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19. * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20. * OF THIS SOFTWARE.
  21. */
  22. #ifndef __DRM_ENCODER_H__
  23. #define __DRM_ENCODER_H__
  24. #include <linux/list.h>
  25. #include <linux/ctype.h>
  26. #include <drm/drm_crtc.h>
  27. #include <drm/drm_mode.h>
  28. #include <drm/drm_mode_object.h>
  29. #include <drm/drm_util.h>
  30. struct drm_encoder;
  31. /**
  32. * struct drm_encoder_funcs - encoder controls
  33. *
  34. * Encoders sit between CRTCs and connectors.
  35. */
  36. struct drm_encoder_funcs {
  37. /**
  38. * @reset:
  39. *
  40. * Reset encoder hardware and software state to off. This function isn't
  41. * called by the core directly, only through drm_mode_config_reset().
  42. * It's not a helper hook only for historical reasons.
  43. */
  44. void (*reset)(struct drm_encoder *encoder);
  45. /**
  46. * @destroy:
  47. *
  48. * Clean up encoder resources. This is only called at driver unload time
  49. * through drm_mode_config_cleanup() since an encoder cannot be
  50. * hotplugged in DRM.
  51. */
  52. void (*destroy)(struct drm_encoder *encoder);
  53. /**
  54. * @late_register:
  55. *
  56. * This optional hook can be used to register additional userspace
  57. * interfaces attached to the encoder like debugfs interfaces.
  58. * It is called late in the driver load sequence from drm_dev_register().
  59. * Everything added from this callback should be unregistered in
  60. * the early_unregister callback.
  61. *
  62. * Returns:
  63. *
  64. * 0 on success, or a negative error code on failure.
  65. */
  66. int (*late_register)(struct drm_encoder *encoder);
  67. /**
  68. * @early_unregister:
  69. *
  70. * This optional hook should be used to unregister the additional
  71. * userspace interfaces attached to the encoder from
  72. * @late_register. It is called from drm_dev_unregister(),
  73. * early in the driver unload sequence to disable userspace access
  74. * before data structures are torndown.
  75. */
  76. void (*early_unregister)(struct drm_encoder *encoder);
  77. };
  78. /**
  79. * struct drm_encoder - central DRM encoder structure
  80. * @dev: parent DRM device
  81. * @head: list management
  82. * @base: base KMS object
  83. * @name: human readable name, can be overwritten by the driver
  84. * @funcs: control functions, can be NULL for simple managed encoders
  85. * @helper_private: mid-layer private data
  86. *
  87. * CRTCs drive pixels to encoders, which convert them into signals
  88. * appropriate for a given connector or set of connectors.
  89. */
  90. struct drm_encoder {
  91. struct drm_device *dev;
  92. struct list_head head;
  93. struct drm_mode_object base;
  94. char *name;
  95. /**
  96. * @encoder_type:
  97. *
  98. * One of the DRM_MODE_ENCODER_<foo> types in drm_mode.h. The following
  99. * encoder types are defined thus far:
  100. *
  101. * - DRM_MODE_ENCODER_DAC for VGA and analog on DVI-I/DVI-A.
  102. *
  103. * - DRM_MODE_ENCODER_TMDS for DVI, HDMI and (embedded) DisplayPort.
  104. *
  105. * - DRM_MODE_ENCODER_LVDS for display panels, or in general any panel
  106. * with a proprietary parallel connector.
  107. *
  108. * - DRM_MODE_ENCODER_TVDAC for TV output (Composite, S-Video,
  109. * Component, SCART).
  110. *
  111. * - DRM_MODE_ENCODER_VIRTUAL for virtual machine displays
  112. *
  113. * - DRM_MODE_ENCODER_DSI for panels connected using the DSI serial bus.
  114. *
  115. * - DRM_MODE_ENCODER_DPI for panels connected using the DPI parallel
  116. * bus.
  117. *
  118. * - DRM_MODE_ENCODER_DPMST for special fake encoders used to allow
  119. * mutliple DP MST streams to share one physical encoder.
  120. */
  121. int encoder_type;
  122. /**
  123. * @index: Position inside the mode_config.list, can be used as an array
  124. * index. It is invariant over the lifetime of the encoder.
  125. */
  126. unsigned index;
  127. /**
  128. * @possible_crtcs: Bitmask of potential CRTC bindings, using
  129. * drm_crtc_index() as the index into the bitfield. The driver must set
  130. * the bits for all &drm_crtc objects this encoder can be connected to
  131. * before calling drm_dev_register().
  132. *
  133. * You will get a WARN if you get this wrong in the driver.
  134. *
  135. * Note that since CRTC objects can't be hotplugged the assigned indices
  136. * are stable and hence known before registering all objects.
  137. */
  138. uint32_t possible_crtcs;
  139. /**
  140. * @possible_clones: Bitmask of potential sibling encoders for cloning,
  141. * using drm_encoder_index() as the index into the bitfield. The driver
  142. * must set the bits for all &drm_encoder objects which can clone a
  143. * &drm_crtc together with this encoder before calling
  144. * drm_dev_register(). Drivers should set the bit representing the
  145. * encoder itself, too. Cloning bits should be set such that when two
  146. * encoders can be used in a cloned configuration, they both should have
  147. * each another bits set.
  148. *
  149. * As an exception to the above rule if the driver doesn't implement
  150. * any cloning it can leave @possible_clones set to 0. The core will
  151. * automagically fix this up by setting the bit for the encoder itself.
  152. *
  153. * You will get a WARN if you get this wrong in the driver.
  154. *
  155. * Note that since encoder objects can't be hotplugged the assigned indices
  156. * are stable and hence known before registering all objects.
  157. */
  158. uint32_t possible_clones;
  159. /**
  160. * @crtc: Currently bound CRTC, only really meaningful for non-atomic
  161. * drivers. Atomic drivers should instead check
  162. * &drm_connector_state.crtc.
  163. */
  164. struct drm_crtc *crtc;
  165. /**
  166. * @bridge_chain: Bridges attached to this encoder. Drivers shall not
  167. * access this field directly.
  168. */
  169. struct list_head bridge_chain;
  170. const struct drm_encoder_funcs *funcs;
  171. const struct drm_encoder_helper_funcs *helper_private;
  172. };
  173. #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
  174. __printf(5, 6)
  175. int drm_encoder_init(struct drm_device *dev,
  176. struct drm_encoder *encoder,
  177. const struct drm_encoder_funcs *funcs,
  178. int encoder_type, const char *name, ...);
  179. __printf(5, 6)
  180. int drmm_encoder_init(struct drm_device *dev,
  181. struct drm_encoder *encoder,
  182. const struct drm_encoder_funcs *funcs,
  183. int encoder_type, const char *name, ...);
  184. __printf(6, 7)
  185. void *__drmm_encoder_alloc(struct drm_device *dev,
  186. size_t size, size_t offset,
  187. const struct drm_encoder_funcs *funcs,
  188. int encoder_type,
  189. const char *name, ...);
  190. /**
  191. * drmm_encoder_alloc - Allocate and initialize an encoder
  192. * @dev: drm device
  193. * @type: the type of the struct which contains struct &drm_encoder
  194. * @member: the name of the &drm_encoder within @type
  195. * @funcs: callbacks for this encoder (optional)
  196. * @encoder_type: user visible type of the encoder
  197. * @name: printf style format string for the encoder name, or NULL for default name
  198. *
  199. * Allocates and initializes an encoder. Encoder should be subclassed as part of
  200. * driver encoder objects. Cleanup is automatically handled through registering
  201. * drm_encoder_cleanup() with drmm_add_action().
  202. *
  203. * The @drm_encoder_funcs.destroy hook must be NULL.
  204. *
  205. * Returns:
  206. * Pointer to new encoder, or ERR_PTR on failure.
  207. */
  208. #define drmm_encoder_alloc(dev, type, member, funcs, encoder_type, name, ...) \
  209. ((type *)__drmm_encoder_alloc(dev, sizeof(type), \
  210. offsetof(type, member), funcs, \
  211. encoder_type, name, ##__VA_ARGS__))
  212. /**
  213. * drmm_plain_encoder_alloc - Allocate and initialize an encoder
  214. * @dev: drm device
  215. * @funcs: callbacks for this encoder (optional)
  216. * @encoder_type: user visible type of the encoder
  217. * @name: printf style format string for the encoder name, or NULL for default name
  218. *
  219. * This is a simplified version of drmm_encoder_alloc(), which only allocates
  220. * and returns a struct drm_encoder instance, with no subclassing.
  221. *
  222. * Returns:
  223. * Pointer to the new drm_encoder struct, or ERR_PTR on failure.
  224. */
  225. #define drmm_plain_encoder_alloc(dev, funcs, encoder_type, name, ...) \
  226. ((struct drm_encoder *) \
  227. __drmm_encoder_alloc(dev, sizeof(struct drm_encoder), \
  228. 0, funcs, encoder_type, name, ##__VA_ARGS__))
  229. /**
  230. * drm_encoder_index - find the index of a registered encoder
  231. * @encoder: encoder to find index for
  232. *
  233. * Given a registered encoder, return the index of that encoder within a DRM
  234. * device's list of encoders.
  235. */
  236. static inline unsigned int drm_encoder_index(const struct drm_encoder *encoder)
  237. {
  238. return encoder->index;
  239. }
  240. /**
  241. * drm_encoder_mask - find the mask of a registered encoder
  242. * @encoder: encoder to find mask for
  243. *
  244. * Given a registered encoder, return the mask bit of that encoder for an
  245. * encoder's possible_clones field.
  246. */
  247. static inline u32 drm_encoder_mask(const struct drm_encoder *encoder)
  248. {
  249. return 1 << drm_encoder_index(encoder);
  250. }
  251. /**
  252. * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
  253. * @encoder: encoder to test
  254. * @crtc: crtc to test
  255. *
  256. * Returns false if @encoder can't be driven by @crtc, true otherwise.
  257. */
  258. static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
  259. struct drm_crtc *crtc)
  260. {
  261. return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
  262. }
  263. /**
  264. * drm_encoder_find - find a &drm_encoder
  265. * @dev: DRM device
  266. * @file_priv: drm file to check for lease against.
  267. * @id: encoder id
  268. *
  269. * Returns the encoder with @id, NULL if it doesn't exist. Simple wrapper around
  270. * drm_mode_object_find().
  271. */
  272. static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
  273. struct drm_file *file_priv,
  274. uint32_t id)
  275. {
  276. struct drm_mode_object *mo;
  277. mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_ENCODER);
  278. return mo ? obj_to_encoder(mo) : NULL;
  279. }
  280. void drm_encoder_cleanup(struct drm_encoder *encoder);
  281. /**
  282. * drm_for_each_encoder_mask - iterate over encoders specified by bitmask
  283. * @encoder: the loop cursor
  284. * @dev: the DRM device
  285. * @encoder_mask: bitmask of encoder indices
  286. *
  287. * Iterate over all encoders specified by bitmask.
  288. */
  289. #define drm_for_each_encoder_mask(encoder, dev, encoder_mask) \
  290. list_for_each_entry((encoder), &(dev)->mode_config.encoder_list, head) \
  291. for_each_if ((encoder_mask) & drm_encoder_mask(encoder))
  292. /**
  293. * drm_for_each_encoder - iterate over all encoders
  294. * @encoder: the loop cursor
  295. * @dev: the DRM device
  296. *
  297. * Iterate over all encoders of @dev.
  298. */
  299. #define drm_for_each_encoder(encoder, dev) \
  300. list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
  301. #endif