split nand.c into nand/{core,fileio,tcl}.c

[openocd.git] / src / flash / nand.h

diff --git a/src/flash/nand.h b/src/flash/nand.h
index ddc4520e92ddc8da69253cdb39426b55027a0e48..d675b295c559295a64c73ce22b5f182eea6a546b 100644 (file)
--- a/src/flash/nand.h
+++ b/src/flash/nand.h
@@ -25,39 +25,27 @@
 #ifndef NAND_H
 #define NAND_H
 
-#include "flash.h"
-
-struct nand_device;
-
-#define __NAND_DEVICE_COMMAND(name) \
-               COMMAND_HELPER(name, struct nand_device *nand)
-
-struct nand_flash_controller
-{
-       char *name;
-       __NAND_DEVICE_COMMAND((*nand_device_command));
-       int (*register_commands)(struct command_context *cmd_ctx);
-       int (*init)(struct nand_device *nand);
-       int (*reset)(struct nand_device *nand);
-       int (*command)(struct nand_device *nand, uint8_t command);
-       int (*address)(struct nand_device *nand, uint8_t address);
-       int (*write_data)(struct nand_device *nand, uint16_t data);
-       int (*read_data)(struct nand_device *nand, void *data);
-       int (*write_block_data)(struct nand_device *nand, uint8_t *data, int size);
-       int (*read_block_data)(struct nand_device *nand, uint8_t *data, int size);
-       int (*write_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
-       int (*read_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
-       int (*controller_ready)(struct nand_device *nand, int timeout);
-       int (*nand_ready)(struct nand_device *nand, int timeout);
-};
-
-#define NAND_DEVICE_COMMAND_HANDLER(name) static __NAND_DEVICE_COMMAND(name)
-
+#include <flash/common.h>
+// to be removed later
+#include <target/target.h>
+// to be removed later
+#include <flash/nand/driver.h>
+
+/**
+ * Representation of a single NAND block in a NAND device.
+ */
 struct nand_block
 {
+       /** Offset to the block. */
        uint32_t offset;
+
+       /** Size of the block. */
        uint32_t size;
+
+       /** True if the block has been erased. */
        int is_erased;
+
+       /** True if the block is bad. */
        int is_bad;
 };
 
@@ -75,6 +63,7 @@ struct nand_ecclayout {
 
 struct nand_device
 {
+       char *name;
        struct nand_flash_controller *controller;
        void *controller_priv;
        struct nand_manufacturer *manufacturer;
@@ -212,8 +201,20 @@ enum oob_formats
 };
 
 
+/**
+ * Returns the flash bank specified by @a name, which matches the
+ * driver name and a suffix (option) specify the driver-specific
+ * bank number. The suffix consists of the '.' and the driver-specific
+ * bank number: when two davinci banks are defined, then 'davinci.1' refers
+ * to the second (e.g. DM355EVM).
+ */
+struct nand_device *get_nand_device_by_name(const char *name);
+
 struct nand_device *get_nand_device_by_num(int num);
 
+int nand_page_command(struct nand_device *nand, uint32_t page,
+               uint8_t cmd, bool oob_only);
+
 int nand_read_page_raw(struct nand_device *nand, uint32_t page,
                uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
 int nand_write_page_raw(struct nand_device *nand, uint32_t page,
@@ -230,7 +231,7 @@ int nand_register_commands(struct command_context *cmd_ctx);
 int nand_init(struct command_context *cmd_ctx);
 
 /// helper for parsing a nand device command argument string
-COMMAND_HELPER(nand_command_get_device_by_num, unsigned name_index,
+COMMAND_HELPER(nand_command_get_device, unsigned name_index,
                struct nand_device **nand);