2 * Copyright (C) 2009 by Marvell Semiconductors, Inc.
3 * Written by Nicolas Pitre <nico at marvell.com>
5 * Copyright (C) 2009 by David Brownell
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the
19 * Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <helper/binarybuffer.h>
30 #include <target/arm.h>
31 #include <target/armv7m.h>
32 #include <target/algorithm.h>
35 * Copies code to a working area. This will allocate room for the code plus the
36 * additional amount requested if the working area pointer is null.
38 * @param target Pointer to the target to copy code to
39 * @param code Pointer to the code area to be copied
40 * @param code_size Size of the code being copied
41 * @param additional Size of the additional area to be allocated in addition to
43 * @param area Pointer to a pointer to a working area to copy code to
44 * @return Success or failure of the operation
46 static int arm_code_to_working_area(struct target
*target
,
47 const uint32_t *code
, unsigned code_size
,
48 unsigned additional
, struct working_area
**area
)
50 uint8_t code_buf
[code_size
];
52 unsigned size
= code_size
+ additional
;
54 /* REVISIT this assumes size doesn't ever change.
55 * That's usually correct; but there are boards with
56 * both large and small page chips, where it won't be...
59 /* make sure we have a working area */
61 retval
= target_alloc_working_area(target
, size
, area
);
62 if (retval
!= ERROR_OK
) {
63 LOG_DEBUG("%s: no %d byte buffer", __func__
, (int) size
);
64 return ERROR_NAND_NO_BUFFER
;
68 /* buffer code in target endianness */
69 target_buffer_set_u32_array(target
, code_buf
, code_size
/ 4, code
);
71 /* copy code to work area */
72 retval
= target_write_memory(target
, (*area
)->address
,
73 4, code_size
/ 4, code_buf
);
79 * ARM-specific bulk write from buffer to address of 8-bit wide NAND.
80 * For now this supports ARMv4,ARMv5 and ARMv7-M cores.
82 * Enhancements to target_run_algorithm() could enable:
83 * - ARMv6 and ARMv7 cores in ARM mode
85 * Different code fragments could handle:
86 * - 16-bit wide data (needs different setup)
88 * @param nand Pointer to the arm_nand_data struct that defines the I/O
89 * @param data Pointer to the data to be copied to flash
90 * @param size Size of the data being copied
91 * @return Success or failure of the operation
93 int arm_nandwrite(struct arm_nand_data
*nand
, uint8_t *data
, int size
)
95 struct target
*target
= nand
->target
;
96 struct arm_algorithm armv4_5_algo
;
97 struct armv7m_algorithm armv7m_algo
;
99 struct arm
*arm
= target
->arch_info
;
100 struct reg_param reg_params
[3];
102 uint32_t exit_var
= 0;
106 * r0 NAND data address (byte wide)
110 static const uint32_t code_armv4_5
[] = {
111 0xe4d13001, /* s: ldrb r3, [r1], #1 */
112 0xe5c03000, /* strb r3, [r0] */
113 0xe2522001, /* subs r2, r2, #1 */
114 0x1afffffb, /* bne s */
116 /* exit: ARMv4 needs hardware breakpoint */
117 0xe1200070, /* e: bkpt #0 */
121 * r0 NAND data address (byte wide)
125 * see contrib/loaders/flash/armv7m_io.s for src
127 static const uint32_t code_armv7m
[] = {
134 int target_code_size
= 0;
135 const uint32_t *target_code_src
= NULL
;
137 /* set up algorithm */
138 if (is_armv7m(target_to_armv7m(target
))) { /* armv7m target */
139 armv7m_algo
.common_magic
= ARMV7M_COMMON_MAGIC
;
140 armv7m_algo
.core_mode
= ARM_MODE_THREAD
;
141 arm_algo
= &armv7m_algo
;
142 target_code_size
= sizeof(code_armv7m
);
143 target_code_src
= code_armv7m
;
145 armv4_5_algo
.common_magic
= ARM_COMMON_MAGIC
;
146 armv4_5_algo
.core_mode
= ARM_MODE_SVC
;
147 armv4_5_algo
.core_state
= ARM_STATE_ARM
;
148 arm_algo
= &armv4_5_algo
;
149 target_code_size
= sizeof(code_armv4_5
);
150 target_code_src
= code_armv4_5
;
153 if (nand
->op
!= ARM_NAND_WRITE
|| !nand
->copy_area
) {
154 retval
= arm_code_to_working_area(target
, target_code_src
, target_code_size
,
155 nand
->chunk_size
, &nand
->copy_area
);
156 if (retval
!= ERROR_OK
)
160 nand
->op
= ARM_NAND_WRITE
;
162 /* copy data to work area */
163 target_buf
= nand
->copy_area
->address
+ target_code_size
;
164 retval
= target_write_buffer(target
, target_buf
, size
, data
);
165 if (retval
!= ERROR_OK
)
168 /* set up parameters */
169 init_reg_param(®_params
[0], "r0", 32, PARAM_IN
);
170 init_reg_param(®_params
[1], "r1", 32, PARAM_IN
);
171 init_reg_param(®_params
[2], "r2", 32, PARAM_IN
);
173 buf_set_u32(reg_params
[0].value
, 0, 32, nand
->data
);
174 buf_set_u32(reg_params
[1].value
, 0, 32, target_buf
);
175 buf_set_u32(reg_params
[2].value
, 0, 32, size
);
177 /* armv4 must exit using a hardware breakpoint */
179 exit_var
= nand
->copy_area
->address
+ target_code_size
- 4;
181 /* use alg to write data from work area to NAND chip */
182 retval
= target_run_algorithm(target
, 0, NULL
, 3, reg_params
,
183 nand
->copy_area
->address
, exit_var
, 1000, arm_algo
);
184 if (retval
!= ERROR_OK
)
185 LOG_ERROR("error executing hosted NAND write");
187 destroy_reg_param(®_params
[0]);
188 destroy_reg_param(®_params
[1]);
189 destroy_reg_param(®_params
[2]);
195 * Uses an on-chip algorithm for an ARM device to read from a NAND device and
196 * store the data into the host machine's memory.
198 * @param nand Pointer to the arm_nand_data struct that defines the I/O
199 * @param data Pointer to the data buffer to store the read data
200 * @param size Amount of data to be stored to the buffer.
201 * @return Success or failure of the operation
203 int arm_nandread(struct arm_nand_data
*nand
, uint8_t *data
, uint32_t size
)
205 struct target
*target
= nand
->target
;
206 struct arm_algorithm armv4_5_algo
;
207 struct armv7m_algorithm armv7m_algo
;
209 struct arm
*arm
= target
->arch_info
;
210 struct reg_param reg_params
[3];
212 uint32_t exit_var
= 0;
217 * r1 NAND data address (byte wide)
220 static const uint32_t code_armv4_5
[] = {
221 0xe5d13000, /* s: ldrb r3, [r1] */
222 0xe4c03001, /* strb r3, [r0], #1 */
223 0xe2522001, /* subs r2, r2, #1 */
224 0x1afffffb, /* bne s */
226 /* exit: ARMv4 needs hardware breakpoint */
227 0xe1200070, /* e: bkpt #0 */
232 * r1 NAND data address (byte wide)
235 * see contrib/loaders/flash/armv7m_io.s for src
237 static const uint32_t code_armv7m
[] = {
244 int target_code_size
= 0;
245 const uint32_t *target_code_src
= NULL
;
247 /* set up algorithm */
248 if (is_armv7m(target_to_armv7m(target
))) { /* armv7m target */
249 armv7m_algo
.common_magic
= ARMV7M_COMMON_MAGIC
;
250 armv7m_algo
.core_mode
= ARM_MODE_THREAD
;
251 arm_algo
= &armv7m_algo
;
252 target_code_size
= sizeof(code_armv7m
);
253 target_code_src
= code_armv7m
;
255 armv4_5_algo
.common_magic
= ARM_COMMON_MAGIC
;
256 armv4_5_algo
.core_mode
= ARM_MODE_SVC
;
257 armv4_5_algo
.core_state
= ARM_STATE_ARM
;
258 arm_algo
= &armv4_5_algo
;
259 target_code_size
= sizeof(code_armv4_5
);
260 target_code_src
= code_armv4_5
;
263 /* create the copy area if not yet available */
264 if (nand
->op
!= ARM_NAND_READ
|| !nand
->copy_area
) {
265 retval
= arm_code_to_working_area(target
, target_code_src
, target_code_size
,
266 nand
->chunk_size
, &nand
->copy_area
);
267 if (retval
!= ERROR_OK
)
271 nand
->op
= ARM_NAND_READ
;
272 target_buf
= nand
->copy_area
->address
+ target_code_size
;
274 /* set up parameters */
275 init_reg_param(®_params
[0], "r0", 32, PARAM_IN
);
276 init_reg_param(®_params
[1], "r1", 32, PARAM_IN
);
277 init_reg_param(®_params
[2], "r2", 32, PARAM_IN
);
279 buf_set_u32(reg_params
[0].value
, 0, 32, target_buf
);
280 buf_set_u32(reg_params
[1].value
, 0, 32, nand
->data
);
281 buf_set_u32(reg_params
[2].value
, 0, 32, size
);
283 /* armv4 must exit using a hardware breakpoint */
285 exit_var
= nand
->copy_area
->address
+ target_code_size
- 4;
287 /* use alg to write data from NAND chip to work area */
288 retval
= target_run_algorithm(target
, 0, NULL
, 3, reg_params
,
289 nand
->copy_area
->address
, exit_var
, 1000, arm_algo
);
290 if (retval
!= ERROR_OK
)
291 LOG_ERROR("error executing hosted NAND read");
293 destroy_reg_param(®_params
[0]);
294 destroy_reg_param(®_params
[1]);
295 destroy_reg_param(®_params
[2]);
297 /* read from work area to the host's memory */
298 retval
= target_read_buffer(target
, target_buf
, size
, data
);