From a7fd30c07fb9c2b7662ffaa48287b1997dc60796 Mon Sep 17 00:00:00 2001 From: Zachary T Welch Date: Fri, 4 Dec 2009 18:24:14 -0800 Subject: split NAND driver handling into nand/driver.[ch] This work parallels the NOR directory, encapsulating the NAND drivers into a separate file. This takes an extra step by encapsulating the type of data structure used to manage the drivers, allowing it to be changed from an array to a dynamic list in the future. --- src/flash/nand/Makefile.am | 5 +++ src/flash/nand/driver.c | 79 +++++++++++++++++++++++++++++++++ src/flash/nand/driver.h | 106 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 190 insertions(+) create mode 100644 src/flash/nand/driver.c create mode 100644 src/flash/nand/driver.h (limited to 'src/flash/nand') diff --git a/src/flash/nand/Makefile.am b/src/flash/nand/Makefile.am index 34947b6e..7d250f6f 100644 --- a/src/flash/nand/Makefile.am +++ b/src/flash/nand/Makefile.am @@ -3,6 +3,10 @@ AM_CPPFLAGS = -I$(top_srcdir)/src noinst_LTLIBRARIES = libocdflashnand.la libocdflashnand_la_SOURCES = \ + $(NAND_DRIVERS) \ + driver.c + +NAND_DRIVERS = \ nonce.c \ davinci.c \ lpc3180.c \ @@ -16,6 +20,7 @@ libocdflashnand_la_SOURCES = \ noinst_HEADERS = \ lpc3180.h \ + driver.h \ mx3.h \ s3c24xx.h \ s3c24xx_regs.h diff --git a/src/flash/nand/driver.c b/src/flash/nand/driver.c new file mode 100644 index 00000000..717f5aaa --- /dev/null +++ b/src/flash/nand/driver.c @@ -0,0 +1,79 @@ +/*************************************************************************** + * Copyright (C) 2005 by Dominic Rath * + * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2008 by Spencer Oliver * + * Copyright (C) 2009 Zachary T Welch * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#ifdef HAVE_CONFIG_H +#include +#endif +#include +#include "driver.h" + +/* NAND flash controller + */ +extern struct nand_flash_controller nonce_nand_controller; +extern struct nand_flash_controller davinci_nand_controller; +extern struct nand_flash_controller lpc3180_nand_controller; +extern struct nand_flash_controller orion_nand_controller; +extern struct nand_flash_controller s3c2410_nand_controller; +extern struct nand_flash_controller s3c2412_nand_controller; +extern struct nand_flash_controller s3c2440_nand_controller; +extern struct nand_flash_controller s3c2443_nand_controller; +extern struct nand_flash_controller imx31_nand_flash_controller; + +/* extern struct nand_flash_controller boundary_scan_nand_controller; */ + +static struct nand_flash_controller *nand_flash_controllers[] = +{ + &nonce_nand_controller, + &davinci_nand_controller, + &lpc3180_nand_controller, + &orion_nand_controller, + &s3c2410_nand_controller, + &s3c2412_nand_controller, + &s3c2440_nand_controller, + &s3c2443_nand_controller, + &imx31_nand_flash_controller, +/* &boundary_scan_nand_controller, */ + NULL +}; + +struct nand_flash_controller *nand_driver_find_by_name(const char *name) +{ + for (unsigned i = 0; nand_flash_controllers[i]; i++) + { + struct nand_flash_controller *controller = nand_flash_controllers[i]; + if (strcmp(name, controller->name) == 0) + return controller; + } + return NULL; +} +int nand_driver_walk(nand_driver_walker_t f, void *x) +{ + for (unsigned i = 0; nand_flash_controllers[i]; i++) + { + int retval = (*f)(nand_flash_controllers[i], x); + if (ERROR_OK != retval) + return retval; + } + return ERROR_OK; +} + + diff --git a/src/flash/nand/driver.h b/src/flash/nand/driver.h new file mode 100644 index 00000000..545a731b --- /dev/null +++ b/src/flash/nand/driver.h @@ -0,0 +1,106 @@ +/*************************************************************************** + * Copyright (C) 2005 by Dominic Rath * + * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2008 by Spencer Oliver * + * Copyright (C) 2009 Zachary T Welch * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ +#ifndef FLASH_NAND_DRIVER_H +#define FLASH_NAND_DRIVER_H + +struct nand_device; + +#define __NAND_DEVICE_COMMAND(name) \ + COMMAND_HELPER(name, struct nand_device *nand) + +/** + * Interface for NAND flash controllers. Not all of these functions are + * required for full functionality of the NAND driver, but better performance + * can be achieved by implementing each function. + */ +struct nand_flash_controller +{ + /** Driver name that is used to select it from configuration files. */ + char *name; + + const struct command_registration *commands; + + /** NAND device command called when driver is instantiated during configuration. */ + __NAND_DEVICE_COMMAND((*nand_device_command)); + + /** Register controller specific commands as a TCL interface to the driver. */ + int (*register_commands)(struct command_context *cmd_ctx); + + /** Initialize the NAND device. */ + int (*init)(struct nand_device *nand); + + /** Reset the NAND device. */ + int (*reset)(struct nand_device *nand); + + /** Issue a command to the NAND device. */ + int (*command)(struct nand_device *nand, uint8_t command); + + /** Write an address to the NAND device. */ + int (*address)(struct nand_device *nand, uint8_t address); + + /** Write word of data to the NAND device. */ + int (*write_data)(struct nand_device *nand, uint16_t data); + + /** Read word of data from the NAND device. */ + int (*read_data)(struct nand_device *nand, void *data); + + /** Write a block of data to the NAND device. */ + int (*write_block_data)(struct nand_device *nand, uint8_t *data, int size); + + /** Read a block of data from the NAND device. */ + int (*read_block_data)(struct nand_device *nand, uint8_t *data, int size); + + /** Write a page to the NAND device. */ + int (*write_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size); + + /** Read a page from the NAND device. */ + int (*read_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size); + + /** Check if the controller is ready for more instructions with timeout. */ + int (*controller_ready)(struct nand_device *nand, int timeout); + + /** Check if the NAND device is ready for more instructions with timeout. */ + int (*nand_ready)(struct nand_device *nand, int timeout); +}; + +#define NAND_DEVICE_COMMAND_HANDLER(name) static __NAND_DEVICE_COMMAND(name) + +/** + * Find a NAND flash controller by name. + * @param The name of the NAND controller to find. + * @returns The nand_flash_controller named @c name, or NULL if not found. + */ +struct nand_flash_controller *nand_driver_find_by_name(const char *name); + +/// Signature for callback functions passed to nand_driver_walk +typedef int (*nand_driver_walker_t)(struct nand_flash_controller *c, void*); +/** + * Walk the list of drivers, encapsulating the data structure type. + * Application state/context can be passed through the @c x pointer. + * @param f The callback function to invoke for each function. + * @param x For use as private data storate, passed directly to @c f. + * @returns ERROR_OK if successful, or the non-zero return value of @c f. + * This allows a walker to terminate the loop early. + */ +int nand_driver_walk(nand_driver_walker_t f, void *x); + +#endif // FLASH_NAND_DRIVER_H -- cgit v1.2.3