xref: /linux/drivers/gpu/drm/nouveau/nouveau_drv.h (revision c060f8168bdf22aa986970955af99702d142dfbe)
1 /* SPDX-License-Identifier: MIT */
2 #ifndef __NOUVEAU_DRV_H__
3 #define __NOUVEAU_DRV_H__
4 
5 #define DRIVER_AUTHOR		"Nouveau Project"
6 #define DRIVER_EMAIL		"nouveau@lists.freedesktop.org"
7 
8 #define DRIVER_NAME		"nouveau"
9 #define DRIVER_DESC		"nVidia Riva/TNT/GeForce/Quadro/Tesla/Tegra K1+"
10 #define DRIVER_DATE		"20120801"
11 
12 #define DRIVER_MAJOR		1
13 #define DRIVER_MINOR		4
14 #define DRIVER_PATCHLEVEL	0
15 
16 /*
17  * 1.1.1:
18  * 	- added support for tiled system memory buffer objects
19  *      - added support for NOUVEAU_GETPARAM_GRAPH_UNITS on [nvc0,nve0].
20  *      - added support for compressed memory storage types on [nvc0,nve0].
21  *      - added support for software methods 0x600,0x644,0x6ac on nvc0
22  *        to control registers on the MPs to enable performance counters,
23  *        and to control the warp error enable mask (OpenGL requires out of
24  *        bounds access to local memory to be silently ignored / return 0).
25  * 1.1.2:
26  *      - fixes multiple bugs in flip completion events and timestamping
27  * 1.2.0:
28  * 	- object api exposed to userspace
29  * 	- fermi,kepler,maxwell zbc
30  * 1.2.1:
31  *      - allow concurrent access to bo's mapped read/write.
32  * 1.2.2:
33  *      - add NOUVEAU_GEM_DOMAIN_COHERENT flag
34  * 1.3.0:
35  *      - NVIF ABI modified, safe because only (current) users are test
36  *        programs that get directly linked with NVKM.
37  * 1.3.1:
38  *      - implemented limited ABI16/NVIF interop
39  */
40 
41 #include <linux/notifier.h>
42 
43 #include <nvif/client.h>
44 #include <nvif/device.h>
45 #include <nvif/ioctl.h>
46 #include <nvif/mmu.h>
47 #include <nvif/vmm.h>
48 
49 #include <drm/drm_connector.h>
50 #include <drm/drm_device.h>
51 #include <drm/drm_drv.h>
52 #include <drm/drm_file.h>
53 
54 #include <drm/ttm/ttm_bo.h>
55 #include <drm/ttm/ttm_placement.h>
56 
57 #include <drm/drm_audio_component.h>
58 
59 #include "uapi/drm/nouveau_drm.h"
60 
61 struct nouveau_channel;
62 struct platform_device;
63 
64 #include "nouveau_fence.h"
65 #include "nouveau_bios.h"
66 #include "nouveau_sched.h"
67 #include "nouveau_vmm.h"
68 #include "nouveau_uvmm.h"
69 
70 struct nouveau_drm_tile {
71 	struct nouveau_fence *fence;
72 	bool used;
73 };
74 
75 enum nouveau_drm_object_route {
76 	NVDRM_OBJECT_NVIF = NVIF_IOCTL_V0_OWNER_NVIF,
77 	NVDRM_OBJECT_USIF,
78 	NVDRM_OBJECT_ABI16,
79 	NVDRM_OBJECT_ANY = NVIF_IOCTL_V0_OWNER_ANY,
80 };
81 
82 enum nouveau_drm_handle {
83 	NVDRM_CHAN    = 0xcccc0000, /* |= client chid */
84 	NVDRM_NVSW    = 0x55550000,
85 };
86 
87 struct nouveau_cli {
88 	struct nvif_client base;
89 	struct nouveau_drm *drm;
90 	struct mutex mutex;
91 
92 	struct nvif_device device;
93 	struct nvif_mmu mmu;
94 	struct nouveau_vmm vmm;
95 	struct nouveau_vmm svm;
96 	struct {
97 		struct nouveau_uvmm *ptr;
98 		bool disabled;
99 	} uvmm;
100 
101 	struct nouveau_sched *sched;
102 
103 	const struct nvif_mclass *mem;
104 
105 	struct list_head head;
106 	void *abi16;
107 	struct list_head objects;
108 	char name[32];
109 
110 	struct work_struct work;
111 	struct list_head worker;
112 	struct mutex lock;
113 };
114 
115 struct nouveau_cli_work {
116 	void (*func)(struct nouveau_cli_work *);
117 	struct nouveau_cli *cli;
118 	struct list_head head;
119 
120 	struct dma_fence *fence;
121 	struct dma_fence_cb cb;
122 };
123 
124 static inline struct nouveau_uvmm *
125 nouveau_cli_uvmm(struct nouveau_cli *cli)
126 {
127 	return cli ? cli->uvmm.ptr : NULL;
128 }
129 
130 static inline struct nouveau_uvmm *
131 nouveau_cli_uvmm_locked(struct nouveau_cli *cli)
132 {
133 	struct nouveau_uvmm *uvmm;
134 
135 	mutex_lock(&cli->mutex);
136 	uvmm = nouveau_cli_uvmm(cli);
137 	mutex_unlock(&cli->mutex);
138 
139 	return uvmm;
140 }
141 
142 static inline struct nouveau_vmm *
143 nouveau_cli_vmm(struct nouveau_cli *cli)
144 {
145 	struct nouveau_uvmm *uvmm;
146 
147 	uvmm = nouveau_cli_uvmm(cli);
148 	if (uvmm)
149 		return &uvmm->vmm;
150 
151 	if (cli->svm.cli)
152 		return &cli->svm;
153 
154 	return &cli->vmm;
155 }
156 
157 static inline void
158 __nouveau_cli_disable_uvmm_noinit(struct nouveau_cli *cli)
159 {
160 	struct nouveau_uvmm *uvmm = nouveau_cli_uvmm(cli);
161 
162 	if (!uvmm)
163 		cli->uvmm.disabled = true;
164 }
165 
166 static inline void
167 nouveau_cli_disable_uvmm_noinit(struct nouveau_cli *cli)
168 {
169 	mutex_lock(&cli->mutex);
170 	__nouveau_cli_disable_uvmm_noinit(cli);
171 	mutex_unlock(&cli->mutex);
172 }
173 
174 void nouveau_cli_work_queue(struct nouveau_cli *, struct dma_fence *,
175 			    struct nouveau_cli_work *);
176 
177 static inline struct nouveau_cli *
178 nouveau_cli(struct drm_file *fpriv)
179 {
180 	return fpriv ? fpriv->driver_priv : NULL;
181 }
182 
183 static inline void
184 u_free(void *addr)
185 {
186 	kvfree(addr);
187 }
188 
189 static inline void *
190 u_memcpya(uint64_t user, unsigned int nmemb, unsigned int size)
191 {
192 	void __user *userptr = u64_to_user_ptr(user);
193 	size_t bytes;
194 
195 	if (unlikely(check_mul_overflow(nmemb, size, &bytes)))
196 		return ERR_PTR(-EOVERFLOW);
197 	return vmemdup_user(userptr, bytes);
198 }
199 
200 #include <nvif/object.h>
201 #include <nvif/parent.h>
202 
203 struct nouveau_drm {
204 	struct nvkm_device *nvkm;
205 	struct nvif_parent parent;
206 	struct mutex client_mutex;
207 	struct nvif_client _client;
208 	struct nvif_device device;
209 	struct nvif_mmu mmu;
210 
211 	struct nouveau_cli client;
212 	struct drm_device *dev;
213 
214 	struct list_head clients;
215 
216 	/**
217 	 * @clients_lock: Protects access to the @clients list of &struct nouveau_cli.
218 	 */
219 	struct mutex clients_lock;
220 
221 	u8 old_pm_cap;
222 
223 	struct {
224 		struct agp_bridge_data *bridge;
225 		u32 base;
226 		u32 size;
227 		bool cma;
228 	} agp;
229 
230 	/* TTM interface support */
231 	struct {
232 		struct ttm_device bdev;
233 		atomic_t validate_sequence;
234 		int (*move)(struct nouveau_channel *,
235 			    struct ttm_buffer_object *,
236 			    struct ttm_resource *, struct ttm_resource *);
237 		struct nouveau_channel *chan;
238 		struct nvif_object copy;
239 		int mtrr;
240 		int type_vram;
241 		int type_host[2];
242 		int type_ncoh[2];
243 		struct mutex io_reserve_mutex;
244 		struct list_head io_reserve_lru;
245 	} ttm;
246 
247 	/* GEM interface support */
248 	struct {
249 		u64 vram_available;
250 		u64 gart_available;
251 	} gem;
252 
253 	/* synchronisation */
254 	void *fence;
255 
256 	/* Global channel management. */
257 	int chan_total; /* Number of channels across all runlists. */
258 	int chan_nr;	/* 0 if per-runlist CHIDs. */
259 	int runl_nr;
260 	struct {
261 		int chan_nr;
262 		int chan_id_base;
263 		u64 context_base;
264 	} *runl;
265 
266 	/* Workqueue used for channel schedulers. */
267 	struct workqueue_struct *sched_wq;
268 
269 	/* context for accelerated drm-internal operations */
270 	struct nouveau_channel *cechan;
271 	struct nouveau_channel *channel;
272 	struct nvkm_gpuobj *notify;
273 	struct nvif_object ntfy;
274 
275 	/* nv10-nv40 tiling regions */
276 	struct {
277 		struct nouveau_drm_tile reg[15];
278 		spinlock_t lock;
279 	} tile;
280 
281 	/* modesetting */
282 	struct nvbios vbios;
283 	struct nouveau_display *display;
284 	bool headless;
285 	struct work_struct hpd_work;
286 	spinlock_t hpd_lock;
287 	u32 hpd_pending;
288 #ifdef CONFIG_ACPI
289 	struct notifier_block acpi_nb;
290 #endif
291 
292 	/* power management */
293 	struct nouveau_hwmon *hwmon;
294 	struct nouveau_debugfs *debugfs;
295 
296 	/* led management */
297 	struct nouveau_led *led;
298 
299 	struct dev_pm_domain vga_pm_domain;
300 
301 	struct nouveau_svm *svm;
302 
303 	struct nouveau_dmem *dmem;
304 
305 	struct {
306 		struct drm_audio_component *component;
307 		struct mutex lock;
308 		bool component_registered;
309 	} audio;
310 };
311 
312 static inline struct nouveau_drm *
313 nouveau_drm(struct drm_device *dev)
314 {
315 	return dev->dev_private;
316 }
317 
318 static inline bool
319 nouveau_drm_use_coherent_gpu_mapping(struct nouveau_drm *drm)
320 {
321 	struct nvif_mmu *mmu = &drm->client.mmu;
322 	return !(mmu->type[drm->ttm.type_host[0]].type & NVIF_MEM_UNCACHED);
323 }
324 
325 int nouveau_pmops_suspend(struct device *);
326 int nouveau_pmops_resume(struct device *);
327 bool nouveau_pmops_runtime(void);
328 
329 #include <nvkm/core/tegra.h>
330 
331 struct drm_device *
332 nouveau_platform_device_create(const struct nvkm_device_tegra_func *,
333 			       struct platform_device *, struct nvkm_device **);
334 void nouveau_drm_device_remove(struct nouveau_drm *);
335 
336 #define NV_PRINTK(l,c,f,a...) do {                                             \
337 	struct nouveau_cli *_cli = (c);                                        \
338 	dev_##l(_cli->drm->dev->dev, "%s: "f, _cli->name, ##a);                \
339 } while(0)
340 
341 #define NV_PRINTK_(l,drm,f,a...) do {             \
342 	dev_##l((drm)->nvkm->dev, "drm: "f, ##a); \
343 } while(0)
344 #define NV_FATAL(drm,f,a...) NV_PRINTK_(crit, (drm), f, ##a)
345 #define NV_ERROR(drm,f,a...) NV_PRINTK_(err, (drm), f, ##a)
346 #define NV_WARN(drm,f,a...) NV_PRINTK_(warn, (drm), f, ##a)
347 #define NV_INFO(drm,f,a...) NV_PRINTK_(info, (drm), f, ##a)
348 
349 #define NV_DEBUG(drm,f,a...) do {                                              \
350 	if (drm_debug_enabled(DRM_UT_DRIVER))                                  \
351 		NV_PRINTK_(info, (drm), f, ##a);                               \
352 } while(0)
353 #define NV_ATOMIC(drm,f,a...) do {                                             \
354 	if (drm_debug_enabled(DRM_UT_ATOMIC))                                  \
355 		NV_PRINTK_(info, (drm), f, ##a);                               \
356 } while(0)
357 
358 #define NV_PRINTK_ONCE(l,c,f,a...) NV_PRINTK(l##_once,c,f, ##a)
359 
360 #define NV_ERROR_ONCE(drm,f,a...) NV_PRINTK_ONCE(err, &(drm)->client, f, ##a)
361 #define NV_WARN_ONCE(drm,f,a...) NV_PRINTK_ONCE(warn, &(drm)->client, f, ##a)
362 #define NV_INFO_ONCE(drm,f,a...) NV_PRINTK_ONCE(info, &(drm)->client, f, ##a)
363 
364 extern int nouveau_modeset;
365 
366 /*XXX: Don't use these in new code.
367  *
368  * These accessors are used in a few places (mostly older code paths)
369  * to get direct access to NVKM structures, where a more well-defined
370  * interface doesn't exist.  Outside of the current use, these should
371  * not be relied on, and instead be implemented as NVIF.
372  *
373  * This is especially important when considering GSP-RM, as a lot the
374  * modules don't exist, or are "stub" implementations that just allow
375  * the GSP-RM paths to be bootstrapped.
376  */
377 #include <subdev/bios.h>
378 #include <subdev/fb.h>
379 #include <subdev/gpio.h>
380 #include <subdev/clk.h>
381 #include <subdev/i2c.h>
382 #include <subdev/timer.h>
383 #include <subdev/therm.h>
384 
385 static inline struct nvkm_device *
386 nvxx_device(struct nouveau_drm *drm)
387 {
388 	return drm->nvkm;
389 }
390 
391 #define nvxx_bios(a) nvxx_device(a)->bios
392 #define nvxx_fb(a) nvxx_device(a)->fb
393 #define nvxx_gpio(a) nvxx_device(a)->gpio
394 #define nvxx_clk(a) nvxx_device(a)->clk
395 #define nvxx_i2c(a) nvxx_device(a)->i2c
396 #define nvxx_iccsense(a) nvxx_device(a)->iccsense
397 #define nvxx_therm(a) nvxx_device(a)->therm
398 #define nvxx_volt(a) nvxx_device(a)->volt
399 
400 #include <engine/gr.h>
401 
402 #define nvxx_gr(a) nvxx_device(a)->gr
403 #endif
404