Add driver for Cadence Quad SPI Flash Controller found on
Intel® Arria® 10 SoC. Cadence Quad SPI Flash is not generic SPI controller, but SPI flash controller, so don't use spibus here, instead provide quad spi flash interface. Since it is not on spibus, then mx25l flash device driver is not usable here, so provide new n25q flash device driver with quad spi flash interface. Sponsored by: DARPA, AFRL Differential Revision: https://reviews.freebsd.org/D10245
This commit is contained in:
br
parent
a525500c85
commit
90d3977775
@ -1762,7 +1762,7 @@ dev/fdt/fdt_clock_if.m optional fdt fdt_clock
|
||||
dev/fdt/fdt_common.c optional fdt
|
||||
dev/fdt/fdt_pinctrl.c optional fdt fdt_pinctrl
|
||||
dev/fdt/fdt_pinctrl_if.m optional fdt fdt_pinctrl
|
||||
dev/fdt/fdt_slicer.c optional fdt cfi | fdt nand | fdt mx25l
|
||||
dev/fdt/fdt_slicer.c optional fdt cfi | fdt nand | fdt mx25l | fdt n25q
|
||||
dev/fdt/fdt_static_dtb.S optional fdt fdt_dtb_static \
|
||||
dependency "fdt_dtb_file"
|
||||
dev/fdt/simplebus.c optional fdt
|
||||
@ -1781,7 +1781,10 @@ dev/firewire/if_fwip.c optional fwip
|
||||
dev/firewire/sbp.c optional sbp
|
||||
dev/firewire/sbp_targ.c optional sbp_targ
|
||||
dev/flash/at45d.c optional at45d
|
||||
dev/flash/cqspi.c optional cqspi
|
||||
dev/flash/mx25l.c optional mx25l
|
||||
dev/flash/n25q.c optional n25q
|
||||
dev/flash/qspi_if.m optional cqspi | n25q
|
||||
dev/fxp/if_fxp.c optional fxp
|
||||
dev/fxp/inphy.c optional fxp
|
||||
dev/gem/if_gem.c optional gem
|
||||
@ -3672,7 +3675,7 @@ geom/geom_disk.c standard
|
||||
geom/geom_dump.c standard
|
||||
geom/geom_event.c standard
|
||||
geom/geom_fox.c optional geom_fox
|
||||
geom/geom_flashmap.c optional fdt cfi | fdt nand | fdt mx25l | mmcsd
|
||||
geom/geom_flashmap.c optional fdt cfi | fdt nand | fdt mx25l | mmcsd | fdt n25q
|
||||
geom/geom_io.c standard
|
||||
geom/geom_kern.c standard
|
||||
geom/geom_map.c optional geom_map
|
||||
|
||||
768
sys/dev/flash/cqspi.c
Normal file
768
sys/dev/flash/cqspi.c
Normal file
@ -0,0 +1,768 @@
|
||||
/*-
|
||||
* Copyright (c) 2017-2018 Ruslan Bukin <br@bsdpad.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* This software was developed by SRI International and the University of
|
||||
* Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
|
||||
* ("CTSRD"), as part of the DARPA CRASH research programme.
|
||||
*
|
||||
* 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, 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.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Cadence Quad SPI Flash Controller driver.
|
||||
* 4B-addressing mode supported only.
|
||||
*/
|
||||
|
||||
#include <sys/cdefs.h>
|
||||
__FBSDID("$FreeBSD$");
|
||||
|
||||
#include "opt_platform.h"
|
||||
|
||||
#include <sys/param.h>
|
||||
#include <sys/systm.h>
|
||||
#include <sys/bio.h>
|
||||
#include <sys/bus.h>
|
||||
#include <sys/conf.h>
|
||||
#include <sys/kernel.h>
|
||||
#include <sys/kthread.h>
|
||||
#include <sys/lock.h>
|
||||
#include <sys/mbuf.h>
|
||||
#include <sys/malloc.h>
|
||||
#include <sys/module.h>
|
||||
#include <sys/mutex.h>
|
||||
#include <geom/geom_disk.h>
|
||||
|
||||
#include <machine/bus.h>
|
||||
|
||||
#include <dev/fdt/simplebus.h>
|
||||
#include <dev/fdt/fdt_common.h>
|
||||
#include <dev/ofw/ofw_bus_subr.h>
|
||||
#include <dev/ofw/openfirm.h>
|
||||
|
||||
#include <dev/flash/cqspi.h>
|
||||
#include <dev/flash/mx25lreg.h>
|
||||
#include <dev/xdma/xdma.h>
|
||||
|
||||
#include "qspi_if.h"
|
||||
|
||||
#define CQSPI_DEBUG
|
||||
#undef CQSPI_DEBUG
|
||||
|
||||
#ifdef CQSPI_DEBUG
|
||||
#define dprintf(fmt, ...) printf(fmt, ##__VA_ARGS__)
|
||||
#else
|
||||
#define dprintf(fmt, ...)
|
||||
#endif
|
||||
|
||||
#define CQSPI_SECTORSIZE 512
|
||||
#define TX_QUEUE_SIZE 16
|
||||
#define RX_QUEUE_SIZE 16
|
||||
|
||||
#define READ4(_sc, _reg) bus_read_4((_sc)->res[0], _reg)
|
||||
#define READ2(_sc, _reg) bus_read_2((_sc)->res[0], _reg)
|
||||
#define READ1(_sc, _reg) bus_read_1((_sc)->res[0], _reg)
|
||||
#define WRITE4(_sc, _reg, _val) bus_write_4((_sc)->res[0], _reg, _val)
|
||||
#define WRITE2(_sc, _reg, _val) bus_write_2((_sc)->res[0], _reg, _val)
|
||||
#define WRITE1(_sc, _reg, _val) bus_write_1((_sc)->res[0], _reg, _val)
|
||||
#define READ_DATA_4(_sc, _reg) bus_read_4((_sc)->res[1], _reg)
|
||||
#define READ_DATA_1(_sc, _reg) bus_read_1((_sc)->res[1], _reg)
|
||||
#define WRITE_DATA_4(_sc, _reg, _val) bus_write_4((_sc)->res[1], _reg, _val)
|
||||
#define WRITE_DATA_1(_sc, _reg, _val) bus_write_1((_sc)->res[1], _reg, _val)
|
||||
|
||||
struct cqspi_softc {
|
||||
device_t dev;
|
||||
|
||||
struct resource *res[3];
|
||||
bus_space_tag_t bst;
|
||||
bus_space_handle_t bsh;
|
||||
void *ih;
|
||||
uint8_t read_op_done;
|
||||
uint8_t write_op_done;
|
||||
|
||||
uint32_t fifo_depth;
|
||||
uint32_t fifo_width;
|
||||
uint32_t trigger_address;
|
||||
uint32_t sram_phys;
|
||||
|
||||
/* xDMA */
|
||||
xdma_controller_t *xdma_tx;
|
||||
xdma_channel_t *xchan_tx;
|
||||
void *ih_tx;
|
||||
|
||||
xdma_controller_t *xdma_rx;
|
||||
xdma_channel_t *xchan_rx;
|
||||
void *ih_rx;
|
||||
|
||||
struct intr_config_hook config_intrhook;
|
||||
struct mtx sc_mtx;
|
||||
};
|
||||
|
||||
#define CQSPI_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
|
||||
#define CQSPI_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
|
||||
#define CQSPI_LOCK_INIT(_sc) \
|
||||
mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->dev), \
|
||||
"cqspi", MTX_DEF)
|
||||
#define CQSPI_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
|
||||
#define CQSPI_ASSERT_LOCKED(_sc) \
|
||||
mtx_assert(&_sc->sc_mtx, MA_OWNED);
|
||||
#define CQSPI_ASSERT_UNLOCKED(_sc) \
|
||||
mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
|
||||
|
||||
static struct resource_spec cqspi_spec[] = {
|
||||
{ SYS_RES_MEMORY, 0, RF_ACTIVE },
|
||||
{ SYS_RES_MEMORY, 1, RF_ACTIVE },
|
||||
{ SYS_RES_IRQ, 0, RF_ACTIVE },
|
||||
{ -1, 0 }
|
||||
};
|
||||
|
||||
static struct ofw_compat_data compat_data[] = {
|
||||
{ "cdns,qspi-nor", 1 },
|
||||
{ NULL, 0 },
|
||||
};
|
||||
|
||||
static void
|
||||
cqspi_intr(void *arg)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
uint32_t pending;
|
||||
|
||||
sc = arg;
|
||||
|
||||
pending = READ4(sc, CQSPI_IRQSTAT);
|
||||
|
||||
dprintf("%s: IRQSTAT %x\n", __func__, pending);
|
||||
|
||||
if (pending & (IRQMASK_INDOPDONE | IRQMASK_INDXFRLVL |
|
||||
IRQMASK_INDSRAMFULL)) {
|
||||
/* TODO: PIO operation done */
|
||||
}
|
||||
|
||||
WRITE4(sc, CQSPI_IRQSTAT, pending);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_xdma_tx_intr(void *arg, xdma_transfer_status_t *status)
|
||||
{
|
||||
struct xdma_transfer_status st;
|
||||
struct cqspi_softc *sc;
|
||||
struct bio *bp;
|
||||
int ret;
|
||||
int deq;
|
||||
|
||||
sc = arg;
|
||||
|
||||
dprintf("%s\n", __func__);
|
||||
|
||||
deq = 0;
|
||||
|
||||
while (1) {
|
||||
ret = xdma_dequeue_bio(sc->xchan_tx, &bp, &st);
|
||||
if (ret != 0) {
|
||||
break;
|
||||
}
|
||||
sc->write_op_done = 1;
|
||||
deq++;
|
||||
}
|
||||
|
||||
if (deq > 1)
|
||||
device_printf(sc->dev,
|
||||
"Warning: more than 1 tx bio dequeued\n");
|
||||
|
||||
wakeup(&sc->xdma_tx);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_xdma_rx_intr(void *arg, xdma_transfer_status_t *status)
|
||||
{
|
||||
struct xdma_transfer_status st;
|
||||
struct cqspi_softc *sc;
|
||||
struct bio *bp;
|
||||
int ret;
|
||||
int deq;
|
||||
|
||||
sc = arg;
|
||||
|
||||
dprintf("%s\n", __func__);
|
||||
|
||||
deq = 0;
|
||||
|
||||
while (1) {
|
||||
ret = xdma_dequeue_bio(sc->xchan_rx, &bp, &st);
|
||||
if (ret != 0) {
|
||||
break;
|
||||
}
|
||||
sc->read_op_done = 1;
|
||||
deq++;
|
||||
}
|
||||
|
||||
if (deq > 1)
|
||||
device_printf(sc->dev,
|
||||
"Warning: more than 1 rx bio dequeued\n");
|
||||
|
||||
wakeup(&sc->xdma_rx);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_wait_for_completion(struct cqspi_softc *sc)
|
||||
{
|
||||
int timeout;
|
||||
int i;
|
||||
|
||||
timeout = 10000;
|
||||
|
||||
for (i = timeout; i > 0; i--) {
|
||||
if ((READ4(sc, CQSPI_FLASHCMD) & FLASHCMD_CMDEXECSTAT) == 0) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (i == 0) {
|
||||
device_printf(sc->dev, "%s: cmd timed out: %x\n",
|
||||
__func__, READ4(sc, CQSPI_FLASHCMD));
|
||||
return (-1);
|
||||
}
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_cmd_write_addr(struct cqspi_softc *sc, uint8_t cmd,
|
||||
uint32_t addr, uint32_t len)
|
||||
{
|
||||
uint32_t reg;
|
||||
int ret;
|
||||
|
||||
dprintf("%s: %x\n", __func__, cmd);
|
||||
|
||||
WRITE4(sc, CQSPI_FLASHCMDADDR, addr);
|
||||
reg = (cmd << FLASHCMD_CMDOPCODE_S);
|
||||
reg |= (FLASHCMD_ENCMDADDR);
|
||||
reg |= ((len - 1) << FLASHCMD_NUMADDRBYTES_S);
|
||||
WRITE4(sc, CQSPI_FLASHCMD, reg);
|
||||
|
||||
reg |= FLASHCMD_EXECCMD;
|
||||
WRITE4(sc, CQSPI_FLASHCMD, reg);
|
||||
|
||||
ret = cqspi_wait_for_completion(sc);
|
||||
|
||||
return (ret);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_cmd_write(struct cqspi_softc *sc, uint8_t cmd,
|
||||
uint8_t *addr, uint32_t len)
|
||||
{
|
||||
uint32_t reg;
|
||||
int ret;
|
||||
|
||||
reg = (cmd << FLASHCMD_CMDOPCODE_S);
|
||||
WRITE4(sc, CQSPI_FLASHCMD, reg);
|
||||
reg |= FLASHCMD_EXECCMD;
|
||||
WRITE4(sc, CQSPI_FLASHCMD, reg);
|
||||
|
||||
ret = cqspi_wait_for_completion(sc);
|
||||
|
||||
return (ret);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_cmd_read(struct cqspi_softc *sc, uint8_t cmd,
|
||||
uint8_t *addr, uint32_t len)
|
||||
{
|
||||
uint32_t data;
|
||||
uint32_t reg;
|
||||
uint8_t *buf;
|
||||
int ret;
|
||||
int i;
|
||||
|
||||
if (len > 8) {
|
||||
device_printf(sc->dev, "Failed to read data\n");
|
||||
return (-1);
|
||||
}
|
||||
|
||||
dprintf("%s: %x\n", __func__, cmd);
|
||||
|
||||
buf = (uint8_t *)addr;
|
||||
|
||||
reg = (cmd << FLASHCMD_CMDOPCODE_S);
|
||||
reg |= ((len - 1) << FLASHCMD_NUMRDDATABYTES_S);
|
||||
reg |= FLASHCMD_ENRDDATA;
|
||||
WRITE4(sc, CQSPI_FLASHCMD, reg);
|
||||
|
||||
reg |= FLASHCMD_EXECCMD;
|
||||
WRITE4(sc, CQSPI_FLASHCMD, reg);
|
||||
|
||||
ret = cqspi_wait_for_completion(sc);
|
||||
if (ret != 0) {
|
||||
device_printf(sc->dev, "%s: cmd failed: %x\n",
|
||||
__func__, cmd);
|
||||
return (ret);
|
||||
}
|
||||
|
||||
data = READ4(sc, CQSPI_FLASHCMDRDDATALO);
|
||||
|
||||
for (i = 0; i < len; i++)
|
||||
buf[i] = (data >> (i * 8)) & 0xff;
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_wait_ready(struct cqspi_softc *sc)
|
||||
{
|
||||
uint8_t data;
|
||||
int ret;
|
||||
|
||||
do {
|
||||
ret = cqspi_cmd_read(sc, CMD_READ_STATUS, &data, 1);
|
||||
} while (data & STATUS_WIP);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_write_reg(device_t dev, device_t child,
|
||||
uint8_t opcode, uint8_t *addr, uint32_t len)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
int ret;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
ret = cqspi_cmd_write(sc, opcode, addr, len);
|
||||
|
||||
return (ret);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_read_reg(device_t dev, device_t child,
|
||||
uint8_t opcode, uint8_t *addr, uint32_t len)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
int ret;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
ret = cqspi_cmd_read(sc, opcode, addr, len);
|
||||
|
||||
return (ret);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_wait_idle(struct cqspi_softc *sc)
|
||||
{
|
||||
uint32_t reg;
|
||||
|
||||
do {
|
||||
reg = READ4(sc, CQSPI_CFG);
|
||||
if (reg & CFG_IDLE) {
|
||||
break;
|
||||
}
|
||||
} while (1);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_erase(device_t dev, device_t child, off_t offset)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
int ret;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
cqspi_wait_ready(sc);
|
||||
ret = cqspi_cmd_write(sc, CMD_WRITE_ENABLE, 0, 0);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
cqspi_wait_ready(sc);
|
||||
ret = cqspi_cmd_write_addr(sc, CMD_QUAD_SECTOR_ERASE, offset, 4);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_write(device_t dev, device_t child, struct bio *bp,
|
||||
off_t offset, caddr_t data, off_t count)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
uint32_t reg;
|
||||
|
||||
dprintf("%s: offset 0x%llx count %lld bytes\n",
|
||||
__func__, offset, count);
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
cqspi_wait_ready(sc);
|
||||
reg = cqspi_cmd_write(sc, CMD_WRITE_ENABLE, 0, 0);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
cqspi_wait_ready(sc);
|
||||
cqspi_wait_idle(sc);
|
||||
|
||||
reg = DMAPER_NUMSGLREQBYTES_4;
|
||||
reg |= DMAPER_NUMBURSTREQBYTES_4;
|
||||
WRITE4(sc, CQSPI_DMAPER, reg);
|
||||
|
||||
WRITE4(sc, CQSPI_INDWRWATER, 64);
|
||||
WRITE4(sc, CQSPI_INDWR, INDRD_IND_OPS_DONE_STATUS);
|
||||
WRITE4(sc, CQSPI_INDWR, 0);
|
||||
|
||||
WRITE4(sc, CQSPI_INDWRCNT, count);
|
||||
WRITE4(sc, CQSPI_INDWRSTADDR, offset);
|
||||
|
||||
reg = (0 << DEVWR_DUMMYWRCLKS_S);
|
||||
reg |= DEVWR_DATA_WIDTH_QUAD;
|
||||
reg |= DEVWR_ADDR_WIDTH_SINGLE;
|
||||
reg |= (CMD_QUAD_PAGE_PROGRAM << DEVWR_WROPCODE_S);
|
||||
WRITE4(sc, CQSPI_DEVWR, reg);
|
||||
|
||||
reg = DEVRD_DATA_WIDTH_QUAD;
|
||||
reg |= DEVRD_ADDR_WIDTH_SINGLE;
|
||||
reg |= DEVRD_INST_WIDTH_SINGLE;
|
||||
WRITE4(sc, CQSPI_DEVRD, reg);
|
||||
|
||||
xdma_enqueue_bio(sc->xchan_tx, &bp,
|
||||
sc->sram_phys, 4, 4, XDMA_MEM_TO_DEV);
|
||||
xdma_queue_submit(sc->xchan_tx);
|
||||
|
||||
sc->write_op_done = 0;
|
||||
|
||||
WRITE4(sc, CQSPI_INDWR, INDRD_START);
|
||||
|
||||
while (sc->write_op_done == 0)
|
||||
tsleep(&sc->xdma_tx, PCATCH | PZERO, "spi", hz/2);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_read(device_t dev, device_t child, struct bio *bp,
|
||||
off_t offset, caddr_t data, off_t count)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
uint32_t reg;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
dprintf("%s: offset 0x%llx count %lld bytes\n",
|
||||
__func__, offset, count);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
|
||||
reg = DMAPER_NUMSGLREQBYTES_4;
|
||||
reg |= DMAPER_NUMBURSTREQBYTES_4;
|
||||
WRITE4(sc, CQSPI_DMAPER, reg);
|
||||
|
||||
WRITE4(sc, CQSPI_INDRDWATER, 64);
|
||||
WRITE4(sc, CQSPI_INDRD, INDRD_IND_OPS_DONE_STATUS);
|
||||
WRITE4(sc, CQSPI_INDRD, 0);
|
||||
|
||||
WRITE4(sc, CQSPI_INDRDCNT, count);
|
||||
WRITE4(sc, CQSPI_INDRDSTADDR, offset);
|
||||
|
||||
reg = (0 << DEVRD_DUMMYRDCLKS_S);
|
||||
reg |= DEVRD_DATA_WIDTH_QUAD;
|
||||
reg |= DEVRD_ADDR_WIDTH_SINGLE;
|
||||
reg |= DEVRD_INST_WIDTH_SINGLE;
|
||||
reg |= DEVRD_ENMODEBITS;
|
||||
reg |= (CMD_READ_4B_QUAD_OUTPUT << DEVRD_RDOPCODE_S);
|
||||
WRITE4(sc, CQSPI_DEVRD, reg);
|
||||
|
||||
WRITE4(sc, CQSPI_MODEBIT, 0xff);
|
||||
WRITE4(sc, CQSPI_IRQMASK, 0);
|
||||
|
||||
xdma_enqueue_bio(sc->xchan_rx, &bp, sc->sram_phys, 4, 4,
|
||||
XDMA_DEV_TO_MEM);
|
||||
xdma_queue_submit(sc->xchan_rx);
|
||||
|
||||
sc->read_op_done = 0;
|
||||
|
||||
WRITE4(sc, CQSPI_INDRD, INDRD_START);
|
||||
|
||||
while (sc->read_op_done == 0)
|
||||
tsleep(&sc->xdma_rx, PCATCH | PZERO, "spi", hz/2);
|
||||
|
||||
cqspi_wait_idle(sc);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_init(struct cqspi_softc *sc)
|
||||
{
|
||||
pcell_t dts_value[1];
|
||||
phandle_t node;
|
||||
uint32_t reg;
|
||||
int len;
|
||||
|
||||
device_printf(sc->dev, "Module ID %x\n",
|
||||
READ4(sc, CQSPI_MODULEID));
|
||||
|
||||
if ((node = ofw_bus_get_node(sc->dev)) == -1) {
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
if ((len = OF_getproplen(node, "cdns,fifo-depth")) <= 0) {
|
||||
return (ENXIO);
|
||||
}
|
||||
OF_getencprop(node, "cdns,fifo-depth", dts_value, len);
|
||||
sc->fifo_depth = dts_value[0];
|
||||
|
||||
if ((len = OF_getproplen(node, "cdns,fifo-width")) <= 0) {
|
||||
return (ENXIO);
|
||||
}
|
||||
OF_getencprop(node, "cdns,fifo-width", dts_value, len);
|
||||
sc->fifo_width = dts_value[0];
|
||||
|
||||
if ((len = OF_getproplen(node, "cdns,trigger-address")) <= 0) {
|
||||
return (ENXIO);
|
||||
}
|
||||
OF_getencprop(node, "cdns,trigger-address", dts_value, len);
|
||||
sc->trigger_address = dts_value[0];
|
||||
|
||||
/* Disable controller */
|
||||
reg = READ4(sc, CQSPI_CFG);
|
||||
reg &= ~(CFG_EN);
|
||||
WRITE4(sc, CQSPI_CFG, reg);
|
||||
|
||||
reg = READ4(sc, CQSPI_DEVSZ);
|
||||
reg &= ~(DEVSZ_NUMADDRBYTES_M);
|
||||
reg |= ((4 - 1) - DEVSZ_NUMADDRBYTES_S);
|
||||
WRITE4(sc, CQSPI_DEVSZ, reg);
|
||||
|
||||
WRITE4(sc, CQSPI_SRAMPART, sc->fifo_depth/2);
|
||||
|
||||
/* TODO: calculate baud rate and delay values. */
|
||||
|
||||
reg = READ4(sc, CQSPI_CFG);
|
||||
/* Configure baud rate */
|
||||
reg &= ~(CFG_BAUD_M);
|
||||
reg |= CFG_BAUD12;
|
||||
reg |= CFG_ENDMA;
|
||||
WRITE4(sc, CQSPI_CFG, reg);
|
||||
|
||||
reg = (3 << DELAY_NSS_S);
|
||||
reg |= (3 << DELAY_BTWN_S);
|
||||
reg |= (1 << DELAY_AFTER_S);
|
||||
reg |= (1 << DELAY_INIT_S);
|
||||
WRITE4(sc, CQSPI_DELAY, reg);
|
||||
|
||||
READ4(sc, CQSPI_RDDATACAP);
|
||||
reg &= ~(RDDATACAP_DELAY_M);
|
||||
reg |= (1 << RDDATACAP_DELAY_S);
|
||||
WRITE4(sc, CQSPI_RDDATACAP, reg);
|
||||
|
||||
/* Enable controller */
|
||||
reg = READ4(sc, CQSPI_CFG);
|
||||
reg |= (CFG_EN);
|
||||
WRITE4(sc, CQSPI_CFG, reg);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_add_devices(device_t dev)
|
||||
{
|
||||
phandle_t child, node;
|
||||
device_t child_dev;
|
||||
int error;
|
||||
|
||||
node = ofw_bus_get_node(dev);
|
||||
|
||||
for (child = OF_child(node); child != 0; child = OF_peer(child)) {
|
||||
child_dev =
|
||||
simplebus_add_device(dev, child, 0, NULL, -1, NULL);
|
||||
if (child_dev == NULL) {
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
error = device_probe_and_attach(child_dev);
|
||||
if (error != 0) {
|
||||
printf("can't probe and attach: %d\n", error);
|
||||
}
|
||||
}
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static void
|
||||
cqspi_delayed_attach(void *arg)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
|
||||
sc = arg;
|
||||
|
||||
cqspi_add_devices(sc->dev);
|
||||
bus_generic_attach(sc->dev);
|
||||
|
||||
config_intrhook_disestablish(&sc->config_intrhook);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_probe(device_t dev)
|
||||
{
|
||||
|
||||
if (!ofw_bus_status_okay(dev)) {
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data) {
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
device_set_desc(dev, "Cadence Quad SPI controller");
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_attach(device_t dev)
|
||||
{
|
||||
struct cqspi_softc *sc;
|
||||
uint32_t caps;
|
||||
int error;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
sc->dev = dev;
|
||||
|
||||
if (bus_alloc_resources(dev, cqspi_spec, sc->res)) {
|
||||
device_printf(dev, "could not allocate resources\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
/* Memory interface */
|
||||
sc->bst = rman_get_bustag(sc->res[0]);
|
||||
sc->bsh = rman_get_bushandle(sc->res[0]);
|
||||
|
||||
sc->sram_phys = rman_get_start(sc->res[1]);
|
||||
|
||||
/* Setup interrupt handlers */
|
||||
if (bus_setup_intr(sc->dev, sc->res[2], INTR_TYPE_BIO | INTR_MPSAFE,
|
||||
NULL, cqspi_intr, sc, &sc->ih)) {
|
||||
device_printf(sc->dev, "Unable to setup intr\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
CQSPI_LOCK_INIT(sc);
|
||||
|
||||
caps = 0;
|
||||
|
||||
/* Get xDMA controller. */
|
||||
sc->xdma_tx = xdma_ofw_get(sc->dev, "tx");
|
||||
if (sc->xdma_tx == NULL) {
|
||||
device_printf(dev, "Can't find DMA controller.\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
sc->xdma_rx = xdma_ofw_get(sc->dev, "rx");
|
||||
if (sc->xdma_rx == NULL) {
|
||||
device_printf(dev, "Can't find DMA controller.\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
/* Alloc xDMA virtual channels. */
|
||||
sc->xchan_tx = xdma_channel_alloc(sc->xdma_tx, caps);
|
||||
if (sc->xchan_tx == NULL) {
|
||||
device_printf(dev, "Can't alloc virtual DMA channel.\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
sc->xchan_rx = xdma_channel_alloc(sc->xdma_rx, caps);
|
||||
if (sc->xchan_rx == NULL) {
|
||||
device_printf(dev, "Can't alloc virtual DMA channel.\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
/* Setup xDMA interrupt handlers. */
|
||||
error = xdma_setup_intr(sc->xchan_tx, cqspi_xdma_tx_intr,
|
||||
sc, &sc->ih_tx);
|
||||
if (error) {
|
||||
device_printf(sc->dev,
|
||||
"Can't setup xDMA interrupt handler.\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
error = xdma_setup_intr(sc->xchan_rx, cqspi_xdma_rx_intr,
|
||||
sc, &sc->ih_rx);
|
||||
if (error) {
|
||||
device_printf(sc->dev,
|
||||
"Can't setup xDMA interrupt handler.\n");
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
xdma_prep_sg(sc->xchan_tx, TX_QUEUE_SIZE, MAXPHYS, 8, 16, 0,
|
||||
BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR);
|
||||
xdma_prep_sg(sc->xchan_rx, TX_QUEUE_SIZE, MAXPHYS, 8, 16, 0,
|
||||
BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR);
|
||||
|
||||
cqspi_init(sc);
|
||||
|
||||
sc->config_intrhook.ich_func = cqspi_delayed_attach;
|
||||
sc->config_intrhook.ich_arg = sc;
|
||||
if (config_intrhook_establish(&sc->config_intrhook) != 0) {
|
||||
device_printf(dev, "config_intrhook_establish failed\n");
|
||||
return (ENOMEM);
|
||||
}
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
cqspi_detach(device_t dev)
|
||||
{
|
||||
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
static device_method_t cqspi_methods[] = {
|
||||
/* Device interface */
|
||||
DEVMETHOD(device_probe, cqspi_probe),
|
||||
DEVMETHOD(device_attach, cqspi_attach),
|
||||
DEVMETHOD(device_detach, cqspi_detach),
|
||||
|
||||
/* Quad SPI Flash Interface */
|
||||
DEVMETHOD(qspi_read_reg, cqspi_read_reg),
|
||||
DEVMETHOD(qspi_write_reg, cqspi_write_reg),
|
||||
DEVMETHOD(qspi_read, cqspi_read),
|
||||
DEVMETHOD(qspi_write, cqspi_write),
|
||||
DEVMETHOD(qspi_erase, cqspi_erase),
|
||||
|
||||
{ 0, 0 }
|
||||
};
|
||||
|
||||
static devclass_t cqspi_devclass;
|
||||
|
||||
DEFINE_CLASS_1(cqspi, cqspi_driver, cqspi_methods,
|
||||
sizeof(struct cqspi_softc), simplebus_driver);
|
||||
|
||||
DRIVER_MODULE(cqspi, simplebus, cqspi_driver, cqspi_devclass, 0, 0);
|
||||
134
sys/dev/flash/cqspi.h
Normal file
134
sys/dev/flash/cqspi.h
Normal file
@ -0,0 +1,134 @@
|
||||
/*-
|
||||
* Copyright (c) 2017-2018 Ruslan Bukin <br@bsdpad.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* This software was developed by SRI International and the University of
|
||||
* Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
|
||||
* ("CTSRD"), as part of the DARPA CRASH research programme.
|
||||
*
|
||||
* 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, 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.
|
||||
*
|
||||
* $FreeBSD$
|
||||
*/
|
||||
|
||||
#ifndef _CQSPI_H_
|
||||
#define _CQSPI_H_
|
||||
|
||||
#define CQSPI_CFG 0x00 /* QSPI Configuration */
|
||||
#define CFG_IDLE (1 << 31)
|
||||
#define CFG_ENDMA (1 << 15)
|
||||
#define CFG_IDLE (1 << 31)
|
||||
#define CFG_BAUD_S 19
|
||||
#define CFG_BAUD_M (0xf << CFG_BAUD_S)
|
||||
#define CFG_BAUD2 (0 << CFG_BAUD_S)
|
||||
#define CFG_BAUD4 (1 << CFG_BAUD_S)
|
||||
#define CFG_BAUD6 (2 << CFG_BAUD_S)
|
||||
#define CFG_BAUD8 (3 << CFG_BAUD_S)
|
||||
#define CFG_BAUD10 (4 << CFG_BAUD_S)
|
||||
#define CFG_BAUD12 (5 << CFG_BAUD_S)
|
||||
#define CFG_BAUD14 (6 << CFG_BAUD_S)
|
||||
#define CFG_BAUD16 (7 << CFG_BAUD_S)
|
||||
#define CFG_BAUD18 (8 << CFG_BAUD_S)
|
||||
#define CFG_BAUD20 (9 << CFG_BAUD_S)
|
||||
#define CFG_BAUD22 (10 << CFG_BAUD_S)
|
||||
#define CFG_BAUD24 (11 << CFG_BAUD_S)
|
||||
#define CFG_BAUD26 (12 << CFG_BAUD_S)
|
||||
#define CFG_BAUD28 (13 << CFG_BAUD_S)
|
||||
#define CFG_BAUD30 (14 << CFG_BAUD_S)
|
||||
#define CFG_BAUD32 (0xf << CFG_BAUD_S)
|
||||
#define CFG_EN (1 << 0)
|
||||
#define CQSPI_DEVRD 0x04 /* Device Read Instruction Configuration */
|
||||
#define DEVRD_DUMMYRDCLKS_S 24
|
||||
#define DEVRD_ENMODEBITS (1 << 20)
|
||||
#define DEVRD_DATA_WIDTH_S 16
|
||||
#define DEVRD_DATA_WIDTH_QUAD (2 << DEVRD_DATA_WIDTH_S)
|
||||
#define DEVRD_ADDR_WIDTH_S 12
|
||||
#define DEVRD_ADDR_WIDTH_SINGLE (0 << DEVRD_ADDR_WIDTH_S)
|
||||
#define DEVRD_INST_WIDTH_S 8
|
||||
#define DEVRD_INST_WIDTH_SINGLE (0 << DEVRD_INST_WIDTH_S)
|
||||
#define DEVRD_RDOPCODE_S 0
|
||||
#define CQSPI_DEVWR 0x08 /* Device Write Instruction Configuration */
|
||||
#define DEVWR_DUMMYWRCLKS_S 24
|
||||
#define DEVWR_WROPCODE_S 0
|
||||
#define DEVWR_DATA_WIDTH_S 16
|
||||
#define DEVWR_DATA_WIDTH_QUAD (2 << DEVWR_DATA_WIDTH_S)
|
||||
#define DEVWR_ADDR_WIDTH_S 12
|
||||
#define DEVWR_ADDR_WIDTH_SINGLE (0 << DEVWR_ADDR_WIDTH_S)
|
||||
#define CQSPI_DELAY 0x0C /* QSPI Device Delay Register */
|
||||
#define DELAY_NSS_S 24
|
||||
#define DELAY_BTWN_S 16
|
||||
#define DELAY_AFTER_S 8
|
||||
#define DELAY_INIT_S 0
|
||||
#define CQSPI_RDDATACAP 0x10 /* Read Data Capture Register */
|
||||
#define RDDATACAP_DELAY_S 1
|
||||
#define RDDATACAP_DELAY_M (0xf << RDDATACAP_DELAY_S)
|
||||
#define CQSPI_DEVSZ 0x14 /* Device Size Configuration Register */
|
||||
#define DEVSZ_NUMADDRBYTES_S 0
|
||||
#define DEVSZ_NUMADDRBYTES_M (0xf << DEVSZ_NUMADDRBYTES_S)
|
||||
#define CQSPI_SRAMPART 0x18 /* SRAM Partition Configuration Register */
|
||||
#define CQSPI_INDADDRTRIG 0x1C /* Indirect AHB Address Trigger Register */
|
||||
#define CQSPI_DMAPER 0x20 /* DMA Peripheral Configuration Register */
|
||||
#define DMAPER_NUMSGLREQBYTES_S 0
|
||||
#define DMAPER_NUMBURSTREQBYTES_S 8
|
||||
#define DMAPER_NUMSGLREQBYTES_4 (2 << DMAPER_NUMSGLREQBYTES_S);
|
||||
#define DMAPER_NUMBURSTREQBYTES_4 (2 << DMAPER_NUMBURSTREQBYTES_S);
|
||||
#define CQSPI_REMAPADDR 0x24 /* Remap Address Register */
|
||||
#define CQSPI_MODEBIT 0x28 /* Mode Bit Configuration */
|
||||
#define CQSPI_SRAMFILL 0x2C /* SRAM Fill Register */
|
||||
#define CQSPI_TXTHRESH 0x30 /* TX Threshold Register */
|
||||
#define CQSPI_RXTHRESH 0x34 /* RX Threshold Register */
|
||||
#define CQSPI_IRQSTAT 0x40 /* Interrupt Status Register */
|
||||
#define CQSPI_IRQMASK 0x44 /* Interrupt Mask */
|
||||
#define IRQMASK_INDSRAMFULL (1 << 12)
|
||||
#define IRQMASK_INDXFRLVL (1 << 6)
|
||||
#define IRQMASK_INDOPDONE (1 << 2)
|
||||
#define CQSPI_LOWWRPROT 0x50 /* Lower Write Protection */
|
||||
#define CQSPI_UPPWRPROT 0x54 /* Upper Write Protection */
|
||||
#define CQSPI_WRPROT 0x58 /* Write Protection Control Register */
|
||||
#define CQSPI_INDRD 0x60 /* Indirect Read Transfer Control Register */
|
||||
#define INDRD_IND_OPS_DONE_STATUS (1 << 5)
|
||||
#define INDRD_START (1 << 0)
|
||||
#define CQSPI_INDRDWATER 0x64 /* Indirect Read Transfer Watermark Register */
|
||||
#define CQSPI_INDRDSTADDR 0x68 /* Indirect Read Transfer Start Address Register */
|
||||
#define CQSPI_INDRDCNT 0x6C /* Indirect Read Transfer Number Bytes Register */
|
||||
#define CQSPI_INDWR 0x70 /* Indirect Write Transfer Control Register */
|
||||
#define CQSPI_INDWRWATER 0x74 /* Indirect Write Transfer Watermark Register */
|
||||
#define CQSPI_INDWRSTADDR 0x78 /* Indirect Write Transfer Start Address Register */
|
||||
#define CQSPI_INDWRCNT 0x7C /* Indirect Write Transfer Number Bytes Register */
|
||||
#define CQSPI_FLASHCMD 0x90 /* Flash Command Control Register */
|
||||
#define FLASHCMD_NUMADDRBYTES_S 16
|
||||
#define FLASHCMD_NUMRDDATABYTES_S 20
|
||||
#define FLASHCMD_NUMRDDATABYTES_M (0x7 << FLASHCMD_NUMRDDATABYTES_S)
|
||||
#define FLASHCMD_ENCMDADDR (1 << 19)
|
||||
#define FLASHCMD_ENRDDATA (1 << 23)
|
||||
#define FLASHCMD_CMDOPCODE_S 24
|
||||
#define FLASHCMD_CMDOPCODE_M (0xff << FLASHCMD_CMDOPCODE_S)
|
||||
#define FLASHCMD_CMDEXECSTAT (1 << 1) /* Command execution in progress. */
|
||||
#define FLASHCMD_EXECCMD (1 << 0) /* Execute the command. */
|
||||
#define CQSPI_FLASHCMDADDR 0x94 /* Flash Command Address Registers */
|
||||
#define CQSPI_FLASHCMDRDDATALO 0xA0 /* Flash Command Read Data Register (Lower) */
|
||||
#define CQSPI_FLASHCMDRDDATAUP 0xA4 /* Flash Command Read Data Register (Upper) */
|
||||
#define CQSPI_FLASHCMDWRDATALO 0xA8 /* Flash Command Write Data Register (Lower) */
|
||||
#define CQSPI_FLASHCMDWRDATAUP 0xAC /* Flash Command Write Data Register (Upper) */
|
||||
#define CQSPI_MODULEID 0xFC /* Module ID Register */
|
||||
|
||||
#endif /* !_CQSPI_H_ */
|
||||
@ -50,6 +50,11 @@
|
||||
#define CMD_ENTER_4B_MODE 0xB7
|
||||
#define CMD_EXIT_4B_MODE 0xE9
|
||||
|
||||
/* Quad 4B-addressing operations. */
|
||||
#define CMD_QUAD_SECTOR_ERASE 0xDC
|
||||
#define CMD_QUAD_PAGE_PROGRAM 0x34
|
||||
#define CMD_READ_4B_QUAD_OUTPUT 0x6C
|
||||
|
||||
/*
|
||||
* Status register flags
|
||||
*/
|
||||
|
||||
490
sys/dev/flash/n25q.c
Normal file
490
sys/dev/flash/n25q.c
Normal file
@ -0,0 +1,490 @@
|
||||
/*-
|
||||
* Copyright (c) 2006 M. Warner Losh. All rights reserved.
|
||||
* Copyright (c) 2009 Oleksandr Tymoshenko. All rights reserved.
|
||||
* Copyright (c) 2017 Ruslan Bukin <br@bsdpad.com>
|
||||
* Copyright (c) 2018 Ian Lepore. All rights reserved.
|
||||
* All rights reserved.
|
||||
*
|
||||
* This software was developed by SRI International and the University of
|
||||
* Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
|
||||
* ("CTSRD"), as part of the DARPA CRASH research programme.
|
||||
*
|
||||
* 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, 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.
|
||||
*/
|
||||
|
||||
/* n25q Quad SPI Flash driver. */
|
||||
|
||||
#include <sys/cdefs.h>
|
||||
__FBSDID("$FreeBSD$");
|
||||
|
||||
#include "opt_platform.h"
|
||||
|
||||
#include <sys/param.h>
|
||||
#include <sys/systm.h>
|
||||
#include <sys/bio.h>
|
||||
#include <sys/bus.h>
|
||||
#include <sys/conf.h>
|
||||
#include <sys/kernel.h>
|
||||
#include <sys/kthread.h>
|
||||
#include <sys/lock.h>
|
||||
#include <sys/mbuf.h>
|
||||
#include <sys/malloc.h>
|
||||
#include <sys/module.h>
|
||||
#include <sys/mutex.h>
|
||||
#include <geom/geom_disk.h>
|
||||
|
||||
#include <machine/bus.h>
|
||||
|
||||
#include <dev/fdt/fdt_common.h>
|
||||
#include <dev/ofw/ofw_bus_subr.h>
|
||||
#include <dev/ofw/openfirm.h>
|
||||
|
||||
#include <dev/flash/mx25lreg.h>
|
||||
|
||||
#include "qspi_if.h"
|
||||
|
||||
#define N25Q_DEBUG
|
||||
#undef N25Q_DEBUG
|
||||
|
||||
#ifdef N25Q_DEBUG
|
||||
#define dprintf(fmt, ...) printf(fmt, ##__VA_ARGS__)
|
||||
#else
|
||||
#define dprintf(fmt, ...)
|
||||
#endif
|
||||
|
||||
#define FL_NONE 0x00
|
||||
#define FL_ERASE_4K 0x01
|
||||
#define FL_ERASE_32K 0x02
|
||||
#define FL_ENABLE_4B_ADDR 0x04
|
||||
#define FL_DISABLE_4B_ADDR 0x08
|
||||
|
||||
/*
|
||||
* Define the sectorsize to be a smaller size rather than the flash
|
||||
* sector size. Trying to run FFS off of a 64k flash sector size
|
||||
* results in a completely un-usable system.
|
||||
*/
|
||||
#define FLASH_SECTORSIZE 512
|
||||
|
||||
struct n25q_flash_ident {
|
||||
const char *name;
|
||||
uint8_t manufacturer_id;
|
||||
uint16_t device_id;
|
||||
unsigned int sectorsize;
|
||||
unsigned int sectorcount;
|
||||
unsigned int flags;
|
||||
};
|
||||
|
||||
struct n25q_softc {
|
||||
device_t dev;
|
||||
bus_space_tag_t bst;
|
||||
bus_space_handle_t bsh;
|
||||
void *ih;
|
||||
struct resource *res[3];
|
||||
|
||||
uint8_t sc_manufacturer_id;
|
||||
uint16_t device_id;
|
||||
unsigned int sc_sectorsize;
|
||||
struct mtx sc_mtx;
|
||||
struct disk *sc_disk;
|
||||
struct proc *sc_p;
|
||||
struct bio_queue_head sc_bio_queue;
|
||||
unsigned int sc_flags;
|
||||
unsigned int sc_taskstate;
|
||||
};
|
||||
|
||||
#define TSTATE_STOPPED 0
|
||||
#define TSTATE_STOPPING 1
|
||||
#define TSTATE_RUNNING 2
|
||||
|
||||
#define N25Q_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
|
||||
#define N25Q_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
|
||||
#define N25Q_LOCK_INIT(_sc) \
|
||||
mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->dev), \
|
||||
"n25q", MTX_DEF)
|
||||
#define N25Q_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
|
||||
#define N25Q_ASSERT_LOCKED(_sc) \
|
||||
mtx_assert(&_sc->sc_mtx, MA_OWNED);
|
||||
#define N25Q_ASSERT_UNLOCKED(_sc) \
|
||||
mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
|
||||
|
||||
static struct ofw_compat_data compat_data[] = {
|
||||
{ "n25q00aa", 1 },
|
||||
{ NULL, 0 },
|
||||
};
|
||||
|
||||
/* disk routines */
|
||||
static int n25q_open(struct disk *dp);
|
||||
static int n25q_close(struct disk *dp);
|
||||
static int n25q_ioctl(struct disk *, u_long, void *, int, struct thread *);
|
||||
static void n25q_strategy(struct bio *bp);
|
||||
static int n25q_getattr(struct bio *bp);
|
||||
static void n25q_task(void *arg);
|
||||
|
||||
struct n25q_flash_ident flash_devices[] = {
|
||||
{ "n25q00", 0x20, 0xbb21, (64 * 1024), 2048, FL_ENABLE_4B_ADDR},
|
||||
};
|
||||
|
||||
static int
|
||||
n25q_wait_for_device_ready(device_t dev)
|
||||
{
|
||||
device_t pdev;
|
||||
uint8_t status;
|
||||
int err;
|
||||
|
||||
pdev = device_get_parent(dev);
|
||||
|
||||
do {
|
||||
err = QSPI_READ_REG(pdev, dev, CMD_READ_STATUS, &status, 1);
|
||||
} while (err == 0 && (status & STATUS_WIP));
|
||||
|
||||
return (err);
|
||||
}
|
||||
|
||||
static struct n25q_flash_ident*
|
||||
n25q_get_device_ident(struct n25q_softc *sc)
|
||||
{
|
||||
uint8_t manufacturer_id;
|
||||
uint16_t dev_id;
|
||||
device_t pdev;
|
||||
uint8_t data[4];
|
||||
int i;
|
||||
|
||||
pdev = device_get_parent(sc->dev);
|
||||
|
||||
QSPI_READ_REG(pdev, sc->dev, CMD_READ_IDENT, (uint8_t *)&data[0], 4);
|
||||
|
||||
manufacturer_id = data[0];
|
||||
dev_id = (data[1] << 8) | (data[2]);
|
||||
|
||||
for (i = 0; i < nitems(flash_devices); i++) {
|
||||
if ((flash_devices[i].manufacturer_id == manufacturer_id) &&
|
||||
(flash_devices[i].device_id == dev_id))
|
||||
return &flash_devices[i];
|
||||
}
|
||||
|
||||
printf("Unknown SPI flash device. Vendor: %02x, device id: %04x\n",
|
||||
manufacturer_id, dev_id);
|
||||
|
||||
return (NULL);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_write(device_t dev, struct bio *bp, off_t offset, caddr_t data, off_t count)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
device_t pdev;
|
||||
int err;
|
||||
|
||||
pdev = device_get_parent(dev);
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
dprintf("%s: offset 0x%llx count %lld bytes\n", __func__, offset, count);
|
||||
|
||||
err = QSPI_ERASE(pdev, dev, offset);
|
||||
if (err != 0) {
|
||||
return (err);
|
||||
}
|
||||
|
||||
err = QSPI_WRITE(pdev, dev, bp, offset, data, count);
|
||||
|
||||
return (err);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_read(device_t dev, struct bio *bp, off_t offset, caddr_t data, off_t count)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
device_t pdev;
|
||||
int err;
|
||||
|
||||
pdev = device_get_parent(dev);
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
dprintf("%s: offset 0x%llx count %lld bytes\n", __func__, offset, count);
|
||||
|
||||
/*
|
||||
* Enforce the disk read sectorsize not the erase sectorsize.
|
||||
* In this way, smaller read IO is possible,dramatically
|
||||
* speeding up filesystem/geom_compress access.
|
||||
*/
|
||||
if (count % sc->sc_disk->d_sectorsize != 0
|
||||
|| offset % sc->sc_disk->d_sectorsize != 0) {
|
||||
printf("EIO\n");
|
||||
return (EIO);
|
||||
}
|
||||
|
||||
err = QSPI_READ(pdev, dev, bp, offset, data, count);
|
||||
|
||||
return (err);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_set_4b_mode(device_t dev, uint8_t command)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
device_t pdev;
|
||||
int err;
|
||||
|
||||
pdev = device_get_parent(dev);
|
||||
sc = device_get_softc(dev);
|
||||
|
||||
err = QSPI_WRITE_REG(pdev, dev, command, 0, 0);
|
||||
|
||||
return (err);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_probe(device_t dev)
|
||||
{
|
||||
int i;
|
||||
|
||||
if (!ofw_bus_status_okay(dev))
|
||||
return (ENXIO);
|
||||
|
||||
/* First try to match the compatible property to the compat_data */
|
||||
if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 1)
|
||||
goto found;
|
||||
|
||||
/*
|
||||
* Next, try to find a compatible device using the names in the
|
||||
* flash_devices structure
|
||||
*/
|
||||
for (i = 0; i < nitems(flash_devices); i++)
|
||||
if (ofw_bus_is_compatible(dev, flash_devices[i].name))
|
||||
goto found;
|
||||
|
||||
return (ENXIO);
|
||||
found:
|
||||
device_set_desc(dev, "Micron n25q");
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_attach(device_t dev)
|
||||
{
|
||||
struct n25q_flash_ident *ident;
|
||||
struct n25q_softc *sc;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
sc->dev = dev;
|
||||
|
||||
N25Q_LOCK_INIT(sc);
|
||||
|
||||
ident = n25q_get_device_ident(sc);
|
||||
if (ident == NULL) {
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
n25q_wait_for_device_ready(sc->dev);
|
||||
|
||||
sc->sc_disk = disk_alloc();
|
||||
sc->sc_disk->d_open = n25q_open;
|
||||
sc->sc_disk->d_close = n25q_close;
|
||||
sc->sc_disk->d_strategy = n25q_strategy;
|
||||
sc->sc_disk->d_getattr = n25q_getattr;
|
||||
sc->sc_disk->d_ioctl = n25q_ioctl;
|
||||
sc->sc_disk->d_name = "flash/qspi";
|
||||
sc->sc_disk->d_drv1 = sc;
|
||||
sc->sc_disk->d_maxsize = DFLTPHYS;
|
||||
sc->sc_disk->d_sectorsize = FLASH_SECTORSIZE;
|
||||
sc->sc_disk->d_mediasize = (ident->sectorsize * ident->sectorcount);
|
||||
sc->sc_disk->d_unit = device_get_unit(sc->dev);
|
||||
sc->sc_disk->d_dump = NULL;
|
||||
/* Sectorsize for erase operations */
|
||||
sc->sc_sectorsize = ident->sectorsize;
|
||||
sc->sc_flags = ident->flags;
|
||||
|
||||
if (sc->sc_flags & FL_ENABLE_4B_ADDR)
|
||||
n25q_set_4b_mode(dev, CMD_ENTER_4B_MODE);
|
||||
|
||||
if (sc->sc_flags & FL_DISABLE_4B_ADDR)
|
||||
n25q_set_4b_mode(dev, CMD_EXIT_4B_MODE);
|
||||
|
||||
/* NB: use stripesize to hold the erase/region size for RedBoot */
|
||||
sc->sc_disk->d_stripesize = ident->sectorsize;
|
||||
|
||||
disk_create(sc->sc_disk, DISK_VERSION);
|
||||
bioq_init(&sc->sc_bio_queue);
|
||||
|
||||
kproc_create(&n25q_task, sc, &sc->sc_p, 0, 0, "task: n25q flash");
|
||||
sc->sc_taskstate = TSTATE_RUNNING;
|
||||
|
||||
device_printf(sc->dev, "%s, sector %d bytes, %d sectors\n",
|
||||
ident->name, ident->sectorsize, ident->sectorcount);
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_detach(device_t dev)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
int err;
|
||||
|
||||
sc = device_get_softc(dev);
|
||||
err = 0;
|
||||
|
||||
N25Q_LOCK(sc);
|
||||
if (sc->sc_taskstate == TSTATE_RUNNING) {
|
||||
sc->sc_taskstate = TSTATE_STOPPING;
|
||||
wakeup(sc);
|
||||
while (err == 0 && sc->sc_taskstate != TSTATE_STOPPED) {
|
||||
err = msleep(sc, &sc->sc_mtx, 0, "n25q", hz * 3);
|
||||
if (err != 0) {
|
||||
sc->sc_taskstate = TSTATE_RUNNING;
|
||||
device_printf(sc->dev,
|
||||
"Failed to stop queue task\n");
|
||||
}
|
||||
}
|
||||
}
|
||||
N25Q_UNLOCK(sc);
|
||||
|
||||
if (err == 0 && sc->sc_taskstate == TSTATE_STOPPED) {
|
||||
disk_destroy(sc->sc_disk);
|
||||
bioq_flush(&sc->sc_bio_queue, NULL, ENXIO);
|
||||
N25Q_LOCK_DESTROY(sc);
|
||||
}
|
||||
return (err);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_open(struct disk *dp)
|
||||
{
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_close(struct disk *dp)
|
||||
{
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_ioctl(struct disk *dp, u_long cmd, void *data,
|
||||
int fflag, struct thread *td)
|
||||
{
|
||||
|
||||
return (EINVAL);
|
||||
}
|
||||
|
||||
static void
|
||||
n25q_strategy(struct bio *bp)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
|
||||
sc = (struct n25q_softc *)bp->bio_disk->d_drv1;
|
||||
|
||||
N25Q_LOCK(sc);
|
||||
bioq_disksort(&sc->sc_bio_queue, bp);
|
||||
wakeup(sc);
|
||||
N25Q_UNLOCK(sc);
|
||||
}
|
||||
|
||||
static int
|
||||
n25q_getattr(struct bio *bp)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
device_t dev;
|
||||
|
||||
if (bp->bio_disk == NULL || bp->bio_disk->d_drv1 == NULL) {
|
||||
return (ENXIO);
|
||||
}
|
||||
|
||||
sc = bp->bio_disk->d_drv1;
|
||||
dev = sc->dev;
|
||||
|
||||
if (strcmp(bp->bio_attribute, "SPI::device") == 0) {
|
||||
if (bp->bio_length != sizeof(dev)) {
|
||||
return (EFAULT);
|
||||
}
|
||||
bcopy(&dev, bp->bio_data, sizeof(dev));
|
||||
return (0);
|
||||
}
|
||||
|
||||
return (-1);
|
||||
}
|
||||
|
||||
static void
|
||||
n25q_task(void *arg)
|
||||
{
|
||||
struct n25q_softc *sc;
|
||||
struct bio *bp;
|
||||
device_t dev;
|
||||
|
||||
sc = (struct n25q_softc *)arg;
|
||||
|
||||
dev = sc->dev;
|
||||
|
||||
for (;;) {
|
||||
N25Q_LOCK(sc);
|
||||
do {
|
||||
if (sc->sc_taskstate == TSTATE_STOPPING) {
|
||||
sc->sc_taskstate = TSTATE_STOPPED;
|
||||
N25Q_UNLOCK(sc);
|
||||
wakeup(sc);
|
||||
kproc_exit(0);
|
||||
}
|
||||
bp = bioq_first(&sc->sc_bio_queue);
|
||||
if (bp == NULL)
|
||||
msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", hz);
|
||||
} while (bp == NULL);
|
||||
bioq_remove(&sc->sc_bio_queue, bp);
|
||||
N25Q_UNLOCK(sc);
|
||||
|
||||
switch (bp->bio_cmd) {
|
||||
case BIO_READ:
|
||||
bp->bio_error = n25q_read(dev, bp, bp->bio_offset,
|
||||
bp->bio_data, bp->bio_bcount);
|
||||
break;
|
||||
case BIO_WRITE:
|
||||
bp->bio_error = n25q_write(dev, bp, bp->bio_offset,
|
||||
bp->bio_data, bp->bio_bcount);
|
||||
break;
|
||||
default:
|
||||
bp->bio_error = EINVAL;
|
||||
}
|
||||
|
||||
biodone(bp);
|
||||
}
|
||||
}
|
||||
|
||||
static devclass_t n25q_devclass;
|
||||
|
||||
static device_method_t n25q_methods[] = {
|
||||
/* Device interface */
|
||||
DEVMETHOD(device_probe, n25q_probe),
|
||||
DEVMETHOD(device_attach, n25q_attach),
|
||||
DEVMETHOD(device_detach, n25q_detach),
|
||||
|
||||
{ 0, 0 }
|
||||
};
|
||||
|
||||
static driver_t n25q_driver = {
|
||||
"n25q",
|
||||
n25q_methods,
|
||||
sizeof(struct n25q_softc),
|
||||
};
|
||||
|
||||
DRIVER_MODULE(n25q, simplebus, n25q_driver, n25q_devclass, 0, 0);
|
||||
76
sys/dev/flash/qspi_if.m
Normal file
76
sys/dev/flash/qspi_if.m
Normal file
@ -0,0 +1,76 @@
|
||||
#-
|
||||
# Copyright (c) 2017-2018 Ruslan Bukin <br@bsdpad.com>
|
||||
# All rights reserved.
|
||||
#
|
||||
# This software was developed by SRI International and the University of
|
||||
# Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
|
||||
# ("CTSRD"), as part of the DARPA CRASH research programme.
|
||||
#
|
||||
# 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, 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.
|
||||
#
|
||||
# $FreeBSD$
|
||||
#
|
||||
|
||||
#include <sys/bus.h>
|
||||
#include <sys/bio.h>
|
||||
|
||||
INTERFACE qspi;
|
||||
|
||||
METHOD int read {
|
||||
device_t dev;
|
||||
device_t child;
|
||||
struct bio *bp;
|
||||
off_t offset;
|
||||
caddr_t data;
|
||||
off_t count;
|
||||
};
|
||||
|
||||
METHOD int write {
|
||||
device_t dev;
|
||||
device_t child;
|
||||
struct bio *bp;
|
||||
off_t offset;
|
||||
caddr_t data;
|
||||
off_t count;
|
||||
};
|
||||
|
||||
METHOD int erase {
|
||||
device_t dev;
|
||||
device_t child;
|
||||
off_t offset;
|
||||
};
|
||||
|
||||
METHOD int write_reg {
|
||||
device_t dev;
|
||||
device_t child;
|
||||
uint8_t opcode;
|
||||
uint8_t *addr;
|
||||
uint32_t len;
|
||||
};
|
||||
|
||||
METHOD int read_reg {
|
||||
device_t dev;
|
||||
device_t child;
|
||||
uint8_t opcode;
|
||||
uint8_t *addr;
|
||||
uint32_t len;
|
||||
};
|
||||
Loading…
Reference in New Issue
Block a user