drm_legacy.h revision 1.2 1 /* $NetBSD: drm_legacy.h,v 1.2 2018/08/27 04:58:37 riastradh Exp $ */
2
3 #ifndef __DRM_DRM_LEGACY_H__
4 #define __DRM_DRM_LEGACY_H__
5
6 /*
7 * Legacy driver interfaces for the Direct Rendering Manager
8 *
9 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
10 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
11 * Copyright (c) 2009-2010, Code Aurora Forum.
12 * All rights reserved.
13 * Copyright 2014 Intel Corporation
14 * Daniel Vetter <daniel.vetter (at) ffwll.ch>
15 *
16 * Author: Rickard E. (Rik) Faith <faith (at) valinux.com>
17 * Author: Gareth Hughes <gareth (at) valinux.com>
18 *
19 * Permission is hereby granted, free of charge, to any person obtaining a
20 * copy of this software and associated documentation files (the "Software"),
21 * to deal in the Software without restriction, including without limitation
22 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
23 * and/or sell copies of the Software, and to permit persons to whom the
24 * Software is furnished to do so, subject to the following conditions:
25 *
26 * The above copyright notice and this permission notice (including the next
27 * paragraph) shall be included in all copies or substantial portions of the
28 * Software.
29 *
30 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
33 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
34 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
35 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
36 * OTHER DEALINGS IN THE SOFTWARE.
37 */
38
39
40 /*
41 * Legacy Support for palateontologic DRM drivers
42 *
43 * If you add a new driver and it uses any of these functions or structures,
44 * you're doing it terribly wrong.
45 */
46
47 /**
48 * DMA buffer.
49 */
50 struct drm_buf {
51 int idx; /**< Index into master buflist */
52 int total; /**< Buffer size */
53 int order; /**< log-base-2(total) */
54 int used; /**< Amount of buffer in use (for DMA) */
55 unsigned long offset; /**< Byte offset (used internally) */
56 void *address; /**< Address of buffer */
57 unsigned long bus_address; /**< Bus address of buffer */
58 struct drm_buf *next; /**< Kernel-only: used for free list */
59 __volatile__ int waiting; /**< On kernel DMA queue */
60 __volatile__ int pending; /**< On hardware DMA queue */
61 struct drm_file *file_priv; /**< Private of holding file descr */
62 int context; /**< Kernel queue for this buffer */
63 int while_locked; /**< Dispatch this buffer while locked */
64 enum {
65 DRM_LIST_NONE = 0,
66 DRM_LIST_FREE = 1,
67 DRM_LIST_WAIT = 2,
68 DRM_LIST_PEND = 3,
69 DRM_LIST_PRIO = 4,
70 DRM_LIST_RECLAIM = 5
71 } list; /**< Which list we're on */
72
73 int dev_priv_size; /**< Size of buffer private storage */
74 void *dev_private; /**< Per-buffer private storage */
75 };
76
77 typedef struct drm_dma_handle {
78 dma_addr_t busaddr;
79 void *vaddr;
80 size_t size;
81 #ifdef __NetBSD__
82 bus_dma_tag_t dmah_tag;
83 bus_dmamap_t dmah_map;
84 bus_dma_segment_t dmah_seg;
85 #endif
86 } drm_dma_handle_t;
87
88 /**
89 * Buffer entry. There is one of this for each buffer size order.
90 */
91 struct drm_buf_entry {
92 int buf_size; /**< size */
93 int buf_count; /**< number of buffers */
94 struct drm_buf *buflist; /**< buffer list */
95 int seg_count;
96 int page_order;
97 struct drm_dma_handle **seglist;
98
99 int low_mark; /**< Low water mark */
100 int high_mark; /**< High water mark */
101 };
102
103 /**
104 * DMA data.
105 */
106 struct drm_device_dma {
107
108 struct drm_buf_entry bufs[DRM_MAX_ORDER + 1]; /**< buffers, grouped by their size order */
109 int buf_count; /**< total number of buffers */
110 struct drm_buf **buflist; /**< Vector of pointers into drm_device_dma::bufs */
111 int seg_count;
112 int page_count; /**< number of pages */
113 unsigned long *pagelist; /**< page list */
114 unsigned long byte_count;
115 enum {
116 _DRM_DMA_USE_AGP = 0x01,
117 _DRM_DMA_USE_SG = 0x02,
118 _DRM_DMA_USE_FB = 0x04,
119 _DRM_DMA_USE_PCI_RO = 0x08
120 } flags;
121
122 };
123
124 /**
125 * Scatter-gather memory.
126 */
127 struct drm_sg_mem {
128 unsigned long handle;
129 void *virtual;
130 #ifdef __NetBSD__
131 size_t sg_size;
132 bus_dma_tag_t sg_tag;
133 bus_dmamap_t sg_map;
134 unsigned int sg_nsegs;
135 unsigned int sg_nsegs_max;
136 bus_dma_segment_t sg_segs[];
137 #else
138 int pages;
139 struct page **pagelist;
140 dma_addr_t *busaddr;
141 #endif
142 };
143
144 #ifdef __NetBSD__
145 /*
146 * XXX Remember: memory mappings only. bm_flags must include
147 * BUS_SPACE_MAP_LINEAR.
148 */
149 struct drm_bus_map {
150 bus_addr_t bm_base;
151 bus_size_t bm_size;
152 bus_space_handle_t bm_bsh;
153 int bm_flags;
154 };
155 #endif
156
157 /**
158 * Kernel side of a mapping
159 */
160 struct drm_local_map {
161 resource_size_t offset; /**< Requested physical address (0 for SAREA)*/
162 unsigned long size; /**< Requested physical size (bytes) */
163 enum drm_map_type type; /**< Type of memory to map */
164 enum drm_map_flags flags; /**< Flags */
165 void *handle; /**< User-space: "Handle" to pass to mmap() */
166 /**< Kernel-space: kernel-virtual address */
167 int mtrr; /**< MTRR slot used */
168
169 #ifdef __NetBSD__
170 union {
171 /* _DRM_FRAME_BUFFER, _DRM_AGP, _DRM_REGISTERS */
172 /* XXX mtrr should be moved into this case too. */
173 struct {
174 /*
175 * XXX bst seems like a waste of space, but not
176 * all accessors have the drm_device handy.
177 */
178 bus_space_tag_t bst;
179 bus_space_handle_t bsh;
180 struct drm_bus_map *bus_map;
181 } bus_space;
182
183 /* _DRM_CONSISTENT */
184 struct drm_dma_handle *dmah;
185
186 /* _DRM_SCATTER_GATHER */
187 #if 0 /* XXX stored in dev->sg instead */
188 struct drm_sg_mem *sg;
189 #endif
190
191 /* _DRM_SHM */
192 /* XXX Anything? uvm object? */
193 } lm_data;
194 #endif
195 };
196
197 typedef struct drm_local_map drm_local_map_t;
198
199 /**
200 * Mappings list
201 */
202 struct drm_map_list {
203 struct list_head head; /**< list head */
204 struct drm_hash_item hash;
205 struct drm_local_map *map; /**< mapping */
206 uint64_t user_token;
207 struct drm_master *master;
208 };
209
210 int drm_legacy_addmap(struct drm_device *d, resource_size_t offset,
211 unsigned int size, enum drm_map_type type,
212 enum drm_map_flags flags, struct drm_local_map **map_p);
213 int drm_legacy_rmmap(struct drm_device *d, struct drm_local_map *map);
214 int drm_legacy_rmmap_locked(struct drm_device *d, struct drm_local_map *map);
215 struct drm_local_map *drm_legacy_getsarea(struct drm_device *dev);
216 #ifdef __NetBSD__
217 int drm_mmap_object(struct drm_device *, off_t, size_t, int,
218 struct uvm_object **, voff_t *, struct file *);
219 paddr_t drm_mmap_paddr(struct drm_device *, off_t, int);
220 #else
221 int drm_legacy_mmap(struct file *filp, struct vm_area_struct *vma);
222 #endif
223
224 int drm_legacy_addbufs_agp(struct drm_device *d, struct drm_buf_desc *req);
225 int drm_legacy_addbufs_pci(struct drm_device *d, struct drm_buf_desc *req);
226
227 /**
228 * Test that the hardware lock is held by the caller, returning otherwise.
229 *
230 * \param dev DRM device.
231 * \param filp file pointer of the caller.
232 */
233 #define LOCK_TEST_WITH_RETURN( dev, _file_priv ) \
234 do { \
235 if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) || \
236 _file_priv->master->lock.file_priv != _file_priv) { \
237 DRM_ERROR( "%s called without lock held, held %d owner %p %p\n",\
238 __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
239 _file_priv->master->lock.file_priv, _file_priv); \
240 return -EINVAL; \
241 } \
242 } while (0)
243
244 void drm_legacy_idlelock_take(struct drm_lock_data *lock);
245 void drm_legacy_idlelock_release(struct drm_lock_data *lock);
246
247 /* drm_pci.c dma alloc wrappers */
248 void __drm_legacy_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
249
250 /* drm_memory.c */
251 #ifdef __NetBSD__
252 int drm_limit_dma_space(struct drm_device *, resource_size_t, resource_size_t);
253 #endif
254 void drm_legacy_ioremap(struct drm_local_map *map, struct drm_device *dev);
255 void drm_legacy_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
256 void drm_legacy_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
257
258 static __inline__ struct drm_local_map *drm_legacy_findmap(struct drm_device *dev,
259 unsigned int token)
260 {
261 struct drm_map_list *_entry;
262 list_for_each_entry(_entry, &dev->maplist, head)
263 if (_entry->user_token == token)
264 return _entry->map;
265 return NULL;
266 }
267
268 #endif /* __DRM_DRM_LEGACY_H__ */
269