1 /* 2 * MEN Chameleon Bus. 3 * 4 * Copyright (C) 2014 MEN Mikroelektronik GmbH (www.men.de) 5 * Author: Johannes Thumshirn <[email protected]> 6 * 7 * This program is free software; you can redistribute it and/or modify it 8 * under the terms of the GNU General Public License as published by the Free 9 * Software Foundation; version 2 of the License. 10 */ 11 #ifndef _LINUX_MCB_H 12 #define _LINUX_MCB_H 13 14 #include <linux/mod_devicetable.h> 15 #include <linux/device.h> 16 #include <linux/irqreturn.h> 17 18 struct mcb_driver; 19 struct mcb_device; 20 21 /** 22 * struct mcb_bus - MEN Chameleon Bus 23 * 24 * @dev: bus device 25 * @carrier: pointer to carrier device 26 * @bus_nr: mcb bus number 27 * @get_irq: callback to get IRQ number 28 */ 29 struct mcb_bus { 30 struct device dev; 31 struct device *carrier; 32 int bus_nr; 33 int (*get_irq)(struct mcb_device *dev); 34 }; 35 #define to_mcb_bus(b) container_of((b), struct mcb_bus, dev) 36 37 /** 38 * struct mcb_device - MEN Chameleon Bus device 39 * 40 * @bus_list: internal list handling for bus code 41 * @dev: device in kernel representation 42 * @bus: mcb bus the device is plugged to 43 * @subordinate: subordinate MCBus in case of bridge 44 * @is_added: flag to check if device is added to bus 45 * @driver: associated mcb_driver 46 * @id: mcb device id 47 * @inst: instance in Chameleon table 48 * @group: group in Chameleon table 49 * @var: variant in Chameleon table 50 * @bar: BAR in Chameleon table 51 * @rev: revision in Chameleon table 52 * @irq: IRQ resource 53 * @memory: memory resource 54 */ 55 struct mcb_device { 56 struct list_head bus_list; 57 struct device dev; 58 struct mcb_bus *bus; 59 struct mcb_bus *subordinate; 60 bool is_added; 61 struct mcb_driver *driver; 62 u16 id; 63 int inst; 64 int group; 65 int var; 66 int bar; 67 int rev; 68 struct resource irq; 69 struct resource mem; 70 }; 71 #define to_mcb_device(x) container_of((x), struct mcb_device, dev) 72 73 /** 74 * struct mcb_driver - MEN Chameleon Bus device driver 75 * 76 * @driver: device_driver 77 * @id_table: mcb id table 78 * @probe: probe callback 79 * @remove: remove callback 80 * @shutdown: shutdown callback 81 */ 82 struct mcb_driver { 83 struct device_driver driver; 84 const struct mcb_device_id *id_table; 85 int (*probe)(struct mcb_device *mdev, const struct mcb_device_id *id); 86 void (*remove)(struct mcb_device *mdev); 87 void (*shutdown)(struct mcb_device *mdev); 88 }; 89 #define to_mcb_driver(x) container_of((x), struct mcb_driver, driver) 90 91 static inline void *mcb_get_drvdata(struct mcb_device *dev) 92 { 93 return dev_get_drvdata(&dev->dev); 94 } 95 96 static inline void mcb_set_drvdata(struct mcb_device *dev, void *data) 97 { 98 dev_set_drvdata(&dev->dev, data); 99 } 100 101 extern int __must_check __mcb_register_driver(struct mcb_driver *drv, 102 struct module *owner, 103 const char *mod_name); 104 #define mcb_register_driver(driver) \ 105 __mcb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 106 extern void mcb_unregister_driver(struct mcb_driver *driver); 107 #define module_mcb_driver(__mcb_driver) \ 108 module_driver(__mcb_driver, mcb_register_driver, mcb_unregister_driver); 109 extern void mcb_bus_add_devices(const struct mcb_bus *bus); 110 extern int mcb_device_register(struct mcb_bus *bus, struct mcb_device *dev); 111 extern struct mcb_bus *mcb_alloc_bus(struct device *carrier); 112 extern struct mcb_bus *mcb_bus_get(struct mcb_bus *bus); 113 extern void mcb_bus_put(struct mcb_bus *bus); 114 extern struct mcb_device *mcb_alloc_dev(struct mcb_bus *bus); 115 extern void mcb_free_dev(struct mcb_device *dev); 116 extern void mcb_release_bus(struct mcb_bus *bus); 117 extern struct resource *mcb_request_mem(struct mcb_device *dev, 118 const char *name); 119 extern void mcb_release_mem(struct resource *mem); 120 extern int mcb_get_irq(struct mcb_device *dev); 121 122 #endif /* _LINUX_MCB_H */ 123