interesting
/
riscv-openocd
mirror of https://github.com/riscv/riscv-openocd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

src/flash: remove 'extern' and wrap headers 

Removes 'extern' keywords from function prototypes in the flash headers.
Wraps long lines to fit into 80 columns.

Adds multiple inclusion protection for s3c2xx_nand.h.
This commit is contained in:
Zachary T Welch 2009-11-09 03:10:11 -08:00
parent 5e9d18f027
commit 81fbc63718
7 changed files with 68 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/flash/flash.h
View File

@ -127,7 +127,8 @@ typedef struct flash_driver_s
* *
* @returns ERROR_OK if successful; otherwise, an error code. * @returns ERROR_OK if successful; otherwise, an error code.
*/ */
int (*flash_bank_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank); int (*flash_bank_command)(struct command_context_s *cmd_ctx,
char *cmd, char **args, int argc, struct flash_bank_s *bank);
/** /**
* Bank/sector erase routine (target-specific). When * Bank/sector erase routine (target-specific). When
@ -166,7 +167,8 @@ typedef struct flash_driver_s
* @param count The number of bytes to write. * @param count The number of bytes to write.
* @returns ERROR_OK if successful; otherwise, an error code. * @returns ERROR_OK if successful; otherwise, an error code.
*/ */
int (*write)(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count); int (*write)(struct flash_bank_s *bank,
uint8_t *buffer, uint32_t offset, uint32_t count);
/** /**
* Probe to determine what kind of flash is present. * Probe to determine what kind of flash is present.
@ -265,15 +267,16 @@ typedef struct flash_bank_s
} flash_bank_t; } flash_bank_t;
/// Registers the 'flash' subsystem commands /// Registers the 'flash' subsystem commands
extern int flash_register_commands(struct command_context_s *cmd_ctx); int flash_register_commands(struct command_context_s *cmd_ctx);
/// Initializes the 'flash' subsystem drivers /// Initializes the 'flash' subsystem drivers
extern int flash_init_drivers(struct command_context_s *cmd_ctx); int flash_init_drivers(struct command_context_s *cmd_ctx);
/** /**
* Erases @a length bytes in the @a target flash, starting at @a addr. * Erases @a length bytes in the @a target flash, starting at @a addr.
* @returns ERROR_OK if successful; otherwise, an error code. * @returns ERROR_OK if successful; otherwise, an error code.
*/ */
extern int flash_erase_address_range(struct target_s *target, uint32_t addr, uint32_t length); int flash_erase_address_range(struct target_s *target,
uint32_t addr, uint32_t length);
/** /**
* Writes @a image into the @a target flash. The @a written parameter * Writes @a image into the @a target flash. The @a written parameter
* will contain the * will contain the
@ -284,35 +287,36 @@ extern int flash_erase_address_range(struct target_s *target, uint32_t addr, uin
* erase the corresponding banks or sectors before programming. * erase the corresponding banks or sectors before programming.
* @returns ERROR_OK if successful; otherwise, an error code. * @returns ERROR_OK if successful; otherwise, an error code.
*/ */
extern int flash_write(struct target_s *target, struct image_s *image, uint32_t *written, int erase); int flash_write(struct target_s *target,
struct image_s *image, uint32_t *written, int erase);
/** /**
* Forces targets to re-examine their erase/protection state. * Forces targets to re-examine their erase/protection state.
* This routine must be called when the system may modify the status. * This routine must be called when the system may modify the status.
*/ */
extern void flash_set_dirty(void); void flash_set_dirty(void);
/// @returns The number of flash banks currently defined. /// @returns The number of flash banks currently defined.
extern int flash_get_bank_count(void); int flash_get_bank_count(void);
/** /**
* Provides default erased-bank check handling. Checks to see if * Provides default erased-bank check handling. Checks to see if
* the flash driver knows they are erased; if things look uncertain, * the flash driver knows they are erased; if things look uncertain,
* this routine will call default_flash_mem_blank_check() to confirm. * this routine will call default_flash_mem_blank_check() to confirm.
* @returns ERROR_OK if successful; otherwise, an error code. * @returns ERROR_OK if successful; otherwise, an error code.
*/ */
extern int default_flash_blank_check(struct flash_bank_s *bank); int default_flash_blank_check(struct flash_bank_s *bank);
/** /**
* Provides a default blank flash memory check. Ensures the contents * Provides a default blank flash memory check. Ensures the contents
* of the given bank have truly been erased. * of the given bank have truly been erased.
* @param bank The flash bank. * @param bank The flash bank.
* @returns ERROR_OK if successful; otherwise, an error code. * @returns ERROR_OK if successful; otherwise, an error code.
*/ */
extern int default_flash_mem_blank_check(struct flash_bank_s *bank); int default_flash_mem_blank_check(struct flash_bank_s *bank);
/** /**
* Returns a flash bank by the specified flash_bank_s bank_number, @a num. * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
* @param num The flash bank number. * @param num The flash bank number.
* @returns A flash_bank_t for flash bank @a num, or NULL * @returns A flash_bank_t for flash bank @a num, or NULL
*/ */
extern flash_bank_t *get_flash_bank_by_num(int num); flash_bank_t *get_flash_bank_by_num(int num);
/** /**
* Retreives @a bank from a command argument, reporting errors parsing * Retreives @a bank from a command argument, reporting errors parsing
* the bank identifier or retreiving the specified bank. * the bank identifier or retreiving the specified bank.
@ -321,21 +325,21 @@ extern flash_bank_t *get_flash_bank_by_num(int num);
* @param bank On output, contians a pointer to the bank or NULL. * @param bank On output, contians a pointer to the bank or NULL.
* @returns ERROR_OK on success, or an error indicating the problem. * @returns ERROR_OK on success, or an error indicating the problem.
*/ */
int flash_command_get_bank_by_num( int flash_command_get_bank_by_num(struct command_context_s *cmd_ctx,
struct command_context_s *cmd_ctx, char *str, flash_bank_t **bank); char *str, flash_bank_t **bank);
/** /**
* Returns the flash bank like get_flash_bank_by_num(), without probing. * Returns the flash bank like get_flash_bank_by_num(), without probing.
* @param num The flash bank number. * @param num The flash bank number.
* @returns A flash_bank_t for flash bank @a num, or NULL. * @returns A flash_bank_t for flash bank @a num, or NULL.
*/ */
extern flash_bank_t *get_flash_bank_by_num_noprobe(int num); flash_bank_t *get_flash_bank_by_num_noprobe(int num);
/** /**
* Returns the flash bank located at a specified address. * Returns the flash bank located at a specified address.
* @param target The target, presumed to contain one or more banks. * @param target The target, presumed to contain one or more banks.
* @param addr An address that is within the range of the bank. * @param addr An address that is within the range of the bank.
* @returns The flash_bank_t located at @a addr, or NULL. * @returns The flash_bank_t located at @a addr, or NULL.
*/ */
extern flash_bank_t *get_flash_bank_by_addr(struct target_s *target, uint32_t addr); flash_bank_t *get_flash_bank_by_addr(struct target_s *target, uint32_t addr);
#define ERROR_FLASH_BANK_INVALID (-900) #define ERROR_FLASH_BANK_INVALID (-900)
#define ERROR_FLASH_SECTOR_INVALID (-901) #define ERROR_FLASH_SECTOR_INVALID (-901)

