mtk_spi_v1.c

/*-
 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
 * Copyright (c) 2011, Aleksandr Rybalko <ray@FreeBSD.org>
 * Copyright (c) 2013, Alexander A. Mityaev <sansan@adm.ua>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice unmodified, this list of conditions, and the following
 *    disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 THE AUTHOR OR CONTRIBUTORS 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.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/bus.h>

#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/rman.h>
#include <sys/lock.h>
#include <sys/mutex.h>

#include <machine/bus.h>
#include <machine/cpu.h>

#include <sys/gpio.h>
#include "gpiobus_if.h"

#include <dev/gpio/gpiobusvar.h>

#include <dev/spibus/spi.h>
#include <dev/spibus/spibusvar.h>
#include "spibus_if.h"

#include "opt_platform.h"

#include <dev/ofw/openfirm.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>

#include <mips/mediatek/mtk_soc.h>
#include <mips/mediatek/mtk_spi_v1.h>
#include <dev/flash/mx25lreg.h>

#undef MTK_SPI_DEBUG
#ifdef MTK_SPI_DEBUG
#define dprintf printf
#else
#define dprintf(x, arg...)
#endif

/*
 * register space access macros
 */
#define SPI_WRITE(sc, reg, val)	do {	\
		bus_write_4(sc->sc_mem_res, (reg), (val)); \
	} while (0)

#define SPI_READ(sc, reg)	 bus_read_4(sc->sc_mem_res, (reg))

#define SPI_SET_BITS(sc, reg, bits)	\
	SPI_WRITE(sc, reg, SPI_READ(sc, (reg)) | (bits))

#define SPI_CLEAR_BITS(sc, reg, bits)	\
	SPI_WRITE(sc, reg, SPI_READ(sc, (reg)) & ~(bits))

struct mtk_spi_softc {
	device_t		sc_dev;
	struct resource		*sc_mem_res;
	struct gpiobus_pin	*gpio_cs;
	int			nonflash;
};

static int	mtk_spi_probe(device_t);
static int	mtk_spi_attach(device_t);
static int	mtk_spi_detach(device_t);
static int	mtk_spi_wait(struct mtk_spi_softc *);
static void	mtk_spi_chip_activate(struct mtk_spi_softc *);
static void	mtk_spi_chip_deactivate(struct mtk_spi_softc *);
static uint8_t	mtk_spi_txrx(struct mtk_spi_softc *, uint8_t *, int);
static int	mtk_spi_transfer(device_t, device_t, struct spi_command *);
static phandle_t mtk_spi_get_node(device_t, device_t);

static struct ofw_compat_data compat_data[] = {
	{ "ralink,rt2880-spi",	1 },
	{ "ralink,rt3050-spi",	1 },
	{ "ralink,rt3352-spi",	1 },
	{ "ralink,rt3883-spi",	1 },
	{ "ralink,rt5350-spi",	1 },
	{ "ralink,mt7620a-spi",	1 },
	{ NULL,			0 }
};

static int
mtk_spi_probe(device_t dev)
{

	if (!ofw_bus_status_okay(dev))
		return (ENXIO);

	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
		return(ENXIO);

	device_set_desc(dev, "MTK SPI Controller (v1)");

	return (0);
}

static int
mtk_spi_attach(device_t dev)
{
	struct mtk_spi_softc *sc = device_get_softc(dev);
	int rid;

	sc->sc_dev = dev;
        rid = 0;
	sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
	    RF_SHAREABLE | RF_ACTIVE);
	if (!sc->sc_mem_res) {
		device_printf(dev, "Could not map memory\n");
		return (ENXIO);
	}

	if (mtk_spi_wait(sc)) {
		bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
		return (EBUSY);
	}

	if (ofw_bus_has_prop(dev, "non-flash"))
		sc->nonflash = 1;
	else
		sc->nonflash = 0;

	ofw_gpiobus_parse_gpios(dev, "cs-gpios", &sc->gpio_cs);

	if (sc->gpio_cs != NULL) {
		GPIO_PIN_SETFLAGS(sc->gpio_cs->dev, sc->gpio_cs->pin,
		    GPIO_PIN_OUTPUT);
		GPIO_PIN_SET(sc->gpio_cs->dev, sc->gpio_cs->pin, 1);
	}

	device_add_child(dev, "spibus", -1);
	return (bus_generic_attach(dev));
}

