]>
Commit | Line | Data |
---|---|---|
d25ce7d2 HS |
1 | /* |
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 | |
1a459660 | 11 | * version 2 as published by the Free Software Foundation. |
d25ce7d2 HS |
12 | */ |
13 | #ifndef _SPI_FLASH_H_ | |
14 | #define _SPI_FLASH_H_ | |
15 | ||
16 | #include <spi.h> | |
e06ab654 | 17 | #include <linux/types.h> |
32b11273 | 18 | #include <linux/compiler.h> |
d25ce7d2 | 19 | |
d25ce7d2 HS |
20 | struct spi_flash { |
21 | struct spi_slave *spi; | |
22 | ||
23 | const char *name; | |
24 | ||
d4aa5009 | 25 | /* Total flash size */ |
d25ce7d2 | 26 | u32 size; |
d4aa5009 MF |
27 | /* Write (page) size */ |
28 | u32 page_size; | |
29 | /* Erase (sector) size */ | |
4e6a5158 | 30 | u32 sector_size; |
1dcd6d03 | 31 | #ifdef CONFIG_SPI_FLASH_BAR |
cf6b11dc JT |
32 | /* Bank read cmd */ |
33 | u8 bank_read_cmd; | |
34 | /* Bank write cmd */ | |
35 | u8 bank_write_cmd; | |
e612ddf5 JT |
36 | /* Current flash bank */ |
37 | u8 bank_curr; | |
1dcd6d03 | 38 | #endif |
615a1561 JT |
39 | /* Poll cmd - for flash erase/program */ |
40 | u8 poll_cmd; | |
41 | ||
bb8215f4 | 42 | void *memory_map; /* Address of read-only SPI flash access */ |
d25ce7d2 HS |
43 | int (*read)(struct spi_flash *flash, u32 offset, |
44 | size_t len, void *buf); | |
45 | int (*write)(struct spi_flash *flash, u32 offset, | |
46 | size_t len, const void *buf); | |
47 | int (*erase)(struct spi_flash *flash, u32 offset, | |
48 | size_t len); | |
49 | }; | |
50 | ||
b5aec142 SG |
51 | /** |
52 | * spi_flash_do_alloc - Allocate a new spi flash structure | |
53 | * | |
54 | * The structure is allocated and cleared with default values for | |
55 | * read, write and erase, which the caller can modify. The caller must set | |
56 | * up size, page_size and sector_size. | |
57 | * | |
58 | * Use the helper macro spi_flash_alloc() to call this. | |
59 | * | |
60 | * @offset: Offset of struct spi_slave within slave structure | |
61 | * @size: Size of slave structure | |
62 | * @spi: SPI slave | |
63 | * @name: Name of SPI flash device | |
64 | */ | |
65 | void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi, | |
66 | const char *name); | |
67 | ||
68 | /** | |
69 | * spi_flash_alloc - Allocate a new SPI flash structure | |
70 | * | |
71 | * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This | |
72 | * structure must contain a member 'struct spi_flash *flash'. | |
73 | * @spi: SPI slave | |
74 | * @name: Name of SPI flash device | |
75 | */ | |
76 | #define spi_flash_alloc(_struct, spi, name) \ | |
77 | spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \ | |
78 | spi, name) | |
79 | ||
80 | /** | |
81 | * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data | |
82 | * | |
83 | * @spi: SPI slave | |
84 | * @name: Name of SPI flash device | |
85 | */ | |
86 | #define spi_flash_alloc_base(spi, name) \ | |
87 | spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name) | |
88 | ||
d25ce7d2 HS |
89 | struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, |
90 | unsigned int max_hz, unsigned int spi_mode); | |
91 | void spi_flash_free(struct spi_flash *flash); | |
92 | ||
93 | static inline int spi_flash_read(struct spi_flash *flash, u32 offset, | |
94 | size_t len, void *buf) | |
95 | { | |
96 | return flash->read(flash, offset, len, buf); | |
97 | } | |
98 | ||
99 | static inline int spi_flash_write(struct spi_flash *flash, u32 offset, | |
100 | size_t len, const void *buf) | |
101 | { | |
102 | return flash->write(flash, offset, len, buf); | |
103 | } | |
104 | ||
105 | static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, | |
106 | size_t len) | |
107 | { | |
108 | return flash->erase(flash, offset, len); | |
109 | } | |
110 | ||
32b11273 CR |
111 | void spi_boot(void) __noreturn; |
112 | ||
d25ce7d2 | 113 | #endif /* _SPI_FLASH_H_ */ |