2 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
3 * Copyright (c) 2011, Aleksandr Rybalko <ray@FreeBSD.org>
4 * Copyright (c) 2013, Alexander A. Mityaev <sansan@adm.ua>
5 * Copyright (c) 2016, Stanislav Galabov <sgalabov@gmail.com>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice unmodified, this list of conditions, and the following
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
42 #include <sys/mutex.h>
44 #include <machine/bus.h>
45 #include <machine/cpu.h>
47 #include <dev/spibus/spi.h>
48 #include <dev/spibus/spibusvar.h>
49 #include "spibus_if.h"
51 #include "opt_platform.h"
53 #include <dev/ofw/openfirm.h>
54 #include <dev/ofw/ofw_bus.h>
55 #include <dev/ofw/ofw_bus_subr.h>
57 #include <mips/mediatek/mtk_spi_v2.h>
58 #include <dev/flash/mx25lreg.h>
62 #define dprintf printf
64 #define dprintf(x, arg...)
68 * register space access macros
70 #define SPI_WRITE(sc, reg, val) do { \
71 bus_write_4(sc->sc_mem_res, (reg), (val)); \
74 #define SPI_READ(sc, reg) bus_read_4(sc->sc_mem_res, (reg))
76 #define SPI_SET_BITS(sc, reg, bits) \
77 SPI_WRITE(sc, reg, SPI_READ(sc, (reg)) | (bits))
79 #define SPI_CLEAR_BITS(sc, reg, bits) \
80 SPI_WRITE(sc, reg, SPI_READ(sc, (reg)) & ~(bits))
82 struct mtk_spi_softc {
84 struct resource *sc_mem_res;
87 static int mtk_spi_probe(device_t);
88 static int mtk_spi_attach(device_t);
89 static int mtk_spi_detach(device_t);
90 static int mtk_spi_wait(struct mtk_spi_softc *);
91 static void mtk_spi_chip_activate(struct mtk_spi_softc *);
92 static void mtk_spi_chip_deactivate(struct mtk_spi_softc *);
93 static uint8_t mtk_spi_txrx(struct mtk_spi_softc *, uint8_t *, int);
94 static int mtk_spi_transfer(device_t, device_t, struct spi_command *);
95 static phandle_t mtk_spi_get_node(device_t, device_t);
97 static struct ofw_compat_data compat_data[] = {
98 { "ralink,mt7621-spi", 1 },
99 { "ralink,mtk7628an-spi", 1 },
104 mtk_spi_probe(device_t dev)
107 if (!ofw_bus_status_okay(dev))
110 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
113 device_set_desc(dev, "MTK SPI Controller (v2)");
119 mtk_spi_attach(device_t dev)
121 struct mtk_spi_softc *sc = device_get_softc(dev);
127 sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
129 if (!sc->sc_mem_res) {
130 device_printf(dev, "Could not map memory\n");
134 if (mtk_spi_wait(sc)) {
135 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
139 val = SPI_READ(sc, MTK_SPIMASTER);
140 val &= ~(0xfff << 16);
144 SPI_WRITE(sc, MTK_SPIMASTER, val);
146 * W25Q64CV max 104MHz, bus 120-192 MHz, so divide by 2.
147 * Update: divide by 4, DEV2 to fast for flash.
150 device_add_child(dev, "spibus", 0);
151 return (bus_generic_attach(dev));
155 mtk_spi_detach(device_t dev)
157 struct mtk_spi_softc *sc = device_get_softc(dev);
160 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
166 mtk_spi_chip_activate(struct mtk_spi_softc *sc)
172 SPI_SET_BITS(sc, MTK_SPIPOLAR, 1);
176 mtk_spi_chip_deactivate(struct mtk_spi_softc *sc)
180 * Put all CSx to high
182 SPI_CLEAR_BITS(sc, MTK_SPIPOLAR, 1);
186 mtk_spi_wait(struct mtk_spi_softc *sc)
191 if (!(SPI_READ(sc, MTK_SPITRANS) & SPIBUSY))
202 mtk_spi_txrx(struct mtk_spi_softc *sc, uint8_t *data, int write)
205 if (mtk_spi_wait(sc))
208 if (write == MTK_SPI_WRITE) {
209 SPI_WRITE(sc, MTK_SPIOPCODE, (*data));
210 SPI_WRITE(sc, MTK_SPIMOREBUF, (8<<24));
212 SPI_WRITE(sc, MTK_SPIMOREBUF, (8<<12));
215 SPI_SET_BITS(sc, MTK_SPITRANS, SPISTART);
217 if (mtk_spi_wait(sc))
220 if (write == MTK_SPI_READ) {
221 *data = SPI_READ(sc, MTK_SPIDATA) & 0xff;
228 mtk_spi_transfer(device_t dev, device_t child, struct spi_command *cmd)
230 struct mtk_spi_softc *sc;
231 uint8_t *buf, byte, *tx_buf;
233 int i, sz, error, write = 0;
235 sc = device_get_softc(dev);
237 spibus_get_cs(child, &cs);
239 cs &= ~SPIBUS_CS_HIGH;
245 /* There is always a command to transfer. */
246 tx_buf = (uint8_t *)(cmd->tx_cmd);
248 /* Perform some fixup because MTK dont support duplex SPI */
254 case CMD_ENTER_4B_MODE:
255 case CMD_EXIT_4B_MODE:
256 case CMD_WRITE_ENABLE:
257 case CMD_WRITE_DISABLE:
261 case CMD_READ_STATUS:
267 cmd->rx_cmd_sz = cmd->tx_data_sz = 0;
269 case CMD_SECTOR_ERASE:
272 case CMD_PAGE_PROGRAM:
273 cmd->rx_cmd_sz = cmd->rx_data_sz = 0;
277 mtk_spi_chip_activate(sc);
279 if (cmd->tx_cmd_sz + cmd->rx_cmd_sz) {
280 buf = (uint8_t *)(cmd->rx_cmd);
281 tx_buf = (uint8_t *)(cmd->tx_cmd);
282 sz = cmd->tx_cmd_sz + cmd->rx_cmd_sz;
284 for (i = 0; i < sz; i++) {
285 if(i < cmd->tx_cmd_sz) {
287 error = mtk_spi_txrx(sc, &byte,
290 goto mtk_spi_transfer_fail;
293 error = mtk_spi_txrx(sc, &byte,
296 goto mtk_spi_transfer_fail;
302 * Transfer/Receive data
305 if (cmd->tx_data_sz + cmd->rx_data_sz) {
306 write = (cmd->tx_data_sz > 0)?1:0;
307 buf = (uint8_t *)(write ? cmd->tx_data : cmd->rx_data);
308 sz = write ? cmd->tx_data_sz : cmd->rx_data_sz;
310 for (i = 0; i < sz; i++) {
312 error = mtk_spi_txrx(sc, &byte,
313 write ? MTK_SPI_WRITE : MTK_SPI_READ);
315 goto mtk_spi_transfer_fail;
319 mtk_spi_transfer_fail:
320 mtk_spi_chip_deactivate(sc);
326 mtk_spi_get_node(device_t bus, device_t dev)
329 /* We only have one child, the SPI bus, which needs our own node. */
330 return (ofw_bus_get_node(bus));
333 static device_method_t mtk_spi_methods[] = {
334 /* Device interface */
335 DEVMETHOD(device_probe, mtk_spi_probe),
336 DEVMETHOD(device_attach, mtk_spi_attach),
337 DEVMETHOD(device_detach, mtk_spi_detach),
339 DEVMETHOD(spibus_transfer, mtk_spi_transfer),
341 /* ofw_bus interface */
342 DEVMETHOD(ofw_bus_get_node, mtk_spi_get_node),
347 static driver_t mtk_spi_driver = {
349 .methods = mtk_spi_methods,
350 .size = sizeof(struct mtk_spi_softc),
353 static devclass_t mtk_spi_devclass;
355 DRIVER_MODULE(mtk_spi_v2, simplebus, mtk_spi_driver, mtk_spi_devclass, 0, 0);