/include/drm/drm_crtc_helper.h

  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
 26/*
 27 * The DRM mode setting helper functions are common code for drivers to use if
 28 * they wish.  Drivers are not forced to use this code in their
 29 * implementations but it would be useful if they code they do use at least
 30 * provides a consistent interface and operation to userspace
 31 */
 32
 33#ifndef __DRM_CRTC_HELPER_H__
 34#define __DRM_CRTC_HELPER_H__
 35
 36#include <linux/spinlock.h>
 37#include <linux/types.h>
 38#include <linux/idr.h>
 39
 40#include <linux/fb.h>
 41
 42struct drm_crtc_helper_funcs {
 43	/*
 44	 * Control power levels on the CRTC.  If the mode passed in is
 45	 * unsupported, the provider must use the next lowest power level.
 46	 */
 47	void (*dpms)(struct drm_crtc *crtc, int mode);
 48	void (*prepare)(struct drm_crtc *crtc);
 49	void (*commit)(struct drm_crtc *crtc);
 50
 51	/* Provider can fixup or change mode timings before modeset occurs */
 52	bool (*mode_fixup)(struct drm_crtc *crtc,
 53			   struct drm_display_mode *mode,
 54			   struct drm_display_mode *adjusted_mode);
 55	/* Actually set the mode */
 56	int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
 57			struct drm_display_mode *adjusted_mode, int x, int y,
 58			struct drm_framebuffer *old_fb);
 59
 60	/* Move the crtc on the current fb to the given position *optional* */
 61	int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
 62			     struct drm_framebuffer *old_fb);
 63
 64	/* reload the current crtc LUT */
 65	void (*load_lut)(struct drm_crtc *crtc);
 66};
 67
 68struct drm_encoder_helper_funcs {
 69	void (*dpms)(struct drm_encoder *encoder, int mode);
 70	void (*save)(struct drm_encoder *encoder);
 71	void (*restore)(struct drm_encoder *encoder);
 72
 73	bool (*mode_fixup)(struct drm_encoder *encoder,
 74			   struct drm_display_mode *mode,
 75			   struct drm_display_mode *adjusted_mode);
 76	void (*prepare)(struct drm_encoder *encoder);
 77	void (*commit)(struct drm_encoder *encoder);
 78	void (*mode_set)(struct drm_encoder *encoder,
 79			 struct drm_display_mode *mode,
 80			 struct drm_display_mode *adjusted_mode);
 81	struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
 82	/* detect for DAC style encoders */
 83	enum drm_connector_status (*detect)(struct drm_encoder *encoder,
 84					    struct drm_connector *connector);
 85	/* disable encoder when not in use - more explicit than dpms off */
 86	void (*disable)(struct drm_encoder *encoder);
 87};
 88
 89struct drm_connector_helper_funcs {
 90	int (*get_modes)(struct drm_connector *connector);
 91	int (*mode_valid)(struct drm_connector *connector,
 92			  struct drm_display_mode *mode);
 93	struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
 94};
 95
 96extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
 97extern void drm_helper_disable_unused_functions(struct drm_device *dev);
 98extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
 99extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
100				     struct drm_display_mode *mode,
101				     int x, int y,
102				     struct drm_framebuffer *old_fb);
103extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
104extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
105
106extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
107
108extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
109					  struct drm_mode_fb_cmd *mode_cmd);
110
111static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
112				       const struct drm_crtc_helper_funcs *funcs)
113{
114	crtc->helper_private = (void *)funcs;
115}
116
117static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
118					  const struct drm_encoder_helper_funcs *funcs)
119{
120	encoder->helper_private = (void *)funcs;
121}
122
123static inline void drm_connector_helper_add(struct drm_connector *connector,
124					    const struct drm_connector_helper_funcs *funcs)
125{
126	connector->helper_private = (void *)funcs;
127}
128
129extern int drm_helper_resume_force_mode(struct drm_device *dev);
130extern void drm_kms_helper_poll_init(struct drm_device *dev);
131extern void drm_kms_helper_poll_fini(struct drm_device *dev);
132extern void drm_helper_hpd_irq_event(struct drm_device *dev);
133
134extern void drm_kms_helper_poll_disable(struct drm_device *dev);
135extern void drm_kms_helper_poll_enable(struct drm_device *dev);
136#endif