include/linux/vlynq.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * Copyright (C) 2006, 2007 Eugene Konev <ejka@openwrt.org>
0004  */
0005
0006 #ifndef __VLYNQ_H__
0007 #define __VLYNQ_H__
0008
0009 #include <linux/device.h>
0010 #include <linux/types.h>
0011
0012 struct module;
0013
0014 #define VLYNQ_NUM_IRQS 32
0015
0016 struct vlynq_mapping {
0017     u32 size;
0018     u32 offset;
0019 };
0020
0021 enum vlynq_divisor {
0022     vlynq_div_auto = 0,
0023     vlynq_ldiv1,
0024     vlynq_ldiv2,
0025     vlynq_ldiv3,
0026     vlynq_ldiv4,
0027     vlynq_ldiv5,
0028     vlynq_ldiv6,
0029     vlynq_ldiv7,
0030     vlynq_ldiv8,
0031     vlynq_rdiv1,
0032     vlynq_rdiv2,
0033     vlynq_rdiv3,
0034     vlynq_rdiv4,
0035     vlynq_rdiv5,
0036     vlynq_rdiv6,
0037     vlynq_rdiv7,
0038     vlynq_rdiv8,
0039     vlynq_div_external
0040 };
0041
0042 struct vlynq_device_id {
0043     u32 id;
0044     enum vlynq_divisor divisor;
0045     unsigned long driver_data;
0046 };
0047
0048 struct vlynq_regs;
0049 struct vlynq_device {
0050     u32 id, dev_id;
0051     int local_irq;
0052     int remote_irq;
0053     enum vlynq_divisor divisor;
0054     u32 regs_start, regs_end;
0055     u32 mem_start, mem_end;
0056     u32 irq_start, irq_end;
0057     int irq;
0058     int enabled;
0059     struct vlynq_regs *local;
0060     struct vlynq_regs *remote;
0061     struct device dev;
0062 };
0063
0064 struct vlynq_driver {
0065     char *name;
0066     struct vlynq_device_id *id_table;
0067     int (*probe)(struct vlynq_device *dev, struct vlynq_device_id *id);
0068     void (*remove)(struct vlynq_device *dev);
0069     struct device_driver driver;
0070 };
0071
0072 struct plat_vlynq_ops {
0073     int (*on)(struct vlynq_device *dev);
0074     void (*off)(struct vlynq_device *dev);
0075 };
0076
0077 static inline struct vlynq_driver *to_vlynq_driver(struct device_driver *drv)
0078 {
0079     return container_of(drv, struct vlynq_driver, driver);
0080 }
0081
0082 static inline struct vlynq_device *to_vlynq_device(struct device *device)
0083 {
0084     return container_of(device, struct vlynq_device, dev);
0085 }
0086
0087 extern struct bus_type vlynq_bus_type;
0088
0089 extern int __vlynq_register_driver(struct vlynq_driver *driver,
0090                    struct module *owner);
0091
0092 static inline int vlynq_register_driver(struct vlynq_driver *driver)
0093 {
0094     return __vlynq_register_driver(driver, THIS_MODULE);
0095 }
0096
0097 static inline void *vlynq_get_drvdata(struct vlynq_device *dev)
0098 {
0099     return dev_get_drvdata(&dev->dev);
0100 }
0101
0102 static inline void vlynq_set_drvdata(struct vlynq_device *dev, void *data)
0103 {
0104     dev_set_drvdata(&dev->dev, data);
0105 }
0106
0107 static inline u32 vlynq_mem_start(struct vlynq_device *dev)
0108 {
0109     return dev->mem_start;
0110 }
0111
0112 static inline u32 vlynq_mem_end(struct vlynq_device *dev)
0113 {
0114     return dev->mem_end;
0115 }
0116
0117 static inline u32 vlynq_mem_len(struct vlynq_device *dev)
0118 {
0119     return dev->mem_end - dev->mem_start + 1;
0120 }
0121
0122 static inline int vlynq_virq_to_irq(struct vlynq_device *dev, int virq)
0123 {
0124     int irq = dev->irq_start + virq;
0125     if ((irq < dev->irq_start) || (irq > dev->irq_end))
0126         return -EINVAL;
0127
0128     return irq;
0129 }
0130
0131 static inline int vlynq_irq_to_virq(struct vlynq_device *dev, int irq)
0132 {
0133     if ((irq < dev->irq_start) || (irq > dev->irq_end))
0134         return -EINVAL;
0135
0136     return irq - dev->irq_start;
0137 }
0138
0139 extern void vlynq_unregister_driver(struct vlynq_driver *driver);
0140 extern int vlynq_enable_device(struct vlynq_device *dev);
0141 extern void vlynq_disable_device(struct vlynq_device *dev);
0142 extern int vlynq_set_local_mapping(struct vlynq_device *dev, u32 tx_offset,
0143                    struct vlynq_mapping *mapping);
0144 extern int vlynq_set_remote_mapping(struct vlynq_device *dev, u32 tx_offset,
0145                     struct vlynq_mapping *mapping);
0146 extern int vlynq_set_local_irq(struct vlynq_device *dev, int virq);
0147 extern int vlynq_set_remote_irq(struct vlynq_device *dev, int virq);
0148
0149 #endif /* __VLYNQ_H__ */