static int
mtk_spi_detach(device_t dev)
{
	struct mtk_spi_softc *sc = device_get_softc(dev);

	SPI_SET_BITS(sc, MTK_SPICTL, HIZSMOSI | CS_HIGH);

	if (sc->sc_mem_res)
		bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);

	return (0);
}

static void
mtk_spi_chip_activate(struct mtk_spi_softc *sc)
{
        mtk_spi_wait(sc);
	/*
	 * Put all CSx to low
	 */
	if (sc->gpio_cs != NULL) {
		GPIO_PIN_SET(sc->gpio_cs->dev, sc->gpio_cs->pin, 0);
		SPI_CLEAR_BITS(sc, MTK_SPICTL, HIZSMOSI);
	} else {
		SPI_CLEAR_BITS(sc, MTK_SPICTL, CS_HIGH | HIZSMOSI);
	}
}

static void
mtk_spi_chip_deactivate(struct mtk_spi_softc *sc)
{
        mtk_spi_wait(sc);
	/*
	 * Put all CSx to high
	 */
	if (sc->gpio_cs != NULL) {
		GPIO_PIN_SET(sc->gpio_cs->dev, sc->gpio_cs->pin, 1);
		SPI_SET_BITS(sc, MTK_SPICTL, HIZSMOSI);
	} else {
		SPI_SET_BITS(sc, MTK_SPICTL, CS_HIGH | HIZSMOSI);
	}
}

static int
mtk_spi_wait(struct mtk_spi_softc *sc)
{
	int i = 1000;

	while (i--) {
		if (!SPI_READ(sc, MTK_SPIBUSY))
			break;
	}
	if (i == 0) {
		printf("busy\n");
		return (1);
	}

	return (0);
}

static uint8_t
mtk_spi_txrx(struct mtk_spi_softc *sc, uint8_t *data, int write)
{

	if (mtk_spi_wait(sc))
		return (EBUSY);

	if (write == MTK_SPI_WRITE) {
		SPI_WRITE(sc, MTK_SPIDATA, *data);
		SPI_SET_BITS(sc, MTK_SPICTL, START_WRITE);
	} else {/* MTK_SPI_READ */
		SPI_SET_BITS(sc, MTK_SPICTL, START_READ);
		if (mtk_spi_wait(sc))
			return (EBUSY);

		*data = SPI_READ(sc, MTK_SPIDATA) & 0xff;
	}
	return (0);
}

