2 * Common SPI flash Interface
4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
7 * See file CREDITS for list of people who contributed to this
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * version 2 as published by the Free Software Foundation.
19 #include <linux/types.h>
20 #include <linux/compiler.h>
23 #define SECT_4K 1 << 1
24 #define SECT_32K 1 << 2
28 /* Enum list - Full read commands */
31 DUAL_OUTPUT_FAST = 1 << 1,
32 DUAL_IO_FAST = 1 << 2,
33 QUAD_OUTPUT_FAST = 1 << 3,
34 QUAD_IO_FAST = 1 << 4,
36 #define RD_EXTN ARRAY_SLOW | DUAL_OUTPUT_FAST | DUAL_IO_FAST
37 #define RD_FULL RD_EXTN | QUAD_OUTPUT_FAST | QUAD_IO_FAST
40 * struct spi_flash_params - SPI/QSPI flash device params structure
42 * @name: Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
43 * @jedec: Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
44 * @ext_jedec: Device ext_jedec ID
45 * @sector_size: Sector size of this device
46 * @nr_sectors: No.of sectors on this device
47 * @e_rd_cmd: Enum list for read commands
48 * @flags: Importent param, for flash specific behaviour
50 struct spi_flash_params {
60 extern const struct spi_flash_params spi_flash_params_table[];
63 * struct spi_flash - SPI flash structure
66 * @name: Name of SPI flash
67 * @size: Total flash size
68 * @page_size: Write (page) size
69 * @sector_size: Sector size
70 * @erase_size: Erase size
71 * @bank_read_cmd: Bank read cmd
72 * @bank_write_cmd: Bank write cmd
73 * @bank_curr: Current flash bank
74 * @poll_cmd: Poll cmd - for flash erase/program
75 * @erase_cmd: Erase cmd 4K, 32K, 64K
76 * @read_cmd: Read cmd - Array Fast, Extn read and quad read.
77 * @write_cmd: Write cmd - page and quad program.
78 * @dummy_byte: Dummy cycles for read operation.
79 * @memory_map: Address of read-only SPI flash access
80 * @read: Flash read ops: Read len bytes at offset into buf
81 * Supported cmds: Fast Array Read
82 * @write: Flash write ops: Write len bytes from buf into offeset
83 * Supported cmds: Page Program
84 * @erase: Flash erase ops: Erase len bytes from offset
85 * Supported cmds: Sector erase 4K, 32K, 64K
86 * return 0 - Sucess, 1 - Failure
89 struct spi_slave *spi;
96 #ifdef CONFIG_SPI_FLASH_BAR
108 int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf);
109 int (*write)(struct spi_flash *flash, u32 offset, size_t len,
111 int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
114 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
115 unsigned int max_hz, unsigned int spi_mode);
118 * Set up a new SPI flash from an fdt node
120 * @param blob Device tree blob
121 * @param slave_node Pointer to this SPI slave node in the device tree
122 * @param spi_node Cached pointer to the SPI interface this node belongs
124 * @return 0 if ok, -1 on error
126 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
129 void spi_flash_free(struct spi_flash *flash);
131 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
132 size_t len, void *buf)
134 return flash->read(flash, offset, len, buf);
137 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
138 size_t len, const void *buf)
140 return flash->write(flash, offset, len, buf);
143 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
146 return flash->erase(flash, offset, len);
149 void spi_boot(void) __noreturn;
151 #endif /* _SPI_FLASH_H_ */