sys/compat/linuxkpi/common/include/linux/device.h

   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-2016 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_DEVICE_H_
  32 #define _LINUX_DEVICE_H_
  33
  34 #include <linux/err.h>
  35 #include <linux/types.h>
  36 #include <linux/kobject.h>
  37 #include <linux/sysfs.h>
  38 #include <linux/list.h>
  39 #include <linux/compiler.h>
  40 #include <linux/types.h>
  41 #include <linux/module.h>
  42 #include <linux/workqueue.h>
  43 #include <linux/sysfs.h>
  44 #include <linux/kdev_t.h>
  45 #include <asm/atomic.h>
  46
  47 #include <sys/bus.h>
  48
  49 struct device;
  50 struct fwnode_handle;
  51
  52 struct class {
  53         const char      *name;
  54         struct module   *owner;
  55         struct kobject  kobj;
  56         devclass_t      bsdclass;
  57         const struct dev_pm_ops *pm;
  58         void            (*class_release)(struct class *class);
  59         void            (*dev_release)(struct device *dev);
  60         char *          (*devnode)(struct device *dev, umode_t *mode);
  61 };
  62
  63 struct dev_pm_ops {
  64         int (*suspend)(struct device *dev);
  65         int (*suspend_late)(struct device *dev);
  66         int (*resume)(struct device *dev);
  67         int (*resume_early)(struct device *dev);
  68         int (*freeze)(struct device *dev);
  69         int (*freeze_late)(struct device *dev);
  70         int (*thaw)(struct device *dev);
  71         int (*thaw_early)(struct device *dev);
  72         int (*poweroff)(struct device *dev);
  73         int (*poweroff_late)(struct device *dev);
  74         int (*restore)(struct device *dev);
  75         int (*restore_early)(struct device *dev);
  76         int (*runtime_suspend)(struct device *dev);
  77         int (*runtime_resume)(struct device *dev);
  78         int (*runtime_idle)(struct device *dev);
  79 };
  80
  81 struct device_driver {
  82         const char      *name;
  83         const struct dev_pm_ops *pm;
  84 };
  85
  86 struct device_type {
  87         const char      *name;
  88 };
  89
  90 struct device {
  91         struct device   *parent;
  92         struct list_head irqents;
  93         device_t        bsddev;
  94         /*
  95          * The following flag is used to determine if the LinuxKPI is
  96          * responsible for detaching the BSD device or not. If the
  97          * LinuxKPI got the BSD device using devclass_get_device(), it
  98          * must not try to detach or delete it, because it's already
  99          * done somewhere else.
 100          */
 101         bool            bsddev_attached_here;
 102         struct device_driver *driver;
 103         struct device_type *type;
 104         dev_t           devt;
 105         struct class    *class;
 106         void            (*release)(struct device *dev);
 107         struct kobject  kobj;
 108         uint64_t        *dma_mask;
 109         void            *driver_data;
 110         unsigned int    irq;
 111 #define LINUX_IRQ_INVALID       65535
 112         unsigned int    msix;
 113         unsigned int    msix_max;
 114         const struct attribute_group **groups;
 115         struct fwnode_handle *fwnode;
 116
 117         spinlock_t      devres_lock;
 118         struct list_head devres_head;
 119 };
 120
 121 extern struct device linux_root_device;
 122 extern struct kobject linux_class_root;
 123 extern const struct kobj_type linux_dev_ktype;
 124 extern const struct kobj_type linux_class_ktype;
 125
 126 struct class_attribute {
 127         struct attribute attr;
 128         ssize_t (*show)(struct class *, struct class_attribute *, char *);
 129         ssize_t (*store)(struct class *, struct class_attribute *, const char *, size_t);
 130         const void *(*namespace)(struct class *, const struct class_attribute *);
 131 };
 132
 133 #define CLASS_ATTR(_name, _mode, _show, _store)                         \
 134         struct class_attribute class_attr_##_name =                     \
 135             { { #_name, NULL, _mode }, _show, _store }
 136
 137 struct device_attribute {
 138         struct attribute        attr;
 139         ssize_t                 (*show)(struct device *,
 140                                         struct device_attribute *, char *);
 141         ssize_t                 (*store)(struct device *,
 142                                         struct device_attribute *, const char *,
 143                                         size_t);
 144 };
 145
 146 #define DEVICE_ATTR(_name, _mode, _show, _store)                        \
 147         struct device_attribute dev_attr_##_name =                      \
 148             __ATTR(_name, _mode, _show, _store)
 149 #define DEVICE_ATTR_RO(_name)                                           \
 150         struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
 151 #define DEVICE_ATTR_WO(_name)                                           \
 152         struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
 153 #define DEVICE_ATTR_RW(_name)                                           \
 154         struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
 155
 156 /* Simple class attribute that is just a static string */
 157 struct class_attribute_string {
 158         struct class_attribute attr;
 159         char *str;
 160 };
 161
 162 static inline ssize_t
 163 show_class_attr_string(struct class *class,
 164                                 struct class_attribute *attr, char *buf)
 165 {
 166         struct class_attribute_string *cs;
 167         cs = container_of(attr, struct class_attribute_string, attr);
 168         return snprintf(buf, PAGE_SIZE, "%s\n", cs->str);
 169 }
 170
 171 /* Currently read-only only */
 172 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
 173         { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
 174 #define CLASS_ATTR_STRING(_name, _mode, _str) \
 175         struct class_attribute_string class_attr_##_name = \
 176                 _CLASS_ATTR_STRING(_name, _mode, _str)
 177
 178 #define dev_err(dev, fmt, ...)  device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
 179 #define dev_warn(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
 180 #define dev_info(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
 181 #define dev_notice(dev, fmt, ...)       device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
 182 #define dev_dbg(dev, fmt, ...)  do { } while (0)
 183 #define dev_printk(lvl, dev, fmt, ...)                                  \
 184             device_printf((dev)->bsddev, fmt, ##__VA_ARGS__)
 185
 186 #define dev_err_once(dev, ...) do {             \
 187         static bool __dev_err_once;             \
 188         if (!__dev_err_once) {                  \
 189                 __dev_err_once = 1;             \
 190                 dev_err(dev, __VA_ARGS__);      \
 191         }                                       \
 192 } while (0)
 193
 194 #define dev_err_ratelimited(dev, ...) do {      \
 195         static linux_ratelimit_t __ratelimited; \
 196         if (linux_ratelimited(&__ratelimited))  \
 197                 dev_err(dev, __VA_ARGS__);      \
 198 } while (0)
 199
 200 #define dev_warn_ratelimited(dev, ...) do {     \
 201         static linux_ratelimit_t __ratelimited; \
 202         if (linux_ratelimited(&__ratelimited))  \
 203                 dev_warn(dev, __VA_ARGS__);     \
 204 } while (0)
 205
 206 static inline void *
 207 dev_get_drvdata(const struct device *dev)
 208 {
 209
 210         return dev->driver_data;
 211 }
 212
 213 static inline void
 214 dev_set_drvdata(struct device *dev, void *data)
 215 {
 216
 217         dev->driver_data = data;
 218 }
 219
 220 static inline struct device *
 221 get_device(struct device *dev)
 222 {
 223
 224         if (dev)
 225                 kobject_get(&dev->kobj);
 226
 227         return (dev);
 228 }
 229
 230 static inline char *
 231 dev_name(const struct device *dev)
 232 {
 233
 234         return kobject_name(&dev->kobj);
 235 }
 236
 237 #define dev_set_name(_dev, _fmt, ...)                                   \
 238         kobject_set_name(&(_dev)->kobj, (_fmt), ##__VA_ARGS__)
 239
 240 static inline void
 241 put_device(struct device *dev)
 242 {
 243
 244         if (dev)
 245                 kobject_put(&dev->kobj);
 246 }
 247
 248 static inline int
 249 class_register(struct class *class)
 250 {
 251
 252         class->bsdclass = devclass_create(class->name);
 253         kobject_init(&class->kobj, &linux_class_ktype);
 254         kobject_set_name(&class->kobj, class->name);
 255         kobject_add(&class->kobj, &linux_class_root, class->name);
 256
 257         return (0);
 258 }
 259
 260 static inline void
 261 class_unregister(struct class *class)
 262 {
 263
 264         kobject_put(&class->kobj);
 265 }
 266
 267 static inline struct device *kobj_to_dev(struct kobject *kobj)
 268 {
 269         return container_of(kobj, struct device, kobj);
 270 }
 271
 272 /*
 273  * Devices are registered and created for exporting to sysfs. Create
 274  * implies register and register assumes the device fields have been
 275  * setup appropriately before being called.
 276  */
 277 static inline void
 278 device_initialize(struct device *dev)
 279 {
 280         device_t bsddev = NULL;
 281         int unit = -1;
 282
 283         if (dev->devt) {
 284                 unit = MINOR(dev->devt);
 285                 bsddev = devclass_get_device(dev->class->bsdclass, unit);
 286                 dev->bsddev_attached_here = false;
 287         } else if (dev->parent == NULL) {
 288                 bsddev = devclass_get_device(dev->class->bsdclass, 0);
 289                 dev->bsddev_attached_here = false;
 290         } else {
 291                 dev->bsddev_attached_here = true;
 292         }
 293
 294         if (bsddev == NULL && dev->parent != NULL) {
 295                 bsddev = device_add_child(dev->parent->bsddev,
 296                     dev->class->kobj.name, unit);
 297         }
 298
 299         if (bsddev != NULL)
 300                 device_set_softc(bsddev, dev);
 301
 302         dev->bsddev = bsddev;
 303         MPASS(dev->bsddev != NULL);
 304         kobject_init(&dev->kobj, &linux_dev_ktype);
 305
 306         spin_lock_init(&dev->devres_lock);
 307         INIT_LIST_HEAD(&dev->devres_head);
 308 }
 309
 310 static inline int
 311 device_add(struct device *dev)
 312 {
 313         if (dev->bsddev != NULL) {
 314                 if (dev->devt == 0)
 315                         dev->devt = makedev(0, device_get_unit(dev->bsddev));
 316         }
 317         kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev));
 318         return (0);
 319 }
 320
 321 static inline void
 322 device_create_release(struct device *dev)
 323 {
 324         kfree(dev);
 325 }
 326
 327 static inline struct device *
 328 device_create_groups_vargs(struct class *class, struct device *parent,
 329     dev_t devt, void *drvdata, const struct attribute_group **groups,
 330     const char *fmt, va_list args)
 331 {
 332         struct device *dev = NULL;
 333         int retval = -ENODEV;
 334
 335         if (class == NULL || IS_ERR(class))
 336                 goto error;
 337
 338         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 339         if (!dev) {
 340                 retval = -ENOMEM;
 341                 goto error;
 342         }
 343
 344         dev->devt = devt;
 345         dev->class = class;
 346         dev->parent = parent;
 347         dev->groups = groups;
 348         dev->release = device_create_release;
 349         /* device_initialize() needs the class and parent to be set */
 350         device_initialize(dev);
 351         dev_set_drvdata(dev, drvdata);
 352
 353         retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
 354         if (retval)
 355                 goto error;
 356
 357         retval = device_add(dev);
 358         if (retval)
 359                 goto error;
 360
 361         return dev;
 362
 363 error:
 364         put_device(dev);
 365         return ERR_PTR(retval);
 366 }
 367
 368 static inline struct device *
 369 device_create_with_groups(struct class *class,
 370     struct device *parent, dev_t devt, void *drvdata,
 371     const struct attribute_group **groups, const char *fmt, ...)
 372 {
 373         va_list vargs;
 374         struct device *dev;
 375
 376         va_start(vargs, fmt);
 377         dev = device_create_groups_vargs(class, parent, devt, drvdata,
 378             groups, fmt, vargs);
 379         va_end(vargs);
 380         return dev;
 381 }
 382
 383 static inline bool
 384 device_is_registered(struct device *dev)
 385 {
 386
 387         return (dev->bsddev != NULL);
 388 }
 389
 390 static inline int
 391 device_register(struct device *dev)
 392 {
 393         device_t bsddev = NULL;
 394         int unit = -1;
 395
 396         if (device_is_registered(dev))
 397                 goto done;
 398
 399         if (dev->devt) {
 400                 unit = MINOR(dev->devt);
 401                 bsddev = devclass_get_device(dev->class->bsdclass, unit);
 402                 dev->bsddev_attached_here = false;
 403         } else if (dev->parent == NULL) {
 404                 bsddev = devclass_get_device(dev->class->bsdclass, 0);
 405                 dev->bsddev_attached_here = false;
 406         } else {
 407                 dev->bsddev_attached_here = true;
 408         }
 409         if (bsddev == NULL && dev->parent != NULL) {
 410                 bsddev = device_add_child(dev->parent->bsddev,
 411                     dev->class->kobj.name, unit);
 412         }
 413         if (bsddev != NULL) {
 414                 if (dev->devt == 0)
 415                         dev->devt = makedev(0, device_get_unit(bsddev));
 416                 device_set_softc(bsddev, dev);
 417         }
 418         dev->bsddev = bsddev;
 419 done:
 420         kobject_init(&dev->kobj, &linux_dev_ktype);
 421         kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev));
 422
 423         return (0);
 424 }
 425
 426 static inline void
 427 device_unregister(struct device *dev)
 428 {
 429         device_t bsddev;
 430
 431         bsddev = dev->bsddev;
 432         dev->bsddev = NULL;
 433
 434         if (bsddev != NULL && dev->bsddev_attached_here) {
 435                 mtx_lock(&Giant);
 436                 device_delete_child(device_get_parent(bsddev), bsddev);
 437                 mtx_unlock(&Giant);
 438         }
 439         put_device(dev);
 440 }
 441
 442 static inline void
 443 device_del(struct device *dev)
 444 {
 445         device_t bsddev;
 446
 447         bsddev = dev->bsddev;
 448         dev->bsddev = NULL;
 449
 450         if (bsddev != NULL && dev->bsddev_attached_here) {
 451                 mtx_lock(&Giant);
 452                 device_delete_child(device_get_parent(bsddev), bsddev);
 453                 mtx_unlock(&Giant);
 454         }
 455 }
 456
 457 struct device *device_create(struct class *class, struct device *parent,
 458             dev_t devt, void *drvdata, const char *fmt, ...);
 459
 460 static inline void
 461 device_destroy(struct class *class, dev_t devt)
 462 {
 463         device_t bsddev;
 464         int unit;
 465
 466         unit = MINOR(devt);
 467         bsddev = devclass_get_device(class->bsdclass, unit);
 468         if (bsddev != NULL)
 469                 device_unregister(device_get_softc(bsddev));
 470 }
 471
 472 #define dev_pm_set_driver_flags(dev, flags) do { \
 473 } while (0)
 474
 475 static inline void
 476 linux_class_kfree(struct class *class)
 477 {
 478
 479         kfree(class);
 480 }
 481
 482 static inline struct class *
 483 class_create(struct module *owner, const char *name)
 484 {
 485         struct class *class;
 486         int error;
 487
 488         class = kzalloc(sizeof(*class), M_WAITOK);
 489         class->owner = owner;
 490         class->name = name;
 491         class->class_release = linux_class_kfree;
 492         error = class_register(class);
 493         if (error) {
 494                 kfree(class);
 495                 return (NULL);
 496         }
 497
 498         return (class);
 499 }
 500
 501 static inline void
 502 class_destroy(struct class *class)
 503 {
 504
 505         if (class == NULL)
 506                 return;
 507         class_unregister(class);
 508 }
 509
 510 static inline int
 511 device_create_file(struct device *dev, const struct device_attribute *attr)
 512 {
 513
 514         if (dev)
 515                 return sysfs_create_file(&dev->kobj, &attr->attr);
 516         return -EINVAL;
 517 }
 518
 519 static inline void
 520 device_remove_file(struct device *dev, const struct device_attribute *attr)
 521 {
 522
 523         if (dev)
 524                 sysfs_remove_file(&dev->kobj, &attr->attr);
 525 }
 526
 527 static inline int
 528 class_create_file(struct class *class, const struct class_attribute *attr)
 529 {
 530
 531         if (class)
 532                 return sysfs_create_file(&class->kobj, &attr->attr);
 533         return -EINVAL;
 534 }
 535
 536 static inline void
 537 class_remove_file(struct class *class, const struct class_attribute *attr)
 538 {
 539
 540         if (class)
 541                 sysfs_remove_file(&class->kobj, &attr->attr);
 542 }
 543
 544 static inline int
 545 dev_to_node(struct device *dev)
 546 {
 547         return -1;
 548 }
 549
 550 char *kvasprintf(gfp_t, const char *, va_list);
 551 char *kasprintf(gfp_t, const char *, ...);
 552
 553 #endif  /* _LINUX_DEVICE_H_ */