1ca7d8b98SSergei Shtylyov /* SPDX-License-Identifier: GPL-2.0 */
2ca7d8b98SSergei Shtylyov /*
3ca7d8b98SSergei Shtylyov  * Renesas RPC-IF core driver
4ca7d8b98SSergei Shtylyov  *
5ca7d8b98SSergei Shtylyov  * Copyright (C) 2018~2019 Renesas Solutions Corp.
6ca7d8b98SSergei Shtylyov  * Copyright (C) 2019 Macronix International Co., Ltd.
7ca7d8b98SSergei Shtylyov  * Copyright (C) 2019-2020 Cogent Embedded, Inc.
8ca7d8b98SSergei Shtylyov  */
9ca7d8b98SSergei Shtylyov 
10ca7d8b98SSergei Shtylyov #ifndef __RENESAS_RPC_IF_H
11ca7d8b98SSergei Shtylyov #define __RENESAS_RPC_IF_H
12ca7d8b98SSergei Shtylyov 
13ca7d8b98SSergei Shtylyov #include <linux/types.h>
14ca7d8b98SSergei Shtylyov 
15ca7d8b98SSergei Shtylyov enum rpcif_data_dir {
16ca7d8b98SSergei Shtylyov 	RPCIF_NO_DATA,
17ca7d8b98SSergei Shtylyov 	RPCIF_DATA_IN,
18ca7d8b98SSergei Shtylyov 	RPCIF_DATA_OUT,
19ca7d8b98SSergei Shtylyov };
20ca7d8b98SSergei Shtylyov 
21ca7d8b98SSergei Shtylyov struct	rpcif_op {
22ca7d8b98SSergei Shtylyov 	struct {
23ca7d8b98SSergei Shtylyov 		u8 buswidth;
24ca7d8b98SSergei Shtylyov 		u8 opcode;
25ca7d8b98SSergei Shtylyov 		bool ddr;
26ca7d8b98SSergei Shtylyov 	} cmd, ocmd;
27ca7d8b98SSergei Shtylyov 
28ca7d8b98SSergei Shtylyov 	struct {
29ca7d8b98SSergei Shtylyov 		u8 nbytes;
30ca7d8b98SSergei Shtylyov 		u8 buswidth;
31ca7d8b98SSergei Shtylyov 		bool ddr;
32ca7d8b98SSergei Shtylyov 		u64 val;
33ca7d8b98SSergei Shtylyov 	} addr;
34ca7d8b98SSergei Shtylyov 
35ca7d8b98SSergei Shtylyov 	struct {
36ca7d8b98SSergei Shtylyov 		u8 ncycles;
37ca7d8b98SSergei Shtylyov 		u8 buswidth;
38ca7d8b98SSergei Shtylyov 	} dummy;
39ca7d8b98SSergei Shtylyov 
40ca7d8b98SSergei Shtylyov 	struct {
41ca7d8b98SSergei Shtylyov 		u8 nbytes;
42ca7d8b98SSergei Shtylyov 		u8 buswidth;
43ca7d8b98SSergei Shtylyov 		bool ddr;
44ca7d8b98SSergei Shtylyov 		u32 val;
45ca7d8b98SSergei Shtylyov 	} option;
46ca7d8b98SSergei Shtylyov 
47ca7d8b98SSergei Shtylyov 	struct {
48ca7d8b98SSergei Shtylyov 		u8 buswidth;
49ca7d8b98SSergei Shtylyov 		unsigned int nbytes;
50ca7d8b98SSergei Shtylyov 		enum rpcif_data_dir dir;
51ca7d8b98SSergei Shtylyov 		bool ddr;
52ca7d8b98SSergei Shtylyov 		union {
53ca7d8b98SSergei Shtylyov 			void *in;
54ca7d8b98SSergei Shtylyov 			const void *out;
55ca7d8b98SSergei Shtylyov 		} buf;
56ca7d8b98SSergei Shtylyov 	} data;
57ca7d8b98SSergei Shtylyov };
58ca7d8b98SSergei Shtylyov 
59ca7d8b98SSergei Shtylyov struct	rpcif {
60ca7d8b98SSergei Shtylyov 	struct device *dev;
61ca7d8b98SSergei Shtylyov 	void __iomem *dirmap;
62ca7d8b98SSergei Shtylyov 	struct regmap *regmap;
63ca7d8b98SSergei Shtylyov 	struct reset_control *rstc;
64ca7d8b98SSergei Shtylyov 	size_t size;
65ca7d8b98SSergei Shtylyov 	enum rpcif_data_dir dir;
66ca7d8b98SSergei Shtylyov 	u8 bus_size;
67ca7d8b98SSergei Shtylyov 	void *buffer;
68ca7d8b98SSergei Shtylyov 	u32 xferlen;
69ca7d8b98SSergei Shtylyov 	u32 smcr;
70ca7d8b98SSergei Shtylyov 	u32 smadr;
71ca7d8b98SSergei Shtylyov 	u32 command;		/* DRCMR or SMCMR */
72ca7d8b98SSergei Shtylyov 	u32 option;		/* DROPR or SMOPR */
73ca7d8b98SSergei Shtylyov 	u32 enable;		/* DRENR or SMENR */
74ca7d8b98SSergei Shtylyov 	u32 dummy;		/* DRDMCR or SMDMCR */
75ca7d8b98SSergei Shtylyov 	u32 ddr;		/* DRDRENR or SMDRENR */
76ca7d8b98SSergei Shtylyov };
77ca7d8b98SSergei Shtylyov 
78ca7d8b98SSergei Shtylyov int  rpcif_sw_init(struct rpcif *rpc, struct device *dev);
79ca7d8b98SSergei Shtylyov void rpcif_hw_init(struct rpcif *rpc, bool hyperflash);
80ca7d8b98SSergei Shtylyov void rpcif_enable_rpm(struct rpcif *rpc);
81ca7d8b98SSergei Shtylyov void rpcif_disable_rpm(struct rpcif *rpc);
82ca7d8b98SSergei Shtylyov void rpcif_prepare(struct rpcif *rpc, const struct rpcif_op *op, u64 *offs,
83ca7d8b98SSergei Shtylyov 		   size_t *len);
84ca7d8b98SSergei Shtylyov int rpcif_manual_xfer(struct rpcif *rpc);
85ca7d8b98SSergei Shtylyov ssize_t rpcif_dirmap_read(struct rpcif *rpc, u64 offs, size_t len, void *buf);
86ca7d8b98SSergei Shtylyov 
87ca7d8b98SSergei Shtylyov #endif // __RENESAS_RPC_IF_H
88