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 drm_device *drm,
  74                               struct vc4_hdmi *vc4_hdmi);
  75
  76         /* Callback to reset the HDMI block */
  77         void (*reset)(struct vc4_hdmi *vc4_hdmi);
  78
  79         /* Callback to enable / disable the CSC */
  80         void (*csc_setup)(struct vc4_hdmi *vc4_hdmi,
  81                           struct drm_connector_state *state,
  82                           const struct drm_display_mode *mode);
  83
  84         /* Callback to configure the video timings in the HDMI block */
  85         void (*set_timings)(struct vc4_hdmi *vc4_hdmi,
  86                             struct drm_connector_state *state,
  87                             struct drm_display_mode *mode);
  88
  89         /* Callback to initialize the PHY according to the connector state */
  90         void (*phy_init)(struct vc4_hdmi *vc4_hdmi,
  91                          struct vc4_hdmi_connector_state *vc4_conn_state);
  92
  93         /* Callback to disable the PHY */
  94         void (*phy_disable)(struct vc4_hdmi *vc4_hdmi);
  95
  96         /* Callback to enable the RNG in the PHY */
  97         void (*phy_rng_enable)(struct vc4_hdmi *vc4_hdmi);
  98
  99         /* Callback to disable the RNG in the PHY */
 100         void (*phy_rng_disable)(struct vc4_hdmi *vc4_hdmi);
 101
 102         /* Callback to get channel map */
 103         u32 (*channel_map)(struct vc4_hdmi *vc4_hdmi, u32 channel_mask);
 104
 105         /* Enables HDR metadata */
 106         bool supports_hdr;
 107
 108         /* Callback for hardware specific hotplug detect */
 109         bool (*hp_detect)(struct vc4_hdmi *vc4_hdmi);
 110 };
 111
 112 /* HDMI audio information */
 113 struct vc4_hdmi_audio {
 114         struct snd_soc_card card;
 115         struct snd_soc_dai_link link;
 116         struct snd_soc_dai_link_component cpu;
 117         struct snd_soc_dai_link_component codec;
 118         struct snd_soc_dai_link_component platform;
 119         struct snd_dmaengine_dai_dma_data dma_data;
 120         struct hdmi_audio_infoframe infoframe;
 121         struct platform_device *codec_pdev;
 122         bool streaming;
 123 };
 124
 125 enum vc4_hdmi_output_format {
 126         VC4_HDMI_OUTPUT_RGB,
 127         VC4_HDMI_OUTPUT_YUV422,
 128         VC4_HDMI_OUTPUT_YUV444,
 129         VC4_HDMI_OUTPUT_YUV420,
 130 };
 131
 132 /* General HDMI hardware state. */
 133 struct vc4_hdmi {
 134         struct vc4_hdmi_audio audio;
 135
 136         struct platform_device *pdev;
 137         const struct vc4_hdmi_variant *variant;
 138
 139         struct vc4_hdmi_encoder encoder;
 140         struct drm_connector connector;
 141
 142         struct delayed_work scrambling_work;
 143
 144         struct drm_property *broadcast_rgb_property;
 145
 146         struct i2c_adapter *ddc;
 147         void __iomem *hdmicore_regs;
 148         void __iomem *hd_regs;
 149
 150         /* VC5 Only */
 151         void __iomem *cec_regs;
 152         /* VC5 Only */
 153         void __iomem *csc_regs;
 154         /* VC5 Only */
 155         void __iomem *dvp_regs;
 156         /* VC5 Only */
 157         void __iomem *phy_regs;
 158         /* VC5 Only */
 159         void __iomem *ram_regs;
 160         /* VC5 Only */
 161         void __iomem *rm_regs;
 162
 163         struct gpio_desc *hpd_gpio;
 164
 165         /*
 166          * On some systems (like the RPi4), some modes are in the same
 167          * frequency range than the WiFi channels (1440p@60Hz for
 168          * example). Should we take evasive actions because that system
 169          * has a wifi adapter?
 170          */
 171         bool disable_wifi_frequencies;
 172
 173         struct cec_adapter *cec_adap;
 174         struct cec_msg cec_rx_msg;
 175         bool cec_tx_ok;
 176         bool cec_irq_was_rx;
 177
 178         struct clk *cec_clock;
 179         struct clk *pixel_clock;
 180         struct clk *hsm_clock;
 181         struct clk *audio_clock;
 182         struct clk *pixel_bvb_clock;
 183
 184         struct reset_control *reset;
 185
 186         struct debugfs_regset32 hdmi_regset;
 187         struct debugfs_regset32 hd_regset;
 188
 189         /**
 190          * @hw_lock: Spinlock protecting device register access.
 191          */
 192         spinlock_t hw_lock;
 193
 194         /**
 195          * @mutex: Mutex protecting the driver access across multiple
 196          * frameworks (KMS, ALSA).
 197          *
 198          * NOTE: While supported, CEC has been left out since
 199          * cec_s_phys_addr_from_edid() might call .adap_enable and lead to a
 200          * reentrancy issue between .get_modes (or .detect) and .adap_enable.
 201          * Since we don't share any state between the CEC hooks and KMS', it's
 202          * not a big deal. The only trouble might come from updating the CEC
 203          * clock divider which might be affected by a modeset, but CEC should
 204          * be resilient to that.
 205          */
 206         struct mutex mutex;
 207
 208         /**
 209          * @saved_adjusted_mode: Copy of @drm_crtc_state.adjusted_mode
 210          * for use by ALSA hooks and interrupt handlers. Protected by @mutex.
 211          */
 212         struct drm_display_mode saved_adjusted_mode;
 213
 214         /**
 215          * @output_enabled: Is the HDMI controller currently active?
 216          * Protected by @mutex.
 217          */
 218         bool output_enabled;
 219
 220         /**
 221          * @scdc_enabled: Is the HDMI controller currently running with
 222          * the scrambler on? Protected by @mutex.
 223          */
 224         bool scdc_enabled;
 225
 226         /**
 227          * @output_bpc: Copy of @vc4_connector_state.output_bpc for use
 228          * outside of KMS hooks. Protected by @mutex.
 229          */
 230         unsigned int output_bpc;
 231
 232         /**
 233          * @output_format: Copy of @vc4_connector_state.output_format
 234          * for use outside of KMS hooks. Protected by @mutex.
 235          */
 236         enum vc4_hdmi_output_format output_format;
 237
 238         /**
 239          * @broadcast_rgb: Copy of @vc4_connector_state.broadcast_rgb
 240          * for use outside of KMS hooks. Protected by @mutex.
 241          */
 242         int broadcast_rgb;
 243
 244         /* VC5 debugfs regset */
 245         struct debugfs_regset32 cec_regset;
 246         struct debugfs_regset32 csc_regset;
 247         struct debugfs_regset32 dvp_regset;
 248         struct debugfs_regset32 phy_regset;
 249         struct debugfs_regset32 ram_regset;
 250         struct debugfs_regset32 rm_regset;
 251 };
 252
 253 static inline struct vc4_hdmi *
 254 connector_to_vc4_hdmi(struct drm_connector *connector)
 255 {
 256         return container_of(connector, struct vc4_hdmi, connector);
 257 }
 258
 259 static inline struct vc4_hdmi *
 260 encoder_to_vc4_hdmi(struct drm_encoder *encoder)
 261 {
 262         struct vc4_hdmi_encoder *_encoder = to_vc4_hdmi_encoder(encoder);
 263
 264         return container_of(_encoder, struct vc4_hdmi, encoder);
 265 }
 266
 267 struct vc4_hdmi_connector_state {
 268         struct drm_connector_state      base;
 269         unsigned long long              pixel_rate;
 270         unsigned int                    output_bpc;
 271         enum vc4_hdmi_output_format     output_format;
 272         int                             broadcast_rgb;
 273 };
 274
 275 static inline struct vc4_hdmi_connector_state *
 276 conn_state_to_vc4_hdmi_conn_state(struct drm_connector_state *conn_state)
 277 {
 278         return container_of(conn_state, struct vc4_hdmi_connector_state, base);
 279 }
 280
 281 static inline const struct vc4_hdmi_connector_state *
 282 const_conn_state_to_vc4_hdmi_conn_state(const struct drm_connector_state *conn_state)
 283 {
 284         return container_of(conn_state, struct vc4_hdmi_connector_state, base);
 285 }
 286
 287 void vc4_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
 288                        struct vc4_hdmi_connector_state *vc4_conn_state);
 289 void vc4_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
 290 void vc4_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
 291 void vc4_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
 292
 293 void vc5_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
 294                        struct vc4_hdmi_connector_state *vc4_conn_state);
 295 void vc5_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
 296 void vc5_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
 297 void vc5_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
 298
 299 #endif /* _VC4_HDMI_H_ */