moxtet.h

  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
 64#define to_moxtet_driver(__drv)	\
 65	( __drv ? container_of_const(__drv, struct moxtet_driver, driver) : NULL )
 66
 67extern int __moxtet_register_driver(struct module *owner,
 68				    struct moxtet_driver *mdrv);
 69
 70static inline void moxtet_unregister_driver(struct moxtet_driver *mdrv)
 71{
 72	if (mdrv)
 73		driver_unregister(&mdrv->driver);
 74}
 75
 76#define moxtet_register_driver(driver) \
 77	__moxtet_register_driver(THIS_MODULE, driver)
 78
 79#define module_moxtet_driver(__moxtet_driver) \
 80	module_driver(__moxtet_driver, moxtet_register_driver, \
 81			moxtet_unregister_driver)
 82
 83struct moxtet_device {
 84	struct device			dev;
 85	struct moxtet			*moxtet;
 86	enum turris_mox_module_id	id;
 87	unsigned int			idx;
 88};
 89
 90extern int moxtet_device_read(struct device *dev);
 91extern int moxtet_device_write(struct device *dev, u8 val);
 92extern int moxtet_device_written(struct device *dev);
 93
 94static inline struct moxtet_device *
 95to_moxtet_device(struct device *dev)
 96{
 97	if (!dev)
 98		return NULL;
 99	return container_of(dev, struct moxtet_device, dev);
100}
101
102#endif /* __LINUX_MOXTET_H */