4
src/flash/mflash.h
View File

@ -141,8 +141,8 @@ typedef struct mflash_bank_s
mg_drv_info_t *drv_info; mg_drv_info_t *drv_info;
} mflash_bank_t; } mflash_bank_t;
extern int mflash_register_commands(struct command_context_s *cmd_ctx); int mflash_register_commands(struct command_context_s *cmd_ctx);
extern int mflash_init_drivers(struct command_context_s *cmd_ctx); int mflash_init_drivers(struct command_context_s *cmd_ctx);
#define MG_MFLASH_SECTOR_SIZE (0x200) /* 512Bytes = 2^9 */ #define MG_MFLASH_SECTOR_SIZE (0x200) /* 512Bytes = 2^9 */
#define MG_MFLASH_SECTOR_SIZE_MASK (0x200-1) #define MG_MFLASH_SECTOR_SIZE_MASK (0x200-1)

25
src/flash/nand.h
View File

@ -206,16 +206,23 @@ enum oob_formats
NAND_OOB_YAFFS2 = 0x100,/* when writing, use YAFFS2 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, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
extern 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);
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); nand_device_t *get_nand_device_by_num(int num);
extern int nand_init(struct command_context_s *cmd_ctx);
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 /// helper for parsing a nand device command argument string
int nand_command_get_device_by_num(struct command_context_s *cmd_ctx, int nand_command_get_device_by_num(struct command_context_s *cmd_ctx,

2
src/flash/non_cfi.h
View File

@ -35,6 +35,6 @@ typedef struct non_cfi_s
uint8_t status_poll_mask; uint8_t status_poll_mask;
} non_cfi_t; } non_cfi_t;
extern void cfi_fixup_non_cfi(flash_bank_t *bank); void cfi_fixup_non_cfi(flash_bank_t *bank);
#endif /* NON_CFI_H */ #endif /* NON_CFI_H */