static int
mtk_spi_transfer(device_t dev, device_t child, struct spi_command *cmd)
{
	struct mtk_spi_softc *sc;
	uint8_t *buf, byte, *tx_buf;
	uint32_t cs, clock, mode;
	int i, sz, error = 0, write = 0;
	int div, clk, cfgreg;

	sc = device_get_softc(dev);

	spibus_get_cs(child, &cs);
	spibus_get_clock(child, &clock);
	spibus_get_mode(child, &mode);

	cs &= ~SPIBUS_CS_HIGH;

	if (cs != 0)
		/* Only 1 CS */
		return (ENXIO);

	cfgreg = MSBFIRST;
	switch(mode) {
		case 0:	/* This is workadound because of
			   mode 0 not work this soc. */
		case 3:
			cfgreg |= SPICLKPOL | TX_ON_CLK_FALL;
                        break;
		case 1:
			cfgreg |= TX_ON_CLK_FALL;
                        break;
		case 2:
			cfgreg |= CAPT_ON_CLK_FALL;
                        break;
	}

	/*
	 * W25Q64CV max 104MHz, bus 120-192 MHz, so divide by 2.
	 * Update: divide by 4, DEV2 to fast for flash.
	 */
	if (clock != 0) {
		div = (mtk_soc_get_cpuclk() + (clock - 1)) / clock;
		clk = fls(div) - 2;
		if (clk < 0)
			clk = 0;
		else if (clk > 6)
			clk = 6;
	} else {
		clk = 6;
	}

	SPI_WRITE(sc, MTK_SPICFG, cfgreg | clk);

	if (sc->nonflash == 0) {
		/* There is always a command to transfer. */
		tx_buf = (uint8_t *)(cmd->tx_cmd);

		/* Perform some fixup because MTK dont support duplex SPI */
		switch(tx_buf[0]) {
			case CMD_READ_IDENT:
				cmd->tx_cmd_sz = 1;
				cmd->rx_cmd_sz = 3;
				break;
			case CMD_ENTER_4B_MODE:
			case CMD_EXIT_4B_MODE:
			case CMD_WRITE_ENABLE:
			case CMD_WRITE_DISABLE:
				cmd->tx_cmd_sz = 1;
				cmd->rx_cmd_sz = 0;
				break;
			case CMD_READ_STATUS:
				cmd->tx_cmd_sz = 1;
				cmd->rx_cmd_sz = 1;
				break;
			case CMD_READ:
			case CMD_FAST_READ:
				cmd->rx_cmd_sz = cmd->tx_data_sz = 0;
				break;
			case CMD_SECTOR_ERASE:
				cmd->rx_cmd_sz = 0;
				break;
			case CMD_PAGE_PROGRAM:
				cmd->rx_cmd_sz = cmd->rx_data_sz = 0;
				break;
		}
	}
        
	mtk_spi_chip_activate(sc);

	if (cmd->tx_cmd_sz + cmd->rx_cmd_sz) {
		buf = (uint8_t *)(cmd->rx_cmd);
		tx_buf = (uint8_t *)(cmd->tx_cmd);
		sz = cmd->tx_cmd_sz;
		if (sc->nonflash == 0)
			sz += cmd->rx_cmd_sz;

		for (i = 0; i < sz; i++) {
                        if(i < cmd->tx_cmd_sz) {
			        byte = tx_buf[i];
        			error = mtk_spi_txrx(sc, &byte,
		        	    MTK_SPI_WRITE);
        			if (error)
        				goto mtk_spi_transfer_fail;
                                continue;
                        }
                        error = mtk_spi_txrx(sc, &byte,
		            MTK_SPI_READ);
        		if (error)
        			goto mtk_spi_transfer_fail;
			buf[i] = byte;
		}
	}
	
	/*
	 * Transfer/Receive data
	 */
	
	if (cmd->tx_data_sz + cmd->rx_data_sz) {
		write = (cmd->tx_data_sz > 0)?1:0;
		buf = (uint8_t *)(write ? cmd->tx_data : cmd->rx_data);
		sz = write ? cmd->tx_data_sz : cmd->rx_data_sz;

		for (i = 0; i < sz; i++) {
			byte = buf[i];
			error = mtk_spi_txrx(sc, &byte,
			    write ? MTK_SPI_WRITE : MTK_SPI_READ);
			if (error)
				goto mtk_spi_transfer_fail;
			buf[i] = byte;
		}
	}
mtk_spi_transfer_fail:
	mtk_spi_chip_deactivate(sc);

	return (error);
}

static phandle_t
mtk_spi_get_node(device_t bus, device_t dev)
{

	/* We only have one child, the SPI bus, which needs our own node. */
	return (ofw_bus_get_node(bus));
}

static device_method_t mtk_spi_methods[] = {
	/* Device interface */
	DEVMETHOD(device_probe,		mtk_spi_probe),
	DEVMETHOD(device_attach,	mtk_spi_attach),
	DEVMETHOD(device_detach,	mtk_spi_detach),

	DEVMETHOD(spibus_transfer,	mtk_spi_transfer),

	/* ofw_bus interface */
	DEVMETHOD(ofw_bus_get_node,	mtk_spi_get_node),

	DEVMETHOD_END
};

static driver_t mtk_spi_driver = {
	.name = "spi",
	.methods = mtk_spi_methods,
	.size = sizeof(struct mtk_spi_softc),
};

static devclass_t mtk_spi_devclass;

DRIVER_MODULE(mtk_spi_v1, simplebus, mtk_spi_driver, mtk_spi_devclass, 0, 0);