drivers/gpu/drm/qxl/qxl_drv.h

   1 /*
   2  * Copyright 2013 Red Hat Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Authors: Dave Airlie
  23  *          Alon Levy
  24  */
  25
  26
  27 #ifndef QXL_DRV_H
  28 #define QXL_DRV_H
  29
  30 /*
  31  * Definitions taken from spice-protocol, plus kernel driver specific bits.
  32  */
  33
  34 #include <linux/fence.h>
  35 #include <linux/workqueue.h>
  36 #include <linux/firmware.h>
  37 #include <linux/platform_device.h>
  38
  39 #include "drmP.h"
  40 #include "drm_crtc.h"
  41 #include <ttm/ttm_bo_api.h>
  42 #include <ttm/ttm_bo_driver.h>
  43 #include <ttm/ttm_placement.h>
  44 #include <ttm/ttm_module.h>
  45
  46 /* just for ttm_validate_buffer */
  47 #include <ttm/ttm_execbuf_util.h>
  48
  49 #include <drm/qxl_drm.h>
  50 #include "qxl_dev.h"
  51
  52 #define DRIVER_AUTHOR           "Dave Airlie"
  53
  54 #define DRIVER_NAME             "qxl"
  55 #define DRIVER_DESC             "RH QXL"
  56 #define DRIVER_DATE             "20120117"
  57
  58 #define DRIVER_MAJOR 0
  59 #define DRIVER_MINOR 1
  60 #define DRIVER_PATCHLEVEL 0
  61
  62 #define QXL_DEBUGFS_MAX_COMPONENTS              32
  63
  64 extern int qxl_log_level;
  65 extern int qxl_num_crtc;
  66
  67 enum {
  68         QXL_INFO_LEVEL = 1,
  69         QXL_DEBUG_LEVEL = 2,
  70 };
  71
  72 #define QXL_INFO(qdev, fmt, ...) do { \
  73                 if (qxl_log_level >= QXL_INFO_LEVEL) {  \
  74                         qxl_io_log(qdev, fmt, __VA_ARGS__); \
  75                 }       \
  76         } while (0)
  77 #define QXL_DEBUG(qdev, fmt, ...) do { \
  78                 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \
  79                         qxl_io_log(qdev, fmt, __VA_ARGS__); \
  80                 }       \
  81         } while (0)
  82 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \
  83                 static int done;                \
  84                 if (!done) {                    \
  85                         done = 1;                       \
  86                         QXL_INFO(qdev, fmt, __VA_ARGS__);       \
  87                 }                                               \
  88         } while (0)
  89
  90 #define DRM_FILE_OFFSET 0x100000000ULL
  91 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
  92
  93 #define QXL_INTERRUPT_MASK (\
  94         QXL_INTERRUPT_DISPLAY |\
  95         QXL_INTERRUPT_CURSOR |\
  96         QXL_INTERRUPT_IO_CMD |\
  97         QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
  98
  99 struct qxl_bo {
 100         /* Protected by gem.mutex */
 101         struct list_head                list;
 102         /* Protected by tbo.reserved */
 103         struct ttm_place                placements[3];
 104         struct ttm_placement            placement;
 105         struct ttm_buffer_object        tbo;
 106         struct ttm_bo_kmap_obj          kmap;
 107         unsigned                        pin_count;
 108         void                            *kptr;
 109         int                             type;
 110
 111         /* Constant after initialization */
 112         struct drm_gem_object           gem_base;
 113         bool is_primary; /* is this now a primary surface */
 114         bool hw_surf_alloc;
 115         struct qxl_surface surf;
 116         uint32_t surface_id;
 117         struct qxl_release *surf_create;
 118 };
 119 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
 120 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
 121
 122 struct qxl_gem {
 123         struct mutex            mutex;
 124         struct list_head        objects;
 125 };
 126
 127 struct qxl_bo_list {
 128         struct ttm_validate_buffer tv;
 129 };
 130
 131 struct qxl_crtc {
 132         struct drm_crtc base;
 133         int index;
 134         int cur_x;
 135         int cur_y;
 136 };
 137
 138 struct qxl_output {
 139         int index;
 140         struct drm_connector base;
 141         struct drm_encoder enc;
 142 };
 143
 144 struct qxl_framebuffer {
 145         struct drm_framebuffer base;
 146         struct drm_gem_object *obj;
 147 };
 148
 149 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
 150 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
 151 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
 152 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
 153
 154 struct qxl_mman {
 155         struct ttm_bo_global_ref        bo_global_ref;
 156         struct drm_global_reference     mem_global_ref;
 157         bool                            mem_global_referenced;
 158         struct ttm_bo_device            bdev;
 159 };
 160
 161 struct qxl_mode_info {
 162         int num_modes;
 163         struct qxl_mode *modes;
 164         bool mode_config_initialized;
 165
 166         /* pointer to fbdev info structure */
 167         struct qxl_fbdev *qfbdev;
 168 };
 169
 170
 171 struct qxl_memslot {
 172         uint8_t         generation;
 173         uint64_t        start_phys_addr;
 174         uint64_t        end_phys_addr;
 175         uint64_t        high_bits;
 176 };
 177
 178 enum {
 179         QXL_RELEASE_DRAWABLE,
 180         QXL_RELEASE_SURFACE_CMD,
 181         QXL_RELEASE_CURSOR_CMD,
 182 };
 183
 184 /* drm_ prefix to differentiate from qxl_release_info in
 185  * spice-protocol/qxl_dev.h */
 186 #define QXL_MAX_RES 96
 187 struct qxl_release {
 188         struct fence base;
 189
 190         int id;
 191         int type;
 192         uint32_t release_offset;
 193         uint32_t surface_release_id;
 194         struct ww_acquire_ctx ticket;
 195         struct list_head bos;
 196 };
 197
 198 struct qxl_drm_chunk {
 199         struct list_head head;
 200         struct qxl_bo *bo;
 201 };
 202
 203 struct qxl_drm_image {
 204         struct qxl_bo *bo;
 205         struct list_head chunk_list;
 206 };
 207
 208 struct qxl_fb_image {
 209         struct qxl_device *qdev;
 210         uint32_t pseudo_palette[16];
 211         struct fb_image fb_image;
 212         uint32_t visual;
 213 };
 214
 215 struct qxl_draw_fill {
 216         struct qxl_device *qdev;
 217         struct qxl_rect rect;
 218         uint32_t color;
 219         uint16_t rop;
 220 };
 221
 222 /*
 223  * Debugfs
 224  */
 225 struct qxl_debugfs {
 226         struct drm_info_list    *files;
 227         unsigned                num_files;
 228 };
 229
 230 int qxl_debugfs_add_files(struct qxl_device *rdev,
 231                              struct drm_info_list *files,
 232                              unsigned nfiles);
 233 int qxl_debugfs_fence_init(struct qxl_device *rdev);
 234 void qxl_debugfs_remove_files(struct qxl_device *qdev);
 235
 236 struct qxl_device;
 237
 238 struct qxl_device {
 239         struct device                   *dev;
 240         struct drm_device               *ddev;
 241         struct pci_dev                  *pdev;
 242         unsigned long flags;
 243
 244         resource_size_t vram_base, vram_size;
 245         resource_size_t surfaceram_base, surfaceram_size;
 246         resource_size_t rom_base, rom_size;
 247         struct qxl_rom *rom;
 248
 249         struct qxl_mode *modes;
 250         struct qxl_bo *monitors_config_bo;
 251         struct qxl_monitors_config *monitors_config;
 252
 253         /* last received client_monitors_config */
 254         struct qxl_monitors_config *client_monitors_config;
 255
 256         int io_base;
 257         void *ram;
 258         struct qxl_mman         mman;
 259         struct qxl_gem          gem;
 260         struct qxl_mode_info mode_info;
 261
 262         struct fb_info                  *fbdev_info;
 263         struct qxl_framebuffer  *fbdev_qfb;
 264         void *ram_physical;
 265
 266         struct qxl_ring *release_ring;
 267         struct qxl_ring *command_ring;
 268         struct qxl_ring *cursor_ring;
 269
 270         struct qxl_ram_header *ram_header;
 271
 272         bool primary_created;
 273
 274         struct qxl_memslot      *mem_slots;
 275         uint8_t         n_mem_slots;
 276
 277         uint8_t         main_mem_slot;
 278         uint8_t         surfaces_mem_slot;
 279         uint8_t         slot_id_bits;
 280         uint8_t         slot_gen_bits;
 281         uint64_t        va_slot_mask;
 282
 283         spinlock_t      release_lock;
 284         struct idr      release_idr;
 285         uint32_t        release_seqno;
 286         spinlock_t release_idr_lock;
 287         struct mutex    async_io_mutex;
 288         unsigned int last_sent_io_cmd;
 289
 290         /* interrupt handling */
 291         atomic_t irq_received;
 292         atomic_t irq_received_display;
 293         atomic_t irq_received_cursor;
 294         atomic_t irq_received_io_cmd;
 295         unsigned irq_received_error;
 296         wait_queue_head_t display_event;
 297         wait_queue_head_t cursor_event;
 298         wait_queue_head_t io_cmd_event;
 299         struct work_struct client_monitors_config_work;
 300
 301         /* debugfs */
 302         struct qxl_debugfs      debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
 303         unsigned                debugfs_count;
 304
 305         struct mutex            update_area_mutex;
 306
 307         struct idr      surf_id_idr;
 308         spinlock_t surf_id_idr_lock;
 309         int last_alloced_surf_id;
 310
 311         struct mutex surf_evict_mutex;
 312         struct io_mapping *vram_mapping;
 313         struct io_mapping *surface_mapping;
 314
 315         /* */
 316         struct mutex release_mutex;
 317         struct qxl_bo *current_release_bo[3];
 318         int current_release_bo_offset[3];
 319
 320         struct workqueue_struct *gc_queue;
 321         struct work_struct gc_work;
 322
 323         struct work_struct fb_work;
 324
 325         struct drm_property *hotplug_mode_update_property;
 326 };
 327
 328 /* forward declaration for QXL_INFO_IO */
 329 void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...);
 330
 331 extern const struct drm_ioctl_desc qxl_ioctls[];
 332 extern int qxl_max_ioctl;
 333
 334 int qxl_driver_load(struct drm_device *dev, unsigned long flags);
 335 int qxl_driver_unload(struct drm_device *dev);
 336
 337 int qxl_modeset_init(struct qxl_device *qdev);
 338 void qxl_modeset_fini(struct qxl_device *qdev);
 339
 340 int qxl_bo_init(struct qxl_device *qdev);
 341 void qxl_bo_fini(struct qxl_device *qdev);
 342
 343 void qxl_reinit_memslots(struct qxl_device *qdev);
 344 int qxl_surf_evict(struct qxl_device *qdev);
 345 int qxl_vram_evict(struct qxl_device *qdev);
 346
 347 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
 348                                  int element_size,
 349                                  int n_elements,
 350                                  int prod_notify,
 351                                  bool set_prod_notify,
 352                                  wait_queue_head_t *push_event);
 353 void qxl_ring_free(struct qxl_ring *ring);
 354 void qxl_ring_init_hdr(struct qxl_ring *ring);
 355 int qxl_check_idle(struct qxl_ring *ring);
 356
 357 static inline void *
 358 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical)
 359 {
 360         QXL_INFO(qdev, "not implemented (%lu)\n", physical);
 361         return 0;
 362 }
 363
 364 static inline uint64_t
 365 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
 366                         unsigned long offset)
 367 {
 368         int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
 369         struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
 370
 371         /* TODO - need to hold one of the locks to read tbo.offset */
 372         return slot->high_bits | (bo->tbo.offset + offset);
 373 }
 374
 375 /* qxl_fb.c */
 376 #define QXLFB_CONN_LIMIT 1
 377
 378 int qxl_fbdev_init(struct qxl_device *qdev);
 379 void qxl_fbdev_fini(struct qxl_device *qdev);
 380 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
 381                                   struct drm_file *file_priv,
 382                                   uint32_t *handle);
 383 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state);
 384
 385 /* qxl_display.c */
 386 int
 387 qxl_framebuffer_init(struct drm_device *dev,
 388                      struct qxl_framebuffer *rfb,
 389                      struct drm_mode_fb_cmd2 *mode_cmd,
 390                      struct drm_gem_object *obj);
 391 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
 392 void qxl_send_monitors_config(struct qxl_device *qdev);
 393 int qxl_create_monitors_object(struct qxl_device *qdev);
 394 int qxl_destroy_monitors_object(struct qxl_device *qdev);
 395
 396 /* used by qxl_debugfs only */
 397 void qxl_crtc_set_from_monitors_config(struct qxl_device *qdev);
 398 void qxl_alloc_client_monitors_config(struct qxl_device *qdev, unsigned count);
 399
 400 /* qxl_gem.c */
 401 int qxl_gem_init(struct qxl_device *qdev);
 402 void qxl_gem_fini(struct qxl_device *qdev);
 403 int qxl_gem_object_create(struct qxl_device *qdev, int size,
 404                           int alignment, int initial_domain,
 405                           bool discardable, bool kernel,
 406                           struct qxl_surface *surf,
 407                           struct drm_gem_object **obj);
 408 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
 409                                       struct drm_file *file_priv,
 410                                       u32 domain,
 411                                       size_t size,
 412                                       struct qxl_surface *surf,
 413                                       struct qxl_bo **qobj,
 414                                       uint32_t *handle);
 415 void qxl_gem_object_free(struct drm_gem_object *gobj);
 416 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
 417 void qxl_gem_object_close(struct drm_gem_object *obj,
 418                           struct drm_file *file_priv);
 419 void qxl_bo_force_delete(struct qxl_device *qdev);
 420 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
 421
 422 /* qxl_dumb.c */
 423 int qxl_mode_dumb_create(struct drm_file *file_priv,
 424                          struct drm_device *dev,
 425                          struct drm_mode_create_dumb *args);
 426 int qxl_mode_dumb_mmap(struct drm_file *filp,
 427                        struct drm_device *dev,
 428                        uint32_t handle, uint64_t *offset_p);
 429
 430
 431 /* qxl ttm */
 432 int qxl_ttm_init(struct qxl_device *qdev);
 433 void qxl_ttm_fini(struct qxl_device *qdev);
 434 int qxl_mmap(struct file *filp, struct vm_area_struct *vma);
 435
 436 /* qxl image */
 437
 438 int qxl_image_init(struct qxl_device *qdev,
 439                    struct qxl_release *release,
 440                    struct qxl_drm_image *dimage,
 441                    const uint8_t *data,
 442                    int x, int y, int width, int height,
 443                    int depth, int stride);
 444 int
 445 qxl_image_alloc_objects(struct qxl_device *qdev,
 446                         struct qxl_release *release,
 447                         struct qxl_drm_image **image_ptr,
 448                         int height, int stride);
 449 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
 450
 451 void qxl_update_screen(struct qxl_device *qxl);
 452
 453 /* qxl io operations (qxl_cmd.c) */
 454
 455 void qxl_io_create_primary(struct qxl_device *qdev,
 456                            unsigned offset,
 457                            struct qxl_bo *bo);
 458 void qxl_io_destroy_primary(struct qxl_device *qdev);
 459 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
 460 void qxl_io_notify_oom(struct qxl_device *qdev);
 461
 462 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
 463                        const struct qxl_rect *area);
 464
 465 void qxl_io_reset(struct qxl_device *qdev);
 466 void qxl_io_monitors_config(struct qxl_device *qdev);
 467 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
 468 void qxl_io_flush_release(struct qxl_device *qdev);
 469 void qxl_io_flush_surfaces(struct qxl_device *qdev);
 470
 471 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
 472                                         struct qxl_release *release);
 473 void qxl_release_unmap(struct qxl_device *qdev,
 474                        struct qxl_release *release,
 475                        union qxl_release_info *info);
 476 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
 477 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
 478 void qxl_release_backoff_reserve_list(struct qxl_release *release);
 479 void qxl_release_fence_buffer_objects(struct qxl_release *release);
 480
 481 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
 482                                        enum qxl_surface_cmd_type surface_cmd_type,
 483                                        struct qxl_release *create_rel,
 484                                        struct qxl_release **release);
 485 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
 486                                int type, struct qxl_release **release,
 487                                struct qxl_bo **rbo);
 488
 489 int
 490 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
 491                               uint32_t type, bool interruptible);
 492 int
 493 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
 494                              uint32_t type, bool interruptible);
 495 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
 496                           struct qxl_release *release,
 497                           unsigned long size,
 498                           struct qxl_bo **_bo);
 499 /* qxl drawing commands */
 500
 501 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
 502                         int stride /* filled in if 0 */);
 503
 504 void qxl_draw_dirty_fb(struct qxl_device *qdev,
 505                        struct qxl_framebuffer *qxl_fb,
 506                        struct qxl_bo *bo,
 507                        unsigned flags, unsigned color,
 508                        struct drm_clip_rect *clips,
 509                        unsigned num_clips, int inc);
 510
 511 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
 512
 513 void qxl_draw_copyarea(struct qxl_device *qdev,
 514                        u32 width, u32 height,
 515                        u32 sx, u32 sy,
 516                        u32 dx, u32 dy);
 517
 518 void qxl_release_free(struct qxl_device *qdev,
 519                       struct qxl_release *release);
 520
 521 /* used by qxl_debugfs_release */
 522 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
 523                                                    uint64_t id);
 524
 525 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
 526 int qxl_garbage_collect(struct qxl_device *qdev);
 527
 528 /* debugfs */
 529
 530 int qxl_debugfs_init(struct drm_minor *minor);
 531 void qxl_debugfs_takedown(struct drm_minor *minor);
 532
 533 /* qxl_irq.c */
 534 int qxl_irq_init(struct qxl_device *qdev);
 535 irqreturn_t qxl_irq_handler(int irq, void *arg);
 536
 537 /* qxl_fb.c */
 538 int qxl_fb_init(struct qxl_device *qdev);
 539 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);
 540
 541 int qxl_debugfs_add_files(struct qxl_device *qdev,
 542                           struct drm_info_list *files,
 543                           unsigned nfiles);
 544
 545 int qxl_surface_id_alloc(struct qxl_device *qdev,
 546                          struct qxl_bo *surf);
 547 void qxl_surface_id_dealloc(struct qxl_device *qdev,
 548                             uint32_t surface_id);
 549 int qxl_hw_surface_alloc(struct qxl_device *qdev,
 550                          struct qxl_bo *surf,
 551                          struct ttm_mem_reg *mem);
 552 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
 553                            struct qxl_bo *surf);
 554
 555 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
 556
 557 struct qxl_drv_surface *
 558 qxl_surface_lookup(struct drm_device *dev, int surface_id);
 559 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
 560 int qxl_update_surface(struct qxl_device *qdev, struct qxl_bo *surf);
 561
 562 #endif