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