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