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/completion.h>
12 #include <linux/configfs.h>
13 #include <linux/device.h>
14 #include <linux/gpio/driver.h>
15 #include <linux/gpio/machine.h>
16 #include <linux/idr.h>
17 #include <linux/interrupt.h>
18 #include <linux/irq.h>
19 #include <linux/irq_sim.h>
20 #include <linux/list.h>
21 #include <linux/mod_devicetable.h>
22 #include <linux/module.h>
23 #include <linux/mutex.h>
24 #include <linux/notifier.h>
25 #include <linux/platform_device.h>
26 #include <linux/property.h>
27 #include <linux/slab.h>
28 #include <linux/string.h>
29 #include <linux/string_helpers.h>
30 #include <linux/sysfs.h>
34 #define GPIO_SIM_NGPIO_MAX 1024
35 #define GPIO_SIM_PROP_MAX 4 /* Max 3 properties + sentinel. */
36 #define GPIO_SIM_NUM_ATTRS 3 /* value, pull and sentinel */
38 static DEFINE_IDA(gpio_sim_ida);
40 struct gpio_sim_chip {
42 unsigned long *direction_map;
43 unsigned long *value_map;
44 unsigned long *pull_map;
45 struct irq_domain *irq_sim;
47 const struct attribute_group **attr_groups;
50 struct gpio_sim_attribute {
51 struct device_attribute dev_attr;
55 static struct gpio_sim_attribute *
56 to_gpio_sim_attr(struct device_attribute *dev_attr)
58 return container_of(dev_attr, struct gpio_sim_attribute, dev_attr);
61 static int gpio_sim_apply_pull(struct gpio_sim_chip *chip,
62 unsigned int offset, int value)
64 int irq, irq_type, ret;
65 struct gpio_desc *desc;
69 desc = &gc->gpiodev->descs[offset];
71 mutex_lock(&chip->lock);
73 if (test_bit(FLAG_REQUESTED, &desc->flags) &&
74 !test_bit(FLAG_IS_OUT, &desc->flags)) {
75 if (value == !!test_bit(offset, chip->value_map))
79 * This is fine - it just means, nobody is listening
80 * for interrupts on this line, otherwise
81 * irq_create_mapping() would have been called from
82 * the to_irq() callback.
84 irq = irq_find_mapping(chip->irq_sim, offset);
88 irq_type = irq_get_trigger_type(irq);
90 if ((value && (irq_type & IRQ_TYPE_EDGE_RISING)) ||
91 (!value && (irq_type & IRQ_TYPE_EDGE_FALLING))) {
92 ret = irq_set_irqchip_state(irq, IRQCHIP_STATE_PENDING,
100 /* Change the value unless we're actively driving the line. */
101 if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
102 !test_bit(FLAG_IS_OUT, &desc->flags))
103 __assign_bit(offset, chip->value_map, value);
106 __assign_bit(offset, chip->pull_map, value);
107 mutex_unlock(&chip->lock);
111 static int gpio_sim_get(struct gpio_chip *gc, unsigned int offset)
113 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
116 mutex_lock(&chip->lock);
117 ret = !!test_bit(offset, chip->value_map);
118 mutex_unlock(&chip->lock);
123 static void gpio_sim_set(struct gpio_chip *gc, unsigned int offset, int value)
125 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
127 mutex_lock(&chip->lock);
128 __assign_bit(offset, chip->value_map, value);
129 mutex_unlock(&chip->lock);
132 static int gpio_sim_get_multiple(struct gpio_chip *gc,
133 unsigned long *mask, unsigned long *bits)
135 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
137 mutex_lock(&chip->lock);
138 bitmap_replace(bits, bits, chip->value_map, mask, gc->ngpio);
139 mutex_unlock(&chip->lock);
144 static void gpio_sim_set_multiple(struct gpio_chip *gc,
145 unsigned long *mask, unsigned long *bits)
147 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
149 mutex_lock(&chip->lock);
150 bitmap_replace(chip->value_map, chip->value_map, bits, mask, gc->ngpio);
151 mutex_unlock(&chip->lock);
154 static int gpio_sim_direction_output(struct gpio_chip *gc,
155 unsigned int offset, int value)
157 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
159 mutex_lock(&chip->lock);
160 __clear_bit(offset, chip->direction_map);
161 __assign_bit(offset, chip->value_map, value);
162 mutex_unlock(&chip->lock);
167 static int gpio_sim_direction_input(struct gpio_chip *gc, unsigned int offset)
169 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
171 mutex_lock(&chip->lock);
172 __set_bit(offset, chip->direction_map);
173 mutex_unlock(&chip->lock);
178 static int gpio_sim_get_direction(struct gpio_chip *gc, unsigned int offset)
180 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
183 mutex_lock(&chip->lock);
184 direction = !!test_bit(offset, chip->direction_map);
185 mutex_unlock(&chip->lock);
187 return direction ? GPIO_LINE_DIRECTION_IN : GPIO_LINE_DIRECTION_OUT;
190 static int gpio_sim_set_config(struct gpio_chip *gc,
191 unsigned int offset, unsigned long config)
193 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
195 switch (pinconf_to_config_param(config)) {
196 case PIN_CONFIG_BIAS_PULL_UP:
197 return gpio_sim_apply_pull(chip, offset, 1);
198 case PIN_CONFIG_BIAS_PULL_DOWN:
199 return gpio_sim_apply_pull(chip, offset, 0);
207 static int gpio_sim_to_irq(struct gpio_chip *gc, unsigned int offset)
209 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
211 return irq_create_mapping(chip->irq_sim, offset);
214 static void gpio_sim_free(struct gpio_chip *gc, unsigned int offset)
216 struct gpio_sim_chip *chip = gpiochip_get_data(gc);
218 mutex_lock(&chip->lock);
219 __assign_bit(offset, chip->value_map, !!test_bit(offset, chip->pull_map));
220 mutex_unlock(&chip->lock);
223 static ssize_t gpio_sim_sysfs_val_show(struct device *dev,
224 struct device_attribute *attr, char *buf)
226 struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr);
227 struct gpio_sim_chip *chip = dev_get_drvdata(dev);
230 mutex_lock(&chip->lock);
231 val = !!test_bit(line_attr->offset, chip->value_map);
232 mutex_unlock(&chip->lock);
234 return sysfs_emit(buf, "%d\n", val);
237 static ssize_t gpio_sim_sysfs_val_store(struct device *dev,
238 struct device_attribute *attr,
239 const char *buf, size_t count)
242 * Not assigning this function will result in write() returning -EIO
243 * which is confusing. Return -EPERM explicitly.
248 static const char *const gpio_sim_sysfs_pull_strings[] = {
253 static ssize_t gpio_sim_sysfs_pull_show(struct device *dev,
254 struct device_attribute *attr,
257 struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr);
258 struct gpio_sim_chip *chip = dev_get_drvdata(dev);
261 mutex_lock(&chip->lock);
262 pull = !!test_bit(line_attr->offset, chip->pull_map);
263 mutex_unlock(&chip->lock);
265 return sysfs_emit(buf, "%s\n", gpio_sim_sysfs_pull_strings[pull]);
268 static ssize_t gpio_sim_sysfs_pull_store(struct device *dev,
269 struct device_attribute *attr,
270 const char *buf, size_t len)
272 struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr);
273 struct gpio_sim_chip *chip = dev_get_drvdata(dev);
276 pull = sysfs_match_string(gpio_sim_sysfs_pull_strings, buf);
280 ret = gpio_sim_apply_pull(chip, line_attr->offset, pull);
287 static void gpio_sim_mutex_destroy(void *data)
289 struct mutex *lock = data;
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, NULL, num_lines);
406 if (IS_ERR(chip->irq_sim))
407 return PTR_ERR(chip->irq_sim);
409 mutex_init(&chip->lock);
410 ret = devm_add_action_or_reset(dev, gpio_sim_mutex_destroy,
417 gc->ngpio = num_lines;
419 gc->owner = THIS_MODULE;
422 gc->get = gpio_sim_get;
423 gc->set = gpio_sim_set;
424 gc->get_multiple = gpio_sim_get_multiple;
425 gc->set_multiple = gpio_sim_set_multiple;
426 gc->direction_output = gpio_sim_direction_output;
427 gc->direction_input = gpio_sim_direction_input;
428 gc->get_direction = gpio_sim_get_direction;
429 gc->set_config = gpio_sim_set_config;
430 gc->to_irq = gpio_sim_to_irq;
431 gc->free = gpio_sim_free;
433 ret = devm_gpiochip_add_data(dev, gc, chip);
437 /* Used by sysfs and configfs callbacks. */
438 dev_set_drvdata(&gc->gpiodev->dev, chip);
440 return gpio_sim_setup_sysfs(chip);
443 static int gpio_sim_probe(struct platform_device *pdev)
445 struct device *dev = &pdev->dev;
446 struct fwnode_handle *swnode;
449 device_for_each_child_node(dev, swnode) {
450 ret = gpio_sim_add_bank(swnode, dev);
452 fwnode_handle_put(swnode);
460 static const struct of_device_id gpio_sim_of_match[] = {
461 { .compatible = "gpio-simulator" },
464 MODULE_DEVICE_TABLE(of, gpio_sim_of_match);
466 static struct platform_driver gpio_sim_driver = {
469 .of_match_table = gpio_sim_of_match,
471 .probe = gpio_sim_probe,
474 struct gpio_sim_device {
475 struct config_group group;
478 * If pdev is NULL, the device is 'pending' (waiting for configuration).
479 * Once the pointer is assigned, the device has been created and the
482 struct platform_device *pdev;
486 * Each configfs filesystem operation is protected with the subsystem
487 * mutex. Each separate attribute is protected with the buffer mutex.
488 * This structure however can be modified by callbacks of different
489 * attributes so we need another lock.
491 * We use this lock fo protecting all data structures owned by this
497 * This is used to synchronously wait for the driver's probe to complete
498 * and notify the user-space about any errors.
500 struct notifier_block bus_notifier;
501 struct completion probe_completion;
504 struct gpiod_hog *hogs;
506 struct list_head bank_list;
509 /* This is called with dev->lock already taken. */
510 static int gpio_sim_bus_notifier_call(struct notifier_block *nb,
511 unsigned long action, void *data)
513 struct gpio_sim_device *simdev = container_of(nb,
514 struct gpio_sim_device,
516 struct device *dev = data;
519 snprintf(devname, sizeof(devname), "gpio-sim.%u", simdev->id);
521 if (strcmp(dev_name(dev), devname) == 0) {
522 if (action == BUS_NOTIFY_BOUND_DRIVER)
523 simdev->driver_bound = true;
524 else if (action == BUS_NOTIFY_DRIVER_NOT_BOUND)
525 simdev->driver_bound = false;
529 complete(&simdev->probe_completion);
536 static struct gpio_sim_device *to_gpio_sim_device(struct config_item *item)
538 struct config_group *group = to_config_group(item);
540 return container_of(group, struct gpio_sim_device, group);
543 struct gpio_sim_bank {
544 struct config_group group;
547 * We could have used the ci_parent field of the config_item but
548 * configfs is stupid and calls the item's release callback after
549 * already having cleared the parent pointer even though the parent
550 * is guaranteed to survive the child...
552 * So we need to store the pointer to the parent struct here. We can
553 * dereference it anywhere we need with no checks and no locking as
554 * it's guaranteed to survive the children and protected by configfs
557 * Same for other structures.
559 struct gpio_sim_device *parent;
560 struct list_head siblings;
563 unsigned int num_lines;
565 struct list_head line_list;
567 struct fwnode_handle *swnode;
570 static struct gpio_sim_bank *to_gpio_sim_bank(struct config_item *item)
572 struct config_group *group = to_config_group(item);
574 return container_of(group, struct gpio_sim_bank, group);
577 static bool gpio_sim_bank_has_label(struct gpio_sim_bank *bank)
579 return bank->label && *bank->label;
582 static struct gpio_sim_device *
583 gpio_sim_bank_get_device(struct gpio_sim_bank *bank)
590 struct gpio_sim_line {
591 struct config_group group;
593 struct gpio_sim_bank *parent;
594 struct list_head siblings;
599 /* There can only be one hog per line. */
600 struct gpio_sim_hog *hog;
603 static struct gpio_sim_line *to_gpio_sim_line(struct config_item *item)
605 struct config_group *group = to_config_group(item);
607 return container_of(group, struct gpio_sim_line, group);
610 static struct gpio_sim_device *
611 gpio_sim_line_get_device(struct gpio_sim_line *line)
613 struct gpio_sim_bank *bank = line->parent;
615 return gpio_sim_bank_get_device(bank);
618 struct gpio_sim_hog {
619 struct config_item item;
620 struct gpio_sim_line *parent;
626 static struct gpio_sim_hog *to_gpio_sim_hog(struct config_item *item)
628 return container_of(item, struct gpio_sim_hog, item);
631 static struct gpio_sim_device *gpio_sim_hog_get_device(struct gpio_sim_hog *hog)
633 struct gpio_sim_line *line = hog->parent;
635 return gpio_sim_line_get_device(line);
638 static bool gpio_sim_device_is_live_unlocked(struct gpio_sim_device *dev)
643 static char *gpio_sim_strdup_trimmed(const char *str, size_t count)
647 dup = kstrndup(str, count, GFP_KERNEL);
651 trimmed = strstrip(dup);
652 memmove(dup, trimmed, strlen(trimmed) + 1);
657 static ssize_t gpio_sim_device_config_dev_name_show(struct config_item *item,
660 struct gpio_sim_device *dev = to_gpio_sim_device(item);
661 struct platform_device *pdev;
664 mutex_lock(&dev->lock);
667 ret = sprintf(page, "%s\n", dev_name(&pdev->dev));
669 ret = sprintf(page, "gpio-sim.%d\n", dev->id);
670 mutex_unlock(&dev->lock);
675 CONFIGFS_ATTR_RO(gpio_sim_device_config_, dev_name);
678 gpio_sim_device_config_live_show(struct config_item *item, char *page)
680 struct gpio_sim_device *dev = to_gpio_sim_device(item);
683 mutex_lock(&dev->lock);
684 live = gpio_sim_device_is_live_unlocked(dev);
685 mutex_unlock(&dev->lock);
687 return sprintf(page, "%c\n", live ? '1' : '0');
690 static char **gpio_sim_make_line_names(struct gpio_sim_bank *bank,
691 unsigned int *line_names_size)
693 unsigned int max_offset = 0;
694 bool has_line_names = false;
695 struct gpio_sim_line *line;
698 list_for_each_entry(line, &bank->line_list, siblings) {
699 if (line->offset >= bank->num_lines)
703 if (line->offset > max_offset)
704 max_offset = line->offset;
707 * max_offset can stay at 0 so it's not an indicator
708 * of whether line names were configured at all.
710 has_line_names = true;
716 * This is not an error - NULL means, there are no line
721 *line_names_size = max_offset + 1;
723 line_names = kcalloc(*line_names_size, sizeof(*line_names), GFP_KERNEL);
725 return ERR_PTR(-ENOMEM);
727 list_for_each_entry(line, &bank->line_list, siblings) {
728 if (line->offset >= bank->num_lines)
731 if (line->name && (line->offset <= max_offset))
732 line_names[line->offset] = line->name;
738 static void gpio_sim_remove_hogs(struct gpio_sim_device *dev)
740 struct gpiod_hog *hog;
745 gpiod_remove_hogs(dev->hogs);
747 for (hog = dev->hogs; hog->chip_label; hog++) {
748 kfree(hog->chip_label);
749 kfree(hog->line_name);
756 static int gpio_sim_add_hogs(struct gpio_sim_device *dev)
758 unsigned int num_hogs = 0, idx = 0;
759 struct gpio_sim_bank *bank;
760 struct gpio_sim_line *line;
761 struct gpiod_hog *hog;
763 list_for_each_entry(bank, &dev->bank_list, siblings) {
764 list_for_each_entry(line, &bank->line_list, siblings) {
765 if (line->offset >= bank->num_lines)
776 /* Allocate one more for the sentinel. */
777 dev->hogs = kcalloc(num_hogs + 1, sizeof(*dev->hogs), GFP_KERNEL);
781 list_for_each_entry(bank, &dev->bank_list, siblings) {
782 list_for_each_entry(line, &bank->line_list, siblings) {
783 if (line->offset >= bank->num_lines)
789 hog = &dev->hogs[idx++];
792 * We need to make this string manually because at this
793 * point the device doesn't exist yet and so dev_name()
796 if (gpio_sim_bank_has_label(bank))
797 hog->chip_label = kstrdup(bank->label,
800 hog->chip_label = kasprintf(GFP_KERNEL,
804 if (!hog->chip_label) {
805 gpio_sim_remove_hogs(dev);
810 * We need to duplicate this because the hog config
811 * item can be removed at any time (and we can't block
812 * it) and gpiolib doesn't make a deep copy of the hog
815 if (line->hog->name) {
816 hog->line_name = kstrdup(line->hog->name,
818 if (!hog->line_name) {
819 gpio_sim_remove_hogs(dev);
824 hog->chip_hwnum = line->offset;
825 hog->dflags = line->hog->dir;
829 gpiod_add_hogs(dev->hogs);
834 static struct fwnode_handle *
835 gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,
836 struct fwnode_handle *parent)
838 struct property_entry properties[GPIO_SIM_PROP_MAX];
839 unsigned int prop_idx = 0, line_names_size = 0;
840 struct fwnode_handle *swnode;
843 memset(properties, 0, sizeof(properties));
845 properties[prop_idx++] = PROPERTY_ENTRY_U32("ngpios", bank->num_lines);
847 if (gpio_sim_bank_has_label(bank))
848 properties[prop_idx++] = PROPERTY_ENTRY_STRING("gpio-sim,label",
851 line_names = gpio_sim_make_line_names(bank, &line_names_size);
852 if (IS_ERR(line_names))
853 return ERR_CAST(line_names);
856 properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN(
858 line_names, line_names_size);
860 swnode = fwnode_create_software_node(properties, parent);
865 static void gpio_sim_remove_swnode_recursive(struct fwnode_handle *swnode)
867 struct fwnode_handle *child;
869 fwnode_for_each_child_node(swnode, child)
870 fwnode_remove_software_node(child);
872 fwnode_remove_software_node(swnode);
875 static bool gpio_sim_bank_labels_non_unique(struct gpio_sim_device *dev)
877 struct gpio_sim_bank *this, *pos;
879 list_for_each_entry(this, &dev->bank_list, siblings) {
880 list_for_each_entry(pos, &dev->bank_list, siblings) {
881 if (this == pos || (!this->label || !pos->label))
884 if (strcmp(this->label, pos->label) == 0)
892 static int gpio_sim_device_activate_unlocked(struct gpio_sim_device *dev)
894 struct platform_device_info pdevinfo;
895 struct fwnode_handle *swnode;
896 struct platform_device *pdev;
897 struct gpio_sim_bank *bank;
900 if (list_empty(&dev->bank_list))
904 * Non-unique GPIO device labels are a corner-case we don't support
905 * as it would interfere with machine hogging mechanism and has little
908 if (gpio_sim_bank_labels_non_unique(dev))
911 memset(&pdevinfo, 0, sizeof(pdevinfo));
913 swnode = fwnode_create_software_node(NULL, NULL);
915 return PTR_ERR(swnode);
917 list_for_each_entry(bank, &dev->bank_list, siblings) {
918 bank->swnode = gpio_sim_make_bank_swnode(bank, swnode);
919 if (IS_ERR(bank->swnode)) {
920 ret = PTR_ERR(bank->swnode);
921 gpio_sim_remove_swnode_recursive(swnode);
926 ret = gpio_sim_add_hogs(dev);
928 gpio_sim_remove_swnode_recursive(swnode);
932 pdevinfo.name = "gpio-sim";
933 pdevinfo.fwnode = swnode;
934 pdevinfo.id = dev->id;
936 reinit_completion(&dev->probe_completion);
937 dev->driver_bound = false;
938 bus_register_notifier(&platform_bus_type, &dev->bus_notifier);
940 pdev = platform_device_register_full(&pdevinfo);
942 bus_unregister_notifier(&platform_bus_type, &dev->bus_notifier);
943 gpio_sim_remove_hogs(dev);
944 gpio_sim_remove_swnode_recursive(swnode);
945 return PTR_ERR(pdev);
948 wait_for_completion(&dev->probe_completion);
949 bus_unregister_notifier(&platform_bus_type, &dev->bus_notifier);
951 if (!dev->driver_bound) {
952 /* Probe failed, check kernel log. */
953 platform_device_unregister(pdev);
954 gpio_sim_remove_hogs(dev);
955 gpio_sim_remove_swnode_recursive(swnode);
964 static void gpio_sim_device_deactivate_unlocked(struct gpio_sim_device *dev)
966 struct fwnode_handle *swnode;
968 swnode = dev_fwnode(&dev->pdev->dev);
969 platform_device_unregister(dev->pdev);
970 gpio_sim_remove_hogs(dev);
971 gpio_sim_remove_swnode_recursive(swnode);
976 gpio_sim_device_config_live_store(struct config_item *item,
977 const char *page, size_t count)
979 struct gpio_sim_device *dev = to_gpio_sim_device(item);
983 ret = kstrtobool(page, &live);
987 mutex_lock(&dev->lock);
989 if ((!live && !gpio_sim_device_is_live_unlocked(dev)) ||
990 (live && gpio_sim_device_is_live_unlocked(dev)))
993 ret = gpio_sim_device_activate_unlocked(dev);
995 gpio_sim_device_deactivate_unlocked(dev);
997 mutex_unlock(&dev->lock);
1002 CONFIGFS_ATTR(gpio_sim_device_config_, live);
1004 static struct configfs_attribute *gpio_sim_device_config_attrs[] = {
1005 &gpio_sim_device_config_attr_dev_name,
1006 &gpio_sim_device_config_attr_live,
1010 struct gpio_sim_chip_name_ctx {
1011 struct fwnode_handle *swnode;
1015 static int gpio_sim_emit_chip_name(struct device *dev, void *data)
1017 struct gpio_sim_chip_name_ctx *ctx = data;
1019 /* This would be the sysfs device exported in /sys/class/gpio. */
1023 if (device_match_fwnode(dev, ctx->swnode))
1024 return sprintf(ctx->page, "%s\n", dev_name(dev));
1029 static ssize_t gpio_sim_bank_config_chip_name_show(struct config_item *item,
1032 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1033 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1034 struct gpio_sim_chip_name_ctx ctx = { bank->swnode, page };
1037 mutex_lock(&dev->lock);
1038 if (gpio_sim_device_is_live_unlocked(dev))
1039 ret = device_for_each_child(&dev->pdev->dev, &ctx,
1040 gpio_sim_emit_chip_name);
1042 ret = sprintf(page, "none\n");
1043 mutex_unlock(&dev->lock);
1048 CONFIGFS_ATTR_RO(gpio_sim_bank_config_, chip_name);
1051 gpio_sim_bank_config_label_show(struct config_item *item, char *page)
1053 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1054 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1057 mutex_lock(&dev->lock);
1058 ret = sprintf(page, "%s\n", bank->label ?: "");
1059 mutex_unlock(&dev->lock);
1064 static ssize_t gpio_sim_bank_config_label_store(struct config_item *item,
1065 const char *page, size_t count)
1067 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1068 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1071 mutex_lock(&dev->lock);
1073 if (gpio_sim_device_is_live_unlocked(dev)) {
1074 mutex_unlock(&dev->lock);
1078 trimmed = gpio_sim_strdup_trimmed(page, count);
1080 mutex_unlock(&dev->lock);
1085 bank->label = trimmed;
1087 mutex_unlock(&dev->lock);
1091 CONFIGFS_ATTR(gpio_sim_bank_config_, label);
1094 gpio_sim_bank_config_num_lines_show(struct config_item *item, char *page)
1096 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1097 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1100 mutex_lock(&dev->lock);
1101 ret = sprintf(page, "%u\n", bank->num_lines);
1102 mutex_unlock(&dev->lock);
1108 gpio_sim_bank_config_num_lines_store(struct config_item *item,
1109 const char *page, size_t count)
1111 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1112 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1113 unsigned int num_lines;
1116 ret = kstrtouint(page, 0, &num_lines);
1123 mutex_lock(&dev->lock);
1125 if (gpio_sim_device_is_live_unlocked(dev)) {
1126 mutex_unlock(&dev->lock);
1130 bank->num_lines = num_lines;
1132 mutex_unlock(&dev->lock);
1136 CONFIGFS_ATTR(gpio_sim_bank_config_, num_lines);
1138 static struct configfs_attribute *gpio_sim_bank_config_attrs[] = {
1139 &gpio_sim_bank_config_attr_chip_name,
1140 &gpio_sim_bank_config_attr_label,
1141 &gpio_sim_bank_config_attr_num_lines,
1146 gpio_sim_line_config_name_show(struct config_item *item, char *page)
1148 struct gpio_sim_line *line = to_gpio_sim_line(item);
1149 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1152 mutex_lock(&dev->lock);
1153 ret = sprintf(page, "%s\n", line->name ?: "");
1154 mutex_unlock(&dev->lock);
1159 static ssize_t gpio_sim_line_config_name_store(struct config_item *item,
1160 const char *page, size_t count)
1162 struct gpio_sim_line *line = to_gpio_sim_line(item);
1163 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1166 mutex_lock(&dev->lock);
1168 if (gpio_sim_device_is_live_unlocked(dev)) {
1169 mutex_unlock(&dev->lock);
1173 trimmed = gpio_sim_strdup_trimmed(page, count);
1175 mutex_unlock(&dev->lock);
1180 line->name = trimmed;
1182 mutex_unlock(&dev->lock);
1187 CONFIGFS_ATTR(gpio_sim_line_config_, name);
1189 static struct configfs_attribute *gpio_sim_line_config_attrs[] = {
1190 &gpio_sim_line_config_attr_name,
1194 static ssize_t gpio_sim_hog_config_name_show(struct config_item *item,
1197 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1198 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1201 mutex_lock(&dev->lock);
1202 ret = sprintf(page, "%s\n", hog->name ?: "");
1203 mutex_unlock(&dev->lock);
1208 static ssize_t gpio_sim_hog_config_name_store(struct config_item *item,
1209 const char *page, size_t count)
1211 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1212 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1215 mutex_lock(&dev->lock);
1217 if (gpio_sim_device_is_live_unlocked(dev)) {
1218 mutex_unlock(&dev->lock);
1222 trimmed = gpio_sim_strdup_trimmed(page, count);
1224 mutex_unlock(&dev->lock);
1229 hog->name = trimmed;
1231 mutex_unlock(&dev->lock);
1236 CONFIGFS_ATTR(gpio_sim_hog_config_, name);
1238 static ssize_t gpio_sim_hog_config_direction_show(struct config_item *item,
1241 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1242 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1246 mutex_lock(&dev->lock);
1248 mutex_unlock(&dev->lock);
1254 case GPIOD_OUT_HIGH:
1255 repr = "output-high";
1258 repr = "output-low";
1261 /* This would be a programmer bug. */
1262 WARN(1, "Unexpected hog direction value: %d", dir);
1266 return sprintf(page, "%s\n", repr);
1270 gpio_sim_hog_config_direction_store(struct config_item *item,
1271 const char *page, size_t count)
1273 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1274 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1278 mutex_lock(&dev->lock);
1280 if (gpio_sim_device_is_live_unlocked(dev)) {
1281 mutex_unlock(&dev->lock);
1285 trimmed = gpio_sim_strdup_trimmed(page, count);
1287 mutex_unlock(&dev->lock);
1291 if (strcmp(trimmed, "input") == 0)
1293 else if (strcmp(trimmed, "output-high") == 0)
1294 dir = GPIOD_OUT_HIGH;
1295 else if (strcmp(trimmed, "output-low") == 0)
1296 dir = GPIOD_OUT_LOW;
1303 mutex_unlock(&dev->lock);
1309 mutex_unlock(&dev->lock);
1314 CONFIGFS_ATTR(gpio_sim_hog_config_, direction);
1316 static struct configfs_attribute *gpio_sim_hog_config_attrs[] = {
1317 &gpio_sim_hog_config_attr_name,
1318 &gpio_sim_hog_config_attr_direction,
1322 static void gpio_sim_hog_config_item_release(struct config_item *item)
1324 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1325 struct gpio_sim_line *line = hog->parent;
1326 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1328 mutex_lock(&dev->lock);
1330 mutex_unlock(&dev->lock);
1336 static struct configfs_item_operations gpio_sim_hog_config_item_ops = {
1337 .release = gpio_sim_hog_config_item_release,
1340 static const struct config_item_type gpio_sim_hog_config_type = {
1341 .ct_item_ops = &gpio_sim_hog_config_item_ops,
1342 .ct_attrs = gpio_sim_hog_config_attrs,
1343 .ct_owner = THIS_MODULE,
1346 static struct config_item *
1347 gpio_sim_line_config_make_hog_item(struct config_group *group, const char *name)
1349 struct gpio_sim_line *line = to_gpio_sim_line(&group->cg_item);
1350 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1351 struct gpio_sim_hog *hog;
1353 if (strcmp(name, "hog") != 0)
1354 return ERR_PTR(-EINVAL);
1356 mutex_lock(&dev->lock);
1358 hog = kzalloc(sizeof(*hog), GFP_KERNEL);
1360 mutex_unlock(&dev->lock);
1361 return ERR_PTR(-ENOMEM);
1364 config_item_init_type_name(&hog->item, name,
1365 &gpio_sim_hog_config_type);
1367 hog->dir = GPIOD_IN;
1372 mutex_unlock(&dev->lock);
1377 static void gpio_sim_line_config_group_release(struct config_item *item)
1379 struct gpio_sim_line *line = to_gpio_sim_line(item);
1380 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1382 mutex_lock(&dev->lock);
1383 list_del(&line->siblings);
1384 mutex_unlock(&dev->lock);
1390 static struct configfs_item_operations gpio_sim_line_config_item_ops = {
1391 .release = gpio_sim_line_config_group_release,
1394 static struct configfs_group_operations gpio_sim_line_config_group_ops = {
1395 .make_item = gpio_sim_line_config_make_hog_item,
1398 static const struct config_item_type gpio_sim_line_config_type = {
1399 .ct_item_ops = &gpio_sim_line_config_item_ops,
1400 .ct_group_ops = &gpio_sim_line_config_group_ops,
1401 .ct_attrs = gpio_sim_line_config_attrs,
1402 .ct_owner = THIS_MODULE,
1405 static struct config_group *
1406 gpio_sim_bank_config_make_line_group(struct config_group *group,
1409 struct gpio_sim_bank *bank = to_gpio_sim_bank(&group->cg_item);
1410 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1411 struct gpio_sim_line *line;
1412 unsigned int offset;
1415 ret = sscanf(name, "line%u%n", &offset, &nchar);
1416 if (ret != 1 || nchar != strlen(name))
1417 return ERR_PTR(-EINVAL);
1419 mutex_lock(&dev->lock);
1421 if (gpio_sim_device_is_live_unlocked(dev)) {
1422 mutex_unlock(&dev->lock);
1423 return ERR_PTR(-EBUSY);
1426 line = kzalloc(sizeof(*line), GFP_KERNEL);
1428 mutex_unlock(&dev->lock);
1429 return ERR_PTR(-ENOMEM);
1432 config_group_init_type_name(&line->group, name,
1433 &gpio_sim_line_config_type);
1435 line->parent = bank;
1436 line->offset = offset;
1437 list_add_tail(&line->siblings, &bank->line_list);
1439 mutex_unlock(&dev->lock);
1441 return &line->group;
1444 static void gpio_sim_bank_config_group_release(struct config_item *item)
1446 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1447 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1449 mutex_lock(&dev->lock);
1450 list_del(&bank->siblings);
1451 mutex_unlock(&dev->lock);
1457 static struct configfs_item_operations gpio_sim_bank_config_item_ops = {
1458 .release = gpio_sim_bank_config_group_release,
1461 static struct configfs_group_operations gpio_sim_bank_config_group_ops = {
1462 .make_group = gpio_sim_bank_config_make_line_group,
1465 static const struct config_item_type gpio_sim_bank_config_group_type = {
1466 .ct_item_ops = &gpio_sim_bank_config_item_ops,
1467 .ct_group_ops = &gpio_sim_bank_config_group_ops,
1468 .ct_attrs = gpio_sim_bank_config_attrs,
1469 .ct_owner = THIS_MODULE,
1472 static struct config_group *
1473 gpio_sim_device_config_make_bank_group(struct config_group *group,
1476 struct gpio_sim_device *dev = to_gpio_sim_device(&group->cg_item);
1477 struct gpio_sim_bank *bank;
1479 mutex_lock(&dev->lock);
1481 if (gpio_sim_device_is_live_unlocked(dev)) {
1482 mutex_unlock(&dev->lock);
1483 return ERR_PTR(-EBUSY);
1486 bank = kzalloc(sizeof(*bank), GFP_KERNEL);
1488 mutex_unlock(&dev->lock);
1489 return ERR_PTR(-ENOMEM);
1492 config_group_init_type_name(&bank->group, name,
1493 &gpio_sim_bank_config_group_type);
1494 bank->num_lines = 1;
1496 INIT_LIST_HEAD(&bank->line_list);
1497 list_add_tail(&bank->siblings, &dev->bank_list);
1499 mutex_unlock(&dev->lock);
1501 return &bank->group;
1504 static void gpio_sim_device_config_group_release(struct config_item *item)
1506 struct gpio_sim_device *dev = to_gpio_sim_device(item);
1508 mutex_lock(&dev->lock);
1509 if (gpio_sim_device_is_live_unlocked(dev))
1510 gpio_sim_device_deactivate_unlocked(dev);
1511 mutex_unlock(&dev->lock);
1513 mutex_destroy(&dev->lock);
1514 ida_free(&gpio_sim_ida, dev->id);
1518 static struct configfs_item_operations gpio_sim_device_config_item_ops = {
1519 .release = gpio_sim_device_config_group_release,
1522 static struct configfs_group_operations gpio_sim_device_config_group_ops = {
1523 .make_group = gpio_sim_device_config_make_bank_group,
1526 static const struct config_item_type gpio_sim_device_config_group_type = {
1527 .ct_item_ops = &gpio_sim_device_config_item_ops,
1528 .ct_group_ops = &gpio_sim_device_config_group_ops,
1529 .ct_attrs = gpio_sim_device_config_attrs,
1530 .ct_owner = THIS_MODULE,
1533 static struct config_group *
1534 gpio_sim_config_make_device_group(struct config_group *group, const char *name)
1536 struct gpio_sim_device *dev;
1539 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1541 return ERR_PTR(-ENOMEM);
1543 id = ida_alloc(&gpio_sim_ida, GFP_KERNEL);
1549 config_group_init_type_name(&dev->group, name,
1550 &gpio_sim_device_config_group_type);
1552 mutex_init(&dev->lock);
1553 INIT_LIST_HEAD(&dev->bank_list);
1555 dev->bus_notifier.notifier_call = gpio_sim_bus_notifier_call;
1556 init_completion(&dev->probe_completion);
1561 static struct configfs_group_operations gpio_sim_config_group_ops = {
1562 .make_group = gpio_sim_config_make_device_group,
1565 static const struct config_item_type gpio_sim_config_type = {
1566 .ct_group_ops = &gpio_sim_config_group_ops,
1567 .ct_owner = THIS_MODULE,
1570 static struct configfs_subsystem gpio_sim_config_subsys = {
1573 .ci_namebuf = "gpio-sim",
1574 .ci_type = &gpio_sim_config_type,
1579 static int __init gpio_sim_init(void)
1583 ret = platform_driver_register(&gpio_sim_driver);
1585 pr_err("Error %d while registering the platform driver\n", ret);
1589 config_group_init(&gpio_sim_config_subsys.su_group);
1590 mutex_init(&gpio_sim_config_subsys.su_mutex);
1591 ret = configfs_register_subsystem(&gpio_sim_config_subsys);
1593 pr_err("Error %d while registering the configfs subsystem %s\n",
1594 ret, gpio_sim_config_subsys.su_group.cg_item.ci_namebuf);
1595 mutex_destroy(&gpio_sim_config_subsys.su_mutex);
1596 platform_driver_unregister(&gpio_sim_driver);
1602 module_init(gpio_sim_init);
1604 static void __exit gpio_sim_exit(void)
1606 configfs_unregister_subsystem(&gpio_sim_config_subsys);
1607 mutex_destroy(&gpio_sim_config_subsys.su_mutex);
1608 platform_driver_unregister(&gpio_sim_driver);
1610 module_exit(gpio_sim_exit);
1613 MODULE_DESCRIPTION("GPIO Simulator Module");
1614 MODULE_LICENSE("GPL");