src/flash/flash.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef FLASH_H
  21 #define FLASH_H
  22
  23 #include "target.h"
  24 #include "image.h"
  25
  26 #define FLASH_MAX_ERROR_STR     (128)
  27
  28 typedef struct flash_sector_s
  29 {
  30         u32 offset;
  31         u32 size;
  32         int is_erased;
  33         int is_protected;
  34 } flash_sector_t;
  35
  36 struct flash_bank_s;
  37
  38 typedef struct flash_driver_s
  39 {
  40         char *name;
  41         int (*register_commands)(struct command_context_s *cmd_ctx);
  42         int (*flash_bank_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
  43         /* low level flash erase. Only invoke from flash_driver_erase()
  44          *
  45          * Will only be invoked when target is halted.
  46          */
  47         int (*erase)(struct flash_bank_s *bank, int first, int last);
  48         /* invoked only from flash_driver_protect().
  49          *
  50          * Only invoked if target is halted
  51          */
  52         int (*protect)(struct flash_bank_s *bank, int set, int first, int last);
  53         /* low level flash write. Will only be invoked if the target is halted.
  54          * use the flash_driver_write() wrapper to invoke.
  55          */
  56         int (*write)(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
  57         int (*probe)(struct flash_bank_s *bank);
  58         int (*erase_check)(struct flash_bank_s *bank);
  59         int (*protect_check)(struct flash_bank_s *bank);
  60         int (*info)(struct flash_bank_s *bank, char *buf, int buf_size);
  61         int (*auto_probe)(struct flash_bank_s *bank);
  62 } flash_driver_t;
  63
  64 typedef struct flash_bank_s
  65 {
  66         target_t *target;
  67         flash_driver_t *driver;
  68         void *driver_priv;
  69         u32 base;
  70         u32 size;
  71         int chip_width;
  72         int bus_width;
  73         int num_sectors;
  74         flash_sector_t *sectors;
  75         struct flash_bank_s *next;
  76 } flash_bank_t;
  77
  78 extern int flash_register_commands(struct command_context_s *cmd_ctx);
  79 extern int flash_init_drivers(struct command_context_s *cmd_ctx);
  80
  81 extern int flash_erase_address_range(target_t *target, u32 addr, u32 length);
  82 extern int flash_write(target_t *target, image_t *image, u32 *written, int erase);
  83 extern void flash_set_dirty(void);
  84
  85 extern flash_bank_t *get_flash_bank_by_num(int num);
  86 extern flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr);
  87
  88 #define         ERROR_FLASH_BANK_INVALID                (-900)
  89 #define         ERROR_FLASH_SECTOR_INVALID              (-901)
  90 #define         ERROR_FLASH_OPERATION_FAILED    (-902)
  91 #define         ERROR_FLASH_DST_OUT_OF_BANK             (-903)
  92 #define         ERROR_FLASH_DST_BREAKS_ALIGNMENT (-904)
  93 #define         ERROR_FLASH_BUSY                                (-905)
  94 #define         ERROR_FLASH_SECTOR_NOT_ERASED   (-906)
  95 #define         ERROR_FLASH_BANK_NOT_PROBED             (-907)
  96
  97 #endif /* FLASH_H */