a1849983f26db9e16603cb22dfdfc2ad6d3a7a0b
[openocd.git] / src / flash / nor / spi.h
1 /***************************************************************************
2 * Copyright (C) 2012 by George Harris *
3 * george@luminairecoffee.com *
4 * *
5 * Copyright (C) 2010 by Antonio Borneo *
6 * borneo.antonio@gmail.com *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
21
22 #ifndef OPENOCD_FLASH_NOR_SPI_H
23 #define OPENOCD_FLASH_NOR_SPI_H
24
25 /* data structure to maintain flash ids from different vendors */
26 struct flash_device {
27 char *name;
28 uint8_t erase_cmd;
29 uint8_t chip_erase_cmd;
30 uint32_t device_id;
31 uint32_t pagesize;
32 unsigned long sectorsize;
33 unsigned long size_in_bytes;
34 };
35
36 #define FLASH_ID(n, es, ces, id, psize, ssize, size) \
37 { \
38 .name = n, \
39 .erase_cmd = es, \
40 .chip_erase_cmd = ces, \
41 .device_id = id, \
42 .pagesize = psize, \
43 .sectorsize = ssize, \
44 .size_in_bytes = size \
45 }
46
47 extern const struct flash_device flash_devices[];
48
49 /* fields in SPI flash status register */
50 #define SPIFLASH_BSY_BIT 0x00000001 /* WIP Bit of SPI SR on SMI SR */
51 #define SPIFLASH_WE_BIT 0x00000002 /* WEL Bit of SPI SR on SMI SR */
52
53 /* SPI Flash Commands */
54 #define SPIFLASH_READ_ID 0x9F /* Read Flash Identification */
55 #define SPIFLASH_READ_STATUS 0x05 /* Read Status Register */
56 #define SPIFLASH_WRITE_ENABLE 0x06 /* Write Enable */
57 #define SPIFLASH_PAGE_PROGRAM 0x02 /* Page Program */
58 #define SPIFLASH_FAST_READ 0x0B /* Fast Read */
59 #define SPIFLASH_READ 0x03 /* Normal Read */
60
61 #endif /* OPENOCD_FLASH_NOR_SPI_H */