xref: /linux/drivers/gpu/drm/nouveau/include/nvkm/core/object.h (revision 8185461e531c39d67aa4705d7f94873feb87adfd)
1 /* SPDX-License-Identifier: MIT */
2 #ifndef __NVKM_OBJECT_H__
3 #define __NVKM_OBJECT_H__
4 #include <core/oclass.h>
5 #include <core/suspend_state.h>
6 struct nvkm_event;
7 struct nvkm_gpuobj;
8 struct nvkm_uevent;
9 
10 struct nvkm_object {
11 	const struct nvkm_object_func *func;
12 	struct nvkm_client *client;
13 	struct nvkm_engine *engine;
14 	s32 oclass;
15 	u32 handle;
16 
17 	struct list_head head;
18 	struct list_head tree;
19 	u64 object;
20 	struct rb_node node;
21 };
22 
23 enum nvkm_object_map {
24 	NVKM_OBJECT_MAP_IO,
25 	NVKM_OBJECT_MAP_VA
26 };
27 
28 struct nvkm_object_func {
29 	void *(*dtor)(struct nvkm_object *);
30 	int (*init)(struct nvkm_object *);
31 	int (*fini)(struct nvkm_object *, enum nvkm_suspend_state suspend);
32 	int (*mthd)(struct nvkm_object *, u32 mthd, void *data, u32 size);
33 	int (*ntfy)(struct nvkm_object *, u32 mthd, struct nvkm_event **);
34 	int (*map)(struct nvkm_object *, void *argv, u32 argc,
35 		   enum nvkm_object_map *, u64 *addr, u64 *size);
36 	int (*unmap)(struct nvkm_object *);
37 	int (*bind)(struct nvkm_object *, struct nvkm_gpuobj *, int align,
38 		    struct nvkm_gpuobj **);
39 	int (*sclass)(struct nvkm_object *, int index, struct nvkm_oclass *);
40 	int (*uevent)(struct nvkm_object *, void *argv, u32 argc, struct nvkm_uevent *);
41 };
42 
43 void nvkm_object_ctor(const struct nvkm_object_func *,
44 		      const struct nvkm_oclass *, struct nvkm_object *);
45 int nvkm_object_new_(const struct nvkm_object_func *,
46 		     const struct nvkm_oclass *, void *data, u32 size,
47 		     struct nvkm_object **);
48 int nvkm_object_new(const struct nvkm_oclass *, void *data, u32 size,
49 		    struct nvkm_object **);
50 void nvkm_object_del(struct nvkm_object **);
51 void *nvkm_object_dtor(struct nvkm_object *);
52 int nvkm_object_init(struct nvkm_object *);
53 int nvkm_object_fini(struct nvkm_object *, enum nvkm_suspend_state);
54 int nvkm_object_mthd(struct nvkm_object *, u32 mthd, void *data, u32 size);
55 int nvkm_object_ntfy(struct nvkm_object *, u32 mthd, struct nvkm_event **);
56 int nvkm_object_map(struct nvkm_object *, void *argv, u32 argc,
57 		    enum nvkm_object_map *, u64 *addr, u64 *size);
58 int nvkm_object_unmap(struct nvkm_object *);
59 int nvkm_object_bind(struct nvkm_object *, struct nvkm_gpuobj *, int align,
60 		     struct nvkm_gpuobj **);
61 
62 bool nvkm_object_insert(struct nvkm_object *);
63 void nvkm_object_remove(struct nvkm_object *);
64 struct nvkm_object *nvkm_object_search(struct nvkm_client *, u64 object,
65 				       const struct nvkm_object_func *);
66 #endif
67