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		3
14#define DRIVER_PATCHLEVEL	1
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_api.h>
55#include <drm/ttm/ttm_bo_driver.h>
56#include <drm/ttm/ttm_placement.h>
57#include <drm/ttm/ttm_memory.h>
58#include <drm/ttm/ttm_module.h>
59#include <drm/ttm/ttm_page_alloc.h>
60
61#include <drm/drm_audio_component.h>
62
63#include "uapi/drm/nouveau_drm.h"
64
65struct nouveau_channel;
66struct platform_device;
67
68#include "nouveau_fence.h"
69#include "nouveau_bios.h"
70#include "nouveau_vmm.h"
71
72struct nouveau_drm_tile {
73	struct nouveau_fence *fence;
74	bool used;
75};
76
77enum nouveau_drm_object_route {
78	NVDRM_OBJECT_NVIF = NVIF_IOCTL_V0_OWNER_NVIF,
79	NVDRM_OBJECT_USIF,
80	NVDRM_OBJECT_ABI16,
81	NVDRM_OBJECT_ANY = NVIF_IOCTL_V0_OWNER_ANY,
82};
83
84enum nouveau_drm_notify_route {
85	NVDRM_NOTIFY_NVIF = 0,
86	NVDRM_NOTIFY_USIF
87};
88
89enum nouveau_drm_handle {
90	NVDRM_CHAN    = 0xcccc0000, /* |= client chid */
91	NVDRM_NVSW    = 0x55550000,
92};
93
94struct nouveau_cli {
95	struct nvif_client base;
96	struct nouveau_drm *drm;
97	struct mutex mutex;
98
99	struct nvif_device device;
100	struct nvif_mmu mmu;
101	struct nouveau_vmm vmm;
102	struct nouveau_vmm svm;
103	const struct nvif_mclass *mem;
104
105	struct list_head head;
106	void *abi16;
107	struct list_head objects;
108	struct list_head notifys;
109	char name[32];
110
111	struct work_struct work;
112	struct list_head worker;
113	struct mutex lock;
114};
115
116struct nouveau_cli_work {
117	void (*func)(struct nouveau_cli_work *);
118	struct nouveau_cli *cli;
119	struct list_head head;
120
121	struct dma_fence *fence;
122	struct dma_fence_cb cb;
123};
124
125void nouveau_cli_work_queue(struct nouveau_cli *, struct dma_fence *,
126			    struct nouveau_cli_work *);
127
128static inline struct nouveau_cli *
129nouveau_cli(struct drm_file *fpriv)
130{
131	return fpriv ? fpriv->driver_priv : NULL;
132}
133
134#include <nvif/object.h>
135#include <nvif/parent.h>
136
137struct nouveau_drm {
138	struct nvif_parent parent;
139	struct nouveau_cli master;
140	struct nouveau_cli client;
141	struct drm_device *dev;
142
143	struct list_head clients;
144
145	/**
146	 * @clients_lock: Protects access to the @clients list of &struct nouveau_cli.
147	 */
148	struct mutex clients_lock;
149
150	u8 old_pm_cap;
151
152	struct {
153		struct agp_bridge_data *bridge;
154		u32 base;
155		u32 size;
156		bool cma;
157	} agp;
158
159	/* TTM interface support */
160	struct {
161		struct ttm_bo_device bdev;
162		atomic_t validate_sequence;
163		int (*move)(struct nouveau_channel *,
164			    struct ttm_buffer_object *,
165			    struct ttm_resource *, struct ttm_resource *);
166		struct nouveau_channel *chan;
167		struct nvif_object copy;
168		int mtrr;
169		int type_vram;
170		int type_host[2];
171		int type_ncoh[2];
172		struct mutex io_reserve_mutex;
173		struct list_head io_reserve_lru;
174	} ttm;
175
176	/* GEM interface support */
177	struct {
178		u64 vram_available;
179		u64 gart_available;
180	} gem;
181
182	/* synchronisation */
183	void *fence;
184
185	/* Global channel management. */
186	struct {
187		int nr;
188		u64 context_base;
189	} chan;
190
191	/* context for accelerated drm-internal operations */
192	struct nouveau_channel *cechan;
193	struct nouveau_channel *channel;
194	struct nvkm_gpuobj *notify;
195	struct nouveau_fbdev *fbcon;
196	struct nvif_object ntfy;
197
198	/* nv10-nv40 tiling regions */
199	struct {
200		struct nouveau_drm_tile reg[15];
201		spinlock_t lock;
202	} tile;
203
204	/* modesetting */
205	struct nvbios vbios;
206	struct nouveau_display *display;
207	struct work_struct hpd_work;
208	struct mutex hpd_lock;
209	u32 hpd_pending;
210	struct work_struct fbcon_work;
211	int fbcon_new_state;
212#ifdef CONFIG_ACPI
213	struct notifier_block acpi_nb;
214#endif
215
216	/* power management */
217	struct nouveau_hwmon *hwmon;
218	struct nouveau_debugfs *debugfs;
219
220	/* led management */
221	struct nouveau_led *led;
222
223	struct dev_pm_domain vga_pm_domain;
224
225	struct nouveau_svm *svm;
226
227	struct nouveau_dmem *dmem;
228
229	struct {
230		struct drm_audio_component *component;
231		bool component_registered;
232	} audio;
233};
234
235static inline struct nouveau_drm *
236nouveau_drm(struct drm_device *dev)
237{
238	return dev->dev_private;
239}
240
241static inline bool
242nouveau_drm_use_coherent_gpu_mapping(struct nouveau_drm *drm)
243{
244	struct nvif_mmu *mmu = &drm->client.mmu;
245	return !(mmu->type[drm->ttm.type_host[0]].type & NVIF_MEM_UNCACHED);
246}
247
248int nouveau_pmops_suspend(struct device *);
249int nouveau_pmops_resume(struct device *);
250bool nouveau_pmops_runtime(void);
251
252#include <nvkm/core/tegra.h>
253
254struct drm_device *
255nouveau_platform_device_create(const struct nvkm_device_tegra_func *,
256			       struct platform_device *, struct nvkm_device **);
257void nouveau_drm_device_remove(struct drm_device *dev);
258
259#define NV_PRINTK(l,c,f,a...) do {                                             \
260	struct nouveau_cli *_cli = (c);                                        \
261	dev_##l(_cli->drm->dev->dev, "%s: "f, _cli->name, ##a);                \
262} while(0)
263
264#define NV_FATAL(drm,f,a...) NV_PRINTK(crit, &(drm)->client, f, ##a)
265#define NV_ERROR(drm,f,a...) NV_PRINTK(err, &(drm)->client, f, ##a)
266#define NV_WARN(drm,f,a...) NV_PRINTK(warn, &(drm)->client, f, ##a)
267#define NV_INFO(drm,f,a...) NV_PRINTK(info, &(drm)->client, f, ##a)
268
269#define NV_DEBUG(drm,f,a...) do {                                              \
270	if (drm_debug_enabled(DRM_UT_DRIVER))                                  \
271		NV_PRINTK(info, &(drm)->client, f, ##a);                       \
272} while(0)
273#define NV_ATOMIC(drm,f,a...) do {                                             \
274	if (drm_debug_enabled(DRM_UT_ATOMIC))                                  \
275		NV_PRINTK(info, &(drm)->client, f, ##a);                       \
276} while(0)
277
278#define NV_PRINTK_ONCE(l,c,f,a...) NV_PRINTK(l##_once,c,f, ##a)
279
280#define NV_ERROR_ONCE(drm,f,a...) NV_PRINTK_ONCE(err, &(drm)->client, f, ##a)
281#define NV_WARN_ONCE(drm,f,a...) NV_PRINTK_ONCE(warn, &(drm)->client, f, ##a)
282#define NV_INFO_ONCE(drm,f,a...) NV_PRINTK_ONCE(info, &(drm)->client, f, ##a)
283
284extern int nouveau_modeset;
285
286#endif
287