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 };
  15
  16 static inline struct vc4_hdmi_encoder *
  17 to_vc4_hdmi_encoder(struct drm_encoder *encoder)
  18 {
  19         return container_of(encoder, struct vc4_hdmi_encoder, base.base);
  20 }
  21
  22 struct vc4_hdmi;
  23 struct vc4_hdmi_register;
  24 struct vc4_hdmi_connector_state;
  25
  26 enum vc4_hdmi_phy_channel {
  27         PHY_LANE_0 = 0,
  28         PHY_LANE_1,
  29         PHY_LANE_2,
  30         PHY_LANE_CK,
  31 };
  32
  33 struct vc4_hdmi_variant {
  34         /* Encoder Type for that controller */
  35         enum vc4_encoder_type encoder_type;
  36
  37         /* ALSA card name */
  38         const char *card_name;
  39
  40         /* Filename to expose the registers in debugfs */
  41         const char *debugfs_name;
  42
  43         /* Maximum pixel clock supported by the controller (in Hz) */
  44         unsigned long long max_pixel_clock;
  45
  46         /* List of the registers available on that variant */
  47         const struct vc4_hdmi_register *registers;
  48
  49         /* Number of registers on that variant */
  50         unsigned int num_registers;
  51
  52         /* BCM2711 Only.
  53          * The variants don't map the lane in the same order in the
  54          * PHY, so this is an array mapping the HDMI channel (index)
  55          * to the PHY lane (value).
  56          */
  57         enum vc4_hdmi_phy_channel phy_lane_mapping[4];
  58
  59         /* The BCM2711 cannot deal with odd horizontal pixel timings */
  60         bool unsupported_odd_h_timings;
  61
  62         /*
  63          * The BCM2711 CEC/hotplug IRQ controller is shared between the
  64          * two HDMI controllers, and we have a proper irqchip driver for
  65          * it.
  66          */
  67         bool external_irq_controller;
  68
  69         /* Callback to get the resources (memory region, interrupts,
  70          * clocks, etc) for that variant.
  71          */
  72         int (*init_resources)(struct drm_device *drm,
  73                               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 drm_property *broadcast_rgb_property;
 144
 145         struct i2c_adapter *ddc;
 146         void __iomem *hdmicore_regs;
 147         void __iomem *hd_regs;
 148
 149         /* VC5 Only */
 150         void __iomem *cec_regs;
 151         /* VC5 Only */
 152         void __iomem *csc_regs;
 153         /* VC5 Only */
 154         void __iomem *dvp_regs;
 155         /* VC5 Only */
 156         void __iomem *phy_regs;
 157         /* VC5 Only */
 158         void __iomem *ram_regs;
 159         /* VC5 Only */
 160         void __iomem *rm_regs;
 161
 162         struct gpio_desc *hpd_gpio;
 163
 164         /*
 165          * On some systems (like the RPi4), some modes are in the same
 166          * frequency range than the WiFi channels (1440p@60Hz for
 167          * example). Should we take evasive actions because that system
 168          * has a wifi adapter?
 169          */
 170         bool disable_wifi_frequencies;
 171
 172         struct cec_adapter *cec_adap;
 173         struct cec_msg cec_rx_msg;
 174         bool cec_tx_ok;
 175         bool cec_irq_was_rx;
 176
 177         struct clk *cec_clock;
 178         struct clk *pixel_clock;
 179         struct clk *hsm_clock;
 180         struct clk *audio_clock;
 181         struct clk *pixel_bvb_clock;
 182
 183         struct reset_control *reset;
 184
 185         struct debugfs_regset32 hdmi_regset;
 186         struct debugfs_regset32 hd_regset;
 187
 188         /**
 189          * @hw_lock: Spinlock protecting device register access.
 190          */
 191         spinlock_t hw_lock;
 192
 193         /**
 194          * @mutex: Mutex protecting the driver access across multiple
 195          * frameworks (KMS, ALSA).
 196          *
 197          * NOTE: While supported, CEC has been left out since
 198          * cec_s_phys_addr_from_edid() might call .adap_enable and lead to a
 199          * reentrancy issue between .get_modes (or .detect) and .adap_enable.
 200          * Since we don't share any state between the CEC hooks and KMS', it's
 201          * not a big deal. The only trouble might come from updating the CEC
 202          * clock divider which might be affected by a modeset, but CEC should
 203          * be resilient to that.
 204          */
 205         struct mutex mutex;
 206
 207         /**
 208          * @saved_adjusted_mode: Copy of @drm_crtc_state.adjusted_mode
 209          * for use by ALSA hooks and interrupt handlers. Protected by @mutex.
 210          */
 211         struct drm_display_mode saved_adjusted_mode;
 212
 213         /**
 214          * @output_enabled: Is the HDMI controller currently active?
 215          * Protected by @mutex.
 216          */
 217         bool output_enabled;
 218
 219         /**
 220          * @scdc_enabled: Is the HDMI controller currently running with
 221          * the scrambler on? Protected by @mutex.
 222          */
 223         bool scdc_enabled;
 224
 225         /**
 226          * @output_bpc: Copy of @vc4_connector_state.output_bpc for use
 227          * outside of KMS hooks. Protected by @mutex.
 228          */
 229         unsigned int output_bpc;
 230
 231         /**
 232          * @output_format: Copy of @vc4_connector_state.output_format
 233          * for use outside of KMS hooks. Protected by @mutex.
 234          */
 235         enum vc4_hdmi_output_format output_format;
 236
 237         /**
 238          * @broadcast_rgb: Copy of @vc4_connector_state.broadcast_rgb
 239          * for use outside of KMS hooks. Protected by @mutex.
 240          */
 241         int broadcast_rgb;
 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         int                             broadcast_rgb;
 272 };
 273
 274 static inline struct vc4_hdmi_connector_state *
 275 conn_state_to_vc4_hdmi_conn_state(struct drm_connector_state *conn_state)
 276 {
 277         return container_of(conn_state, struct vc4_hdmi_connector_state, base);
 278 }
 279
 280 static inline const struct vc4_hdmi_connector_state *
 281 const_conn_state_to_vc4_hdmi_conn_state(const struct drm_connector_state *conn_state)
 282 {
 283         return container_of(conn_state, struct vc4_hdmi_connector_state, base);
 284 }
 285
 286 void vc4_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
 287                        struct vc4_hdmi_connector_state *vc4_conn_state);
 288 void vc4_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
 289 void vc4_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
 290 void vc4_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
 291
 292 void vc5_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
 293                        struct vc4_hdmi_connector_state *vc4_conn_state);
 294 void vc5_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
 295 void vc5_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
 296 void vc5_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
 297
 298 #endif /* _VC4_HDMI_H_ */