X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fflash%2Fnand.h;h=c6d4075187a4f3176dd15b27687c0257a1ce569a;hb=43483e5054c78e0fdfaebed5e14c14246af07c97;hp=0ee1ffe83fd38882187a8f4c54e52b67c7c53022;hpb=1464742d745d211f454185957d2dcbceb2740141;p=openocd.git

diff --git a/src/flash/nand.h b/src/flash/nand.h
index 0ee1ffe83f..c6d4075187 100644
--- a/src/flash/nand.h
+++ b/src/flash/nand.h
@@ -29,58 +29,63 @@
 
 struct nand_device_s;
 
-typedef struct nand_flash_controller_s
+#define __NAND_DEVICE_COMMAND(name) \
+		COMMAND_HELPER(name, struct nand_device_s *nand)
+
+struct nand_flash_controller
 {
 	char *name;
-	int (*nand_device_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct nand_device_s *device);
+	__NAND_DEVICE_COMMAND((*nand_device_command));
 	int (*register_commands)(struct command_context_s *cmd_ctx);
-	int (*init)(struct nand_device_s *device);
-	int (*reset)(struct nand_device_s *device);
-	int (*command)(struct nand_device_s *device, u8 command);
-	int (*address)(struct nand_device_s *device, u8 address);
-	int (*write_data)(struct nand_device_s *device, u16 data);
-	int (*read_data)(struct nand_device_s *device, void *data);
-	int (*write_block_data)(struct nand_device_s *device, u8 *data, int size);
-	int (*read_block_data)(struct nand_device_s *device, u8 *data, int size);
-	int (*write_page)(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
-	int (*read_page)(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
-	int (*controller_ready)(struct nand_device_s *device, int timeout);
-	int (*nand_ready)(struct nand_device_s *device, int timeout);
-} nand_flash_controller_t;
-
-typedef struct nand_block_s
+	int (*init)(struct nand_device_s *nand);
+	int (*reset)(struct nand_device_s *nand);
+	int (*command)(struct nand_device_s *nand, uint8_t command);
+	int (*address)(struct nand_device_s *nand, uint8_t address);
+	int (*write_data)(struct nand_device_s *nand, uint16_t data);
+	int (*read_data)(struct nand_device_s *nand, void *data);
+	int (*write_block_data)(struct nand_device_s *nand, uint8_t *data, int size);
+	int (*read_block_data)(struct nand_device_s *nand, uint8_t *data, int size);
+	int (*write_page)(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
+	int (*read_page)(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
+	int (*controller_ready)(struct nand_device_s *nand, int timeout);
+	int (*nand_ready)(struct nand_device_s *nand, int timeout);
+};
+
+#define NAND_DEVICE_COMMAND_HANDLER(name) static __NAND_DEVICE_COMMAND(name)
+
+struct nand_block
 {
-	u32 offset;
-	u32 size;
+	uint32_t offset;
+	uint32_t size;
 	int is_erased;
 	int is_bad;
-} nand_block_t;
+};
 
 struct nand_oobfree {
 	int offset;
 	int length;
 };
 
-typedef struct nand_ecclayout_s {
+struct nand_ecclayout {
 	int eccbytes;
 	int eccpos[64];
 	int oobavail;
 	struct nand_oobfree oobfree[2];
-} nand_ecclayout_t;
+};
 
 typedef struct nand_device_s
 {
-	nand_flash_controller_t *controller;
+	struct nand_flash_controller *controller;
 	void *controller_priv;
-	struct nand_manufacturer_s *manufacturer;
-	struct nand_info_s *device;
+	struct nand_manufacturer *manufacturer;
+	struct nand_info *device;
 	int bus_width;
 	int address_cycles;
 	int page_size;
 	int erase_size;
 	int use_raw;
 	int num_blocks;
-	nand_block_t *blocks;
+	struct nand_block *blocks;
 	struct nand_device_s *next;
 } nand_device_t;
 
@@ -98,13 +103,13 @@ enum
 	NAND_MFR_MICRON = 0x2c,
 };
 
-typedef struct nand_manufacturer_s
+struct nand_manufacturer
 {
 	int id;
 	char *name;
-} nand_manufacturer_t;
+};
 
-typedef struct nand_info_s
+struct nand_info
 {
 	char *name;
 	int id;
@@ -112,7 +117,7 @@ typedef struct nand_info_s
 	int chip_size;
 	int erase_size;
 	int options;
-} nand_info_t;
+};
 
 /* Option constants for bizarre disfunctionality and real features
  */
@@ -206,16 +211,28 @@ enum oob_formats
 	NAND_OOB_YAFFS2 = 0x100,/* when writing, use YAFFS2 OOB layout */
 };
 
-/* Function prototypes */
-extern nand_device_t *get_nand_device_by_num(int num);
-extern int nand_read_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
-extern int nand_write_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
-extern int nand_read_status(struct nand_device_s *device, u8 *status);
-extern int nand_calculate_ecc(struct nand_device_s *device, const u8 *dat, u8 *ecc_code);
-extern int nand_calculate_ecc_kw(struct nand_device_s *device, const u8 *dat, u8 *ecc_code);
 
-extern int nand_register_commands(struct command_context_s *cmd_ctx);
-extern int nand_init(struct command_context_s *cmd_ctx);
+nand_device_t *get_nand_device_by_num(int num);
+
+int nand_read_page_raw(struct nand_device_s *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_s *nand, uint32_t page,
+		uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
+
+int nand_read_status(struct nand_device_s *nand, uint8_t *status);
+
+int nand_calculate_ecc(struct nand_device_s *nand,
+		const uint8_t *dat, uint8_t *ecc_code);
+int nand_calculate_ecc_kw(struct nand_device_s *nand,
+		const uint8_t *dat, uint8_t *ecc_code);
+
+int nand_register_commands(struct command_context_s *cmd_ctx);
+int nand_init(struct command_context_s *cmd_ctx);
+
+/// helper for parsing a nand device command argument string
+int nand_command_get_device_by_num(struct command_context_s *cmd_ctx,
+		const char *str, nand_device_t **nand);
+
 
 #define		ERROR_NAND_DEVICE_INVALID		(-1100)
 #define		ERROR_NAND_OPERATION_FAILED		(-1101)
@@ -223,5 +240,6 @@ extern int nand_init(struct command_context_s *cmd_ctx);
 #define		ERROR_NAND_OPERATION_NOT_SUPPORTED	(-1103)
 #define		ERROR_NAND_DEVICE_NOT_PROBED	(-1104)
 #define		ERROR_NAND_ERROR_CORRECTION_FAILED	(-1105)
+#define		ERROR_NAND_NO_BUFFER			(-1106)
 
 #endif /* NAND_H */