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 * Copyright (c) 2021-2022 The FreeBSD Foundation 8 * 9 * Portions of this software were developed by Björn Zeeb 10 * under sponsorship from the FreeBSD Foundation. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice unmodified, this list of conditions, and the following 17 * disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 #ifndef _LINUXKPI_LINUX_DEVICE_H_ 34 #define _LINUXKPI_LINUX_DEVICE_H_ 35 36 #include <linux/err.h> 37 #include <linux/types.h> 38 #include <linux/kobject.h> 39 #include <linux/sysfs.h> 40 #include <linux/list.h> 41 #include <linux/compiler.h> 42 #include <linux/module.h> 43 #include <linux/workqueue.h> 44 #include <linux/kdev_t.h> 45 #include <linux/backlight.h> 46 #include <linux/pm.h> 47 #include <linux/idr.h> 48 #include <linux/ratelimit.h> /* via linux/dev_printk.h */ 49 #include <linux/fwnode.h> 50 #include <asm/atomic.h> 51 52 #include <sys/bus.h> 53 #include <sys/backlight.h> 54 55 struct device; 56 57 struct class { 58 const char *name; 59 struct module *owner; 60 struct kobject kobj; 61 devclass_t bsdclass; 62 const struct dev_pm_ops *pm; 63 const struct attribute_group **dev_groups; 64 void (*class_release)(struct class *class); 65 void (*dev_release)(struct device *dev); 66 char * (*devnode)(struct device *dev, umode_t *mode); 67 }; 68 69 struct dev_pm_ops { 70 int (*prepare)(struct device *dev); 71 void (*complete)(struct device *dev); 72 int (*suspend)(struct device *dev); 73 int (*suspend_late)(struct device *dev); 74 int (*resume)(struct device *dev); 75 int (*resume_early)(struct device *dev); 76 int (*freeze)(struct device *dev); 77 int (*freeze_late)(struct device *dev); 78 int (*thaw)(struct device *dev); 79 int (*thaw_early)(struct device *dev); 80 int (*poweroff)(struct device *dev); 81 int (*poweroff_late)(struct device *dev); 82 int (*restore)(struct device *dev); 83 int (*restore_early)(struct device *dev); 84 int (*suspend_noirq)(struct device *dev); 85 int (*runtime_suspend)(struct device *dev); 86 int (*runtime_resume)(struct device *dev); 87 int (*runtime_idle)(struct device *dev); 88 }; 89 90 struct device_driver { 91 const char *name; 92 const struct dev_pm_ops *pm; 93 }; 94 95 struct device_type { 96 const char *name; 97 }; 98 99 struct device { 100 struct device *parent; 101 struct list_head irqents; 102 device_t bsddev; 103 /* 104 * The following flag is used to determine if the LinuxKPI is 105 * responsible for detaching the BSD device or not. If the 106 * LinuxKPI got the BSD device using devclass_get_device(), it 107 * must not try to detach or delete it, because it's already 108 * done somewhere else. 109 */ 110 bool bsddev_attached_here; 111 struct device_driver *driver; 112 struct device_type *type; 113 dev_t devt; 114 struct class *class; 115 void (*release)(struct device *dev); 116 struct kobject kobj; 117 void *dma_priv; 118 void *driver_data; 119 unsigned int irq; 120 #define LINUX_IRQ_INVALID 65535 121 unsigned int irq_start; 122 unsigned int irq_end; 123 const struct attribute_group **groups; 124 struct fwnode_handle *fwnode; 125 struct cdev *backlight_dev; 126 struct backlight_device *bd; 127 128 spinlock_t devres_lock; 129 struct list_head devres_head; 130 131 struct dev_pm_info power; 132 }; 133 134 extern struct device linux_root_device; 135 extern struct kobject linux_class_root; 136 extern const struct kobj_type linux_dev_ktype; 137 extern const struct kobj_type linux_class_ktype; 138 139 struct class_attribute { 140 struct attribute attr; 141 ssize_t (*show)(struct class *, struct class_attribute *, char *); 142 ssize_t (*store)(struct class *, struct class_attribute *, const char *, size_t); 143 const void *(*namespace)(struct class *, const struct class_attribute *); 144 }; 145 146 #define CLASS_ATTR(_name, _mode, _show, _store) \ 147 struct class_attribute class_attr_##_name = \ 148 { { #_name, NULL, _mode }, _show, _store } 149 150 struct device_attribute { 151 struct attribute attr; 152 ssize_t (*show)(struct device *, 153 struct device_attribute *, char *); 154 ssize_t (*store)(struct device *, 155 struct device_attribute *, const char *, 156 size_t); 157 }; 158 159 #define DEVICE_ATTR(_name, _mode, _show, _store) \ 160 struct device_attribute dev_attr_##_name = \ 161 __ATTR(_name, _mode, _show, _store) 162 #define DEVICE_ATTR_RO(_name) \ 163 struct device_attribute dev_attr_##_name = __ATTR_RO(_name) 164 #define DEVICE_ATTR_WO(_name) \ 165 struct device_attribute dev_attr_##_name = __ATTR_WO(_name) 166 #define DEVICE_ATTR_RW(_name) \ 167 struct device_attribute dev_attr_##_name = __ATTR_RW(_name) 168 169 /* Simple class attribute that is just a static string */ 170 struct class_attribute_string { 171 struct class_attribute attr; 172 char *str; 173 }; 174 175 static inline ssize_t 176 show_class_attr_string(struct class *class, 177 struct class_attribute *attr, char *buf) 178 { 179 struct class_attribute_string *cs; 180 cs = container_of(attr, struct class_attribute_string, attr); 181 return snprintf(buf, PAGE_SIZE, "%s\n", cs->str); 182 } 183 184 /* Currently read-only only */ 185 #define _CLASS_ATTR_STRING(_name, _mode, _str) \ 186 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } 187 #define CLASS_ATTR_STRING(_name, _mode, _str) \ 188 struct class_attribute_string class_attr_##_name = \ 189 _CLASS_ATTR_STRING(_name, _mode, _str) 190 191 #define dev_err(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 192 #define dev_crit(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 193 #define dev_warn(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 194 #define dev_info(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 195 #define dev_notice(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 196 #define dev_emerg(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 197 #define dev_dbg(dev, fmt, ...) do { } while (0) 198 #define dev_printk(lvl, dev, fmt, ...) \ 199 device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 200 201 #define dev_WARN(dev, fmt, ...) \ 202 device_printf((dev)->bsddev, "%s:%d: " fmt, __func__, __LINE__, ##__VA_ARGS__) 203 204 #define dev_WARN_ONCE(dev, condition, fmt, ...) do { \ 205 static bool __dev_WARN_ONCE; \ 206 bool __ret_warn_on = (condition); \ 207 if (unlikely(__ret_warn_on)) { \ 208 if (!__dev_WARN_ONCE) { \ 209 __dev_WARN_ONCE = true; \ 210 device_printf((dev)->bsddev, "%s:%d: " fmt, __func__, __LINE__, ##__VA_ARGS__); \ 211 } \ 212 } \ 213 } while (0) 214 215 #define dev_info_once(dev, ...) do { \ 216 static bool __dev_info_once; \ 217 if (!__dev_info_once) { \ 218 __dev_info_once = true; \ 219 dev_info(dev, __VA_ARGS__); \ 220 } \ 221 } while (0) 222 223 #define dev_warn_once(dev, ...) do { \ 224 static bool __dev_warn_once; \ 225 if (!__dev_warn_once) { \ 226 __dev_warn_once = 1; \ 227 dev_warn(dev, __VA_ARGS__); \ 228 } \ 229 } while (0) 230 231 #define dev_err_once(dev, ...) do { \ 232 static bool __dev_err_once; \ 233 if (!__dev_err_once) { \ 234 __dev_err_once = 1; \ 235 dev_err(dev, __VA_ARGS__); \ 236 } \ 237 } while (0) 238 239 #define dev_dbg_once(dev, ...) do { \ 240 static bool __dev_dbg_once; \ 241 if (!__dev_dbg_once) { \ 242 __dev_dbg_once = 1; \ 243 dev_dbg(dev, __VA_ARGS__); \ 244 } \ 245 } while (0) 246 247 #define dev_err_ratelimited(dev, ...) do { \ 248 static linux_ratelimit_t __ratelimited; \ 249 if (linux_ratelimited(&__ratelimited)) \ 250 dev_err(dev, __VA_ARGS__); \ 251 } while (0) 252 253 #define dev_warn_ratelimited(dev, ...) do { \ 254 static linux_ratelimit_t __ratelimited; \ 255 if (linux_ratelimited(&__ratelimited)) \ 256 dev_warn(dev, __VA_ARGS__); \ 257 } while (0) 258 259 #define dev_dbg_ratelimited(dev, ...) do { \ 260 static linux_ratelimit_t __ratelimited; \ 261 if (linux_ratelimited(&__ratelimited)) \ 262 dev_dbg(dev, __VA_ARGS__); \ 263 } while (0) 264 265 /* Public and LinuxKPI internal devres functions. */ 266 void *lkpi_devres_alloc(void(*release)(struct device *, void *), size_t, gfp_t); 267 void lkpi_devres_add(struct device *, void *); 268 void lkpi_devres_free(void *); 269 void *lkpi_devres_find(struct device *, void(*release)(struct device *, void *), 270 int (*match)(struct device *, void *, void *), void *); 271 int lkpi_devres_destroy(struct device *, void(*release)(struct device *, void *), 272 int (*match)(struct device *, void *, void *), void *); 273 #define devres_alloc(_r, _s, _g) lkpi_devres_alloc(_r, _s, _g) 274 #define devres_add(_d, _p) lkpi_devres_add(_d, _p) 275 #define devres_free(_p) lkpi_devres_free(_p) 276 #define devres_find(_d, _rfn, _mfn, _mp) \ 277 lkpi_devres_find(_d, _rfn, _mfn, _mp) 278 #define devres_destroy(_d, _rfn, _mfn, _mp) \ 279 lkpi_devres_destroy(_d, _rfn, _mfn, _mp) 280 void lkpi_devres_release_free_list(struct device *); 281 void lkpi_devres_unlink(struct device *, void *); 282 void lkpi_devm_kmalloc_release(struct device *, void *); 283 284 static inline const char * 285 dev_driver_string(const struct device *dev) 286 { 287 driver_t *drv; 288 const char *str = ""; 289 290 if (dev->bsddev != NULL) { 291 drv = device_get_driver(dev->bsddev); 292 if (drv != NULL) 293 str = drv->name; 294 } 295 296 return (str); 297 } 298 299 static inline void * 300 dev_get_drvdata(const struct device *dev) 301 { 302 303 return dev->driver_data; 304 } 305 306 static inline void 307 dev_set_drvdata(struct device *dev, void *data) 308 { 309 310 dev->driver_data = data; 311 } 312 313 static inline struct device * 314 get_device(struct device *dev) 315 { 316 317 if (dev) 318 kobject_get(&dev->kobj); 319 320 return (dev); 321 } 322 323 static inline char * 324 dev_name(const struct device *dev) 325 { 326 327 return kobject_name(&dev->kobj); 328 } 329 330 #define dev_set_name(_dev, _fmt, ...) \ 331 kobject_set_name(&(_dev)->kobj, (_fmt), ##__VA_ARGS__) 332 333 static inline void 334 put_device(struct device *dev) 335 { 336 337 if (dev) 338 kobject_put(&dev->kobj); 339 } 340 341 struct class *class_create(struct module *owner, const char *name); 342 343 static inline int 344 class_register(struct class *class) 345 { 346 347 class->bsdclass = devclass_create(class->name); 348 kobject_init(&class->kobj, &linux_class_ktype); 349 kobject_set_name(&class->kobj, class->name); 350 kobject_add(&class->kobj, &linux_class_root, class->name); 351 352 return (0); 353 } 354 355 static inline void 356 class_unregister(struct class *class) 357 { 358 359 kobject_put(&class->kobj); 360 } 361 362 static inline struct device *kobj_to_dev(struct kobject *kobj) 363 { 364 return container_of(kobj, struct device, kobj); 365 } 366 367 struct device *device_create(struct class *class, struct device *parent, 368 dev_t devt, void *drvdata, const char *fmt, ...); 369 struct device *device_create_groups_vargs(struct class *class, struct device *parent, 370 dev_t devt, void *drvdata, const struct attribute_group **groups, 371 const char *fmt, va_list args); 372 373 /* 374 * Devices are registered and created for exporting to sysfs. Create 375 * implies register and register assumes the device fields have been 376 * setup appropriately before being called. 377 */ 378 static inline void 379 device_initialize(struct device *dev) 380 { 381 device_t bsddev = NULL; 382 int unit = -1; 383 384 if (dev->devt) { 385 unit = MINOR(dev->devt); 386 bsddev = devclass_get_device(dev->class->bsdclass, unit); 387 dev->bsddev_attached_here = false; 388 } else if (dev->parent == NULL) { 389 bsddev = devclass_get_device(dev->class->bsdclass, 0); 390 dev->bsddev_attached_here = false; 391 } else { 392 dev->bsddev_attached_here = true; 393 } 394 395 if (bsddev == NULL && dev->parent != NULL) { 396 bsddev = device_add_child(dev->parent->bsddev, 397 dev->class->kobj.name, unit); 398 } 399 400 if (bsddev != NULL) 401 device_set_softc(bsddev, dev); 402 403 dev->bsddev = bsddev; 404 MPASS(dev->bsddev != NULL); 405 kobject_init(&dev->kobj, &linux_dev_ktype); 406 407 spin_lock_init(&dev->devres_lock); 408 INIT_LIST_HEAD(&dev->devres_head); 409 } 410 411 static inline int 412 device_add(struct device *dev) 413 { 414 if (dev->bsddev != NULL) { 415 if (dev->devt == 0) 416 dev->devt = makedev(0, device_get_unit(dev->bsddev)); 417 } 418 kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev)); 419 420 if (dev->groups) 421 return (sysfs_create_groups(&dev->kobj, dev->groups)); 422 423 return (0); 424 } 425 426 static inline void 427 device_create_release(struct device *dev) 428 { 429 kfree(dev); 430 } 431 432 static inline struct device * 433 device_create_with_groups(struct class *class, 434 struct device *parent, dev_t devt, void *drvdata, 435 const struct attribute_group **groups, const char *fmt, ...) 436 { 437 va_list vargs; 438 struct device *dev; 439 440 va_start(vargs, fmt); 441 dev = device_create_groups_vargs(class, parent, devt, drvdata, 442 groups, fmt, vargs); 443 va_end(vargs); 444 return dev; 445 } 446 447 static inline bool 448 device_is_registered(struct device *dev) 449 { 450 451 return (dev->bsddev != NULL); 452 } 453 454 static inline int 455 device_register(struct device *dev) 456 { 457 device_t bsddev = NULL; 458 int unit = -1; 459 460 if (device_is_registered(dev)) 461 goto done; 462 463 if (dev->devt) { 464 unit = MINOR(dev->devt); 465 bsddev = devclass_get_device(dev->class->bsdclass, unit); 466 dev->bsddev_attached_here = false; 467 } else if (dev->parent == NULL) { 468 bsddev = devclass_get_device(dev->class->bsdclass, 0); 469 dev->bsddev_attached_here = false; 470 } else { 471 dev->bsddev_attached_here = true; 472 } 473 if (bsddev == NULL && dev->parent != NULL) { 474 bsddev = device_add_child(dev->parent->bsddev, 475 dev->class->kobj.name, unit); 476 } 477 if (bsddev != NULL) { 478 if (dev->devt == 0) 479 dev->devt = makedev(0, device_get_unit(bsddev)); 480 device_set_softc(bsddev, dev); 481 } 482 dev->bsddev = bsddev; 483 done: 484 kobject_init(&dev->kobj, &linux_dev_ktype); 485 kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev)); 486 487 sysfs_create_groups(&dev->kobj, dev->class->dev_groups); 488 489 return (0); 490 } 491 492 static inline void 493 device_unregister(struct device *dev) 494 { 495 device_t bsddev; 496 497 sysfs_remove_groups(&dev->kobj, dev->class->dev_groups); 498 499 bsddev = dev->bsddev; 500 dev->bsddev = NULL; 501 502 if (bsddev != NULL && dev->bsddev_attached_here) { 503 bus_topo_lock(); 504 device_delete_child(device_get_parent(bsddev), bsddev); 505 bus_topo_unlock(); 506 } 507 put_device(dev); 508 } 509 510 static inline void 511 device_del(struct device *dev) 512 { 513 device_t bsddev; 514 515 bsddev = dev->bsddev; 516 dev->bsddev = NULL; 517 518 if (bsddev != NULL && dev->bsddev_attached_here) { 519 bus_topo_lock(); 520 device_delete_child(device_get_parent(bsddev), bsddev); 521 bus_topo_unlock(); 522 } 523 } 524 525 static inline void 526 device_destroy(struct class *class, dev_t devt) 527 { 528 device_t bsddev; 529 int unit; 530 531 unit = MINOR(devt); 532 bsddev = devclass_get_device(class->bsdclass, unit); 533 if (bsddev != NULL) 534 device_unregister(device_get_softc(bsddev)); 535 } 536 537 static inline void 538 device_release_driver(struct device *dev) 539 { 540 541 #if 0 542 /* This leads to panics. Disable temporarily. Keep to rework. */ 543 544 /* We also need to cleanup LinuxKPI bits. What else? */ 545 lkpi_devres_release_free_list(dev); 546 dev_set_drvdata(dev, NULL); 547 /* Do not call dev->release! */ 548 549 bus_topo_lock(); 550 if (device_is_attached(dev->bsddev)) 551 device_detach(dev->bsddev); 552 bus_topo_unlock(); 553 #endif 554 } 555 556 static inline int 557 device_reprobe(struct device *dev) 558 { 559 int error; 560 561 device_release_driver(dev); 562 bus_topo_lock(); 563 error = device_probe_and_attach(dev->bsddev); 564 bus_topo_unlock(); 565 566 return (-error); 567 } 568 569 static inline void 570 device_set_wakeup_enable(struct device *dev __unused, bool enable __unused) 571 { 572 573 /* 574 * XXX-BZ TODO This is used by wireless drivers supporting WoWLAN which 575 * we currently do not support. 576 */ 577 } 578 579 static inline int 580 device_wakeup_enable(struct device *dev) 581 { 582 583 device_set_wakeup_enable(dev, true); 584 return (0); 585 } 586 587 static inline bool 588 device_iommu_mapped(struct device *dev __unused) 589 { 590 return (false); 591 } 592 593 #define dev_pm_set_driver_flags(dev, flags) do { \ 594 } while (0) 595 596 static inline void 597 linux_class_kfree(struct class *class) 598 { 599 600 kfree(class); 601 } 602 603 static inline void 604 class_destroy(struct class *class) 605 { 606 607 if (class == NULL) 608 return; 609 class_unregister(class); 610 } 611 612 static inline int 613 device_create_file(struct device *dev, const struct device_attribute *attr) 614 { 615 616 if (dev) 617 return sysfs_create_file(&dev->kobj, &attr->attr); 618 return -EINVAL; 619 } 620 621 static inline void 622 device_remove_file(struct device *dev, const struct device_attribute *attr) 623 { 624 625 if (dev) 626 sysfs_remove_file(&dev->kobj, &attr->attr); 627 } 628 629 static inline int 630 class_create_file(struct class *class, const struct class_attribute *attr) 631 { 632 633 if (class) 634 return sysfs_create_file(&class->kobj, &attr->attr); 635 return -EINVAL; 636 } 637 638 static inline void 639 class_remove_file(struct class *class, const struct class_attribute *attr) 640 { 641 642 if (class) 643 sysfs_remove_file(&class->kobj, &attr->attr); 644 } 645 646 #define dev_to_node(dev) linux_dev_to_node(dev) 647 #define of_node_to_nid(node) -1 648 int linux_dev_to_node(struct device *); 649 650 char *kvasprintf(gfp_t, const char *, va_list); 651 char *kasprintf(gfp_t, const char *, ...); 652 char *lkpi_devm_kasprintf(struct device *, gfp_t, const char *, ...); 653 654 #define devm_kasprintf(_dev, _gfp, _fmt, ...) \ 655 lkpi_devm_kasprintf(_dev, _gfp, _fmt, ##__VA_ARGS__) 656 657 static __inline void * 658 devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) 659 { 660 void *p; 661 662 p = lkpi_devres_alloc(lkpi_devm_kmalloc_release, size, gfp); 663 if (p != NULL) 664 lkpi_devres_add(dev, p); 665 666 return (p); 667 } 668 669 static inline void * 670 devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp) 671 { 672 void *dst; 673 674 if (len == 0) 675 return (NULL); 676 677 dst = devm_kmalloc(dev, len, gfp); 678 if (dst != NULL) 679 memcpy(dst, src, len); 680 681 return (dst); 682 } 683 684 #define devm_kzalloc(_dev, _size, _gfp) \ 685 devm_kmalloc((_dev), (_size), (_gfp) | __GFP_ZERO) 686 687 #define devm_kcalloc(_dev, _sizen, _size, _gfp) \ 688 devm_kmalloc((_dev), ((_sizen) * (_size)), (_gfp) | __GFP_ZERO) 689 690 int lkpi_devm_add_action(struct device *dev, void (*action)(void *), void *data); 691 #define devm_add_action(dev, action, data) \ 692 lkpi_devm_add_action(dev, action, data); 693 int lkpi_devm_add_action_or_reset(struct device *dev, void (*action)(void *), void *data); 694 #define devm_add_action_or_reset(dev, action, data) \ 695 lkpi_devm_add_action_or_reset(dev, action, data) 696 697 #endif /* _LINUXKPI_LINUX_DEVICE_H_ */ 698