2014-08-11 01:30:45 -06:00
|
|
|
/*
|
|
|
|
* Greybus driver and device API
|
|
|
|
*
|
2015-05-22 11:59:16 -06:00
|
|
|
* Copyright 2014-2015 Google Inc.
|
|
|
|
* Copyright 2014-2015 Linaro Ltd.
|
2014-08-11 01:30:45 -06:00
|
|
|
*
|
|
|
|
* Released under the GPLv2 only.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __LINUX_GREYBUS_H
|
|
|
|
#define __LINUX_GREYBUS_H
|
|
|
|
|
|
|
|
#ifdef __KERNEL__
|
|
|
|
|
2014-10-01 20:54:11 -06:00
|
|
|
#include <linux/kernel.h>
|
2014-09-01 14:42:43 -06:00
|
|
|
#include <linux/types.h>
|
2014-08-11 01:30:45 -06:00
|
|
|
#include <linux/list.h>
|
2014-10-01 20:54:11 -06:00
|
|
|
#include <linux/slab.h>
|
2014-08-11 01:30:45 -06:00
|
|
|
#include <linux/device.h>
|
|
|
|
#include <linux/module.h>
|
2016-07-14 14:13:00 -06:00
|
|
|
#include <linux/pm_runtime.h>
|
2014-10-03 13:14:24 -06:00
|
|
|
#include <linux/idr.h>
|
2014-10-01 20:54:11 -06:00
|
|
|
|
2014-08-11 01:30:45 -06:00
|
|
|
#include "greybus_id.h"
|
2014-09-09 12:55:03 -06:00
|
|
|
#include "greybus_manifest.h"
|
2015-05-22 11:35:32 -06:00
|
|
|
#include "greybus_protocols.h"
|
2014-10-01 20:54:16 -06:00
|
|
|
#include "manifest.h"
|
2015-11-03 10:03:22 -07:00
|
|
|
#include "hd.h"
|
2015-05-22 12:02:08 -06:00
|
|
|
#include "svc.h"
|
2015-06-22 05:12:26 -06:00
|
|
|
#include "control.h"
|
2016-04-23 10:47:24 -06:00
|
|
|
#include "module.h"
|
2014-12-19 15:56:30 -07:00
|
|
|
#include "interface.h"
|
2014-12-12 15:10:16 -07:00
|
|
|
#include "bundle.h"
|
2014-10-01 20:54:14 -06:00
|
|
|
#include "connection.h"
|
2014-10-01 20:54:15 -06:00
|
|
|
#include "operation.h"
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2014-09-12 21:47:11 -06:00
|
|
|
/* Matches up with the Greybus Protocol specification document */
|
2014-09-18 13:25:43 -06:00
|
|
|
#define GREYBUS_VERSION_MAJOR 0x00
|
|
|
|
#define GREYBUS_VERSION_MINOR 0x01
|
2014-09-12 21:47:11 -06:00
|
|
|
|
2015-11-21 02:51:59 -07:00
|
|
|
#define GREYBUS_ID_MATCH_DEVICE \
|
|
|
|
(GREYBUS_ID_MATCH_VENDOR | GREYBUS_ID_MATCH_PRODUCT)
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2014-09-01 14:42:43 -06:00
|
|
|
#define GREYBUS_DEVICE(v, p) \
|
2015-11-21 02:51:59 -07:00
|
|
|
.match_flags = GREYBUS_ID_MATCH_DEVICE, \
|
2014-09-01 14:42:43 -06:00
|
|
|
.vendor = (v), \
|
|
|
|
.product = (p),
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2015-11-21 02:52:04 -07:00
|
|
|
#define GREYBUS_DEVICE_CLASS(c) \
|
|
|
|
.match_flags = GREYBUS_ID_MATCH_CLASS, \
|
|
|
|
.class = (c),
|
|
|
|
|
2015-09-02 10:03:21 -06:00
|
|
|
/* Maximum number of CPorts */
|
|
|
|
#define CPORT_ID_MAX 4095 /* UniPro max id is 4095 */
|
|
|
|
#define CPORT_ID_BAD U16_MAX
|
2014-08-11 01:30:45 -06:00
|
|
|
|
|
|
|
struct greybus_driver {
|
|
|
|
const char *name;
|
|
|
|
|
2015-04-01 09:02:04 -06:00
|
|
|
int (*probe)(struct gb_bundle *bundle,
|
|
|
|
const struct greybus_bundle_id *id);
|
|
|
|
void (*disconnect)(struct gb_bundle *bundle);
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2015-04-01 09:02:04 -06:00
|
|
|
const struct greybus_bundle_id *id_table;
|
2014-08-11 01:30:45 -06:00
|
|
|
|
|
|
|
struct device_driver driver;
|
|
|
|
};
|
|
|
|
#define to_greybus_driver(d) container_of(d, struct greybus_driver, driver)
|
|
|
|
|
2016-01-08 12:13:43 -07:00
|
|
|
static inline void greybus_set_drvdata(struct gb_bundle *bundle, void *data)
|
|
|
|
{
|
|
|
|
dev_set_drvdata(&bundle->dev, data);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void *greybus_get_drvdata(struct gb_bundle *bundle)
|
|
|
|
{
|
|
|
|
return dev_get_drvdata(&bundle->dev);
|
|
|
|
}
|
|
|
|
|
2014-08-11 01:30:45 -06:00
|
|
|
/* Don't call these directly, use the module_greybus_driver() macro instead */
|
|
|
|
int greybus_register_driver(struct greybus_driver *driver,
|
|
|
|
struct module *module, const char *mod_name);
|
2015-06-08 11:05:13 -06:00
|
|
|
void greybus_deregister_driver(struct greybus_driver *driver);
|
2014-08-11 01:30:45 -06:00
|
|
|
|
|
|
|
/* define to get proper THIS_MODULE and KBUILD_MODNAME values */
|
|
|
|
#define greybus_register(driver) \
|
|
|
|
greybus_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
|
2015-06-08 11:05:13 -06:00
|
|
|
#define greybus_deregister(driver) \
|
|
|
|
greybus_deregister_driver(driver)
|
2014-08-11 01:30:45 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* module_greybus_driver() - Helper macro for registering a Greybus driver
|
|
|
|
* @__greybus_driver: greybus_driver structure
|
|
|
|
*
|
|
|
|
* Helper macro for Greybus drivers to set up proper module init / exit
|
|
|
|
* functions. Replaces module_init() and module_exit() and keeps people from
|
|
|
|
* printing pointless things to the kernel log when their driver is loaded.
|
|
|
|
*/
|
|
|
|
#define module_greybus_driver(__greybus_driver) \
|
|
|
|
module_driver(__greybus_driver, greybus_register, greybus_deregister)
|
|
|
|
|
|
|
|
int greybus_disabled(void);
|
|
|
|
|
2015-06-11 10:22:51 -06:00
|
|
|
void gb_debugfs_init(void);
|
2014-08-31 17:17:04 -06:00
|
|
|
void gb_debugfs_cleanup(void);
|
2015-03-18 08:42:51 -06:00
|
|
|
struct dentry *gb_debugfs_get(void);
|
2014-08-31 17:17:04 -06:00
|
|
|
|
2014-10-24 03:34:46 -06:00
|
|
|
extern struct bus_type greybus_bus_type;
|
2014-09-01 20:05:54 -06:00
|
|
|
|
2015-11-25 07:59:02 -07:00
|
|
|
extern struct device_type greybus_hd_type;
|
2016-04-23 10:47:24 -06:00
|
|
|
extern struct device_type greybus_module_type;
|
2014-12-19 15:56:31 -07:00
|
|
|
extern struct device_type greybus_interface_type;
|
2016-04-13 11:19:02 -06:00
|
|
|
extern struct device_type greybus_control_type;
|
2014-12-12 15:10:17 -07:00
|
|
|
extern struct device_type greybus_bundle_type;
|
2015-11-25 07:59:08 -07:00
|
|
|
extern struct device_type greybus_svc_type;
|
2014-11-15 13:12:16 -07:00
|
|
|
|
2015-11-25 07:59:02 -07:00
|
|
|
static inline int is_gb_host_device(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_hd_type;
|
|
|
|
}
|
|
|
|
|
2016-04-23 10:47:24 -06:00
|
|
|
static inline int is_gb_module(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_module_type;
|
|
|
|
}
|
|
|
|
|
2014-12-19 15:56:31 -07:00
|
|
|
static inline int is_gb_interface(const struct device *dev)
|
2014-11-15 13:12:16 -07:00
|
|
|
{
|
2014-12-19 15:56:31 -07:00
|
|
|
return dev->type == &greybus_interface_type;
|
2014-11-15 13:12:16 -07:00
|
|
|
}
|
|
|
|
|
2016-04-13 11:19:02 -06:00
|
|
|
static inline int is_gb_control(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_control_type;
|
|
|
|
}
|
|
|
|
|
2014-12-12 15:10:17 -07:00
|
|
|
static inline int is_gb_bundle(const struct device *dev)
|
2014-11-15 13:12:16 -07:00
|
|
|
{
|
2014-12-12 15:10:17 -07:00
|
|
|
return dev->type == &greybus_bundle_type;
|
2014-11-15 13:12:16 -07:00
|
|
|
}
|
|
|
|
|
2015-11-25 07:59:08 -07:00
|
|
|
static inline int is_gb_svc(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_svc_type;
|
|
|
|
}
|
|
|
|
|
2015-11-03 10:03:23 -07:00
|
|
|
static inline bool cport_id_valid(struct gb_host_device *hd, u16 cport_id)
|
2015-06-13 10:02:07 -06:00
|
|
|
{
|
2015-09-02 07:50:35 -06:00
|
|
|
return cport_id != CPORT_ID_BAD && cport_id < hd->num_cports;
|
2015-06-13 10:02:07 -06:00
|
|
|
}
|
|
|
|
|
2014-08-11 01:30:45 -06:00
|
|
|
#endif /* __KERNEL__ */
|
|
|
|
#endif /* __LINUX_GREYBUS_H */
|