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