flash/nor/driver.h

Go to the documentation of this file.

/***************************************************************************
 *   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>       *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
 ***************************************************************************/

#ifndef OPENOCD_FLASH_NOR_DRIVER_H
#define OPENOCD_FLASH_NOR_DRIVER_H

struct flash_bank;

#define __FLASH_BANK_COMMAND(name) \
        COMMAND_HELPER(name, struct flash_bank *bank)

struct flash_driver {
    const char *name;

    const char *usage;

    const struct command_registration *commands;

    __FLASH_BANK_COMMAND((*flash_bank_command));

    int (*erase)(struct flash_bank *bank, unsigned int first,
        unsigned int last);

    int (*protect)(struct flash_bank *bank, int set, unsigned int first,
        unsigned int last);

    int (*write)(struct flash_bank *bank,
            const uint8_t *buffer, uint32_t offset, uint32_t count);

     int (*read)(struct flash_bank *bank,
            uint8_t *buffer, uint32_t offset, uint32_t count);

    int (*verify)(struct flash_bank *bank,
            const uint8_t *buffer, uint32_t offset, uint32_t count);

    int (*probe)(struct flash_bank *bank);

    int (*erase_check)(struct flash_bank *bank);

    int (*protect_check)(struct flash_bank *bank);

    int (*info)(struct flash_bank *bank, char *buf, int buf_size);

    int (*auto_probe)(struct flash_bank *bank);

    void (*free_driver_priv)(struct flash_bank *bank);
};

#define FLASH_BANK_COMMAND_HANDLER(name) \
    static __FLASH_BANK_COMMAND(name)

const struct flash_driver *flash_driver_find_by_name(const char *name);

#endif /* OPENOCD_FLASH_NOR_DRIVER_H */