1 // SPDX-License-Identifier: MIT
3 #include <drm/drm_atomic.h>
4 #include <drm/drm_connector.h>
5 #include <drm/drm_edid.h>
6 #include <drm/drm_print.h>
8 #include <drm/display/drm_hdmi_helper.h>
9 #include <drm/display/drm_hdmi_state_helper.h>
12 * __drm_atomic_helper_connector_hdmi_reset() - Initializes all HDMI @drm_connector_state resources
13 * @connector: DRM connector
14 * @new_conn_state: connector state to reset
16 * Initializes all HDMI resources from a @drm_connector_state without
17 * actually allocating it. This is useful for HDMI drivers, in
18 * combination with __drm_atomic_helper_connector_reset() or
19 * drm_atomic_helper_connector_reset().
21 void __drm_atomic_helper_connector_hdmi_reset(struct drm_connector *connector,
22 struct drm_connector_state *new_conn_state)
24 unsigned int max_bpc = connector->max_bpc;
26 new_conn_state->max_bpc = max_bpc;
27 new_conn_state->max_requested_bpc = max_bpc;
28 new_conn_state->hdmi.broadcast_rgb = DRM_HDMI_BROADCAST_RGB_AUTO;
30 EXPORT_SYMBOL(__drm_atomic_helper_connector_hdmi_reset);
32 static const struct drm_display_mode *
33 connector_state_get_mode(const struct drm_connector_state *conn_state)
35 struct drm_atomic_state *state;
36 struct drm_crtc_state *crtc_state;
37 struct drm_crtc *crtc;
39 state = conn_state->state;
43 crtc = conn_state->crtc;
47 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
51 return &crtc_state->mode;
54 static bool hdmi_is_limited_range(const struct drm_connector *connector,
55 const struct drm_connector_state *conn_state)
57 const struct drm_display_info *info = &connector->display_info;
58 const struct drm_display_mode *mode =
59 connector_state_get_mode(conn_state);
62 * The Broadcast RGB property only applies to RGB format, and
63 * i915 just assumes limited range for YCbCr output, so let's
66 if (conn_state->hdmi.output_format != HDMI_COLORSPACE_RGB)
69 if (conn_state->hdmi.broadcast_rgb == DRM_HDMI_BROADCAST_RGB_FULL)
72 if (conn_state->hdmi.broadcast_rgb == DRM_HDMI_BROADCAST_RGB_LIMITED)
78 return drm_default_rgb_quant_range(mode) == HDMI_QUANTIZATION_RANGE_LIMITED;
82 sink_supports_format_bpc(const struct drm_connector *connector,
83 const struct drm_display_info *info,
84 const struct drm_display_mode *mode,
85 unsigned int format, unsigned int bpc)
87 struct drm_device *dev = connector->dev;
88 u8 vic = drm_match_cea_mode(mode);
91 * CTA-861-F, section 5.4 - Color Coding & Quantization states
92 * that the bpc must be 8, 10, 12 or 16 except for the default
93 * 640x480 VIC1 where the value must be 8.
95 * The definition of default here is ambiguous but the spec
96 * refers to VIC1 being the default timing in several occasions
97 * so our understanding is that for the default timing (ie,
98 * VIC1), the bpc must be 8.
100 if (vic == 1 && bpc != 8) {
101 drm_dbg_kms(dev, "VIC1 requires a bpc of 8, got %u\n", bpc);
105 if (!info->is_hdmi &&
106 (format != HDMI_COLORSPACE_RGB || bpc != 8)) {
107 drm_dbg_kms(dev, "DVI Monitors require an RGB output at 8 bpc\n");
111 if (!(connector->hdmi.supported_formats & BIT(format))) {
112 drm_dbg_kms(dev, "%s format unsupported by the connector.\n",
113 drm_hdmi_connector_get_output_format_name(format));
118 case HDMI_COLORSPACE_RGB:
119 drm_dbg_kms(dev, "RGB Format, checking the constraints.\n");
122 * In some cases, like when the EDID readout fails, or
123 * is not an HDMI compliant EDID for some reason, the
124 * color_formats field will be blank and not report any
125 * format supported. In such a case, assume that RGB is
126 * supported so we can keep things going and light up
129 if (!(info->color_formats & DRM_COLOR_FORMAT_RGB444))
130 drm_warn(dev, "HDMI Sink doesn't support RGB, something's wrong.\n");
132 if (bpc == 10 && !(info->edid_hdmi_rgb444_dc_modes & DRM_EDID_HDMI_DC_30)) {
133 drm_dbg_kms(dev, "10 BPC but sink doesn't support Deep Color 30.\n");
137 if (bpc == 12 && !(info->edid_hdmi_rgb444_dc_modes & DRM_EDID_HDMI_DC_36)) {
138 drm_dbg_kms(dev, "12 BPC but sink doesn't support Deep Color 36.\n");
142 drm_dbg_kms(dev, "RGB format supported in that configuration.\n");
146 case HDMI_COLORSPACE_YUV420:
147 /* TODO: YUV420 is unsupported at the moment. */
148 drm_dbg_kms(dev, "YUV420 format isn't supported yet.\n");
151 case HDMI_COLORSPACE_YUV422:
152 drm_dbg_kms(dev, "YUV422 format, checking the constraints.\n");
154 if (!(info->color_formats & DRM_COLOR_FORMAT_YCBCR422)) {
155 drm_dbg_kms(dev, "Sink doesn't support YUV422.\n");
160 drm_dbg_kms(dev, "YUV422 only supports 12 bpc or lower.\n");
165 * HDMI Spec 1.3 - Section 6.5 Pixel Encodings and Color Depth
166 * states that Deep Color is not relevant for YUV422 so we
167 * don't need to check the Deep Color bits in the EDIDs here.
170 drm_dbg_kms(dev, "YUV422 format supported in that configuration.\n");
174 case HDMI_COLORSPACE_YUV444:
175 drm_dbg_kms(dev, "YUV444 format, checking the constraints.\n");
177 if (!(info->color_formats & DRM_COLOR_FORMAT_YCBCR444)) {
178 drm_dbg_kms(dev, "Sink doesn't support YUV444.\n");
182 if (bpc == 10 && !(info->edid_hdmi_ycbcr444_dc_modes & DRM_EDID_HDMI_DC_30)) {
183 drm_dbg_kms(dev, "10 BPC but sink doesn't support Deep Color 30.\n");
187 if (bpc == 12 && !(info->edid_hdmi_ycbcr444_dc_modes & DRM_EDID_HDMI_DC_36)) {
188 drm_dbg_kms(dev, "12 BPC but sink doesn't support Deep Color 36.\n");
192 drm_dbg_kms(dev, "YUV444 format supported in that configuration.\n");
197 drm_dbg_kms(dev, "Unsupported pixel format.\n");
201 static enum drm_mode_status
202 hdmi_clock_valid(const struct drm_connector *connector,
203 const struct drm_display_mode *mode,
204 unsigned long long clock)
206 const struct drm_connector_hdmi_funcs *funcs = connector->hdmi.funcs;
207 const struct drm_display_info *info = &connector->display_info;
209 if (info->max_tmds_clock && clock > info->max_tmds_clock * 1000)
210 return MODE_CLOCK_HIGH;
212 if (funcs && funcs->tmds_char_rate_valid) {
213 enum drm_mode_status status;
215 status = funcs->tmds_char_rate_valid(connector, mode, clock);
216 if (status != MODE_OK)
224 hdmi_compute_clock(const struct drm_connector *connector,
225 struct drm_connector_state *conn_state,
226 const struct drm_display_mode *mode,
227 unsigned int bpc, enum hdmi_colorspace fmt)
229 enum drm_mode_status status;
230 unsigned long long clock;
232 clock = drm_hdmi_compute_mode_clock(mode, bpc, fmt);
236 status = hdmi_clock_valid(connector, mode, clock);
237 if (status != MODE_OK)
240 conn_state->hdmi.tmds_char_rate = clock;
246 hdmi_try_format_bpc(const struct drm_connector *connector,
247 struct drm_connector_state *conn_state,
248 const struct drm_display_mode *mode,
249 unsigned int bpc, enum hdmi_colorspace fmt)
251 const struct drm_display_info *info = &connector->display_info;
252 struct drm_device *dev = connector->dev;
255 drm_dbg_kms(dev, "Trying %s output format\n",
256 drm_hdmi_connector_get_output_format_name(fmt));
258 if (!sink_supports_format_bpc(connector, info, mode, fmt, bpc)) {
259 drm_dbg_kms(dev, "%s output format not supported with %u bpc\n",
260 drm_hdmi_connector_get_output_format_name(fmt),
265 ret = hdmi_compute_clock(connector, conn_state, mode, bpc, fmt);
267 drm_dbg_kms(dev, "Couldn't compute clock for %s output format and %u bpc\n",
268 drm_hdmi_connector_get_output_format_name(fmt),
273 drm_dbg_kms(dev, "%s output format supported with %u (TMDS char rate: %llu Hz)\n",
274 drm_hdmi_connector_get_output_format_name(fmt),
275 bpc, conn_state->hdmi.tmds_char_rate);
281 hdmi_compute_format(const struct drm_connector *connector,
282 struct drm_connector_state *conn_state,
283 const struct drm_display_mode *mode,
286 struct drm_device *dev = connector->dev;
289 * TODO: Add support for YCbCr420 output for HDMI 2.0 capable
290 * devices, for modes that only support YCbCr420.
292 if (hdmi_try_format_bpc(connector, conn_state, mode, bpc, HDMI_COLORSPACE_RGB)) {
293 conn_state->hdmi.output_format = HDMI_COLORSPACE_RGB;
297 drm_dbg_kms(dev, "Failed. No Format Supported for that bpc count.\n");
303 hdmi_compute_config(const struct drm_connector *connector,
304 struct drm_connector_state *conn_state,
305 const struct drm_display_mode *mode)
307 struct drm_device *dev = connector->dev;
308 unsigned int max_bpc = clamp_t(unsigned int,
310 8, connector->max_bpc);
314 for (bpc = max_bpc; bpc >= 8; bpc -= 2) {
315 drm_dbg_kms(dev, "Trying with a %d bpc output\n", bpc);
317 ret = hdmi_compute_format(connector, conn_state, mode, bpc);
321 conn_state->hdmi.output_bpc = bpc;
324 "Mode %ux%u @ %uHz: Found configuration: bpc: %u, fmt: %s, clock: %llu\n",
325 mode->hdisplay, mode->vdisplay, drm_mode_vrefresh(mode),
326 conn_state->hdmi.output_bpc,
327 drm_hdmi_connector_get_output_format_name(conn_state->hdmi.output_format),
328 conn_state->hdmi.tmds_char_rate);
336 static int hdmi_generate_avi_infoframe(const struct drm_connector *connector,
337 struct drm_connector_state *conn_state)
339 const struct drm_display_mode *mode =
340 connector_state_get_mode(conn_state);
341 struct drm_connector_hdmi_infoframe *infoframe =
342 &conn_state->hdmi.infoframes.avi;
343 struct hdmi_avi_infoframe *frame =
344 &infoframe->data.avi;
345 bool is_limited_range = conn_state->hdmi.is_limited_range;
346 enum hdmi_quantization_range rgb_quant_range =
347 is_limited_range ? HDMI_QUANTIZATION_RANGE_LIMITED : HDMI_QUANTIZATION_RANGE_FULL;
350 ret = drm_hdmi_avi_infoframe_from_display_mode(frame, connector, mode);
354 frame->colorspace = conn_state->hdmi.output_format;
357 * FIXME: drm_hdmi_avi_infoframe_quant_range() doesn't handle
358 * YUV formats at all at the moment, so if we ever support YUV
359 * formats this needs to be revised.
361 drm_hdmi_avi_infoframe_quant_range(frame, connector, mode, rgb_quant_range);
362 drm_hdmi_avi_infoframe_colorimetry(frame, conn_state);
363 drm_hdmi_avi_infoframe_bars(frame, conn_state);
365 infoframe->set = true;
370 static int hdmi_generate_spd_infoframe(const struct drm_connector *connector,
371 struct drm_connector_state *conn_state)
373 struct drm_connector_hdmi_infoframe *infoframe =
374 &conn_state->hdmi.infoframes.spd;
375 struct hdmi_spd_infoframe *frame =
376 &infoframe->data.spd;
379 ret = hdmi_spd_infoframe_init(frame,
380 connector->hdmi.vendor,
381 connector->hdmi.product);
385 frame->sdi = HDMI_SPD_SDI_PC;
387 infoframe->set = true;
392 static int hdmi_generate_hdr_infoframe(const struct drm_connector *connector,
393 struct drm_connector_state *conn_state)
395 struct drm_connector_hdmi_infoframe *infoframe =
396 &conn_state->hdmi.infoframes.hdr_drm;
397 struct hdmi_drm_infoframe *frame =
398 &infoframe->data.drm;
401 if (connector->max_bpc < 10)
404 if (!conn_state->hdr_output_metadata)
407 ret = drm_hdmi_infoframe_set_hdr_metadata(frame, conn_state);
411 infoframe->set = true;
416 static int hdmi_generate_hdmi_vendor_infoframe(const struct drm_connector *connector,
417 struct drm_connector_state *conn_state)
419 const struct drm_display_info *info = &connector->display_info;
420 const struct drm_display_mode *mode =
421 connector_state_get_mode(conn_state);
422 struct drm_connector_hdmi_infoframe *infoframe =
423 &conn_state->hdmi.infoframes.hdmi;
424 struct hdmi_vendor_infoframe *frame =
425 &infoframe->data.vendor.hdmi;
428 if (!info->has_hdmi_infoframe)
431 ret = drm_hdmi_vendor_infoframe_from_display_mode(frame, connector, mode);
435 infoframe->set = true;
441 hdmi_generate_infoframes(const struct drm_connector *connector,
442 struct drm_connector_state *conn_state)
444 const struct drm_display_info *info = &connector->display_info;
450 ret = hdmi_generate_avi_infoframe(connector, conn_state);
454 ret = hdmi_generate_spd_infoframe(connector, conn_state);
459 * Audio Infoframes will be generated by ALSA, and updated by
460 * drm_atomic_helper_connector_hdmi_update_audio_infoframe().
463 ret = hdmi_generate_hdr_infoframe(connector, conn_state);
467 ret = hdmi_generate_hdmi_vendor_infoframe(connector, conn_state);
475 * drm_atomic_helper_connector_hdmi_check() - Helper to check HDMI connector atomic state
476 * @connector: DRM Connector
477 * @state: the DRM State object
479 * Provides a default connector state check handler for HDMI connectors.
480 * Checks that a desired connector update is valid, and updates various
481 * fields of derived state.
484 * Zero on success, or an errno code otherwise.
486 int drm_atomic_helper_connector_hdmi_check(struct drm_connector *connector,
487 struct drm_atomic_state *state)
489 struct drm_connector_state *old_conn_state =
490 drm_atomic_get_old_connector_state(state, connector);
491 struct drm_connector_state *new_conn_state =
492 drm_atomic_get_new_connector_state(state, connector);
493 const struct drm_display_mode *mode =
494 connector_state_get_mode(new_conn_state);
497 new_conn_state->hdmi.is_limited_range = hdmi_is_limited_range(connector, new_conn_state);
499 ret = hdmi_compute_config(connector, new_conn_state, mode);
503 ret = hdmi_generate_infoframes(connector, new_conn_state);
507 if (old_conn_state->hdmi.broadcast_rgb != new_conn_state->hdmi.broadcast_rgb ||
508 old_conn_state->hdmi.output_bpc != new_conn_state->hdmi.output_bpc ||
509 old_conn_state->hdmi.output_format != new_conn_state->hdmi.output_format) {
510 struct drm_crtc *crtc = new_conn_state->crtc;
511 struct drm_crtc_state *crtc_state;
513 crtc_state = drm_atomic_get_crtc_state(state, crtc);
514 if (IS_ERR(crtc_state))
515 return PTR_ERR(crtc_state);
517 crtc_state->mode_changed = true;
522 EXPORT_SYMBOL(drm_atomic_helper_connector_hdmi_check);
524 static int clear_device_infoframe(struct drm_connector *connector,
525 enum hdmi_infoframe_type type)
527 const struct drm_connector_hdmi_funcs *funcs = connector->hdmi.funcs;
528 struct drm_device *dev = connector->dev;
531 drm_dbg_kms(dev, "Clearing infoframe type 0x%x\n", type);
533 if (!funcs || !funcs->clear_infoframe) {
534 drm_dbg_kms(dev, "Function not implemented, bailing.\n");
538 ret = funcs->clear_infoframe(connector, type);
540 drm_dbg_kms(dev, "Call failed: %d\n", ret);
547 static int clear_infoframe(struct drm_connector *connector,
548 struct drm_connector_hdmi_infoframe *old_frame)
552 ret = clear_device_infoframe(connector, old_frame->data.any.type);
559 static int write_device_infoframe(struct drm_connector *connector,
560 union hdmi_infoframe *frame)
562 const struct drm_connector_hdmi_funcs *funcs = connector->hdmi.funcs;
563 struct drm_device *dev = connector->dev;
564 u8 buffer[HDMI_INFOFRAME_SIZE(MAX)];
568 drm_dbg_kms(dev, "Writing infoframe type %x\n", frame->any.type);
570 if (!funcs || !funcs->write_infoframe) {
571 drm_dbg_kms(dev, "Function not implemented, bailing.\n");
575 len = hdmi_infoframe_pack(frame, buffer, sizeof(buffer));
579 ret = funcs->write_infoframe(connector, frame->any.type, buffer, len);
581 drm_dbg_kms(dev, "Call failed: %d\n", ret);
588 static int write_infoframe(struct drm_connector *connector,
589 struct drm_connector_hdmi_infoframe *new_frame)
593 ret = write_device_infoframe(connector, &new_frame->data);
600 static int write_or_clear_infoframe(struct drm_connector *connector,
601 struct drm_connector_hdmi_infoframe *old_frame,
602 struct drm_connector_hdmi_infoframe *new_frame)
605 return write_infoframe(connector, new_frame);
607 if (old_frame->set && !new_frame->set)
608 return clear_infoframe(connector, old_frame);
614 * drm_atomic_helper_connector_hdmi_update_infoframes - Update the Infoframes
615 * @connector: A pointer to the HDMI connector
616 * @state: The HDMI connector state to generate the infoframe from
618 * This function is meant for HDMI connector drivers to write their
619 * infoframes. It will typically be used in a
620 * @drm_connector_helper_funcs.atomic_enable implementation.
623 * Zero on success, error code on failure.
625 int drm_atomic_helper_connector_hdmi_update_infoframes(struct drm_connector *connector,
626 struct drm_atomic_state *state)
628 struct drm_connector_state *old_conn_state =
629 drm_atomic_get_old_connector_state(state, connector);
630 struct drm_connector_state *new_conn_state =
631 drm_atomic_get_new_connector_state(state, connector);
632 struct drm_display_info *info = &connector->display_info;
638 mutex_lock(&connector->hdmi.infoframes.lock);
640 ret = write_or_clear_infoframe(connector,
641 &old_conn_state->hdmi.infoframes.avi,
642 &new_conn_state->hdmi.infoframes.avi);
646 if (connector->hdmi.infoframes.audio.set) {
647 ret = write_infoframe(connector,
648 &connector->hdmi.infoframes.audio);
653 ret = write_or_clear_infoframe(connector,
654 &old_conn_state->hdmi.infoframes.hdr_drm,
655 &new_conn_state->hdmi.infoframes.hdr_drm);
659 ret = write_or_clear_infoframe(connector,
660 &old_conn_state->hdmi.infoframes.spd,
661 &new_conn_state->hdmi.infoframes.spd);
665 if (info->has_hdmi_infoframe) {
666 ret = write_or_clear_infoframe(connector,
667 &old_conn_state->hdmi.infoframes.hdmi,
668 &new_conn_state->hdmi.infoframes.hdmi);
674 mutex_unlock(&connector->hdmi.infoframes.lock);
677 EXPORT_SYMBOL(drm_atomic_helper_connector_hdmi_update_infoframes);
680 * drm_atomic_helper_connector_hdmi_update_audio_infoframe - Update the Audio Infoframe
681 * @connector: A pointer to the HDMI connector
682 * @frame: A pointer to the audio infoframe to write
684 * This function is meant for HDMI connector drivers to update their
685 * audio infoframe. It will typically be used in one of the ALSA hooks
686 * (most likely prepare).
689 * Zero on success, error code on failure.
692 drm_atomic_helper_connector_hdmi_update_audio_infoframe(struct drm_connector *connector,
693 struct hdmi_audio_infoframe *frame)
695 struct drm_connector_hdmi_infoframe *infoframe =
696 &connector->hdmi.infoframes.audio;
697 struct drm_display_info *info = &connector->display_info;
703 mutex_lock(&connector->hdmi.infoframes.lock);
705 memcpy(&infoframe->data, frame, sizeof(infoframe->data));
706 infoframe->set = true;
708 ret = write_infoframe(connector, infoframe);
710 mutex_unlock(&connector->hdmi.infoframes.lock);
714 EXPORT_SYMBOL(drm_atomic_helper_connector_hdmi_update_audio_infoframe);
717 * drm_atomic_helper_connector_hdmi_clear_audio_infoframe - Stop sending the Audio Infoframe
718 * @connector: A pointer to the HDMI connector
720 * This function is meant for HDMI connector drivers to stop sending their
721 * audio infoframe. It will typically be used in one of the ALSA hooks
722 * (most likely shutdown).
725 * Zero on success, error code on failure.
728 drm_atomic_helper_connector_hdmi_clear_audio_infoframe(struct drm_connector *connector)
730 struct drm_connector_hdmi_infoframe *infoframe =
731 &connector->hdmi.infoframes.audio;
732 struct drm_display_info *info = &connector->display_info;
738 mutex_lock(&connector->hdmi.infoframes.lock);
740 infoframe->set = false;
742 ret = clear_infoframe(connector, infoframe);
744 memset(&infoframe->data, 0, sizeof(infoframe->data));
746 mutex_unlock(&connector->hdmi.infoframes.lock);
750 EXPORT_SYMBOL(drm_atomic_helper_connector_hdmi_clear_audio_infoframe);