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