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