X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fnand.h;h=a30a65495e769aef0e505a0327dd4019e7de5757;hp=ddc4520e92ddc8da69253cdb39426b55027a0e48;hb=e1ec02bb055fa356b058dddc0a15710e0fdc9870;hpb=cbc05783727122f0052fe6f3be40635eb73ec5bc

diff --git a/src/flash/nand.h b/src/flash/nand.h
index ddc4520e92..a30a65495e 100644
--- a/src/flash/nand.h
+++ b/src/flash/nand.h
@@ -32,32 +32,78 @@ 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)
 
+/**
+ * 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 +121,7 @@ struct nand_ecclayout {
 
 struct nand_device
 {
+	char *name;
 	struct nand_flash_controller *controller;
 	void *controller_priv;
 	struct nand_manufacturer *manufacturer;
@@ -212,6 +259,15 @@ 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_read_page_raw(struct nand_device *nand, uint32_t page,
@@ -230,7 +286,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);