1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/* Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* SPI flash interface for Chrome EC */
#ifndef __CROS_EC_SPI_FLASH_H
#define __CROS_EC_SPI_FLASH_H
/* Obtain SPI flash size from JEDEC size */
#define SPI_FLASH_SIZE(x) (1 << (x))
/* SPI flash instructions */
#define SPI_FLASH_WRITE_ENABLE 0x06
#define SPI_FLASH_WRITE_DISABLE 0x04
#define SPI_FLASH_READ_SR1 0x05
#define SPI_FLASH_READ_SR2 0x35
#define SPI_FLASH_WRITE_SR 0x01
#define SPI_FLASH_ERASE_4KB 0x20
#define SPI_FLASH_ERASE_32KB 0x52
#define SPI_FLASH_ERASE_64KB 0xD8
#define SPI_FLASH_ERASE_CHIP 0xC7
#define SPI_FLASH_READ 0x03
#define SPI_FLASH_PAGE_PRGRM 0x02
#define SPI_FLASH_REL_PWRDWN 0xAB
#define SPI_FLASH_MFR_DEV_ID 0x90
#define SPI_FLASH_JEDEC_ID 0x9F
#define SPI_FLASH_UNIQUE_ID 0x4B
#define SPI_FLASH_SFDP 0x44
#define SPI_FLASH_ERASE_SEC_REG 0x44
#define SPI_FLASH_PRGRM_SEC_REG 0x42
#define SPI_FLASH_READ_SEC_REG 0x48
#define SPI_FLASH_ENABLE_RESET 0x66
#define SPI_FLASH_RESET 0x99
/* Maximum single write size (in bytes) for the W25Q64FV SPI flash */
#define SPI_FLASH_MAX_WRITE_SIZE 256
/* Maximum single read size (in bytes) for the W25Q64FV SPI flash */
/* Limited by size of internal driver buffer, not the chip */
#define SPI_FLASH_MAX_READ_SIZE (SPI_FLASH_MAX_MESSAGE_SIZE - 4)
/* Status register write protect structure */
enum wp {
SPI_WP_NONE,
SPI_WP_HARDWARE,
SPI_WP_POWER_CYCLE,
SPI_WP_PERMANENT,
};
/**
* Determines whether SPI is initialized
* @return 1 if initialized, 0 otherwise.
*/
int spi_flash_ready(void);
/**
* Waits for chip to finish current operation. Must be called after
* erase/write operations to ensure successive commands are executed.
* @return EC_SUCCESS or error on timeout
*/
int spi_flash_wait(void);
/**
* Initialize SPI module, registers, and clocks
*/
void spi_flash_initialize(void);
/**
* Shutdown SPI
* @return EC_SUCCESS, or non-zero if any error.
*/
int spi_flash_shutdown(void);
/**
* Returns the contents of SPI flash status register 1
* @return register contents
*/
uint8_t spi_flash_get_status1(void);
/**
* Returns the contents of SPI flash status register 2
* @return register contents
*/
uint8_t spi_flash_get_status2(void);
/**
* Sets the SPI flash status registers (non-volatile bits only)
* Pass reg2 == -1 to only set reg1.
* @param reg1 Status register 1
* @param reg2 Status register 2 (optional)
* @return EC_SUCCESS, or non-zero if any error.
*/
int spi_flash_set_status(int reg1, int reg2);
/**
* Returns the content of SPI flash
* @param buf Buffer to write flash contents
* @param offset Flash offset to start reading from
* @param bytes Number of bytes to read. Limited by receive buffer to 256.
* @return EC_SUCCESS, or non-zero if any error.
*/
int spi_flash_read(uint8_t *buf, unsigned int offset, unsigned int bytes);
/**
* Erase SPI flash.
* @param offset Flash offset to start erasing
* @param bytes Number of bytes to erase
* @return EC_SUCCESS, or non-zero if any error.
*/
int spi_flash_erase(unsigned int offset, unsigned int bytes);
/**
* Write to SPI flash. Assumes already erased.
* Limited to SPI_FLASH_MAX_WRITE_SIZE by chip.
* @param offset Flash offset to write
* @param bytes Number of bytes to write
* @param data Data to write to flash
* @return EC_SUCCESS, or non-zero if any error.
*/
int spi_flash_write(unsigned int offset, unsigned int bytes,
const uint8_t const *data);
/**
* Returns the SPI flash manufacturer ID and device ID [8:0]
* @return flash manufacturer + device ID
*/
uint16_t spi_flash_get_id(void);
/**
* Returns the SPI flash JEDEC ID (manufacturer ID, memory type, and capacity)
* @return flash JEDEC ID
*/
uint32_t spi_flash_get_jedec_id(void);
/**
* Returns the SPI flash unique ID (serial)
* @return flash unique ID
*/
uint64_t spi_flash_get_unique_id(void);
/**
* Check for SPI flash status register write protection
* Cannot sample WP pin, will consider hardware WP to be no protection
* @param wp Status register write protection mode
* @return EC_SUCCESS for no protection, or non-zero if error.
*/
int spi_flash_check_wp(void);
/**
* Set SPI flash status register write protection
* @param wp Status register write protection mode
* @return EC_SUCCESS for no protection, or non-zero if error.
*/
int spi_flash_set_wp(enum wp);
/**
* Check for SPI flash block write protection
* @param offset Flash block offset to check
* @param bytes Flash block length to check
* @return EC_SUCCESS for no protection, or non-zero if error.
*/
int spi_flash_check_protect(unsigned int offset, unsigned int bytes);
/**
* Set SPI flash block write protection
* If offset == bytes == 0, remove protection.
* @param offset Flash block offset to protect
* @param bytes Flash block length to protect
* @return EC_SUCCESS, or non-zero if error.
*/
int spi_flash_set_protect(unsigned int offset, unsigned int bytes);
#endif /* __CROS_EC_SPI_FLASH_H */
|
