1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Turris Mox module configuration bus driver
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2019 Marek Behun <marek.behun@nic.cz>
6*4882a593Smuzhiyun */
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun #ifndef __LINUX_MOXTET_H
9*4882a593Smuzhiyun #define __LINUX_MOXTET_H
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/device.h>
12*4882a593Smuzhiyun #include <linux/irq.h>
13*4882a593Smuzhiyun #include <linux/irqdomain.h>
14*4882a593Smuzhiyun #include <linux/mutex.h>
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun #define TURRIS_MOX_MAX_MODULES 10
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun enum turris_mox_cpu_module_id {
19*4882a593Smuzhiyun TURRIS_MOX_CPU_ID_EMMC = 0x00,
20*4882a593Smuzhiyun TURRIS_MOX_CPU_ID_SD = 0x10,
21*4882a593Smuzhiyun };
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun enum turris_mox_module_id {
24*4882a593Smuzhiyun TURRIS_MOX_MODULE_FIRST = 0x01,
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun TURRIS_MOX_MODULE_SFP = 0x01,
27*4882a593Smuzhiyun TURRIS_MOX_MODULE_PCI = 0x02,
28*4882a593Smuzhiyun TURRIS_MOX_MODULE_TOPAZ = 0x03,
29*4882a593Smuzhiyun TURRIS_MOX_MODULE_PERIDOT = 0x04,
30*4882a593Smuzhiyun TURRIS_MOX_MODULE_USB3 = 0x05,
31*4882a593Smuzhiyun TURRIS_MOX_MODULE_PCI_BRIDGE = 0x06,
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun TURRIS_MOX_MODULE_LAST = 0x06,
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun #define MOXTET_NIRQS 16
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun extern struct bus_type moxtet_type;
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun struct moxtet {
41*4882a593Smuzhiyun struct device *dev;
42*4882a593Smuzhiyun struct mutex lock;
43*4882a593Smuzhiyun u8 modules[TURRIS_MOX_MAX_MODULES];
44*4882a593Smuzhiyun int count;
45*4882a593Smuzhiyun u8 tx[TURRIS_MOX_MAX_MODULES];
46*4882a593Smuzhiyun int dev_irq;
47*4882a593Smuzhiyun struct {
48*4882a593Smuzhiyun struct irq_domain *domain;
49*4882a593Smuzhiyun struct irq_chip chip;
50*4882a593Smuzhiyun unsigned long masked, exists;
51*4882a593Smuzhiyun struct moxtet_irqpos {
52*4882a593Smuzhiyun u8 idx;
53*4882a593Smuzhiyun u8 bit;
54*4882a593Smuzhiyun } position[MOXTET_NIRQS];
55*4882a593Smuzhiyun } irq;
56*4882a593Smuzhiyun #ifdef CONFIG_DEBUG_FS
57*4882a593Smuzhiyun struct dentry *debugfs_root;
58*4882a593Smuzhiyun #endif
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun struct moxtet_driver {
62*4882a593Smuzhiyun const enum turris_mox_module_id *id_table;
63*4882a593Smuzhiyun struct device_driver driver;
64*4882a593Smuzhiyun };
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun static inline struct moxtet_driver *
to_moxtet_driver(struct device_driver * drv)67*4882a593Smuzhiyun to_moxtet_driver(struct device_driver *drv)
68*4882a593Smuzhiyun {
69*4882a593Smuzhiyun if (!drv)
70*4882a593Smuzhiyun return NULL;
71*4882a593Smuzhiyun return container_of(drv, struct moxtet_driver, driver);
72*4882a593Smuzhiyun }
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun extern int __moxtet_register_driver(struct module *owner,
75*4882a593Smuzhiyun struct moxtet_driver *mdrv);
76*4882a593Smuzhiyun
moxtet_unregister_driver(struct moxtet_driver * mdrv)77*4882a593Smuzhiyun static inline void moxtet_unregister_driver(struct moxtet_driver *mdrv)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun if (mdrv)
80*4882a593Smuzhiyun driver_unregister(&mdrv->driver);
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun #define moxtet_register_driver(driver) \
84*4882a593Smuzhiyun __moxtet_register_driver(THIS_MODULE, driver)
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun #define module_moxtet_driver(__moxtet_driver) \
87*4882a593Smuzhiyun module_driver(__moxtet_driver, moxtet_register_driver, \
88*4882a593Smuzhiyun moxtet_unregister_driver)
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun struct moxtet_device {
91*4882a593Smuzhiyun struct device dev;
92*4882a593Smuzhiyun struct moxtet *moxtet;
93*4882a593Smuzhiyun enum turris_mox_module_id id;
94*4882a593Smuzhiyun unsigned int idx;
95*4882a593Smuzhiyun };
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun extern int moxtet_device_read(struct device *dev);
98*4882a593Smuzhiyun extern int moxtet_device_write(struct device *dev, u8 val);
99*4882a593Smuzhiyun extern int moxtet_device_written(struct device *dev);
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun static inline struct moxtet_device *
to_moxtet_device(struct device * dev)102*4882a593Smuzhiyun to_moxtet_device(struct device *dev)
103*4882a593Smuzhiyun {
104*4882a593Smuzhiyun if (!dev)
105*4882a593Smuzhiyun return NULL;
106*4882a593Smuzhiyun return container_of(dev, struct moxtet_device, dev);
107*4882a593Smuzhiyun }
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun #endif /* __LINUX_MOXTET_H */
110