drivers/base/swnode.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Software nodes for the firmware node framework.
   4  *
   5  * Copyright (C) 2018, Intel Corporation
   6  * Author: Heikki Krogerus <heikki.krogerus@linux.intel.com>
   7  */
   8
   9 #include <linux/device.h>
  10 #include <linux/kernel.h>
  11 #include <linux/property.h>
  12 #include <linux/slab.h>
  13
  14 struct swnode {
  15         int id;
  16         struct kobject kobj;
  17         struct fwnode_handle fwnode;
  18         const struct software_node *node;
  19
  20         /* hierarchy */
  21         struct ida child_ids;
  22         struct list_head entry;
  23         struct list_head children;
  24         struct swnode *parent;
  25
  26         unsigned int allocated:1;
  27 };
  28
  29 static DEFINE_IDA(swnode_root_ids);
  30 static struct kset *swnode_kset;
  31
  32 #define kobj_to_swnode(_kobj_) container_of(_kobj_, struct swnode, kobj)
  33
  34 static const struct fwnode_operations software_node_ops;
  35
  36 bool is_software_node(const struct fwnode_handle *fwnode)
  37 {
  38         return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &software_node_ops;
  39 }
  40 EXPORT_SYMBOL_GPL(is_software_node);
  41
  42 #define to_swnode(__fwnode)                                             \
  43         ({                                                              \
  44                 typeof(__fwnode) __to_swnode_fwnode = __fwnode;         \
  45                                                                         \
  46                 is_software_node(__to_swnode_fwnode) ?                  \
  47                         container_of(__to_swnode_fwnode,                \
  48                                      struct swnode, fwnode) : NULL;     \
  49         })
  50
  51 static struct swnode *
  52 software_node_to_swnode(const struct software_node *node)
  53 {
  54         struct swnode *swnode = NULL;
  55         struct kobject *k;
  56
  57         if (!node)
  58                 return NULL;
  59
  60         spin_lock(&swnode_kset->list_lock);
  61
  62         list_for_each_entry(k, &swnode_kset->list, entry) {
  63                 swnode = kobj_to_swnode(k);
  64                 if (swnode->node == node)
  65                         break;
  66                 swnode = NULL;
  67         }
  68
  69         spin_unlock(&swnode_kset->list_lock);
  70
  71         return swnode;
  72 }
  73
  74 const struct software_node *to_software_node(const struct fwnode_handle *fwnode)
  75 {
  76         const struct swnode *swnode = to_swnode(fwnode);
  77
  78         return swnode ? swnode->node : NULL;
  79 }
  80 EXPORT_SYMBOL_GPL(to_software_node);
  81
  82 struct fwnode_handle *software_node_fwnode(const struct software_node *node)
  83 {
  84         struct swnode *swnode = software_node_to_swnode(node);
  85
  86         return swnode ? &swnode->fwnode : NULL;
  87 }
  88 EXPORT_SYMBOL_GPL(software_node_fwnode);
  89
  90 /* -------------------------------------------------------------------------- */
  91 /* property_entry processing */
  92
  93 static const struct property_entry *
  94 property_entry_get(const struct property_entry *prop, const char *name)
  95 {
  96         if (!prop)
  97                 return NULL;
  98
  99         for (; prop->name; prop++)
 100                 if (!strcmp(name, prop->name))
 101                         return prop;
 102
 103         return NULL;
 104 }
 105
 106 static const void *property_get_pointer(const struct property_entry *prop)
 107 {
 108         if (!prop->length)
 109                 return NULL;
 110
 111         return prop->is_inline ? &prop->value : prop->pointer;
 112 }
 113
 114 static const void *property_entry_find(const struct property_entry *props,
 115                                        const char *propname, size_t length)
 116 {
 117         const struct property_entry *prop;
 118         const void *pointer;
 119
 120         prop = property_entry_get(props, propname);
 121         if (!prop)
 122                 return ERR_PTR(-EINVAL);
 123         pointer = property_get_pointer(prop);
 124         if (!pointer)
 125                 return ERR_PTR(-ENODATA);
 126         if (length > prop->length)
 127                 return ERR_PTR(-EOVERFLOW);
 128         return pointer;
 129 }
 130
 131 static int
 132 property_entry_count_elems_of_size(const struct property_entry *props,
 133                                    const char *propname, size_t length)
 134 {
 135         const struct property_entry *prop;
 136
 137         prop = property_entry_get(props, propname);
 138         if (!prop)
 139                 return -EINVAL;
 140
 141         return prop->length / length;
 142 }
 143
 144 static int property_entry_read_int_array(const struct property_entry *props,
 145                                          const char *name,
 146                                          unsigned int elem_size, void *val,
 147                                          size_t nval)
 148 {
 149         const void *pointer;
 150         size_t length;
 151
 152         if (!val)
 153                 return property_entry_count_elems_of_size(props, name,
 154                                                           elem_size);
 155
 156         if (!is_power_of_2(elem_size) || elem_size > sizeof(u64))
 157                 return -ENXIO;
 158
 159         length = nval * elem_size;
 160
 161         pointer = property_entry_find(props, name, length);
 162         if (IS_ERR(pointer))
 163                 return PTR_ERR(pointer);
 164
 165         memcpy(val, pointer, length);
 166         return 0;
 167 }
 168
 169 static int property_entry_read_string_array(const struct property_entry *props,
 170                                             const char *propname,
 171                                             const char **strings, size_t nval)
 172 {
 173         const void *pointer;
 174         size_t length;
 175         int array_len;
 176
 177         /* Find out the array length. */
 178         array_len = property_entry_count_elems_of_size(props, propname,
 179                                                        sizeof(const char *));
 180         if (array_len < 0)
 181                 return array_len;
 182
 183         /* Return how many there are if strings is NULL. */
 184         if (!strings)
 185                 return array_len;
 186
 187         array_len = min_t(size_t, nval, array_len);
 188         length = array_len * sizeof(*strings);
 189
 190         pointer = property_entry_find(props, propname, length);
 191         if (IS_ERR(pointer))
 192                 return PTR_ERR(pointer);
 193
 194         memcpy(strings, pointer, length);
 195
 196         return array_len;
 197 }
 198
 199 static void property_entry_free_data(const struct property_entry *p)
 200 {
 201         const char * const *src_str;
 202         size_t i, nval;
 203
 204         if (p->type == DEV_PROP_STRING) {
 205                 src_str = property_get_pointer(p);
 206                 nval = p->length / sizeof(*src_str);
 207                 for (i = 0; i < nval; i++)
 208                         kfree(src_str[i]);
 209         }
 210
 211         if (!p->is_inline)
 212                 kfree(p->pointer);
 213
 214         kfree(p->name);
 215 }
 216
 217 static bool property_copy_string_array(const char **dst_ptr,
 218                                        const char * const *src_ptr,
 219                                        size_t nval)
 220 {
 221         int i;
 222
 223         for (i = 0; i < nval; i++) {
 224                 dst_ptr[i] = kstrdup(src_ptr[i], GFP_KERNEL);
 225                 if (!dst_ptr[i] && src_ptr[i]) {
 226                         while (--i >= 0)
 227                                 kfree(dst_ptr[i]);
 228                         return false;
 229                 }
 230         }
 231
 232         return true;
 233 }
 234
 235 static int property_entry_copy_data(struct property_entry *dst,
 236                                     const struct property_entry *src)
 237 {
 238         const void *pointer = property_get_pointer(src);
 239         void *dst_ptr;
 240         size_t nval;
 241
 242         /*
 243          * Properties with no data should not be marked as stored
 244          * out of line.
 245          */
 246         if (!src->is_inline && !src->length)
 247                 return -ENODATA;
 248
 249         /*
 250          * Reference properties are never stored inline as
 251          * they are too big.
 252          */
 253         if (src->type == DEV_PROP_REF && src->is_inline)
 254                 return -EINVAL;
 255
 256         if (src->length <= sizeof(dst->value)) {
 257                 dst_ptr = &dst->value;
 258                 dst->is_inline = true;
 259         } else {
 260                 dst_ptr = kmalloc(src->length, GFP_KERNEL);
 261                 if (!dst_ptr)
 262                         return -ENOMEM;
 263                 dst->pointer = dst_ptr;
 264         }
 265
 266         if (src->type == DEV_PROP_STRING) {
 267                 nval = src->length / sizeof(const char *);
 268                 if (!property_copy_string_array(dst_ptr, pointer, nval)) {
 269                         if (!dst->is_inline)
 270                                 kfree(dst->pointer);
 271                         return -ENOMEM;
 272                 }
 273         } else {
 274                 memcpy(dst_ptr, pointer, src->length);
 275         }
 276
 277         dst->length = src->length;
 278         dst->type = src->type;
 279         dst->name = kstrdup(src->name, GFP_KERNEL);
 280         if (!dst->name) {
 281                 property_entry_free_data(dst);
 282                 return -ENOMEM;
 283         }
 284
 285         return 0;
 286 }
 287
 288 /**
 289  * property_entries_dup - duplicate array of properties
 290  * @properties: array of properties to copy
 291  *
 292  * This function creates a deep copy of the given NULL-terminated array
 293  * of property entries.
 294  */
 295 struct property_entry *
 296 property_entries_dup(const struct property_entry *properties)
 297 {
 298         struct property_entry *p;
 299         int i, n = 0;
 300         int ret;
 301
 302         if (!properties)
 303                 return NULL;
 304
 305         while (properties[n].name)
 306                 n++;
 307
 308         p = kcalloc(n + 1, sizeof(*p), GFP_KERNEL);
 309         if (!p)
 310                 return ERR_PTR(-ENOMEM);
 311
 312         for (i = 0; i < n; i++) {
 313                 ret = property_entry_copy_data(&p[i], &properties[i]);
 314                 if (ret) {
 315                         while (--i >= 0)
 316                                 property_entry_free_data(&p[i]);
 317                         kfree(p);
 318                         return ERR_PTR(ret);
 319                 }
 320         }
 321
 322         return p;
 323 }
 324 EXPORT_SYMBOL_GPL(property_entries_dup);
 325
 326 /**
 327  * property_entries_free - free previously allocated array of properties
 328  * @properties: array of properties to destroy
 329  *
 330  * This function frees given NULL-terminated array of property entries,
 331  * along with their data.
 332  */
 333 void property_entries_free(const struct property_entry *properties)
 334 {
 335         const struct property_entry *p;
 336
 337         if (!properties)
 338                 return;
 339
 340         for (p = properties; p->name; p++)
 341                 property_entry_free_data(p);
 342
 343         kfree(properties);
 344 }
 345 EXPORT_SYMBOL_GPL(property_entries_free);
 346
 347 /* -------------------------------------------------------------------------- */
 348 /* fwnode operations */
 349
 350 static struct fwnode_handle *software_node_get(struct fwnode_handle *fwnode)
 351 {
 352         struct swnode *swnode = to_swnode(fwnode);
 353
 354         kobject_get(&swnode->kobj);
 355
 356         return &swnode->fwnode;
 357 }
 358
 359 static void software_node_put(struct fwnode_handle *fwnode)
 360 {
 361         struct swnode *swnode = to_swnode(fwnode);
 362
 363         kobject_put(&swnode->kobj);
 364 }
 365
 366 static bool software_node_property_present(const struct fwnode_handle *fwnode,
 367                                            const char *propname)
 368 {
 369         struct swnode *swnode = to_swnode(fwnode);
 370
 371         return !!property_entry_get(swnode->node->properties, propname);
 372 }
 373
 374 static int software_node_read_int_array(const struct fwnode_handle *fwnode,
 375                                         const char *propname,
 376                                         unsigned int elem_size, void *val,
 377                                         size_t nval)
 378 {
 379         struct swnode *swnode = to_swnode(fwnode);
 380
 381         return property_entry_read_int_array(swnode->node->properties, propname,
 382                                              elem_size, val, nval);
 383 }
 384
 385 static int software_node_read_string_array(const struct fwnode_handle *fwnode,
 386                                            const char *propname,
 387                                            const char **val, size_t nval)
 388 {
 389         struct swnode *swnode = to_swnode(fwnode);
 390
 391         return property_entry_read_string_array(swnode->node->properties,
 392                                                 propname, val, nval);
 393 }
 394
 395 static const char *
 396 software_node_get_name(const struct fwnode_handle *fwnode)
 397 {
 398         const struct swnode *swnode = to_swnode(fwnode);
 399
 400         if (!swnode)
 401                 return "(null)";
 402
 403         return kobject_name(&swnode->kobj);
 404 }
 405
 406 static const char *
 407 software_node_get_name_prefix(const struct fwnode_handle *fwnode)
 408 {
 409         struct fwnode_handle *parent;
 410         const char *prefix;
 411
 412         parent = fwnode_get_parent(fwnode);
 413         if (!parent)
 414                 return "";
 415
 416         /* Figure out the prefix from the parents. */
 417         while (is_software_node(parent))
 418                 parent = fwnode_get_next_parent(parent);
 419
 420         prefix = fwnode_get_name_prefix(parent);
 421         fwnode_handle_put(parent);
 422
 423         /* Guess something if prefix was NULL. */
 424         return prefix ?: "/";
 425 }
 426
 427 static struct fwnode_handle *
 428 software_node_get_parent(const struct fwnode_handle *fwnode)
 429 {
 430         struct swnode *swnode = to_swnode(fwnode);
 431
 432         if (!swnode || !swnode->parent)
 433                 return NULL;
 434
 435         return fwnode_handle_get(&swnode->parent->fwnode);
 436 }
 437
 438 static struct fwnode_handle *
 439 software_node_get_next_child(const struct fwnode_handle *fwnode,
 440                              struct fwnode_handle *child)
 441 {
 442         struct swnode *p = to_swnode(fwnode);
 443         struct swnode *c = to_swnode(child);
 444
 445         if (!p || list_empty(&p->children) ||
 446             (c && list_is_last(&c->entry, &p->children))) {
 447                 fwnode_handle_put(child);
 448                 return NULL;
 449         }
 450
 451         if (c)
 452                 c = list_next_entry(c, entry);
 453         else
 454                 c = list_first_entry(&p->children, struct swnode, entry);
 455
 456         fwnode_handle_put(child);
 457         return fwnode_handle_get(&c->fwnode);
 458 }
 459
 460 static struct fwnode_handle *
 461 software_node_get_named_child_node(const struct fwnode_handle *fwnode,
 462                                    const char *childname)
 463 {
 464         struct swnode *swnode = to_swnode(fwnode);
 465         struct swnode *child;
 466
 467         if (!swnode || list_empty(&swnode->children))
 468                 return NULL;
 469
 470         list_for_each_entry(child, &swnode->children, entry) {
 471                 if (!strcmp(childname, kobject_name(&child->kobj))) {
 472                         kobject_get(&child->kobj);
 473                         return &child->fwnode;
 474                 }
 475         }
 476         return NULL;
 477 }
 478
 479 static int
 480 software_node_get_reference_args(const struct fwnode_handle *fwnode,
 481                                  const char *propname, const char *nargs_prop,
 482                                  unsigned int nargs, unsigned int index,
 483                                  struct fwnode_reference_args *args)
 484 {
 485         struct swnode *swnode = to_swnode(fwnode);
 486         const struct software_node_ref_args *ref_array;
 487         const struct software_node_ref_args *ref;
 488         const struct property_entry *prop;
 489         struct fwnode_handle *refnode;
 490         u32 nargs_prop_val;
 491         int error;
 492         int i;
 493
 494         if (!swnode)
 495                 return -ENOENT;
 496
 497         prop = property_entry_get(swnode->node->properties, propname);
 498         if (!prop)
 499                 return -ENOENT;
 500
 501         if (prop->type != DEV_PROP_REF)
 502                 return -EINVAL;
 503
 504         /*
 505          * We expect that references are never stored inline, even
 506          * single ones, as they are too big.
 507          */
 508         if (prop->is_inline)
 509                 return -EINVAL;
 510
 511         if (index * sizeof(*ref) >= prop->length)
 512                 return -ENOENT;
 513
 514         ref_array = prop->pointer;
 515         ref = &ref_array[index];
 516
 517         refnode = software_node_fwnode(ref->node);
 518         if (!refnode)
 519                 return -ENOENT;
 520
 521         if (nargs_prop) {
 522                 error = property_entry_read_int_array(ref->node->properties,
 523                                                       nargs_prop, sizeof(u32),
 524                                                       &nargs_prop_val, 1);
 525                 if (error)
 526                         return error;
 527
 528                 nargs = nargs_prop_val;
 529         }
 530
 531         if (nargs > NR_FWNODE_REFERENCE_ARGS)
 532                 return -EINVAL;
 533
 534         if (!args)
 535                 return 0;
 536
 537         args->fwnode = software_node_get(refnode);
 538         args->nargs = nargs;
 539
 540         for (i = 0; i < nargs; i++)
 541                 args->args[i] = ref->args[i];
 542
 543         return 0;
 544 }
 545
 546 static const struct fwnode_operations software_node_ops = {
 547         .get = software_node_get,
 548         .put = software_node_put,
 549         .property_present = software_node_property_present,
 550         .property_read_int_array = software_node_read_int_array,
 551         .property_read_string_array = software_node_read_string_array,
 552         .get_name = software_node_get_name,
 553         .get_name_prefix = software_node_get_name_prefix,
 554         .get_parent = software_node_get_parent,
 555         .get_next_child_node = software_node_get_next_child,
 556         .get_named_child_node = software_node_get_named_child_node,
 557         .get_reference_args = software_node_get_reference_args
 558 };
 559
 560 /* -------------------------------------------------------------------------- */
 561
 562 /**
 563  * software_node_find_by_name - Find software node by name
 564  * @parent: Parent of the software node
 565  * @name: Name of the software node
 566  *
 567  * The function will find a node that is child of @parent and that is named
 568  * @name. If no node is found, the function returns NULL.
 569  *
 570  * NOTE: you will need to drop the reference with fwnode_handle_put() after use.
 571  */
 572 const struct software_node *
 573 software_node_find_by_name(const struct software_node *parent, const char *name)
 574 {
 575         struct swnode *swnode = NULL;
 576         struct kobject *k;
 577
 578         if (!name)
 579                 return NULL;
 580
 581         spin_lock(&swnode_kset->list_lock);
 582
 583         list_for_each_entry(k, &swnode_kset->list, entry) {
 584                 swnode = kobj_to_swnode(k);
 585                 if (parent == swnode->node->parent && swnode->node->name &&
 586                     !strcmp(name, swnode->node->name)) {
 587                         kobject_get(&swnode->kobj);
 588                         break;
 589                 }
 590                 swnode = NULL;
 591         }
 592
 593         spin_unlock(&swnode_kset->list_lock);
 594
 595         return swnode ? swnode->node : NULL;
 596 }
 597 EXPORT_SYMBOL_GPL(software_node_find_by_name);
 598
 599 static int
 600 software_node_register_properties(struct software_node *node,
 601                                   const struct property_entry *properties)
 602 {
 603         struct property_entry *props;
 604
 605         props = property_entries_dup(properties);
 606         if (IS_ERR(props))
 607                 return PTR_ERR(props);
 608
 609         node->properties = props;
 610
 611         return 0;
 612 }
 613
 614 static void software_node_release(struct kobject *kobj)
 615 {
 616         struct swnode *swnode = kobj_to_swnode(kobj);
 617
 618         if (swnode->parent) {
 619                 ida_simple_remove(&swnode->parent->child_ids, swnode->id);
 620                 list_del(&swnode->entry);
 621         } else {
 622                 ida_simple_remove(&swnode_root_ids, swnode->id);
 623         }
 624
 625         if (swnode->allocated) {
 626                 property_entries_free(swnode->node->properties);
 627                 kfree(swnode->node);
 628         }
 629         ida_destroy(&swnode->child_ids);
 630         kfree(swnode);
 631 }
 632
 633 static struct kobj_type software_node_type = {
 634         .release = software_node_release,
 635         .sysfs_ops = &kobj_sysfs_ops,
 636 };
 637
 638 static struct fwnode_handle *
 639 swnode_register(const struct software_node *node, struct swnode *parent,
 640                 unsigned int allocated)
 641 {
 642         struct swnode *swnode;
 643         int ret;
 644
 645         swnode = kzalloc(sizeof(*swnode), GFP_KERNEL);
 646         if (!swnode) {
 647                 ret = -ENOMEM;
 648                 goto out_err;
 649         }
 650
 651         ret = ida_simple_get(parent ? &parent->child_ids : &swnode_root_ids,
 652                              0, 0, GFP_KERNEL);
 653         if (ret < 0) {
 654                 kfree(swnode);
 655                 goto out_err;
 656         }
 657
 658         swnode->id = ret;
 659         swnode->node = node;
 660         swnode->parent = parent;
 661         swnode->allocated = allocated;
 662         swnode->kobj.kset = swnode_kset;
 663         swnode->fwnode.ops = &software_node_ops;
 664
 665         ida_init(&swnode->child_ids);
 666         INIT_LIST_HEAD(&swnode->entry);
 667         INIT_LIST_HEAD(&swnode->children);
 668
 669         if (node->name)
 670                 ret = kobject_init_and_add(&swnode->kobj, &software_node_type,
 671                                            parent ? &parent->kobj : NULL,
 672                                            "%s", node->name);
 673         else
 674                 ret = kobject_init_and_add(&swnode->kobj, &software_node_type,
 675                                            parent ? &parent->kobj : NULL,
 676                                            "node%d", swnode->id);
 677         if (ret) {
 678                 kobject_put(&swnode->kobj);
 679                 return ERR_PTR(ret);
 680         }
 681
 682         if (parent)
 683                 list_add_tail(&swnode->entry, &parent->children);
 684
 685         kobject_uevent(&swnode->kobj, KOBJ_ADD);
 686         return &swnode->fwnode;
 687
 688 out_err:
 689         if (allocated)
 690                 property_entries_free(node->properties);
 691         return ERR_PTR(ret);
 692 }
 693
 694 /**
 695  * software_node_register_nodes - Register an array of software nodes
 696  * @nodes: Zero terminated array of software nodes to be registered
 697  *
 698  * Register multiple software nodes at once.
 699  */
 700 int software_node_register_nodes(const struct software_node *nodes)
 701 {
 702         int ret;
 703         int i;
 704
 705         for (i = 0; nodes[i].name; i++) {
 706                 ret = software_node_register(&nodes[i]);
 707                 if (ret) {
 708                         software_node_unregister_nodes(nodes);
 709                         return ret;
 710                 }
 711         }
 712
 713         return 0;
 714 }
 715 EXPORT_SYMBOL_GPL(software_node_register_nodes);
 716
 717 /**
 718  * software_node_unregister_nodes - Unregister an array of software nodes
 719  * @nodes: Zero terminated array of software nodes to be unregistered
 720  *
 721  * Unregister multiple software nodes at once.
 722  *
 723  * NOTE: Be careful using this call if the nodes had parent pointers set up in
 724  * them before registering.  If so, it is wiser to remove the nodes
 725  * individually, in the correct order (child before parent) instead of relying
 726  * on the sequential order of the list of nodes in the array.
 727  */
 728 void software_node_unregister_nodes(const struct software_node *nodes)
 729 {
 730         int i;
 731
 732         for (i = 0; nodes[i].name; i++)
 733                 software_node_unregister(&nodes[i]);
 734 }
 735 EXPORT_SYMBOL_GPL(software_node_unregister_nodes);
 736
 737 /**
 738  * software_node_register_node_group - Register a group of software nodes
 739  * @node_group: NULL terminated array of software node pointers to be registered
 740  *
 741  * Register multiple software nodes at once.
 742  */
 743 int software_node_register_node_group(const struct software_node **node_group)
 744 {
 745         unsigned int i;
 746         int ret;
 747
 748         if (!node_group)
 749                 return 0;
 750
 751         for (i = 0; node_group[i]; i++) {
 752                 ret = software_node_register(node_group[i]);
 753                 if (ret) {
 754                         software_node_unregister_node_group(node_group);
 755                         return ret;
 756                 }
 757         }
 758
 759         return 0;
 760 }
 761 EXPORT_SYMBOL_GPL(software_node_register_node_group);
 762
 763 /**
 764  * software_node_unregister_node_group - Unregister a group of software nodes
 765  * @node_group: NULL terminated array of software node pointers to be unregistered
 766  *
 767  * Unregister multiple software nodes at once.
 768  */
 769 void software_node_unregister_node_group(const struct software_node **node_group)
 770 {
 771         unsigned int i;
 772
 773         if (!node_group)
 774                 return;
 775
 776         for (i = 0; node_group[i]; i++)
 777                 software_node_unregister(node_group[i]);
 778 }
 779 EXPORT_SYMBOL_GPL(software_node_unregister_node_group);
 780
 781 /**
 782  * software_node_register - Register static software node
 783  * @node: The software node to be registered
 784  */
 785 int software_node_register(const struct software_node *node)
 786 {
 787         struct swnode *parent = software_node_to_swnode(node->parent);
 788
 789         if (software_node_to_swnode(node))
 790                 return -EEXIST;
 791
 792         if (node->parent && !parent)
 793                 return -EINVAL;
 794
 795         return PTR_ERR_OR_ZERO(swnode_register(node, parent, 0));
 796 }
 797 EXPORT_SYMBOL_GPL(software_node_register);
 798
 799 /**
 800  * software_node_unregister - Unregister static software node
 801  * @node: The software node to be unregistered
 802  */
 803 void software_node_unregister(const struct software_node *node)
 804 {
 805         struct swnode *swnode;
 806
 807         swnode = software_node_to_swnode(node);
 808         if (swnode)
 809                 fwnode_remove_software_node(&swnode->fwnode);
 810 }
 811 EXPORT_SYMBOL_GPL(software_node_unregister);
 812
 813 struct fwnode_handle *
 814 fwnode_create_software_node(const struct property_entry *properties,
 815                             const struct fwnode_handle *parent)
 816 {
 817         struct software_node *node;
 818         struct swnode *p = NULL;
 819         int ret;
 820
 821         if (parent) {
 822                 if (IS_ERR(parent))
 823                         return ERR_CAST(parent);
 824                 if (!is_software_node(parent))
 825                         return ERR_PTR(-EINVAL);
 826                 p = to_swnode(parent);
 827         }
 828
 829         node = kzalloc(sizeof(*node), GFP_KERNEL);
 830         if (!node)
 831                 return ERR_PTR(-ENOMEM);
 832
 833         ret = software_node_register_properties(node, properties);
 834         if (ret) {
 835                 kfree(node);
 836                 return ERR_PTR(ret);
 837         }
 838
 839         node->parent = p ? p->node : NULL;
 840
 841         return swnode_register(node, p, 1);
 842 }
 843 EXPORT_SYMBOL_GPL(fwnode_create_software_node);
 844
 845 void fwnode_remove_software_node(struct fwnode_handle *fwnode)
 846 {
 847         struct swnode *swnode = to_swnode(fwnode);
 848
 849         if (!swnode)
 850                 return;
 851
 852         kobject_put(&swnode->kobj);
 853 }
 854 EXPORT_SYMBOL_GPL(fwnode_remove_software_node);
 855
 856 int software_node_notify(struct device *dev, unsigned long action)
 857 {
 858         struct fwnode_handle *fwnode = dev_fwnode(dev);
 859         struct swnode *swnode;
 860         int ret;
 861
 862         if (!fwnode)
 863                 return 0;
 864
 865         if (!is_software_node(fwnode))
 866                 fwnode = fwnode->secondary;
 867         if (!is_software_node(fwnode))
 868                 return 0;
 869
 870         swnode = to_swnode(fwnode);
 871
 872         switch (action) {
 873         case KOBJ_ADD:
 874                 ret = sysfs_create_link(&dev->kobj, &swnode->kobj,
 875                                         "software_node");
 876                 if (ret)
 877                         break;
 878
 879                 ret = sysfs_create_link(&swnode->kobj, &dev->kobj,
 880                                         dev_name(dev));
 881                 if (ret) {
 882                         sysfs_remove_link(&dev->kobj, "software_node");
 883                         break;
 884                 }
 885                 kobject_get(&swnode->kobj);
 886                 break;
 887         case KOBJ_REMOVE:
 888                 sysfs_remove_link(&swnode->kobj, dev_name(dev));
 889                 sysfs_remove_link(&dev->kobj, "software_node");
 890                 kobject_put(&swnode->kobj);
 891                 break;
 892         default:
 893                 break;
 894         }
 895
 896         return 0;
 897 }
 898
 899 static int __init software_node_init(void)
 900 {
 901         swnode_kset = kset_create_and_add("software_nodes", NULL, kernel_kobj);
 902         if (!swnode_kset)
 903                 return -ENOMEM;
 904         return 0;
 905 }
 906 postcore_initcall(software_node_init);
 907
 908 static void __exit software_node_exit(void)
 909 {
 910         ida_destroy(&swnode_root_ids);
 911         kset_unregister(swnode_kset);
 912 }
 913 __exitcall(software_node_exit);