xref: /dragonfly/sys/dev/drm/include/drm/drm_legacy.h (revision bb8c85ff)
1 #ifndef __DRM_DRM_LEGACY_H__
2 #define __DRM_DRM_LEGACY_H__
3 
4 /*
5  * Legacy driver interfaces for the Direct Rendering Manager
6  *
7  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
8  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
9  * Copyright (c) 2009-2010, Code Aurora Forum.
10  * All rights reserved.
11  * Copyright © 2014 Intel Corporation
12  *   Daniel Vetter <daniel.vetter@ffwll.ch>
13  *
14  * Author: Rickard E. (Rik) Faith <faith@valinux.com>
15  * Author: Gareth Hughes <gareth@valinux.com>
16  *
17  * Permission is hereby granted, free of charge, to any person obtaining a
18  * copy of this software and associated documentation files (the "Software"),
19  * to deal in the Software without restriction, including without limitation
20  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
21  * and/or sell copies of the Software, and to permit persons to whom the
22  * Software is furnished to do so, subject to the following conditions:
23  *
24  * The above copyright notice and this permission notice (including the next
25  * paragraph) shall be included in all copies or substantial portions of the
26  * Software.
27  *
28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
31  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
32  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
33  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34  * OTHER DEALINGS IN THE SOFTWARE.
35  */
36 
37 
38 /*
39  * Legacy Support for palateontologic DRM drivers
40  *
41  * If you add a new driver and it uses any of these functions or structures,
42  * you're doing it terribly wrong.
43  */
44 
45 /**
46  * DMA buffer.
47  */
48 struct drm_buf {
49 	int idx;		       /**< Index into master buflist */
50 	int total;		       /**< Buffer size */
51 	int order;		       /**< log-base-2(total) */
52 	int used;		       /**< Amount of buffer in use (for DMA) */
53 	unsigned long offset;	       /**< Byte offset (used internally) */
54 	void *address;		       /**< Address of buffer */
55 	unsigned long bus_address;     /**< Bus address of buffer */
56 	struct drm_buf *next;	       /**< Kernel-only: used for free list */
57 	__volatile__ int waiting;      /**< On kernel DMA queue */
58 	__volatile__ int pending;      /**< On hardware DMA queue */
59 	struct drm_file *file_priv;    /**< Private of holding file descr */
60 	int context;		       /**< Kernel queue for this buffer */
61 	int while_locked;	       /**< Dispatch this buffer while locked */
62 	enum {
63 		DRM_LIST_NONE = 0,
64 		DRM_LIST_FREE = 1,
65 		DRM_LIST_WAIT = 2,
66 		DRM_LIST_PEND = 3,
67 		DRM_LIST_PRIO = 4,
68 		DRM_LIST_RECLAIM = 5
69 	} list;			       /**< Which list we're on */
70 
71 	int dev_priv_size;		 /**< Size of buffer private storage */
72 	void *dev_private;		 /**< Per-buffer private storage */
73 };
74 
75 typedef struct drm_dma_handle {
76 	void *vaddr;
77 	size_t size;
78 	bus_addr_t busaddr;
79 	bus_dma_tag_t tag;
80 	bus_dmamap_t map;
81 } drm_dma_handle_t;
82 
83 /**
84  * Buffer entry.  There is one of this for each buffer size order.
85  */
86 struct drm_buf_entry {
87 	int buf_size;			/**< size */
88 	int buf_count;			/**< number of buffers */
89 	struct drm_buf *buflist;		/**< buffer list */
90 	int seg_count;
91 	int page_order;
92 	struct drm_dma_handle **seglist;
93 
94 	int low_mark;			/**< Low water mark */
95 	int high_mark;			/**< High water mark */
96 };
97 
98 /**
99  * DMA data.
100  */
101 struct drm_device_dma {
102 
103 	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
104 	int buf_count;			/**< total number of buffers */
105 	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
106 	int seg_count;
107 	int page_count;			/**< number of pages */
108 	unsigned long *pagelist;	/**< page list */
109 	unsigned long byte_count;
110 	enum {
111 		_DRM_DMA_USE_AGP = 0x01,
112 		_DRM_DMA_USE_SG = 0x02,
113 		_DRM_DMA_USE_FB = 0x04,
114 		_DRM_DMA_USE_PCI_RO = 0x08
115 	} flags;
116 
117 };
118 
119 /**
120  * Scatter-gather memory.
121  */
122 struct drm_sg_mem {
123 	vm_offset_t vaddr;
124 	vm_paddr_t *busaddr;
125 	vm_pindex_t pages;
126 };
127 
128 /**
129  * Kernel side of a mapping
130  */
131 struct drm_local_map {
132 	resource_size_t offset;	 /**< Requested physical address (0 for SAREA)*/
133 	unsigned long size;	 /**< Requested physical size (bytes) */
134 	enum drm_map_type type;	 /**< Type of memory to map */
135 	enum drm_map_flags flags;	 /**< Flags */
136 	void *handle;		 /**< User-space: "Handle" to pass to mmap() */
137 				 /**< Kernel-space: kernel-virtual address */
138 	int mtrr;		 /**< MTRR slot used */
139 };
140 
141 typedef struct drm_local_map drm_local_map_t;
142 
143 /**
144  * Mappings list
145  */
146 struct drm_map_list {
147 	struct list_head head;		/**< list head */
148 	struct drm_hash_item hash;
149 	struct drm_local_map *map;	/**< mapping */
150 	uint64_t user_token;
151 	struct drm_master *master;
152 };
153 
154 int drm_legacy_addmap(struct drm_device *d, resource_size_t offset,
155 		      unsigned int size, enum drm_map_type type,
156 		      enum drm_map_flags flags, struct drm_local_map **map_p);
157 int drm_legacy_rmmap(struct drm_device *d, struct drm_local_map *map);
158 int drm_legacy_rmmap_locked(struct drm_device *d, struct drm_local_map *map);
159 struct drm_local_map *drm_legacy_getsarea(struct drm_device *dev);
160 
161 int drm_legacy_addbufs_agp(struct drm_device *d, struct drm_buf_desc *req);
162 int drm_legacy_addbufs_pci(struct drm_device *d, struct drm_buf_desc *req);
163 
164 /**
165  * Test that the hardware lock is held by the caller, returning otherwise.
166  *
167  * \param dev DRM device.
168  * \param filp file pointer of the caller.
169  */
170 #define LOCK_TEST_WITH_RETURN(dev, file_priv)				\
171 do {									\
172 	if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||		\
173 	     dev->lock.file_priv != file_priv) {			\
174 		DRM_ERROR("%s called without lock held\n",		\
175 			   __FUNCTION__);				\
176 		return EINVAL;						\
177 	}								\
178 } while (0)
179 
180 void drm_legacy_idlelock_take(struct drm_lock_data *lock);
181 void drm_legacy_idlelock_release(struct drm_lock_data *lock);
182 
183 /* drm_pci.c dma alloc wrappers */
184 void __drm_legacy_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
185 
186 /* drm_memory.c */
187 void drm_legacy_ioremap(struct drm_local_map *map, struct drm_device *dev);
188 void drm_legacy_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
189 void drm_legacy_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
190 
191 #endif /* __DRM_DRM_LEGACY_H__ */
192