drivers/gpu/drm/vc4/vc4_hdmi.h

   1 #ifndef _VC4_HDMI_H_
   2 #define _VC4_HDMI_H_
   3
   4 #include <drm/drm_connector.h>
   5 #include <media/cec.h>
   6 #include <sound/dmaengine_pcm.h>
   7 #include <sound/soc.h>
   8
   9 #include "vc4_drv.h"
  10
  11 /* VC4 HDMI encoder KMS struct */
  12 struct vc4_hdmi_encoder {
  13         struct vc4_encoder base;
  14         bool hdmi_monitor;
  15 };
  16
  17 static inline struct vc4_hdmi_encoder *
  18 to_vc4_hdmi_encoder(struct drm_encoder *encoder)
  19 {
  20         return container_of(encoder, struct vc4_hdmi_encoder, base.base);
  21 }
  22
  23 struct vc4_hdmi;
  24 struct vc4_hdmi_register;
  25 struct vc4_hdmi_connector_state;
  26
  27 enum vc4_hdmi_phy_channel {
  28         PHY_LANE_0 = 0,
  29         PHY_LANE_1,
  30         PHY_LANE_2,
  31         PHY_LANE_CK,
  32 };
  33
  34 struct vc4_hdmi_variant {
  35         /* Encoder Type for that controller */
  36         enum vc4_encoder_type encoder_type;
  37
  38         /* ALSA card name */
  39         const char *card_name;
  40
  41         /* Filename to expose the registers in debugfs */
  42         const char *debugfs_name;
  43
  44         /* Maximum pixel clock supported by the controller (in Hz) */
  45         unsigned long long max_pixel_clock;
  46
  47         /* List of the registers available on that variant */
  48         const struct vc4_hdmi_register *registers;
  49
  50         /* Number of registers on that variant */
  51         unsigned int num_registers;
  52
  53         /* BCM2711 Only.
  54          * The variants don't map the lane in the same order in the
  55          * PHY, so this is an array mapping the HDMI channel (index)
  56          * to the PHY lane (value).
  57          */
  58         enum vc4_hdmi_phy_channel phy_lane_mapping[4];
  59
  60         /* The BCM2711 cannot deal with odd horizontal pixel timings */
  61         bool unsupported_odd_h_timings;
  62
  63         /*
  64          * The BCM2711 CEC/hotplug IRQ controller is shared between the
  65          * two HDMI controllers, and we have a proper irqchip driver for
  66          * it.
  67          */
  68         bool external_irq_controller;
  69
  70         /* Callback to get the resources (memory region, interrupts,
  71          * clocks, etc) for that variant.
  72          */
  73         int (*init_resources)(struct vc4_hdmi *vc4_hdmi);
  74
  75         /* Callback to reset the HDMI block */
  76         void (*reset)(struct vc4_hdmi *vc4_hdmi);
  77
  78         /* Callback to enable / disable the CSC */
  79         void (*csc_setup)(struct vc4_hdmi *vc4_hdmi,
  80                           struct drm_connector_state *state,
  81                           const struct drm_display_mode *mode);
  82
  83         /* Callback to configure the video timings in the HDMI block */
  84         void (*set_timings)(struct vc4_hdmi *vc4_hdmi,
  85                             struct drm_connector_state *state,
  86                             struct drm_display_mode *mode);
  87
  88         /* Callback to initialize the PHY according to the connector state */
  89         void (*phy_init)(struct vc4_hdmi *vc4_hdmi,
  90                          struct vc4_hdmi_connector_state *vc4_conn_state);
  91
  92         /* Callback to disable the PHY */
  93         void (*phy_disable)(struct vc4_hdmi *vc4_hdmi);
  94
  95         /* Callback to enable the RNG in the PHY */
  96         void (*phy_rng_enable)(struct vc4_hdmi *vc4_hdmi);
  97
  98         /* Callback to disable the RNG in the PHY */
  99         void (*phy_rng_disable)(struct vc4_hdmi *vc4_hdmi);
 100
 101         /* Callback to get channel map */
 102         u32 (*channel_map)(struct vc4_hdmi *vc4_hdmi, u32 channel_mask);
 103
 104         /* Enables HDR metadata */
 105         bool supports_hdr;
 106
 107         /* Callback for hardware specific hotplug detect */
 108         bool (*hp_detect)(struct vc4_hdmi *vc4_hdmi);
 109 };
 110
 111 /* HDMI audio information */
 112 struct vc4_hdmi_audio {
 113         struct snd_soc_card card;
 114         struct snd_soc_dai_link link;
 115         struct snd_soc_dai_link_component cpu;
 116         struct snd_soc_dai_link_component codec;
 117         struct snd_soc_dai_link_component platform;
 118         struct snd_dmaengine_dai_dma_data dma_data;
 119         struct hdmi_audio_infoframe infoframe;
 120         struct platform_device *codec_pdev;
 121         bool streaming;
 122 };
 123
 124 enum vc4_hdmi_output_format {
 125         VC4_HDMI_OUTPUT_RGB,
 126         VC4_HDMI_OUTPUT_YUV422,
 127         VC4_HDMI_OUTPUT_YUV444,
 128         VC4_HDMI_OUTPUT_YUV420,
 129 };
 130
 131 /* General HDMI hardware state. */
 132 struct vc4_hdmi {
 133         struct vc4_hdmi_audio audio;
 134
 135         struct platform_device *pdev;
 136         const struct vc4_hdmi_variant *variant;
 137
 138         struct vc4_hdmi_encoder encoder;
 139         struct drm_connector connector;
 140
 141         struct delayed_work scrambling_work;
 142
 143         struct i2c_adapter *ddc;
 144         void __iomem *hdmicore_regs;
 145         void __iomem *hd_regs;
 146
 147         /* VC5 Only */
 148         void __iomem *cec_regs;
 149         /* VC5 Only */
 150         void __iomem *csc_regs;
 151         /* VC5 Only */
 152         void __iomem *dvp_regs;
 153         /* VC5 Only */
 154         void __iomem *phy_regs;
 155         /* VC5 Only */
 156         void __iomem *ram_regs;
 157         /* VC5 Only */
 158         void __iomem *rm_regs;
 159
 160         struct gpio_desc *hpd_gpio;
 161
 162         /*
 163          * On some systems (like the RPi4), some modes are in the same
 164          * frequency range than the WiFi channels (1440p@60Hz for
 165          * example). Should we take evasive actions because that system
 166          * has a wifi adapter?
 167          */
 168         bool disable_wifi_frequencies;
 169
 170         /*
 171          * Even if HDMI0 on the RPi4 can output modes requiring a pixel
 172          * rate higher than 297MHz, it needs some adjustments in the
 173          * config.txt file to be able to do so and thus won't always be
 174          * available.
 175          */
 176         bool disable_4kp60;
 177
 178         struct cec_adapter *cec_adap;
 179         struct cec_msg cec_rx_msg;
 180         bool cec_tx_ok;
 181         bool cec_irq_was_rx;
 182
 183         struct clk *cec_clock;
 184         struct clk *pixel_clock;
 185         struct clk *hsm_clock;
 186         struct clk *audio_clock;
 187         struct clk *pixel_bvb_clock;
 188
 189         struct reset_control *reset;
 190
 191         struct debugfs_regset32 hdmi_regset;
 192         struct debugfs_regset32 hd_regset;
 193
 194         /**
 195          * @hw_lock: Spinlock protecting device register access.
 196          */
 197         spinlock_t hw_lock;
 198
 199         /**
 200          * @mutex: Mutex protecting the driver access across multiple
 201          * frameworks (KMS, ALSA).
 202          *
 203          * NOTE: While supported, CEC has been left out since
 204          * cec_s_phys_addr_from_edid() might call .adap_enable and lead to a
 205          * reentrancy issue between .get_modes (or .detect) and .adap_enable.
 206          * Since we don't share any state between the CEC hooks and KMS', it's
 207          * not a big deal. The only trouble might come from updating the CEC
 208          * clock divider which might be affected by a modeset, but CEC should
 209          * be resilient to that.
 210          */
 211         struct mutex mutex;
 212
 213         /**
 214          * @saved_adjusted_mode: Copy of @drm_crtc_state.adjusted_mode
 215          * for use by ALSA hooks and interrupt handlers. Protected by @mutex.
 216          */
 217         struct drm_display_mode saved_adjusted_mode;
 218
 219         /**
 220          * @output_enabled: Is the HDMI controller currently active?
 221          * Protected by @mutex.
 222          */
 223         bool output_enabled;
 224
 225         /**
 226          * @scdc_enabled: Is the HDMI controller currently running with
 227          * the scrambler on? Protected by @mutex.
 228          */
 229         bool scdc_enabled;
 230
 231         /**
 232          * @output_bpc: Copy of @vc4_connector_state.output_bpc for use
 233          * outside of KMS hooks. Protected by @mutex.
 234          */
 235         unsigned int output_bpc;
 236
 237         /**
 238          * @output_format: Copy of @vc4_connector_state.output_format
 239          * for use outside of KMS hooks. Protected by @mutex.
 240          */
 241         enum vc4_hdmi_output_format output_format;
 242
 243         /* VC5 debugfs regset */
 244         struct debugfs_regset32 cec_regset;
 245         struct debugfs_regset32 csc_regset;
 246         struct debugfs_regset32 dvp_regset;
 247         struct debugfs_regset32 phy_regset;
 248         struct debugfs_regset32 ram_regset;
 249         struct debugfs_regset32 rm_regset;
 250 };
 251
 252 static inline struct vc4_hdmi *
 253 connector_to_vc4_hdmi(struct drm_connector *connector)
 254 {
 255         return container_of(connector, struct vc4_hdmi, connector);
 256 }
 257
 258 static inline struct vc4_hdmi *
 259 encoder_to_vc4_hdmi(struct drm_encoder *encoder)
 260 {
 261         struct vc4_hdmi_encoder *_encoder = to_vc4_hdmi_encoder(encoder);
 262
 263         return container_of(_encoder, struct vc4_hdmi, encoder);
 264 }
 265
 266 struct vc4_hdmi_connector_state {
 267         struct drm_connector_state      base;
 268         unsigned long long              pixel_rate;
 269         unsigned int                    output_bpc;
 270         enum vc4_hdmi_output_format     output_format;
 271 };
 272
 273 static inline struct vc4_hdmi_connector_state *
 274 conn_state_to_vc4_hdmi_conn_state(struct drm_connector_state *conn_state)
 275 {
 276         return container_of(conn_state, struct vc4_hdmi_connector_state, base);
 277 }
 278
 279 void vc4_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
 280                        struct vc4_hdmi_connector_state *vc4_conn_state);
 281 void vc4_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
 282 void vc4_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
 283 void vc4_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
 284
 285 void vc5_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
 286                        struct vc4_hdmi_connector_state *vc4_conn_state);
 287 void vc5_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
 288 void vc5_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
 289 void vc5_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
 290
 291 #endif /* _VC4_HDMI_H_ */