[GitHub/LineageOS/android_kernel_motorola_exynos9610.git] / drivers / staging / greybus / arpc.h

/*
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2016 Google Inc. All rights reserved.
 * Copyright(c) 2016 Linaro Ltd. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License version 2 for more details.
 *
 * BSD LICENSE
 *
 * Copyright(c) 2016 Google Inc. All rights reserved.
 * Copyright(c) 2016 Linaro Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Google Inc. or Linaro Ltd. nor the names of
 *    its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC. OR
 * LINARO LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __ARPC_H
#define __ARPC_H

/* APBridgeA RPC (ARPC) */

enum arpc_result {
	ARPC_SUCCESS		= 0x00,
	ARPC_NO_MEMORY		= 0x01,
	ARPC_INVALID		= 0x02,
	ARPC_TIMEOUT		= 0x03,
	ARPC_UNKNOWN_ERROR	= 0xff,
};

struct arpc_request_message {
	__le16	id;		/* RPC unique id */
	__le16	size;		/* Size in bytes of header + payload */
	__u8	type;		/* RPC type */
	__u8	data[0];	/* ARPC data */
} __packed;

struct arpc_response_message {
	__le16	id;		/* RPC unique id */
	__u8	result;		/* Result of RPC */
} __packed;

/* ARPC requests */
#define ARPC_TYPE_CPORT_CONNECTED		0x01
#define ARPC_TYPE_CPORT_QUIESCE			0x02
#define ARPC_TYPE_CPORT_CLEAR			0x03
#define ARPC_TYPE_CPORT_FLUSH			0x04
#define ARPC_TYPE_CPORT_SHUTDOWN		0x05

struct arpc_cport_connected_req {
	__le16 cport_id;
} __packed;

struct arpc_cport_quiesce_req {
	__le16 cport_id;
	__le16 peer_space;
	__le16 timeout;
} __packed;

struct arpc_cport_clear_req {
	__le16 cport_id;
} __packed;

struct arpc_cport_flush_req {
	__le16 cport_id;
} __packed;

struct arpc_cport_shutdown_req {
	__le16 cport_id;
	__le16 timeout;
	__u8 phase;
} __packed;

#endif	/* __ARPC_H */
Commit	Line	Data
7d0e76d6 JH	1	/*
	2	* This file is provided under a dual BSD/GPLv2 license. When using or
	3	* redistributing this file, you may do so under either license.
	4	*
	5	* GPL LICENSE SUMMARY
	6	*
b3136a77 GKH	7	* Copyright(c) 2016 Google Inc. All rights reserved.
b3136a77 GKH	8	* Copyright(c) 2016 Linaro Ltd. All rights reserved.
7d0e76d6 JH	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of version 2 of the GNU General Public License as
	12	* published by the Free Software Foundation.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License version 2 for more details.
	18	*
	19	* BSD LICENSE
	20	*
b3136a77 GKH	21	* Copyright(c) 2016 Google Inc. All rights reserved.
b3136a77 GKH	22	* Copyright(c) 2016 Linaro Ltd. All rights reserved.
7d0e76d6 JH	23	*
	24	* Redistribution and use in source and binary forms, with or without
	25	* modification, are permitted provided that the following conditions
	26	* are met:
	27	*
	28	* * Redistributions of source code must retain the above copyright
	29	* notice, this list of conditions and the following disclaimer.
	30	* * Redistributions in binary form must reproduce the above copyright
	31	* notice, this list of conditions and the following disclaimer in
	32	* the documentation and/or other materials provided with the
	33	* distribution.
	34	* * Neither the name of Google Inc. or Linaro Ltd. nor the names of
	35	* its contributors may be used to endorse or promote products
	36	* derived from this software without specific prior written
	37	* permission.
	38	*
	39	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	40	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	41	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	42	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC. OR
	43	* LINARO LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	44	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	45	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	46	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
	47	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	48	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	49	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	50	*/
	51
	52	#ifndef __ARPC_H
	53	#define __ARPC_H
	54
	55	/* APBridgeA RPC (ARPC) */
	56
	57	enum arpc_result {
	58	ARPC_SUCCESS = 0x00,
	59	ARPC_NO_MEMORY = 0x01,
	60	ARPC_INVALID = 0x02,
	61	ARPC_TIMEOUT = 0x03,
	62	ARPC_UNKNOWN_ERROR = 0xff,
	63	};
	64
	65	struct arpc_request_message {
	66	__le16 id; /* RPC unique id */
	67	__le16 size; /* Size in bytes of header + payload */
	68	__u8 type; /* RPC type */
	69	__u8 data[0]; /* ARPC data */
	70	} __packed;
	71
	72	struct arpc_response_message {
	73	__le16 id; /* RPC unique id */
	74	__u8 result; /* Result of RPC */
	75	} __packed;
	76
7d0e76d6	77	/* ARPC requests */
a9dc1cf5	78	#define ARPC_TYPE_CPORT_CONNECTED 0x01
0e7cd0d2	79	#define ARPC_TYPE_CPORT_QUIESCE 0x02
6471c003	80	#define ARPC_TYPE_CPORT_CLEAR 0x03
d2dee94b	81	#define ARPC_TYPE_CPORT_FLUSH 0x04
77e52b3b	82	#define ARPC_TYPE_CPORT_SHUTDOWN 0x05
7d0e76d6	83
a9dc1cf5 JH	84	struct arpc_cport_connected_req {
	85	__le16 cport_id;
	86	} __packed;
	87
0e7cd0d2 JH	88	struct arpc_cport_quiesce_req {
	89	__le16 cport_id;
	90	__le16 peer_space;
	91	__le16 timeout;
	92	} __packed;
	93
6471c003 JH	94	struct arpc_cport_clear_req {
	95	__le16 cport_id;
	96	} __packed;
	97
d2dee94b JH	98	struct arpc_cport_flush_req {
	99	__le16 cport_id;
	100	} __packed;
a9dc1cf5	101
77e52b3b JH	102	struct arpc_cport_shutdown_req {
	103	__le16 cport_id;
	104	__le16 timeout;
	105	__u8 phase;
	106	} __packed;
	107
7d0e76d6	108	#endif /* __ARPC_H */