LXR linux/drivers/gpu/drm/qxl/qxl

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