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) {
700 if (line->offset > max_offset)
701 max_offset = line->offset;
704 * max_offset can stay at 0 so it's not an indicator
705 * of whether line names were configured at all.
707 has_line_names = true;
713 * This is not an error - NULL means, there are no line
718 *line_names_size = max_offset + 1;
720 line_names = kcalloc(*line_names_size, sizeof(*line_names), GFP_KERNEL);
722 return ERR_PTR(-ENOMEM);
724 list_for_each_entry(line, &bank->line_list, siblings)
725 line_names[line->offset] = line->name;
730 static void gpio_sim_remove_hogs(struct gpio_sim_device *dev)
732 struct gpiod_hog *hog;
737 gpiod_remove_hogs(dev->hogs);
739 for (hog = dev->hogs; hog->chip_label; hog++) {
740 kfree(hog->chip_label);
741 kfree(hog->line_name);
748 static int gpio_sim_add_hogs(struct gpio_sim_device *dev)
750 unsigned int num_hogs = 0, idx = 0;
751 struct gpio_sim_bank *bank;
752 struct gpio_sim_line *line;
753 struct gpiod_hog *hog;
755 list_for_each_entry(bank, &dev->bank_list, siblings) {
756 list_for_each_entry(line, &bank->line_list, siblings) {
765 /* Allocate one more for the sentinel. */
766 dev->hogs = kcalloc(num_hogs + 1, sizeof(*dev->hogs), GFP_KERNEL);
770 list_for_each_entry(bank, &dev->bank_list, siblings) {
771 list_for_each_entry(line, &bank->line_list, siblings) {
775 hog = &dev->hogs[idx++];
778 * We need to make this string manually because at this
779 * point the device doesn't exist yet and so dev_name()
782 if (gpio_sim_bank_has_label(bank))
783 hog->chip_label = kstrdup(bank->label,
786 hog->chip_label = kasprintf(GFP_KERNEL,
790 if (!hog->chip_label) {
791 gpio_sim_remove_hogs(dev);
796 * We need to duplicate this because the hog config
797 * item can be removed at any time (and we can't block
798 * it) and gpiolib doesn't make a deep copy of the hog
801 if (line->hog->name) {
802 hog->line_name = kstrdup(line->hog->name,
804 if (!hog->line_name) {
805 gpio_sim_remove_hogs(dev);
810 hog->chip_hwnum = line->offset;
811 hog->dflags = line->hog->dir;
815 gpiod_add_hogs(dev->hogs);
820 static struct fwnode_handle *
821 gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,
822 struct fwnode_handle *parent)
824 struct property_entry properties[GPIO_SIM_PROP_MAX];
825 unsigned int prop_idx = 0, line_names_size = 0;
826 struct fwnode_handle *swnode;
829 memset(properties, 0, sizeof(properties));
831 properties[prop_idx++] = PROPERTY_ENTRY_U32("ngpios", bank->num_lines);
833 if (gpio_sim_bank_has_label(bank))
834 properties[prop_idx++] = PROPERTY_ENTRY_STRING("gpio-sim,label",
837 line_names = gpio_sim_make_line_names(bank, &line_names_size);
838 if (IS_ERR(line_names))
839 return ERR_CAST(line_names);
842 properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN(
844 line_names, line_names_size);
846 swnode = fwnode_create_software_node(properties, parent);
851 static void gpio_sim_remove_swnode_recursive(struct fwnode_handle *swnode)
853 struct fwnode_handle *child;
855 fwnode_for_each_child_node(swnode, child)
856 fwnode_remove_software_node(child);
858 fwnode_remove_software_node(swnode);
861 static bool gpio_sim_bank_labels_non_unique(struct gpio_sim_device *dev)
863 struct gpio_sim_bank *this, *pos;
865 list_for_each_entry(this, &dev->bank_list, siblings) {
866 list_for_each_entry(pos, &dev->bank_list, siblings) {
867 if (this == pos || (!this->label || !pos->label))
870 if (strcmp(this->label, pos->label) == 0)
878 static int gpio_sim_device_activate_unlocked(struct gpio_sim_device *dev)
880 struct platform_device_info pdevinfo;
881 struct fwnode_handle *swnode;
882 struct platform_device *pdev;
883 struct gpio_sim_bank *bank;
886 if (list_empty(&dev->bank_list))
890 * Non-unique GPIO device labels are a corner-case we don't support
891 * as it would interfere with machine hogging mechanism and has little
894 if (gpio_sim_bank_labels_non_unique(dev))
897 memset(&pdevinfo, 0, sizeof(pdevinfo));
899 swnode = fwnode_create_software_node(NULL, NULL);
901 return PTR_ERR(swnode);
903 list_for_each_entry(bank, &dev->bank_list, siblings) {
904 bank->swnode = gpio_sim_make_bank_swnode(bank, swnode);
905 if (IS_ERR(bank->swnode)) {
906 ret = PTR_ERR(bank->swnode);
907 gpio_sim_remove_swnode_recursive(swnode);
912 ret = gpio_sim_add_hogs(dev);
914 gpio_sim_remove_swnode_recursive(swnode);
918 pdevinfo.name = "gpio-sim";
919 pdevinfo.fwnode = swnode;
920 pdevinfo.id = dev->id;
922 reinit_completion(&dev->probe_completion);
923 dev->driver_bound = false;
924 bus_register_notifier(&platform_bus_type, &dev->bus_notifier);
926 pdev = platform_device_register_full(&pdevinfo);
928 bus_unregister_notifier(&platform_bus_type, &dev->bus_notifier);
929 gpio_sim_remove_hogs(dev);
930 gpio_sim_remove_swnode_recursive(swnode);
931 return PTR_ERR(pdev);
934 wait_for_completion(&dev->probe_completion);
935 bus_unregister_notifier(&platform_bus_type, &dev->bus_notifier);
937 if (!dev->driver_bound) {
938 /* Probe failed, check kernel log. */
939 platform_device_unregister(pdev);
940 gpio_sim_remove_hogs(dev);
941 gpio_sim_remove_swnode_recursive(swnode);
950 static void gpio_sim_device_deactivate_unlocked(struct gpio_sim_device *dev)
952 struct fwnode_handle *swnode;
954 swnode = dev_fwnode(&dev->pdev->dev);
955 platform_device_unregister(dev->pdev);
956 gpio_sim_remove_hogs(dev);
957 gpio_sim_remove_swnode_recursive(swnode);
962 gpio_sim_device_config_live_store(struct config_item *item,
963 const char *page, size_t count)
965 struct gpio_sim_device *dev = to_gpio_sim_device(item);
969 ret = kstrtobool(page, &live);
973 mutex_lock(&dev->lock);
975 if ((!live && !gpio_sim_device_is_live_unlocked(dev)) ||
976 (live && gpio_sim_device_is_live_unlocked(dev)))
979 ret = gpio_sim_device_activate_unlocked(dev);
981 gpio_sim_device_deactivate_unlocked(dev);
983 mutex_unlock(&dev->lock);
988 CONFIGFS_ATTR(gpio_sim_device_config_, live);
990 static struct configfs_attribute *gpio_sim_device_config_attrs[] = {
991 &gpio_sim_device_config_attr_dev_name,
992 &gpio_sim_device_config_attr_live,
996 struct gpio_sim_chip_name_ctx {
997 struct fwnode_handle *swnode;
1001 static int gpio_sim_emit_chip_name(struct device *dev, void *data)
1003 struct gpio_sim_chip_name_ctx *ctx = data;
1005 /* This would be the sysfs device exported in /sys/class/gpio. */
1009 if (device_match_fwnode(dev, ctx->swnode))
1010 return sprintf(ctx->page, "%s\n", dev_name(dev));
1015 static ssize_t gpio_sim_bank_config_chip_name_show(struct config_item *item,
1018 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1019 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1020 struct gpio_sim_chip_name_ctx ctx = { bank->swnode, page };
1023 mutex_lock(&dev->lock);
1024 if (gpio_sim_device_is_live_unlocked(dev))
1025 ret = device_for_each_child(&dev->pdev->dev, &ctx,
1026 gpio_sim_emit_chip_name);
1028 ret = sprintf(page, "none\n");
1029 mutex_unlock(&dev->lock);
1034 CONFIGFS_ATTR_RO(gpio_sim_bank_config_, chip_name);
1037 gpio_sim_bank_config_label_show(struct config_item *item, char *page)
1039 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1040 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1043 mutex_lock(&dev->lock);
1044 ret = sprintf(page, "%s\n", bank->label ?: "");
1045 mutex_unlock(&dev->lock);
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 mutex_lock(&dev->lock);
1059 if (gpio_sim_device_is_live_unlocked(dev)) {
1060 mutex_unlock(&dev->lock);
1064 trimmed = gpio_sim_strdup_trimmed(page, count);
1066 mutex_unlock(&dev->lock);
1071 bank->label = trimmed;
1073 mutex_unlock(&dev->lock);
1077 CONFIGFS_ATTR(gpio_sim_bank_config_, label);
1080 gpio_sim_bank_config_num_lines_show(struct config_item *item, char *page)
1082 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1083 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1086 mutex_lock(&dev->lock);
1087 ret = sprintf(page, "%u\n", bank->num_lines);
1088 mutex_unlock(&dev->lock);
1094 gpio_sim_bank_config_num_lines_store(struct config_item *item,
1095 const char *page, size_t count)
1097 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1098 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1099 unsigned int num_lines;
1102 ret = kstrtouint(page, 0, &num_lines);
1109 mutex_lock(&dev->lock);
1111 if (gpio_sim_device_is_live_unlocked(dev)) {
1112 mutex_unlock(&dev->lock);
1116 bank->num_lines = num_lines;
1118 mutex_unlock(&dev->lock);
1122 CONFIGFS_ATTR(gpio_sim_bank_config_, num_lines);
1124 static struct configfs_attribute *gpio_sim_bank_config_attrs[] = {
1125 &gpio_sim_bank_config_attr_chip_name,
1126 &gpio_sim_bank_config_attr_label,
1127 &gpio_sim_bank_config_attr_num_lines,
1132 gpio_sim_line_config_name_show(struct config_item *item, char *page)
1134 struct gpio_sim_line *line = to_gpio_sim_line(item);
1135 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1138 mutex_lock(&dev->lock);
1139 ret = sprintf(page, "%s\n", line->name ?: "");
1140 mutex_unlock(&dev->lock);
1145 static ssize_t gpio_sim_line_config_name_store(struct config_item *item,
1146 const char *page, size_t count)
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);
1154 if (gpio_sim_device_is_live_unlocked(dev)) {
1155 mutex_unlock(&dev->lock);
1159 trimmed = gpio_sim_strdup_trimmed(page, count);
1161 mutex_unlock(&dev->lock);
1166 line->name = trimmed;
1168 mutex_unlock(&dev->lock);
1173 CONFIGFS_ATTR(gpio_sim_line_config_, name);
1175 static struct configfs_attribute *gpio_sim_line_config_attrs[] = {
1176 &gpio_sim_line_config_attr_name,
1180 static ssize_t gpio_sim_hog_config_name_show(struct config_item *item,
1183 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1184 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1187 mutex_lock(&dev->lock);
1188 ret = sprintf(page, "%s\n", hog->name ?: "");
1189 mutex_unlock(&dev->lock);
1194 static ssize_t gpio_sim_hog_config_name_store(struct config_item *item,
1195 const char *page, size_t count)
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);
1203 if (gpio_sim_device_is_live_unlocked(dev)) {
1204 mutex_unlock(&dev->lock);
1208 trimmed = gpio_sim_strdup_trimmed(page, count);
1210 mutex_unlock(&dev->lock);
1215 hog->name = trimmed;
1217 mutex_unlock(&dev->lock);
1222 CONFIGFS_ATTR(gpio_sim_hog_config_, name);
1224 static ssize_t gpio_sim_hog_config_direction_show(struct config_item *item,
1227 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1228 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1232 mutex_lock(&dev->lock);
1234 mutex_unlock(&dev->lock);
1240 case GPIOD_OUT_HIGH:
1241 repr = "output-high";
1244 repr = "output-low";
1247 /* This would be a programmer bug. */
1248 WARN(1, "Unexpected hog direction value: %d", dir);
1252 return sprintf(page, "%s\n", repr);
1256 gpio_sim_hog_config_direction_store(struct config_item *item,
1257 const char *page, size_t count)
1259 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1260 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1264 mutex_lock(&dev->lock);
1266 if (gpio_sim_device_is_live_unlocked(dev)) {
1267 mutex_unlock(&dev->lock);
1271 trimmed = gpio_sim_strdup_trimmed(page, count);
1273 mutex_unlock(&dev->lock);
1277 if (strcmp(trimmed, "input") == 0)
1279 else if (strcmp(trimmed, "output-high") == 0)
1280 dir = GPIOD_OUT_HIGH;
1281 else if (strcmp(trimmed, "output-low") == 0)
1282 dir = GPIOD_OUT_LOW;
1289 mutex_unlock(&dev->lock);
1295 mutex_unlock(&dev->lock);
1300 CONFIGFS_ATTR(gpio_sim_hog_config_, direction);
1302 static struct configfs_attribute *gpio_sim_hog_config_attrs[] = {
1303 &gpio_sim_hog_config_attr_name,
1304 &gpio_sim_hog_config_attr_direction,
1308 static void gpio_sim_hog_config_item_release(struct config_item *item)
1310 struct gpio_sim_hog *hog = to_gpio_sim_hog(item);
1311 struct gpio_sim_line *line = hog->parent;
1312 struct gpio_sim_device *dev = gpio_sim_hog_get_device(hog);
1314 mutex_lock(&dev->lock);
1316 mutex_unlock(&dev->lock);
1322 static struct configfs_item_operations gpio_sim_hog_config_item_ops = {
1323 .release = gpio_sim_hog_config_item_release,
1326 static const struct config_item_type gpio_sim_hog_config_type = {
1327 .ct_item_ops = &gpio_sim_hog_config_item_ops,
1328 .ct_attrs = gpio_sim_hog_config_attrs,
1329 .ct_owner = THIS_MODULE,
1332 static struct config_item *
1333 gpio_sim_line_config_make_hog_item(struct config_group *group, const char *name)
1335 struct gpio_sim_line *line = to_gpio_sim_line(&group->cg_item);
1336 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1337 struct gpio_sim_hog *hog;
1339 if (strcmp(name, "hog") != 0)
1340 return ERR_PTR(-EINVAL);
1342 mutex_lock(&dev->lock);
1344 hog = kzalloc(sizeof(*hog), GFP_KERNEL);
1346 mutex_unlock(&dev->lock);
1347 return ERR_PTR(-ENOMEM);
1350 config_item_init_type_name(&hog->item, name,
1351 &gpio_sim_hog_config_type);
1353 hog->dir = GPIOD_IN;
1358 mutex_unlock(&dev->lock);
1363 static void gpio_sim_line_config_group_release(struct config_item *item)
1365 struct gpio_sim_line *line = to_gpio_sim_line(item);
1366 struct gpio_sim_device *dev = gpio_sim_line_get_device(line);
1368 mutex_lock(&dev->lock);
1369 list_del(&line->siblings);
1370 mutex_unlock(&dev->lock);
1376 static struct configfs_item_operations gpio_sim_line_config_item_ops = {
1377 .release = gpio_sim_line_config_group_release,
1380 static struct configfs_group_operations gpio_sim_line_config_group_ops = {
1381 .make_item = gpio_sim_line_config_make_hog_item,
1384 static const struct config_item_type gpio_sim_line_config_type = {
1385 .ct_item_ops = &gpio_sim_line_config_item_ops,
1386 .ct_group_ops = &gpio_sim_line_config_group_ops,
1387 .ct_attrs = gpio_sim_line_config_attrs,
1388 .ct_owner = THIS_MODULE,
1391 static struct config_group *
1392 gpio_sim_bank_config_make_line_group(struct config_group *group,
1395 struct gpio_sim_bank *bank = to_gpio_sim_bank(&group->cg_item);
1396 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1397 struct gpio_sim_line *line;
1398 unsigned int offset;
1401 ret = sscanf(name, "line%u%n", &offset, &nchar);
1402 if (ret != 1 || nchar != strlen(name))
1403 return ERR_PTR(-EINVAL);
1405 mutex_lock(&dev->lock);
1407 if (gpio_sim_device_is_live_unlocked(dev)) {
1408 mutex_unlock(&dev->lock);
1409 return ERR_PTR(-EBUSY);
1412 line = kzalloc(sizeof(*line), GFP_KERNEL);
1414 mutex_unlock(&dev->lock);
1415 return ERR_PTR(-ENOMEM);
1418 config_group_init_type_name(&line->group, name,
1419 &gpio_sim_line_config_type);
1421 line->parent = bank;
1422 line->offset = offset;
1423 list_add_tail(&line->siblings, &bank->line_list);
1425 mutex_unlock(&dev->lock);
1427 return &line->group;
1430 static void gpio_sim_bank_config_group_release(struct config_item *item)
1432 struct gpio_sim_bank *bank = to_gpio_sim_bank(item);
1433 struct gpio_sim_device *dev = gpio_sim_bank_get_device(bank);
1435 mutex_lock(&dev->lock);
1436 list_del(&bank->siblings);
1437 mutex_unlock(&dev->lock);
1443 static struct configfs_item_operations gpio_sim_bank_config_item_ops = {
1444 .release = gpio_sim_bank_config_group_release,
1447 static struct configfs_group_operations gpio_sim_bank_config_group_ops = {
1448 .make_group = gpio_sim_bank_config_make_line_group,
1451 static const struct config_item_type gpio_sim_bank_config_group_type = {
1452 .ct_item_ops = &gpio_sim_bank_config_item_ops,
1453 .ct_group_ops = &gpio_sim_bank_config_group_ops,
1454 .ct_attrs = gpio_sim_bank_config_attrs,
1455 .ct_owner = THIS_MODULE,
1458 static struct config_group *
1459 gpio_sim_device_config_make_bank_group(struct config_group *group,
1462 struct gpio_sim_device *dev = to_gpio_sim_device(&group->cg_item);
1463 struct gpio_sim_bank *bank;
1465 mutex_lock(&dev->lock);
1467 if (gpio_sim_device_is_live_unlocked(dev)) {
1468 mutex_unlock(&dev->lock);
1469 return ERR_PTR(-EBUSY);
1472 bank = kzalloc(sizeof(*bank), GFP_KERNEL);
1474 mutex_unlock(&dev->lock);
1475 return ERR_PTR(-ENOMEM);
1478 config_group_init_type_name(&bank->group, name,
1479 &gpio_sim_bank_config_group_type);
1480 bank->num_lines = 1;
1482 INIT_LIST_HEAD(&bank->line_list);
1483 list_add_tail(&bank->siblings, &dev->bank_list);
1485 mutex_unlock(&dev->lock);
1487 return &bank->group;
1490 static void gpio_sim_device_config_group_release(struct config_item *item)
1492 struct gpio_sim_device *dev = to_gpio_sim_device(item);
1494 mutex_lock(&dev->lock);
1495 if (gpio_sim_device_is_live_unlocked(dev))
1496 gpio_sim_device_deactivate_unlocked(dev);
1497 mutex_unlock(&dev->lock);
1499 mutex_destroy(&dev->lock);
1500 ida_free(&gpio_sim_ida, dev->id);
1504 static struct configfs_item_operations gpio_sim_device_config_item_ops = {
1505 .release = gpio_sim_device_config_group_release,
1508 static struct configfs_group_operations gpio_sim_device_config_group_ops = {
1509 .make_group = gpio_sim_device_config_make_bank_group,
1512 static const struct config_item_type gpio_sim_device_config_group_type = {
1513 .ct_item_ops = &gpio_sim_device_config_item_ops,
1514 .ct_group_ops = &gpio_sim_device_config_group_ops,
1515 .ct_attrs = gpio_sim_device_config_attrs,
1516 .ct_owner = THIS_MODULE,
1519 static struct config_group *
1520 gpio_sim_config_make_device_group(struct config_group *group, const char *name)
1522 struct gpio_sim_device *dev;
1525 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1527 return ERR_PTR(-ENOMEM);
1529 id = ida_alloc(&gpio_sim_ida, GFP_KERNEL);
1535 config_group_init_type_name(&dev->group, name,
1536 &gpio_sim_device_config_group_type);
1538 mutex_init(&dev->lock);
1539 INIT_LIST_HEAD(&dev->bank_list);
1541 dev->bus_notifier.notifier_call = gpio_sim_bus_notifier_call;
1542 init_completion(&dev->probe_completion);
1547 static struct configfs_group_operations gpio_sim_config_group_ops = {
1548 .make_group = gpio_sim_config_make_device_group,
1551 static const struct config_item_type gpio_sim_config_type = {
1552 .ct_group_ops = &gpio_sim_config_group_ops,
1553 .ct_owner = THIS_MODULE,
1556 static struct configfs_subsystem gpio_sim_config_subsys = {
1559 .ci_namebuf = "gpio-sim",
1560 .ci_type = &gpio_sim_config_type,
1565 static int __init gpio_sim_init(void)
1569 ret = platform_driver_register(&gpio_sim_driver);
1571 pr_err("Error %d while registering the platform driver\n", ret);
1575 config_group_init(&gpio_sim_config_subsys.su_group);
1576 mutex_init(&gpio_sim_config_subsys.su_mutex);
1577 ret = configfs_register_subsystem(&gpio_sim_config_subsys);
1579 pr_err("Error %d while registering the configfs subsystem %s\n",
1580 ret, gpio_sim_config_subsys.su_group.cg_item.ci_namebuf);
1581 mutex_destroy(&gpio_sim_config_subsys.su_mutex);
1582 platform_driver_unregister(&gpio_sim_driver);
1588 module_init(gpio_sim_init);
1590 static void __exit gpio_sim_exit(void)
1592 configfs_unregister_subsystem(&gpio_sim_config_subsys);
1593 mutex_destroy(&gpio_sim_config_subsys.su_mutex);
1594 platform_driver_unregister(&gpio_sim_driver);
1596 module_exit(gpio_sim_exit);
1599 MODULE_DESCRIPTION("GPIO Simulator Module");
1600 MODULE_LICENSE("GPL");