1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // RPC-IF SPI/QSPI/Octa driver
4 //
5 // Copyright (C) 2018 ~ 2019 Renesas Solutions Corp.
6 // Copyright (C) 2019 Macronix International Co., Ltd.
7 // Copyright (C) 2019 - 2020 Cogent Embedded, Inc.
8 //
9
10 #include <linux/module.h>
11 #include <linux/platform_device.h>
12 #include <linux/spi/spi.h>
13 #include <linux/spi/spi-mem.h>
14
15 #include <memory/renesas-rpc-if.h>
16
17 #include <linux/unaligned.h>
18
rpcif_spi_mem_prepare(struct spi_device * spi_dev,const struct spi_mem_op * spi_op,u64 * offs,size_t * len)19 static void rpcif_spi_mem_prepare(struct spi_device *spi_dev,
20 const struct spi_mem_op *spi_op,
21 u64 *offs, size_t *len)
22 {
23 struct rpcif *rpc = spi_controller_get_devdata(spi_dev->controller);
24 struct rpcif_op rpc_op = { };
25
26 rpc_op.cmd.opcode = spi_op->cmd.opcode;
27 rpc_op.cmd.buswidth = spi_op->cmd.buswidth;
28
29 if (spi_op->addr.nbytes) {
30 rpc_op.addr.buswidth = spi_op->addr.buswidth;
31 rpc_op.addr.nbytes = spi_op->addr.nbytes;
32 rpc_op.addr.val = spi_op->addr.val;
33 }
34
35 if (spi_op->dummy.nbytes) {
36 rpc_op.dummy.buswidth = spi_op->dummy.buswidth;
37 rpc_op.dummy.ncycles = spi_op->dummy.nbytes * 8 /
38 spi_op->dummy.buswidth;
39 }
40
41 if (spi_op->data.nbytes || (offs && len)) {
42 rpc_op.data.buswidth = spi_op->data.buswidth;
43 rpc_op.data.nbytes = spi_op->data.nbytes;
44 switch (spi_op->data.dir) {
45 case SPI_MEM_DATA_IN:
46 rpc_op.data.dir = RPCIF_DATA_IN;
47 rpc_op.data.buf.in = spi_op->data.buf.in;
48 break;
49 case SPI_MEM_DATA_OUT:
50 rpc_op.data.dir = RPCIF_DATA_OUT;
51 rpc_op.data.buf.out = spi_op->data.buf.out;
52 break;
53 case SPI_MEM_NO_DATA:
54 rpc_op.data.dir = RPCIF_NO_DATA;
55 break;
56 }
57 } else {
58 rpc_op.data.dir = RPCIF_NO_DATA;
59 }
60
61 rpcif_prepare(rpc->dev, &rpc_op, offs, len);
62 }
63
rpcif_spi_mem_supports_op(struct spi_mem * mem,const struct spi_mem_op * op)64 static bool rpcif_spi_mem_supports_op(struct spi_mem *mem,
65 const struct spi_mem_op *op)
66 {
67 if (!spi_mem_default_supports_op(mem, op))
68 return false;
69
70 if (op->data.buswidth > 4 || op->addr.buswidth > 4 ||
71 op->dummy.buswidth > 4 || op->cmd.buswidth > 4 ||
72 op->addr.nbytes > 4)
73 return false;
74
75 return true;
76 }
77
xspi_spi_mem_dirmap_write(struct spi_mem_dirmap_desc * desc,u64 offs,size_t len,const void * buf)78 static ssize_t xspi_spi_mem_dirmap_write(struct spi_mem_dirmap_desc *desc,
79 u64 offs, size_t len, const void *buf)
80 {
81 struct rpcif *rpc = spi_controller_get_devdata(desc->mem->spi->controller);
82
83 if (offs + desc->info.offset + len > U32_MAX)
84 return -EINVAL;
85
86 rpcif_spi_mem_prepare(desc->mem->spi, &desc->info.op_tmpl, &offs, &len);
87
88 return xspi_dirmap_write(rpc->dev, offs, len, buf);
89 }
90
rpcif_spi_mem_dirmap_read(struct spi_mem_dirmap_desc * desc,u64 offs,size_t len,void * buf)91 static ssize_t rpcif_spi_mem_dirmap_read(struct spi_mem_dirmap_desc *desc,
92 u64 offs, size_t len, void *buf)
93 {
94 struct rpcif *rpc =
95 spi_controller_get_devdata(desc->mem->spi->controller);
96
97 if (offs + desc->info.offset + len > U32_MAX)
98 return -EINVAL;
99
100 rpcif_spi_mem_prepare(desc->mem->spi, &desc->info.op_tmpl, &offs, &len);
101
102 return rpcif_dirmap_read(rpc->dev, offs, len, buf);
103 }
104
rpcif_spi_mem_dirmap_create(struct spi_mem_dirmap_desc * desc)105 static int rpcif_spi_mem_dirmap_create(struct spi_mem_dirmap_desc *desc)
106 {
107 struct rpcif *rpc =
108 spi_controller_get_devdata(desc->mem->spi->controller);
109
110 if (desc->info.offset + desc->info.length > U32_MAX)
111 return -EINVAL;
112
113 if (!rpcif_spi_mem_supports_op(desc->mem, &desc->info.op_tmpl))
114 return -EOPNOTSUPP;
115
116 if (!rpc->dirmap)
117 return -EOPNOTSUPP;
118
119 if (!rpc->xspi && desc->info.op_tmpl.data.dir != SPI_MEM_DATA_IN)
120 return -EOPNOTSUPP;
121
122 return 0;
123 }
124
rpcif_spi_mem_exec_op(struct spi_mem * mem,const struct spi_mem_op * op)125 static int rpcif_spi_mem_exec_op(struct spi_mem *mem,
126 const struct spi_mem_op *op)
127 {
128 struct rpcif *rpc =
129 spi_controller_get_devdata(mem->spi->controller);
130
131 rpcif_spi_mem_prepare(mem->spi, op, NULL, NULL);
132
133 return rpcif_manual_xfer(rpc->dev);
134 }
135
136 static const struct spi_controller_mem_ops rpcif_spi_mem_ops = {
137 .supports_op = rpcif_spi_mem_supports_op,
138 .exec_op = rpcif_spi_mem_exec_op,
139 .dirmap_create = rpcif_spi_mem_dirmap_create,
140 .dirmap_read = rpcif_spi_mem_dirmap_read,
141 .dirmap_write = xspi_spi_mem_dirmap_write,
142 };
143
rpcif_spi_probe(struct platform_device * pdev)144 static int rpcif_spi_probe(struct platform_device *pdev)
145 {
146 struct device *parent = pdev->dev.parent;
147 struct spi_controller *ctlr;
148 struct rpcif *rpc;
149 int error;
150
151 ctlr = devm_spi_alloc_host(&pdev->dev, sizeof(*rpc));
152 if (!ctlr)
153 return -ENOMEM;
154
155 rpc = spi_controller_get_devdata(ctlr);
156 error = rpcif_sw_init(rpc, parent);
157 if (error)
158 return error;
159
160 platform_set_drvdata(pdev, ctlr);
161
162 ctlr->dev.of_node = parent->of_node;
163
164 pm_runtime_enable(rpc->dev);
165
166 ctlr->num_chipselect = 1;
167 ctlr->mem_ops = &rpcif_spi_mem_ops;
168
169 ctlr->bits_per_word_mask = SPI_BPW_MASK(8);
170 ctlr->mode_bits = SPI_CPOL | SPI_CPHA | SPI_TX_QUAD | SPI_RX_QUAD;
171 ctlr->flags = SPI_CONTROLLER_HALF_DUPLEX;
172
173 error = rpcif_hw_init(rpc->dev, false);
174 if (error)
175 goto out_disable_rpm;
176
177 error = spi_register_controller(ctlr);
178 if (error) {
179 dev_err(&pdev->dev, "spi_register_controller failed\n");
180 goto out_disable_rpm;
181 }
182
183 return 0;
184
185 out_disable_rpm:
186 pm_runtime_disable(rpc->dev);
187 return error;
188 }
189
rpcif_spi_remove(struct platform_device * pdev)190 static void rpcif_spi_remove(struct platform_device *pdev)
191 {
192 struct spi_controller *ctlr = platform_get_drvdata(pdev);
193 struct rpcif *rpc = spi_controller_get_devdata(ctlr);
194
195 spi_unregister_controller(ctlr);
196 pm_runtime_disable(rpc->dev);
197 }
198
rpcif_spi_suspend(struct device * dev)199 static int __maybe_unused rpcif_spi_suspend(struct device *dev)
200 {
201 struct spi_controller *ctlr = dev_get_drvdata(dev);
202
203 return spi_controller_suspend(ctlr);
204 }
205
rpcif_spi_resume(struct device * dev)206 static int __maybe_unused rpcif_spi_resume(struct device *dev)
207 {
208 struct spi_controller *ctlr = dev_get_drvdata(dev);
209
210 return spi_controller_resume(ctlr);
211 }
212
213 static SIMPLE_DEV_PM_OPS(rpcif_spi_pm_ops, rpcif_spi_suspend, rpcif_spi_resume);
214
215 static const struct platform_device_id rpc_if_spi_id_table[] = {
216 { .name = "rpc-if-spi" },
217 { /* sentinel */ }
218 };
219 MODULE_DEVICE_TABLE(platform, rpc_if_spi_id_table);
220
221 static struct platform_driver rpcif_spi_driver = {
222 .probe = rpcif_spi_probe,
223 .remove = rpcif_spi_remove,
224 .id_table = rpc_if_spi_id_table,
225 .driver = {
226 .name = "rpc-if-spi",
227 #ifdef CONFIG_PM_SLEEP
228 .pm = &rpcif_spi_pm_ops,
229 #endif
230 },
231 };
232 module_platform_driver(rpcif_spi_driver);
233
234 MODULE_DESCRIPTION("Renesas RPC-IF SPI driver");
235 MODULE_LICENSE("GPL v2");
236