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_encoder.h>
24 #include <drm/drm_mode_config.h>
25 #include <drm/drmP.h>
26 
27 #include "drm_crtc_internal.h"
28 #include "drm_internal.h"
29 
30 int drm_modeset_register_all(struct drm_device *dev)
31 {
32 	int ret;
33 
34 	ret = drm_plane_register_all(dev);
35 	if (ret)
36 		goto err_plane;
37 
38 	ret = drm_crtc_register_all(dev);
39 	if  (ret)
40 		goto err_crtc;
41 
42 	ret = drm_encoder_register_all(dev);
43 	if (ret)
44 		goto err_encoder;
45 
46 	ret = drm_connector_register_all(dev);
47 	if (ret)
48 		goto err_connector;
49 
50 	return 0;
51 
52 err_connector:
53 	drm_encoder_unregister_all(dev);
54 err_encoder:
55 	drm_crtc_unregister_all(dev);
56 err_crtc:
57 	drm_plane_unregister_all(dev);
58 err_plane:
59 	return ret;
60 }
61 
62 void drm_modeset_unregister_all(struct drm_device *dev)
63 {
64 	drm_connector_unregister_all(dev);
65 	drm_encoder_unregister_all(dev);
66 	drm_crtc_unregister_all(dev);
67 	drm_plane_unregister_all(dev);
68 }
69 
70 /**
71  * drm_mode_getresources - get graphics configuration
72  * @dev: drm device for the ioctl
73  * @data: data pointer for the ioctl
74  * @file_priv: drm file for the ioctl call
75  *
76  * Construct a set of configuration description structures and return
77  * them to the user, including CRTC, connector and framebuffer configuration.
78  *
79  * Called by the user via ioctl.
80  *
81  * Returns:
82  * Zero on success, negative errno on failure.
83  */
84 int drm_mode_getresources(struct drm_device *dev, void *data,
85 			  struct drm_file *file_priv)
86 {
87 	struct drm_mode_card_res *card_res = data;
88 	struct drm_framebuffer *fb;
89 	struct drm_connector *connector;
90 	struct drm_crtc *crtc;
91 	struct drm_encoder *encoder;
92 	int count, ret = 0;
93 	uint32_t __user *fb_id;
94 	uint32_t __user *crtc_id;
95 	uint32_t __user *connector_id;
96 	uint32_t __user *encoder_id;
97 	struct drm_connector_list_iter conn_iter;
98 
99 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
100 		return -EINVAL;
101 
102 
103 	mutex_lock(&file_priv->fbs_lock);
104 	count = 0;
105 	fb_id = u64_to_user_ptr(card_res->fb_id_ptr);
106 	list_for_each_entry(fb, &file_priv->fbs, filp_head) {
107 		if (count < card_res->count_fbs &&
108 		    put_user(fb->base.id, fb_id + count)) {
109 			mutex_unlock(&file_priv->fbs_lock);
110 			return -EFAULT;
111 		}
112 		count++;
113 	}
114 	card_res->count_fbs = count;
115 	mutex_unlock(&file_priv->fbs_lock);
116 
117 	card_res->max_height = dev->mode_config.max_height;
118 	card_res->min_height = dev->mode_config.min_height;
119 	card_res->max_width = dev->mode_config.max_width;
120 	card_res->min_width = dev->mode_config.min_width;
121 
122 	count = 0;
123 	crtc_id = u64_to_user_ptr(card_res->crtc_id_ptr);
124 	drm_for_each_crtc(crtc, dev) {
125 		if (count < card_res->count_crtcs &&
126 		    put_user(crtc->base.id, crtc_id + count))
127 			return -EFAULT;
128 		count++;
129 	}
130 	card_res->count_crtcs = count;
131 
132 	count = 0;
133 	encoder_id = u64_to_user_ptr(card_res->encoder_id_ptr);
134 	drm_for_each_encoder(encoder, dev) {
135 		if (count < card_res->count_encoders &&
136 		    put_user(encoder->base.id, encoder_id + count))
137 			return -EFAULT;
138 		count++;
139 	}
140 	card_res->count_encoders = count;
141 
142 	drm_connector_list_iter_begin(dev, &conn_iter);
143 	count = 0;
144 	connector_id = u64_to_user_ptr(card_res->connector_id_ptr);
145 	drm_for_each_connector_iter(connector, &conn_iter) {
146 		if (count < card_res->count_connectors &&
147 		    put_user(connector->base.id, connector_id + count)) {
148 			drm_connector_list_iter_end(&conn_iter);
149 			return -EFAULT;
150 		}
151 		count++;
152 	}
153 	card_res->count_connectors = count;
154 	drm_connector_list_iter_end(&conn_iter);
155 
156 	return ret;
157 }
158 
159 /**
160  * drm_mode_config_reset - call ->reset callbacks
161  * @dev: drm device
162  *
163  * This functions calls all the crtc's, encoder's and connector's ->reset
164  * callback. Drivers can use this in e.g. their driver load or resume code to
165  * reset hardware and software state.
166  */
167 void drm_mode_config_reset(struct drm_device *dev)
168 {
169 	struct drm_crtc *crtc;
170 	struct drm_plane *plane;
171 	struct drm_encoder *encoder;
172 	struct drm_connector *connector;
173 	struct drm_connector_list_iter conn_iter;
174 
175 	drm_for_each_plane(plane, dev)
176 		if (plane->funcs->reset)
177 			plane->funcs->reset(plane);
178 
179 	drm_for_each_crtc(crtc, dev)
180 		if (crtc->funcs->reset)
181 			crtc->funcs->reset(crtc);
182 
183 	drm_for_each_encoder(encoder, dev)
184 		if (encoder->funcs->reset)
185 			encoder->funcs->reset(encoder);
186 
187 	drm_connector_list_iter_begin(dev, &conn_iter);
188 	drm_for_each_connector_iter(connector, &conn_iter)
189 		if (connector->funcs->reset)
190 			connector->funcs->reset(connector);
191 	drm_connector_list_iter_end(&conn_iter);
192 }
193 EXPORT_SYMBOL(drm_mode_config_reset);
194 
195 /*
196  * Global properties
197  */
198 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
199 	{ DRM_PLANE_TYPE_OVERLAY, "Overlay" },
200 	{ DRM_PLANE_TYPE_PRIMARY, "Primary" },
201 	{ DRM_PLANE_TYPE_CURSOR, "Cursor" },
202 };
203 
204 static int drm_mode_create_standard_properties(struct drm_device *dev)
205 {
206 	struct drm_property *prop;
207 	int ret;
208 
209 	ret = drm_connector_create_standard_properties(dev);
210 	if (ret)
211 		return ret;
212 
213 	prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
214 					"type", drm_plane_type_enum_list,
215 					ARRAY_SIZE(drm_plane_type_enum_list));
216 	if (!prop)
217 		return -ENOMEM;
218 	dev->mode_config.plane_type_property = prop;
219 
220 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
221 			"SRC_X", 0, UINT_MAX);
222 	if (!prop)
223 		return -ENOMEM;
224 	dev->mode_config.prop_src_x = prop;
225 
226 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
227 			"SRC_Y", 0, UINT_MAX);
228 	if (!prop)
229 		return -ENOMEM;
230 	dev->mode_config.prop_src_y = prop;
231 
232 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
233 			"SRC_W", 0, UINT_MAX);
234 	if (!prop)
235 		return -ENOMEM;
236 	dev->mode_config.prop_src_w = prop;
237 
238 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
239 			"SRC_H", 0, UINT_MAX);
240 	if (!prop)
241 		return -ENOMEM;
242 	dev->mode_config.prop_src_h = prop;
243 
244 	prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
245 			"CRTC_X", INT_MIN, INT_MAX);
246 	if (!prop)
247 		return -ENOMEM;
248 	dev->mode_config.prop_crtc_x = prop;
249 
250 	prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
251 			"CRTC_Y", INT_MIN, INT_MAX);
252 	if (!prop)
253 		return -ENOMEM;
254 	dev->mode_config.prop_crtc_y = prop;
255 
256 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
257 			"CRTC_W", 0, INT_MAX);
258 	if (!prop)
259 		return -ENOMEM;
260 	dev->mode_config.prop_crtc_w = prop;
261 
262 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
263 			"CRTC_H", 0, INT_MAX);
264 	if (!prop)
265 		return -ENOMEM;
266 	dev->mode_config.prop_crtc_h = prop;
267 
268 	prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
269 			"FB_ID", DRM_MODE_OBJECT_FB);
270 	if (!prop)
271 		return -ENOMEM;
272 	dev->mode_config.prop_fb_id = prop;
273 
274 	prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
275 			"IN_FENCE_FD", -1, INT_MAX);
276 	if (!prop)
277 		return -ENOMEM;
278 	dev->mode_config.prop_in_fence_fd = prop;
279 
280 	prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
281 			"OUT_FENCE_PTR", 0, U64_MAX);
282 	if (!prop)
283 		return -ENOMEM;
284 	dev->mode_config.prop_out_fence_ptr = prop;
285 
286 	prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
287 			"CRTC_ID", DRM_MODE_OBJECT_CRTC);
288 	if (!prop)
289 		return -ENOMEM;
290 	dev->mode_config.prop_crtc_id = prop;
291 
292 	prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
293 			"ACTIVE");
294 	if (!prop)
295 		return -ENOMEM;
296 	dev->mode_config.prop_active = prop;
297 
298 	prop = drm_property_create(dev,
299 			DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
300 			"MODE_ID", 0);
301 	if (!prop)
302 		return -ENOMEM;
303 	dev->mode_config.prop_mode_id = prop;
304 
305 	prop = drm_property_create(dev,
306 			DRM_MODE_PROP_BLOB,
307 			"DEGAMMA_LUT", 0);
308 	if (!prop)
309 		return -ENOMEM;
310 	dev->mode_config.degamma_lut_property = prop;
311 
312 	prop = drm_property_create_range(dev,
313 			DRM_MODE_PROP_IMMUTABLE,
314 			"DEGAMMA_LUT_SIZE", 0, UINT_MAX);
315 	if (!prop)
316 		return -ENOMEM;
317 	dev->mode_config.degamma_lut_size_property = prop;
318 
319 	prop = drm_property_create(dev,
320 			DRM_MODE_PROP_BLOB,
321 			"CTM", 0);
322 	if (!prop)
323 		return -ENOMEM;
324 	dev->mode_config.ctm_property = prop;
325 
326 	prop = drm_property_create(dev,
327 			DRM_MODE_PROP_BLOB,
328 			"GAMMA_LUT", 0);
329 	if (!prop)
330 		return -ENOMEM;
331 	dev->mode_config.gamma_lut_property = prop;
332 
333 	prop = drm_property_create_range(dev,
334 			DRM_MODE_PROP_IMMUTABLE,
335 			"GAMMA_LUT_SIZE", 0, UINT_MAX);
336 	if (!prop)
337 		return -ENOMEM;
338 	dev->mode_config.gamma_lut_size_property = prop;
339 
340 	prop = drm_property_create(dev,
341 				   DRM_MODE_PROP_IMMUTABLE | DRM_MODE_PROP_BLOB,
342 				   "IN_FORMATS", 0);
343 	if (!prop)
344 		return -ENOMEM;
345 	dev->mode_config.modifiers_property = prop;
346 
347 	return 0;
348 }
349 
350 /**
351  * drm_mode_config_init - initialize DRM mode_configuration structure
352  * @dev: DRM device
353  *
354  * Initialize @dev's mode_config structure, used for tracking the graphics
355  * configuration of @dev.
356  *
357  * Since this initializes the modeset locks, no locking is possible. Which is no
358  * problem, since this should happen single threaded at init time. It is the
359  * driver's problem to ensure this guarantee.
360  *
361  */
362 void drm_mode_config_init(struct drm_device *dev)
363 {
364 	mutex_init(&dev->mode_config.mutex);
365 	drm_modeset_lock_init(&dev->mode_config.connection_mutex);
366 	mutex_init(&dev->mode_config.idr_mutex);
367 	mutex_init(&dev->mode_config.fb_lock);
368 	mutex_init(&dev->mode_config.blob_lock);
369 	INIT_LIST_HEAD(&dev->mode_config.fb_list);
370 	INIT_LIST_HEAD(&dev->mode_config.crtc_list);
371 	INIT_LIST_HEAD(&dev->mode_config.connector_list);
372 	INIT_LIST_HEAD(&dev->mode_config.encoder_list);
373 	INIT_LIST_HEAD(&dev->mode_config.property_list);
374 	INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
375 	INIT_LIST_HEAD(&dev->mode_config.plane_list);
376 	idr_init(&dev->mode_config.crtc_idr);
377 	idr_init(&dev->mode_config.tile_idr);
378 	ida_init(&dev->mode_config.connector_ida);
379 	spin_lock_init(&dev->mode_config.connector_list_lock);
380 
381 	drm_mode_create_standard_properties(dev);
382 
383 	/* Just to be sure */
384 	dev->mode_config.num_fb = 0;
385 	dev->mode_config.num_connector = 0;
386 	dev->mode_config.num_crtc = 0;
387 	dev->mode_config.num_encoder = 0;
388 	dev->mode_config.num_overlay_plane = 0;
389 	dev->mode_config.num_total_plane = 0;
390 }
391 EXPORT_SYMBOL(drm_mode_config_init);
392 
393 /**
394  * drm_mode_config_cleanup - free up DRM mode_config info
395  * @dev: DRM device
396  *
397  * Free up all the connectors and CRTCs associated with this DRM device, then
398  * free up the framebuffers and associated buffer objects.
399  *
400  * Note that since this /should/ happen single-threaded at driver/device
401  * teardown time, no locking is required. It's the driver's job to ensure that
402  * this guarantee actually holds true.
403  *
404  * FIXME: cleanup any dangling user buffer objects too
405  */
406 void drm_mode_config_cleanup(struct drm_device *dev)
407 {
408 	struct drm_connector *connector;
409 	struct drm_connector_list_iter conn_iter;
410 	struct drm_crtc *crtc, *ct;
411 	struct drm_encoder *encoder, *enct;
412 	struct drm_framebuffer *fb, *fbt;
413 	struct drm_property *property, *pt;
414 	struct drm_property_blob *blob, *bt;
415 	struct drm_plane *plane, *plt;
416 
417 	list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
418 				 head) {
419 		encoder->funcs->destroy(encoder);
420 	}
421 
422 	drm_connector_list_iter_begin(dev, &conn_iter);
423 	drm_for_each_connector_iter(connector, &conn_iter) {
424 		/* drm_connector_list_iter holds an full reference to the
425 		 * current connector itself, which means it is inherently safe
426 		 * against unreferencing the current connector - but not against
427 		 * deleting it right away. */
428 		drm_connector_put(connector);
429 	}
430 	drm_connector_list_iter_end(&conn_iter);
431 	if (WARN_ON(!list_empty(&dev->mode_config.connector_list))) {
432 		drm_connector_list_iter_begin(dev, &conn_iter);
433 		drm_for_each_connector_iter(connector, &conn_iter)
434 			DRM_ERROR("connector %s leaked!\n", connector->name);
435 		drm_connector_list_iter_end(&conn_iter);
436 	}
437 
438 	list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
439 				 head) {
440 		drm_property_destroy(dev, property);
441 	}
442 
443 	list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
444 				 head) {
445 		plane->funcs->destroy(plane);
446 	}
447 
448 	list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
449 		crtc->funcs->destroy(crtc);
450 	}
451 
452 	list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
453 				 head_global) {
454 		drm_property_blob_put(blob);
455 	}
456 
457 	/*
458 	 * Single-threaded teardown context, so it's not required to grab the
459 	 * fb_lock to protect against concurrent fb_list access. Contrary, it
460 	 * would actually deadlock with the drm_framebuffer_cleanup function.
461 	 *
462 	 * Also, if there are any framebuffers left, that's a driver leak now,
463 	 * so politely WARN about this.
464 	 */
465 	WARN_ON(!list_empty(&dev->mode_config.fb_list));
466 	list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
467 		drm_framebuffer_free(&fb->base.refcount);
468 	}
469 
470 	ida_destroy(&dev->mode_config.connector_ida);
471 	idr_destroy(&dev->mode_config.tile_idr);
472 	idr_destroy(&dev->mode_config.crtc_idr);
473 	drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
474 }
475 EXPORT_SYMBOL(drm_mode_config_cleanup);
476