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