Commit | Line | Data |
---|---|---|
59abd836 HK |
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 | ||
384f5a85 RW |
14 | #include "base.h" |
15 | ||
80488a6b | 16 | struct swnode { |
59abd836 HK |
17 | struct kobject kobj; |
18 | struct fwnode_handle fwnode; | |
80488a6b | 19 | const struct software_node *node; |
4a32e384 | 20 | int id; |
59abd836 HK |
21 | |
22 | /* hierarchy */ | |
23 | struct ida child_ids; | |
24 | struct list_head entry; | |
25 | struct list_head children; | |
80488a6b | 26 | struct swnode *parent; |
59abd836 | 27 | |
80488a6b | 28 | unsigned int allocated:1; |
151f6ff7 | 29 | unsigned int managed:1; |
59abd836 HK |
30 | }; |
31 | ||
32 | static DEFINE_IDA(swnode_root_ids); | |
33 | static struct kset *swnode_kset; | |
34 | ||
80488a6b | 35 | #define kobj_to_swnode(_kobj_) container_of(_kobj_, struct swnode, kobj) |
59abd836 HK |
36 | |
37 | static const struct fwnode_operations software_node_ops; | |
38 | ||
39 | bool is_software_node(const struct fwnode_handle *fwnode) | |
40 | { | |
41 | return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &software_node_ops; | |
42 | } | |
80488a6b | 43 | EXPORT_SYMBOL_GPL(is_software_node); |
59abd836 | 44 | |
80488a6b | 45 | #define to_swnode(__fwnode) \ |
59abd836 | 46 | ({ \ |
80488a6b | 47 | typeof(__fwnode) __to_swnode_fwnode = __fwnode; \ |
59abd836 | 48 | \ |
80488a6b HK |
49 | is_software_node(__to_swnode_fwnode) ? \ |
50 | container_of(__to_swnode_fwnode, \ | |
51 | struct swnode, fwnode) : NULL; \ | |
59abd836 HK |
52 | }) |
53 | ||
e68d0119 HK |
54 | static 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 | ||
80488a6b HK |
67 | static struct swnode * |
68 | software_node_to_swnode(const struct software_node *node) | |
69 | { | |
61636873 | 70 | struct swnode *swnode = NULL; |
80488a6b HK |
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 | ||
56c9aa07 | 90 | const struct software_node *to_software_node(const struct fwnode_handle *fwnode) |
80488a6b | 91 | { |
56c9aa07 | 92 | const struct swnode *swnode = to_swnode(fwnode); |
80488a6b HK |
93 | |
94 | return swnode ? swnode->node : NULL; | |
95 | } | |
96 | EXPORT_SYMBOL_GPL(to_software_node); | |
97 | ||
98 | struct 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 | } | |
104 | EXPORT_SYMBOL_GPL(software_node_fwnode); | |
105 | ||
59abd836 HK |
106 | /* -------------------------------------------------------------------------- */ |
107 | /* property_entry processing */ | |
108 | ||
109 | static const struct property_entry * | |
110 | property_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 | ||
122 | static const void *property_get_pointer(const struct property_entry *prop) | |
123 | { | |
1f74d70f | 124 | if (!prop->length) |
59abd836 | 125 | return NULL; |
1f74d70f | 126 | |
e6bff466 | 127 | return prop->is_inline ? &prop->value : prop->pointer; |
59abd836 HK |
128 | } |
129 | ||
130 | static 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 | ||
59abd836 HK |
147 | static int |
148 | property_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 | ||
160 | static 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 | { | |
5236f5fe DT |
165 | const void *pointer; |
166 | size_t length; | |
167 | ||
59abd836 HK |
168 | if (!val) |
169 | return property_entry_count_elems_of_size(props, name, | |
170 | elem_size); | |
59abd836 | 171 | |
5236f5fe DT |
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; | |
59abd836 HK |
183 | } |
184 | ||
185 | static int property_entry_read_string_array(const struct property_entry *props, | |
186 | const char *propname, | |
187 | const char **strings, size_t nval) | |
188 | { | |
59abd836 | 189 | const void *pointer; |
1afc1403 DT |
190 | size_t length; |
191 | int array_len; | |
59abd836 HK |
192 | |
193 | /* Find out the array length. */ | |
1afc1403 DT |
194 | array_len = property_entry_count_elems_of_size(props, propname, |
195 | sizeof(const char *)); | |
196 | if (array_len < 0) | |
197 | return array_len; | |
59abd836 HK |
198 | |
199 | /* Return how many there are if strings is NULL. */ | |
200 | if (!strings) | |
201 | return array_len; | |
202 | ||
1afc1403 | 203 | array_len = min_t(size_t, nval, array_len); |
59abd836 HK |
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 | ||
ed1cdf31 HK |
215 | static void property_entry_free_data(const struct property_entry *p) |
216 | { | |
1f74d70f | 217 | const char * const *src_str; |
ed1cdf31 HK |
218 | size_t i, nval; |
219 | ||
996b0830 DT |
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]); | |
ed1cdf31 | 225 | } |
996b0830 DT |
226 | |
227 | if (!p->is_inline) | |
228 | kfree(p->pointer); | |
229 | ||
ed1cdf31 HK |
230 | kfree(p->name); |
231 | } | |
232 | ||
996b0830 DT |
233 | static bool property_copy_string_array(const char **dst_ptr, |
234 | const char * const *src_ptr, | |
235 | size_t nval) | |
ed1cdf31 | 236 | { |
ed1cdf31 HK |
237 | int i; |
238 | ||
ed1cdf31 | 239 | for (i = 0; i < nval; i++) { |
996b0830 DT |
240 | dst_ptr[i] = kstrdup(src_ptr[i], GFP_KERNEL); |
241 | if (!dst_ptr[i] && src_ptr[i]) { | |
ed1cdf31 | 242 | while (--i >= 0) |
996b0830 DT |
243 | kfree(dst_ptr[i]); |
244 | return false; | |
ed1cdf31 HK |
245 | } |
246 | } | |
247 | ||
996b0830 | 248 | return true; |
ed1cdf31 HK |
249 | } |
250 | ||
251 | static int property_entry_copy_data(struct property_entry *dst, | |
252 | const struct property_entry *src) | |
253 | { | |
254 | const void *pointer = property_get_pointer(src); | |
996b0830 DT |
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 | ||
e64b674b DT |
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 | ||
996b0830 DT |
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) | |
ed1cdf31 | 278 | return -ENOMEM; |
996b0830 DT |
279 | dst->pointer = dst_ptr; |
280 | } | |
1f74d70f | 281 | |
996b0830 DT |
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 | } | |
ed1cdf31 | 289 | } else { |
996b0830 | 290 | memcpy(dst_ptr, pointer, src->length); |
ed1cdf31 HK |
291 | } |
292 | ||
293 | dst->length = src->length; | |
ed1cdf31 | 294 | dst->type = src->type; |
ed1cdf31 | 295 | dst->name = kstrdup(src->name, GFP_KERNEL); |
996b0830 DT |
296 | if (!dst->name) { |
297 | property_entry_free_data(dst); | |
298 | return -ENOMEM; | |
299 | } | |
ed1cdf31 HK |
300 | |
301 | return 0; | |
ed1cdf31 HK |
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 | */ | |
311 | struct property_entry * | |
312 | property_entries_dup(const struct property_entry *properties) | |
313 | { | |
314 | struct property_entry *p; | |
315 | int i, n = 0; | |
316 | int ret; | |
317 | ||
a7996986 HK |
318 | if (!properties) |
319 | return NULL; | |
320 | ||
ed1cdf31 HK |
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 | } | |
340 | EXPORT_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 | */ | |
349 | void 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 | } | |
361 | EXPORT_SYMBOL_GPL(property_entries_free); | |
362 | ||
59abd836 HK |
363 | /* -------------------------------------------------------------------------- */ |
364 | /* fwnode operations */ | |
365 | ||
366 | static struct fwnode_handle *software_node_get(struct fwnode_handle *fwnode) | |
367 | { | |
80488a6b | 368 | struct swnode *swnode = to_swnode(fwnode); |
59abd836 HK |
369 | |
370 | kobject_get(&swnode->kobj); | |
371 | ||
372 | return &swnode->fwnode; | |
373 | } | |
374 | ||
375 | static void software_node_put(struct fwnode_handle *fwnode) | |
376 | { | |
80488a6b | 377 | struct swnode *swnode = to_swnode(fwnode); |
59abd836 HK |
378 | |
379 | kobject_put(&swnode->kobj); | |
380 | } | |
381 | ||
382 | static bool software_node_property_present(const struct fwnode_handle *fwnode, | |
383 | const char *propname) | |
384 | { | |
80488a6b HK |
385 | struct swnode *swnode = to_swnode(fwnode); |
386 | ||
387 | return !!property_entry_get(swnode->node->properties, propname); | |
59abd836 HK |
388 | } |
389 | ||
390 | static 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 | { | |
80488a6b | 395 | struct swnode *swnode = to_swnode(fwnode); |
59abd836 | 396 | |
80488a6b | 397 | return property_entry_read_int_array(swnode->node->properties, propname, |
59abd836 HK |
398 | elem_size, val, nval); |
399 | } | |
400 | ||
401 | static int software_node_read_string_array(const struct fwnode_handle *fwnode, | |
402 | const char *propname, | |
403 | const char **val, size_t nval) | |
404 | { | |
80488a6b | 405 | struct swnode *swnode = to_swnode(fwnode); |
59abd836 | 406 | |
80488a6b HK |
407 | return property_entry_read_string_array(swnode->node->properties, |
408 | propname, val, nval); | |
59abd836 HK |
409 | } |
410 | ||
bc0500c1 SA |
411 | static const char * |
412 | software_node_get_name(const struct fwnode_handle *fwnode) | |
413 | { | |
414 | const struct swnode *swnode = to_swnode(fwnode); | |
415 | ||
bc0500c1 SA |
416 | return kobject_name(&swnode->kobj); |
417 | } | |
418 | ||
e7e242bc SA |
419 | static const char * |
420 | software_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 | ||
0e3edd94 | 440 | static struct fwnode_handle * |
59abd836 HK |
441 | software_node_get_parent(const struct fwnode_handle *fwnode) |
442 | { | |
80488a6b | 443 | struct swnode *swnode = to_swnode(fwnode); |
59abd836 | 444 | |
51c100a6 SA |
445 | if (!swnode || !swnode->parent) |
446 | return NULL; | |
447 | ||
448 | return fwnode_handle_get(&swnode->parent->fwnode); | |
59abd836 HK |
449 | } |
450 | ||
0e3edd94 | 451 | static struct fwnode_handle * |
59abd836 HK |
452 | software_node_get_next_child(const struct fwnode_handle *fwnode, |
453 | struct fwnode_handle *child) | |
454 | { | |
80488a6b HK |
455 | struct swnode *p = to_swnode(fwnode); |
456 | struct swnode *c = to_swnode(child); | |
59abd836 | 457 | |
1d8f062e | 458 | if (!p || list_empty(&p->children) || |
fb5ec981 DS |
459 | (c && list_is_last(&c->entry, &p->children))) { |
460 | fwnode_handle_put(child); | |
59abd836 | 461 | return NULL; |
fb5ec981 | 462 | } |
59abd836 HK |
463 | |
464 | if (c) | |
465 | c = list_next_entry(c, entry); | |
466 | else | |
80488a6b | 467 | c = list_first_entry(&p->children, struct swnode, entry); |
fb5ec981 DS |
468 | |
469 | fwnode_handle_put(child); | |
470 | return fwnode_handle_get(&c->fwnode); | |
59abd836 HK |
471 | } |
472 | ||
34479820 HK |
473 | static struct fwnode_handle * |
474 | software_node_get_named_child_node(const struct fwnode_handle *fwnode, | |
475 | const char *childname) | |
476 | { | |
80488a6b | 477 | struct swnode *swnode = to_swnode(fwnode); |
80488a6b | 478 | struct swnode *child; |
34479820 HK |
479 | |
480 | if (!swnode || list_empty(&swnode->children)) | |
481 | return NULL; | |
482 | ||
483 | list_for_each_entry(child, &swnode->children, entry) { | |
c959d0c2 | 484 | if (!strcmp(childname, kobject_name(&child->kobj))) { |
34479820 HK |
485 | kobject_get(&child->kobj); |
486 | return &child->fwnode; | |
487 | } | |
488 | } | |
489 | return NULL; | |
490 | } | |
59abd836 | 491 | |
b06184ac HK |
492 | static int |
493 | software_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); | |
e64b674b | 499 | const struct software_node_ref_args *ref_array; |
e933bedd | 500 | const struct software_node_ref_args *ref; |
b06184ac HK |
501 | const struct property_entry *prop; |
502 | struct fwnode_handle *refnode; | |
996b0830 DT |
503 | u32 nargs_prop_val; |
504 | int error; | |
b06184ac HK |
505 | int i; |
506 | ||
e64b674b | 507 | prop = property_entry_get(swnode->node->properties, propname); |
e933bedd DT |
508 | if (!prop) |
509 | return -ENOENT; | |
510 | ||
511 | if (prop->type != DEV_PROP_REF) | |
512 | return -EINVAL; | |
e64b674b | 513 | |
e933bedd DT |
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; | |
e64b674b | 520 | |
e933bedd DT |
521 | if (index * sizeof(*ref) >= prop->length) |
522 | return -ENOENT; | |
e64b674b | 523 | |
e933bedd DT |
524 | ref_array = prop->pointer; |
525 | ref = &ref_array[index]; | |
b06184ac | 526 | |
e933bedd | 527 | refnode = software_node_fwnode(ref->node); |
b06184ac HK |
528 | if (!refnode) |
529 | return -ENOENT; | |
530 | ||
531 | if (nargs_prop) { | |
c5fc5ba8 | 532 | error = property_entry_read_int_array(ref->node->properties, |
996b0830 DT |
533 | nargs_prop, sizeof(u32), |
534 | &nargs_prop_val, 1); | |
535 | if (error) | |
536 | return error; | |
b06184ac | 537 | |
996b0830 | 538 | nargs = nargs_prop_val; |
b06184ac HK |
539 | } |
540 | ||
541 | if (nargs > NR_FWNODE_REFERENCE_ARGS) | |
542 | return -EINVAL; | |
543 | ||
544 | args->fwnode = software_node_get(refnode); | |
545 | args->nargs = nargs; | |
546 | ||
547 | for (i = 0; i < nargs; i++) | |
e933bedd | 548 | args->args[i] = ref->args[i]; |
b06184ac HK |
549 | |
550 | return 0; | |
551 | } | |
552 | ||
000c08fd HK |
553 | static struct fwnode_handle * |
554 | swnode_graph_find_next_port(const struct fwnode_handle *parent, | |
555 | struct fwnode_handle *port) | |
556 | { | |
557 | struct fwnode_handle *old = port; | |
558 | ||
559 | while ((port = software_node_get_next_child(parent, old))) { | |
560 | /* | |
561 | * fwnode ports have naming style "port@", so we search for any | |
562 | * children that follow that convention. | |
563 | */ | |
564 | if (!strncmp(to_swnode(port)->node->name, "port@", | |
565 | strlen("port@"))) | |
566 | return port; | |
567 | old = port; | |
568 | } | |
569 | ||
570 | return NULL; | |
571 | } | |
572 | ||
573 | static struct fwnode_handle * | |
574 | software_node_graph_get_next_endpoint(const struct fwnode_handle *fwnode, | |
575 | struct fwnode_handle *endpoint) | |
576 | { | |
577 | struct swnode *swnode = to_swnode(fwnode); | |
578 | struct fwnode_handle *parent; | |
579 | struct fwnode_handle *port; | |
580 | ||
581 | if (!swnode) | |
582 | return NULL; | |
583 | ||
584 | if (endpoint) { | |
585 | port = software_node_get_parent(endpoint); | |
586 | parent = software_node_get_parent(port); | |
587 | } else { | |
588 | parent = software_node_get_named_child_node(fwnode, "ports"); | |
589 | if (!parent) | |
590 | parent = software_node_get(&swnode->fwnode); | |
591 | ||
592 | port = swnode_graph_find_next_port(parent, NULL); | |
593 | } | |
594 | ||
595 | for (; port; port = swnode_graph_find_next_port(parent, port)) { | |
596 | endpoint = software_node_get_next_child(port, endpoint); | |
597 | if (endpoint) { | |
598 | fwnode_handle_put(port); | |
599 | break; | |
600 | } | |
601 | } | |
602 | ||
603 | fwnode_handle_put(parent); | |
604 | ||
605 | return endpoint; | |
606 | } | |
607 | ||
608 | static struct fwnode_handle * | |
609 | software_node_graph_get_remote_endpoint(const struct fwnode_handle *fwnode) | |
610 | { | |
611 | struct swnode *swnode = to_swnode(fwnode); | |
612 | const struct software_node_ref_args *ref; | |
613 | const struct property_entry *prop; | |
614 | ||
615 | if (!swnode) | |
616 | return NULL; | |
617 | ||
618 | prop = property_entry_get(swnode->node->properties, "remote-endpoint"); | |
619 | if (!prop || prop->type != DEV_PROP_REF || prop->is_inline) | |
620 | return NULL; | |
621 | ||
622 | ref = prop->pointer; | |
623 | ||
624 | return software_node_get(software_node_fwnode(ref[0].node)); | |
625 | } | |
626 | ||
627 | static struct fwnode_handle * | |
628 | software_node_graph_get_port_parent(struct fwnode_handle *fwnode) | |
629 | { | |
630 | struct swnode *swnode = to_swnode(fwnode); | |
631 | ||
632 | swnode = swnode->parent; | |
633 | if (swnode && !strcmp(swnode->node->name, "ports")) | |
634 | swnode = swnode->parent; | |
635 | ||
636 | return swnode ? software_node_get(&swnode->fwnode) : NULL; | |
637 | } | |
638 | ||
639 | static int | |
640 | software_node_graph_parse_endpoint(const struct fwnode_handle *fwnode, | |
641 | struct fwnode_endpoint *endpoint) | |
642 | { | |
643 | struct swnode *swnode = to_swnode(fwnode); | |
644 | const char *parent_name = swnode->parent->node->name; | |
645 | int ret; | |
646 | ||
647 | if (strlen("port@") >= strlen(parent_name) || | |
648 | strncmp(parent_name, "port@", strlen("port@"))) | |
649 | return -EINVAL; | |
650 | ||
651 | /* Ports have naming style "port@n", we need to select the n */ | |
652 | ret = kstrtou32(parent_name + strlen("port@"), 10, &endpoint->port); | |
653 | if (ret) | |
654 | return ret; | |
655 | ||
656 | endpoint->id = swnode->id; | |
657 | endpoint->local_fwnode = fwnode; | |
658 | ||
659 | return 0; | |
660 | } | |
661 | ||
59abd836 HK |
662 | static const struct fwnode_operations software_node_ops = { |
663 | .get = software_node_get, | |
664 | .put = software_node_put, | |
665 | .property_present = software_node_property_present, | |
666 | .property_read_int_array = software_node_read_int_array, | |
667 | .property_read_string_array = software_node_read_string_array, | |
bc0500c1 | 668 | .get_name = software_node_get_name, |
e7e242bc | 669 | .get_name_prefix = software_node_get_name_prefix, |
59abd836 HK |
670 | .get_parent = software_node_get_parent, |
671 | .get_next_child_node = software_node_get_next_child, | |
34479820 | 672 | .get_named_child_node = software_node_get_named_child_node, |
000c08fd HK |
673 | .get_reference_args = software_node_get_reference_args, |
674 | .graph_get_next_endpoint = software_node_graph_get_next_endpoint, | |
675 | .graph_get_remote_endpoint = software_node_graph_get_remote_endpoint, | |
676 | .graph_get_port_parent = software_node_graph_get_port_parent, | |
677 | .graph_parse_endpoint = software_node_graph_parse_endpoint, | |
59abd836 HK |
678 | }; |
679 | ||
680 | /* -------------------------------------------------------------------------- */ | |
681 | ||
1666faed HK |
682 | /** |
683 | * software_node_find_by_name - Find software node by name | |
684 | * @parent: Parent of the software node | |
685 | * @name: Name of the software node | |
686 | * | |
687 | * The function will find a node that is child of @parent and that is named | |
688 | * @name. If no node is found, the function returns NULL. | |
689 | * | |
690 | * NOTE: you will need to drop the reference with fwnode_handle_put() after use. | |
691 | */ | |
692 | const struct software_node * | |
693 | software_node_find_by_name(const struct software_node *parent, const char *name) | |
694 | { | |
016049a8 | 695 | struct swnode *swnode = NULL; |
1666faed HK |
696 | struct kobject *k; |
697 | ||
698 | if (!name) | |
699 | return NULL; | |
700 | ||
701 | spin_lock(&swnode_kset->list_lock); | |
702 | ||
703 | list_for_each_entry(k, &swnode_kset->list, entry) { | |
704 | swnode = kobj_to_swnode(k); | |
705 | if (parent == swnode->node->parent && swnode->node->name && | |
706 | !strcmp(name, swnode->node->name)) { | |
707 | kobject_get(&swnode->kobj); | |
708 | break; | |
709 | } | |
710 | swnode = NULL; | |
711 | } | |
712 | ||
713 | spin_unlock(&swnode_kset->list_lock); | |
714 | ||
715 | return swnode ? swnode->node : NULL; | |
716 | } | |
717 | EXPORT_SYMBOL_GPL(software_node_find_by_name); | |
718 | ||
06ad93c3 | 719 | static struct software_node *software_node_alloc(const struct property_entry *properties) |
59abd836 HK |
720 | { |
721 | struct property_entry *props; | |
06ad93c3 | 722 | struct software_node *node; |
59abd836 HK |
723 | |
724 | props = property_entries_dup(properties); | |
725 | if (IS_ERR(props)) | |
06ad93c3 AS |
726 | return ERR_CAST(props); |
727 | ||
728 | node = kzalloc(sizeof(*node), GFP_KERNEL); | |
729 | if (!node) { | |
730 | property_entries_free(props); | |
731 | return ERR_PTR(-ENOMEM); | |
732 | } | |
59abd836 | 733 | |
80488a6b | 734 | node->properties = props; |
59abd836 | 735 | |
06ad93c3 AS |
736 | return node; |
737 | } | |
738 | ||
739 | static void software_node_free(const struct software_node *node) | |
740 | { | |
741 | property_entries_free(node->properties); | |
742 | kfree(node); | |
59abd836 HK |
743 | } |
744 | ||
745 | static void software_node_release(struct kobject *kobj) | |
746 | { | |
80488a6b | 747 | struct swnode *swnode = kobj_to_swnode(kobj); |
59abd836 | 748 | |
7589238a BH |
749 | if (swnode->parent) { |
750 | ida_simple_remove(&swnode->parent->child_ids, swnode->id); | |
751 | list_del(&swnode->entry); | |
752 | } else { | |
753 | ida_simple_remove(&swnode_root_ids, swnode->id); | |
754 | } | |
755 | ||
06ad93c3 AS |
756 | if (swnode->allocated) |
757 | software_node_free(swnode->node); | |
758 | ||
59abd836 | 759 | ida_destroy(&swnode->child_ids); |
59abd836 HK |
760 | kfree(swnode); |
761 | } | |
762 | ||
c83d9ab4 | 763 | static const struct kobj_type software_node_type = { |
59abd836 HK |
764 | .release = software_node_release, |
765 | .sysfs_ops = &kobj_sysfs_ops, | |
766 | }; | |
767 | ||
80488a6b HK |
768 | static struct fwnode_handle * |
769 | swnode_register(const struct software_node *node, struct swnode *parent, | |
770 | unsigned int allocated) | |
59abd836 | 771 | { |
80488a6b | 772 | struct swnode *swnode; |
59abd836 HK |
773 | int ret; |
774 | ||
59abd836 | 775 | swnode = kzalloc(sizeof(*swnode), GFP_KERNEL); |
3f6b6536 AS |
776 | if (!swnode) |
777 | return ERR_PTR(-ENOMEM); | |
59abd836 | 778 | |
80488a6b HK |
779 | ret = ida_simple_get(parent ? &parent->child_ids : &swnode_root_ids, |
780 | 0, 0, GFP_KERNEL); | |
59abd836 HK |
781 | if (ret < 0) { |
782 | kfree(swnode); | |
3f6b6536 | 783 | return ERR_PTR(ret); |
59abd836 HK |
784 | } |
785 | ||
786 | swnode->id = ret; | |
80488a6b HK |
787 | swnode->node = node; |
788 | swnode->parent = parent; | |
59abd836 | 789 | swnode->kobj.kset = swnode_kset; |
01bb86b3 | 790 | fwnode_init(&swnode->fwnode, &software_node_ops); |
59abd836 HK |
791 | |
792 | ida_init(&swnode->child_ids); | |
793 | INIT_LIST_HEAD(&swnode->entry); | |
794 | INIT_LIST_HEAD(&swnode->children); | |
59abd836 | 795 | |
80488a6b HK |
796 | if (node->name) |
797 | ret = kobject_init_and_add(&swnode->kobj, &software_node_type, | |
798 | parent ? &parent->kobj : NULL, | |
799 | "%s", node->name); | |
800 | else | |
801 | ret = kobject_init_and_add(&swnode->kobj, &software_node_type, | |
802 | parent ? &parent->kobj : NULL, | |
803 | "node%d", swnode->id); | |
59abd836 HK |
804 | if (ret) { |
805 | kobject_put(&swnode->kobj); | |
806 | return ERR_PTR(ret); | |
807 | } | |
808 | ||
3f6b6536 AS |
809 | /* |
810 | * Assign the flag only in the successful case, so | |
811 | * the above kobject_put() won't mess up with properties. | |
812 | */ | |
813 | swnode->allocated = allocated; | |
814 | ||
80488a6b HK |
815 | if (parent) |
816 | list_add_tail(&swnode->entry, &parent->children); | |
817 | ||
818 | kobject_uevent(&swnode->kobj, KOBJ_ADD); | |
819 | return &swnode->fwnode; | |
80488a6b HK |
820 | } |
821 | ||
02094d54 AS |
822 | /** |
823 | * software_node_register_node_group - Register a group of software nodes | |
824 | * @node_group: NULL terminated array of software node pointers to be registered | |
825 | * | |
0b8bf06f AS |
826 | * Register multiple software nodes at once. If any node in the array |
827 | * has its .parent pointer set (which can only be to another software_node), | |
828 | * then its parent **must** have been registered before it is; either outside | |
829 | * of this function or by ordering the array such that parent comes before | |
830 | * child. | |
02094d54 AS |
831 | */ |
832 | int software_node_register_node_group(const struct software_node **node_group) | |
833 | { | |
834 | unsigned int i; | |
835 | int ret; | |
836 | ||
837 | if (!node_group) | |
838 | return 0; | |
839 | ||
840 | for (i = 0; node_group[i]; i++) { | |
841 | ret = software_node_register(node_group[i]); | |
842 | if (ret) { | |
843 | software_node_unregister_node_group(node_group); | |
844 | return ret; | |
845 | } | |
846 | } | |
847 | ||
848 | return 0; | |
849 | } | |
850 | EXPORT_SYMBOL_GPL(software_node_register_node_group); | |
851 | ||
852 | /** | |
853 | * software_node_unregister_node_group - Unregister a group of software nodes | |
854 | * @node_group: NULL terminated array of software node pointers to be unregistered | |
855 | * | |
0b8bf06f AS |
856 | * Unregister multiple software nodes at once. If parent pointers are set up |
857 | * in any of the software nodes then the array **must** be ordered such that | |
858 | * parents come before their children. | |
859 | * | |
860 | * NOTE: If you are uncertain whether the array is ordered such that | |
861 | * parents will be unregistered before their children, it is wiser to | |
862 | * remove the nodes individually, in the correct order (child before | |
863 | * parent). | |
02094d54 | 864 | */ |
fc002f0f DS |
865 | void software_node_unregister_node_group( |
866 | const struct software_node **node_group) | |
02094d54 | 867 | { |
fc002f0f | 868 | unsigned int i = 0; |
02094d54 AS |
869 | |
870 | if (!node_group) | |
871 | return; | |
872 | ||
fc002f0f DS |
873 | while (node_group[i]) |
874 | i++; | |
875 | ||
876 | while (i--) | |
9dcbac84 | 877 | software_node_unregister(node_group[i]); |
02094d54 AS |
878 | } |
879 | EXPORT_SYMBOL_GPL(software_node_unregister_node_group); | |
880 | ||
80488a6b HK |
881 | /** |
882 | * software_node_register - Register static software node | |
883 | * @node: The software node to be registered | |
884 | */ | |
885 | int software_node_register(const struct software_node *node) | |
886 | { | |
887 | struct swnode *parent = software_node_to_swnode(node->parent); | |
888 | ||
889 | if (software_node_to_swnode(node)) | |
890 | return -EEXIST; | |
891 | ||
8891123f HK |
892 | if (node->parent && !parent) |
893 | return -EINVAL; | |
894 | ||
80488a6b HK |
895 | return PTR_ERR_OR_ZERO(swnode_register(node, parent, 0)); |
896 | } | |
897 | EXPORT_SYMBOL_GPL(software_node_register); | |
898 | ||
46d26819 GKH |
899 | /** |
900 | * software_node_unregister - Unregister static software node | |
901 | * @node: The software node to be unregistered | |
902 | */ | |
903 | void software_node_unregister(const struct software_node *node) | |
904 | { | |
905 | struct swnode *swnode; | |
906 | ||
907 | swnode = software_node_to_swnode(node); | |
908 | if (swnode) | |
909 | fwnode_remove_software_node(&swnode->fwnode); | |
910 | } | |
911 | EXPORT_SYMBOL_GPL(software_node_unregister); | |
912 | ||
80488a6b HK |
913 | struct fwnode_handle * |
914 | fwnode_create_software_node(const struct property_entry *properties, | |
915 | const struct fwnode_handle *parent) | |
916 | { | |
3f6b6536 | 917 | struct fwnode_handle *fwnode; |
80488a6b | 918 | struct software_node *node; |
73c93426 AS |
919 | struct swnode *p; |
920 | ||
921 | if (IS_ERR(parent)) | |
922 | return ERR_CAST(parent); | |
923 | ||
924 | p = to_swnode(parent); | |
925 | if (parent && !p) | |
926 | return ERR_PTR(-EINVAL); | |
80488a6b | 927 | |
06ad93c3 AS |
928 | node = software_node_alloc(properties); |
929 | if (IS_ERR(node)) | |
930 | return ERR_CAST(node); | |
59abd836 | 931 | |
80488a6b | 932 | node->parent = p ? p->node : NULL; |
3df85a1a | 933 | |
3f6b6536 | 934 | fwnode = swnode_register(node, p, 1); |
06ad93c3 AS |
935 | if (IS_ERR(fwnode)) |
936 | software_node_free(node); | |
3f6b6536 AS |
937 | |
938 | return fwnode; | |
59abd836 HK |
939 | } |
940 | EXPORT_SYMBOL_GPL(fwnode_create_software_node); | |
941 | ||
942 | void fwnode_remove_software_node(struct fwnode_handle *fwnode) | |
943 | { | |
80488a6b | 944 | struct swnode *swnode = to_swnode(fwnode); |
59abd836 HK |
945 | |
946 | if (!swnode) | |
947 | return; | |
948 | ||
949 | kobject_put(&swnode->kobj); | |
950 | } | |
951 | EXPORT_SYMBOL_GPL(fwnode_remove_software_node); | |
952 | ||
e68d0119 HK |
953 | /** |
954 | * device_add_software_node - Assign software node to a device | |
955 | * @dev: The device the software node is meant for. | |
2a92c90f | 956 | * @node: The software node. |
e68d0119 | 957 | * |
2a92c90f HK |
958 | * This function will make @node the secondary firmware node pointer of @dev. If |
959 | * @dev has no primary node, then @node will become the primary node. The | |
960 | * function will register @node automatically if it wasn't already registered. | |
e68d0119 | 961 | */ |
2a92c90f | 962 | int device_add_software_node(struct device *dev, const struct software_node *node) |
e68d0119 | 963 | { |
2a92c90f | 964 | struct swnode *swnode; |
e68d0119 HK |
965 | int ret; |
966 | ||
967 | /* Only one software node per device. */ | |
968 | if (dev_to_swnode(dev)) | |
969 | return -EBUSY; | |
970 | ||
2a92c90f HK |
971 | swnode = software_node_to_swnode(node); |
972 | if (swnode) { | |
973 | kobject_get(&swnode->kobj); | |
974 | } else { | |
975 | ret = software_node_register(node); | |
976 | if (ret) | |
977 | return ret; | |
978 | ||
979 | swnode = software_node_to_swnode(node); | |
980 | } | |
e68d0119 | 981 | |
2a92c90f | 982 | set_secondary_fwnode(dev, &swnode->fwnode); |
5dca69e2 HK |
983 | |
984 | /* | |
985 | * If the device has been fully registered by the time this function is | |
986 | * called, software_node_notify() must be called separately so that the | |
987 | * symlinks get created and the reference count of the node is kept in | |
988 | * balance. | |
989 | */ | |
990 | if (device_is_registered(dev)) | |
384f5a85 | 991 | software_node_notify(dev); |
e68d0119 HK |
992 | |
993 | return 0; | |
994 | } | |
995 | EXPORT_SYMBOL_GPL(device_add_software_node); | |
996 | ||
997 | /** | |
998 | * device_remove_software_node - Remove device's software node | |
999 | * @dev: The device with the software node. | |
1000 | * | |
1001 | * This function will unregister the software node of @dev. | |
1002 | */ | |
1003 | void device_remove_software_node(struct device *dev) | |
1004 | { | |
1005 | struct swnode *swnode; | |
1006 | ||
1007 | swnode = dev_to_swnode(dev); | |
1008 | if (!swnode) | |
1009 | return; | |
1010 | ||
5dca69e2 | 1011 | if (device_is_registered(dev)) |
384f5a85 RW |
1012 | software_node_notify_remove(dev); |
1013 | ||
e68d0119 HK |
1014 | set_secondary_fwnode(dev, NULL); |
1015 | kobject_put(&swnode->kobj); | |
1016 | } | |
1017 | EXPORT_SYMBOL_GPL(device_remove_software_node); | |
1018 | ||
151f6ff7 HK |
1019 | /** |
1020 | * device_create_managed_software_node - Create a software node for a device | |
1021 | * @dev: The device the software node is assigned to. | |
1022 | * @properties: Device properties for the software node. | |
1023 | * @parent: Parent of the software node. | |
1024 | * | |
1025 | * Creates a software node as a managed resource for @dev, which means the | |
1026 | * lifetime of the newly created software node is tied to the lifetime of @dev. | |
1027 | * Software nodes created with this function should not be reused or shared | |
1028 | * because of that. The function takes a deep copy of @properties for the | |
1029 | * software node. | |
1030 | * | |
1031 | * Since the new software node is assigned directly to @dev, and since it should | |
1032 | * not be shared, it is not returned to the caller. The function returns 0 on | |
1033 | * success, and errno in case of an error. | |
1034 | */ | |
1035 | int device_create_managed_software_node(struct device *dev, | |
1036 | const struct property_entry *properties, | |
1037 | const struct software_node *parent) | |
1038 | { | |
1039 | struct fwnode_handle *p = software_node_fwnode(parent); | |
1040 | struct fwnode_handle *fwnode; | |
1041 | ||
1042 | if (parent && !p) | |
1043 | return -EINVAL; | |
1044 | ||
1045 | fwnode = fwnode_create_software_node(properties, p); | |
1046 | if (IS_ERR(fwnode)) | |
1047 | return PTR_ERR(fwnode); | |
1048 | ||
1049 | to_swnode(fwnode)->managed = true; | |
1050 | set_secondary_fwnode(dev, fwnode); | |
1051 | ||
5aeb05b2 LT |
1052 | if (device_is_registered(dev)) |
1053 | software_node_notify(dev); | |
1054 | ||
151f6ff7 HK |
1055 | return 0; |
1056 | } | |
1057 | EXPORT_SYMBOL_GPL(device_create_managed_software_node); | |
1058 | ||
384f5a85 | 1059 | void software_node_notify(struct device *dev) |
59abd836 | 1060 | { |
80488a6b | 1061 | struct swnode *swnode; |
59abd836 HK |
1062 | int ret; |
1063 | ||
e68d0119 HK |
1064 | swnode = dev_to_swnode(dev); |
1065 | if (!swnode) | |
384f5a85 | 1066 | return; |
59abd836 | 1067 | |
384f5a85 RW |
1068 | ret = sysfs_create_link(&dev->kobj, &swnode->kobj, "software_node"); |
1069 | if (ret) | |
1070 | return; | |
59abd836 | 1071 | |
384f5a85 RW |
1072 | ret = sysfs_create_link(&swnode->kobj, &dev->kobj, dev_name(dev)); |
1073 | if (ret) { | |
59abd836 | 1074 | sysfs_remove_link(&dev->kobj, "software_node"); |
384f5a85 | 1075 | return; |
59abd836 HK |
1076 | } |
1077 | ||
384f5a85 RW |
1078 | kobject_get(&swnode->kobj); |
1079 | } | |
1080 | ||
1081 | void software_node_notify_remove(struct device *dev) | |
1082 | { | |
1083 | struct swnode *swnode; | |
1084 | ||
1085 | swnode = dev_to_swnode(dev); | |
1086 | if (!swnode) | |
1087 | return; | |
1088 | ||
1089 | sysfs_remove_link(&swnode->kobj, dev_name(dev)); | |
1090 | sysfs_remove_link(&dev->kobj, "software_node"); | |
1091 | kobject_put(&swnode->kobj); | |
1092 | ||
1093 | if (swnode->managed) { | |
1094 | set_secondary_fwnode(dev, NULL); | |
1095 | kobject_put(&swnode->kobj); | |
1096 | } | |
59abd836 HK |
1097 | } |
1098 | ||
1099 | static int __init software_node_init(void) | |
1100 | { | |
1101 | swnode_kset = kset_create_and_add("software_nodes", NULL, kernel_kobj); | |
1102 | if (!swnode_kset) | |
1103 | return -ENOMEM; | |
1104 | return 0; | |
1105 | } | |
1106 | postcore_initcall(software_node_init); | |
1107 | ||
1108 | static void __exit software_node_exit(void) | |
1109 | { | |
1110 | ida_destroy(&swnode_root_ids); | |
1111 | kset_unregister(swnode_kset); | |
1112 | } | |
1113 | __exitcall(software_node_exit); |