#ifndef NAND_H
#define NAND_H
-#include "flash.h"
+#include <flash/flash.h>
-struct nand_device_s;
+struct nand_device;
#define __NAND_DEVICE_COMMAND(name) \
- COMMAND_HELPER(name, struct nand_device_s *nand)
+ 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));
- int (*register_commands)(struct command_context_s *cmd_ctx);
- 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);
+
+ /** 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)
-typedef struct nand_block_s
+/**
+ * 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;
-} 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
{
+ char *name;
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
*/
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;
int chip_size;
int erase_size;
int options;
-} nand_info_t;
+};
/* Option constants for bizarre disfunctionality and real features
*/
};
-nand_device_t *get_nand_device_by_num(int num);
+/**
+ * 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_s *nand, uint32_t page,
+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_s *nand, uint32_t page,
+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_s *nand, uint8_t *status);
+int nand_read_status(struct nand_device *nand, uint8_t *status);
-int nand_calculate_ecc(struct nand_device_s *nand,
+int nand_calculate_ecc(struct nand_device *nand,
const uint8_t *dat, uint8_t *ecc_code);
-int nand_calculate_ecc_kw(struct nand_device_s *nand,
+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);
+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
-int nand_command_get_device_by_num(struct command_context_s *cmd_ctx,
- const char *str, nand_device_t **nand);
+COMMAND_HELPER(nand_command_get_device, unsigned name_index,
+ struct nand_device **nand);
#define ERROR_NAND_DEVICE_INVALID (-1100)
projects / fw / openocd / blobdiff