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 #ifndef QXL_DRV_H
  27 #define QXL_DRV_H
  28
  29 /*
  30  * Definitions taken from spice-protocol, plus kernel driver specific bits.
  31  */
  32
  33 #include <linux/dma-buf-map.h>
  34 #include <linux/dma-fence.h>
  35 #include <linux/firmware.h>
  36 #include <linux/platform_device.h>
  37 #include <linux/workqueue.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_ttm_helper.h>
  43 #include <drm/drm_ioctl.h>
  44 #include <drm/drm_gem.h>
  45 #include <drm/qxl_drm.h>
  46 #include <drm/ttm/ttm_bo_api.h>
  47 #include <drm/ttm/ttm_bo_driver.h>
  48 #include <drm/ttm/ttm_execbuf_util.h>
  49 #include <drm/ttm/ttm_module.h>
  50 #include <drm/ttm/ttm_placement.h>
  51
  52 #include "qxl_dev.h"
  53
  54 struct dma_buf_map;
  55
  56 #define DRIVER_AUTHOR           "Dave Airlie"
  57
  58 #define DRIVER_NAME             "qxl"
  59 #define DRIVER_DESC             "RH QXL"
  60 #define DRIVER_DATE             "20120117"
  61
  62 #define DRIVER_MAJOR 0
  63 #define DRIVER_MINOR 1
  64 #define DRIVER_PATCHLEVEL 0
  65
  66 #define QXL_DEBUGFS_MAX_COMPONENTS              32
  67
  68 extern int qxl_num_crtc;
  69 extern int qxl_max_ioctls;
  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         struct ttm_buffer_object        tbo;
  79
  80         /* Protected by gem.mutex */
  81         struct list_head                list;
  82         /* Protected by tbo.reserved */
  83         struct ttm_place                placements[3];
  84         struct ttm_placement            placement;
  85         struct dma_buf_map              map;
  86         void                            *kptr;
  87         unsigned int                    map_count;
  88         int                             type;
  89
  90         /* Constant after initialization */
  91         unsigned int is_primary:1; /* is this now a primary surface */
  92         unsigned int is_dumb:1;
  93         struct qxl_bo *shadow;
  94         unsigned int hw_surf_alloc:1;
  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, tbo.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 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
 125 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
 126 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
 127
 128 struct qxl_mman {
 129         struct ttm_bo_device            bdev;
 130 };
 131
 132 struct qxl_memslot {
 133         int             index;
 134         const char      *name;
 135         uint8_t         generation;
 136         uint64_t        start_phys_addr;
 137         uint64_t        size;
 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 /*
 173  * Debugfs
 174  */
 175 struct qxl_debugfs {
 176         struct drm_info_list    *files;
 177         unsigned int num_files;
 178 };
 179
 180 struct qxl_device {
 181         struct drm_device ddev;
 182
 183         resource_size_t vram_base, vram_size;
 184         resource_size_t surfaceram_base, surfaceram_size;
 185         resource_size_t rom_base, rom_size;
 186         struct qxl_rom *rom;
 187
 188         struct qxl_mode *modes;
 189         struct qxl_bo *monitors_config_bo;
 190         struct qxl_monitors_config *monitors_config;
 191
 192         /* last received client_monitors_config */
 193         struct qxl_monitors_config *client_monitors_config;
 194
 195         int io_base;
 196         void *ram;
 197         struct qxl_mman         mman;
 198         struct qxl_gem          gem;
 199
 200         void *ram_physical;
 201
 202         struct qxl_ring *release_ring;
 203         struct qxl_ring *command_ring;
 204         struct qxl_ring *cursor_ring;
 205
 206         struct qxl_ram_header *ram_header;
 207
 208         struct qxl_bo *primary_bo;
 209         struct qxl_bo *dumb_shadow_bo;
 210         struct qxl_head *dumb_heads;
 211
 212         struct qxl_memslot main_slot;
 213         struct qxl_memslot surfaces_slot;
 214
 215         spinlock_t      release_lock;
 216         struct idr      release_idr;
 217         uint32_t        release_seqno;
 218         spinlock_t release_idr_lock;
 219         struct mutex    async_io_mutex;
 220         unsigned int last_sent_io_cmd;
 221
 222         /* interrupt handling */
 223         atomic_t irq_received;
 224         atomic_t irq_received_display;
 225         atomic_t irq_received_cursor;
 226         atomic_t irq_received_io_cmd;
 227         unsigned int irq_received_error;
 228         wait_queue_head_t display_event;
 229         wait_queue_head_t cursor_event;
 230         wait_queue_head_t io_cmd_event;
 231         struct work_struct client_monitors_config_work;
 232
 233         /* debugfs */
 234         struct qxl_debugfs      debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
 235         unsigned int debugfs_count;
 236
 237         struct mutex            update_area_mutex;
 238
 239         struct idr      surf_id_idr;
 240         spinlock_t surf_id_idr_lock;
 241         int last_alloced_surf_id;
 242
 243         struct mutex surf_evict_mutex;
 244         struct io_mapping *vram_mapping;
 245         struct io_mapping *surface_mapping;
 246
 247         /* */
 248         struct mutex release_mutex;
 249         struct qxl_bo *current_release_bo[3];
 250         int current_release_bo_offset[3];
 251
 252         struct work_struct gc_work;
 253
 254         struct drm_property *hotplug_mode_update_property;
 255         int monitors_config_width;
 256         int monitors_config_height;
 257 };
 258
 259 #define to_qxl(dev) container_of(dev, struct qxl_device, ddev)
 260
 261 int qxl_debugfs_fence_init(struct qxl_device *rdev);
 262
 263 extern const struct drm_ioctl_desc qxl_ioctls[];
 264 extern int qxl_max_ioctl;
 265
 266 int qxl_device_init(struct qxl_device *qdev, struct pci_dev *pdev);
 267 void qxl_device_fini(struct qxl_device *qdev);
 268
 269 int qxl_modeset_init(struct qxl_device *qdev);
 270 void qxl_modeset_fini(struct qxl_device *qdev);
 271
 272 int qxl_bo_init(struct qxl_device *qdev);
 273 void qxl_bo_fini(struct qxl_device *qdev);
 274
 275 void qxl_reinit_memslots(struct qxl_device *qdev);
 276 int qxl_surf_evict(struct qxl_device *qdev);
 277 int qxl_vram_evict(struct qxl_device *qdev);
 278
 279 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
 280                                  int element_size,
 281                                  int n_elements,
 282                                  int prod_notify,
 283                                  bool set_prod_notify,
 284                                  wait_queue_head_t *push_event);
 285 void qxl_ring_free(struct qxl_ring *ring);
 286 void qxl_ring_init_hdr(struct qxl_ring *ring);
 287 int qxl_check_idle(struct qxl_ring *ring);
 288
 289 static inline uint64_t
 290 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
 291                         unsigned long offset)
 292 {
 293         struct qxl_memslot *slot =
 294                 (bo->tbo.mem.mem_type == TTM_PL_VRAM)
 295                 ? &qdev->main_slot : &qdev->surfaces_slot;
 296
 297        /* TODO - need to hold one of the locks to read bo->tbo.mem.start */
 298
 299         return slot->high_bits | ((bo->tbo.mem.start << PAGE_SHIFT) + offset);
 300 }
 301
 302 /* qxl_display.c */
 303 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
 304 int qxl_create_monitors_object(struct qxl_device *qdev);
 305 int qxl_destroy_monitors_object(struct qxl_device *qdev);
 306
 307 /* qxl_gem.c */
 308 void qxl_gem_init(struct qxl_device *qdev);
 309 void qxl_gem_fini(struct qxl_device *qdev);
 310 int qxl_gem_object_create(struct qxl_device *qdev, int size,
 311                           int alignment, int initial_domain,
 312                           bool discardable, bool kernel,
 313                           struct qxl_surface *surf,
 314                           struct drm_gem_object **obj);
 315 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
 316                                       struct drm_file *file_priv,
 317                                       u32 domain,
 318                                       size_t size,
 319                                       struct qxl_surface *surf,
 320                                       struct qxl_bo **qobj,
 321                                       uint32_t *handle);
 322 void qxl_gem_object_free(struct drm_gem_object *gobj);
 323 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
 324 void qxl_gem_object_close(struct drm_gem_object *obj,
 325                           struct drm_file *file_priv);
 326 void qxl_bo_force_delete(struct qxl_device *qdev);
 327
 328 /* qxl_dumb.c */
 329 int qxl_mode_dumb_create(struct drm_file *file_priv,
 330                          struct drm_device *dev,
 331                          struct drm_mode_create_dumb *args);
 332 int qxl_mode_dumb_mmap(struct drm_file *filp,
 333                        struct drm_device *dev,
 334                        uint32_t handle, uint64_t *offset_p);
 335
 336 /* qxl ttm */
 337 int qxl_ttm_init(struct qxl_device *qdev);
 338 void qxl_ttm_fini(struct qxl_device *qdev);
 339 int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
 340                            struct ttm_resource *mem);
 341
 342 /* qxl image */
 343
 344 int qxl_image_init(struct qxl_device *qdev,
 345                    struct qxl_release *release,
 346                    struct qxl_drm_image *dimage,
 347                    const uint8_t *data,
 348                    int x, int y, int width, int height,
 349                    int depth, int stride);
 350 int
 351 qxl_image_alloc_objects(struct qxl_device *qdev,
 352                         struct qxl_release *release,
 353                         struct qxl_drm_image **image_ptr,
 354                         int height, int stride);
 355 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
 356
 357 void qxl_update_screen(struct qxl_device *qxl);
 358
 359 /* qxl io operations (qxl_cmd.c) */
 360
 361 void qxl_io_create_primary(struct qxl_device *qdev,
 362                            struct qxl_bo *bo);
 363 void qxl_io_destroy_primary(struct qxl_device *qdev);
 364 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
 365 void qxl_io_notify_oom(struct qxl_device *qdev);
 366
 367 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
 368                        const struct qxl_rect *area);
 369
 370 void qxl_io_reset(struct qxl_device *qdev);
 371 void qxl_io_monitors_config(struct qxl_device *qdev);
 372 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
 373 void qxl_io_flush_release(struct qxl_device *qdev);
 374 void qxl_io_flush_surfaces(struct qxl_device *qdev);
 375
 376 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
 377                                         struct qxl_release *release);
 378 void qxl_release_unmap(struct qxl_device *qdev,
 379                        struct qxl_release *release,
 380                        union qxl_release_info *info);
 381 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
 382 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
 383 void qxl_release_backoff_reserve_list(struct qxl_release *release);
 384 void qxl_release_fence_buffer_objects(struct qxl_release *release);
 385
 386 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
 387                                        enum qxl_surface_cmd_type surface_cmd_type,
 388                                        struct qxl_release *create_rel,
 389                                        struct qxl_release **release);
 390 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
 391                                int type, struct qxl_release **release,
 392                                struct qxl_bo **rbo);
 393
 394 int
 395 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
 396                               uint32_t type, bool interruptible);
 397 int
 398 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
 399                              uint32_t type, bool interruptible);
 400 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
 401                           struct qxl_release *release,
 402                           unsigned long size,
 403                           struct qxl_bo **_bo);
 404 /* qxl drawing commands */
 405
 406 void qxl_draw_dirty_fb(struct qxl_device *qdev,
 407                        struct drm_framebuffer *fb,
 408                        struct qxl_bo *bo,
 409                        unsigned int flags, unsigned int color,
 410                        struct drm_clip_rect *clips,
 411                        unsigned int num_clips, int inc,
 412                        uint32_t dumb_shadow_offset);
 413
 414 void qxl_release_free(struct qxl_device *qdev,
 415                       struct qxl_release *release);
 416
 417 /* used by qxl_debugfs_release */
 418 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
 419                                                    uint64_t id);
 420
 421 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
 422 int qxl_garbage_collect(struct qxl_device *qdev);
 423
 424 /* debugfs */
 425
 426 void qxl_debugfs_init(struct drm_minor *minor);
 427 void qxl_ttm_debugfs_init(struct qxl_device *qdev);
 428
 429 /* qxl_prime.c */
 430 int qxl_gem_prime_pin(struct drm_gem_object *obj);
 431 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
 432 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
 433 struct drm_gem_object *qxl_gem_prime_import_sg_table(
 434         struct drm_device *dev, struct dma_buf_attachment *attach,
 435         struct sg_table *sgt);
 436 int qxl_gem_prime_vmap(struct drm_gem_object *obj, struct dma_buf_map *map);
 437 void qxl_gem_prime_vunmap(struct drm_gem_object *obj,
 438                           struct dma_buf_map *map);
 439 int qxl_gem_prime_mmap(struct drm_gem_object *obj,
 440                                 struct vm_area_struct *vma);
 441
 442 /* qxl_irq.c */
 443 int qxl_irq_init(struct qxl_device *qdev);
 444 irqreturn_t qxl_irq_handler(int irq, void *arg);
 445
 446 void qxl_debugfs_add_files(struct qxl_device *qdev,
 447                            struct drm_info_list *files,
 448                            unsigned int nfiles);
 449
 450 int qxl_surface_id_alloc(struct qxl_device *qdev,
 451                          struct qxl_bo *surf);
 452 void qxl_surface_id_dealloc(struct qxl_device *qdev,
 453                             uint32_t surface_id);
 454 int qxl_hw_surface_alloc(struct qxl_device *qdev,
 455                          struct qxl_bo *surf);
 456 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
 457                            struct qxl_bo *surf);
 458
 459 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
 460
 461 struct qxl_drv_surface *
 462 qxl_surface_lookup(struct drm_device *dev, int surface_id);
 463 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
 464
 465 #endif