blob: 7ffc7b239e8826e967d0935148466f7d760b8815 [file] [log] [blame]
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +02001/*
2 * Interface to SPI flash
3 *
4 * Copyright (C) 2008 Atmel Corporation
5 *
6 * See file CREDITS for list of people who contributed to this
7 * project.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
Wolfgang Denkd79de1d2013-07-08 09:37:19 +020011 * version 2 as published by the Free Software Foundation.
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +020012 */
13#ifndef _SPI_FLASH_H_
14#define _SPI_FLASH_H_
15
16#include <spi.h>
Mike Frysingere4c698b2009-11-03 11:36:39 -050017#include <linux/types.h>
Christian Riesch23f16a82011-12-09 09:47:35 +000018#include <linux/compiler.h>
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +020019
Jagannadha Sutradharudu Tekibc0f8792013-10-02 19:36:58 +053020/* SECT flags */
21#define SECT_4K (1 << 1)
22#define SECT_32K (1 << 2)
Jagannadha Sutradharudu Tekif41fcca2013-10-02 19:37:43 +053023#define E_FSR (1 << 3)
Jagannadha Sutradharudu Tekibc0f8792013-10-02 19:36:58 +053024
Jagannadha Sutradharudu Teki08032422013-10-02 19:34:53 +053025/* SST specific macros */
26#ifdef CONFIG_SPI_FLASH_SST
27# define SST_WP 0x01 /* Supports AAI word program */
28# define CMD_SST_BP 0x02 /* Byte Program */
29# define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */
30#endif
31
Jagannadha Sutradharudu Tekif000ad02013-09-28 18:10:43 +053032/**
33 * struct spi_flash - SPI flash structure
34 *
35 * @spi: SPI slave
36 * @name: Name of SPI flash
37 * @size: Total flash size
38 * @page_size: Write (page) size
39 * @sector_size: Sector size
40 * @erase_size: Erase size
41 * @bank_read_cmd: Bank read cmd
42 * @bank_write_cmd: Bank write cmd
43 * @bank_curr: Current flash bank
44 * @poll_cmd: Poll cmd - for flash erase/program
45 * @erase_cmd: Erase cmd 4K, 32K, 64K
46 * @memory_map: Address of read-only SPI flash access
47 * @read: Flash read ops: Read len bytes at offset into buf
48 * Supported cmds: Fast Array Read
49 * @write: Flash write ops: Write len bytes from buf into offeset
50 * Supported cmds: Page Program
51 * @erase: Flash erase ops: Erase len bytes from offset
52 * Supported cmds: Sector erase 4K, 32K, 64K
53 * return 0 - Sucess, 1 - Failure
54 */
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +020055struct spi_flash {
56 struct spi_slave *spi;
Jagannadha Sutradharudu Tekif000ad02013-09-28 18:10:43 +053057 const char *name;
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +020058
Jagannadha Sutradharudu Tekif000ad02013-09-28 18:10:43 +053059 u32 size;
60 u32 page_size;
61 u32 sector_size;
62 u32 erase_size;
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +053063#ifdef CONFIG_SPI_FLASH_BAR
Jagannadha Sutradharudu Tekif000ad02013-09-28 18:10:43 +053064 u8 bank_read_cmd;
65 u8 bank_write_cmd;
66 u8 bank_curr;
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +053067#endif
Jagannadha Sutradharudu Tekif000ad02013-09-28 18:10:43 +053068 u8 poll_cmd;
69 u8 erase_cmd;
Jagannadha Sutradharudu Teki750f3ac2013-06-21 15:56:30 +053070
Jagannadha Sutradharudu Tekif000ad02013-09-28 18:10:43 +053071 void *memory_map;
72 int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf);
73 int (*write)(struct spi_flash *flash, u32 offset, size_t len,
74 const void *buf);
75 int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +020076};
77
Simon Glassb162a7c2013-03-11 06:08:02 +000078/**
79 * spi_flash_do_alloc - Allocate a new spi flash structure
80 *
81 * The structure is allocated and cleared with default values for
82 * read, write and erase, which the caller can modify. The caller must set
83 * up size, page_size and sector_size.
84 *
85 * Use the helper macro spi_flash_alloc() to call this.
86 *
87 * @offset: Offset of struct spi_slave within slave structure
88 * @size: Size of slave structure
89 * @spi: SPI slave
90 * @name: Name of SPI flash device
91 */
92void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi,
93 const char *name);
94
95/**
96 * spi_flash_alloc - Allocate a new SPI flash structure
97 *
98 * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This
99 * structure must contain a member 'struct spi_flash *flash'.
100 * @spi: SPI slave
101 * @name: Name of SPI flash device
102 */
103#define spi_flash_alloc(_struct, spi, name) \
104 spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \
105 spi, name)
106
107/**
108 * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data
109 *
110 * @spi: SPI slave
111 * @name: Name of SPI flash device
112 */
113#define spi_flash_alloc_base(spi, name) \
114 spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name)
115
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200116struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
117 unsigned int max_hz, unsigned int spi_mode);
118void spi_flash_free(struct spi_flash *flash);
119
120static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
121 size_t len, void *buf)
122{
123 return flash->read(flash, offset, len, buf);
124}
125
126static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
127 size_t len, const void *buf)
128{
129 return flash->write(flash, offset, len, buf);
130}
131
132static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
133 size_t len)
134{
135 return flash->erase(flash, offset, len);
136}
137
Christian Riesch23f16a82011-12-09 09:47:35 +0000138void spi_boot(void) __noreturn;
139
Haavard Skinnemoen2f5bfb72008-05-16 11:10:33 +0200140#endif /* _SPI_FLASH_H_ */