nfc_rb.c revision 284083
1169695Skan/*- 2169695Skan * Copyright (C) 2015 Justin Hibbits 3169695Skan * All rights reserved. 4169695Skan * 5169695Skan * Redistribution and use in source and binary forms, with or without 6169695Skan * modification, are permitted provided that the following conditions 7169695Skan * are met: 8169695Skan * 1. Redistributions of source code must retain the above copyright 9169695Skan * notice, this list of conditions and the following disclaimer. 10169695Skan * 2. Redistributions in binary form must reproduce the above copyright 11169695Skan * notice, this list of conditions and the following disclaimer in the 12169695Skan * documentation and/or other materials provided with the distribution. 13169695Skan * 14169695Skan * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15169695Skan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16169695Skan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17169695Skan * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18169695Skan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19169695Skan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20169695Skan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21169695Skan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22169695Skan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23169695Skan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24169695Skan * SUCH DAMAGE. 25169695Skan */ 26169695Skan 27169695Skan/* RouterBoard 600/800 NAND controller driver. */ 28169695Skan 29169695Skan#include <sys/cdefs.h> 30169695Skan__FBSDID("$FreeBSD: head/sys/dev/nand/nfc_rb.c 284083 2015-06-06 16:38:40Z jhibbits $"); 31169695Skan 32169695Skan#include <sys/param.h> 33169695Skan#include <sys/systm.h> 34169695Skan#include <sys/proc.h> 35169695Skan#include <sys/bus.h> 36169695Skan#include <sys/conf.h> 37169695Skan#include <sys/kernel.h> 38169695Skan#include <sys/module.h> 39169695Skan#include <sys/malloc.h> 40169695Skan#include <sys/rman.h> 41169695Skan#include <sys/lock.h> 42169695Skan#include <sys/mutex.h> 43169695Skan#include <sys/time.h> 44169695Skan 45169695Skan#include <machine/bus.h> 46169695Skan 47169695Skan#include <dev/ofw/ofw_bus.h> 48169695Skan#include <dev/ofw/ofw_bus_subr.h> 49169695Skan 50169695Skan#include <dev/nand/nand.h> 51169695Skan#include <dev/nand/nandbus.h> 52169695Skan 53169695Skan#include <powerpc/mpc85xx/mpc85xx.h> 54169695Skan 55169695Skan#include "nfc_if.h" 56169695Skan#include "gpio_if.h" 57169695Skan 58169695Skan#define RB_NAND_DATA (0x00) 59169695Skan 60169695Skanstruct rb_nand_softc { 61169695Skan struct nand_softc nand_dev; 62169695Skan struct resource *sc_mem; 63169695Skan int rid; 64169695Skan device_t sc_gpio; 65169695Skan uint32_t sc_rdy_pin; 66169695Skan uint32_t sc_nce_pin; 67169695Skan uint32_t sc_cle_pin; 68169695Skan uint32_t sc_ale_pin; 69169695Skan}; 70169695Skan 71169695Skanstatic int rb_nand_attach(device_t); 72169695Skanstatic int rb_nand_probe(device_t); 73169695Skanstatic int rb_nand_send_command(device_t, uint8_t); 74169695Skanstatic int rb_nand_send_address(device_t, uint8_t); 75169695Skanstatic uint8_t rb_nand_read_byte(device_t); 76169695Skanstatic void rb_nand_read_buf(device_t, void *, uint32_t); 77169695Skanstatic void rb_nand_write_buf(device_t, void *, uint32_t); 78169695Skanstatic int rb_nand_select_cs(device_t, uint8_t); 79169695Skanstatic int rb_nand_read_rnb(device_t); 80169695Skan 81169695Skanstatic device_method_t rb_nand_methods[] = { 82169695Skan DEVMETHOD(device_probe, rb_nand_probe), 83169695Skan DEVMETHOD(device_attach, rb_nand_attach), 84169695Skan 85169695Skan DEVMETHOD(nfc_send_command, rb_nand_send_command), 86169695Skan DEVMETHOD(nfc_send_address, rb_nand_send_address), 87169695Skan DEVMETHOD(nfc_read_byte, rb_nand_read_byte), 88169695Skan DEVMETHOD(nfc_read_buf, rb_nand_read_buf), 89169695Skan DEVMETHOD(nfc_write_buf, rb_nand_write_buf), 90169695Skan DEVMETHOD(nfc_select_cs, rb_nand_select_cs), 91169695Skan DEVMETHOD(nfc_read_rnb, rb_nand_read_rnb), 92169695Skan 93169695Skan { 0, 0 }, 94169695Skan}; 95169695Skan 96169695Skanstatic driver_t rb_nand_driver = { 97169695Skan "nand", 98169695Skan rb_nand_methods, 99169695Skan sizeof(struct rb_nand_softc), 100169695Skan}; 101169695Skan 102169695Skanstatic devclass_t rb_nand_devclass; 103169695SkanDRIVER_MODULE(rb_nand, ofwbus, rb_nand_driver, rb_nand_devclass, 0, 0); 104169695Skan 105169695Skan#if 0 106169695Skanstatic const struct nand_ecc_data rb_ecc = { 107169695Skan .eccsize = 6, 108169695Skan .eccmode = NAND_ECC_SOFT, 109169695Skan .eccbytes = 6, 110169695Skan .eccpositions = { 8, 9, 10, 13, 14, 15 }, 111169695Skan}; 112169695Skan#endif 113169695Skan 114169695Skanstatic int 115169695Skanrb_nand_probe(device_t dev) 116169695Skan{ 117169695Skan const char *device_type; 118169695Skan 119169695Skan device_type = ofw_bus_get_type(dev); 120169695Skan 121169695Skan if (!device_type || strcmp(device_type, "rb,nand")) 122169695Skan return (ENXIO); 123169695Skan 124169695Skan device_set_desc(dev, "RouterBoard 333/600/800 NAND controller"); 125169695Skan return (BUS_PROBE_DEFAULT); 126169695Skan} 127169695Skan 128169695Skanstatic int 129169695Skanrb_nand_attach(device_t dev) 130169695Skan{ 131169695Skan struct rb_nand_softc *sc; 132169695Skan phandle_t node; 133169695Skan uint32_t ale[2],cle[2],nce[2],rdy[2]; 134169695Skan u_long size,start; 135169695Skan int err; 136169695Skan 137169695Skan sc = device_get_softc(dev); 138169695Skan node = ofw_bus_get_node(dev); 139169695Skan 140169695Skan if (OF_getprop(node, "ale", ale, sizeof(ale)) <= 0) { 141169695Skan return (ENXIO); 142169695Skan } 143169695Skan if (OF_getprop(node, "cle", cle, sizeof(cle)) <= 0) { 144169695Skan return (ENXIO); 145169695Skan } 146169695Skan if (OF_getprop(node, "nce", nce, sizeof(nce)) <= 0) { 147169695Skan return (ENXIO); 148169695Skan } 149169695Skan if (OF_getprop(node, "rdy", rdy, sizeof(rdy)) <= 0) { 150169695Skan return (ENXIO); 151169695Skan } 152169695Skan 153169695Skan if (ale[0] != cle[0] || ale[0] != nce[0] || ale[0] != rdy[0]) { 154169695Skan device_printf(dev, "GPIO handles for signals must match.\n"); 155169695Skan return (ENXIO); 156169695Skan } 157169695Skan sc->sc_ale_pin = ale[1]; 158169695Skan sc->sc_cle_pin = cle[1]; 159169695Skan sc->sc_nce_pin = nce[1]; 160169695Skan sc->sc_rdy_pin = rdy[1]; 161169695Skan 162169695Skan sc->sc_gpio = OF_device_from_xref(ale[0]); 163169695Skan if (sc->sc_gpio == NULL) { 164169695Skan device_printf(dev, "No GPIO resource found!\n"); 165169695Skan return (ENXIO); 166169695Skan } 167169695Skan 168169695Skan sc->sc_mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->rid, 169169695Skan RF_ACTIVE); 170169695Skan if (sc->sc_mem == NULL) { 171169695Skan device_printf(dev, "could not allocate resources!\n"); 172169695Skan return (ENXIO); 173169695Skan } 174169695Skan 175169695Skan start = rman_get_start(sc->sc_mem); 176169695Skan size = rman_get_size(sc->sc_mem); 177169695Skan if (law_enable(OCP85XX_TGTIF_LBC, start, size) != 0) { 178169695Skan bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->sc_mem); 179169695Skan device_printf(dev, "could not allocate local address window.\n"); 180169695Skan return (ENXIO); 181169695Skan } 182169695Skan 183169695Skan nand_init(&sc->nand_dev, dev, NAND_ECC_SOFT, 0, 0, NULL, NULL); 184169695Skan 185169695Skan err = nandbus_create(dev); 186169695Skan 187169695Skan return (err); 188169695Skan} 189169695Skan 190169695Skanstatic int 191169695Skanrb_nand_send_command(device_t dev, uint8_t command) 192169695Skan{ 193169695Skan struct rb_nand_softc *sc; 194169695Skan 195169695Skan nand_debug(NDBG_DRV,"rb_nand: send command %x", command); 196169695Skan 197169695Skan sc = device_get_softc(dev); 198169695Skan GPIO_PIN_SET(sc->sc_gpio, sc->sc_cle_pin, 1); 199169695Skan GPIO_PIN_SET(sc->sc_gpio, sc->sc_ale_pin, 0); 200 GPIO_PIN_SET(sc->sc_gpio, sc->sc_nce_pin, 0); 201 bus_write_1(sc->sc_mem, RB_NAND_DATA, command); 202 GPIO_PIN_SET(sc->sc_gpio, sc->sc_cle_pin, 0); 203 return (0); 204} 205 206static int 207rb_nand_send_address(device_t dev, uint8_t addr) 208{ 209 struct rb_nand_softc *sc; 210 211 nand_debug(NDBG_DRV,"rb_nand: send address %x", addr); 212 213 sc = device_get_softc(dev); 214 GPIO_PIN_SET(sc->sc_gpio, sc->sc_cle_pin, 0); 215 GPIO_PIN_SET(sc->sc_gpio, sc->sc_ale_pin, 1); 216 GPIO_PIN_SET(sc->sc_gpio, sc->sc_nce_pin, 0); 217 bus_write_1(sc->sc_mem, RB_NAND_DATA, addr); 218 GPIO_PIN_SET(sc->sc_gpio, sc->sc_ale_pin, 0); 219 return (0); 220} 221 222static uint8_t 223rb_nand_read_byte(device_t dev) 224{ 225 struct rb_nand_softc *sc; 226 uint8_t data; 227 228 sc = device_get_softc(dev); 229 data = bus_read_1(sc->sc_mem, RB_NAND_DATA); 230 231 nand_debug(NDBG_DRV,"rb_nand: read %x", data); 232 233 return (data); 234} 235 236static void 237rb_nand_read_buf(device_t dev, void* buf, uint32_t len) 238{ 239 struct rb_nand_softc *sc; 240 241 sc = device_get_softc(dev); 242 243 bus_read_region_1(sc->sc_mem, RB_NAND_DATA, buf, len); 244} 245 246static void 247rb_nand_write_buf(device_t dev, void* buf, uint32_t len) 248{ 249 struct rb_nand_softc *sc; 250 int i; 251 uint8_t *b = (uint8_t*)buf; 252 253 sc = device_get_softc(dev); 254 255 for (i = 0; i < len; i++) { 256#ifdef NAND_DEBUG 257 if (!(i % 16)) 258 printf("%s", i == 0 ? "rb_nand:\n" : "\n"); 259 printf(" %x", b[i]); 260 if (i == len - 1) 261 printf("\n"); 262#endif 263 bus_write_1(sc->sc_mem, RB_NAND_DATA, b[i]); 264 } 265} 266 267static int 268rb_nand_select_cs(device_t dev, uint8_t cs) 269{ 270 271 if (cs > 0) 272 return (ENODEV); 273 274 return (0); 275} 276 277static int 278rb_nand_read_rnb(device_t dev) 279{ 280 struct rb_nand_softc *sc; 281 uint32_t rdy_bit; 282 283 sc = device_get_softc(dev); 284 GPIO_PIN_GET(sc->sc_gpio, sc->sc_rdy_pin, &rdy_bit); 285 286 return (rdy_bit); /* ready */ 287} 288