blob: bb82385c1f74fa693b4ee95488789df864eea33e [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenkaffae2b2002-08-17 09:36:01 +00002/*
3 * (C) Copyright 2000
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkaffae2b2002-08-17 09:36:01 +00005 */
6
wdenk7e780362004-04-08 22:31:29 +00007/* #define DEBUG */
8
wdenkaffae2b2002-08-17 09:36:01 +00009#include <common.h>
10#include <flash.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060011#include <log.h>
Simon Glassb79fdc72020-05-10 11:39:54 -060012#include <uuid.h>
wdenkaffae2b2002-08-17 09:36:01 +000013
Stefan Roeseca5def32010-08-31 10:00:10 +020014#include <mtd/cfi_flash.h>
wdenkaffae2b2002-08-17 09:36:01 +000015
Marian Balakowicze6f2e902005-10-11 19:09:42 +020016extern flash_info_t flash_info[]; /* info for FLASH chips */
wdenkaffae2b2002-08-17 09:36:01 +000017
18/*-----------------------------------------------------------------------
19 * Functions
20 */
21
22/*-----------------------------------------------------------------------
23 * Set protection status for monitor sectors
24 *
25 * The monitor is always located in the _first_ Flash bank.
26 * If necessary you have to map the second bank at lower addresses.
27 */
28void
Simon Glassa595a0e2020-05-10 11:39:53 -060029flash_protect(int flag, ulong from, ulong to, flash_info_t *info)
wdenkaffae2b2002-08-17 09:36:01 +000030{
Mike Frysingera4e8d9f2010-07-28 23:45:03 -040031 ulong b_end;
32 short s_end;
wdenkaffae2b2002-08-17 09:36:01 +000033 int i;
34
35 /* Do nothing if input data is bad. */
Mike Frysingera4e8d9f2010-07-28 23:45:03 -040036 if (!info || info->sector_count == 0 || info->size == 0 || to < from) {
wdenkaffae2b2002-08-17 09:36:01 +000037 return;
38 }
39
Mike Frysingera4e8d9f2010-07-28 23:45:03 -040040 s_end = info->sector_count - 1; /* index of last sector */
41 b_end = info->start[0] + info->size - 1; /* bank end address */
42
Simon Glass09140112020-05-10 11:40:03 -060043 debug("%s %s: from 0x%08lX to 0x%08lX\n", __func__,
44 (flag & FLAG_PROTECT_SET) ? "ON" :
Simon Glass3c7dded2020-05-10 11:40:04 -060045 (flag & FLAG_PROTECT_CLEAR) ? "OFF" : "???",
Simon Glass09140112020-05-10 11:40:03 -060046 from, to);
Eugene OBriend2f68002007-07-31 10:24:56 +020047
wdenkaffae2b2002-08-17 09:36:01 +000048 /* There is nothing to do if we have no data about the flash
49 * or the protect range and flash range don't overlap.
50 */
51 if (info->flash_id == FLASH_UNKNOWN ||
52 to < info->start[0] || from > b_end) {
53 return;
54 }
55
56 for (i=0; i<info->sector_count; ++i) {
57 ulong end; /* last address in current sect */
58
59 end = (i == s_end) ? b_end : info->start[i + 1] - 1;
60
61 /* Update protection if any part of the sector
62 * is in the specified range.
63 */
64 if (from <= end && to >= info->start[i]) {
65 if (flag & FLAG_PROTECT_CLEAR) {
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020066#if defined(CONFIG_SYS_FLASH_PROTECTION)
wdenkaffae2b2002-08-17 09:36:01 +000067 flash_real_protect(info, i, 0);
68#else
69 info->protect[i] = 0;
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020070#endif /* CONFIG_SYS_FLASH_PROTECTION */
Simon Glass3c7dded2020-05-10 11:40:04 -060071 debug("protect off %d\n", i);
wdenkaffae2b2002-08-17 09:36:01 +000072 }
73 else if (flag & FLAG_PROTECT_SET) {
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020074#if defined(CONFIG_SYS_FLASH_PROTECTION)
wdenkaffae2b2002-08-17 09:36:01 +000075 flash_real_protect(info, i, 1);
76#else
77 info->protect[i] = 1;
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020078#endif /* CONFIG_SYS_FLASH_PROTECTION */
Simon Glass3c7dded2020-05-10 11:40:04 -060079 debug("protect on %d\n", i);
wdenkaffae2b2002-08-17 09:36:01 +000080 }
81 }
82 }
83}
84
85/*-----------------------------------------------------------------------
86 */
87
88flash_info_t *
Simon Glassa595a0e2020-05-10 11:39:53 -060089addr2info(ulong addr)
wdenkaffae2b2002-08-17 09:36:01 +000090{
wdenkaffae2b2002-08-17 09:36:01 +000091 flash_info_t *info;
92 int i;
93
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020094 for (i=0, info = &flash_info[0]; i<CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {
wdenkaffae2b2002-08-17 09:36:01 +000095 if (info->flash_id != FLASH_UNKNOWN &&
96 addr >= info->start[0] &&
97 /* WARNING - The '- 1' is needed if the flash
98 * is at the end of the address space, since
99 * info->start[0] + info->size wraps back to 0.
100 * Please don't change this unless you understand this.
101 */
102 addr <= info->start[0] + info->size - 1) {
103 return (info);
104 }
105 }
wdenkaffae2b2002-08-17 09:36:01 +0000106
107 return (NULL);
108}
109
110/*-----------------------------------------------------------------------
111 * Copy memory to flash.
112 * Make sure all target addresses are within Flash bounds,
113 * and no protected sectors are hit.
114 * Returns:
115 * ERR_OK 0 - OK
Mario Six9dbaebc2018-01-26 14:43:52 +0100116 * ERR_TIMEOUT 1 - write timeout
wdenkaffae2b2002-08-17 09:36:01 +0000117 * ERR_NOT_ERASED 2 - Flash not erased
118 * ERR_PROTECTED 4 - target range includes protected sectors
119 * ERR_INVAL 8 - target address not in Flash memory
120 * ERR_ALIGN 16 - target address not aligned on boundary
121 * (only some targets require alignment)
122 */
123int
Simon Glassa595a0e2020-05-10 11:39:53 -0600124flash_write(char *src, ulong addr, ulong cnt)
wdenkaffae2b2002-08-17 09:36:01 +0000125{
wdenkaffae2b2002-08-17 09:36:01 +0000126 int i;
127 ulong end = addr + cnt - 1;
Simon Glassa595a0e2020-05-10 11:39:53 -0600128 flash_info_t *info_first = addr2info(addr);
129 flash_info_t *info_last = addr2info(end);
wdenkaffae2b2002-08-17 09:36:01 +0000130 flash_info_t *info;
Stefan Roese352ef3f2013-04-04 15:53:14 +0200131 __maybe_unused char *src_orig = src;
132 __maybe_unused char *addr_orig = (char *)addr;
133 __maybe_unused ulong cnt_orig = cnt;
wdenkaffae2b2002-08-17 09:36:01 +0000134
135 if (cnt == 0) {
136 return (ERR_OK);
137 }
138
139 if (!info_first || !info_last) {
140 return (ERR_INVAL);
141 }
142
143 for (info = info_first; info <= info_last; ++info) {
144 ulong b_end = info->start[0] + info->size; /* bank end addr */
145 short s_end = info->sector_count - 1;
146 for (i=0; i<info->sector_count; ++i) {
147 ulong e_addr = (i == s_end) ? b_end : info->start[i + 1];
148
149 if ((end >= info->start[i]) && (addr < e_addr) &&
150 (info->protect[i] != 0) ) {
151 return (ERR_PROTECTED);
152 }
153 }
154 }
155
156 /* finally write data to flash */
157 for (info = info_first; info <= info_last && cnt>0; ++info) {
158 ulong len;
159
160 len = info->start[0] + info->size - addr;
161 if (len > cnt)
162 len = cnt;
Wolfgang Denk77ddac92005-10-13 16:45:02 +0200163 if ((i = write_buff(info, (uchar *)src, addr, len)) != 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000164 return (i);
165 }
166 cnt -= len;
167 addr += len;
168 src += len;
169 }
Stefan Roese352ef3f2013-04-04 15:53:14 +0200170
171#if defined(CONFIG_FLASH_VERIFY)
172 if (memcmp(src_orig, addr_orig, cnt_orig)) {
173 printf("\nVerify failed!\n");
174 return ERR_PROG_ERROR;
175 }
176#endif /* CONFIG_SYS_FLASH_VERIFY_AFTER_WRITE */
177
wdenkaffae2b2002-08-17 09:36:01 +0000178 return (ERR_OK);
wdenkaffae2b2002-08-17 09:36:01 +0000179}
180
181/*-----------------------------------------------------------------------
182 */
183
Simon Glass0ee482522019-12-28 10:44:40 -0700184void flash_perror(int err)
wdenkaffae2b2002-08-17 09:36:01 +0000185{
186 switch (err) {
187 case ERR_OK:
188 break;
Mario Six9dbaebc2018-01-26 14:43:52 +0100189 case ERR_TIMEOUT:
wdenkaffae2b2002-08-17 09:36:01 +0000190 puts ("Timeout writing to Flash\n");
191 break;
192 case ERR_NOT_ERASED:
193 puts ("Flash not Erased\n");
194 break;
195 case ERR_PROTECTED:
196 puts ("Can't write to protected Flash sectors\n");
197 break;
198 case ERR_INVAL:
199 puts ("Outside available Flash\n");
200 break;
201 case ERR_ALIGN:
202 puts ("Start and/or end address not on sector boundary\n");
203 break;
204 case ERR_UNKNOWN_FLASH_VENDOR:
205 puts ("Unknown Vendor of Flash\n");
206 break;
207 case ERR_UNKNOWN_FLASH_TYPE:
208 puts ("Unknown Type of Flash\n");
209 break;
210 case ERR_PROG_ERROR:
211 puts ("General Flash Programming Error\n");
212 break;
Joe Hershbergerde15a062012-08-17 15:36:41 -0500213 case ERR_ABORTED:
214 puts("Flash Programming Aborted\n");
215 break;
wdenkaffae2b2002-08-17 09:36:01 +0000216 default:
217 printf ("%s[%d] FIXME: rc=%d\n", __FILE__, __LINE__, err);
218 break;
219 }
220}