1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright 2010 Matt Turner. 4 * Copyright 2012 Red Hat 5 * 6 * Authors: Matthew Garrett 7 * Matt Turner 8 * Dave Airlie 9 */ 10 #ifndef __MGAG200_DRV_H__ 11 #define __MGAG200_DRV_H__ 12 13 #include <video/vga.h> 14 15 #include <drm/drm_connector.h> 16 #include <drm/drm_crtc.h> 17 #include <drm/drm_encoder.h> 18 #include <drm/drm_gem.h> 19 #include <drm/drm_gem_shmem_helper.h> 20 #include <drm/drm_plane.h> 21 22 #include "mgag200_reg.h" 23 24 #define DRIVER_AUTHOR "Matthew Garrett" 25 26 #define DRIVER_NAME "mgag200" 27 #define DRIVER_DESC "MGA G200 SE" 28 #define DRIVER_DATE "20110418" 29 30 #define DRIVER_MAJOR 1 31 #define DRIVER_MINOR 0 32 #define DRIVER_PATCHLEVEL 0 33 34 #define RREG8(reg) ioread8(((void __iomem *)mdev->rmmio) + (reg)) 35 #define WREG8(reg, v) iowrite8(v, ((void __iomem *)mdev->rmmio) + (reg)) 36 #define RREG32(reg) ioread32(((void __iomem *)mdev->rmmio) + (reg)) 37 #define WREG32(reg, v) iowrite32(v, ((void __iomem *)mdev->rmmio) + (reg)) 38 39 #define MGA_BIOS_OFFSET 0x7ffc 40 41 #define ATTR_INDEX 0x1fc0 42 #define ATTR_DATA 0x1fc1 43 44 #define WREG_MISC(v) \ 45 WREG8(MGA_MISC_OUT, v) 46 47 #define RREG_MISC(v) \ 48 ((v) = RREG8(MGA_MISC_IN)) 49 50 #define WREG_MISC_MASKED(v, mask) \ 51 do { \ 52 u8 misc_; \ 53 u8 mask_ = (mask); \ 54 RREG_MISC(misc_); \ 55 misc_ &= ~mask_; \ 56 misc_ |= ((v) & mask_); \ 57 WREG_MISC(misc_); \ 58 } while (0) 59 60 #define WREG_ATTR(reg, v) \ 61 do { \ 62 RREG8(0x1fda); \ 63 WREG8(ATTR_INDEX, reg); \ 64 WREG8(ATTR_DATA, v); \ 65 } while (0) \ 66 67 #define RREG_SEQ(reg, v) \ 68 do { \ 69 WREG8(MGAREG_SEQ_INDEX, reg); \ 70 v = RREG8(MGAREG_SEQ_DATA); \ 71 } while (0) \ 72 73 #define WREG_SEQ(reg, v) \ 74 do { \ 75 WREG8(MGAREG_SEQ_INDEX, reg); \ 76 WREG8(MGAREG_SEQ_DATA, v); \ 77 } while (0) \ 78 79 #define RREG_CRT(reg, v) \ 80 do { \ 81 WREG8(MGAREG_CRTC_INDEX, reg); \ 82 v = RREG8(MGAREG_CRTC_DATA); \ 83 } while (0) \ 84 85 #define WREG_CRT(reg, v) \ 86 do { \ 87 WREG8(MGAREG_CRTC_INDEX, reg); \ 88 WREG8(MGAREG_CRTC_DATA, v); \ 89 } while (0) \ 90 91 #define RREG_ECRT(reg, v) \ 92 do { \ 93 WREG8(MGAREG_CRTCEXT_INDEX, reg); \ 94 v = RREG8(MGAREG_CRTCEXT_DATA); \ 95 } while (0) \ 96 97 #define WREG_ECRT(reg, v) \ 98 do { \ 99 WREG8(MGAREG_CRTCEXT_INDEX, reg); \ 100 WREG8(MGAREG_CRTCEXT_DATA, v); \ 101 } while (0) \ 102 103 #define GFX_INDEX 0x1fce 104 #define GFX_DATA 0x1fcf 105 106 #define WREG_GFX(reg, v) \ 107 do { \ 108 WREG8(GFX_INDEX, reg); \ 109 WREG8(GFX_DATA, v); \ 110 } while (0) \ 111 112 #define DAC_INDEX 0x3c00 113 #define DAC_DATA 0x3c0a 114 115 #define WREG_DAC(reg, v) \ 116 do { \ 117 WREG8(DAC_INDEX, reg); \ 118 WREG8(DAC_DATA, v); \ 119 } while (0) \ 120 121 #define MGA_MISC_OUT 0x1fc2 122 #define MGA_MISC_IN 0x1fcc 123 124 /* 125 * TODO: This is a pretty large set of default values for all kinds of 126 * settings. It should be split and set in the various DRM helpers, 127 * such as the CRTC reset or atomic_enable helpers. The PLL values 128 * probably belong to each model's PLL code. 129 */ 130 #define MGAG200_DAC_DEFAULT(xvrefctrl, xpixclkctrl, xmiscctrl, xsyspllm, xsysplln, xsyspllp) \ 131 /* 0x00: */ 0, 0, 0, 0, 0, 0, 0x00, 0, \ 132 /* 0x08: */ 0, 0, 0, 0, 0, 0, 0, 0, \ 133 /* 0x10: */ 0, 0, 0, 0, 0, 0, 0, 0, \ 134 /* 0x18: */ (xvrefctrl), \ 135 /* 0x19: */ 0, \ 136 /* 0x1a: */ (xpixclkctrl), \ 137 /* 0x1b: */ 0xff, 0xbf, 0x20, \ 138 /* 0x1e: */ (xmiscctrl), \ 139 /* 0x1f: */ 0x20, \ 140 /* 0x20: */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ 141 /* 0x28: */ 0x00, 0x00, 0x00, 0x00, \ 142 /* 0x2c: */ (xsyspllm), \ 143 /* 0x2d: */ (xsysplln), \ 144 /* 0x2e: */ (xsyspllp), \ 145 /* 0x2f: */ 0x40, \ 146 /* 0x30: */ 0x00, 0xb0, 0x00, 0xc2, 0x34, 0x14, 0x02, 0x83, \ 147 /* 0x38: */ 0x00, 0x93, 0x00, 0x77, 0x00, 0x00, 0x00, 0x3a, \ 148 /* 0x40: */ 0, 0, 0, 0, 0, 0, 0, 0, \ 149 /* 0x48: */ 0, 0, 0, 0, 0, 0, 0, 0 \ 150 151 #define MGAG200_LUT_SIZE 256 152 153 #define MGAG200_MAX_FB_HEIGHT 4096 154 #define MGAG200_MAX_FB_WIDTH 4096 155 156 struct mga_device; 157 158 /* 159 * Stores parameters for programming the PLLs 160 * 161 * Fref: reference frequency (A: 25.175 Mhz, B: 28.361, C: XX Mhz) 162 * Fo: output frequency 163 * Fvco = Fref * (N / M) 164 * Fo = Fvco / P 165 * 166 * S = [0..3] 167 */ 168 struct mgag200_pll_values { 169 unsigned int m; 170 unsigned int n; 171 unsigned int p; 172 unsigned int s; 173 }; 174 175 struct mgag200_crtc_state { 176 struct drm_crtc_state base; 177 178 /* Primary-plane format; required for modesetting and color mgmt. */ 179 const struct drm_format_info *format; 180 181 struct mgag200_pll_values pixpllc; 182 }; 183 184 static inline struct mgag200_crtc_state *to_mgag200_crtc_state(struct drm_crtc_state *base) 185 { 186 return container_of(base, struct mgag200_crtc_state, base); 187 } 188 189 enum mga_type { 190 G200_PCI, 191 G200_AGP, 192 G200_SE_A, 193 G200_SE_B, 194 G200_WB, 195 G200_EV, 196 G200_EH, 197 G200_EH3, 198 G200_ER, 199 G200_EW3, 200 }; 201 202 struct mgag200_device_info { 203 u16 max_hdisplay; 204 u16 max_vdisplay; 205 206 /* 207 * Maximum memory bandwidth (MiB/sec). Setting this to zero disables 208 * the rsp test during mode validation. 209 */ 210 unsigned long max_mem_bandwidth; 211 212 /* HW has external source (e.g., BMC) to synchronize with */ 213 bool has_vidrst:1; 214 215 struct { 216 unsigned data_bit:3; 217 unsigned clock_bit:3; 218 } i2c; 219 220 /* 221 * HW does not handle 'startadd' register correctly. Always set 222 * it's value to 0. 223 */ 224 bool bug_no_startadd:1; 225 }; 226 227 #define MGAG200_DEVICE_INFO_INIT(_max_hdisplay, _max_vdisplay, _max_mem_bandwidth, \ 228 _has_vidrst, _i2c_data_bit, _i2c_clock_bit, \ 229 _bug_no_startadd) \ 230 { \ 231 .max_hdisplay = (_max_hdisplay), \ 232 .max_vdisplay = (_max_vdisplay), \ 233 .max_mem_bandwidth = (_max_mem_bandwidth), \ 234 .has_vidrst = (_has_vidrst), \ 235 .i2c = { \ 236 .data_bit = (_i2c_data_bit), \ 237 .clock_bit = (_i2c_clock_bit), \ 238 }, \ 239 .bug_no_startadd = (_bug_no_startadd), \ 240 } 241 242 struct mgag200_device_funcs { 243 /* 244 * Disables an external reset source (i.e., BMC) before programming 245 * a new display mode. 246 */ 247 void (*disable_vidrst)(struct mga_device *mdev); 248 249 /* 250 * Enables an external reset source (i.e., BMC) after programming 251 * a new display mode. 252 */ 253 void (*enable_vidrst)(struct mga_device *mdev); 254 255 /* 256 * Validate that the given state can be programmed into PIXPLLC. On 257 * success, the calculated parameters should be stored in the CRTC's 258 * state in struct @mgag200_crtc_state.pixpllc. 259 */ 260 int (*pixpllc_atomic_check)(struct drm_crtc *crtc, struct drm_atomic_state *new_state); 261 262 /* 263 * Program PIXPLLC from the CRTC state. The parameters should have been 264 * stored in struct @mgag200_crtc_state.pixpllc by the corresponding 265 * implementation of @pixpllc_atomic_check. 266 */ 267 void (*pixpllc_atomic_update)(struct drm_crtc *crtc, struct drm_atomic_state *old_state); 268 }; 269 270 struct mga_device { 271 struct drm_device base; 272 273 const struct mgag200_device_info *info; 274 const struct mgag200_device_funcs *funcs; 275 276 struct resource *rmmio_res; 277 void __iomem *rmmio; 278 struct mutex rmmio_lock; /* Protects access to rmmio */ 279 280 struct resource *vram_res; 281 void __iomem *vram; 282 resource_size_t vram_available; 283 284 struct drm_plane primary_plane; 285 struct drm_crtc crtc; 286 struct drm_encoder encoder; 287 struct drm_connector connector; 288 }; 289 290 static inline struct mga_device *to_mga_device(struct drm_device *dev) 291 { 292 return container_of(dev, struct mga_device, base); 293 } 294 295 struct mgag200_g200_device { 296 struct mga_device base; 297 298 /* PLL constants */ 299 long ref_clk; 300 long pclk_min; 301 long pclk_max; 302 }; 303 304 static inline struct mgag200_g200_device *to_mgag200_g200_device(struct drm_device *dev) 305 { 306 return container_of(to_mga_device(dev), struct mgag200_g200_device, base); 307 } 308 309 struct mgag200_g200se_device { 310 struct mga_device base; 311 312 /* SE model number stored in reg 0x1e24 */ 313 u32 unique_rev_id; 314 }; 315 316 static inline struct mgag200_g200se_device *to_mgag200_g200se_device(struct drm_device *dev) 317 { 318 return container_of(to_mga_device(dev), struct mgag200_g200se_device, base); 319 } 320 321 /* mgag200_drv.c */ 322 int mgag200_init_pci_options(struct pci_dev *pdev, u32 option, u32 option2); 323 resource_size_t mgag200_probe_vram(void __iomem *mem, resource_size_t size); 324 resource_size_t mgag200_device_probe_vram(struct mga_device *mdev); 325 int mgag200_device_preinit(struct mga_device *mdev); 326 int mgag200_device_init(struct mga_device *mdev, 327 const struct mgag200_device_info *info, 328 const struct mgag200_device_funcs *funcs); 329 330 /* mgag200_<device type>.c */ 331 struct mga_device *mgag200_g200_device_create(struct pci_dev *pdev, const struct drm_driver *drv); 332 struct mga_device *mgag200_g200se_device_create(struct pci_dev *pdev, const struct drm_driver *drv, 333 enum mga_type type); 334 void mgag200_g200wb_init_registers(struct mga_device *mdev); 335 void mgag200_g200wb_pixpllc_atomic_update(struct drm_crtc *crtc, struct drm_atomic_state *old_state); 336 struct mga_device *mgag200_g200wb_device_create(struct pci_dev *pdev, const struct drm_driver *drv); 337 struct mga_device *mgag200_g200ev_device_create(struct pci_dev *pdev, const struct drm_driver *drv); 338 void mgag200_g200eh_init_registers(struct mga_device *mdev); 339 void mgag200_g200eh_pixpllc_atomic_update(struct drm_crtc *crtc, struct drm_atomic_state *old_state); 340 struct mga_device *mgag200_g200eh_device_create(struct pci_dev *pdev, 341 const struct drm_driver *drv); 342 struct mga_device *mgag200_g200eh3_device_create(struct pci_dev *pdev, 343 const struct drm_driver *drv); 344 struct mga_device *mgag200_g200er_device_create(struct pci_dev *pdev, 345 const struct drm_driver *drv); 346 struct mga_device *mgag200_g200ew3_device_create(struct pci_dev *pdev, 347 const struct drm_driver *drv); 348 349 /* 350 * mgag200_mode.c 351 */ 352 353 struct drm_crtc; 354 struct drm_crtc_state; 355 struct drm_display_mode; 356 struct drm_plane; 357 struct drm_atomic_state; 358 struct drm_scanout_buffer; 359 360 extern const uint32_t mgag200_primary_plane_formats[]; 361 extern const size_t mgag200_primary_plane_formats_size; 362 extern const uint64_t mgag200_primary_plane_fmtmods[]; 363 364 int mgag200_primary_plane_helper_atomic_check(struct drm_plane *plane, 365 struct drm_atomic_state *new_state); 366 void mgag200_primary_plane_helper_atomic_update(struct drm_plane *plane, 367 struct drm_atomic_state *old_state); 368 void mgag200_primary_plane_helper_atomic_enable(struct drm_plane *plane, 369 struct drm_atomic_state *state); 370 void mgag200_primary_plane_helper_atomic_disable(struct drm_plane *plane, 371 struct drm_atomic_state *old_state); 372 int mgag200_primary_plane_helper_get_scanout_buffer(struct drm_plane *plane, 373 struct drm_scanout_buffer *sb); 374 375 #define MGAG200_PRIMARY_PLANE_HELPER_FUNCS \ 376 DRM_GEM_SHADOW_PLANE_HELPER_FUNCS, \ 377 .atomic_check = mgag200_primary_plane_helper_atomic_check, \ 378 .atomic_update = mgag200_primary_plane_helper_atomic_update, \ 379 .atomic_enable = mgag200_primary_plane_helper_atomic_enable, \ 380 .atomic_disable = mgag200_primary_plane_helper_atomic_disable, \ 381 .get_scanout_buffer = mgag200_primary_plane_helper_get_scanout_buffer 382 383 #define MGAG200_PRIMARY_PLANE_FUNCS \ 384 .update_plane = drm_atomic_helper_update_plane, \ 385 .disable_plane = drm_atomic_helper_disable_plane, \ 386 .destroy = drm_plane_cleanup, \ 387 DRM_GEM_SHADOW_PLANE_FUNCS 388 389 void mgag200_crtc_set_gamma_linear(struct mga_device *mdev, const struct drm_format_info *format); 390 void mgag200_crtc_set_gamma(struct mga_device *mdev, 391 const struct drm_format_info *format, 392 struct drm_color_lut *lut); 393 394 enum drm_mode_status mgag200_crtc_helper_mode_valid(struct drm_crtc *crtc, 395 const struct drm_display_mode *mode); 396 int mgag200_crtc_helper_atomic_check(struct drm_crtc *crtc, struct drm_atomic_state *new_state); 397 void mgag200_crtc_helper_atomic_flush(struct drm_crtc *crtc, struct drm_atomic_state *old_state); 398 void mgag200_crtc_helper_atomic_enable(struct drm_crtc *crtc, struct drm_atomic_state *old_state); 399 void mgag200_crtc_helper_atomic_disable(struct drm_crtc *crtc, struct drm_atomic_state *old_state); 400 401 #define MGAG200_CRTC_HELPER_FUNCS \ 402 .mode_valid = mgag200_crtc_helper_mode_valid, \ 403 .atomic_check = mgag200_crtc_helper_atomic_check, \ 404 .atomic_flush = mgag200_crtc_helper_atomic_flush, \ 405 .atomic_enable = mgag200_crtc_helper_atomic_enable, \ 406 .atomic_disable = mgag200_crtc_helper_atomic_disable 407 408 void mgag200_crtc_reset(struct drm_crtc *crtc); 409 struct drm_crtc_state *mgag200_crtc_atomic_duplicate_state(struct drm_crtc *crtc); 410 void mgag200_crtc_atomic_destroy_state(struct drm_crtc *crtc, struct drm_crtc_state *crtc_state); 411 412 #define MGAG200_CRTC_FUNCS \ 413 .reset = mgag200_crtc_reset, \ 414 .destroy = drm_crtc_cleanup, \ 415 .set_config = drm_atomic_helper_set_config, \ 416 .page_flip = drm_atomic_helper_page_flip, \ 417 .atomic_duplicate_state = mgag200_crtc_atomic_duplicate_state, \ 418 .atomic_destroy_state = mgag200_crtc_atomic_destroy_state 419 420 #define MGAG200_DAC_ENCODER_FUNCS \ 421 .destroy = drm_encoder_cleanup 422 423 #define MGAG200_VGA_CONNECTOR_HELPER_FUNCS \ 424 .get_modes = drm_connector_helper_get_modes 425 426 #define MGAG200_VGA_CONNECTOR_FUNCS \ 427 .reset = drm_atomic_helper_connector_reset, \ 428 .fill_modes = drm_helper_probe_single_connector_modes, \ 429 .destroy = drm_connector_cleanup, \ 430 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state, \ 431 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state 432 433 void mgag200_set_mode_regs(struct mga_device *mdev, const struct drm_display_mode *mode); 434 void mgag200_set_format_regs(struct mga_device *mdev, const struct drm_format_info *format); 435 void mgag200_enable_display(struct mga_device *mdev); 436 void mgag200_init_registers(struct mga_device *mdev); 437 int mgag200_mode_config_init(struct mga_device *mdev, resource_size_t vram_available); 438 439 /* mgag200_bmc.c */ 440 void mgag200_bmc_disable_vidrst(struct mga_device *mdev); 441 void mgag200_bmc_enable_vidrst(struct mga_device *mdev); 442 443 #endif /* __MGAG200_DRV_H__ */ 444