blob: 25ca8f177b3452329e277c83dd357946ce6749ba [file] [log] [blame]
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +02001/*
Jagannadha Sutradharudu Tekia5e81992013-10-02 19:38:49 +05302 * Common SPI flash Interface
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +02003 *
4 * Copyright (C) 2008 Atmel Corporation
Jagannadha Sutradharudu Tekia5e81992013-10-02 19:38:49 +05305 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +02006 *
7 * See file CREDITS for list of people who contributed to this
8 * project.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
Wolfgang Denk3765b3e2013-10-07 13:07:26 +020012 * version 2 as published by the Free Software Foundation.
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020013 */
Jagannadha Sutradharudu Tekia5e81992013-10-02 19:38:49 +053014
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020015#ifndef _SPI_FLASH_H_
16#define _SPI_FLASH_H_
17
18#include <spi.h>
Mike Frysingere06ab652009-11-03 11:36:39 -050019#include <linux/types.h>
Christian Riesch32b11272011-12-09 09:47:35 +000020#include <linux/compiler.h>
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020021
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053022/**
23 * struct spi_flash - SPI flash structure
24 *
25 * @spi: SPI slave
26 * @name: Name of SPI flash
27 * @size: Total flash size
28 * @page_size: Write (page) size
29 * @sector_size: Sector size
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053030 * @erase_size: Erase size
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053031 * @bank_read_cmd: Bank read cmd
32 * @bank_write_cmd: Bank write cmd
33 * @bank_curr: Current flash bank
34 * @poll_cmd: Poll cmd - for flash erase/program
35 * @erase_cmd: Erase cmd 4K, 32K, 64K
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053036 * @memory_map: Address of read-only SPI flash access
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053037 * @read: Flash read ops: Read len bytes at offset into buf
38 * Supported cmds: Fast Array Read
39 * @write: Flash write ops: Write len bytes from buf into offeset
40 * Supported cmds: Page Program
41 * @erase: Flash erase ops: Erase len bytes from offset
42 * Supported cmds: Sector erase 4K, 32K, 64K
43 * return 0 - Sucess, 1 - Failure
44 */
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020045struct spi_flash {
46 struct spi_slave *spi;
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053047 const char *name;
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020048
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053049 u32 size;
50 u32 page_size;
51 u32 sector_size;
52 u32 erase_size;
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +053053#ifdef CONFIG_SPI_FLASH_BAR
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053054 u8 bank_read_cmd;
55 u8 bank_write_cmd;
56 u8 bank_curr;
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +053057#endif
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053058 u8 poll_cmd;
59 u8 erase_cmd;
Jagannadha Sutradharudu Teki615a1562013-06-21 15:56:30 +053060
Jagannadha Sutradharudu Teki7ab35d92013-09-28 18:10:43 +053061 void *memory_map;
62 int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf);
63 int (*write)(struct spi_flash *flash, u32 offset, size_t len,
64 const void *buf);
65 int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020066};
67
68struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
69 unsigned int max_hz, unsigned int spi_mode);
70void spi_flash_free(struct spi_flash *flash);
71
72static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
73 size_t len, void *buf)
74{
75 return flash->read(flash, offset, len, buf);
76}
77
78static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
79 size_t len, const void *buf)
80{
81 return flash->write(flash, offset, len, buf);
82}
83
84static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
85 size_t len)
86{
87 return flash->erase(flash, offset, len);
88}
89
Christian Riesch32b11272011-12-09 09:47:35 +000090void spi_boot(void) __noreturn;
91
Haavard Skinnemoend25ce7d2008-05-16 11:10:33 +020092#endif /* _SPI_FLASH_H_ */