xref: /freebsd/sys/compat/linuxkpi/common/include/linux/kobject.h (revision 6be3386466ab79a84b48429ae66244f21526d3df)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	_LINUX_KOBJECT_H_
32 #define	_LINUX_KOBJECT_H_
33 
34 #include <machine/stdarg.h>
35 
36 #include <linux/kernel.h>
37 #include <linux/kref.h>
38 #include <linux/list.h>
39 #include <linux/slab.h>
40 
41 struct kobject;
42 struct sysctl_oid;
43 
44 #define	KOBJ_CHANGE		0x01
45 
46 struct kobj_type {
47 	void (*release)(struct kobject *kobj);
48 	const struct sysfs_ops *sysfs_ops;
49 	struct attribute **default_attrs;
50 };
51 
52 extern const struct kobj_type linux_kfree_type;
53 
54 struct kobject {
55 	struct kobject		*parent;
56 	char			*name;
57 	struct kref		kref;
58 	const struct kobj_type	*ktype;
59 	struct list_head	entry;
60 	struct sysctl_oid	*oidp;
61 };
62 
63 extern struct kobject *mm_kobj;
64 
65 struct attribute {
66 	const char	*name;
67 	struct module	*owner;
68 	mode_t		mode;
69 };
70 
71 struct kobj_attribute {
72 	struct attribute attr;
73 	ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
74 	    char *buf);
75 	ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
76 	    const char *buf, size_t count);
77 };
78 
79 static inline void
80 kobject_init(struct kobject *kobj, const struct kobj_type *ktype)
81 {
82 
83 	kref_init(&kobj->kref);
84 	INIT_LIST_HEAD(&kobj->entry);
85 	kobj->ktype = ktype;
86 	kobj->oidp = NULL;
87 }
88 
89 void linux_kobject_release(struct kref *kref);
90 
91 static inline void
92 kobject_put(struct kobject *kobj)
93 {
94 
95 	if (kobj)
96 		kref_put(&kobj->kref, linux_kobject_release);
97 }
98 
99 static inline struct kobject *
100 kobject_get(struct kobject *kobj)
101 {
102 
103 	if (kobj)
104 		kref_get(&kobj->kref);
105 	return kobj;
106 }
107 
108 int	kobject_set_name_vargs(struct kobject *kobj, const char *fmt, va_list);
109 int	kobject_add(struct kobject *kobj, struct kobject *parent,
110 	    const char *fmt, ...);
111 
112 static inline struct kobject *
113 kobject_create(void)
114 {
115 	struct kobject *kobj;
116 
117 	kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
118 	if (kobj == NULL)
119 		return (NULL);
120 	kobject_init(kobj, &linux_kfree_type);
121 
122 	return (kobj);
123 }
124 
125 static inline struct kobject *
126 kobject_create_and_add(const char *name, struct kobject *parent)
127 {
128 	struct kobject *kobj;
129 
130 	kobj = kobject_create();
131 	if (kobj == NULL)
132 		return (NULL);
133 	if (kobject_add(kobj, parent, "%s", name) == 0)
134 		return (kobj);
135 	kobject_put(kobj);
136 
137 	return (NULL);
138 }
139 
140 static inline void
141 kobject_del(struct kobject *kobj __unused)
142 {
143 }
144 
145 static inline char *
146 kobject_name(const struct kobject *kobj)
147 {
148 
149 	return kobj->name;
150 }
151 
152 int	kobject_set_name(struct kobject *kobj, const char *fmt, ...);
153 int	kobject_init_and_add(struct kobject *kobj, const struct kobj_type *ktype,
154 	    struct kobject *parent, const char *fmt, ...);
155 
156 static __inline void
157 kobject_uevent_env(struct kobject *kobj, int action, char *envp[])
158 {
159 
160 	/*
161 	 * iwlwifi(4) sends an INACCESSIBLE event when it detects that the card
162 	 * (pice endpoint) is gone and it attempts a removal cleanup.
163 	 * Not sure if we do anything related to udev/sysfs at the moment or
164 	 * need a shortcut or simply ignore it (for now).
165 	 */
166 }
167 
168 #endif /* _LINUX_KOBJECT_H_ */
169