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