2 * Greybus driver and device API
4 * Copyright 2014-2015 Google Inc.
5 * Copyright 2014-2015 Linaro Ltd.
7 * Released under the GPLv2 only.
10 #ifndef __LINUX_GREYBUS_H
11 #define __LINUX_GREYBUS_H
15 #include <linux/kernel.h>
16 #include <linux/types.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/device.h>
20 #include <linux/module.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/idr.h>
24 #include "greybus_id.h"
25 #include "greybus_manifest.h"
26 #include "greybus_protocols.h"
32 #include "interface.h"
34 #include "connection.h"
35 #include "operation.h"
37 /* Matches up with the Greybus Protocol specification document */
38 #define GREYBUS_VERSION_MAJOR 0x00
39 #define GREYBUS_VERSION_MINOR 0x01
41 #define GREYBUS_ID_MATCH_DEVICE \
42 (GREYBUS_ID_MATCH_VENDOR | GREYBUS_ID_MATCH_PRODUCT)
44 #define GREYBUS_DEVICE(v, p) \
45 .match_flags = GREYBUS_ID_MATCH_DEVICE, \
49 #define GREYBUS_DEVICE_CLASS(c) \
50 .match_flags = GREYBUS_ID_MATCH_CLASS, \
53 /* Maximum number of CPorts */
54 #define CPORT_ID_MAX 4095 /* UniPro max id is 4095 */
55 #define CPORT_ID_BAD U16_MAX
57 struct greybus_driver {
60 int (*probe)(struct gb_bundle *bundle,
61 const struct greybus_bundle_id *id);
62 void (*disconnect)(struct gb_bundle *bundle);
64 const struct greybus_bundle_id *id_table;
66 struct device_driver driver;
68 #define to_greybus_driver(d) container_of(d, struct greybus_driver, driver)
70 static inline void greybus_set_drvdata(struct gb_bundle *bundle, void *data)
72 dev_set_drvdata(&bundle->dev, data);
75 static inline void *greybus_get_drvdata(struct gb_bundle *bundle)
77 return dev_get_drvdata(&bundle->dev);
80 /* Don't call these directly, use the module_greybus_driver() macro instead */
81 int greybus_register_driver(struct greybus_driver *driver,
82 struct module *module, const char *mod_name);
83 void greybus_deregister_driver(struct greybus_driver *driver);
85 /* define to get proper THIS_MODULE and KBUILD_MODNAME values */
86 #define greybus_register(driver) \
87 greybus_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
88 #define greybus_deregister(driver) \
89 greybus_deregister_driver(driver)
92 * module_greybus_driver() - Helper macro for registering a Greybus driver
93 * @__greybus_driver: greybus_driver structure
95 * Helper macro for Greybus drivers to set up proper module init / exit
96 * functions. Replaces module_init() and module_exit() and keeps people from
97 * printing pointless things to the kernel log when their driver is loaded.
99 #define module_greybus_driver(__greybus_driver) \
100 module_driver(__greybus_driver, greybus_register, greybus_deregister)
102 int greybus_disabled(void);
104 void gb_debugfs_init(void);
105 void gb_debugfs_cleanup(void);
106 struct dentry *gb_debugfs_get(void);
108 extern struct bus_type greybus_bus_type;
110 extern struct device_type greybus_hd_type;
111 extern struct device_type greybus_module_type;
112 extern struct device_type greybus_interface_type;
113 extern struct device_type greybus_control_type;
114 extern struct device_type greybus_bundle_type;
115 extern struct device_type greybus_svc_type;
117 static inline int is_gb_host_device(const struct device *dev)
119 return dev->type == &greybus_hd_type;
122 static inline int is_gb_module(const struct device *dev)
124 return dev->type == &greybus_module_type;
127 static inline int is_gb_interface(const struct device *dev)
129 return dev->type == &greybus_interface_type;
132 static inline int is_gb_control(const struct device *dev)
134 return dev->type == &greybus_control_type;
137 static inline int is_gb_bundle(const struct device *dev)
139 return dev->type == &greybus_bundle_type;
142 static inline int is_gb_svc(const struct device *dev)
144 return dev->type == &greybus_svc_type;
147 static inline bool cport_id_valid(struct gb_host_device *hd, u16 cport_id)
149 return cport_id != CPORT_ID_BAD && cport_id < hd->num_cports;
152 #endif /* __KERNEL__ */
153 #endif /* __LINUX_GREYBUS_H */