nor/core.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   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>             *
 *   Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com>       *
 ***************************************************************************/
 
#ifndef OPENOCD_FLASH_NOR_CORE_H
#define OPENOCD_FLASH_NOR_CORE_H
 
#include <flash/common.h>
 
struct image;
 
struct flash_sector {
    uint32_t offset;
    uint32_t size;
    int is_erased;
    int is_protected;
};
 
#define FLASH_WRITE_ALIGN_SECTOR    UINT32_MAX
 
#define FLASH_WRITE_CONTINUOUS      0
#define FLASH_WRITE_GAP_SECTOR      UINT32_MAX
 
struct flash_bank {
    char *name;
 
    struct target *target; 
    const struct flash_driver *driver; 
    void *driver_priv; 
    unsigned int bank_number; 
    target_addr_t base; 
    uint32_t size; 
    bool read_only; 
    unsigned int chip_width; 
    unsigned int bus_width; 
    uint8_t erased_value;
 
    uint8_t default_padded_value;
 
    uint32_t write_start_alignment;
    uint32_t write_end_alignment;
    uint32_t minimal_write_gap;
 
    unsigned int num_sectors;
    struct flash_sector *sectors;
 
    unsigned int num_prot_blocks;
    struct flash_sector *prot_blocks;
 
    struct flash_bank *next; 
};
 
int flash_register_commands(struct command_context *cmd_ctx);
 
int flash_erase_address_range(struct target *target,
        bool pad, target_addr_t addr, uint32_t length);
 
int flash_unlock_address_range(struct target *target, target_addr_t addr,
        uint32_t length);
 
target_addr_t flash_write_align_start(struct flash_bank *bank, target_addr_t addr);
target_addr_t flash_write_align_end(struct flash_bank *bank, target_addr_t addr);
 
int flash_write(struct target *target,
        struct image *image, uint32_t *written, bool erase);
 
void flash_set_dirty(void);
 
unsigned int flash_get_bank_count(void);
 
void default_flash_free_driver_priv(struct flash_bank *bank);
 
void flash_free_all_banks(void);
 
int default_flash_read(struct flash_bank *bank,
        uint8_t *buffer, uint32_t offset, uint32_t count);
 
int default_flash_verify(struct flash_bank *bank,
        const uint8_t *buffer, uint32_t offset, uint32_t count);
 
int default_flash_blank_check(struct flash_bank *bank);
int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result);
struct flash_bank *get_flash_bank_by_name_noprobe(const char *name);
int get_flash_bank_by_num(unsigned int num, struct flash_bank **bank);
COMMAND_HELPER(flash_command_get_bank, unsigned int name_index,
        struct flash_bank **bank);
COMMAND_HELPER(flash_command_get_bank_probe_optional, unsigned int name_index,
        struct flash_bank **bank, bool do_probe);
struct flash_bank *get_flash_bank_by_num_noprobe(unsigned int num);
int get_flash_bank_by_addr(struct target *target, target_addr_t addr, bool check,
        struct flash_bank **result_bank);
struct flash_sector *alloc_block_array(uint32_t offset, uint32_t size,
        unsigned int num_blocks);
 
#endif /* OPENOCD_FLASH_NOR_CORE_H */