X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fnand.h;h=80963095948b2663d79d8c0c7c1a67ff289d0596;hp=d0dd7579847b20e68aff80733ad72fa2cfb8b1eb;hb=2f6e56e38320350bb300b363d0b3737fa8d1f3ea;hpb=6d3bed69dc023f49b51b6504d977463e722e9e9d diff --git a/src/flash/nand.h b/src/flash/nand.h index d0dd757984..8096309594 100644 --- a/src/flash/nand.h +++ b/src/flash/nand.h @@ -27,50 +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); + __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 *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_device_s +struct nand_ecclayout { + int eccbytes; + int eccpos[64]; + int oobavail; + struct nand_oobfree oobfree[2]; +}; + +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 */ @@ -83,15 +100,16 @@ enum NAND_MFR_RENESAS = 0x07, NAND_MFR_STMICRO = 0x20, NAND_MFR_HYNIX = 0xad, + NAND_MFR_MICRON = 0x2c, }; -typedef struct nand_manufacturer_s +struct nand_manufacturer { - int id; + int id; char *name; -} nand_manufacturer_t; +}; -typedef struct nand_info_s +struct nand_info { char *name; int id; @@ -99,47 +117,47 @@ typedef struct nand_info_s int chip_size; int erase_size; int options; -} nand_info_t; +}; /* 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 +181,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,20 +204,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_register_commands(struct command_context_s *cmd_ctx); -extern int nand_init(struct command_context_s *cmd_ctx); +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_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, struct nand_device **nand); + #define ERROR_NAND_DEVICE_INVALID (-1100) #define ERROR_NAND_OPERATION_FAILED (-1101) @@ -207,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 */