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
 23#include <drm/drm_atomic_helper.h>
 24#include <drm/drm_crtc_helper.h>
 25#include <drm/drm_fb_helper.h>
 26#include <drm/drm_modeset_helper.h>
 27#include <drm/drm_plane_helper.h>
 28
 29/**
 30 * DOC: aux kms helpers
 31 *
 32 * This helper library contains various one-off functions which don't really fit
 33 * anywhere else in the DRM modeset helper library.
 34 */
 35
 36/**
 37 * drm_helper_move_panel_connectors_to_head() - move panels to the front in the
 38 * 						connector list
 39 * @dev: drm device to operate on
 40 *
 41 * Some userspace presumes that the first connected connector is the main
 42 * display, where it's supposed to display e.g. the login screen. For
 43 * laptops, this should be the main panel. Use this function to sort all
 44 * (eDP/LVDS/DSI) panels to the front of the connector list, instead of
 45 * painstakingly trying to initialize them in the right order.
 46 */
 47void drm_helper_move_panel_connectors_to_head(struct drm_device *dev)
 48{
 49	struct drm_connector *connector, *tmp;
 50	struct list_head panel_list;
 51
 52	INIT_LIST_HEAD(&panel_list);
 53
 54	spin_lock_irq(&dev->mode_config.connector_list_lock);
 55	list_for_each_entry_safe(connector, tmp,
 56				 &dev->mode_config.connector_list, head) {
 57		if (connector->connector_type == DRM_MODE_CONNECTOR_LVDS ||
 58		    connector->connector_type == DRM_MODE_CONNECTOR_eDP ||
 59		    connector->connector_type == DRM_MODE_CONNECTOR_DSI)
 60			list_move_tail(&connector->head, &panel_list);
 61	}
 62
 63	list_splice(&panel_list, &dev->mode_config.connector_list);
 64	spin_unlock_irq(&dev->mode_config.connector_list_lock);
 65}
 66EXPORT_SYMBOL(drm_helper_move_panel_connectors_to_head);
 67
 68/**
 69 * drm_helper_mode_fill_fb_struct - fill out framebuffer metadata
 70 * @dev: DRM device
 71 * @fb: drm_framebuffer object to fill out
 72 * @mode_cmd: metadata from the userspace fb creation request
 73 *
 74 * This helper can be used in a drivers fb_create callback to pre-fill the fb's
 75 * metadata fields.
 76 */
 77void drm_helper_mode_fill_fb_struct(struct drm_device *dev,
 78				    struct drm_framebuffer *fb,
 79				    const struct drm_mode_fb_cmd2 *mode_cmd)
 80{
 81	int i;
 82
 83	fb->dev = dev;
 84	fb->format = drm_get_format_info(dev, mode_cmd);
 85	fb->width = mode_cmd->width;
 86	fb->height = mode_cmd->height;
 87	for (i = 0; i < 4; i++) {
 88		fb->pitches[i] = mode_cmd->pitches[i];
 89		fb->offsets[i] = mode_cmd->offsets[i];
 90	}
 91	fb->modifier = mode_cmd->modifier[0];
 92	fb->flags = mode_cmd->flags;
 93}
 94EXPORT_SYMBOL(drm_helper_mode_fill_fb_struct);
 95
 96/*
 97 * This is the minimal list of formats that seem to be safe for modeset use
 98 * with all current DRM drivers.  Most hardware can actually support more
 99 * formats than this and drivers may specify a more accurate list when
100 * creating the primary plane.  However drivers that still call
101 * drm_plane_init() will use this minimal format list as the default.
102 */
103static const uint32_t safe_modeset_formats[] = {
104	DRM_FORMAT_XRGB8888,
105	DRM_FORMAT_ARGB8888,
106};
107
108static struct drm_plane *create_primary_plane(struct drm_device *dev)
109{
110	struct drm_plane *primary;
111	int ret;
112
113	primary = kzalloc(sizeof(*primary), GFP_KERNEL);
114	if (primary == NULL) {
115		DRM_DEBUG_KMS("Failed to allocate primary plane\n");
116		return NULL;
117	}
118
119	/*
120	 * Remove the format_default field from drm_plane when dropping
121	 * this helper.
122	 */
123	primary->format_default = true;
124
125	/* possible_crtc's will be filled in later by crtc_init */
126	ret = drm_universal_plane_init(dev, primary, 0,
127				       &drm_primary_helper_funcs,
128				       safe_modeset_formats,
129				       ARRAY_SIZE(safe_modeset_formats),
130				       NULL,
131				       DRM_PLANE_TYPE_PRIMARY, NULL);
132	if (ret) {
133		kfree(primary);
134		primary = NULL;
135	}
136
137	return primary;
138}
139
140/**
141 * drm_crtc_init - Legacy CRTC initialization function
142 * @dev: DRM device
143 * @crtc: CRTC object to init
144 * @funcs: callbacks for the new CRTC
145 *
146 * Initialize a CRTC object with a default helper-provided primary plane and no
147 * cursor plane.
148 *
149 * Returns:
150 * Zero on success, error code on failure.
151 */
152int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
153		  const struct drm_crtc_funcs *funcs)
154{
155	struct drm_plane *primary;
156
157	primary = create_primary_plane(dev);
158	return drm_crtc_init_with_planes(dev, crtc, primary, NULL, funcs,
159					 NULL);
160}
161EXPORT_SYMBOL(drm_crtc_init);
162
163/**
164 * drm_mode_config_helper_suspend - Modeset suspend helper
165 * @dev: DRM device
166 *
167 * This helper function takes care of suspending the modeset side. It disables
168 * output polling if initialized, suspends fbdev if used and finally calls
169 * drm_atomic_helper_suspend().
170 * If suspending fails, fbdev and polling is re-enabled.
171 *
172 * Returns:
173 * Zero on success, negative error code on error.
174 *
175 * See also:
176 * drm_kms_helper_poll_disable() and drm_fb_helper_set_suspend_unlocked().
177 */
178int drm_mode_config_helper_suspend(struct drm_device *dev)
179{
180	struct drm_atomic_state *state;
181
182	if (!dev)
183		return 0;
184
185	drm_kms_helper_poll_disable(dev);
186	drm_fb_helper_set_suspend_unlocked(dev->fb_helper, 1);
187	state = drm_atomic_helper_suspend(dev);
188	if (IS_ERR(state)) {
189		drm_fb_helper_set_suspend_unlocked(dev->fb_helper, 0);
190		drm_kms_helper_poll_enable(dev);
191		return PTR_ERR(state);
192	}
193
194	dev->mode_config.suspend_state = state;
195
196	return 0;
197}
198EXPORT_SYMBOL(drm_mode_config_helper_suspend);
199
200/**
201 * drm_mode_config_helper_resume - Modeset resume helper
202 * @dev: DRM device
203 *
204 * This helper function takes care of resuming the modeset side. It calls
205 * drm_atomic_helper_resume(), resumes fbdev if used and enables output polling
206 * if initiaized.
207 *
208 * Returns:
209 * Zero on success, negative error code on error.
210 *
211 * See also:
212 * drm_fb_helper_set_suspend_unlocked() and drm_kms_helper_poll_enable().
213 */
214int drm_mode_config_helper_resume(struct drm_device *dev)
215{
216	int ret;
217
218	if (!dev)
219		return 0;
220
221	if (WARN_ON(!dev->mode_config.suspend_state))
222		return -EINVAL;
223
224	ret = drm_atomic_helper_resume(dev, dev->mode_config.suspend_state);
225	if (ret)
226		DRM_ERROR("Failed to resume (%d)\n", ret);
227	dev->mode_config.suspend_state = NULL;
228
229	drm_fb_helper_set_suspend_unlocked(dev->fb_helper, 0);
230	drm_kms_helper_poll_enable(dev);
231
232	return ret;
233}
234EXPORT_SYMBOL(drm_mode_config_helper_resume);