Merge tag 'rust-fixes-6.3-rc1' of https://github.com/Rust-for-Linux/linux
[linux-2.6-microblaze.git] / drivers / gpu / drm / drm_probe_helper.c
1 /*
2  * Copyright (c) 2006-2008 Intel Corporation
3  * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4  *
5  * DRM core CRTC related functions
6  *
7  * Permission to use, copy, modify, distribute, and sell this software and its
8  * documentation for any purpose is hereby granted without fee, provided that
9  * the above copyright notice appear in all copies and that both that copyright
10  * notice and this permission notice appear in supporting documentation, and
11  * that the name of the copyright holders not be used in advertising or
12  * publicity pertaining to distribution of the software without specific,
13  * written prior permission.  The copyright holders make no representations
14  * about the suitability of this software for any purpose.  It is provided "as
15  * is" without express or implied warranty.
16  *
17  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
18  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
19  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
20  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
22  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
23  * OF THIS SOFTWARE.
24  *
25  * Authors:
26  *      Keith Packard
27  *      Eric Anholt <eric@anholt.net>
28  *      Dave Airlie <airlied@linux.ie>
29  *      Jesse Barnes <jesse.barnes@intel.com>
30  */
31
32 #include <linux/export.h>
33 #include <linux/moduleparam.h>
34
35 #include <drm/drm_bridge.h>
36 #include <drm/drm_client.h>
37 #include <drm/drm_crtc.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_modeset_helper_vtables.h>
41 #include <drm/drm_print.h>
42 #include <drm/drm_probe_helper.h>
43 #include <drm/drm_sysfs.h>
44
45 #include "drm_crtc_helper_internal.h"
46
47 /**
48  * DOC: output probing helper overview
49  *
50  * This library provides some helper code for output probing. It provides an
51  * implementation of the core &drm_connector_funcs.fill_modes interface with
52  * drm_helper_probe_single_connector_modes().
53  *
54  * It also provides support for polling connectors with a work item and for
55  * generic hotplug interrupt handling where the driver doesn't or cannot keep
56  * track of a per-connector hpd interrupt.
57  *
58  * This helper library can be used independently of the modeset helper library.
59  * Drivers can also overwrite different parts e.g. use their own hotplug
60  * handling code to avoid probing unrelated outputs.
61  *
62  * The probe helpers share the function table structures with other display
63  * helper libraries. See &struct drm_connector_helper_funcs for the details.
64  */
65
66 static bool drm_kms_helper_poll = true;
67 module_param_named(poll, drm_kms_helper_poll, bool, 0600);
68
69 static enum drm_mode_status
70 drm_mode_validate_flag(const struct drm_display_mode *mode,
71                        int flags)
72 {
73         if ((mode->flags & DRM_MODE_FLAG_INTERLACE) &&
74             !(flags & DRM_MODE_FLAG_INTERLACE))
75                 return MODE_NO_INTERLACE;
76
77         if ((mode->flags & DRM_MODE_FLAG_DBLSCAN) &&
78             !(flags & DRM_MODE_FLAG_DBLSCAN))
79                 return MODE_NO_DBLESCAN;
80
81         if ((mode->flags & DRM_MODE_FLAG_3D_MASK) &&
82             !(flags & DRM_MODE_FLAG_3D_MASK))
83                 return MODE_NO_STEREO;
84
85         return MODE_OK;
86 }
87
88 static int
89 drm_mode_validate_pipeline(struct drm_display_mode *mode,
90                            struct drm_connector *connector,
91                            struct drm_modeset_acquire_ctx *ctx,
92                            enum drm_mode_status *status)
93 {
94         struct drm_device *dev = connector->dev;
95         struct drm_encoder *encoder;
96         int ret;
97
98         /* Step 1: Validate against connector */
99         ret = drm_connector_mode_valid(connector, mode, ctx, status);
100         if (ret || *status != MODE_OK)
101                 return ret;
102
103         /* Step 2: Validate against encoders and crtcs */
104         drm_connector_for_each_possible_encoder(connector, encoder) {
105                 struct drm_bridge *bridge;
106                 struct drm_crtc *crtc;
107
108                 *status = drm_encoder_mode_valid(encoder, mode);
109                 if (*status != MODE_OK) {
110                         /* No point in continuing for crtc check as this encoder
111                          * will not accept the mode anyway. If all encoders
112                          * reject the mode then, at exit, ret will not be
113                          * MODE_OK. */
114                         continue;
115                 }
116
117                 bridge = drm_bridge_chain_get_first_bridge(encoder);
118                 *status = drm_bridge_chain_mode_valid(bridge,
119                                                       &connector->display_info,
120                                                       mode);
121                 if (*status != MODE_OK) {
122                         /* There is also no point in continuing for crtc check
123                          * here. */
124                         continue;
125                 }
126
127                 drm_for_each_crtc(crtc, dev) {
128                         if (!drm_encoder_crtc_ok(encoder, crtc))
129                                 continue;
130
131                         *status = drm_crtc_mode_valid(crtc, mode);
132                         if (*status == MODE_OK) {
133                                 /* If we get to this point there is at least
134                                  * one combination of encoder+crtc that works
135                                  * for this mode. Lets return now. */
136                                 return 0;
137                         }
138                 }
139         }
140
141         return 0;
142 }
143
144 static int drm_helper_probe_add_cmdline_mode(struct drm_connector *connector)
145 {
146         struct drm_cmdline_mode *cmdline_mode;
147         struct drm_display_mode *mode;
148
149         cmdline_mode = &connector->cmdline_mode;
150         if (!cmdline_mode->specified)
151                 return 0;
152
153         /* Only add a GTF mode if we find no matching probed modes */
154         list_for_each_entry(mode, &connector->probed_modes, head) {
155                 if (mode->hdisplay != cmdline_mode->xres ||
156                     mode->vdisplay != cmdline_mode->yres)
157                         continue;
158
159                 if (cmdline_mode->refresh_specified) {
160                         /* The probed mode's vrefresh is set until later */
161                         if (drm_mode_vrefresh(mode) != cmdline_mode->refresh)
162                                 continue;
163                 }
164
165                 /* Mark the matching mode as being preferred by the user */
166                 mode->type |= DRM_MODE_TYPE_USERDEF;
167                 return 0;
168         }
169
170         mode = drm_mode_create_from_cmdline_mode(connector->dev,
171                                                  cmdline_mode);
172         if (mode == NULL)
173                 return 0;
174
175         drm_mode_probed_add(connector, mode);
176         return 1;
177 }
178
179 enum drm_mode_status drm_crtc_mode_valid(struct drm_crtc *crtc,
180                                          const struct drm_display_mode *mode)
181 {
182         const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
183
184         if (!crtc_funcs || !crtc_funcs->mode_valid)
185                 return MODE_OK;
186
187         return crtc_funcs->mode_valid(crtc, mode);
188 }
189
190 enum drm_mode_status drm_encoder_mode_valid(struct drm_encoder *encoder,
191                                             const struct drm_display_mode *mode)
192 {
193         const struct drm_encoder_helper_funcs *encoder_funcs =
194                 encoder->helper_private;
195
196         if (!encoder_funcs || !encoder_funcs->mode_valid)
197                 return MODE_OK;
198
199         return encoder_funcs->mode_valid(encoder, mode);
200 }
201
202 int
203 drm_connector_mode_valid(struct drm_connector *connector,
204                          struct drm_display_mode *mode,
205                          struct drm_modeset_acquire_ctx *ctx,
206                          enum drm_mode_status *status)
207 {
208         const struct drm_connector_helper_funcs *connector_funcs =
209                 connector->helper_private;
210         int ret = 0;
211
212         if (!connector_funcs)
213                 *status = MODE_OK;
214         else if (connector_funcs->mode_valid_ctx)
215                 ret = connector_funcs->mode_valid_ctx(connector, mode, ctx,
216                                                       status);
217         else if (connector_funcs->mode_valid)
218                 *status = connector_funcs->mode_valid(connector, mode);
219         else
220                 *status = MODE_OK;
221
222         return ret;
223 }
224
225 static void drm_kms_helper_disable_hpd(struct drm_device *dev)
226 {
227         struct drm_connector *connector;
228         struct drm_connector_list_iter conn_iter;
229
230         drm_connector_list_iter_begin(dev, &conn_iter);
231         drm_for_each_connector_iter(connector, &conn_iter) {
232                 const struct drm_connector_helper_funcs *funcs =
233                         connector->helper_private;
234
235                 if (funcs && funcs->disable_hpd)
236                         funcs->disable_hpd(connector);
237         }
238         drm_connector_list_iter_end(&conn_iter);
239 }
240
241 static bool drm_kms_helper_enable_hpd(struct drm_device *dev)
242 {
243         bool poll = false;
244         struct drm_connector *connector;
245         struct drm_connector_list_iter conn_iter;
246
247         drm_connector_list_iter_begin(dev, &conn_iter);
248         drm_for_each_connector_iter(connector, &conn_iter) {
249                 const struct drm_connector_helper_funcs *funcs =
250                         connector->helper_private;
251
252                 if (funcs && funcs->enable_hpd)
253                         funcs->enable_hpd(connector);
254
255                 if (connector->polled & (DRM_CONNECTOR_POLL_CONNECT |
256                                          DRM_CONNECTOR_POLL_DISCONNECT))
257                         poll = true;
258         }
259         drm_connector_list_iter_end(&conn_iter);
260
261         return poll;
262 }
263
264 #define DRM_OUTPUT_POLL_PERIOD (10*HZ)
265 /**
266  * drm_kms_helper_poll_enable - re-enable output polling.
267  * @dev: drm_device
268  *
269  * This function re-enables the output polling work, after it has been
270  * temporarily disabled using drm_kms_helper_poll_disable(), for example over
271  * suspend/resume.
272  *
273  * Drivers can call this helper from their device resume implementation. It is
274  * not an error to call this even when output polling isn't enabled.
275  *
276  * Note that calls to enable and disable polling must be strictly ordered, which
277  * is automatically the case when they're only call from suspend/resume
278  * callbacks.
279  */
280 void drm_kms_helper_poll_enable(struct drm_device *dev)
281 {
282         bool poll = false;
283         unsigned long delay = DRM_OUTPUT_POLL_PERIOD;
284
285         if (!dev->mode_config.poll_enabled || !drm_kms_helper_poll ||
286             dev->mode_config.poll_running)
287                 return;
288
289         poll = drm_kms_helper_enable_hpd(dev);
290
291         if (dev->mode_config.delayed_event) {
292                 /*
293                  * FIXME:
294                  *
295                  * Use short (1s) delay to handle the initial delayed event.
296                  * This delay should not be needed, but Optimus/nouveau will
297                  * fail in a mysterious way if the delayed event is handled as
298                  * soon as possible like it is done in
299                  * drm_helper_probe_single_connector_modes() in case the poll
300                  * was enabled before.
301                  */
302                 poll = true;
303                 delay = HZ;
304         }
305
306         if (poll)
307                 schedule_delayed_work(&dev->mode_config.output_poll_work, delay);
308
309         dev->mode_config.poll_running = true;
310 }
311 EXPORT_SYMBOL(drm_kms_helper_poll_enable);
312
313 static enum drm_connector_status
314 drm_helper_probe_detect_ctx(struct drm_connector *connector, bool force)
315 {
316         const struct drm_connector_helper_funcs *funcs = connector->helper_private;
317         struct drm_modeset_acquire_ctx ctx;
318         int ret;
319
320         drm_modeset_acquire_init(&ctx, 0);
321
322 retry:
323         ret = drm_modeset_lock(&connector->dev->mode_config.connection_mutex, &ctx);
324         if (!ret) {
325                 if (funcs->detect_ctx)
326                         ret = funcs->detect_ctx(connector, &ctx, force);
327                 else if (connector->funcs->detect)
328                         ret = connector->funcs->detect(connector, force);
329                 else
330                         ret = connector_status_connected;
331         }
332
333         if (ret == -EDEADLK) {
334                 drm_modeset_backoff(&ctx);
335                 goto retry;
336         }
337
338         if (WARN_ON(ret < 0))
339                 ret = connector_status_unknown;
340
341         if (ret != connector->status)
342                 connector->epoch_counter += 1;
343
344         drm_modeset_drop_locks(&ctx);
345         drm_modeset_acquire_fini(&ctx);
346
347         return ret;
348 }
349
350 /**
351  * drm_helper_probe_detect - probe connector status
352  * @connector: connector to probe
353  * @ctx: acquire_ctx, or NULL to let this function handle locking.
354  * @force: Whether destructive probe operations should be performed.
355  *
356  * This function calls the detect callbacks of the connector.
357  * This function returns &drm_connector_status, or
358  * if @ctx is set, it might also return -EDEADLK.
359  */
360 int
361 drm_helper_probe_detect(struct drm_connector *connector,
362                         struct drm_modeset_acquire_ctx *ctx,
363                         bool force)
364 {
365         const struct drm_connector_helper_funcs *funcs = connector->helper_private;
366         struct drm_device *dev = connector->dev;
367         int ret;
368
369         if (!ctx)
370                 return drm_helper_probe_detect_ctx(connector, force);
371
372         ret = drm_modeset_lock(&dev->mode_config.connection_mutex, ctx);
373         if (ret)
374                 return ret;
375
376         if (funcs->detect_ctx)
377                 ret = funcs->detect_ctx(connector, ctx, force);
378         else if (connector->funcs->detect)
379                 ret = connector->funcs->detect(connector, force);
380         else
381                 ret = connector_status_connected;
382
383         if (ret != connector->status)
384                 connector->epoch_counter += 1;
385
386         return ret;
387 }
388 EXPORT_SYMBOL(drm_helper_probe_detect);
389
390 static int drm_helper_probe_get_modes(struct drm_connector *connector)
391 {
392         const struct drm_connector_helper_funcs *connector_funcs =
393                 connector->helper_private;
394         int count;
395
396         count = connector_funcs->get_modes(connector);
397
398         /*
399          * Fallback for when DDC probe failed in drm_get_edid() and thus skipped
400          * override/firmware EDID.
401          */
402         if (count == 0 && connector->status == connector_status_connected)
403                 count = drm_edid_override_connector_update(connector);
404
405         return count;
406 }
407
408 static int __drm_helper_update_and_validate(struct drm_connector *connector,
409                                             uint32_t maxX, uint32_t maxY,
410                                             struct drm_modeset_acquire_ctx *ctx)
411 {
412         struct drm_device *dev = connector->dev;
413         struct drm_display_mode *mode;
414         int mode_flags = 0;
415         int ret;
416
417         drm_connector_list_update(connector);
418
419         if (connector->interlace_allowed)
420                 mode_flags |= DRM_MODE_FLAG_INTERLACE;
421         if (connector->doublescan_allowed)
422                 mode_flags |= DRM_MODE_FLAG_DBLSCAN;
423         if (connector->stereo_allowed)
424                 mode_flags |= DRM_MODE_FLAG_3D_MASK;
425
426         list_for_each_entry(mode, &connector->modes, head) {
427                 if (mode->status != MODE_OK)
428                         continue;
429
430                 mode->status = drm_mode_validate_driver(dev, mode);
431                 if (mode->status != MODE_OK)
432                         continue;
433
434                 mode->status = drm_mode_validate_size(mode, maxX, maxY);
435                 if (mode->status != MODE_OK)
436                         continue;
437
438                 mode->status = drm_mode_validate_flag(mode, mode_flags);
439                 if (mode->status != MODE_OK)
440                         continue;
441
442                 ret = drm_mode_validate_pipeline(mode, connector, ctx,
443                                                  &mode->status);
444                 if (ret) {
445                         drm_dbg_kms(dev,
446                                     "drm_mode_validate_pipeline failed: %d\n",
447                                     ret);
448
449                         if (drm_WARN_ON_ONCE(dev, ret != -EDEADLK))
450                                 mode->status = MODE_ERROR;
451                         else
452                                 return -EDEADLK;
453                 }
454
455                 if (mode->status != MODE_OK)
456                         continue;
457                 mode->status = drm_mode_validate_ycbcr420(mode, connector);
458         }
459
460         return 0;
461 }
462
463 /**
464  * drm_helper_probe_single_connector_modes - get complete set of display modes
465  * @connector: connector to probe
466  * @maxX: max width for modes
467  * @maxY: max height for modes
468  *
469  * Based on the helper callbacks implemented by @connector in struct
470  * &drm_connector_helper_funcs try to detect all valid modes.  Modes will first
471  * be added to the connector's probed_modes list, then culled (based on validity
472  * and the @maxX, @maxY parameters) and put into the normal modes list.
473  *
474  * Intended to be used as a generic implementation of the
475  * &drm_connector_funcs.fill_modes() vfunc for drivers that use the CRTC helpers
476  * for output mode filtering and detection.
477  *
478  * The basic procedure is as follows
479  *
480  * 1. All modes currently on the connector's modes list are marked as stale
481  *
482  * 2. New modes are added to the connector's probed_modes list with
483  *    drm_mode_probed_add(). New modes start their life with status as OK.
484  *    Modes are added from a single source using the following priority order.
485  *
486  *    - &drm_connector_helper_funcs.get_modes vfunc
487  *    - if the connector status is connector_status_connected, standard
488  *      VESA DMT modes up to 1024x768 are automatically added
489  *      (drm_add_modes_noedid())
490  *
491  *    Finally modes specified via the kernel command line (video=...) are
492  *    added in addition to what the earlier probes produced
493  *    (drm_helper_probe_add_cmdline_mode()). These modes are generated
494  *    using the VESA GTF/CVT formulas.
495  *
496  * 3. Modes are moved from the probed_modes list to the modes list. Potential
497  *    duplicates are merged together (see drm_connector_list_update()).
498  *    After this step the probed_modes list will be empty again.
499  *
500  * 4. Any non-stale mode on the modes list then undergoes validation
501  *
502  *    - drm_mode_validate_basic() performs basic sanity checks
503  *    - drm_mode_validate_size() filters out modes larger than @maxX and @maxY
504  *      (if specified)
505  *    - drm_mode_validate_flag() checks the modes against basic connector
506  *      capabilities (interlace_allowed,doublescan_allowed,stereo_allowed)
507  *    - the optional &drm_connector_helper_funcs.mode_valid or
508  *      &drm_connector_helper_funcs.mode_valid_ctx helpers can perform driver
509  *      and/or sink specific checks
510  *    - the optional &drm_crtc_helper_funcs.mode_valid,
511  *      &drm_bridge_funcs.mode_valid and &drm_encoder_helper_funcs.mode_valid
512  *      helpers can perform driver and/or source specific checks which are also
513  *      enforced by the modeset/atomic helpers
514  *
515  * 5. Any mode whose status is not OK is pruned from the connector's modes list,
516  *    accompanied by a debug message indicating the reason for the mode's
517  *    rejection (see drm_mode_prune_invalid()).
518  *
519  * Returns:
520  * The number of modes found on @connector.
521  */
522 int drm_helper_probe_single_connector_modes(struct drm_connector *connector,
523                                             uint32_t maxX, uint32_t maxY)
524 {
525         struct drm_device *dev = connector->dev;
526         struct drm_display_mode *mode;
527         int count = 0, ret;
528         enum drm_connector_status old_status;
529         struct drm_modeset_acquire_ctx ctx;
530
531         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
532
533         drm_modeset_acquire_init(&ctx, 0);
534
535         DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n", connector->base.id,
536                         connector->name);
537
538 retry:
539         ret = drm_modeset_lock(&dev->mode_config.connection_mutex, &ctx);
540         if (ret == -EDEADLK) {
541                 drm_modeset_backoff(&ctx);
542                 goto retry;
543         } else
544                 WARN_ON(ret < 0);
545
546         /* set all old modes to the stale state */
547         list_for_each_entry(mode, &connector->modes, head)
548                 mode->status = MODE_STALE;
549
550         old_status = connector->status;
551
552         if (connector->force) {
553                 if (connector->force == DRM_FORCE_ON ||
554                     connector->force == DRM_FORCE_ON_DIGITAL)
555                         connector->status = connector_status_connected;
556                 else
557                         connector->status = connector_status_disconnected;
558                 if (connector->funcs->force)
559                         connector->funcs->force(connector);
560         } else {
561                 ret = drm_helper_probe_detect(connector, &ctx, true);
562
563                 if (ret == -EDEADLK) {
564                         drm_modeset_backoff(&ctx);
565                         goto retry;
566                 } else if (WARN(ret < 0, "Invalid return value %i for connector detection\n", ret))
567                         ret = connector_status_unknown;
568
569                 connector->status = ret;
570         }
571
572         /*
573          * Normally either the driver's hpd code or the poll loop should
574          * pick up any changes and fire the hotplug event. But if
575          * userspace sneaks in a probe, we might miss a change. Hence
576          * check here, and if anything changed start the hotplug code.
577          */
578         if (old_status != connector->status) {
579                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
580                               connector->base.id,
581                               connector->name,
582                               drm_get_connector_status_name(old_status),
583                               drm_get_connector_status_name(connector->status));
584
585                 /*
586                  * The hotplug event code might call into the fb
587                  * helpers, and so expects that we do not hold any
588                  * locks. Fire up the poll struct instead, it will
589                  * disable itself again.
590                  */
591                 dev->mode_config.delayed_event = true;
592                 if (dev->mode_config.poll_enabled)
593                         schedule_delayed_work(&dev->mode_config.output_poll_work,
594                                               0);
595         }
596
597         /* Re-enable polling in case the global poll config changed. */
598         drm_kms_helper_poll_enable(dev);
599
600         if (connector->status == connector_status_disconnected) {
601                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] disconnected\n",
602                         connector->base.id, connector->name);
603                 drm_connector_update_edid_property(connector, NULL);
604                 drm_mode_prune_invalid(dev, &connector->modes, false);
605                 goto exit;
606         }
607
608         count = drm_helper_probe_get_modes(connector);
609
610         if (count == 0 && (connector->status == connector_status_connected ||
611                            connector->status == connector_status_unknown)) {
612                 count = drm_add_modes_noedid(connector, 1024, 768);
613
614                 /*
615                  * Section 4.2.2.6 (EDID Corruption Detection) of the DP 1.4a
616                  * Link CTS specifies that 640x480 (the official "failsafe"
617                  * mode) needs to be the default if there's no EDID.
618                  */
619                 if (connector->connector_type == DRM_MODE_CONNECTOR_DisplayPort)
620                         drm_set_preferred_mode(connector, 640, 480);
621         }
622         count += drm_helper_probe_add_cmdline_mode(connector);
623         if (count != 0) {
624                 ret = __drm_helper_update_and_validate(connector, maxX, maxY, &ctx);
625                 if (ret == -EDEADLK) {
626                         drm_modeset_backoff(&ctx);
627                         goto retry;
628                 }
629         }
630
631         drm_mode_prune_invalid(dev, &connector->modes, true);
632
633         /*
634          * Displayport spec section 5.2.1.2 ("Video Timing Format") says that
635          * all detachable sinks shall support 640x480 @60Hz as a fail safe
636          * mode. If all modes were pruned, perhaps because they need more
637          * lanes or a higher pixel clock than available, at least try to add
638          * in 640x480.
639          */
640         if (list_empty(&connector->modes) &&
641             connector->connector_type == DRM_MODE_CONNECTOR_DisplayPort) {
642                 count = drm_add_modes_noedid(connector, 640, 480);
643                 ret = __drm_helper_update_and_validate(connector, maxX, maxY, &ctx);
644                 if (ret == -EDEADLK) {
645                         drm_modeset_backoff(&ctx);
646                         goto retry;
647                 }
648                 drm_mode_prune_invalid(dev, &connector->modes, true);
649         }
650
651 exit:
652         drm_modeset_drop_locks(&ctx);
653         drm_modeset_acquire_fini(&ctx);
654
655         if (list_empty(&connector->modes))
656                 return 0;
657
658         drm_mode_sort(&connector->modes);
659
660         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] probed modes :\n", connector->base.id,
661                         connector->name);
662         list_for_each_entry(mode, &connector->modes, head) {
663                 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
664                 drm_mode_debug_printmodeline(mode);
665         }
666
667         return count;
668 }
669 EXPORT_SYMBOL(drm_helper_probe_single_connector_modes);
670
671 /**
672  * drm_kms_helper_hotplug_event - fire off KMS hotplug events
673  * @dev: drm_device whose connector state changed
674  *
675  * This function fires off the uevent for userspace and also calls the
676  * output_poll_changed function, which is most commonly used to inform the fbdev
677  * emulation code and allow it to update the fbcon output configuration.
678  *
679  * Drivers should call this from their hotplug handling code when a change is
680  * detected. Note that this function does not do any output detection of its
681  * own, like drm_helper_hpd_irq_event() does - this is assumed to be done by the
682  * driver already.
683  *
684  * This function must be called from process context with no mode
685  * setting locks held.
686  *
687  * If only a single connector has changed, consider calling
688  * drm_kms_helper_connector_hotplug_event() instead.
689  */
690 void drm_kms_helper_hotplug_event(struct drm_device *dev)
691 {
692         /* send a uevent + call fbdev */
693         drm_sysfs_hotplug_event(dev);
694         if (dev->mode_config.funcs->output_poll_changed)
695                 dev->mode_config.funcs->output_poll_changed(dev);
696
697         drm_client_dev_hotplug(dev);
698 }
699 EXPORT_SYMBOL(drm_kms_helper_hotplug_event);
700
701 /**
702  * drm_kms_helper_connector_hotplug_event - fire off a KMS connector hotplug event
703  * @connector: drm_connector which has changed
704  *
705  * This is the same as drm_kms_helper_hotplug_event(), except it fires a more
706  * fine-grained uevent for a single connector.
707  */
708 void drm_kms_helper_connector_hotplug_event(struct drm_connector *connector)
709 {
710         struct drm_device *dev = connector->dev;
711
712         /* send a uevent + call fbdev */
713         drm_sysfs_connector_hotplug_event(connector);
714         if (dev->mode_config.funcs->output_poll_changed)
715                 dev->mode_config.funcs->output_poll_changed(dev);
716
717         drm_client_dev_hotplug(dev);
718 }
719 EXPORT_SYMBOL(drm_kms_helper_connector_hotplug_event);
720
721 static void output_poll_execute(struct work_struct *work)
722 {
723         struct delayed_work *delayed_work = to_delayed_work(work);
724         struct drm_device *dev = container_of(delayed_work, struct drm_device, mode_config.output_poll_work);
725         struct drm_connector *connector;
726         struct drm_connector_list_iter conn_iter;
727         enum drm_connector_status old_status;
728         bool repoll = false, changed;
729         u64 old_epoch_counter;
730
731         if (!dev->mode_config.poll_enabled)
732                 return;
733
734         /* Pick up any changes detected by the probe functions. */
735         changed = dev->mode_config.delayed_event;
736         dev->mode_config.delayed_event = false;
737
738         if (!drm_kms_helper_poll && dev->mode_config.poll_running) {
739                 drm_kms_helper_disable_hpd(dev);
740                 dev->mode_config.poll_running = false;
741                 goto out;
742         }
743
744         if (!mutex_trylock(&dev->mode_config.mutex)) {
745                 repoll = true;
746                 goto out;
747         }
748
749         drm_connector_list_iter_begin(dev, &conn_iter);
750         drm_for_each_connector_iter(connector, &conn_iter) {
751                 /* Ignore forced connectors. */
752                 if (connector->force)
753                         continue;
754
755                 /* Ignore HPD capable connectors and connectors where we don't
756                  * want any hotplug detection at all for polling. */
757                 if (!connector->polled || connector->polled == DRM_CONNECTOR_POLL_HPD)
758                         continue;
759
760                 old_status = connector->status;
761                 /* if we are connected and don't want to poll for disconnect
762                    skip it */
763                 if (old_status == connector_status_connected &&
764                     !(connector->polled & DRM_CONNECTOR_POLL_DISCONNECT))
765                         continue;
766
767                 repoll = true;
768
769                 old_epoch_counter = connector->epoch_counter;
770                 connector->status = drm_helper_probe_detect(connector, NULL, false);
771                 if (old_epoch_counter != connector->epoch_counter) {
772                         const char *old, *new;
773
774                         /*
775                          * The poll work sets force=false when calling detect so
776                          * that drivers can avoid to do disruptive tests (e.g.
777                          * when load detect cycles could cause flickering on
778                          * other, running displays). This bears the risk that we
779                          * flip-flop between unknown here in the poll work and
780                          * the real state when userspace forces a full detect
781                          * call after receiving a hotplug event due to this
782                          * change.
783                          *
784                          * Hence clamp an unknown detect status to the old
785                          * value.
786                          */
787                         if (connector->status == connector_status_unknown) {
788                                 connector->status = old_status;
789                                 continue;
790                         }
791
792                         old = drm_get_connector_status_name(old_status);
793                         new = drm_get_connector_status_name(connector->status);
794
795                         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] "
796                                       "status updated from %s to %s\n",
797                                       connector->base.id,
798                                       connector->name,
799                                       old, new);
800                         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] epoch counter %llu -> %llu\n",
801                                       connector->base.id, connector->name,
802                                       old_epoch_counter, connector->epoch_counter);
803
804                         changed = true;
805                 }
806         }
807         drm_connector_list_iter_end(&conn_iter);
808
809         mutex_unlock(&dev->mode_config.mutex);
810
811 out:
812         if (changed)
813                 drm_kms_helper_hotplug_event(dev);
814
815         if (repoll)
816                 schedule_delayed_work(delayed_work, DRM_OUTPUT_POLL_PERIOD);
817 }
818
819 /**
820  * drm_kms_helper_is_poll_worker - is %current task an output poll worker?
821  *
822  * Determine if %current task is an output poll worker.  This can be used
823  * to select distinct code paths for output polling versus other contexts.
824  *
825  * One use case is to avoid a deadlock between the output poll worker and
826  * the autosuspend worker wherein the latter waits for polling to finish
827  * upon calling drm_kms_helper_poll_disable(), while the former waits for
828  * runtime suspend to finish upon calling pm_runtime_get_sync() in a
829  * connector ->detect hook.
830  */
831 bool drm_kms_helper_is_poll_worker(void)
832 {
833         struct work_struct *work = current_work();
834
835         return work && work->func == output_poll_execute;
836 }
837 EXPORT_SYMBOL(drm_kms_helper_is_poll_worker);
838
839 /**
840  * drm_kms_helper_poll_disable - disable output polling
841  * @dev: drm_device
842  *
843  * This function disables the output polling work.
844  *
845  * Drivers can call this helper from their device suspend implementation. It is
846  * not an error to call this even when output polling isn't enabled or already
847  * disabled. Polling is re-enabled by calling drm_kms_helper_poll_enable().
848  *
849  * Note that calls to enable and disable polling must be strictly ordered, which
850  * is automatically the case when they're only call from suspend/resume
851  * callbacks.
852  */
853 void drm_kms_helper_poll_disable(struct drm_device *dev)
854 {
855         if (dev->mode_config.poll_running)
856                 drm_kms_helper_disable_hpd(dev);
857
858         cancel_delayed_work_sync(&dev->mode_config.output_poll_work);
859
860         dev->mode_config.poll_running = false;
861 }
862 EXPORT_SYMBOL(drm_kms_helper_poll_disable);
863
864 /**
865  * drm_kms_helper_poll_init - initialize and enable output polling
866  * @dev: drm_device
867  *
868  * This function initializes and then also enables output polling support for
869  * @dev. Drivers which do not have reliable hotplug support in hardware can use
870  * this helper infrastructure to regularly poll such connectors for changes in
871  * their connection state.
872  *
873  * Drivers can control which connectors are polled by setting the
874  * DRM_CONNECTOR_POLL_CONNECT and DRM_CONNECTOR_POLL_DISCONNECT flags. On
875  * connectors where probing live outputs can result in visual distortion drivers
876  * should not set the DRM_CONNECTOR_POLL_DISCONNECT flag to avoid this.
877  * Connectors which have no flag or only DRM_CONNECTOR_POLL_HPD set are
878  * completely ignored by the polling logic.
879  *
880  * Note that a connector can be both polled and probed from the hotplug handler,
881  * in case the hotplug interrupt is known to be unreliable.
882  */
883 void drm_kms_helper_poll_init(struct drm_device *dev)
884 {
885         INIT_DELAYED_WORK(&dev->mode_config.output_poll_work, output_poll_execute);
886         dev->mode_config.poll_enabled = true;
887
888         drm_kms_helper_poll_enable(dev);
889 }
890 EXPORT_SYMBOL(drm_kms_helper_poll_init);
891
892 /**
893  * drm_kms_helper_poll_fini - disable output polling and clean it up
894  * @dev: drm_device
895  */
896 void drm_kms_helper_poll_fini(struct drm_device *dev)
897 {
898         if (!dev->mode_config.poll_enabled)
899                 return;
900
901         drm_kms_helper_poll_disable(dev);
902
903         dev->mode_config.poll_enabled = false;
904 }
905 EXPORT_SYMBOL(drm_kms_helper_poll_fini);
906
907 static bool check_connector_changed(struct drm_connector *connector)
908 {
909         struct drm_device *dev = connector->dev;
910         enum drm_connector_status old_status;
911         u64 old_epoch_counter;
912
913         /* Only handle HPD capable connectors. */
914         drm_WARN_ON(dev, !(connector->polled & DRM_CONNECTOR_POLL_HPD));
915
916         drm_WARN_ON(dev, !mutex_is_locked(&dev->mode_config.mutex));
917
918         old_status = connector->status;
919         old_epoch_counter = connector->epoch_counter;
920         connector->status = drm_helper_probe_detect(connector, NULL, false);
921
922         if (old_epoch_counter == connector->epoch_counter) {
923                 drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Same epoch counter %llu\n",
924                             connector->base.id,
925                             connector->name,
926                             connector->epoch_counter);
927
928                 return false;
929         }
930
931         drm_dbg_kms(dev, "[CONNECTOR:%d:%s] status updated from %s to %s\n",
932                     connector->base.id,
933                     connector->name,
934                     drm_get_connector_status_name(old_status),
935                     drm_get_connector_status_name(connector->status));
936
937         drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Changed epoch counter %llu => %llu\n",
938                     connector->base.id,
939                     connector->name,
940                     old_epoch_counter,
941                     connector->epoch_counter);
942
943         return true;
944 }
945
946 /**
947  * drm_connector_helper_hpd_irq_event - hotplug processing
948  * @connector: drm_connector
949  *
950  * Drivers can use this helper function to run a detect cycle on a connector
951  * which has the DRM_CONNECTOR_POLL_HPD flag set in its &polled member.
952  *
953  * This helper function is useful for drivers which can track hotplug
954  * interrupts for a single connector. Drivers that want to send a
955  * hotplug event for all connectors or can't track hotplug interrupts
956  * per connector need to use drm_helper_hpd_irq_event().
957  *
958  * This function must be called from process context with no mode
959  * setting locks held.
960  *
961  * Note that a connector can be both polled and probed from the hotplug
962  * handler, in case the hotplug interrupt is known to be unreliable.
963  *
964  * Returns:
965  * A boolean indicating whether the connector status changed or not
966  */
967 bool drm_connector_helper_hpd_irq_event(struct drm_connector *connector)
968 {
969         struct drm_device *dev = connector->dev;
970         bool changed;
971
972         mutex_lock(&dev->mode_config.mutex);
973         changed = check_connector_changed(connector);
974         mutex_unlock(&dev->mode_config.mutex);
975
976         if (changed) {
977                 drm_kms_helper_connector_hotplug_event(connector);
978                 drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Sent hotplug event\n",
979                             connector->base.id,
980                             connector->name);
981         }
982
983         return changed;
984 }
985 EXPORT_SYMBOL(drm_connector_helper_hpd_irq_event);
986
987 /**
988  * drm_helper_hpd_irq_event - hotplug processing
989  * @dev: drm_device
990  *
991  * Drivers can use this helper function to run a detect cycle on all connectors
992  * which have the DRM_CONNECTOR_POLL_HPD flag set in their &polled member. All
993  * other connectors are ignored, which is useful to avoid reprobing fixed
994  * panels.
995  *
996  * This helper function is useful for drivers which can't or don't track hotplug
997  * interrupts for each connector.
998  *
999  * Drivers which support hotplug interrupts for each connector individually and
1000  * which have a more fine-grained detect logic can use
1001  * drm_connector_helper_hpd_irq_event(). Alternatively, they should bypass this
1002  * code and directly call drm_kms_helper_hotplug_event() in case the connector
1003  * state changed.
1004  *
1005  * This function must be called from process context with no mode
1006  * setting locks held.
1007  *
1008  * Note that a connector can be both polled and probed from the hotplug handler,
1009  * in case the hotplug interrupt is known to be unreliable.
1010  *
1011  * Returns:
1012  * A boolean indicating whether the connector status changed or not
1013  */
1014 bool drm_helper_hpd_irq_event(struct drm_device *dev)
1015 {
1016         struct drm_connector *connector, *first_changed_connector = NULL;
1017         struct drm_connector_list_iter conn_iter;
1018         int changed = 0;
1019
1020         if (!dev->mode_config.poll_enabled)
1021                 return false;
1022
1023         mutex_lock(&dev->mode_config.mutex);
1024         drm_connector_list_iter_begin(dev, &conn_iter);
1025         drm_for_each_connector_iter(connector, &conn_iter) {
1026                 /* Only handle HPD capable connectors. */
1027                 if (!(connector->polled & DRM_CONNECTOR_POLL_HPD))
1028                         continue;
1029
1030                 if (check_connector_changed(connector)) {
1031                         if (!first_changed_connector) {
1032                                 drm_connector_get(connector);
1033                                 first_changed_connector = connector;
1034                         }
1035
1036                         changed++;
1037                 }
1038         }
1039         drm_connector_list_iter_end(&conn_iter);
1040         mutex_unlock(&dev->mode_config.mutex);
1041
1042         if (changed == 1)
1043                 drm_kms_helper_connector_hotplug_event(first_changed_connector);
1044         else if (changed > 0)
1045                 drm_kms_helper_hotplug_event(dev);
1046
1047         if (first_changed_connector)
1048                 drm_connector_put(first_changed_connector);
1049
1050         return changed;
1051 }
1052 EXPORT_SYMBOL(drm_helper_hpd_irq_event);
1053
1054 /**
1055  * drm_crtc_helper_mode_valid_fixed - Validates a display mode
1056  * @crtc: the crtc
1057  * @mode: the mode to validate
1058  * @fixed_mode: the display hardware's mode
1059  *
1060  * Returns:
1061  * MODE_OK on success, or another mode-status code otherwise.
1062  */
1063 enum drm_mode_status drm_crtc_helper_mode_valid_fixed(struct drm_crtc *crtc,
1064                                                       const struct drm_display_mode *mode,
1065                                                       const struct drm_display_mode *fixed_mode)
1066 {
1067         if (mode->hdisplay != fixed_mode->hdisplay && mode->vdisplay != fixed_mode->vdisplay)
1068                 return MODE_ONE_SIZE;
1069         else if (mode->hdisplay != fixed_mode->hdisplay)
1070                 return MODE_ONE_WIDTH;
1071         else if (mode->vdisplay != fixed_mode->vdisplay)
1072                 return MODE_ONE_HEIGHT;
1073
1074         return MODE_OK;
1075 }
1076 EXPORT_SYMBOL(drm_crtc_helper_mode_valid_fixed);
1077
1078 /**
1079  * drm_connector_helper_get_modes_from_ddc - Updates the connector's EDID
1080  *                                           property from the connector's
1081  *                                           DDC channel
1082  * @connector: The connector
1083  *
1084  * Returns:
1085  * The number of detected display modes.
1086  *
1087  * Uses a connector's DDC channel to retrieve EDID data and update the
1088  * connector's EDID property and display modes. Drivers can use this
1089  * function to implement struct &drm_connector_helper_funcs.get_modes
1090  * for connectors with a DDC channel.
1091  */
1092 int drm_connector_helper_get_modes_from_ddc(struct drm_connector *connector)
1093 {
1094         struct edid *edid;
1095         int count = 0;
1096
1097         if (!connector->ddc)
1098                 return 0;
1099
1100         edid = drm_get_edid(connector, connector->ddc);
1101
1102         // clears property if EDID is NULL
1103         drm_connector_update_edid_property(connector, edid);
1104
1105         if (edid) {
1106                 count = drm_add_edid_modes(connector, edid);
1107                 kfree(edid);
1108         }
1109
1110         return count;
1111 }
1112 EXPORT_SYMBOL(drm_connector_helper_get_modes_from_ddc);
1113
1114 /**
1115  * drm_connector_helper_get_modes_fixed - Duplicates a display mode for a connector
1116  * @connector: the connector
1117  * @fixed_mode: the display hardware's mode
1118  *
1119  * This function duplicates a display modes for a connector. Drivers for hardware
1120  * that only supports a single fixed mode can use this function in their connector's
1121  * get_modes helper.
1122  *
1123  * Returns:
1124  * The number of created modes.
1125  */
1126 int drm_connector_helper_get_modes_fixed(struct drm_connector *connector,
1127                                          const struct drm_display_mode *fixed_mode)
1128 {
1129         struct drm_device *dev = connector->dev;
1130         struct drm_display_mode *mode;
1131
1132         mode = drm_mode_duplicate(dev, fixed_mode);
1133         if (!mode) {
1134                 drm_err(dev, "Failed to duplicate mode " DRM_MODE_FMT "\n",
1135                         DRM_MODE_ARG(fixed_mode));
1136                 return 0;
1137         }
1138
1139         if (mode->name[0] == '\0')
1140                 drm_mode_set_name(mode);
1141
1142         mode->type |= DRM_MODE_TYPE_PREFERRED;
1143         drm_mode_probed_add(connector, mode);
1144
1145         if (mode->width_mm)
1146                 connector->display_info.width_mm = mode->width_mm;
1147         if (mode->height_mm)
1148                 connector->display_info.height_mm = mode->height_mm;
1149
1150         return 1;
1151 }
1152 EXPORT_SYMBOL(drm_connector_helper_get_modes_fixed);
1153
1154 /**
1155  * drm_connector_helper_get_modes - Read EDID and update connector.
1156  * @connector: The connector
1157  *
1158  * Read the EDID using drm_edid_read() (which requires that connector->ddc is
1159  * set), and update the connector using the EDID.
1160  *
1161  * This can be used as the "default" connector helper .get_modes() hook if the
1162  * driver does not need any special processing. This is sets the example what
1163  * custom .get_modes() hooks should do regarding EDID read and connector update.
1164  *
1165  * Returns: Number of modes.
1166  */
1167 int drm_connector_helper_get_modes(struct drm_connector *connector)
1168 {
1169         const struct drm_edid *drm_edid;
1170         int count;
1171
1172         drm_edid = drm_edid_read(connector);
1173
1174         /*
1175          * Unconditionally update the connector. If the EDID was read
1176          * successfully, fill in the connector information derived from the
1177          * EDID. Otherwise, if the EDID is NULL, clear the connector
1178          * information.
1179          */
1180         drm_edid_connector_update(connector, drm_edid);
1181
1182         count = drm_edid_connector_add_modes(connector);
1183
1184         drm_edid_free(drm_edid);
1185
1186         return count;
1187 }
1188 EXPORT_SYMBOL(drm_connector_helper_get_modes);
1189
1190 /**
1191  * drm_connector_helper_tv_get_modes - Fills the modes availables to a TV connector
1192  * @connector: The connector
1193  *
1194  * Fills the available modes for a TV connector based on the supported
1195  * TV modes, and the default mode expressed by the kernel command line.
1196  *
1197  * This can be used as the default TV connector helper .get_modes() hook
1198  * if the driver does not need any special processing.
1199  *
1200  * Returns:
1201  * The number of modes added to the connector.
1202  */
1203 int drm_connector_helper_tv_get_modes(struct drm_connector *connector)
1204 {
1205         struct drm_device *dev = connector->dev;
1206         struct drm_property *tv_mode_property =
1207                 dev->mode_config.tv_mode_property;
1208         struct drm_cmdline_mode *cmdline = &connector->cmdline_mode;
1209         unsigned int ntsc_modes = BIT(DRM_MODE_TV_MODE_NTSC) |
1210                 BIT(DRM_MODE_TV_MODE_NTSC_443) |
1211                 BIT(DRM_MODE_TV_MODE_NTSC_J) |
1212                 BIT(DRM_MODE_TV_MODE_PAL_M);
1213         unsigned int pal_modes = BIT(DRM_MODE_TV_MODE_PAL) |
1214                 BIT(DRM_MODE_TV_MODE_PAL_N) |
1215                 BIT(DRM_MODE_TV_MODE_SECAM);
1216         unsigned int tv_modes[2] = { UINT_MAX, UINT_MAX };
1217         unsigned int i, supported_tv_modes = 0;
1218
1219         if (!tv_mode_property)
1220                 return 0;
1221
1222         for (i = 0; i < tv_mode_property->num_values; i++)
1223                 supported_tv_modes |= BIT(tv_mode_property->values[i]);
1224
1225         if ((supported_tv_modes & ntsc_modes) &&
1226             (supported_tv_modes & pal_modes)) {
1227                 uint64_t default_mode;
1228
1229                 if (drm_object_property_get_default_value(&connector->base,
1230                                                           tv_mode_property,
1231                                                           &default_mode))
1232                         return 0;
1233
1234                 if (cmdline->tv_mode_specified)
1235                         default_mode = cmdline->tv_mode;
1236
1237                 if (BIT(default_mode) & ntsc_modes) {
1238                         tv_modes[0] = DRM_MODE_TV_MODE_NTSC;
1239                         tv_modes[1] = DRM_MODE_TV_MODE_PAL;
1240                 } else {
1241                         tv_modes[0] = DRM_MODE_TV_MODE_PAL;
1242                         tv_modes[1] = DRM_MODE_TV_MODE_NTSC;
1243                 }
1244         } else if (supported_tv_modes & ntsc_modes) {
1245                 tv_modes[0] = DRM_MODE_TV_MODE_NTSC;
1246         } else if (supported_tv_modes & pal_modes) {
1247                 tv_modes[0] = DRM_MODE_TV_MODE_PAL;
1248         } else {
1249                 return 0;
1250         }
1251
1252         for (i = 0; i < ARRAY_SIZE(tv_modes); i++) {
1253                 struct drm_display_mode *mode;
1254
1255                 if (tv_modes[i] == DRM_MODE_TV_MODE_NTSC)
1256                         mode = drm_mode_analog_ntsc_480i(dev);
1257                 else if (tv_modes[i] == DRM_MODE_TV_MODE_PAL)
1258                         mode = drm_mode_analog_pal_576i(dev);
1259                 else
1260                         break;
1261                 if (!mode)
1262                         return i;
1263                 if (!i)
1264                         mode->type |= DRM_MODE_TYPE_PREFERRED;
1265                 drm_mode_probed_add(connector, mode);
1266         }
1267
1268         return i;
1269 }
1270 EXPORT_SYMBOL(drm_connector_helper_tv_get_modes);