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