qxl_drv.h 14 KB

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