/***************************************************************************
+ * Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de> *
+ * Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com> *
+ * Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk> *
* Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net> *
* *
* This program is free software; you can redistribute it and/or modify *
#ifndef FLASH_NOR_CORE_H
#define FLASH_NOR_CORE_H
-#include <flash/flash.h>
+#include <flash/common.h>
+struct image;
+
+#define FLASH_MAX_ERROR_STR (128)
+
+/**
+ * Describes the geometry and status of a single flash sector
+ * within a flash bank. A single bank typically consists of multiple
+ * sectors, each of which can be erased and protected independently.
+ */
+struct flash_sector
+{
+ /// Bus offset from start of the flash chip (in bytes).
+ uint32_t offset;
+ /// Number of bytes in this flash sector.
+ uint32_t size;
+ /**
+ * Indication of erasure status: 0 = not erased, 1 = erased,
+ * other = unknown. Set by @c flash_driver_s::erase_check.
+ */
+ int is_erased;
+ /**
+ * Indication of protection status: 0 = unprotected/unlocked,
+ * 1 = protected/locked, other = unknown. Set by
+ * @c flash_driver_s::protect_check.
+ */
+ int is_protected;
+};
+
+/**
+ * Provides details of a flash bank, available either on-chip or through
+ * a major interface.
+ *
+ * This structure will be passed as a parameter to the callbacks in the
+ * flash_driver_s structure, some of which may modify the contents of
+ * this structure of the area of flash that it defines. Driver writers
+ * may use the @c driver_priv member to store additional data on a
+ * per-bank basis, if required.
+ */
+struct flash_bank
+{
+ char *name;
+
+ struct target *target; /**< Target to which this bank belongs. */
+
+ struct flash_driver *driver; /**< Driver for this bank. */
+ void *driver_priv; /**< Private driver storage pointer */
+
+ int bank_number; /**< The 'bank' (or chip number) of this instance. */
+ uint32_t base; /**< The base address of this bank */
+ uint32_t size; /**< The size of this chip bank, in bytes */
+
+ int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
+ int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
+
+ /**
+ * The number of sectors on this chip. This value will
+ * be set intially to 0, and the flash driver must set this to
+ * some non-zero value during "probe()" or "auto_probe()".
+ */
+ int num_sectors;
+ /// Array of sectors, allocated and initilized by the flash driver
+ struct flash_sector *sectors;
+
+ struct flash_bank *next; /**< The next flash bank on this chip */
+};
+
+/// Registers the 'flash' subsystem commands
+int flash_register_commands(struct command_context *cmd_ctx);
+/// Initializes the 'flash' subsystem drivers
+int flash_init_drivers(struct command_context *cmd_ctx);
+
+/**
+ * Erases @a length bytes in the @a target flash, starting at @a addr.
+ * @returns ERROR_OK if successful; otherwise, an error code.
+ */
+int flash_erase_address_range(struct target *target,
+ uint32_t addr, uint32_t length);
+/**
+ * Writes @a image into the @a target flash. The @a written parameter
+ * will contain the
+ * @param target The target with the flash to be programmed.
+ * @param image The image that will be programmed to flash.
+ * @param written On return, contains the number of bytes written.
+ * @param erase If non-zero, indicates the flash driver should first
+ * erase the corresponding banks or sectors before programming.
+ * @returns ERROR_OK if successful; otherwise, an error code.
+ */
+int flash_write(struct target *target,
+ struct image *image, uint32_t *written, int erase);
+/**
+ * Forces targets to re-examine their erase/protection state.
+ * This routine must be called when the system may modify the status.
+ */
+void flash_set_dirty(void);
+/// @returns The number of flash banks currently defined.
+int flash_get_bank_count(void);
+/**
+ * Provides default erased-bank check handling. Checks to see if
+ * the flash driver knows they are erased; if things look uncertain,
+ * this routine will call default_flash_mem_blank_check() to confirm.
+ * @returns ERROR_OK if successful; otherwise, an error code.
+ */
+int default_flash_blank_check(struct flash_bank *bank);
+/**
+ * Provides a default blank flash memory check. Ensures the contents
+ * of the given bank have truly been erased.
+ * @param bank The flash bank.
+ * @returns ERROR_OK if successful; otherwise, an error code.
+ */
+int default_flash_mem_blank_check(struct flash_bank *bank);
+
+/**
+ * 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 str9x banks are defined, then 'str9x.1' refers
+ * to the second.
+ */
+struct flash_bank *get_flash_bank_by_name(const char *name);
+/**
+ * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
+ * @param num The flash bank number.
+ * @returns A struct flash_bank for flash bank @a num, or NULL
+ */
+struct flash_bank *get_flash_bank_by_num(int num);
+/**
+ * Retreives @a bank from a command argument, reporting errors parsing
+ * the bank identifier or retreiving the specified bank. The bank
+ * may be identified by its bank number or by @c name.instance, where
+ * @a instance is driver-specific.
+ * @param name_index The index to the string in args containing the
+ * bank identifier.
+ * @param bank On output, contians a pointer to the bank or NULL.
+ * @returns ERROR_OK on success, or an error indicating the problem.
+ */
+COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
+ struct flash_bank **bank);
+/**
+ * Returns the flash bank like get_flash_bank_by_num(), without probing.
+ * @param num The flash bank number.
+ * @returns A struct flash_bank for flash bank @a num, or NULL.
+ */
+struct flash_bank *get_flash_bank_by_num_noprobe(int num);
/**
- * Find a NOR flash driver by its name.
- * @param name The name of the requested driver.
- * @returns The flash_driver called @c name, or NULL if not found.
+ * Returns the flash bank located at a specified address.
+ * @param target The target, presumed to contain one or more banks.
+ * @param addr An address that is within the range of the bank.
+ * @returns The struct flash_bank located at @a addr, or NULL.
*/
-struct flash_driver *flash_driver_find_by_name(const char *name);
+struct flash_bank *get_flash_bank_by_addr(struct target *target, uint32_t addr);
#endif // FLASH_NOR_CORE_H
Code Review / openocd.git / blobdiff