drivers/staging/greybus/greybus.h

   1 /*
   2  * Greybus driver and device API
   3  *
   4  * Copyright 2014-2015 Google Inc.
   5  * Copyright 2014-2015 Linaro Ltd.
   6  *
   7  * Released under the GPLv2 only.
   8  */
   9
  10 #ifndef __LINUX_GREYBUS_H
  11 #define __LINUX_GREYBUS_H
  12
  13 #ifdef __KERNEL__
  14
  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/idr.h>
  22
  23 #include "kernel_ver.h"
  24 #include "greybus_id.h"
  25 #include "greybus_manifest.h"
  26 #include "greybus_protocols.h"
  27 #include "manifest.h"
  28 #include "hd.h"
  29 #include "svc.h"
  30 #include "firmware.h"
  31 #include "control.h"
  32 #include "interface.h"
  33 #include "bundle.h"
  34 #include "connection.h"
  35 #include "protocol.h"
  36 #include "operation.h"
  37
  38
  39 /* Matches up with the Greybus Protocol specification document */
  40 #define GREYBUS_VERSION_MAJOR   0x00
  41 #define GREYBUS_VERSION_MINOR   0x01
  42
  43 #define GREYBUS_ID_MATCH_DEVICE \
  44         (GREYBUS_ID_MATCH_VENDOR | GREYBUS_ID_MATCH_PRODUCT)
  45
  46 #define GREYBUS_DEVICE(v, p)                                    \
  47         .match_flags    = GREYBUS_ID_MATCH_DEVICE,              \
  48         .vendor         = (v),                                  \
  49         .product        = (p),
  50
  51 #define GREYBUS_DEVICE_CLASS(c)                                 \
  52         .match_flags    = GREYBUS_ID_MATCH_CLASS,               \
  53         .class          = (c),
  54
  55 /* Maximum number of CPorts */
  56 #define CPORT_ID_MAX    4095            /* UniPro max id is 4095 */
  57 #define CPORT_ID_BAD    U16_MAX
  58
  59 struct greybus_driver {
  60         const char *name;
  61
  62         int (*probe)(struct gb_bundle *bundle,
  63                      const struct greybus_bundle_id *id);
  64         void (*disconnect)(struct gb_bundle *bundle);
  65
  66         int (*suspend)(struct gb_bundle *bundle, pm_message_t message);
  67         int (*resume)(struct gb_bundle *bundle);
  68
  69         const struct greybus_bundle_id *id_table;
  70
  71         struct device_driver driver;
  72 };
  73 #define to_greybus_driver(d) container_of(d, struct greybus_driver, driver)
  74
  75 static inline void greybus_set_drvdata(struct gb_bundle *bundle, void *data)
  76 {
  77         dev_set_drvdata(&bundle->dev, data);
  78 }
  79
  80 static inline void *greybus_get_drvdata(struct gb_bundle *bundle)
  81 {
  82         return dev_get_drvdata(&bundle->dev);
  83 }
  84
  85 /* Don't call these directly, use the module_greybus_driver() macro instead */
  86 int greybus_register_driver(struct greybus_driver *driver,
  87                             struct module *module, const char *mod_name);
  88 void greybus_deregister_driver(struct greybus_driver *driver);
  89
  90 /* define to get proper THIS_MODULE and KBUILD_MODNAME values */
  91 #define greybus_register(driver) \
  92         greybus_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
  93 #define greybus_deregister(driver) \
  94         greybus_deregister_driver(driver)
  95
  96 /**
  97  * module_greybus_driver() - Helper macro for registering a Greybus driver
  98  * @__greybus_driver: greybus_driver structure
  99  *
 100  * Helper macro for Greybus drivers to set up proper module init / exit
 101  * functions.  Replaces module_init() and module_exit() and keeps people from
 102  * printing pointless things to the kernel log when their driver is loaded.
 103  */
 104 #define module_greybus_driver(__greybus_driver) \
 105         module_driver(__greybus_driver, greybus_register, greybus_deregister)
 106
 107 int greybus_disabled(void);
 108
 109 void gb_debugfs_init(void);
 110 void gb_debugfs_cleanup(void);
 111 struct dentry *gb_debugfs_get(void);
 112
 113 extern struct bus_type greybus_bus_type;
 114
 115 extern struct device_type greybus_hd_type;
 116 extern struct device_type greybus_interface_type;
 117 extern struct device_type greybus_bundle_type;
 118 extern struct device_type greybus_svc_type;
 119
 120 static inline int is_gb_host_device(const struct device *dev)
 121 {
 122         return dev->type == &greybus_hd_type;
 123 }
 124
 125 static inline int is_gb_interface(const struct device *dev)
 126 {
 127         return dev->type == &greybus_interface_type;
 128 }
 129
 130 static inline int is_gb_bundle(const struct device *dev)
 131 {
 132         return dev->type == &greybus_bundle_type;
 133 }
 134
 135 static inline int is_gb_svc(const struct device *dev)
 136 {
 137         return dev->type == &greybus_svc_type;
 138 }
 139
 140 static inline bool cport_id_valid(struct gb_host_device *hd, u16 cport_id)
 141 {
 142         return cport_id != CPORT_ID_BAD && cport_id < hd->num_cports;
 143 }
 144
 145 #endif /* __KERNEL__ */
 146 #endif /* __LINUX_GREYBUS_H */