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