1 // SPDX-License-Identifier: GPL-2.0
3 * Turris Mox module configuration bus driver
5 * Copyright (C) 2019 Marek Behun <marek.behun@nic.cz>
8 #include <dt-bindings/bus/moxtet.h>
9 #include <linux/bitops.h>
10 #include <linux/debugfs.h>
11 #include <linux/interrupt.h>
12 #include <linux/module.h>
13 #include <linux/moxtet.h>
14 #include <linux/mutex.h>
15 #include <linux/of_device.h>
16 #include <linux/of_irq.h>
17 #include <linux/spi/spi.h>
20 * @name: module name for sysfs
21 * @hwirq_base: base index for IRQ for this module (-1 if no IRQs)
22 * @nirqs: how many interrupts does the shift register provide
23 * @desc: module description for kernel log
30 } mox_module_table
[] = {
31 /* do not change order of this array! */
33 { "sfp", -1, 0, "MOX D (SFP cage)" },
34 { "pci", MOXTET_IRQ_PCI
, 1, "MOX B (Mini-PCIe)" },
35 { "topaz", MOXTET_IRQ_TOPAZ
, 1, "MOX C (4 port switch)" },
36 { "peridot", MOXTET_IRQ_PERIDOT(0), 1, "MOX E (8 port switch)" },
37 { "usb3", MOXTET_IRQ_USB3
, 2, "MOX F (USB 3.0)" },
38 { "pci-bridge", -1, 0, "MOX G (Mini-PCIe bridge)" },
41 static inline bool mox_module_known(unsigned int id
)
43 return id
>= TURRIS_MOX_MODULE_FIRST
&& id
<= TURRIS_MOX_MODULE_LAST
;
46 static inline const char *mox_module_name(unsigned int id
)
48 if (mox_module_known(id
))
49 return mox_module_table
[id
].name
;
54 #define DEF_MODULE_ATTR(name, fmt, ...) \
56 module_##name##_show(struct device *dev, struct device_attribute *a, \
59 struct moxtet_device *mdev = to_moxtet_device(dev); \
60 return sprintf(buf, (fmt), __VA_ARGS__); \
62 static DEVICE_ATTR_RO(module_##name)
64 DEF_MODULE_ATTR(id
, "0x%x\n", mdev
->id
);
65 DEF_MODULE_ATTR(name
, "%s\n", mox_module_name(mdev
->id
));
66 DEF_MODULE_ATTR(description
, "%s\n",
67 mox_module_known(mdev
->id
) ? mox_module_table
[mdev
->id
].desc
70 static struct attribute
*moxtet_dev_attrs
[] = {
71 &dev_attr_module_id
.attr
,
72 &dev_attr_module_name
.attr
,
73 &dev_attr_module_description
.attr
,
77 static const struct attribute_group moxtet_dev_group
= {
78 .attrs
= moxtet_dev_attrs
,
81 static const struct attribute_group
*moxtet_dev_groups
[] = {
86 static int moxtet_match(struct device
*dev
, struct device_driver
*drv
)
88 struct moxtet_device
*mdev
= to_moxtet_device(dev
);
89 struct moxtet_driver
*tdrv
= to_moxtet_driver(drv
);
90 const enum turris_mox_module_id
*t
;
92 if (of_driver_match_device(dev
, drv
))
98 for (t
= tdrv
->id_table
; *t
; ++t
)
105 static struct bus_type moxtet_bus_type
= {
107 .dev_groups
= moxtet_dev_groups
,
108 .match
= moxtet_match
,
111 int __moxtet_register_driver(struct module
*owner
,
112 struct moxtet_driver
*mdrv
)
114 mdrv
->driver
.owner
= owner
;
115 mdrv
->driver
.bus
= &moxtet_bus_type
;
116 return driver_register(&mdrv
->driver
);
118 EXPORT_SYMBOL_GPL(__moxtet_register_driver
);
120 static int moxtet_dev_check(struct device
*dev
, void *data
)
122 struct moxtet_device
*mdev
= to_moxtet_device(dev
);
123 struct moxtet_device
*new_dev
= data
;
125 if (mdev
->moxtet
== new_dev
->moxtet
&& mdev
->id
== new_dev
->id
&&
126 mdev
->idx
== new_dev
->idx
)
131 static void moxtet_dev_release(struct device
*dev
)
133 struct moxtet_device
*mdev
= to_moxtet_device(dev
);
135 put_device(mdev
->moxtet
->dev
);
139 static struct moxtet_device
*
140 moxtet_alloc_device(struct moxtet
*moxtet
)
142 struct moxtet_device
*dev
;
144 if (!get_device(moxtet
->dev
))
147 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
149 put_device(moxtet
->dev
);
153 dev
->moxtet
= moxtet
;
154 dev
->dev
.parent
= moxtet
->dev
;
155 dev
->dev
.bus
= &moxtet_bus_type
;
156 dev
->dev
.release
= moxtet_dev_release
;
158 device_initialize(&dev
->dev
);
163 static int moxtet_add_device(struct moxtet_device
*dev
)
165 static DEFINE_MUTEX(add_mutex
);
168 if (dev
->idx
>= TURRIS_MOX_MAX_MODULES
|| dev
->id
> 0xf)
171 dev_set_name(&dev
->dev
, "moxtet-%s.%u", mox_module_name(dev
->id
),
174 mutex_lock(&add_mutex
);
176 ret
= bus_for_each_dev(&moxtet_bus_type
, NULL
, dev
,
181 ret
= device_add(&dev
->dev
);
183 dev_err(dev
->moxtet
->dev
, "can't add %s, status %d\n",
184 dev_name(dev
->moxtet
->dev
), ret
);
187 mutex_unlock(&add_mutex
);
191 static int __unregister(struct device
*dev
, void *null
)
194 of_node_clear_flag(dev
->of_node
, OF_POPULATED
);
195 of_node_put(dev
->of_node
);
198 device_unregister(dev
);
203 static struct moxtet_device
*
204 of_register_moxtet_device(struct moxtet
*moxtet
, struct device_node
*nc
)
206 struct moxtet_device
*dev
;
210 dev
= moxtet_alloc_device(moxtet
);
213 "Moxtet device alloc error for %pOF\n", nc
);
214 return ERR_PTR(-ENOMEM
);
217 ret
= of_property_read_u32(nc
, "reg", &val
);
219 dev_err(moxtet
->dev
, "%pOF has no valid 'reg' property (%d)\n",
226 if (dev
->idx
>= TURRIS_MOX_MAX_MODULES
) {
227 dev_err(moxtet
->dev
, "%pOF Moxtet address 0x%x out of range\n",
233 dev
->id
= moxtet
->modules
[dev
->idx
];
236 dev_err(moxtet
->dev
, "%pOF Moxtet address 0x%x is empty\n", nc
,
243 dev
->dev
.of_node
= nc
;
245 ret
= moxtet_add_device(dev
);
248 "Moxtet device register error for %pOF\n", nc
);
256 put_device(&dev
->dev
);
260 static void of_register_moxtet_devices(struct moxtet
*moxtet
)
262 struct moxtet_device
*dev
;
263 struct device_node
*nc
;
265 if (!moxtet
->dev
->of_node
)
268 for_each_available_child_of_node(moxtet
->dev
->of_node
, nc
) {
269 if (of_node_test_and_set_flag(nc
, OF_POPULATED
))
271 dev
= of_register_moxtet_device(moxtet
, nc
);
273 dev_warn(moxtet
->dev
,
274 "Failed to create Moxtet device for %pOF\n",
276 of_node_clear_flag(nc
, OF_POPULATED
);
282 moxtet_register_devices_from_topology(struct moxtet
*moxtet
)
284 struct moxtet_device
*dev
;
287 for (i
= 0; i
< moxtet
->count
; ++i
) {
288 dev
= moxtet_alloc_device(moxtet
);
290 dev_err(moxtet
->dev
, "Moxtet device %u alloc error\n",
296 dev
->id
= moxtet
->modules
[i
];
298 ret
= moxtet_add_device(dev
);
299 if (ret
&& ret
!= -EBUSY
) {
300 put_device(&dev
->dev
);
302 "Moxtet device %u register error: %i\n", i
,
309 * @nsame: how many modules with same id are already in moxtet->modules
311 static int moxtet_set_irq(struct moxtet
*moxtet
, int idx
, int id
, int nsame
)
314 struct moxtet_irqpos
*pos
;
316 first
= mox_module_table
[id
].hwirq_base
+
317 nsame
* mox_module_table
[id
].nirqs
;
319 if (first
+ mox_module_table
[id
].nirqs
> MOXTET_NIRQS
)
322 for (i
= 0; i
< mox_module_table
[id
].nirqs
; ++i
) {
323 pos
= &moxtet
->irq
.position
[first
+ i
];
326 moxtet
->irq
.exists
|= BIT(first
+ i
);
332 static int moxtet_find_topology(struct moxtet
*moxtet
)
334 u8 buf
[TURRIS_MOX_MAX_MODULES
];
335 int cnts
[TURRIS_MOX_MODULE_LAST
];
338 memset(cnts
, 0, sizeof(cnts
));
340 ret
= spi_read(to_spi_device(moxtet
->dev
), buf
, TURRIS_MOX_MAX_MODULES
);
344 if (buf
[0] == TURRIS_MOX_CPU_ID_EMMC
) {
345 dev_info(moxtet
->dev
, "Found MOX A (eMMC CPU) module\n");
346 } else if (buf
[0] == TURRIS_MOX_CPU_ID_SD
) {
347 dev_info(moxtet
->dev
, "Found MOX A (CPU) module\n");
349 dev_err(moxtet
->dev
, "Invalid Turris MOX A CPU module 0x%02x\n",
356 for (i
= 1; i
< TURRIS_MOX_MAX_MODULES
; ++i
) {
364 moxtet
->modules
[i
-1] = id
;
367 if (mox_module_known(id
)) {
368 dev_info(moxtet
->dev
, "Found %s module\n",
369 mox_module_table
[id
].desc
);
371 if (moxtet_set_irq(moxtet
, i
-1, id
, cnts
[id
]++) < 0)
373 " Cannot set IRQ for module %s\n",
374 mox_module_table
[id
].desc
);
376 dev_warn(moxtet
->dev
,
377 "Unknown Moxtet module found (ID 0x%02x)\n",
385 static int moxtet_spi_read(struct moxtet
*moxtet
, u8
*buf
)
387 struct spi_transfer xfer
= {
389 .tx_buf
= moxtet
->tx
,
390 .len
= moxtet
->count
+ 1
394 mutex_lock(&moxtet
->lock
);
396 ret
= spi_sync_transfer(to_spi_device(moxtet
->dev
), &xfer
, 1);
398 mutex_unlock(&moxtet
->lock
);
403 int moxtet_device_read(struct device
*dev
)
405 struct moxtet_device
*mdev
= to_moxtet_device(dev
);
406 struct moxtet
*moxtet
= mdev
->moxtet
;
407 u8 buf
[TURRIS_MOX_MAX_MODULES
];
410 if (mdev
->idx
>= moxtet
->count
)
413 ret
= moxtet_spi_read(moxtet
, buf
);
417 return buf
[mdev
->idx
+ 1] >> 4;
419 EXPORT_SYMBOL_GPL(moxtet_device_read
);
421 int moxtet_device_write(struct device
*dev
, u8 val
)
423 struct moxtet_device
*mdev
= to_moxtet_device(dev
);
424 struct moxtet
*moxtet
= mdev
->moxtet
;
427 if (mdev
->idx
>= moxtet
->count
)
430 mutex_lock(&moxtet
->lock
);
432 moxtet
->tx
[moxtet
->count
- mdev
->idx
] = val
;
434 ret
= spi_write(to_spi_device(moxtet
->dev
), moxtet
->tx
,
437 mutex_unlock(&moxtet
->lock
);
441 EXPORT_SYMBOL_GPL(moxtet_device_write
);
443 int moxtet_device_written(struct device
*dev
)
445 struct moxtet_device
*mdev
= to_moxtet_device(dev
);
446 struct moxtet
*moxtet
= mdev
->moxtet
;
448 if (mdev
->idx
>= moxtet
->count
)
451 return moxtet
->tx
[moxtet
->count
- mdev
->idx
];
453 EXPORT_SYMBOL_GPL(moxtet_device_written
);
455 #ifdef CONFIG_DEBUG_FS
456 static int moxtet_debug_open(struct inode
*inode
, struct file
*file
)
458 file
->private_data
= inode
->i_private
;
460 return nonseekable_open(inode
, file
);
463 static ssize_t
input_read(struct file
*file
, char __user
*buf
, size_t len
,
466 struct moxtet
*moxtet
= file
->private_data
;
467 u8 bin
[TURRIS_MOX_MAX_MODULES
];
468 u8 hex
[sizeof(bin
) * 2 + 1];
471 ret
= moxtet_spi_read(moxtet
, bin
);
475 n
= moxtet
->count
+ 1;
476 bin2hex(hex
, bin
, n
);
480 return simple_read_from_buffer(buf
, len
, ppos
, hex
, 2*n
+ 1);
483 static const struct file_operations input_fops
= {
484 .owner
= THIS_MODULE
,
485 .open
= moxtet_debug_open
,
490 static ssize_t
output_read(struct file
*file
, char __user
*buf
, size_t len
,
493 struct moxtet
*moxtet
= file
->private_data
;
494 u8 hex
[TURRIS_MOX_MAX_MODULES
* 2 + 1];
498 mutex_lock(&moxtet
->lock
);
500 for (i
= 0; i
< moxtet
->count
; ++i
)
501 p
= hex_byte_pack(p
, moxtet
->tx
[moxtet
->count
- i
]);
503 mutex_unlock(&moxtet
->lock
);
507 return simple_read_from_buffer(buf
, len
, ppos
, hex
, p
- hex
);
510 static ssize_t
output_write(struct file
*file
, const char __user
*buf
,
511 size_t len
, loff_t
*ppos
)
513 struct moxtet
*moxtet
= file
->private_data
;
514 u8 bin
[TURRIS_MOX_MAX_MODULES
];
515 u8 hex
[sizeof(bin
) * 2 + 1];
520 if (len
> 2 * moxtet
->count
+ 1 || len
< 2 * moxtet
->count
)
523 res
= simple_write_to_buffer(hex
, sizeof(hex
), &dummy
, buf
, len
);
527 if (len
% 2 == 1 && hex
[len
- 1] != '\n')
530 err
= hex2bin(bin
, hex
, moxtet
->count
);
534 mutex_lock(&moxtet
->lock
);
536 for (i
= 0; i
< moxtet
->count
; ++i
)
537 moxtet
->tx
[moxtet
->count
- i
] = bin
[i
];
539 err
= spi_write(to_spi_device(moxtet
->dev
), moxtet
->tx
,
542 mutex_unlock(&moxtet
->lock
);
544 return err
< 0 ? err
: len
;
547 static const struct file_operations output_fops
= {
548 .owner
= THIS_MODULE
,
549 .open
= moxtet_debug_open
,
551 .write
= output_write
,
555 static int moxtet_register_debugfs(struct moxtet
*moxtet
)
557 struct dentry
*root
, *entry
;
559 root
= debugfs_create_dir("moxtet", NULL
);
562 return PTR_ERR(root
);
564 entry
= debugfs_create_file_unsafe("input", 0444, root
, moxtet
,
569 entry
= debugfs_create_file_unsafe("output", 0644, root
, moxtet
,
574 moxtet
->debugfs_root
= root
;
578 debugfs_remove_recursive(root
);
579 return PTR_ERR(entry
);
582 static void moxtet_unregister_debugfs(struct moxtet
*moxtet
)
584 debugfs_remove_recursive(moxtet
->debugfs_root
);
587 static inline int moxtet_register_debugfs(struct moxtet
*moxtet
)
592 static inline void moxtet_unregister_debugfs(struct moxtet
*moxtet
)
597 static int moxtet_irq_domain_map(struct irq_domain
*d
, unsigned int irq
,
600 struct moxtet
*moxtet
= d
->host_data
;
602 if (hw
>= MOXTET_NIRQS
|| !(moxtet
->irq
.exists
& BIT(hw
))) {
603 dev_err(moxtet
->dev
, "Invalid hw irq number\n");
607 irq_set_chip_data(irq
, d
->host_data
);
608 irq_set_chip_and_handler(irq
, &moxtet
->irq
.chip
, handle_level_irq
);
613 static int moxtet_irq_domain_xlate(struct irq_domain
*d
,
614 struct device_node
*ctrlr
,
615 const u32
*intspec
, unsigned int intsize
,
616 unsigned long *out_hwirq
,
617 unsigned int *out_type
)
619 struct moxtet
*moxtet
= d
->host_data
;
622 if (WARN_ON(intsize
< 1))
627 if (irq
>= MOXTET_NIRQS
|| !(moxtet
->irq
.exists
& BIT(irq
)))
631 *out_type
= IRQ_TYPE_NONE
;
635 static const struct irq_domain_ops moxtet_irq_domain
= {
636 .map
= moxtet_irq_domain_map
,
637 .xlate
= moxtet_irq_domain_xlate
,
640 static void moxtet_irq_mask(struct irq_data
*d
)
642 struct moxtet
*moxtet
= irq_data_get_irq_chip_data(d
);
644 moxtet
->irq
.masked
|= BIT(d
->hwirq
);
647 static void moxtet_irq_unmask(struct irq_data
*d
)
649 struct moxtet
*moxtet
= irq_data_get_irq_chip_data(d
);
651 moxtet
->irq
.masked
&= ~BIT(d
->hwirq
);
654 static void moxtet_irq_print_chip(struct irq_data
*d
, struct seq_file
*p
)
656 struct moxtet
*moxtet
= irq_data_get_irq_chip_data(d
);
657 struct moxtet_irqpos
*pos
= &moxtet
->irq
.position
[d
->hwirq
];
660 id
= moxtet
->modules
[pos
->idx
];
662 seq_printf(p
, " moxtet-%s.%i#%i", mox_module_name(id
), pos
->idx
,
666 static const struct irq_chip moxtet_irq_chip
= {
668 .irq_mask
= moxtet_irq_mask
,
669 .irq_unmask
= moxtet_irq_unmask
,
670 .irq_print_chip
= moxtet_irq_print_chip
,
673 static int moxtet_irq_read(struct moxtet
*moxtet
, unsigned long *map
)
675 struct moxtet_irqpos
*pos
= moxtet
->irq
.position
;
676 u8 buf
[TURRIS_MOX_MAX_MODULES
];
679 ret
= moxtet_spi_read(moxtet
, buf
);
685 for_each_set_bit(i
, &moxtet
->irq
.exists
, MOXTET_NIRQS
) {
686 if (!(buf
[pos
[i
].idx
+ 1] & BIT(4 + pos
[i
].bit
)))
693 static irqreturn_t
moxtet_irq_thread_fn(int irq
, void *data
)
695 struct moxtet
*moxtet
= data
;
697 int nhandled
= 0, i
, sub_irq
, ret
;
699 ret
= moxtet_irq_read(moxtet
, &set
);
703 set
&= ~moxtet
->irq
.masked
;
706 for_each_set_bit(i
, &set
, MOXTET_NIRQS
) {
707 sub_irq
= irq_find_mapping(moxtet
->irq
.domain
, i
);
708 handle_nested_irq(sub_irq
);
709 dev_dbg(moxtet
->dev
, "%i irq\n", i
);
713 ret
= moxtet_irq_read(moxtet
, &set
);
717 set
&= ~moxtet
->irq
.masked
;
721 return (nhandled
> 0 ? IRQ_HANDLED
: IRQ_NONE
);
724 static void moxtet_irq_free(struct moxtet
*moxtet
)
728 for (i
= 0; i
< MOXTET_NIRQS
; ++i
) {
729 if (moxtet
->irq
.exists
& BIT(i
)) {
730 irq
= irq_find_mapping(moxtet
->irq
.domain
, i
);
731 irq_dispose_mapping(irq
);
735 irq_domain_remove(moxtet
->irq
.domain
);
738 static int moxtet_irq_setup(struct moxtet
*moxtet
)
742 moxtet
->irq
.domain
= irq_domain_add_simple(moxtet
->dev
->of_node
,
744 &moxtet_irq_domain
, moxtet
);
745 if (moxtet
->irq
.domain
== NULL
) {
746 dev_err(moxtet
->dev
, "Could not add IRQ domain\n");
750 for (i
= 0; i
< MOXTET_NIRQS
; ++i
)
751 if (moxtet
->irq
.exists
& BIT(i
))
752 irq_create_mapping(moxtet
->irq
.domain
, i
);
754 moxtet
->irq
.chip
= moxtet_irq_chip
;
755 moxtet
->irq
.masked
= ~0;
757 ret
= request_threaded_irq(moxtet
->dev_irq
, NULL
, moxtet_irq_thread_fn
,
758 IRQF_ONESHOT
, "moxtet", moxtet
);
765 moxtet_irq_free(moxtet
);
769 static int moxtet_probe(struct spi_device
*spi
)
771 struct moxtet
*moxtet
;
774 ret
= spi_setup(spi
);
778 moxtet
= devm_kzalloc(&spi
->dev
, sizeof(struct moxtet
),
783 moxtet
->dev
= &spi
->dev
;
784 spi_set_drvdata(spi
, moxtet
);
786 mutex_init(&moxtet
->lock
);
788 moxtet
->dev_irq
= of_irq_get(moxtet
->dev
->of_node
, 0);
789 if (moxtet
->dev_irq
== -EPROBE_DEFER
)
790 return -EPROBE_DEFER
;
792 if (moxtet
->dev_irq
<= 0) {
793 dev_err(moxtet
->dev
, "No IRQ resource found\n");
797 ret
= moxtet_find_topology(moxtet
);
801 if (moxtet
->irq
.exists
) {
802 ret
= moxtet_irq_setup(moxtet
);
807 of_register_moxtet_devices(moxtet
);
808 moxtet_register_devices_from_topology(moxtet
);
810 ret
= moxtet_register_debugfs(moxtet
);
812 dev_warn(moxtet
->dev
, "Failed creating debugfs entries: %i\n",
818 static int moxtet_remove(struct spi_device
*spi
)
820 struct moxtet
*moxtet
= spi_get_drvdata(spi
);
822 free_irq(moxtet
->dev_irq
, moxtet
);
824 moxtet_irq_free(moxtet
);
826 moxtet_unregister_debugfs(moxtet
);
828 device_for_each_child(moxtet
->dev
, NULL
, __unregister
);
830 mutex_destroy(&moxtet
->lock
);
835 static const struct of_device_id moxtet_dt_ids
[] = {
836 { .compatible
= "cznic,moxtet" },
839 MODULE_DEVICE_TABLE(of
, moxtet_dt_ids
);
841 static struct spi_driver moxtet_spi_driver
= {
844 .of_match_table
= moxtet_dt_ids
,
846 .probe
= moxtet_probe
,
847 .remove
= moxtet_remove
,
850 static int __init
moxtet_init(void)
854 ret
= bus_register(&moxtet_bus_type
);
856 pr_err("moxtet bus registration failed: %d\n", ret
);
860 ret
= spi_register_driver(&moxtet_spi_driver
);
862 pr_err("moxtet spi driver registration failed: %d\n", ret
);
869 bus_unregister(&moxtet_bus_type
);
873 postcore_initcall_sync(moxtet_init
);
875 static void __exit
moxtet_exit(void)
877 spi_unregister_driver(&moxtet_spi_driver
);
878 bus_unregister(&moxtet_bus_type
);
880 module_exit(moxtet_exit
);
882 MODULE_AUTHOR("Marek Behun <marek.behun@nic.cz>");
883 MODULE_DESCRIPTION("CZ.NIC's Turris Mox module configuration bus");
884 MODULE_LICENSE("GPL v2");