Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
allow flash/nand banks commands to accept names
[openocd.git] / src / flash / nand.h
diff --git a/src/flash/nand.h b/src/flash/nand.h
index b78eb8ecbd10874f0d8dc5d1639f3740da814fc3..a10877153169ef5689515cae2809f69928ae6d93 100644 (file)
--- a/src/flash/nand.h
+++ b/src/flash/nand.h
@@ -27,62 +27,67 @@
 
 #include "flash.h"
 
-struct nand_device_s;
+struct nand_device;
 
-typedef struct nand_flash_controller_s
+#define __NAND_DEVICE_COMMAND(name) \
+               COMMAND_HELPER(name, struct nand_device *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);
-       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, uint8_t command);
-       int (*address)(struct nand_device_s *device, uint8_t 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, uint8_t *data, int size);
-       int (*read_block_data)(struct nand_device_s *device, uint8_t *data, int size);
-       int (*write_page)(struct nand_device_s *device, u32 page, uint8_t *data, u32 data_size, uint8_t *oob, u32 oob_size);
-       int (*read_page)(struct nand_device_s *device, u32 page, uint8_t *data, u32 data_size, uint8_t *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
+       __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)
+
+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
+struct nand_device
 {
-       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_device_s *next;
-} nand_device_t;
+       struct nand_block *blocks;
+       struct nand_device *next;
+};
 
 /* NAND Flash Manufacturer ID Codes
  */
@@ -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,37 @@ 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, uint8_t *data, u32 data_size, uint8_t *oob, u32 oob_size);
-extern int nand_write_page_raw(struct nand_device_s *device, u32 page, uint8_t *data, u32 data_size, uint8_t *oob, u32 oob_size);
-extern int nand_read_status(struct nand_device_s *device, uint8_t *status);
-extern int nand_calculate_ecc(struct nand_device_s *device, const uint8_t *dat, uint8_t *ecc_code);
-extern int nand_calculate_ecc_kw(struct nand_device_s *device, const uint8_t *dat, uint8_t *ecc_code);
 
-extern int nand_register_commands(struct command_context_s *cmd_ctx);
-extern int nand_init(struct command_context_s *cmd_ctx);
+/**
+ * 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,
+               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,
+               uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
+
+int nand_read_status(struct nand_device *nand, uint8_t *status);
+
+int nand_calculate_ecc(struct nand_device *nand,
+               const uint8_t *dat, uint8_t *ecc_code);
+int nand_calculate_ecc_kw(struct nand_device *nand,
+               const uint8_t *dat, uint8_t *ecc_code);
+
+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,
+               struct nand_device **nand);
+
 
 #define                ERROR_NAND_DEVICE_INVALID               (-1100)
 #define                ERROR_NAND_OPERATION_FAILED             (-1101)
@@ -223,5 +249,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 */
Open On-Chip Debugger

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)