qxl_drv.h 14 KB

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