2019-08-25 12:54:21 +07:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2014-08-11 14:30:45 +07:00
|
|
|
/*
|
|
|
|
* Greybus driver and device API
|
|
|
|
*
|
2015-05-23 00:59:16 +07:00
|
|
|
* Copyright 2014-2015 Google Inc.
|
|
|
|
* Copyright 2014-2015 Linaro Ltd.
|
2014-08-11 14:30:45 +07:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __LINUX_GREYBUS_H
|
|
|
|
#define __LINUX_GREYBUS_H
|
|
|
|
|
|
|
|
#ifdef __KERNEL__
|
|
|
|
|
2014-10-02 09:54:11 +07:00
|
|
|
#include <linux/kernel.h>
|
2014-09-02 03:42:43 +07:00
|
|
|
#include <linux/types.h>
|
2014-08-11 14:30:45 +07:00
|
|
|
#include <linux/list.h>
|
2014-10-02 09:54:11 +07:00
|
|
|
#include <linux/slab.h>
|
2014-08-11 14:30:45 +07:00
|
|
|
#include <linux/device.h>
|
|
|
|
#include <linux/module.h>
|
2016-07-15 03:13:00 +07:00
|
|
|
#include <linux/pm_runtime.h>
|
2014-10-04 02:14:24 +07:00
|
|
|
#include <linux/idr.h>
|
2014-10-02 09:54:11 +07:00
|
|
|
|
2019-08-25 12:54:27 +07:00
|
|
|
#include <linux/greybus/greybus_id.h>
|
|
|
|
#include <linux/greybus/greybus_manifest.h>
|
|
|
|
#include <linux/greybus/greybus_protocols.h>
|
|
|
|
#include <linux/greybus/manifest.h>
|
|
|
|
#include <linux/greybus/hd.h>
|
|
|
|
#include <linux/greybus/svc.h>
|
|
|
|
#include <linux/greybus/control.h>
|
|
|
|
#include <linux/greybus/module.h>
|
|
|
|
#include <linux/greybus/interface.h>
|
|
|
|
#include <linux/greybus/bundle.h>
|
|
|
|
#include <linux/greybus/connection.h>
|
|
|
|
#include <linux/greybus/operation.h>
|
2014-08-11 14:30:45 +07:00
|
|
|
|
2014-09-13 10:47:11 +07:00
|
|
|
/* Matches up with the Greybus Protocol specification document */
|
2014-09-19 02:25:43 +07:00
|
|
|
#define GREYBUS_VERSION_MAJOR 0x00
|
|
|
|
#define GREYBUS_VERSION_MINOR 0x01
|
2014-09-13 10:47:11 +07:00
|
|
|
|
2015-11-21 16:51:59 +07:00
|
|
|
#define GREYBUS_ID_MATCH_DEVICE \
|
|
|
|
(GREYBUS_ID_MATCH_VENDOR | GREYBUS_ID_MATCH_PRODUCT)
|
2014-08-11 14:30:45 +07:00
|
|
|
|
2014-09-02 03:42:43 +07:00
|
|
|
#define GREYBUS_DEVICE(v, p) \
|
2015-11-21 16:51:59 +07:00
|
|
|
.match_flags = GREYBUS_ID_MATCH_DEVICE, \
|
2014-09-02 03:42:43 +07:00
|
|
|
.vendor = (v), \
|
|
|
|
.product = (p),
|
2014-08-11 14:30:45 +07:00
|
|
|
|
2015-11-21 16:52:04 +07:00
|
|
|
#define GREYBUS_DEVICE_CLASS(c) \
|
|
|
|
.match_flags = GREYBUS_ID_MATCH_CLASS, \
|
|
|
|
.class = (c),
|
|
|
|
|
2015-09-02 23:03:21 +07:00
|
|
|
/* Maximum number of CPorts */
|
|
|
|
#define CPORT_ID_MAX 4095 /* UniPro max id is 4095 */
|
|
|
|
#define CPORT_ID_BAD U16_MAX
|
2014-08-11 14:30:45 +07:00
|
|
|
|
|
|
|
struct greybus_driver {
|
|
|
|
const char *name;
|
|
|
|
|
2015-04-01 22:02:04 +07:00
|
|
|
int (*probe)(struct gb_bundle *bundle,
|
|
|
|
const struct greybus_bundle_id *id);
|
|
|
|
void (*disconnect)(struct gb_bundle *bundle);
|
2014-08-11 14:30:45 +07:00
|
|
|
|
2015-04-01 22:02:04 +07:00
|
|
|
const struct greybus_bundle_id *id_table;
|
2014-08-11 14:30:45 +07:00
|
|
|
|
|
|
|
struct device_driver driver;
|
|
|
|
};
|
|
|
|
#define to_greybus_driver(d) container_of(d, struct greybus_driver, driver)
|
|
|
|
|
2016-01-09 02: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 14:30:45 +07: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-09 00:05:13 +07:00
|
|
|
void greybus_deregister_driver(struct greybus_driver *driver);
|
2014-08-11 14:30:45 +07: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-09 00:05:13 +07:00
|
|
|
#define greybus_deregister(driver) \
|
|
|
|
greybus_deregister_driver(driver)
|
2014-08-11 14:30:45 +07: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 23:22:51 +07:00
|
|
|
void gb_debugfs_init(void);
|
2014-09-01 06:17:04 +07:00
|
|
|
void gb_debugfs_cleanup(void);
|
2015-03-18 21:42:51 +07:00
|
|
|
struct dentry *gb_debugfs_get(void);
|
2014-09-01 06:17:04 +07:00
|
|
|
|
2014-10-24 16:34:46 +07:00
|
|
|
extern struct bus_type greybus_bus_type;
|
2014-09-02 09:05:54 +07:00
|
|
|
|
2015-11-25 21:59:02 +07:00
|
|
|
extern struct device_type greybus_hd_type;
|
2016-04-23 23:47:24 +07:00
|
|
|
extern struct device_type greybus_module_type;
|
2014-12-20 05:56:31 +07:00
|
|
|
extern struct device_type greybus_interface_type;
|
2016-04-14 00:19:02 +07:00
|
|
|
extern struct device_type greybus_control_type;
|
2014-12-13 05:10:17 +07:00
|
|
|
extern struct device_type greybus_bundle_type;
|
2015-11-25 21:59:08 +07:00
|
|
|
extern struct device_type greybus_svc_type;
|
2014-11-16 03:12:16 +07:00
|
|
|
|
2015-11-25 21:59:02 +07:00
|
|
|
static inline int is_gb_host_device(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_hd_type;
|
|
|
|
}
|
|
|
|
|
2016-04-23 23:47:24 +07:00
|
|
|
static inline int is_gb_module(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_module_type;
|
|
|
|
}
|
|
|
|
|
2014-12-20 05:56:31 +07:00
|
|
|
static inline int is_gb_interface(const struct device *dev)
|
2014-11-16 03:12:16 +07:00
|
|
|
{
|
2014-12-20 05:56:31 +07:00
|
|
|
return dev->type == &greybus_interface_type;
|
2014-11-16 03:12:16 +07:00
|
|
|
}
|
|
|
|
|
2016-04-14 00:19:02 +07:00
|
|
|
static inline int is_gb_control(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_control_type;
|
|
|
|
}
|
|
|
|
|
2014-12-13 05:10:17 +07:00
|
|
|
static inline int is_gb_bundle(const struct device *dev)
|
2014-11-16 03:12:16 +07:00
|
|
|
{
|
2014-12-13 05:10:17 +07:00
|
|
|
return dev->type == &greybus_bundle_type;
|
2014-11-16 03:12:16 +07:00
|
|
|
}
|
|
|
|
|
2015-11-25 21:59:08 +07:00
|
|
|
static inline int is_gb_svc(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_svc_type;
|
|
|
|
}
|
|
|
|
|
2015-11-04 00:03:23 +07:00
|
|
|
static inline bool cport_id_valid(struct gb_host_device *hd, u16 cport_id)
|
2015-06-13 23:02:07 +07:00
|
|
|
{
|
2015-09-02 20:50:35 +07:00
|
|
|
return cport_id != CPORT_ID_BAD && cport_id < hd->num_cports;
|
2015-06-13 23:02:07 +07:00
|
|
|
}
|
|
|
|
|
2014-08-11 14:30:45 +07:00
|
|
|
#endif /* __KERNEL__ */
|
|
|
|
#endif /* __LINUX_GREYBUS_H */
|