1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * GPIO testing driver based on configfs.
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/bitmap.h>
11 #include <linux/cleanup.h>
12 #include <linux/completion.h>
13 #include <linux/configfs.h>
14 #include <linux/device.h>
15 #include <linux/gpio/driver.h>
16 #include <linux/gpio/machine.h>
17 #include <linux/idr.h>
18 #include <linux/interrupt.h>
19 #include <linux/irq.h>
20 #include <linux/irq_sim.h>
21 #include <linux/list.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/module.h>
24 #include <linux/mutex.h>
25 #include <linux/notifier.h>
26 #include <linux/platform_device.h>
27 #include <linux/property.h>
28 #include <linux/slab.h>
29 #include <linux/string.h>
30 #include <linux/string_helpers.h>
31 #include <linux/sysfs.h>
35 #define GPIO_SIM_NGPIO_MAX 1024
36 #define GPIO_SIM_PROP_MAX 4 /* Max 3 properties + sentinel. */
37 #define GPIO_SIM_NUM_ATTRS 3 /* value, pull and sentinel */
39 static DEFINE_IDA(gpio_sim_ida);
41 struct gpio_sim_chip {
43 unsigned long *direction_map;
44 unsigned long *value_map;
45 unsigned long *pull_map;
46 struct irq_domain *irq_sim;
48 const struct attribute_group **attr_groups;
51 struct gpio_sim_attribute {
52 struct device_attribute dev_attr;
56 static struct gpio_sim_attribute *
57 to_gpio_sim_attr(struct device_attribute *dev_attr)
59 return container_of(dev_attr, struct gpio_sim_attribute, dev_attr);
62 static int gpio_sim_apply_pull(struct gpio_sim_chip *chip,
63 unsigned int offset, int value)
65 int irq, irq_type, ret;
66 struct gpio_desc *desc;
70 desc = &gc->gpiodev->descs[offset];
72 guard(mutex)(&chip->lock);
74 if (test_bit(FLAG_REQUESTED, &desc->flags) &&
75 !test_bit(FLAG_IS_OUT, &desc->flags)) {
76 if (value == !!test_bit(offset, chip->value_map))
80 * This is fine - it just means, nobody is listening
81 * for interrupts on this line, otherwise
82 * irq_create_mapping() would have been called from
83 * the to_irq() callback.
85 irq = irq_find_mapping(chip->irq_sim, offset);
89 irq_type = irq_get_trigger_type(irq);
91 if ((value && (irq_type & IRQ_TYPE_EDGE_RISING)) ||
92 (!value && (irq_type & IRQ_TYPE_EDGE_FALLING))) {
93 ret = irq_set_irqchip_state(irq, IRQCHIP_STATE_PENDING,
101 /* Change the value unless we're actively driving the line. */
102 if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
103 !test_bit(FLAG_IS_OUT, &desc->flags))
104 __assign_bit(offset, chip->value_map, value);
107 __assign_bit(offset, chip->pull_map, value);
111 static int gpio_sim_get(struct gpio_chip *gc, unsigned int offset)
113 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
115 guard(mutex)(&chip->lock);
117 return !!test_bit(offset, chip->value_map);
120 static void gpio_sim_set(struct gpio_chip *gc, unsigned int offset, int value)
122 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
124 scoped_guard(mutex, &chip->lock)
125 __assign_bit(offset, chip->value_map, value);
128 static int gpio_sim_get_multiple(struct gpio_chip *gc,
129 unsigned long *mask, unsigned long *bits)
131 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
133 scoped_guard(mutex, &chip->lock)
134 bitmap_replace(bits, bits, chip->value_map, mask, gc->ngpio);
139 static void gpio_sim_set_multiple(struct gpio_chip *gc,
140 unsigned long *mask, unsigned long *bits)
142 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
144 scoped_guard(mutex, &chip->lock)
145 bitmap_replace(chip->value_map, chip->value_map, bits, mask,
149 static int gpio_sim_direction_output(struct gpio_chip *gc,
150 unsigned int offset, int value)
152 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
154 scoped_guard(mutex, &chip->lock) {
155 __clear_bit(offset, chip->direction_map);
156 __assign_bit(offset, chip->value_map, value);
162 static int gpio_sim_direction_input(struct gpio_chip *gc, unsigned int offset)
164 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
166 scoped_guard(mutex, &chip->lock)
167 __set_bit(offset, chip->direction_map);
172 static int gpio_sim_get_direction(struct gpio_chip *gc, unsigned int offset)
174 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
177 scoped_guard(mutex, &chip->lock)
178 direction = !!test_bit(offset, chip->direction_map);
180 return direction ? GPIO_LINE_DIRECTION_IN : GPIO_LINE_DIRECTION_OUT;
183 static int gpio_sim_set_config(struct gpio_chip *gc,
184 unsigned int offset, unsigned long config)
186 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
188 switch (pinconf_to_config_param(config)) {
189 case PIN_CONFIG_BIAS_PULL_UP:
190 return gpio_sim_apply_pull(chip, offset, 1);
191 case PIN_CONFIG_BIAS_PULL_DOWN:
192 return gpio_sim_apply_pull(chip, offset, 0);
200 static int gpio_sim_to_irq(struct gpio_chip *gc, unsigned int offset)
202 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
204 return irq_create_mapping(chip->irq_sim, offset);
207 static void gpio_sim_free(struct gpio_chip *gc, unsigned int offset)
209 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
211 scoped_guard(mutex, &chip->lock)
212 __assign_bit(offset, chip->value_map,
213 !!test_bit(offset, chip->pull_map));
216 static ssize_t gpio_sim_sysfs_val_show(struct device *dev,
217 struct device_attribute *attr, char *buf)
219 struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr);
220 struct gpio_sim_chip *chip = dev_get_drvdata(dev);
223 scoped_guard(mutex, &chip->lock)
224 val = !!test_bit(line_attr->offset, chip->value_map);
226 return sysfs_emit(buf, "%d\n", val);
229 static ssize_t gpio_sim_sysfs_val_store(struct device *dev,
230 struct device_attribute *attr,
231 const char *buf, size_t count)
234 * Not assigning this function will result in write() returning -EIO
235 * which is confusing. Return -EPERM explicitly.
240 static const char *const gpio_sim_sysfs_pull_strings[] = {
245 static ssize_t gpio_sim_sysfs_pull_show(struct device *dev,
246 struct device_attribute *attr,
249 struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr);
250 struct gpio_sim_chip *chip = dev_get_drvdata(dev);
253 scoped_guard(mutex, &chip->lock)
254 pull = !!test_bit(line_attr->offset, chip->pull_map);
256 return sysfs_emit(buf, "%s\n", gpio_sim_sysfs_pull_strings[pull]);
259 static ssize_t gpio_sim_sysfs_pull_store(struct device *dev,
260 struct device_attribute *attr,
261 const char *buf, size_t len)
263 struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr);
264 struct gpio_sim_chip *chip = dev_get_drvdata(dev);
267 pull = sysfs_match_string(gpio_sim_sysfs_pull_strings, buf);
271 ret = gpio_sim_apply_pull(chip, line_attr->offset, pull);
278 static void gpio_sim_mutex_destroy(void *data)
280 struct mutex *lock = data;
285 static void gpio_sim_dispose_mappings(void *data)
287 struct gpio_sim_chip *chip = data;
290 for (i = 0; i < chip->gc.ngpio; i++)
291 irq_dispose_mapping(irq_find_mapping(chip->irq_sim, i));
294 static void gpio_sim_sysfs_remove(void *data)
296 struct gpio_sim_chip *chip = data;
298 sysfs_remove_groups(&chip->gc.gpiodev->dev.kobj, chip->attr_groups);
301 static int gpio_sim_setup_sysfs(struct gpio_sim_chip *chip)
303 struct device_attribute *val_dev_attr, *pull_dev_attr;
304 struct gpio_sim_attribute *val_attr, *pull_attr;
305 unsigned int num_lines = chip->gc.ngpio;
306 struct device *dev = chip->gc.parent;
307 struct attribute_group *attr_group;
308 struct attribute **attrs;
311 chip->attr_groups = devm_kcalloc(dev, sizeof(*chip->attr_groups),
312 num_lines + 1, GFP_KERNEL);
313 if (!chip->attr_groups)
316 for (i = 0; i < num_lines; i++) {
317 attr_group = devm_kzalloc(dev, sizeof(*attr_group), GFP_KERNEL);
318 attrs = devm_kcalloc(dev, GPIO_SIM_NUM_ATTRS, sizeof(*attrs),
320 val_attr = devm_kzalloc(dev, sizeof(*val_attr), GFP_KERNEL);
321 pull_attr = devm_kzalloc(dev, sizeof(*pull_attr), GFP_KERNEL);
322 if (!attr_group || !attrs || !val_attr || !pull_attr)
325 attr_group->name = devm_kasprintf(dev, GFP_KERNEL,
327 if (!attr_group->name)
330 val_attr->offset = pull_attr->offset = i;
332 val_dev_attr = &val_attr->dev_attr;
333 pull_dev_attr = &pull_attr->dev_attr;
335 sysfs_attr_init(&val_dev_attr->attr);
336 sysfs_attr_init(&pull_dev_attr->attr);
338 val_dev_attr->attr.name = "value";
339 pull_dev_attr->attr.name = "pull";
341 val_dev_attr->attr.mode = pull_dev_attr->attr.mode = 0644;
343 val_dev_attr->show = gpio_sim_sysfs_val_show;
344 val_dev_attr->store = gpio_sim_sysfs_val_store;
345 pull_dev_attr->show = gpio_sim_sysfs_pull_show;
346 pull_dev_attr->store = gpio_sim_sysfs_pull_store;
348 attrs[0] = &val_dev_attr->attr;
349 attrs[1] = &pull_dev_attr->attr;
351 attr_group->attrs = attrs;
352 chip->attr_groups[i] = attr_group;
355 ret = sysfs_create_groups(&chip->gc.gpiodev->dev.kobj,
360 return devm_add_action_or_reset(dev, gpio_sim_sysfs_remove, chip);
363 static int gpio_sim_add_bank(struct fwnode_handle *swnode, struct device *dev)
365 struct gpio_sim_chip *chip;
366 struct gpio_chip *gc;
371 ret = fwnode_property_read_u32(swnode, "ngpios", &num_lines);
375 if (num_lines > GPIO_SIM_NGPIO_MAX)
378 ret = fwnode_property_read_string(swnode, "gpio-sim,label", &label);
380 label = devm_kasprintf(dev, GFP_KERNEL, "%s-%pfwP",
381 dev_name(dev), swnode);
386 chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
390 chip->direction_map = devm_bitmap_alloc(dev, num_lines, GFP_KERNEL);
391 if (!chip->direction_map)
394 /* Default to input mode. */
395 bitmap_fill(chip->direction_map, num_lines);
397 chip->value_map = devm_bitmap_zalloc(dev, num_lines, GFP_KERNEL);
398 if (!chip->value_map)
401 chip->pull_map = devm_bitmap_zalloc(dev, num_lines, GFP_KERNEL);
405 chip->irq_sim = devm_irq_domain_create_sim(dev, swnode, num_lines);
406 if (IS_ERR(chip->irq_sim))
407 return PTR_ERR(chip->irq_sim);
409 ret = devm_add_action_or_reset(dev, gpio_sim_dispose_mappings, chip);
413 mutex_init(&chip->lock);
414 ret = devm_add_action_or_reset(dev, gpio_sim_mutex_destroy,
421 gc->ngpio = num_lines;
423 gc->owner = THIS_MODULE;
426 gc->get = gpio_sim_get;
427 gc->set = gpio_sim_set;
428 gc->get_multiple = gpio_sim_get_multiple;
429 gc->set_multiple = gpio_sim_set_multiple;
430 gc->direction_output = gpio_sim_direction_output;
431 gc->direction_input = gpio_sim_direction_input;
432 gc->get_direction = gpio_sim_get_direction;
433 gc->set_config = gpio_sim_set_config;
434 gc->to_irq = gpio_sim_to_irq;
435 gc->free = gpio_sim_free;
436 gc->can_sleep = true;
438 ret = devm_gpiochip_add_data(dev, gc, chip);
442 /* Used by sysfs and configfs callbacks. */
443 dev_set_drvdata(&gc->gpiodev->dev, chip);
445 return gpio_sim_setup_sysfs(chip);
448 static int gpio_sim_probe(struct platform_device *pdev)
450 struct device *dev = &pdev->dev;
451 struct fwnode_handle *swnode;
454 device_for_each_child_node(dev, swnode) {
455 ret = gpio_sim_add_bank(swnode, dev);
457 fwnode_handle_put(swnode);
465 static const struct of_device_id gpio_sim_of_match[] = {
466 { .compatible = "gpio-simulator" },
469 MODULE_DEVICE_TABLE(of, gpio_sim_of_match);
471 static struct platform_driver gpio_sim_driver = {
474 .of_match_table = gpio_sim_of_match,
476 .probe = gpio_sim_probe,
479 struct gpio_sim_device {
480 struct config_group group;
483 * If pdev is NULL, the device is 'pending' (waiting for configuration).
484 * Once the pointer is assigned, the device has been created and the
487 struct platform_device *pdev;
491 * Each configfs filesystem operation is protected with the subsystem
492 * mutex. Each separate attribute is protected with the buffer mutex.
493 * This structure however can be modified by callbacks of different
494 * attributes so we need another lock.
496 * We use this lock for protecting all data structures owned by this
502 * This is used to synchronously wait for the driver's probe to complete
503 * and notify the user-space about any errors.
505 struct notifier_block bus_notifier;
506 struct completion probe_completion;
509 struct gpiod_hog *hogs;
511 struct list_head bank_list;
514 /* This is called with dev->lock already taken. */
515 static int gpio_sim_bus_notifier_call(struct notifier_block *nb,
516 unsigned long action, void *data)
518 struct gpio_sim_device *simdev = container_of(nb,
519 struct gpio_sim_device,
521 struct device *dev = data;
524 snprintf(devname, sizeof(devname), "gpio-sim.%u", simdev->id);
526 if (strcmp(dev_name(dev), devname) == 0) {
527 if (action == BUS_NOTIFY_BOUND_DRIVER)
528 simdev->driver_bound = true;
529 else if (action == BUS_NOTIFY_DRIVER_NOT_BOUND)
530 simdev->driver_bound = false;
534 complete(&simdev->probe_completion);
541 static struct gpio_sim_device *to_gpio_sim_device(struct config_item *item)
543 struct config_group *group = to_config_group(item);
545 return container_of(group, struct gpio_sim_device, group);
548 struct gpio_sim_bank {
549 struct config_group group;
552 * We could have used the ci_parent field of the config_item but
553 * configfs is stupid and calls the item's release callback after
554 * already having cleared the parent pointer even though the parent
555 * is guaranteed to survive the child...
557 * So we need to store the pointer to the parent struct here. We can
558 * dereference it anywhere we need with no checks and no locking as
559 * it's guaranteed to survive the children and protected by configfs
562 * Same for other structures.
564 struct gpio_sim_device *parent;
565 struct list_head siblings;
568 unsigned int num_lines;
570 struct list_head line_list;
572 struct fwnode_handle *swnode;
575 static struct gpio_sim_bank *to_gpio_sim_bank(struct config_item *item)
577 struct config_group *group = to_config_group(item);
579 return container_of(group, struct gpio_sim_bank, group);
582 static bool gpio_sim_bank_has_label(struct gpio_sim_bank *bank)
584 return bank->label && *bank->label;
587 static struct gpio_sim_device *
588 gpio_sim_bank_get_device(struct gpio_sim_bank *bank)
595 struct gpio_sim_line {
596 struct config_group group;
598 struct gpio_sim_bank *parent;
599 struct list_head siblings;
604 /* There can only be one hog per line. */
605 struct gpio_sim_hog *hog;
608 static struct gpio_sim_line *to_gpio_sim_line(struct config_item *item)
610 struct config_group *group = to_config_group(item);
612 return container_of(group, struct gpio_sim_line, group);
615 static struct gpio_sim_device *
616 gpio_sim_line_get_device(struct gpio_sim_line *line)
618 struct gpio_sim_bank *bank = line->parent;
620 return gpio_sim_bank_get_device(bank);
623 struct gpio_sim_hog {
624 struct config_item item;
625 struct gpio_sim_line *parent;
631 static struct gpio_sim_hog *to_gpio_sim_hog(struct config_item *item)
633 return container_of(item, struct gpio_sim_hog, item);
636 static struct gpio_sim_device *gpio_sim_hog_get_device(struct gpio_sim_hog *hog)
638 struct gpio_sim_line *line = hog->parent;
640 return gpio_sim_line_get_device(line);
643 static bool gpio_sim_device_is_live_unlocked(struct gpio_sim_device *dev)
648 static char *gpio_sim_strdup_trimmed(const char *str, size_t count)
652 trimmed = kstrndup(skip_spaces(str), count, GFP_KERNEL);
656 return strim(trimmed);
659 static ssize_t gpio_sim_device_config_dev_name_show(struct config_item *item,
662 struct gpio_sim_device *dev = to_gpio_sim_device(item);
663 struct platform_device *pdev;
665 guard(mutex)(&dev->lock);
669 return sprintf(page, "%s\n", dev_name(&pdev->dev));
671 return sprintf(page, "gpio-sim.%d\n", dev->id);
674 CONFIGFS_ATTR_RO(gpio_sim_device_config_, dev_name);
677 gpio_sim_device_config_live_show(struct config_item *item, char *page)
679 struct gpio_sim_device *dev = to_gpio_sim_device(item);
682 scoped_guard(mutex, &dev->lock)
683 live = gpio_sim_device_is_live_unlocked(dev);
685 return sprintf(page, "%c\n", live ? '1' : '0');
688 static char **gpio_sim_make_line_names(struct gpio_sim_bank *bank,
689 unsigned int *line_names_size)
691 unsigned int max_offset = 0;
692 bool has_line_names = false;
693 struct gpio_sim_line *line;
696 list_for_each_entry(line, &bank->line_list, siblings) {
697 if (line->offset >= bank->num_lines)
701 if (line->offset > max_offset)
702 max_offset = line->offset;
705 * max_offset can stay at 0 so it's not an indicator
706 * of whether line names were configured at all.
708 has_line_names = true;
714 * This is not an error - NULL means, there are no line
719 *line_names_size = max_offset + 1;
721 line_names = kcalloc(*line_names_size, sizeof(*line_names), GFP_KERNEL);
723 return ERR_PTR(-ENOMEM);
725 list_for_each_entry(line, &bank->line_list, siblings) {
726 if (line->offset >= bank->num_lines)
729 if (line->name && (line->offset <= max_offset))
730 line_names[line->offset] = line->name;
736 static void gpio_sim_remove_hogs(struct gpio_sim_device *dev)
738 struct gpiod_hog *hog;
743 gpiod_remove_hogs(dev->hogs);
745 for (hog = dev->hogs; hog->chip_label; hog++) {
746 kfree(hog->chip_label);
747 kfree(hog->line_name);
754 static int gpio_sim_add_hogs(struct gpio_sim_device *dev)
756 unsigned int num_hogs = 0, idx = 0;
757 struct gpio_sim_bank *bank;
758 struct gpio_sim_line *line;
759 struct gpiod_hog *hog;
761 list_for_each_entry(bank, &dev->bank_list, siblings) {
762 list_for_each_entry(line, &bank->line_list, siblings) {
763 if (line->offset >= bank->num_lines)
774 /* Allocate one more for the sentinel. */
775 dev->hogs = kcalloc(num_hogs + 1, sizeof(*dev->hogs), GFP_KERNEL);
779 list_for_each_entry(bank, &dev->bank_list, siblings) {
780 list_for_each_entry(line, &bank->line_list, siblings) {
781 if (line->offset >= bank->num_lines)
787 hog = &dev->hogs[idx++];
790 * We need to make this string manually because at this
791 * point the device doesn't exist yet and so dev_name()
794 if (gpio_sim_bank_has_label(bank))
795 hog->chip_label = kstrdup(bank->label,
798 hog->chip_label = kasprintf(GFP_KERNEL,
802 if (!hog->chip_label) {
803 gpio_sim_remove_hogs(dev);
808 * We need to duplicate this because the hog config
809 * item can be removed at any time (and we can't block
810 * it) and gpiolib doesn't make a deep copy of the hog
813 if (line->hog->name) {
814 hog->line_name = kstrdup(line->hog->name,
816 if (!hog->line_name) {
817 gpio_sim_remove_hogs(dev);
822 hog->chip_hwnum = line->offset;
823 hog->dflags = line->hog->dir;
827 gpiod_add_hogs(dev->hogs);
832 static struct fwnode_handle *
833 gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,
834 struct fwnode_handle *parent)
836 struct property_entry properties[GPIO_SIM_PROP_MAX];
837 unsigned int prop_idx = 0, line_names_size = 0;
838 char **line_names __free(kfree) = NULL;
840 memset(properties, 0, sizeof(properties));
842 properties[prop_idx++] = PROPERTY_ENTRY_U32("ngpios", bank->num_lines);
844 if (gpio_sim_bank_has_label(bank))
845 properties[prop_idx++] = PROPERTY_ENTRY_STRING("gpio-sim,label",
848 line_names = gpio_sim_make_line_names(bank, &line_names_size);
849 if (IS_ERR(line_names))
850 return ERR_CAST(line_names);
853 properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN(
855 line_names, line_names_size);
857 return fwnode_create_software_node(properties, parent);
860 static void gpio_sim_remove_swnode_recursive(struct fwnode_handle *swnode)
862 struct fwnode_handle *child;
864 fwnode_for_each_child_node(swnode, child)
865 fwnode_remove_software_node(child);
867 fwnode_remove_software_node(swnode);
870 static bool gpio_sim_bank_labels_non_unique(struct gpio_sim_device *dev)
872 struct gpio_sim_bank *this, *pos;
874 list_for_each_entry(this, &dev->bank_list, siblings) {
875 list_for_each_entry(pos, &dev->bank_list, siblings) {
876 if (this == pos || (!this->label || !pos->label))
879 if (strcmp(this->label, pos->label) == 0)
887 static int gpio_sim_device_activate_unlocked(struct gpio_sim_device *dev)
889 struct platform_device_info pdevinfo;
890 struct fwnode_handle *swnode;
891 struct platform_device *pdev;
892 struct gpio_sim_bank *bank;
895 if (list_empty(&dev->bank_list))
899 * Non-unique GPIO device labels are a corner-case we don't support
900 * as it would interfere with machine hogging mechanism and has little
903 if (gpio_sim_bank_labels_non_unique(dev))
906 memset(&pdevinfo, 0, sizeof(pdevinfo));
908 swnode = fwnode_create_software_node(NULL, NULL);
910 return PTR_ERR(swnode);
912 list_for_each_entry(bank, &dev->bank_list, siblings) {
913 bank->swnode = gpio_sim_make_bank_swnode(bank, swnode);
914 if (IS_ERR(bank->swnode)) {
915 ret = PTR_ERR(bank->swnode);
916 gpio_sim_remove_swnode_recursive(swnode);
921 ret = gpio_sim_add_hogs(dev);
923 gpio_sim_remove_swnode_recursive(swnode);
927 pdevinfo.name = "gpio-sim";
928 pdevinfo.fwnode = swnode;
929 pdevinfo.id = dev->id;
931 reinit_completion(&dev->probe_completion);
932 dev->driver_bound = false;
933 bus_register_notifier(&platform_bus_type, &dev->bus_notifier);
935 pdev = platform_device_register_full(&pdevinfo);
937 bus_unregister_notifier(&platform_bus_type, &dev->bus_notifier);
938 gpio_sim_remove_hogs(dev);
939 gpio_sim_remove_swnode_recursive(swnode);
940 return PTR_ERR(pdev);
943 wait_for_completion(&dev->probe_completion);
944 bus_unregister_notifier(&platform_bus_type, &dev->bus_notifier);
946 if (!dev->driver_bound) {
947 /* Probe failed, check kernel log. */
948 platform_device_unregister(pdev);
949 gpio_sim_remove_hogs(dev);
950 gpio_sim_remove_swnode_recursive(swnode);
959 static void gpio_sim_device_deactivate_unlocked(struct gpio_sim_device *dev)
961 struct fwnode_handle *swnode;
963 swnode = dev_fwnode(&dev->pdev->dev);
964 platform_device_unregister(dev->pdev);
965 gpio_sim_remove_hogs(dev);
966 gpio_sim_remove_swnode_recursive(swnode);
971 gpio_sim_device_config_live_store(struct config_item *item,
972 const char *page, size_t count)
974 struct gpio_sim_device *dev = to_gpio_sim_device(item);
978 ret = kstrtobool(page, &live);
982 guard(mutex)(&dev->lock);
984 if (live == gpio_sim_device_is_live_unlocked(dev))
987 ret = gpio_sim_device_activate_unlocked(dev);
989 gpio_sim_device_deactivate_unlocked(dev);
994 CONFIGFS_ATTR(gpio_sim_device_config_, live);
996 static struct configfs_attribute *gpio_sim_device_config_attrs[] = {
997 &gpio_sim_device_config_attr_dev_name,
998 &gpio_sim_device_config_attr_live,
1002 struct gpio_sim_chip_name_ctx {
1003 struct fwnode_handle *swnode;
1007 static int gpio_sim_emit_chip_name(struct device *dev, void *data)
1009 struct gpio_sim_chip_name_ctx *ctx = data;
1011 /* This would be the sysfs device exported in /sys/class/gpio. */
1015 if (device_match_fwnode(dev, ctx->swnode))
1016 return sprintf(ctx->page, "%s\n", dev_name(dev));
1021 static ssize_t gpio_sim_bank_config_chip_name_show(struct config_item *item,
1024 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1025 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1026 struct gpio_sim_chip_name_ctx ctx = { bank->swnode, page };
1028 guard(mutex)(&dev->lock);
1030 if (gpio_sim_device_is_live_unlocked(dev))
1031 return device_for_each_child(&dev->pdev->dev, &ctx,
1032 gpio_sim_emit_chip_name);
1034 return sprintf(page, "none\n");
1037 CONFIGFS_ATTR_RO(gpio_sim_bank_config_, chip_name);
1040 gpio_sim_bank_config_label_show(struct config_item *item, char *page)
1042 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1043 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1045 guard(mutex)(&dev->lock);
1047 return sprintf(page, "%s\n", bank->label ?: "");
1050 static ssize_t gpio_sim_bank_config_label_store(struct config_item *item,
1051 const char *page, size_t count)
1053 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1054 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1057 guard(mutex)(&dev->lock);
1059 if (gpio_sim_device_is_live_unlocked(dev))
1062 trimmed = gpio_sim_strdup_trimmed(page, count);
1067 bank->label = trimmed;
1072 CONFIGFS_ATTR(gpio_sim_bank_config_, label);
1075 gpio_sim_bank_config_num_lines_show(struct config_item *item, char *page)
1077 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1078 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1080 guard(mutex)(&dev->lock);
1082 return sprintf(page, "%u\n", bank->num_lines);
1086 gpio_sim_bank_config_num_lines_store(struct config_item *item,
1087 const char *page, size_t count)
1089 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1090 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1091 unsigned int num_lines;
1094 ret = kstrtouint(page, 0, &num_lines);
1101 guard(mutex)(&dev->lock);
1103 if (gpio_sim_device_is_live_unlocked(dev))
1106 bank->num_lines = num_lines;
1111 CONFIGFS_ATTR(gpio_sim_bank_config_, num_lines);
1113 static struct configfs_attribute *gpio_sim_bank_config_attrs[] = {
1114 &gpio_sim_bank_config_attr_chip_name,
1115 &gpio_sim_bank_config_attr_label,
1116 &gpio_sim_bank_config_attr_num_lines,
1121 gpio_sim_line_config_name_show(struct config_item *item, char *page)
1123 struct gpio_sim_line *line = to_gpio_sim_line(item);
1124 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1126 guard(mutex)(&dev->lock);
1128 return sprintf(page, "%s\n", line->name ?: "");
1131 static ssize_t gpio_sim_line_config_name_store(struct config_item *item,
1132 const char *page, size_t count)
1134 struct gpio_sim_line *line = to_gpio_sim_line(item);
1135 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1138 guard(mutex)(&dev->lock);
1140 if (gpio_sim_device_is_live_unlocked(dev))
1143 trimmed = gpio_sim_strdup_trimmed(page, count);
1148 line->name = trimmed;
1153 CONFIGFS_ATTR(gpio_sim_line_config_, name);
1155 static struct configfs_attribute *gpio_sim_line_config_attrs[] = {
1156 &gpio_sim_line_config_attr_name,
1160 static ssize_t gpio_sim_hog_config_name_show(struct config_item *item,
1163 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1164 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1166 guard(mutex)(&dev->lock);
1168 return sprintf(page, "%s\n", hog->name ?: "");
1171 static ssize_t gpio_sim_hog_config_name_store(struct config_item *item,
1172 const char *page, size_t count)
1174 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1175 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1178 guard(mutex)(&dev->lock);
1180 if (gpio_sim_device_is_live_unlocked(dev))
1183 trimmed = gpio_sim_strdup_trimmed(page, count);
1188 hog->name = trimmed;
1193 CONFIGFS_ATTR(gpio_sim_hog_config_, name);
1195 static ssize_t gpio_sim_hog_config_direction_show(struct config_item *item,
1198 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1199 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1203 scoped_guard(mutex, &dev->lock)
1210 case GPIOD_OUT_HIGH:
1211 repr = "output-high";
1214 repr = "output-low";
1217 /* This would be a programmer bug. */
1218 WARN(1, "Unexpected hog direction value: %d", dir);
1222 return sprintf(page, "%s\n", repr);
1226 gpio_sim_hog_config_direction_store(struct config_item *item,
1227 const char *page, size_t count)
1229 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1230 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1233 guard(mutex)(&dev->lock);
1235 if (gpio_sim_device_is_live_unlocked(dev))
1238 if (sysfs_streq(page, "input"))
1240 else if (sysfs_streq(page, "output-high"))
1241 dir = GPIOD_OUT_HIGH;
1242 else if (sysfs_streq(page, "output-low"))
1243 dir = GPIOD_OUT_LOW;
1252 CONFIGFS_ATTR(gpio_sim_hog_config_, direction);
1254 static struct configfs_attribute *gpio_sim_hog_config_attrs[] = {
1255 &gpio_sim_hog_config_attr_name,
1256 &gpio_sim_hog_config_attr_direction,
1260 static void gpio_sim_hog_config_item_release(struct config_item *item)
1262 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1263 struct gpio_sim_line *line = hog->parent;
1264 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1266 scoped_guard(mutex, &dev->lock)
1273 static struct configfs_item_operations gpio_sim_hog_config_item_ops = {
1274 .release = gpio_sim_hog_config_item_release,
1277 static const struct config_item_type gpio_sim_hog_config_type = {
1278 .ct_item_ops = &gpio_sim_hog_config_item_ops,
1279 .ct_attrs = gpio_sim_hog_config_attrs,
1280 .ct_owner = THIS_MODULE,
1283 static struct config_item *
1284 gpio_sim_line_config_make_hog_item(struct config_group *group, const char *name)
1286 struct gpio_sim_line *line = to_gpio_sim_line(&group->cg_item);
1287 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1288 struct gpio_sim_hog *hog;
1290 if (strcmp(name, "hog") != 0)
1291 return ERR_PTR(-EINVAL);
1293 guard(mutex)(&dev->lock);
1295 hog = kzalloc(sizeof(*hog), GFP_KERNEL);
1297 return ERR_PTR(-ENOMEM);
1299 config_item_init_type_name(&hog->item, name,
1300 &gpio_sim_hog_config_type);
1302 hog->dir = GPIOD_IN;
1310 static void gpio_sim_line_config_group_release(struct config_item *item)
1312 struct gpio_sim_line *line = to_gpio_sim_line(item);
1313 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1315 scoped_guard(mutex, &dev->lock)
1316 list_del(&line->siblings);
1322 static struct configfs_item_operations gpio_sim_line_config_item_ops = {
1323 .release = gpio_sim_line_config_group_release,
1326 static struct configfs_group_operations gpio_sim_line_config_group_ops = {
1327 .make_item = gpio_sim_line_config_make_hog_item,
1330 static const struct config_item_type gpio_sim_line_config_type = {
1331 .ct_item_ops = &gpio_sim_line_config_item_ops,
1332 .ct_group_ops = &gpio_sim_line_config_group_ops,
1333 .ct_attrs = gpio_sim_line_config_attrs,
1334 .ct_owner = THIS_MODULE,
1337 static struct config_group *
1338 gpio_sim_bank_config_make_line_group(struct config_group *group,
1341 struct gpio_sim_bank *bank = to_gpio_sim_bank(&group->cg_item);
1342 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1343 struct gpio_sim_line *line;
1344 unsigned int offset;
1347 ret = sscanf(name, "line%u%n", &offset, &nchar);
1348 if (ret != 1 || nchar != strlen(name))
1349 return ERR_PTR(-EINVAL);
1351 guard(mutex)(&dev->lock);
1353 if (gpio_sim_device_is_live_unlocked(dev))
1354 return ERR_PTR(-EBUSY);
1356 line = kzalloc(sizeof(*line), GFP_KERNEL);
1358 return ERR_PTR(-ENOMEM);
1360 config_group_init_type_name(&line->group, name,
1361 &gpio_sim_line_config_type);
1363 line->parent = bank;
1364 line->offset = offset;
1365 list_add_tail(&line->siblings, &bank->line_list);
1367 return &line->group;
1370 static void gpio_sim_bank_config_group_release(struct config_item *item)
1372 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1373 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1375 scoped_guard(mutex, &dev->lock)
1376 list_del(&bank->siblings);
1382 static struct configfs_item_operations gpio_sim_bank_config_item_ops = {
1383 .release = gpio_sim_bank_config_group_release,
1386 static struct configfs_group_operations gpio_sim_bank_config_group_ops = {
1387 .make_group = gpio_sim_bank_config_make_line_group,
1390 static const struct config_item_type gpio_sim_bank_config_group_type = {
1391 .ct_item_ops = &gpio_sim_bank_config_item_ops,
1392 .ct_group_ops = &gpio_sim_bank_config_group_ops,
1393 .ct_attrs = gpio_sim_bank_config_attrs,
1394 .ct_owner = THIS_MODULE,
1397 static struct config_group *
1398 gpio_sim_device_config_make_bank_group(struct config_group *group,
1401 struct gpio_sim_device *dev = to_gpio_sim_device(&group->cg_item);
1402 struct gpio_sim_bank *bank;
1404 guard(mutex)(&dev->lock);
1406 if (gpio_sim_device_is_live_unlocked(dev))
1407 return ERR_PTR(-EBUSY);
1409 bank = kzalloc(sizeof(*bank), GFP_KERNEL);
1411 return ERR_PTR(-ENOMEM);
1413 config_group_init_type_name(&bank->group, name,
1414 &gpio_sim_bank_config_group_type);
1415 bank->num_lines = 1;
1417 INIT_LIST_HEAD(&bank->line_list);
1418 list_add_tail(&bank->siblings, &dev->bank_list);
1420 return &bank->group;
1423 static void gpio_sim_device_config_group_release(struct config_item *item)
1425 struct gpio_sim_device *dev = to_gpio_sim_device(item);
1427 scoped_guard(mutex, &dev->lock) {
1428 if (gpio_sim_device_is_live_unlocked(dev))
1429 gpio_sim_device_deactivate_unlocked(dev);
1432 mutex_destroy(&dev->lock);
1433 ida_free(&gpio_sim_ida, dev->id);
1437 static struct configfs_item_operations gpio_sim_device_config_item_ops = {
1438 .release = gpio_sim_device_config_group_release,
1441 static struct configfs_group_operations gpio_sim_device_config_group_ops = {
1442 .make_group = gpio_sim_device_config_make_bank_group,
1445 static const struct config_item_type gpio_sim_device_config_group_type = {
1446 .ct_item_ops = &gpio_sim_device_config_item_ops,
1447 .ct_group_ops = &gpio_sim_device_config_group_ops,
1448 .ct_attrs = gpio_sim_device_config_attrs,
1449 .ct_owner = THIS_MODULE,
1452 static struct config_group *
1453 gpio_sim_config_make_device_group(struct config_group *group, const char *name)
1455 struct gpio_sim_device *dev __free(kfree) = NULL;
1458 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1460 return ERR_PTR(-ENOMEM);
1462 id = ida_alloc(&gpio_sim_ida, GFP_KERNEL);
1466 config_group_init_type_name(&dev->group, name,
1467 &gpio_sim_device_config_group_type);
1469 mutex_init(&dev->lock);
1470 INIT_LIST_HEAD(&dev->bank_list);
1472 dev->bus_notifier.notifier_call = gpio_sim_bus_notifier_call;
1473 init_completion(&dev->probe_completion);
1475 return &no_free_ptr(dev)->group;
1478 static struct configfs_group_operations gpio_sim_config_group_ops = {
1479 .make_group = gpio_sim_config_make_device_group,
1482 static const struct config_item_type gpio_sim_config_type = {
1483 .ct_group_ops = &gpio_sim_config_group_ops,
1484 .ct_owner = THIS_MODULE,
1487 static struct configfs_subsystem gpio_sim_config_subsys = {
1490 .ci_namebuf = "gpio-sim",
1491 .ci_type = &gpio_sim_config_type,
1496 static int __init gpio_sim_init(void)
1500 ret = platform_driver_register(&gpio_sim_driver);
1502 pr_err("Error %d while registering the platform driver\n", ret);
1506 config_group_init(&gpio_sim_config_subsys.su_group);
1507 mutex_init(&gpio_sim_config_subsys.su_mutex);
1508 ret = configfs_register_subsystem(&gpio_sim_config_subsys);
1510 pr_err("Error %d while registering the configfs subsystem %s\n",
1511 ret, gpio_sim_config_subsys.su_group.cg_item.ci_namebuf);
1512 mutex_destroy(&gpio_sim_config_subsys.su_mutex);
1513 platform_driver_unregister(&gpio_sim_driver);
1519 module_init(gpio_sim_init);
1521 static void __exit gpio_sim_exit(void)
1523 configfs_unregister_subsystem(&gpio_sim_config_subsys);
1524 mutex_destroy(&gpio_sim_config_subsys.su_mutex);
1525 platform_driver_unregister(&gpio_sim_driver);
1527 module_exit(gpio_sim_exit);
1530 MODULE_DESCRIPTION("GPIO Simulator Module");
1531 MODULE_LICENSE("GPL");