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>
|
2014-10-03 13:14:24 -06:00
|
|
|
#include <linux/idr.h>
|
2014-10-01 20:54:11 -06:00
|
|
|
|
2014-10-02 11:30:03 -06:00
|
|
|
#include "kernel_ver.h"
|
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-04-07 12:26:53 -06:00
|
|
|
#include "endo.h"
|
2015-05-22 12:02:08 -06:00
|
|
|
#include "svc.h"
|
2014-12-21 15:10:26 -07:00
|
|
|
#include "module.h"
|
2015-06-22 05:12:26 -06:00
|
|
|
#include "control.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-28 18:36:00 -06:00
|
|
|
#include "protocol.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
|
|
|
|
2014-08-11 01:30:45 -06:00
|
|
|
#define GREYBUS_DEVICE_ID_MATCH_DEVICE \
|
2014-10-06 21:34:48 -06:00
|
|
|
(GREYBUS_DEVICE_ID_MATCH_VENDOR | GREYBUS_DEVICE_ID_MATCH_PRODUCT)
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2014-09-01 14:42:43 -06:00
|
|
|
#define GREYBUS_DEVICE(v, p) \
|
2014-08-11 01:30:45 -06:00
|
|
|
.match_flags = GREYBUS_DEVICE_ID_MATCH_DEVICE, \
|
2014-09-01 14:42:43 -06:00
|
|
|
.vendor = (v), \
|
|
|
|
.product = (p),
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2014-09-01 14:42:43 -06:00
|
|
|
#define GREYBUS_DEVICE_SERIAL(s) \
|
2014-08-11 01:30:45 -06:00
|
|
|
.match_flags = GREYBUS_DEVICE_ID_MATCH_SERIAL, \
|
2014-09-01 14:42:43 -06:00
|
|
|
.serial_number = (s),
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2014-10-02 11:30:03 -06:00
|
|
|
/* XXX I couldn't get my Kconfig file to be noticed for out-of-tree build */
|
2015-06-13 10:02:09 -06:00
|
|
|
#ifndef CONFIG_CPORT_ID_MAX
|
|
|
|
#define CONFIG_CPORT_ID_MAX 128
|
|
|
|
#endif /* !CONFIG_CPORT_ID_MAX */
|
2014-10-02 11:30:03 -06:00
|
|
|
|
|
|
|
/* Maximum number of CPorts usable by a host device */
|
|
|
|
/* XXX This should really be determined by the AP module manifest */
|
2015-06-13 10:02:09 -06:00
|
|
|
#define CPORT_ID_MAX CONFIG_CPORT_ID_MAX
|
|
|
|
#define CPORT_ID_BAD U16_MAX /* UniPro max id is 4095 */
|
2014-08-11 01:30:45 -06:00
|
|
|
|
2014-08-30 17:20:22 -06:00
|
|
|
/* For SP1 hardware, we are going to "hardcode" each device to have all logical
|
|
|
|
* blocks in order to be able to address them as one unified "unit". Then
|
|
|
|
* higher up layers will then be able to talk to them as one logical block and
|
|
|
|
* properly know how they are hooked together (i.e. which i2c port is on the
|
|
|
|
* same module as the gpio pins, etc.)
|
|
|
|
*
|
|
|
|
* So, put the "private" data structures here in greybus.h and link to them off
|
2014-10-01 20:54:11 -06:00
|
|
|
* of the "main" gb_module structure.
|
2014-08-30 17:20:22 -06:00
|
|
|
*/
|
|
|
|
|
2014-09-06 17:57:36 -06:00
|
|
|
struct greybus_host_device;
|
2014-09-07 14:12:11 -06:00
|
|
|
struct svc_msg;
|
2014-09-06 17:57:36 -06:00
|
|
|
|
|
|
|
/* Greybus "Host driver" structure, needed by a host controller driver to be
|
|
|
|
* able to handle both SVC control as well as "real" greybus messages
|
|
|
|
*/
|
|
|
|
struct greybus_host_driver {
|
|
|
|
size_t hd_priv_size;
|
|
|
|
|
2015-07-01 04:37:21 -06:00
|
|
|
int (*message_send)(struct greybus_host_device *hd, u16 dest_cport_id,
|
2015-04-07 03:27:16 -06:00
|
|
|
struct gb_message *message, gfp_t gfp_mask);
|
2015-07-01 04:37:21 -06:00
|
|
|
void (*message_cancel)(struct gb_message *message);
|
2014-09-24 04:16:14 -06:00
|
|
|
int (*submit_svc)(struct svc_msg *svc_msg,
|
2014-09-19 20:13:33 -06:00
|
|
|
struct greybus_host_device *hd);
|
2014-09-06 17:57:36 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
struct greybus_host_device {
|
2014-09-12 21:47:11 -06:00
|
|
|
struct kref kref;
|
2014-09-14 13:27:28 -06:00
|
|
|
struct device *parent;
|
2014-09-06 17:57:36 -06:00
|
|
|
const struct greybus_host_driver *driver;
|
|
|
|
|
2014-12-19 15:56:36 -07:00
|
|
|
struct list_head interfaces;
|
2014-11-17 07:08:44 -07:00
|
|
|
struct list_head connections;
|
2014-10-03 13:14:24 -06:00
|
|
|
struct ida cport_id_map;
|
2014-10-20 23:52:27 -06:00
|
|
|
u8 device_id;
|
2014-10-02 11:30:03 -06:00
|
|
|
|
2014-11-20 15:09:13 -07:00
|
|
|
/* Host device buffer constraints */
|
|
|
|
size_t buffer_size_max;
|
|
|
|
|
2015-04-07 12:27:15 -06:00
|
|
|
struct gb_endo *endo;
|
|
|
|
|
2014-09-06 17:57:36 -06:00
|
|
|
/* Private data for the host driver */
|
2014-10-06 21:34:48 -06:00
|
|
|
unsigned long hd_priv[0] __aligned(sizeof(s64));
|
2014-09-06 17:57:36 -06:00
|
|
|
};
|
|
|
|
|
2014-10-06 21:34:48 -06:00
|
|
|
struct greybus_host_device *greybus_create_hd(struct greybus_host_driver *hd,
|
2015-05-19 03:22:43 -06:00
|
|
|
struct device *parent,
|
|
|
|
size_t buffer_size_max);
|
2015-05-22 11:56:49 -06:00
|
|
|
int greybus_endo_setup(struct greybus_host_device *hd, u16 endo_id,
|
|
|
|
u8 ap_intf_id);
|
2014-09-07 14:12:11 -06:00
|
|
|
void greybus_remove_hd(struct greybus_host_device *hd);
|
2014-08-11 05:03:20 -06:00
|
|
|
|
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
|
|
|
int (*suspend)(struct gb_bundle *bundle, pm_message_t message);
|
|
|
|
int (*resume)(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)
|
|
|
|
|
|
|
|
/* 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);
|
|
|
|
|
2014-09-26 19:55:35 -06:00
|
|
|
int greybus_svc_in(struct greybus_host_device *hd, u8 *data, int length);
|
2015-06-11 10:22:51 -06:00
|
|
|
int gb_ap_init(void);
|
2014-09-14 12:40:35 -06:00
|
|
|
void gb_ap_exit(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-04-07 12:26:53 -06:00
|
|
|
extern struct device_type greybus_endo_type;
|
2014-12-21 15:10:26 -07:00
|
|
|
extern struct device_type greybus_module_type;
|
2014-12-19 15:56:31 -07:00
|
|
|
extern struct device_type greybus_interface_type;
|
2014-12-12 15:10:17 -07:00
|
|
|
extern struct device_type greybus_bundle_type;
|
2014-11-15 13:12:16 -07:00
|
|
|
extern struct device_type greybus_connection_type;
|
|
|
|
|
2015-04-07 12:26:53 -06:00
|
|
|
static inline int is_gb_endo(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_endo_type;
|
|
|
|
}
|
|
|
|
|
2014-12-21 15:10:26 -07: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
|
|
|
}
|
|
|
|
|
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
|
|
|
}
|
|
|
|
|
|
|
|
static inline int is_gb_connection(const struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->type == &greybus_connection_type;
|
|
|
|
}
|
|
|
|
|
2015-06-13 10:02:07 -06:00
|
|
|
static inline bool cport_id_valid(u16 cport_id)
|
|
|
|
{
|
2015-06-16 20:43:05 -06:00
|
|
|
return cport_id != CPORT_ID_BAD && cport_id <= CPORT_ID_MAX;
|
2015-06-13 10:02:07 -06:00
|
|
|
}
|
|
|
|
|
2014-08-11 01:30:45 -06:00
|
|
|
#endif /* __KERNEL__ */
|
|
|
|
#endif /* __LINUX_GREYBUS_H */
|