Loading...
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#include "base.h"
15
16struct swnode {
17 struct kobject kobj;
18 struct fwnode_handle fwnode;
19 const struct software_node *node;
20 int id;
21
22 /* hierarchy */
23 struct ida child_ids;
24 struct list_head entry;
25 struct list_head children;
26 struct swnode *parent;
27
28 unsigned int allocated:1;
29 unsigned int managed:1;
30};
31
32static DEFINE_IDA(swnode_root_ids);
33static struct kset *swnode_kset;
34
35#define kobj_to_swnode(_kobj_) container_of(_kobj_, struct swnode, kobj)
36
37static const struct fwnode_operations software_node_ops;
38
39bool is_software_node(const struct fwnode_handle *fwnode)
40{
41 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &software_node_ops;
42}
43EXPORT_SYMBOL_GPL(is_software_node);
44
45#define to_swnode(__fwnode) \
46 ({ \
47 typeof(__fwnode) __to_swnode_fwnode = __fwnode; \
48 \
49 is_software_node(__to_swnode_fwnode) ? \
50 container_of(__to_swnode_fwnode, \
51 struct swnode, fwnode) : NULL; \
52 })
53
54static inline struct swnode *dev_to_swnode(struct device *dev)
55{
56 struct fwnode_handle *fwnode = dev_fwnode(dev);
57
58 if (!fwnode)
59 return NULL;
60
61 if (!is_software_node(fwnode))
62 fwnode = fwnode->secondary;
63
64 return to_swnode(fwnode);
65}
66
67static struct swnode *
68software_node_to_swnode(const struct software_node *node)
69{
70 struct swnode *swnode = NULL;
71 struct kobject *k;
72
73 if (!node)
74 return NULL;
75
76 spin_lock(&swnode_kset->list_lock);
77
78 list_for_each_entry(k, &swnode_kset->list, entry) {
79 swnode = kobj_to_swnode(k);
80 if (swnode->node == node)
81 break;
82 swnode = NULL;
83 }
84
85 spin_unlock(&swnode_kset->list_lock);
86
87 return swnode;
88}
89
90const struct software_node *to_software_node(const struct fwnode_handle *fwnode)
91{
92 const struct swnode *swnode = to_swnode(fwnode);
93
94 return swnode ? swnode->node : NULL;
95}
96EXPORT_SYMBOL_GPL(to_software_node);
97
98struct fwnode_handle *software_node_fwnode(const struct software_node *node)
99{
100 struct swnode *swnode = software_node_to_swnode(node);
101
102 return swnode ? &swnode->fwnode : NULL;
103}
104EXPORT_SYMBOL_GPL(software_node_fwnode);
105
106/* -------------------------------------------------------------------------- */
107/* property_entry processing */
108
109static const struct property_entry *
110property_entry_get(const struct property_entry *prop, const char *name)
111{
112 if (!prop)
113 return NULL;
114
115 for (; prop->name; prop++)
116 if (!strcmp(name, prop->name))
117 return prop;
118
119 return NULL;
120}
121
122static const void *property_get_pointer(const struct property_entry *prop)
123{
124 if (!prop->length)
125 return NULL;
126
127 return prop->is_inline ? &prop->value : prop->pointer;
128}
129
130static const void *property_entry_find(const struct property_entry *props,
131 const char *propname, size_t length)
132{
133 const struct property_entry *prop;
134 const void *pointer;
135
136 prop = property_entry_get(props, propname);
137 if (!prop)
138 return ERR_PTR(-EINVAL);
139 pointer = property_get_pointer(prop);
140 if (!pointer)
141 return ERR_PTR(-ENODATA);
142 if (length > prop->length)
143 return ERR_PTR(-EOVERFLOW);
144 return pointer;
145}
146
147static int
148property_entry_count_elems_of_size(const struct property_entry *props,
149 const char *propname, size_t length)
150{
151 const struct property_entry *prop;
152
153 prop = property_entry_get(props, propname);
154 if (!prop)
155 return -EINVAL;
156
157 return prop->length / length;
158}
159
160static int property_entry_read_int_array(const struct property_entry *props,
161 const char *name,
162 unsigned int elem_size, void *val,
163 size_t nval)
164{
165 const void *pointer;
166 size_t length;
167
168 if (!val)
169 return property_entry_count_elems_of_size(props, name,
170 elem_size);
171
172 if (!is_power_of_2(elem_size) || elem_size > sizeof(u64))
173 return -ENXIO;
174
175 length = nval * elem_size;
176
177 pointer = property_entry_find(props, name, length);
178 if (IS_ERR(pointer))
179 return PTR_ERR(pointer);
180
181 memcpy(val, pointer, length);
182 return 0;
183}
184
185static int property_entry_read_string_array(const struct property_entry *props,
186 const char *propname,
187 const char **strings, size_t nval)
188{
189 const void *pointer;
190 size_t length;
191 int array_len;
192
193 /* Find out the array length. */
194 array_len = property_entry_count_elems_of_size(props, propname,
195 sizeof(const char *));
196 if (array_len < 0)
197 return array_len;
198
199 /* Return how many there are if strings is NULL. */
200 if (!strings)
201 return array_len;
202
203 array_len = min_t(size_t, nval, array_len);
204 length = array_len * sizeof(*strings);
205
206 pointer = property_entry_find(props, propname, length);
207 if (IS_ERR(pointer))
208 return PTR_ERR(pointer);
209
210 memcpy(strings, pointer, length);
211
212 return array_len;
213}
214
215static void property_entry_free_data(const struct property_entry *p)
216{
217 const char * const *src_str;
218 size_t i, nval;
219
220 if (p->type == DEV_PROP_STRING) {
221 src_str = property_get_pointer(p);
222 nval = p->length / sizeof(*src_str);
223 for (i = 0; i < nval; i++)
224 kfree(src_str[i]);
225 }
226
227 if (!p->is_inline)
228 kfree(p->pointer);
229
230 kfree(p->name);
231}
232
233static bool property_copy_string_array(const char **dst_ptr,
234 const char * const *src_ptr,
235 size_t nval)
236{
237 int i;
238
239 for (i = 0; i < nval; i++) {
240 dst_ptr[i] = kstrdup(src_ptr[i], GFP_KERNEL);
241 if (!dst_ptr[i] && src_ptr[i]) {
242 while (--i >= 0)
243 kfree(dst_ptr[i]);
244 return false;
245 }
246 }
247
248 return true;
249}
250
251static int property_entry_copy_data(struct property_entry *dst,
252 const struct property_entry *src)
253{
254 const void *pointer = property_get_pointer(src);
255 void *dst_ptr;
256 size_t nval;
257
258 /*
259 * Properties with no data should not be marked as stored
260 * out of line.
261 */
262 if (!src->is_inline && !src->length)
263 return -ENODATA;
264
265 /*
266 * Reference properties are never stored inline as
267 * they are too big.
268 */
269 if (src->type == DEV_PROP_REF && src->is_inline)
270 return -EINVAL;
271
272 if (src->length <= sizeof(dst->value)) {
273 dst_ptr = &dst->value;
274 dst->is_inline = true;
275 } else {
276 dst_ptr = kmalloc(src->length, GFP_KERNEL);
277 if (!dst_ptr)
278 return -ENOMEM;
279 dst->pointer = dst_ptr;
280 }
281
282 if (src->type == DEV_PROP_STRING) {
283 nval = src->length / sizeof(const char *);
284 if (!property_copy_string_array(dst_ptr, pointer, nval)) {
285 if (!dst->is_inline)
286 kfree(dst->pointer);
287 return -ENOMEM;
288 }
289 } else {
290 memcpy(dst_ptr, pointer, src->length);
291 }
292
293 dst->length = src->length;
294 dst->type = src->type;
295 dst->name = kstrdup(src->name, GFP_KERNEL);
296 if (!dst->name) {
297 property_entry_free_data(dst);
298 return -ENOMEM;
299 }
300
301 return 0;
302}
303
304/**
305 * property_entries_dup - duplicate array of properties
306 * @properties: array of properties to copy
307 *
308 * This function creates a deep copy of the given NULL-terminated array
309 * of property entries.
310 */
311struct property_entry *
312property_entries_dup(const struct property_entry *properties)
313{
314 struct property_entry *p;
315 int i, n = 0;
316 int ret;
317
318 if (!properties)
319 return NULL;
320
321 while (properties[n].name)
322 n++;
323
324 p = kcalloc(n + 1, sizeof(*p), GFP_KERNEL);
325 if (!p)
326 return ERR_PTR(-ENOMEM);
327
328 for (i = 0; i < n; i++) {
329 ret = property_entry_copy_data(&p[i], &properties[i]);
330 if (ret) {
331 while (--i >= 0)
332 property_entry_free_data(&p[i]);
333 kfree(p);
334 return ERR_PTR(ret);
335 }
336 }
337
338 return p;
339}
340EXPORT_SYMBOL_GPL(property_entries_dup);
341
342/**
343 * property_entries_free - free previously allocated array of properties
344 * @properties: array of properties to destroy
345 *
346 * This function frees given NULL-terminated array of property entries,
347 * along with their data.
348 */
349void property_entries_free(const struct property_entry *properties)
350{
351 const struct property_entry *p;
352
353 if (!properties)
354 return;
355
356 for (p = properties; p->name; p++)
357 property_entry_free_data(p);
358
359 kfree(properties);
360}
361EXPORT_SYMBOL_GPL(property_entries_free);
362
363/* -------------------------------------------------------------------------- */
364/* fwnode operations */
365
366static struct fwnode_handle *software_node_get(struct fwnode_handle *fwnode)
367{
368 struct swnode *swnode = to_swnode(fwnode);
369
370 kobject_get(&swnode->kobj);
371
372 return &swnode->fwnode;
373}
374
375static void software_node_put(struct fwnode_handle *fwnode)
376{
377 struct swnode *swnode = to_swnode(fwnode);
378
379 kobject_put(&swnode->kobj);
380}
381
382static bool software_node_property_present(const struct fwnode_handle *fwnode,
383 const char *propname)
384{
385 struct swnode *swnode = to_swnode(fwnode);
386
387 return !!property_entry_get(swnode->node->properties, propname);
388}
389
390static int software_node_read_int_array(const struct fwnode_handle *fwnode,
391 const char *propname,
392 unsigned int elem_size, void *val,
393 size_t nval)
394{
395 struct swnode *swnode = to_swnode(fwnode);
396
397 return property_entry_read_int_array(swnode->node->properties, propname,
398 elem_size, val, nval);
399}
400
401static int software_node_read_string_array(const struct fwnode_handle *fwnode,
402 const char *propname,
403 const char **val, size_t nval)
404{
405 struct swnode *swnode = to_swnode(fwnode);
406
407 return property_entry_read_string_array(swnode->node->properties,
408 propname, val, nval);
409}
410
411static const char *
412software_node_get_name(const struct fwnode_handle *fwnode)
413{
414 const struct swnode *swnode = to_swnode(fwnode);
415
416 return kobject_name(&swnode->kobj);
417}
418
419static const char *
420software_node_get_name_prefix(const struct fwnode_handle *fwnode)
421{
422 struct fwnode_handle *parent;
423 const char *prefix;
424
425 parent = fwnode_get_parent(fwnode);
426 if (!parent)
427 return "";
428
429 /* Figure out the prefix from the parents. */
430 while (is_software_node(parent))
431 parent = fwnode_get_next_parent(parent);
432
433 prefix = fwnode_get_name_prefix(parent);
434 fwnode_handle_put(parent);
435
436 /* Guess something if prefix was NULL. */
437 return prefix ?: "/";
438}
439
440static struct fwnode_handle *
441software_node_get_parent(const struct fwnode_handle *fwnode)
442{
443 struct swnode *swnode = to_swnode(fwnode);
444
445 if (!swnode || !swnode->parent)
446 return NULL;
447
448 return fwnode_handle_get(&swnode->parent->fwnode);
449}
450
451static struct fwnode_handle *
452software_node_get_next_child(const struct fwnode_handle *fwnode,
453 struct fwnode_handle *child)
454{
455 struct swnode *p = to_swnode(fwnode);
456 struct swnode *c = to_swnode(child);
457
458 if (!p || list_empty(&p->children) ||
459 (c && list_is_last(&c->entry, &p->children))) {
460 fwnode_handle_put(child);
461 return NULL;
462 }
463
464 if (c)
465 c = list_next_entry(c, entry);
466 else
467 c = list_first_entry(&p->children, struct swnode, entry);
468
469 fwnode_handle_put(child);
470 return fwnode_handle_get(&c->fwnode);
471}
472
473static struct fwnode_handle *
474software_node_get_named_child_node(const struct fwnode_handle *fwnode,
475 const char *childname)
476{
477 struct swnode *swnode = to_swnode(fwnode);
478 struct swnode *child;
479
480 if (!swnode || list_empty(&swnode->children))
481 return NULL;
482
483 list_for_each_entry(child, &swnode->children, entry) {
484 if (!strcmp(childname, kobject_name(&child->kobj))) {
485 kobject_get(&child->kobj);
486 return &child->fwnode;
487 }
488 }
489 return NULL;
490}
491
492static int
493software_node_get_reference_args(const struct fwnode_handle *fwnode,
494 const char *propname, const char *nargs_prop,
495 unsigned int nargs, unsigned int index,
496 struct fwnode_reference_args *args)
497{
498 struct swnode *swnode = to_swnode(fwnode);
499 const struct software_node_ref_args *ref_array;
500 const struct software_node_ref_args *ref;
501 const struct property_entry *prop;
502 struct fwnode_handle *refnode;
503 u32 nargs_prop_val;
504 int error;
505 int i;
506
507 prop = property_entry_get(swnode->node->properties, propname);
508 if (!prop)
509 return -ENOENT;
510
511 if (prop->type != DEV_PROP_REF)
512 return -EINVAL;
513
514 /*
515 * We expect that references are never stored inline, even
516 * single ones, as they are too big.
517 */
518 if (prop->is_inline)
519 return -EINVAL;
520
521 if (index * sizeof(*ref) >= prop->length)
522 return -ENOENT;
523
524 ref_array = prop->pointer;
525 ref = &ref_array[index];
526
527 refnode = software_node_fwnode(ref->node);
528 if (!refnode)
529 return -ENOENT;
530
531 if (nargs_prop) {
532 error = property_entry_read_int_array(ref->node->properties,
533 nargs_prop, sizeof(u32),
534 &nargs_prop_val, 1);
535 if (error)
536 return error;
537
538 nargs = nargs_prop_val;
539 }
540
541 if (nargs > NR_FWNODE_REFERENCE_ARGS)
542 return -EINVAL;
543
544 if (!args)
545 return 0;
546
547 args->fwnode = software_node_get(refnode);
548 args->nargs = nargs;
549
550 for (i = 0; i < nargs; i++)
551 args->args[i] = ref->args[i];
552
553 return 0;
554}
555
556static struct fwnode_handle *
557swnode_graph_find_next_port(const struct fwnode_handle *parent,
558 struct fwnode_handle *port)
559{
560 struct fwnode_handle *old = port;
561
562 while ((port = software_node_get_next_child(parent, old))) {
563 /*
564 * fwnode ports have naming style "port@", so we search for any
565 * children that follow that convention.
566 */
567 if (!strncmp(to_swnode(port)->node->name, "port@",
568 strlen("port@")))
569 return port;
570 old = port;
571 }
572
573 return NULL;
574}
575
576static struct fwnode_handle *
577software_node_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
578 struct fwnode_handle *endpoint)
579{
580 struct swnode *swnode = to_swnode(fwnode);
581 struct fwnode_handle *parent;
582 struct fwnode_handle *port;
583
584 if (!swnode)
585 return NULL;
586
587 if (endpoint) {
588 port = software_node_get_parent(endpoint);
589 parent = software_node_get_parent(port);
590 } else {
591 parent = software_node_get_named_child_node(fwnode, "ports");
592 if (!parent)
593 parent = software_node_get(&swnode->fwnode);
594
595 port = swnode_graph_find_next_port(parent, NULL);
596 }
597
598 for (; port; port = swnode_graph_find_next_port(parent, port)) {
599 endpoint = software_node_get_next_child(port, endpoint);
600 if (endpoint) {
601 fwnode_handle_put(port);
602 break;
603 }
604 }
605
606 fwnode_handle_put(parent);
607
608 return endpoint;
609}
610
611static struct fwnode_handle *
612software_node_graph_get_remote_endpoint(const struct fwnode_handle *fwnode)
613{
614 struct swnode *swnode = to_swnode(fwnode);
615 const struct software_node_ref_args *ref;
616 const struct property_entry *prop;
617
618 if (!swnode)
619 return NULL;
620
621 prop = property_entry_get(swnode->node->properties, "remote-endpoint");
622 if (!prop || prop->type != DEV_PROP_REF || prop->is_inline)
623 return NULL;
624
625 ref = prop->pointer;
626
627 return software_node_get(software_node_fwnode(ref[0].node));
628}
629
630static struct fwnode_handle *
631software_node_graph_get_port_parent(struct fwnode_handle *fwnode)
632{
633 struct swnode *swnode = to_swnode(fwnode);
634
635 swnode = swnode->parent;
636 if (swnode && !strcmp(swnode->node->name, "ports"))
637 swnode = swnode->parent;
638
639 return swnode ? software_node_get(&swnode->fwnode) : NULL;
640}
641
642static int
643software_node_graph_parse_endpoint(const struct fwnode_handle *fwnode,
644 struct fwnode_endpoint *endpoint)
645{
646 struct swnode *swnode = to_swnode(fwnode);
647 const char *parent_name = swnode->parent->node->name;
648 int ret;
649
650 if (strlen("port@") >= strlen(parent_name) ||
651 strncmp(parent_name, "port@", strlen("port@")))
652 return -EINVAL;
653
654 /* Ports have naming style "port@n", we need to select the n */
655 ret = kstrtou32(parent_name + strlen("port@"), 10, &endpoint->port);
656 if (ret)
657 return ret;
658
659 endpoint->id = swnode->id;
660 endpoint->local_fwnode = fwnode;
661
662 return 0;
663}
664
665static const struct fwnode_operations software_node_ops = {
666 .get = software_node_get,
667 .put = software_node_put,
668 .property_present = software_node_property_present,
669 .property_read_int_array = software_node_read_int_array,
670 .property_read_string_array = software_node_read_string_array,
671 .get_name = software_node_get_name,
672 .get_name_prefix = software_node_get_name_prefix,
673 .get_parent = software_node_get_parent,
674 .get_next_child_node = software_node_get_next_child,
675 .get_named_child_node = software_node_get_named_child_node,
676 .get_reference_args = software_node_get_reference_args,
677 .graph_get_next_endpoint = software_node_graph_get_next_endpoint,
678 .graph_get_remote_endpoint = software_node_graph_get_remote_endpoint,
679 .graph_get_port_parent = software_node_graph_get_port_parent,
680 .graph_parse_endpoint = software_node_graph_parse_endpoint,
681};
682
683/* -------------------------------------------------------------------------- */
684
685/**
686 * software_node_find_by_name - Find software node by name
687 * @parent: Parent of the software node
688 * @name: Name of the software node
689 *
690 * The function will find a node that is child of @parent and that is named
691 * @name. If no node is found, the function returns NULL.
692 *
693 * NOTE: you will need to drop the reference with fwnode_handle_put() after use.
694 */
695const struct software_node *
696software_node_find_by_name(const struct software_node *parent, const char *name)
697{
698 struct swnode *swnode = NULL;
699 struct kobject *k;
700
701 if (!name)
702 return NULL;
703
704 spin_lock(&swnode_kset->list_lock);
705
706 list_for_each_entry(k, &swnode_kset->list, entry) {
707 swnode = kobj_to_swnode(k);
708 if (parent == swnode->node->parent && swnode->node->name &&
709 !strcmp(name, swnode->node->name)) {
710 kobject_get(&swnode->kobj);
711 break;
712 }
713 swnode = NULL;
714 }
715
716 spin_unlock(&swnode_kset->list_lock);
717
718 return swnode ? swnode->node : NULL;
719}
720EXPORT_SYMBOL_GPL(software_node_find_by_name);
721
722static struct software_node *software_node_alloc(const struct property_entry *properties)
723{
724 struct property_entry *props;
725 struct software_node *node;
726
727 props = property_entries_dup(properties);
728 if (IS_ERR(props))
729 return ERR_CAST(props);
730
731 node = kzalloc(sizeof(*node), GFP_KERNEL);
732 if (!node) {
733 property_entries_free(props);
734 return ERR_PTR(-ENOMEM);
735 }
736
737 node->properties = props;
738
739 return node;
740}
741
742static void software_node_free(const struct software_node *node)
743{
744 property_entries_free(node->properties);
745 kfree(node);
746}
747
748static void software_node_release(struct kobject *kobj)
749{
750 struct swnode *swnode = kobj_to_swnode(kobj);
751
752 if (swnode->parent) {
753 ida_free(&swnode->parent->child_ids, swnode->id);
754 list_del(&swnode->entry);
755 } else {
756 ida_free(&swnode_root_ids, swnode->id);
757 }
758
759 if (swnode->allocated)
760 software_node_free(swnode->node);
761
762 ida_destroy(&swnode->child_ids);
763 kfree(swnode);
764}
765
766static const struct kobj_type software_node_type = {
767 .release = software_node_release,
768 .sysfs_ops = &kobj_sysfs_ops,
769};
770
771static struct fwnode_handle *
772swnode_register(const struct software_node *node, struct swnode *parent,
773 unsigned int allocated)
774{
775 struct swnode *swnode;
776 int ret;
777
778 swnode = kzalloc(sizeof(*swnode), GFP_KERNEL);
779 if (!swnode)
780 return ERR_PTR(-ENOMEM);
781
782 ret = ida_alloc(parent ? &parent->child_ids : &swnode_root_ids,
783 GFP_KERNEL);
784 if (ret < 0) {
785 kfree(swnode);
786 return ERR_PTR(ret);
787 }
788
789 swnode->id = ret;
790 swnode->node = node;
791 swnode->parent = parent;
792 swnode->kobj.kset = swnode_kset;
793 fwnode_init(&swnode->fwnode, &software_node_ops);
794
795 ida_init(&swnode->child_ids);
796 INIT_LIST_HEAD(&swnode->entry);
797 INIT_LIST_HEAD(&swnode->children);
798
799 if (node->name)
800 ret = kobject_init_and_add(&swnode->kobj, &software_node_type,
801 parent ? &parent->kobj : NULL,
802 "%s", node->name);
803 else
804 ret = kobject_init_and_add(&swnode->kobj, &software_node_type,
805 parent ? &parent->kobj : NULL,
806 "node%d", swnode->id);
807 if (ret) {
808 kobject_put(&swnode->kobj);
809 return ERR_PTR(ret);
810 }
811
812 /*
813 * Assign the flag only in the successful case, so
814 * the above kobject_put() won't mess up with properties.
815 */
816 swnode->allocated = allocated;
817
818 if (parent)
819 list_add_tail(&swnode->entry, &parent->children);
820
821 kobject_uevent(&swnode->kobj, KOBJ_ADD);
822 return &swnode->fwnode;
823}
824
825/**
826 * software_node_register_node_group - Register a group of software nodes
827 * @node_group: NULL terminated array of software node pointers to be registered
828 *
829 * Register multiple software nodes at once. If any node in the array
830 * has its .parent pointer set (which can only be to another software_node),
831 * then its parent **must** have been registered before it is; either outside
832 * of this function or by ordering the array such that parent comes before
833 * child.
834 */
835int software_node_register_node_group(const struct software_node **node_group)
836{
837 unsigned int i;
838 int ret;
839
840 if (!node_group)
841 return 0;
842
843 for (i = 0; node_group[i]; i++) {
844 ret = software_node_register(node_group[i]);
845 if (ret) {
846 software_node_unregister_node_group(node_group);
847 return ret;
848 }
849 }
850
851 return 0;
852}
853EXPORT_SYMBOL_GPL(software_node_register_node_group);
854
855/**
856 * software_node_unregister_node_group - Unregister a group of software nodes
857 * @node_group: NULL terminated array of software node pointers to be unregistered
858 *
859 * Unregister multiple software nodes at once. If parent pointers are set up
860 * in any of the software nodes then the array **must** be ordered such that
861 * parents come before their children.
862 *
863 * NOTE: If you are uncertain whether the array is ordered such that
864 * parents will be unregistered before their children, it is wiser to
865 * remove the nodes individually, in the correct order (child before
866 * parent).
867 */
868void software_node_unregister_node_group(
869 const struct software_node **node_group)
870{
871 unsigned int i = 0;
872
873 if (!node_group)
874 return;
875
876 while (node_group[i])
877 i++;
878
879 while (i--)
880 software_node_unregister(node_group[i]);
881}
882EXPORT_SYMBOL_GPL(software_node_unregister_node_group);
883
884/**
885 * software_node_register - Register static software node
886 * @node: The software node to be registered
887 */
888int software_node_register(const struct software_node *node)
889{
890 struct swnode *parent = software_node_to_swnode(node->parent);
891
892 if (software_node_to_swnode(node))
893 return -EEXIST;
894
895 if (node->parent && !parent)
896 return -EINVAL;
897
898 return PTR_ERR_OR_ZERO(swnode_register(node, parent, 0));
899}
900EXPORT_SYMBOL_GPL(software_node_register);
901
902/**
903 * software_node_unregister - Unregister static software node
904 * @node: The software node to be unregistered
905 */
906void software_node_unregister(const struct software_node *node)
907{
908 struct swnode *swnode;
909
910 swnode = software_node_to_swnode(node);
911 if (swnode)
912 fwnode_remove_software_node(&swnode->fwnode);
913}
914EXPORT_SYMBOL_GPL(software_node_unregister);
915
916struct fwnode_handle *
917fwnode_create_software_node(const struct property_entry *properties,
918 const struct fwnode_handle *parent)
919{
920 struct fwnode_handle *fwnode;
921 struct software_node *node;
922 struct swnode *p;
923
924 if (IS_ERR(parent))
925 return ERR_CAST(parent);
926
927 p = to_swnode(parent);
928 if (parent && !p)
929 return ERR_PTR(-EINVAL);
930
931 node = software_node_alloc(properties);
932 if (IS_ERR(node))
933 return ERR_CAST(node);
934
935 node->parent = p ? p->node : NULL;
936
937 fwnode = swnode_register(node, p, 1);
938 if (IS_ERR(fwnode))
939 software_node_free(node);
940
941 return fwnode;
942}
943EXPORT_SYMBOL_GPL(fwnode_create_software_node);
944
945void fwnode_remove_software_node(struct fwnode_handle *fwnode)
946{
947 struct swnode *swnode = to_swnode(fwnode);
948
949 if (!swnode)
950 return;
951
952 kobject_put(&swnode->kobj);
953}
954EXPORT_SYMBOL_GPL(fwnode_remove_software_node);
955
956/**
957 * device_add_software_node - Assign software node to a device
958 * @dev: The device the software node is meant for.
959 * @node: The software node.
960 *
961 * This function will make @node the secondary firmware node pointer of @dev. If
962 * @dev has no primary node, then @node will become the primary node. The
963 * function will register @node automatically if it wasn't already registered.
964 */
965int device_add_software_node(struct device *dev, const struct software_node *node)
966{
967 struct swnode *swnode;
968 int ret;
969
970 /* Only one software node per device. */
971 if (dev_to_swnode(dev))
972 return -EBUSY;
973
974 swnode = software_node_to_swnode(node);
975 if (swnode) {
976 kobject_get(&swnode->kobj);
977 } else {
978 ret = software_node_register(node);
979 if (ret)
980 return ret;
981
982 swnode = software_node_to_swnode(node);
983 }
984
985 set_secondary_fwnode(dev, &swnode->fwnode);
986
987 /*
988 * If the device has been fully registered by the time this function is
989 * called, software_node_notify() must be called separately so that the
990 * symlinks get created and the reference count of the node is kept in
991 * balance.
992 */
993 if (device_is_registered(dev))
994 software_node_notify(dev);
995
996 return 0;
997}
998EXPORT_SYMBOL_GPL(device_add_software_node);
999
1000/**
1001 * device_remove_software_node - Remove device's software node
1002 * @dev: The device with the software node.
1003 *
1004 * This function will unregister the software node of @dev.
1005 */
1006void device_remove_software_node(struct device *dev)
1007{
1008 struct swnode *swnode;
1009
1010 swnode = dev_to_swnode(dev);
1011 if (!swnode)
1012 return;
1013
1014 if (device_is_registered(dev))
1015 software_node_notify_remove(dev);
1016
1017 set_secondary_fwnode(dev, NULL);
1018 kobject_put(&swnode->kobj);
1019}
1020EXPORT_SYMBOL_GPL(device_remove_software_node);
1021
1022/**
1023 * device_create_managed_software_node - Create a software node for a device
1024 * @dev: The device the software node is assigned to.
1025 * @properties: Device properties for the software node.
1026 * @parent: Parent of the software node.
1027 *
1028 * Creates a software node as a managed resource for @dev, which means the
1029 * lifetime of the newly created software node is tied to the lifetime of @dev.
1030 * Software nodes created with this function should not be reused or shared
1031 * because of that. The function takes a deep copy of @properties for the
1032 * software node.
1033 *
1034 * Since the new software node is assigned directly to @dev, and since it should
1035 * not be shared, it is not returned to the caller. The function returns 0 on
1036 * success, and errno in case of an error.
1037 */
1038int device_create_managed_software_node(struct device *dev,
1039 const struct property_entry *properties,
1040 const struct software_node *parent)
1041{
1042 struct fwnode_handle *p = software_node_fwnode(parent);
1043 struct fwnode_handle *fwnode;
1044
1045 if (parent && !p)
1046 return -EINVAL;
1047
1048 fwnode = fwnode_create_software_node(properties, p);
1049 if (IS_ERR(fwnode))
1050 return PTR_ERR(fwnode);
1051
1052 to_swnode(fwnode)->managed = true;
1053 set_secondary_fwnode(dev, fwnode);
1054
1055 if (device_is_registered(dev))
1056 software_node_notify(dev);
1057
1058 return 0;
1059}
1060EXPORT_SYMBOL_GPL(device_create_managed_software_node);
1061
1062void software_node_notify(struct device *dev)
1063{
1064 struct swnode *swnode;
1065 int ret;
1066
1067 swnode = dev_to_swnode(dev);
1068 if (!swnode)
1069 return;
1070
1071 ret = sysfs_create_link(&dev->kobj, &swnode->kobj, "software_node");
1072 if (ret)
1073 return;
1074
1075 ret = sysfs_create_link(&swnode->kobj, &dev->kobj, dev_name(dev));
1076 if (ret) {
1077 sysfs_remove_link(&dev->kobj, "software_node");
1078 return;
1079 }
1080
1081 kobject_get(&swnode->kobj);
1082}
1083
1084void software_node_notify_remove(struct device *dev)
1085{
1086 struct swnode *swnode;
1087
1088 swnode = dev_to_swnode(dev);
1089 if (!swnode)
1090 return;
1091
1092 sysfs_remove_link(&swnode->kobj, dev_name(dev));
1093 sysfs_remove_link(&dev->kobj, "software_node");
1094 kobject_put(&swnode->kobj);
1095
1096 if (swnode->managed) {
1097 set_secondary_fwnode(dev, NULL);
1098 kobject_put(&swnode->kobj);
1099 }
1100}
1101
1102static int __init software_node_init(void)
1103{
1104 swnode_kset = kset_create_and_add("software_nodes", NULL, kernel_kobj);
1105 if (!swnode_kset)
1106 return -ENOMEM;
1107 return 0;
1108}
1109postcore_initcall(software_node_init);
1110
1111static void __exit software_node_exit(void)
1112{
1113 ida_destroy(&swnode_root_ids);
1114 kset_unregister(swnode_kset);
1115}
1116__exitcall(software_node_exit);
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
14struct 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
29static DEFINE_IDA(swnode_root_ids);
30static struct kset *swnode_kset;
31
32#define kobj_to_swnode(_kobj_) container_of(_kobj_, struct swnode, kobj)
33
34static const struct fwnode_operations software_node_ops;
35
36bool is_software_node(const struct fwnode_handle *fwnode)
37{
38 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &software_node_ops;
39}
40EXPORT_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
51static struct swnode *
52software_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
74const 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}
80EXPORT_SYMBOL_GPL(to_software_node);
81
82struct 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}
88EXPORT_SYMBOL_GPL(software_node_fwnode);
89
90/* -------------------------------------------------------------------------- */
91/* property_entry processing */
92
93static const struct property_entry *
94property_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
106static 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
114static 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
131static int
132property_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
144static 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
169static 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
199static 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
217static 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
235static 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 */
295struct property_entry *
296property_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}
324EXPORT_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 */
333void 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}
345EXPORT_SYMBOL_GPL(property_entries_free);
346
347/* -------------------------------------------------------------------------- */
348/* fwnode operations */
349
350static 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
359static void software_node_put(struct fwnode_handle *fwnode)
360{
361 struct swnode *swnode = to_swnode(fwnode);
362
363 kobject_put(&swnode->kobj);
364}
365
366static 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
374static 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
385static 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
395static const char *
396software_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
406static const char *
407software_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
427static struct fwnode_handle *
428software_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
438static struct fwnode_handle *
439software_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 return NULL;
448
449 if (c)
450 c = list_next_entry(c, entry);
451 else
452 c = list_first_entry(&p->children, struct swnode, entry);
453 return &c->fwnode;
454}
455
456static struct fwnode_handle *
457software_node_get_named_child_node(const struct fwnode_handle *fwnode,
458 const char *childname)
459{
460 struct swnode *swnode = to_swnode(fwnode);
461 struct swnode *child;
462
463 if (!swnode || list_empty(&swnode->children))
464 return NULL;
465
466 list_for_each_entry(child, &swnode->children, entry) {
467 if (!strcmp(childname, kobject_name(&child->kobj))) {
468 kobject_get(&child->kobj);
469 return &child->fwnode;
470 }
471 }
472 return NULL;
473}
474
475static int
476software_node_get_reference_args(const struct fwnode_handle *fwnode,
477 const char *propname, const char *nargs_prop,
478 unsigned int nargs, unsigned int index,
479 struct fwnode_reference_args *args)
480{
481 struct swnode *swnode = to_swnode(fwnode);
482 const struct software_node_ref_args *ref_array;
483 const struct software_node_ref_args *ref;
484 const struct property_entry *prop;
485 struct fwnode_handle *refnode;
486 u32 nargs_prop_val;
487 int error;
488 int i;
489
490 if (!swnode)
491 return -ENOENT;
492
493 prop = property_entry_get(swnode->node->properties, propname);
494 if (!prop)
495 return -ENOENT;
496
497 if (prop->type != DEV_PROP_REF)
498 return -EINVAL;
499
500 /*
501 * We expect that references are never stored inline, even
502 * single ones, as they are too big.
503 */
504 if (prop->is_inline)
505 return -EINVAL;
506
507 if (index * sizeof(*ref) >= prop->length)
508 return -ENOENT;
509
510 ref_array = prop->pointer;
511 ref = &ref_array[index];
512
513 refnode = software_node_fwnode(ref->node);
514 if (!refnode)
515 return -ENOENT;
516
517 if (nargs_prop) {
518 error = property_entry_read_int_array(swnode->node->properties,
519 nargs_prop, sizeof(u32),
520 &nargs_prop_val, 1);
521 if (error)
522 return error;
523
524 nargs = nargs_prop_val;
525 }
526
527 if (nargs > NR_FWNODE_REFERENCE_ARGS)
528 return -EINVAL;
529
530 args->fwnode = software_node_get(refnode);
531 args->nargs = nargs;
532
533 for (i = 0; i < nargs; i++)
534 args->args[i] = ref->args[i];
535
536 return 0;
537}
538
539static const struct fwnode_operations software_node_ops = {
540 .get = software_node_get,
541 .put = software_node_put,
542 .property_present = software_node_property_present,
543 .property_read_int_array = software_node_read_int_array,
544 .property_read_string_array = software_node_read_string_array,
545 .get_name = software_node_get_name,
546 .get_name_prefix = software_node_get_name_prefix,
547 .get_parent = software_node_get_parent,
548 .get_next_child_node = software_node_get_next_child,
549 .get_named_child_node = software_node_get_named_child_node,
550 .get_reference_args = software_node_get_reference_args
551};
552
553/* -------------------------------------------------------------------------- */
554
555/**
556 * software_node_find_by_name - Find software node by name
557 * @parent: Parent of the software node
558 * @name: Name of the software node
559 *
560 * The function will find a node that is child of @parent and that is named
561 * @name. If no node is found, the function returns NULL.
562 *
563 * NOTE: you will need to drop the reference with fwnode_handle_put() after use.
564 */
565const struct software_node *
566software_node_find_by_name(const struct software_node *parent, const char *name)
567{
568 struct swnode *swnode = NULL;
569 struct kobject *k;
570
571 if (!name)
572 return NULL;
573
574 spin_lock(&swnode_kset->list_lock);
575
576 list_for_each_entry(k, &swnode_kset->list, entry) {
577 swnode = kobj_to_swnode(k);
578 if (parent == swnode->node->parent && swnode->node->name &&
579 !strcmp(name, swnode->node->name)) {
580 kobject_get(&swnode->kobj);
581 break;
582 }
583 swnode = NULL;
584 }
585
586 spin_unlock(&swnode_kset->list_lock);
587
588 return swnode ? swnode->node : NULL;
589}
590EXPORT_SYMBOL_GPL(software_node_find_by_name);
591
592static int
593software_node_register_properties(struct software_node *node,
594 const struct property_entry *properties)
595{
596 struct property_entry *props;
597
598 props = property_entries_dup(properties);
599 if (IS_ERR(props))
600 return PTR_ERR(props);
601
602 node->properties = props;
603
604 return 0;
605}
606
607static void software_node_release(struct kobject *kobj)
608{
609 struct swnode *swnode = kobj_to_swnode(kobj);
610
611 if (swnode->parent) {
612 ida_simple_remove(&swnode->parent->child_ids, swnode->id);
613 list_del(&swnode->entry);
614 } else {
615 ida_simple_remove(&swnode_root_ids, swnode->id);
616 }
617
618 if (swnode->allocated) {
619 property_entries_free(swnode->node->properties);
620 kfree(swnode->node);
621 }
622 ida_destroy(&swnode->child_ids);
623 kfree(swnode);
624}
625
626static struct kobj_type software_node_type = {
627 .release = software_node_release,
628 .sysfs_ops = &kobj_sysfs_ops,
629};
630
631static struct fwnode_handle *
632swnode_register(const struct software_node *node, struct swnode *parent,
633 unsigned int allocated)
634{
635 struct swnode *swnode;
636 int ret;
637
638 swnode = kzalloc(sizeof(*swnode), GFP_KERNEL);
639 if (!swnode) {
640 ret = -ENOMEM;
641 goto out_err;
642 }
643
644 ret = ida_simple_get(parent ? &parent->child_ids : &swnode_root_ids,
645 0, 0, GFP_KERNEL);
646 if (ret < 0) {
647 kfree(swnode);
648 goto out_err;
649 }
650
651 swnode->id = ret;
652 swnode->node = node;
653 swnode->parent = parent;
654 swnode->allocated = allocated;
655 swnode->kobj.kset = swnode_kset;
656 swnode->fwnode.ops = &software_node_ops;
657
658 ida_init(&swnode->child_ids);
659 INIT_LIST_HEAD(&swnode->entry);
660 INIT_LIST_HEAD(&swnode->children);
661
662 if (node->name)
663 ret = kobject_init_and_add(&swnode->kobj, &software_node_type,
664 parent ? &parent->kobj : NULL,
665 "%s", node->name);
666 else
667 ret = kobject_init_and_add(&swnode->kobj, &software_node_type,
668 parent ? &parent->kobj : NULL,
669 "node%d", swnode->id);
670 if (ret) {
671 kobject_put(&swnode->kobj);
672 return ERR_PTR(ret);
673 }
674
675 if (parent)
676 list_add_tail(&swnode->entry, &parent->children);
677
678 kobject_uevent(&swnode->kobj, KOBJ_ADD);
679 return &swnode->fwnode;
680
681out_err:
682 if (allocated)
683 property_entries_free(node->properties);
684 return ERR_PTR(ret);
685}
686
687/**
688 * software_node_register_nodes - Register an array of software nodes
689 * @nodes: Zero terminated array of software nodes to be registered
690 *
691 * Register multiple software nodes at once.
692 */
693int software_node_register_nodes(const struct software_node *nodes)
694{
695 int ret;
696 int i;
697
698 for (i = 0; nodes[i].name; i++) {
699 ret = software_node_register(&nodes[i]);
700 if (ret) {
701 software_node_unregister_nodes(nodes);
702 return ret;
703 }
704 }
705
706 return 0;
707}
708EXPORT_SYMBOL_GPL(software_node_register_nodes);
709
710/**
711 * software_node_unregister_nodes - Unregister an array of software nodes
712 * @nodes: Zero terminated array of software nodes to be unregistered
713 *
714 * Unregister multiple software nodes at once.
715 *
716 * NOTE: Be careful using this call if the nodes had parent pointers set up in
717 * them before registering. If so, it is wiser to remove the nodes
718 * individually, in the correct order (child before parent) instead of relying
719 * on the sequential order of the list of nodes in the array.
720 */
721void software_node_unregister_nodes(const struct software_node *nodes)
722{
723 int i;
724
725 for (i = 0; nodes[i].name; i++)
726 software_node_unregister(&nodes[i]);
727}
728EXPORT_SYMBOL_GPL(software_node_unregister_nodes);
729
730/**
731 * software_node_register_node_group - Register a group of software nodes
732 * @node_group: NULL terminated array of software node pointers to be registered
733 *
734 * Register multiple software nodes at once.
735 */
736int software_node_register_node_group(const struct software_node **node_group)
737{
738 unsigned int i;
739 int ret;
740
741 if (!node_group)
742 return 0;
743
744 for (i = 0; node_group[i]; i++) {
745 ret = software_node_register(node_group[i]);
746 if (ret) {
747 software_node_unregister_node_group(node_group);
748 return ret;
749 }
750 }
751
752 return 0;
753}
754EXPORT_SYMBOL_GPL(software_node_register_node_group);
755
756/**
757 * software_node_unregister_node_group - Unregister a group of software nodes
758 * @node_group: NULL terminated array of software node pointers to be unregistered
759 *
760 * Unregister multiple software nodes at once.
761 */
762void software_node_unregister_node_group(const struct software_node **node_group)
763{
764 unsigned int i;
765
766 if (!node_group)
767 return;
768
769 for (i = 0; node_group[i]; i++)
770 software_node_unregister(node_group[i]);
771}
772EXPORT_SYMBOL_GPL(software_node_unregister_node_group);
773
774/**
775 * software_node_register - Register static software node
776 * @node: The software node to be registered
777 */
778int software_node_register(const struct software_node *node)
779{
780 struct swnode *parent = software_node_to_swnode(node->parent);
781
782 if (software_node_to_swnode(node))
783 return -EEXIST;
784
785 return PTR_ERR_OR_ZERO(swnode_register(node, parent, 0));
786}
787EXPORT_SYMBOL_GPL(software_node_register);
788
789/**
790 * software_node_unregister - Unregister static software node
791 * @node: The software node to be unregistered
792 */
793void software_node_unregister(const struct software_node *node)
794{
795 struct swnode *swnode;
796
797 swnode = software_node_to_swnode(node);
798 if (swnode)
799 fwnode_remove_software_node(&swnode->fwnode);
800}
801EXPORT_SYMBOL_GPL(software_node_unregister);
802
803struct fwnode_handle *
804fwnode_create_software_node(const struct property_entry *properties,
805 const struct fwnode_handle *parent)
806{
807 struct software_node *node;
808 struct swnode *p = NULL;
809 int ret;
810
811 if (parent) {
812 if (IS_ERR(parent))
813 return ERR_CAST(parent);
814 if (!is_software_node(parent))
815 return ERR_PTR(-EINVAL);
816 p = to_swnode(parent);
817 }
818
819 node = kzalloc(sizeof(*node), GFP_KERNEL);
820 if (!node)
821 return ERR_PTR(-ENOMEM);
822
823 ret = software_node_register_properties(node, properties);
824 if (ret) {
825 kfree(node);
826 return ERR_PTR(ret);
827 }
828
829 node->parent = p ? p->node : NULL;
830
831 return swnode_register(node, p, 1);
832}
833EXPORT_SYMBOL_GPL(fwnode_create_software_node);
834
835void fwnode_remove_software_node(struct fwnode_handle *fwnode)
836{
837 struct swnode *swnode = to_swnode(fwnode);
838
839 if (!swnode)
840 return;
841
842 kobject_put(&swnode->kobj);
843}
844EXPORT_SYMBOL_GPL(fwnode_remove_software_node);
845
846int software_node_notify(struct device *dev, unsigned long action)
847{
848 struct fwnode_handle *fwnode = dev_fwnode(dev);
849 struct swnode *swnode;
850 int ret;
851
852 if (!fwnode)
853 return 0;
854
855 if (!is_software_node(fwnode))
856 fwnode = fwnode->secondary;
857 if (!is_software_node(fwnode))
858 return 0;
859
860 swnode = to_swnode(fwnode);
861
862 switch (action) {
863 case KOBJ_ADD:
864 ret = sysfs_create_link(&dev->kobj, &swnode->kobj,
865 "software_node");
866 if (ret)
867 break;
868
869 ret = sysfs_create_link(&swnode->kobj, &dev->kobj,
870 dev_name(dev));
871 if (ret) {
872 sysfs_remove_link(&dev->kobj, "software_node");
873 break;
874 }
875 kobject_get(&swnode->kobj);
876 break;
877 case KOBJ_REMOVE:
878 sysfs_remove_link(&swnode->kobj, dev_name(dev));
879 sysfs_remove_link(&dev->kobj, "software_node");
880 kobject_put(&swnode->kobj);
881 break;
882 default:
883 break;
884 }
885
886 return 0;
887}
888
889static int __init software_node_init(void)
890{
891 swnode_kset = kset_create_and_add("software_nodes", NULL, kernel_kobj);
892 if (!swnode_kset)
893 return -ENOMEM;
894 return 0;
895}
896postcore_initcall(software_node_init);
897
898static void __exit software_node_exit(void)
899{
900 ida_destroy(&swnode_root_ids);
901 kset_unregister(swnode_kset);
902}
903__exitcall(software_node_exit);