drm/qxl/qxl_drv.h

0001 /*
0002  * Copyright 2013 Red Hat Inc.
0003  *
0004  * Permission is hereby granted, free of charge, to any person obtaining a
0005  * copy of this software and associated documentation files (the "Software"),
0006  * to deal in the Software without restriction, including without limitation
0007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0008  * and/or sell copies of the Software, and to permit persons to whom the
0009  * Software is furnished to do so, subject to the following conditions:
0010  *
0011  * The above copyright notice and this permission notice shall be included in
0012  * all copies or substantial portions of the Software.
0013  *
0014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
0017  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
0018  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
0019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
0020  * OTHER DEALINGS IN THE SOFTWARE.
0021  *
0022  * Authors: Dave Airlie
0023  *          Alon Levy
0024  */
0025
0026 #ifndef QXL_DRV_H
0027 #define QXL_DRV_H
0028
0029 /*
0030  * Definitions taken from spice-protocol, plus kernel driver specific bits.
0031  */
0032
0033 #include <linux/iosys-map.h>
0034 #include <linux/dma-fence.h>
0035 #include <linux/firmware.h>
0036 #include <linux/platform_device.h>
0037 #include <linux/workqueue.h>
0038
0039 #include <drm/drm_crtc.h>
0040 #include <drm/drm_encoder.h>
0041 #include <drm/drm_fb_helper.h>
0042 #include <drm/drm_gem_ttm_helper.h>
0043 #include <drm/drm_ioctl.h>
0044 #include <drm/drm_gem.h>
0045 #include <drm/qxl_drm.h>
0046 #include <drm/ttm/ttm_bo_api.h>
0047 #include <drm/ttm/ttm_bo_driver.h>
0048 #include <drm/ttm/ttm_execbuf_util.h>
0049 #include <drm/ttm/ttm_placement.h>
0050
0051 #include "qxl_dev.h"
0052
0053 struct iosys_map;
0054
0055 #define DRIVER_AUTHOR       "Dave Airlie"
0056
0057 #define DRIVER_NAME     "qxl"
0058 #define DRIVER_DESC     "RH QXL"
0059 #define DRIVER_DATE     "20120117"
0060
0061 #define DRIVER_MAJOR 0
0062 #define DRIVER_MINOR 1
0063 #define DRIVER_PATCHLEVEL 0
0064
0065 #define QXL_DEBUGFS_MAX_COMPONENTS      32
0066
0067 extern int qxl_num_crtc;
0068
0069 #define QXL_INTERRUPT_MASK (\
0070     QXL_INTERRUPT_DISPLAY |\
0071     QXL_INTERRUPT_CURSOR |\
0072     QXL_INTERRUPT_IO_CMD |\
0073     QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
0074
0075 struct qxl_bo {
0076     struct ttm_buffer_object    tbo;
0077
0078     /* Protected by gem.mutex */
0079     struct list_head        list;
0080     /* Protected by tbo.reserved */
0081     struct ttm_place        placements[3];
0082     struct ttm_placement        placement;
0083     struct iosys_map        map;
0084     void                *kptr;
0085     unsigned int                    map_count;
0086     int                             type;
0087
0088     /* Constant after initialization */
0089     unsigned int is_primary:1; /* is this now a primary surface */
0090     unsigned int is_dumb:1;
0091     struct qxl_bo *shadow;
0092     unsigned int hw_surf_alloc:1;
0093     struct qxl_surface surf;
0094     uint32_t surface_id;
0095     struct qxl_release *surf_create;
0096 };
0097 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, tbo.base)
0098 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
0099
0100 struct qxl_gem {
0101     struct mutex        mutex;
0102     struct list_head    objects;
0103 };
0104
0105 struct qxl_bo_list {
0106     struct ttm_validate_buffer tv;
0107 };
0108
0109 struct qxl_crtc {
0110     struct drm_crtc base;
0111     int index;
0112
0113     struct qxl_bo *cursor_bo;
0114 };
0115
0116 struct qxl_output {
0117     int index;
0118     struct drm_connector base;
0119     struct drm_encoder enc;
0120 };
0121
0122 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
0123 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
0124 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
0125
0126 struct qxl_mman {
0127     struct ttm_device       bdev;
0128 };
0129
0130 struct qxl_memslot {
0131     int             index;
0132     const char      *name;
0133     uint8_t     generation;
0134     uint64_t    start_phys_addr;
0135     uint64_t    size;
0136     uint64_t    high_bits;
0137 };
0138
0139 enum {
0140     QXL_RELEASE_DRAWABLE,
0141     QXL_RELEASE_SURFACE_CMD,
0142     QXL_RELEASE_CURSOR_CMD,
0143 };
0144
0145 /* drm_ prefix to differentiate from qxl_release_info in
0146  * spice-protocol/qxl_dev.h */
0147 #define QXL_MAX_RES 96
0148 struct qxl_release {
0149     struct dma_fence base;
0150
0151     int id;
0152     int type;
0153     struct qxl_bo *release_bo;
0154     uint32_t release_offset;
0155     uint32_t surface_release_id;
0156     struct ww_acquire_ctx ticket;
0157     struct list_head bos;
0158 };
0159
0160 struct qxl_drm_chunk {
0161     struct list_head head;
0162     struct qxl_bo *bo;
0163 };
0164
0165 struct qxl_drm_image {
0166     struct qxl_bo *bo;
0167     struct list_head chunk_list;
0168 };
0169
0170 /*
0171  * Debugfs
0172  */
0173 struct qxl_debugfs {
0174     struct drm_info_list    *files;
0175     unsigned int num_files;
0176 };
0177
0178 struct qxl_device {
0179     struct drm_device ddev;
0180
0181     resource_size_t vram_base, vram_size;
0182     resource_size_t surfaceram_base, surfaceram_size;
0183     resource_size_t rom_base, rom_size;
0184     struct qxl_rom *rom;
0185
0186     struct qxl_mode *modes;
0187     struct qxl_bo *monitors_config_bo;
0188     struct qxl_monitors_config *monitors_config;
0189
0190     /* last received client_monitors_config */
0191     struct qxl_monitors_config *client_monitors_config;
0192
0193     int io_base;
0194     void *ram;
0195     struct qxl_mman     mman;
0196     struct qxl_gem      gem;
0197
0198     void *ram_physical;
0199
0200     struct qxl_ring *release_ring;
0201     struct qxl_ring *command_ring;
0202     struct qxl_ring *cursor_ring;
0203
0204     struct qxl_ram_header *ram_header;
0205
0206     struct qxl_bo *primary_bo;
0207     struct qxl_bo *dumb_shadow_bo;
0208     struct qxl_head *dumb_heads;
0209
0210     struct qxl_memslot main_slot;
0211     struct qxl_memslot surfaces_slot;
0212
0213     spinlock_t  release_lock;
0214     struct idr  release_idr;
0215     uint32_t    release_seqno;
0216     atomic_t    release_count;
0217     wait_queue_head_t release_event;
0218     spinlock_t release_idr_lock;
0219     struct mutex    async_io_mutex;
0220     unsigned int last_sent_io_cmd;
0221
0222     /* interrupt handling */
0223     atomic_t irq_received;
0224     atomic_t irq_received_display;
0225     atomic_t irq_received_cursor;
0226     atomic_t irq_received_io_cmd;
0227     unsigned int irq_received_error;
0228     wait_queue_head_t display_event;
0229     wait_queue_head_t cursor_event;
0230     wait_queue_head_t io_cmd_event;
0231     struct work_struct client_monitors_config_work;
0232
0233     /* debugfs */
0234     struct qxl_debugfs  debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
0235     unsigned int debugfs_count;
0236
0237     struct mutex        update_area_mutex;
0238
0239     struct idr  surf_id_idr;
0240     spinlock_t surf_id_idr_lock;
0241     int last_alloced_surf_id;
0242
0243     struct mutex surf_evict_mutex;
0244     struct io_mapping *vram_mapping;
0245     struct io_mapping *surface_mapping;
0246
0247     /* */
0248     struct mutex release_mutex;
0249     struct qxl_bo *current_release_bo[3];
0250     int current_release_bo_offset[3];
0251
0252     struct work_struct gc_work;
0253
0254     struct drm_property *hotplug_mode_update_property;
0255     int monitors_config_width;
0256     int monitors_config_height;
0257 };
0258
0259 #define to_qxl(dev) container_of(dev, struct qxl_device, ddev)
0260
0261 int qxl_debugfs_fence_init(struct qxl_device *rdev);
0262
0263 int qxl_device_init(struct qxl_device *qdev, struct pci_dev *pdev);
0264 void qxl_device_fini(struct qxl_device *qdev);
0265
0266 int qxl_modeset_init(struct qxl_device *qdev);
0267 void qxl_modeset_fini(struct qxl_device *qdev);
0268
0269 int qxl_bo_init(struct qxl_device *qdev);
0270 void qxl_bo_fini(struct qxl_device *qdev);
0271
0272 void qxl_reinit_memslots(struct qxl_device *qdev);
0273 int qxl_surf_evict(struct qxl_device *qdev);
0274 int qxl_vram_evict(struct qxl_device *qdev);
0275
0276 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
0277                  int element_size,
0278                  int n_elements,
0279                  int prod_notify,
0280                  bool set_prod_notify,
0281                  wait_queue_head_t *push_event);
0282 void qxl_ring_free(struct qxl_ring *ring);
0283 void qxl_ring_init_hdr(struct qxl_ring *ring);
0284 int qxl_check_idle(struct qxl_ring *ring);
0285
0286 static inline uint64_t
0287 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
0288             unsigned long offset)
0289 {
0290     struct qxl_memslot *slot =
0291         (bo->tbo.resource->mem_type == TTM_PL_VRAM)
0292         ? &qdev->main_slot : &qdev->surfaces_slot;
0293
0294        /* TODO - need to hold one of the locks to read bo->tbo.resource->start */
0295
0296     return slot->high_bits | ((bo->tbo.resource->start << PAGE_SHIFT) + offset);
0297 }
0298
0299 /* qxl_display.c */
0300 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
0301 int qxl_create_monitors_object(struct qxl_device *qdev);
0302 int qxl_destroy_monitors_object(struct qxl_device *qdev);
0303
0304 /* qxl_gem.c */
0305 void qxl_gem_init(struct qxl_device *qdev);
0306 void qxl_gem_fini(struct qxl_device *qdev);
0307 int qxl_gem_object_create(struct qxl_device *qdev, int size,
0308               int alignment, int initial_domain,
0309               bool discardable, bool kernel,
0310               struct qxl_surface *surf,
0311               struct drm_gem_object **obj);
0312 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
0313                       struct drm_file *file_priv,
0314                       u32 domain,
0315                       size_t size,
0316                       struct qxl_surface *surf,
0317                       struct qxl_bo **qobj,
0318                       uint32_t *handle);
0319 void qxl_gem_object_free(struct drm_gem_object *gobj);
0320 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
0321 void qxl_gem_object_close(struct drm_gem_object *obj,
0322               struct drm_file *file_priv);
0323 void qxl_bo_force_delete(struct qxl_device *qdev);
0324
0325 /* qxl_dumb.c */
0326 int qxl_mode_dumb_create(struct drm_file *file_priv,
0327              struct drm_device *dev,
0328              struct drm_mode_create_dumb *args);
0329
0330 /* qxl ttm */
0331 int qxl_ttm_init(struct qxl_device *qdev);
0332 void qxl_ttm_fini(struct qxl_device *qdev);
0333 int qxl_ttm_io_mem_reserve(struct ttm_device *bdev,
0334                struct ttm_resource *mem);
0335
0336 /* qxl image */
0337
0338 int qxl_image_init(struct qxl_device *qdev,
0339            struct qxl_release *release,
0340            struct qxl_drm_image *dimage,
0341            const uint8_t *data,
0342            int x, int y, int width, int height,
0343            int depth, int stride);
0344 int
0345 qxl_image_alloc_objects(struct qxl_device *qdev,
0346             struct qxl_release *release,
0347             struct qxl_drm_image **image_ptr,
0348             int height, int stride);
0349 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
0350
0351 void qxl_update_screen(struct qxl_device *qxl);
0352
0353 /* qxl io operations (qxl_cmd.c) */
0354
0355 void qxl_io_create_primary(struct qxl_device *qdev,
0356                struct qxl_bo *bo);
0357 void qxl_io_destroy_primary(struct qxl_device *qdev);
0358 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
0359 void qxl_io_notify_oom(struct qxl_device *qdev);
0360
0361 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
0362                const struct qxl_rect *area);
0363
0364 void qxl_io_reset(struct qxl_device *qdev);
0365 void qxl_io_monitors_config(struct qxl_device *qdev);
0366 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
0367 void qxl_io_flush_release(struct qxl_device *qdev);
0368 void qxl_io_flush_surfaces(struct qxl_device *qdev);
0369
0370 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
0371                     struct qxl_release *release);
0372 void qxl_release_unmap(struct qxl_device *qdev,
0373                struct qxl_release *release,
0374                union qxl_release_info *info);
0375 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
0376 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
0377 void qxl_release_backoff_reserve_list(struct qxl_release *release);
0378 void qxl_release_fence_buffer_objects(struct qxl_release *release);
0379
0380 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
0381                        enum qxl_surface_cmd_type surface_cmd_type,
0382                        struct qxl_release *create_rel,
0383                        struct qxl_release **release);
0384 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
0385                    int type, struct qxl_release **release,
0386                    struct qxl_bo **rbo);
0387
0388 int
0389 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
0390                   uint32_t type, bool interruptible);
0391 int
0392 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
0393                  uint32_t type, bool interruptible);
0394 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
0395               struct qxl_release *release,
0396               unsigned long size,
0397               struct qxl_bo **_bo);
0398 /* qxl drawing commands */
0399
0400 void qxl_draw_dirty_fb(struct qxl_device *qdev,
0401                struct drm_framebuffer *fb,
0402                struct qxl_bo *bo,
0403                unsigned int flags, unsigned int color,
0404                struct drm_clip_rect *clips,
0405                unsigned int num_clips, int inc,
0406                uint32_t dumb_shadow_offset);
0407
0408 void qxl_release_free(struct qxl_device *qdev,
0409               struct qxl_release *release);
0410
0411 /* used by qxl_debugfs_release */
0412 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
0413                            uint64_t id);
0414
0415 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
0416 int qxl_garbage_collect(struct qxl_device *qdev);
0417
0418 /* debugfs */
0419
0420 void qxl_debugfs_init(struct drm_minor *minor);
0421 void qxl_ttm_debugfs_init(struct qxl_device *qdev);
0422
0423 /* qxl_prime.c */
0424 int qxl_gem_prime_pin(struct drm_gem_object *obj);
0425 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
0426 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
0427 struct drm_gem_object *qxl_gem_prime_import_sg_table(
0428     struct drm_device *dev, struct dma_buf_attachment *attach,
0429     struct sg_table *sgt);
0430 int qxl_gem_prime_vmap(struct drm_gem_object *obj, struct iosys_map *map);
0431 void qxl_gem_prime_vunmap(struct drm_gem_object *obj,
0432               struct iosys_map *map);
0433
0434 /* qxl_irq.c */
0435 int qxl_irq_init(struct qxl_device *qdev);
0436
0437 void qxl_debugfs_add_files(struct qxl_device *qdev,
0438                struct drm_info_list *files,
0439                unsigned int nfiles);
0440
0441 int qxl_surface_id_alloc(struct qxl_device *qdev,
0442              struct qxl_bo *surf);
0443 void qxl_surface_id_dealloc(struct qxl_device *qdev,
0444                 uint32_t surface_id);
0445 int qxl_hw_surface_alloc(struct qxl_device *qdev,
0446              struct qxl_bo *surf);
0447 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
0448                struct qxl_bo *surf);
0449
0450 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
0451
0452 struct qxl_drv_surface *
0453 qxl_surface_lookup(struct drm_device *dev, int surface_id);
0454 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
0455
0456 /* qxl_ioctl.c */
0457 int qxl_alloc_ioctl(struct drm_device *dev, void *data, struct drm_file *file_priv);
0458 int qxl_map_ioctl(struct drm_device *dev, void *data, struct drm_file *file_priv);
0459 int qxl_execbuffer_ioctl(struct drm_device *dev, void *data, struct drm_file *file_priv);
0460 int qxl_update_area_ioctl(struct drm_device *dev, void *data, struct drm_file *file);
0461 int qxl_getparam_ioctl(struct drm_device *dev, void *data, struct drm_file *file_priv);
0462 int qxl_clientcap_ioctl(struct drm_device *dev, void *data, struct drm_file *file_priv);
0463 int qxl_alloc_surf_ioctl(struct drm_device *dev, void *data, struct drm_file *file);
0464
0465 #endif