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 #ifndef _LINUXKPI_LINUX_KOBJECT_H_
30 #define _LINUXKPI_LINUX_KOBJECT_H_
31
32 #include <machine/stdarg.h>
33
34 #include <linux/kernel.h>
35 #include <linux/kref.h>
36 #include <linux/list.h>
37 #include <linux/slab.h>
38 #include <linux/spinlock.h>
39 #include <linux/wait.h>
40 #include <linux/workqueue.h>
41
42 struct kobject;
43 struct sysctl_oid;
44
45 #define KOBJ_CHANGE 0x01
46
47 struct kobj_type {
48 void (*release)(struct kobject *kobj);
49 const struct sysfs_ops *sysfs_ops;
50 struct attribute **default_attrs;
51 const struct attribute_group **default_groups;
52 };
53
54 extern const struct kobj_type linux_kfree_type;
55
56 struct kobject {
57 struct kobject *parent;
58 char *name;
59 struct kref kref;
60 const struct kobj_type *ktype;
61 struct list_head entry;
62 struct sysctl_oid *oidp;
63 };
64
65 extern struct kobject *mm_kobj;
66
67 struct attribute {
68 const char *name;
69 struct module *owner;
70 mode_t mode;
71 };
72
73 extern const struct sysfs_ops kobj_sysfs_ops;
74
75 struct kobj_attribute {
76 struct attribute attr;
77 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
78 char *buf);
79 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
80 const char *buf, size_t count);
81 };
82
83 static inline void
kobject_init(struct kobject * kobj,const struct kobj_type * ktype)84 kobject_init(struct kobject *kobj, const struct kobj_type *ktype)
85 {
86
87 kref_init(&kobj->kref);
88 INIT_LIST_HEAD(&kobj->entry);
89 kobj->ktype = ktype;
90 kobj->oidp = NULL;
91 }
92
93 void linux_kobject_release(struct kref *kref);
94
95 static inline void
kobject_put(struct kobject * kobj)96 kobject_put(struct kobject *kobj)
97 {
98
99 if (kobj)
100 kref_put(&kobj->kref, linux_kobject_release);
101 }
102
103 static inline struct kobject *
kobject_get(struct kobject * kobj)104 kobject_get(struct kobject *kobj)
105 {
106
107 if (kobj)
108 kref_get(&kobj->kref);
109 return kobj;
110 }
111
112 struct kobject *kobject_create(void);
113 int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, va_list);
114 int kobject_add(struct kobject *kobj, struct kobject *parent,
115 const char *fmt, ...);
116
117 static inline struct kobject *
kobject_create_and_add(const char * name,struct kobject * parent)118 kobject_create_and_add(const char *name, struct kobject *parent)
119 {
120 struct kobject *kobj;
121
122 kobj = kobject_create();
123 if (kobj == NULL)
124 return (NULL);
125 if (kobject_add(kobj, parent, "%s", name) == 0)
126 return (kobj);
127 kobject_put(kobj);
128
129 return (NULL);
130 }
131
132 static inline void
kobject_del(struct kobject * kobj __unused)133 kobject_del(struct kobject *kobj __unused)
134 {
135 }
136
137 static inline char *
kobject_name(const struct kobject * kobj)138 kobject_name(const struct kobject *kobj)
139 {
140
141 return kobj->name;
142 }
143
144 int kobject_set_name(struct kobject *kobj, const char *fmt, ...);
145 int kobject_init_and_add(struct kobject *kobj, const struct kobj_type *ktype,
146 struct kobject *parent, const char *fmt, ...);
147
148 static __inline void
kobject_uevent_env(struct kobject * kobj,int action,char * envp[])149 kobject_uevent_env(struct kobject *kobj, int action, char *envp[])
150 {
151
152 /*
153 * iwlwifi(4) sends an INACCESSIBLE event when it detects that the card
154 * (pice endpoint) is gone and it attempts a removal cleanup.
155 * Not sure if we do anything related to udev/sysfs at the moment or
156 * need a shortcut or simply ignore it (for now).
157 */
158 }
159
160 void linux_kobject_kfree_name(struct kobject *kobj);
161
162 #endif /* _LINUXKPI_LINUX_KOBJECT_H_ */
163