xref: /dragonfly/sys/dev/drm/include/linux/kobject.h (revision d8082429)
1 /*
2  * Copyright (c) 2016-2018 François Tigeot <ftigeot@wolfpond.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _LINUX_KOBJECT_H_
28 #define _LINUX_KOBJECT_H_
29 
30 #include <linux/types.h>
31 #include <linux/list.h>
32 #include <linux/sysfs.h>
33 #include <linux/compiler.h>
34 #include <linux/spinlock.h>
35 #include <linux/kref.h>
36 #include <linux/kernel.h>
37 #include <linux/wait.h>
38 #include <linux/atomic.h>
39 
40 enum kobject_action {
41 	KOBJ_ADD,
42 	KOBJ_REMOVE,
43 	KOBJ_CHANGE,
44 	KOBJ_MOVE,
45 	KOBJ_ONLINE,
46 	KOBJ_OFFLINE,
47 	KOBJ_MAX
48 };
49 
50 struct kobject {
51 	const char *name;
52 	struct kref kref;
53 	struct kobj_type *ktype;
54 };
55 
56 struct kobj_type {
57 	void (*release)(struct kobject *kobj);
58 	const struct sysfs_ops *sysfs_ops;
59 	struct attribute **default_attrs;
60 };
61 
62 static inline int
63 kobject_uevent_env(struct kobject *kobj, enum kobject_action action, char *envp[])
64 {
65 	return 0;
66 }
67 
68 extern __printf(4, 5) __must_check
69 int kobject_init_and_add(struct kobject *kobj,
70 			 struct kobj_type *ktype, struct kobject *parent,
71 			 const char *fmt, ...);
72 
73 extern void kobject_release(struct kref *kref);
74 
75 static inline void
76 kobject_put(struct kobject *kobj)
77 {
78 	if (kobj != NULL)
79 		kref_put(&kobj->kref, kobject_release);
80 }
81 
82 static inline void
83 kobject_del(struct kobject *kobj)
84 {
85 	/*
86 	   This function is supposed to unlink the object from a hierarchy.
87 	   There is no such hierarchy in the DragonFly implementation, doing
88 	   nothing is fine.
89 	*/
90 }
91 
92 #endif	/* _LINUX_KOBJECT_H_ */
93