4
src/flash/ocl/at91sam7x/dcc.h
View File

@ -23,9 +23,9 @@
#include "platform.h" #include "platform.h"
/* debug channel read (debugger->MCU) */ /* debug channel read (debugger->MCU) */
extern uint32 dcc_rd(void); uint32 dcc_rd(void);
/* debug channel write (MCU->debugger) */ /* debug channel write (MCU->debugger) */
extern int dcc_wr(uint32 data); int dcc_wr(uint32 data);
#endif #endif

8
src/flash/ocl/at91sam7x/samflash.h
View File

@ -34,15 +34,15 @@ extern unsigned int flash_page_count;
extern unsigned int flash_page_size; /* words */ extern unsigned int flash_page_size; /* words */
/* detect chip and set loader parameters */ /* detect chip and set loader parameters */
extern int flash_init(void); int flash_init(void);
/* program single flash page */ /* program single flash page */
extern int flash_page_program(uint32 *data, int page_num); int flash_page_program(uint32 *data, int page_num);
/* erase whole chip */ /* erase whole chip */
extern int flash_erase_all(void); int flash_erase_all(void);
/* verify written data */ /* verify written data */
extern int flash_verify(uint32 adr, unsigned int len, uint8 *src); int flash_verify(uint32 adr, unsigned int len, uint8 *src);
#endif #endif

35
src/flash/s3c24xx_nand.h
View File

@ -18,6 +18,9 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/ ***************************************************************************/
#ifndef S3C24xx_NAND_H
#define S3C24xx_NAND_H
/* /*
* S3C24XX Series OpenOCD NAND Flash controller support. * S3C24XX Series OpenOCD NAND Flash controller support.
* *
@ -42,22 +45,32 @@ typedef struct s3c24xx_nand_controller_s
#undef S3C2410_NFREG #undef S3C2410_NFREG
#define S3C2410_NFREG(x) ((x) + 0x4e000000) #define S3C2410_NFREG(x) ((x) + 0x4e000000)
extern s3c24xx_nand_controller_t *s3c24xx_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct nand_device_s *device); s3c24xx_nand_controller_t *s3c24xx_nand_device_command(
struct command_context_s *cmd_ctx, char *cmd,
char **args, int argc, struct nand_device_s *device);
extern int s3c24xx_register_commands(struct command_context_s *cmd_ctx); int s3c24xx_register_commands(struct command_context_s *cmd_ctx);
extern int s3c24xx_reset(struct nand_device_s *device);
extern int s3c24xx_command(struct nand_device_s *device, uint8_t command); int s3c24xx_reset(struct nand_device_s *device);
extern int s3c24xx_address(struct nand_device_s *device, uint8_t address);
extern int s3c24xx_write_data(struct nand_device_s *device, uint16_t data); int s3c24xx_command(struct nand_device_s *device, uint8_t command);
extern int s3c24xx_read_data(struct nand_device_s *device, void *data); int s3c24xx_address(struct nand_device_s *device, uint8_t address);
extern int s3c24xx_controller_ready(struct nand_device_s *device, int tout);
int s3c24xx_write_data(struct nand_device_s *device, uint16_t data);
int s3c24xx_read_data(struct nand_device_s *device, void *data);
int s3c24xx_controller_ready(struct nand_device_s *device, int tout);
#define s3c24xx_write_page NULL #define s3c24xx_write_page NULL
#define s3c24xx_read_page NULL #define s3c24xx_read_page NULL
/* code shared between different controllers */ /* code shared between different controllers */
extern int s3c2440_nand_ready(struct nand_device_s *device, int timeout); int s3c2440_nand_ready(struct nand_device_s *device, int timeout);
extern int s3c2440_read_block_data(struct nand_device_s *, uint8_t *data, int data_size); int s3c2440_read_block_data(struct nand_device_s *device,
extern int s3c2440_write_block_data(struct nand_device_s *, uint8_t *data, int data_size); uint8_t *data, int data_size);
int s3c2440_write_block_data(struct nand_device_s *device,
uint8_t *data, int data_size);
#endif // S3C24xx_NAND_H