xref: /OK3568_Linux_fs/kernel/include/linux/mailbox/brcm-message.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *  Copyright (C) 2016 Broadcom
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Common header for Broadcom mailbox messages which is shared across
6*4882a593Smuzhiyun  * Broadcom SoCs and Broadcom mailbox client drivers.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef _LINUX_BRCM_MESSAGE_H_
10*4882a593Smuzhiyun #define _LINUX_BRCM_MESSAGE_H_
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/scatterlist.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun enum brcm_message_type {
15*4882a593Smuzhiyun 	BRCM_MESSAGE_UNKNOWN = 0,
16*4882a593Smuzhiyun 	BRCM_MESSAGE_BATCH,
17*4882a593Smuzhiyun 	BRCM_MESSAGE_SPU,
18*4882a593Smuzhiyun 	BRCM_MESSAGE_SBA,
19*4882a593Smuzhiyun 	BRCM_MESSAGE_MAX,
20*4882a593Smuzhiyun };
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun struct brcm_sba_command {
23*4882a593Smuzhiyun 	u64 cmd;
24*4882a593Smuzhiyun 	u64 *cmd_dma;
25*4882a593Smuzhiyun 	dma_addr_t cmd_dma_addr;
26*4882a593Smuzhiyun #define BRCM_SBA_CMD_TYPE_A		BIT(0)
27*4882a593Smuzhiyun #define BRCM_SBA_CMD_TYPE_B		BIT(1)
28*4882a593Smuzhiyun #define BRCM_SBA_CMD_TYPE_C		BIT(2)
29*4882a593Smuzhiyun #define BRCM_SBA_CMD_HAS_RESP		BIT(3)
30*4882a593Smuzhiyun #define BRCM_SBA_CMD_HAS_OUTPUT		BIT(4)
31*4882a593Smuzhiyun 	u64 flags;
32*4882a593Smuzhiyun 	dma_addr_t resp;
33*4882a593Smuzhiyun 	size_t resp_len;
34*4882a593Smuzhiyun 	dma_addr_t data;
35*4882a593Smuzhiyun 	size_t data_len;
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun struct brcm_message {
39*4882a593Smuzhiyun 	enum brcm_message_type type;
40*4882a593Smuzhiyun 	union {
41*4882a593Smuzhiyun 		struct {
42*4882a593Smuzhiyun 			struct brcm_message *msgs;
43*4882a593Smuzhiyun 			unsigned int msgs_queued;
44*4882a593Smuzhiyun 			unsigned int msgs_count;
45*4882a593Smuzhiyun 		} batch;
46*4882a593Smuzhiyun 		struct {
47*4882a593Smuzhiyun 			struct scatterlist *src;
48*4882a593Smuzhiyun 			struct scatterlist *dst;
49*4882a593Smuzhiyun 		} spu;
50*4882a593Smuzhiyun 		struct {
51*4882a593Smuzhiyun 			struct brcm_sba_command *cmds;
52*4882a593Smuzhiyun 			unsigned int cmds_count;
53*4882a593Smuzhiyun 		} sba;
54*4882a593Smuzhiyun 	};
55*4882a593Smuzhiyun 	void *ctx;
56*4882a593Smuzhiyun 	int error;
57*4882a593Smuzhiyun };
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #endif /* _LINUX_BRCM_MESSAGE_H_ */
60