Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / 066f950c65c206c1a1a2f72f2c80134177ea3999 / . / drivers / staging / greybus / protocol.h
blob: 26c59efd9ed8f49f2936aae175752bd202789572 [file] [log] [blame]
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]1/*
2 * Greybus protocol handling
3 *
4 * Copyright 2014 Google Inc.
Alex Eldera46e9672014-12-12 12:08:42 -0600[diff] [blame]5 * Copyright 2014 Linaro Ltd.
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]6 *
7 * Released under the GPLv2 only.
8 */
9
10#ifndef __PROTOCOL_H
11#define __PROTOCOL_H
12
Johan Hovoldfed78bf2015-05-19 11:22:41 +0200[diff] [blame]13struct gb_connection;
Alex Elderf8fb05e2014-11-05 16:12:55 -0600[diff] [blame]14struct gb_operation;
15
Alex Elder5d9fd7e2014-11-05 16:12:54 -0600[diff] [blame]16typedef int (*gb_connection_init_t)(struct gb_connection *);
17typedef void (*gb_connection_exit_t)(struct gb_connection *);
Johan Hovold973ccfd2015-03-27 12:45:49 +0100[diff] [blame]18typedef int (*gb_request_recv_t)(u8, struct gb_operation *);
Alex Elder5d9fd7e2014-11-05 16:12:54 -0600[diff] [blame]19
Alex Elder6ae7fa42014-11-05 16:12:50 -0600[diff] [blame]20/*
21 * Protocols having the same id but different major and/or minor
22 * version numbers are treated as distinct protocols. If it makes
23 * sense someday we could group protocols having the same id.
24 */
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]25struct gb_protocol {
Alex Elder6ae7fa42014-11-05 16:12:50 -0600[diff] [blame]26 u8 id;
27 u8 major;
28 u8 minor;
Alex Elder0e447652014-11-05 16:12:51 -0600[diff] [blame]29 u8 count;
Alex Elder6ae7fa42014-11-05 16:12:50 -0600[diff] [blame]30
Alex Elder6ae7fa42014-11-05 16:12:50 -0600[diff] [blame]31 struct list_head links; /* global list */
Alex Elder5d9fd7e2014-11-05 16:12:54 -0600[diff] [blame]32
33 gb_connection_init_t connection_init;
34 gb_connection_exit_t connection_exit;
Alex Elderf8fb05e2014-11-05 16:12:55 -0600[diff] [blame]35 gb_request_recv_t request_recv;
Greg Kroah-Hartman12a5dfc2014-12-24 13:01:40 -0800[diff] [blame]36 struct module *owner;
Greg Kroah-Hartman7422a1e2014-12-24 13:01:45 -0800[diff] [blame]37 char *name;
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]38};
39
Greg Kroah-Hartman12a5dfc2014-12-24 13:01:40 -0800[diff] [blame]40int __gb_protocol_register(struct gb_protocol *protocol, struct module *module);
Johan Hovold78033842015-10-13 19:10:24 +0200[diff] [blame]41void gb_protocol_deregister(struct gb_protocol *protocol);
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]42
Greg Kroah-Hartman12a5dfc2014-12-24 13:01:40 -0800[diff] [blame]43#define gb_protocol_register(protocol) \
44 __gb_protocol_register(protocol, THIS_MODULE)
45
Alex Elder0e447652014-11-05 16:12:51 -0600[diff] [blame]46struct gb_protocol *gb_protocol_get(u8 id, u8 major, u8 minor);
Viresh Kumar1cb5fa42015-08-12 11:04:06 +0530[diff] [blame]47int gb_protocol_get_version(struct gb_connection *connection);
Viresh Kumar36e79de2015-01-21 18:12:36 +0530[diff] [blame]48
Alex Elder0e447652014-11-05 16:12:51 -0600[diff] [blame]49void gb_protocol_put(struct gb_protocol *protocol);
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]50
Alex Elder19d03de2014-11-05 16:12:53 -0600[diff] [blame]51/*
52 * These are defined in their respective protocol source files.
53 * Declared here for now. They could be added via modules, or maybe
54 * just use initcalls (which level?).
55 */
Greg Kroah-Hartman7c7d5b92014-12-23 15:16:51 -0800[diff] [blame]56extern int gb_gpio_protocol_init(void);
Alex Elder19d03de2014-11-05 16:12:53 -0600[diff] [blame]57extern void gb_gpio_protocol_exit(void);
58
Greg Kroah-Hartman7c7d5b92014-12-23 15:16:51 -0800[diff] [blame]59extern int gb_pwm_protocol_init(void);
Matt Porter34c65072014-11-13 09:14:13 -0500[diff] [blame]60extern void gb_pwm_protocol_exit(void);
61
Greg Kroah-Hartman7c7d5b92014-12-23 15:16:51 -0800[diff] [blame]62extern int gb_uart_protocol_init(void);
Alex Elder19d03de2014-11-05 16:12:53 -0600[diff] [blame]63extern void gb_uart_protocol_exit(void);
64
Greg Kroah-Hartman7c7d5b92014-12-23 15:16:51 -0800[diff] [blame]65extern int gb_sdio_protocol_init(void);
Alex Elder19d03de2014-11-05 16:12:53 -0600[diff] [blame]66extern void gb_sdio_protocol_exit(void);
67
Greg Kroah-Hartman7c7d5b92014-12-23 15:16:51 -0800[diff] [blame]68extern int gb_usb_protocol_init(void);
Greg Kroah-Hartman615772a2014-11-25 16:59:21 -0800[diff] [blame]69extern void gb_usb_protocol_exit(void);
70
Greg Kroah-Hartman2c078172014-12-24 13:01:44 -0800[diff] [blame]71extern int gb_i2c_protocol_init(void);
72extern void gb_i2c_protocol_exit(void);
73
Viresh Kumar15d651b2015-01-23 13:07:45 +0530[diff] [blame]74extern int gb_spi_protocol_init(void);
75extern void gb_spi_protocol_exit(void);
76
Viresh Kumar27551b12015-05-20 17:20:09 +0530[diff] [blame]77/* __protocol: Pointer to struct gb_protocol */
Greg Kroah-Hartman900ceba2014-12-23 15:16:54 -0800[diff] [blame]78#define gb_protocol_driver(__protocol) \
79static int __init protocol_init(void) \
80{ \
81 return gb_protocol_register(__protocol); \
82} \
83module_init(protocol_init); \
84static void __exit protocol_exit(void) \
85{ \
86 gb_protocol_deregister(__protocol); \
87} \
Greg Kroah-Hartmanf487c802015-05-01 21:05:50 +0200[diff] [blame]88module_exit(protocol_exit)
Greg Kroah-Hartman900ceba2014-12-23 15:16:54 -0800[diff] [blame]89
Viresh Kumar27551b12015-05-20 17:20:09 +0530[diff] [blame]90/* __protocol: string matching name of struct gb_protocol */
Viresh Kumare18822e2015-07-01 12:13:52 +0530[diff] [blame]91#define gb_builtin_protocol_driver(__protocol) \
Viresh Kumar27551b12015-05-20 17:20:09 +0530[diff] [blame]92int __init gb_##__protocol##_init(void) \
93{ \
94 return gb_protocol_register(&__protocol); \
95} \
Johan Hovold8d346df2015-05-21 11:47:24 +0200[diff] [blame]96void gb_##__protocol##_exit(void) \
Viresh Kumar27551b12015-05-20 17:20:09 +0530[diff] [blame]97{ \
98 gb_protocol_deregister(&__protocol); \
99} \
100
Alex Elder4ccb6b72014-10-28 19:36:00 -0500[diff] [blame]101#endif /* __PROTOCOL_H */