add const keyword to some APIs
[openocd.git] / src / flash / nand.h
index 5535221acb3d69941778ec472947578325ad6e4a..5b19d5a95056ee209e94e214f7d9f7c1171d55a6 100644 (file)
@@ -36,26 +36,38 @@ typedef struct nand_flash_controller_s
        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 (*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, uint16_t 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 (*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, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
+       int (*read_page)(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t 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
 {
-       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 {
+       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;
@@ -83,11 +95,12 @@ enum
        NAND_MFR_RENESAS = 0x07,
        NAND_MFR_STMICRO = 0x20,
        NAND_MFR_HYNIX = 0xad,
+       NAND_MFR_MICRON = 0x2c,
 };
 
 typedef struct nand_manufacturer_s
 {
-    int id;
+       int id;
        char *name;
 } nand_manufacturer_t;
 
@@ -103,43 +116,43 @@ typedef struct nand_info_s
 
 /* Option constants for bizarre disfunctionality and real features
  */
-enum { 
+enum {
        /* Chip can not auto increment pages */
        NAND_NO_AUTOINCR = 0x00000001,
-       
+
        /* Buswitdh is 16 bit */
        NAND_BUSWIDTH_16 = 0x00000002,
-       
+
        /* Device supports partial programming without padding */
        NAND_NO_PADDING = 0x00000004,
-       
+
        /* Chip has cache program function */
        NAND_CACHEPRG = 0x00000008,
-       
+
        /* Chip has copy back function */
        NAND_COPYBACK = 0x00000010,
-       
+
        /* AND Chip which has 4 banks and a confusing page / block
         * assignment. See Renesas datasheet for further information */
        NAND_IS_AND = 0x00000020,
-       
+
        /* Chip has a array of 4 pages which can be read without
         * additional ready /busy waits */
        NAND_4PAGE_ARRAY = 0x00000040,
-       
+
        /* Chip requires that BBT is periodically rewritten to prevent
         * bits from adjacent blocks from 'leaking' in altering data.
         * This happens with the Renesas AG-AND chips, possibly others.  */
        BBT_AUTO_REFRESH = 0x00000080,
-       
+
        /* Chip does not require ready check on read. True
         * for all large page devices, as they do not support
         * autoincrement.*/
        NAND_NO_READRDY = 0x00000100,
-       
+
        /* Options valid for Samsung large page devices */
        NAND_SAMSUNG_LP_OPTIONS = (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK),
-       
+
        /* Options for new chips with large page size. The pagesize and the
         * erasesize is determined from the extended id bytes
         */
@@ -163,7 +176,7 @@ enum
        NAND_CMD_READID = 0x90,
        NAND_CMD_ERASE2 = 0xd0,
        NAND_CMD_RESET = 0xff,
-       
+
        /* Extended commands for large page devices */
        NAND_CMD_READSTART = 0x30,
        NAND_CMD_RNDOUTSTART = 0xE0,
@@ -186,21 +199,35 @@ enum oob_formats
        NAND_OOB_NONE = 0x0,    /* no OOB data at all */
        NAND_OOB_RAW = 0x1,             /* raw OOB data (16 bytes for 512b page sizes, 64 bytes for 2048b page sizes) */
        NAND_OOB_ONLY = 0x2,    /* only OOB data */
-       NAND_OOB_SW_ECC = 0x10, /* when writing, use SW ECC (as opposed to no ECC) */ 
+       NAND_OOB_SW_ECC = 0x10, /* when writing, use SW ECC (as opposed to no ECC) */
        NAND_OOB_HW_ECC = 0x20, /* when writing, use HW ECC (as opposed to no ECC) */
+       NAND_OOB_SW_ECC_KW = 0x40, /* when writing, use Marvell's Kirkwood bootrom format */
        NAND_OOB_JFFS2 = 0x100, /* when writing, use JFFS2 OOB layout */
        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_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 *device, 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 *device, 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 *device, uint8_t *status);
+
+int nand_calculate_ecc(struct nand_device_s *device,
+               const uint8_t *dat, uint8_t *ecc_code);
+int nand_calculate_ecc_kw(struct nand_device_s *device,
+               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 **device);
+
 
 #define                ERROR_NAND_DEVICE_INVALID               (-1100)
 #define                ERROR_NAND_OPERATION_FAILED             (-1101)
@@ -208,5 +235,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 */

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)