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 _LINUXKPI_LINUX_KOBJECT_H_ 32 #define _LINUXKPI_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 extern const struct sysfs_ops kobj_sysfs_ops; 72 73 struct kobj_attribute { 74 struct attribute attr; 75 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr, 76 char *buf); 77 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr, 78 const char *buf, size_t count); 79 }; 80 81 static inline void 82 kobject_init(struct kobject *kobj, const struct kobj_type *ktype) 83 { 84 85 kref_init(&kobj->kref); 86 INIT_LIST_HEAD(&kobj->entry); 87 kobj->ktype = ktype; 88 kobj->oidp = NULL; 89 } 90 91 void linux_kobject_release(struct kref *kref); 92 93 static inline void 94 kobject_put(struct kobject *kobj) 95 { 96 97 if (kobj) 98 kref_put(&kobj->kref, linux_kobject_release); 99 } 100 101 static inline struct kobject * 102 kobject_get(struct kobject *kobj) 103 { 104 105 if (kobj) 106 kref_get(&kobj->kref); 107 return kobj; 108 } 109 110 int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, va_list); 111 int kobject_add(struct kobject *kobj, struct kobject *parent, 112 const char *fmt, ...); 113 114 static inline struct kobject * 115 kobject_create(void) 116 { 117 struct kobject *kobj; 118 119 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL); 120 if (kobj == NULL) 121 return (NULL); 122 kobject_init(kobj, &linux_kfree_type); 123 124 return (kobj); 125 } 126 127 static inline struct kobject * 128 kobject_create_and_add(const char *name, struct kobject *parent) 129 { 130 struct kobject *kobj; 131 132 kobj = kobject_create(); 133 if (kobj == NULL) 134 return (NULL); 135 if (kobject_add(kobj, parent, "%s", name) == 0) 136 return (kobj); 137 kobject_put(kobj); 138 139 return (NULL); 140 } 141 142 static inline void 143 kobject_del(struct kobject *kobj __unused) 144 { 145 } 146 147 static inline char * 148 kobject_name(const struct kobject *kobj) 149 { 150 151 return kobj->name; 152 } 153 154 int kobject_set_name(struct kobject *kobj, const char *fmt, ...); 155 int kobject_init_and_add(struct kobject *kobj, const struct kobj_type *ktype, 156 struct kobject *parent, const char *fmt, ...); 157 158 static __inline void 159 kobject_uevent_env(struct kobject *kobj, int action, char *envp[]) 160 { 161 162 /* 163 * iwlwifi(4) sends an INACCESSIBLE event when it detects that the card 164 * (pice endpoint) is gone and it attempts a removal cleanup. 165 * Not sure if we do anything related to udev/sysfs at the moment or 166 * need a shortcut or simply ignore it (for now). 167 */ 168 } 169 170 #endif /* _LINUXKPI_LINUX_KOBJECT_H_ */ 171