include/linux/mcb.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * MEN Chameleon Bus.
0004  *
0005  * Copyright (C) 2014 MEN Mikroelektronik GmbH (www.men.de)
0006  * Author: Johannes Thumshirn <johannes.thumshirn@men.de>
0007  */
0008 #ifndef _LINUX_MCB_H
0009 #define _LINUX_MCB_H
0010
0011 #include <linux/mod_devicetable.h>
0012 #include <linux/device.h>
0013 #include <linux/irqreturn.h>
0014
0015 #define CHAMELEON_FILENAME_LEN 12
0016
0017 struct mcb_driver;
0018 struct mcb_device;
0019
0020 /**
0021  * struct mcb_bus - MEN Chameleon Bus
0022  *
0023  * @dev: bus device
0024  * @carrier: pointer to carrier device
0025  * @bus_nr: mcb bus number
0026  * @get_irq: callback to get IRQ number
0027  * @revision: the FPGA's revision number
0028  * @model: the FPGA's model number
0029  * @filename: the FPGA's name
0030  */
0031 struct mcb_bus {
0032     struct device dev;
0033     struct device *carrier;
0034     int bus_nr;
0035     u8 revision;
0036     char model;
0037     u8 minor;
0038     char name[CHAMELEON_FILENAME_LEN + 1];
0039     int (*get_irq)(struct mcb_device *dev);
0040 };
0041
0042 static inline struct mcb_bus *to_mcb_bus(struct device *dev)
0043 {
0044     return container_of(dev, struct mcb_bus, dev);
0045 }
0046
0047 /**
0048  * struct mcb_device - MEN Chameleon Bus device
0049  *
0050  * @dev: device in kernel representation
0051  * @bus: mcb bus the device is plugged to
0052  * @is_added: flag to check if device is added to bus
0053  * @driver: associated mcb_driver
0054  * @id: mcb device id
0055  * @inst: instance in Chameleon table
0056  * @group: group in Chameleon table
0057  * @var: variant in Chameleon table
0058  * @bar: BAR in Chameleon table
0059  * @rev: revision in Chameleon table
0060  * @irq: IRQ resource
0061  * @memory: memory resource
0062  */
0063 struct mcb_device {
0064     struct device dev;
0065     struct mcb_bus *bus;
0066     bool is_added;
0067     struct mcb_driver *driver;
0068     u16 id;
0069     int inst;
0070     int group;
0071     int var;
0072     int bar;
0073     int rev;
0074     struct resource irq;
0075     struct resource mem;
0076     struct device *dma_dev;
0077 };
0078
0079 static inline struct mcb_device *to_mcb_device(struct device *dev)
0080 {
0081     return container_of(dev, struct mcb_device, dev);
0082 }
0083
0084 /**
0085  * struct mcb_driver - MEN Chameleon Bus device driver
0086  *
0087  * @driver: device_driver
0088  * @id_table: mcb id table
0089  * @probe: probe callback
0090  * @remove: remove callback
0091  * @shutdown: shutdown callback
0092  */
0093 struct mcb_driver {
0094     struct device_driver driver;
0095     const struct mcb_device_id *id_table;
0096     int (*probe)(struct mcb_device *mdev, const struct mcb_device_id *id);
0097     void (*remove)(struct mcb_device *mdev);
0098     void (*shutdown)(struct mcb_device *mdev);
0099 };
0100
0101 static inline struct mcb_driver *to_mcb_driver(struct device_driver *drv)
0102 {
0103     return container_of(drv, struct mcb_driver, driver);
0104 }
0105
0106 static inline void *mcb_get_drvdata(struct mcb_device *dev)
0107 {
0108     return dev_get_drvdata(&dev->dev);
0109 }
0110
0111 static inline void mcb_set_drvdata(struct mcb_device *dev, void *data)
0112 {
0113     dev_set_drvdata(&dev->dev, data);
0114 }
0115
0116 extern int __must_check __mcb_register_driver(struct mcb_driver *drv,
0117                     struct module *owner,
0118                     const char *mod_name);
0119 #define mcb_register_driver(driver)     \
0120     __mcb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
0121 extern void mcb_unregister_driver(struct mcb_driver *driver);
0122 #define module_mcb_driver(__mcb_driver)     \
0123     module_driver(__mcb_driver, mcb_register_driver, mcb_unregister_driver)
0124 extern void mcb_bus_add_devices(const struct mcb_bus *bus);
0125 extern int mcb_device_register(struct mcb_bus *bus, struct mcb_device *dev);
0126 extern struct mcb_bus *mcb_alloc_bus(struct device *carrier);
0127 extern struct mcb_bus *mcb_bus_get(struct mcb_bus *bus);
0128 extern void mcb_bus_put(struct mcb_bus *bus);
0129 extern struct mcb_device *mcb_alloc_dev(struct mcb_bus *bus);
0130 extern void mcb_free_dev(struct mcb_device *dev);
0131 extern void mcb_release_bus(struct mcb_bus *bus);
0132 extern struct resource *mcb_request_mem(struct mcb_device *dev,
0133                     const char *name);
0134 extern void mcb_release_mem(struct resource *mem);
0135 extern int mcb_get_irq(struct mcb_device *dev);
0136 extern struct resource *mcb_get_resource(struct mcb_device *dev,
0137                      unsigned int type);
0138
0139 #endif /* _LINUX_MCB_H */