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