1 /***************************************************************************
\r
2 * Copyright (C) 2007 by Pavel Chromy *
\r
5 * This program is free software; you can redistribute it and/or modify *
\r
6 * it under the terms of the GNU General Public License as published by *
\r
7 * the Free Software Foundation; either version 2 of the License, or *
\r
8 * (at your option) any later version. *
\r
10 * This program is distributed in the hope that it will be useful, *
\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
\r
13 * GNU General Public License for more details. *
\r
15 * You should have received a copy of the GNU General Public License *
\r
16 * along with this program; if not, write to the *
\r
17 * Free Software Foundation, Inc., *
\r
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
\r
19 ***************************************************************************/
\r
20 #ifdef HAVE_CONFIG_H
\r
24 #include "replacements.h"
\r
31 #include "binarybuffer.h"
\r
33 #include "embeddedice.h"
\r
34 #include "arm7_9_common.h"
\r
40 int ocl_register_commands(struct command_context_s *cmd_ctx);
\r
41 int ocl_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
\r
42 int ocl_erase(struct flash_bank_s *bank, int first, int last);
\r
43 int ocl_protect(struct flash_bank_s *bank, int set, int first, int last);
\r
44 int ocl_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
\r
45 int ocl_probe(struct flash_bank_s *bank);
\r
46 int ocl_erase_check(struct flash_bank_s *bank);
\r
47 int ocl_protect_check(struct flash_bank_s *bank);
\r
48 int ocl_info(struct flash_bank_s *bank, char *buf, int buf_size);
\r
49 int ocl_auto_probe(struct flash_bank_s *bank);
\r
51 flash_driver_t ocl_flash =
\r
54 .register_commands = ocl_register_commands,
\r
55 .flash_bank_command = ocl_flash_bank_command,
\r
57 .protect = ocl_protect,
\r
60 .erase_check = ocl_erase_check,
\r
61 .protect_check = ocl_protect_check,
\r
63 .auto_probe = ocl_auto_probe
\r
67 typedef struct ocl_priv_s
\r
69 arm_jtag_t *jtag_info;
\r
75 int ocl_register_commands(struct command_context_s *cmd_ctx)
\r
81 int ocl_erase_check(struct flash_bank_s *bank)
\r
87 int ocl_protect_check(struct flash_bank_s *bank)
\r
93 /* flash_bank ocl 0 0 0 0 <target#> */
\r
94 int ocl_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
\r
97 armv4_5_common_t *armv4_5;
\r
98 arm7_9_common_t *arm7_9;
\r
103 LOG_WARNING("incomplete flash_bank ocl configuration");
\r
104 return ERROR_FLASH_BANK_INVALID;
\r
107 if ((retval = arm7_9_get_arch_pointers(bank->target, &armv4_5, &arm7_9)) != ERROR_OK)
\r
110 ocl = bank->driver_priv = malloc(sizeof(ocl_priv_t));
\r
111 ocl->jtag_info = &arm7_9->jtag_info;
\r
119 int ocl_erase(struct flash_bank_s *bank, int first, int last)
\r
121 ocl_priv_t *ocl = bank->driver_priv;
\r
125 /* check preconditions */
\r
126 if (bank->num_sectors == 0)
\r
127 return ERROR_FLASH_BANK_NOT_PROBED;
\r
129 if (bank->target->state != TARGET_RUNNING)
\r
131 LOG_ERROR("target has to be running to communicate with the loader");
\r
132 return ERROR_TARGET_NOT_RUNNING;
\r
135 if ((first == 0) && (last == bank->num_sectors - 1))
\r
137 dcc_buffer[0] = OCL_ERASE_ALL;
\r
138 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
143 dcc_buffer[0] = OCL_ERASE_BLOCK;
\r
144 dcc_buffer[1] = first;
\r
145 dcc_buffer[2] = last;
\r
146 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 3) != ERROR_OK))
\r
150 /* wait for response, fixed timeout of 1 s */
\r
151 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000) != ERROR_OK))
\r
153 if (retval == ERROR_TARGET_TIMEOUT)
\r
154 LOG_ERROR("loader not responding");
\r
158 /* receive response */
\r
159 if ((retval = embeddedice_receive(ocl->jtag_info, dcc_buffer+1, 1) != ERROR_OK))
\r
162 if (dcc_buffer[1] != OCL_CMD_DONE)
\r
164 if (dcc_buffer[0] == OCL_ERASE_ALL)
\r
165 LOG_ERROR("loader response to OCL_ERASE_ALL 0x%08lX", dcc_buffer[1]);
\r
167 LOG_ERROR("loader response to OCL_ERASE_BLOCK 0x%08lX", dcc_buffer[1]);
\r
168 return ERROR_FLASH_OPERATION_FAILED;
\r
175 int ocl_protect(struct flash_bank_s *bank, int set, int first, int last)
\r
181 int ocl_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
\r
183 ocl_priv_t *ocl = bank->driver_priv;
\r
193 /* check preconditions */
\r
194 if (ocl->buflen == 0 || ocl->bufalign==0)
\r
195 return ERROR_FLASH_BANK_NOT_PROBED;
\r
197 if (bank->target->state != TARGET_RUNNING)
\r
199 LOG_ERROR("target has to be running to communicate with the loader");
\r
200 return ERROR_TARGET_NOT_RUNNING;
\r
203 /* allocate buffer for max. ocl buffer + overhead */
\r
204 dcc_buffer = malloc(sizeof(u32)*(ocl->buflen/4+3));
\r
208 if (count + (offset % ocl->bufalign) > ocl->buflen)
\r
209 runlen = ocl->buflen - (offset % ocl->bufalign);
\r
213 dcc_buffer[0] = OCL_FLASH_BLOCK | runlen;
\r
214 dcc_buffer[1] = offset;
\r
215 dcc_bufptr = &dcc_buffer[2];
\r
217 *dcc_bufptr = 0xffffffff;
\r
218 byteofs = (offset % ocl->bufalign) % 4;
\r
219 chksum = OCL_CHKS_INIT;
\r
221 /* copy data to DCC buffer in proper byte order and properly aligned */
\r
222 for (i=0; i<runlen; i++)
\r
227 *dcc_bufptr &= *(buffer++) | 0xffffff00;
\r
230 *dcc_bufptr &= ((*(buffer++))<<8) | 0xffff00ff;
\r
233 *dcc_bufptr &= ((*(buffer++))<<16) | 0xff00ffff;
\r
236 *dcc_bufptr &= ((*(buffer++))<<24) | 0x00ffffff;
\r
237 chksum ^= *(dcc_bufptr++);
\r
238 *dcc_bufptr = 0xffffffff;
\r
244 /* add the remaining word to checksum */
\r
246 chksum ^= *(dcc_bufptr++);
\r
248 *(dcc_bufptr++) = chksum;
\r
250 /* send the data */
\r
251 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, dcc_bufptr-dcc_buffer)) != ERROR_OK)
\r
257 /* wait for response, fixed timeout of 1 s */
\r
258 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000) != ERROR_OK))
\r
260 if (retval == ERROR_TARGET_TIMEOUT)
\r
261 LOG_ERROR("loader not responding");
\r
266 /* receive response */
\r
267 if ((retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
273 if (dcc_buffer[0] != OCL_CMD_DONE)
\r
275 LOG_ERROR("loader response to OCL_FLASH_BLOCK 0x%08lX", dcc_buffer[0]);
\r
277 return ERROR_FLASH_OPERATION_FAILED;
\r
289 int ocl_probe(struct flash_bank_s *bank)
\r
291 ocl_priv_t *ocl = bank->driver_priv;
\r
297 /* purge pending data in DCC */
\r
298 embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
\r
300 dcc_buffer[0] = OCL_PROBE;
\r
301 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
304 /* wait for response, fixed timeout of 1 s */
\r
305 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000) != ERROR_OK))
\r
307 if (retval == ERROR_TARGET_TIMEOUT)
\r
308 LOG_ERROR("loader not responding");
\r
312 /* receive response */
\r
313 if ((retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
316 if (dcc_buffer[0] != OCL_CMD_DONE)
\r
318 LOG_ERROR("loader response to OCL_PROBE 0x%08lX", dcc_buffer[0]);
\r
319 return ERROR_FLASH_OPERATION_FAILED;
\r
322 /* receive and fill in parameters, detection of loader is important, receive it one by one */
\r
323 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
\r
324 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
326 bank->base = dcc_buffer[0];
\r
328 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
\r
329 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
331 bank->size = dcc_buffer[0];
\r
333 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
\r
334 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
336 bank->num_sectors = dcc_buffer[0];
\r
338 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
\r
339 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
\r
341 ocl->buflen = dcc_buffer[0] & 0xffff;
\r
342 ocl->bufalign = dcc_buffer[0] >> 16;
\r
344 bank->sectors = realloc(bank->sectors, sizeof(flash_sector_t)*bank->num_sectors);
\r
345 if (bank->num_sectors == 0)
\r
347 LOG_ERROR("number of sectors shall be non zero value");
\r
348 return ERROR_FLASH_BANK_INVALID;
\r
350 if (bank->size % bank->num_sectors) {
\r
351 LOG_ERROR("bank size not divisible by number of sectors");
\r
352 return ERROR_FLASH_BANK_INVALID;
\r
354 sectsize = bank->size / bank->num_sectors;
\r
355 for (i=0; i<bank->num_sectors; i++)
\r
357 bank->sectors[i].offset = i * sectsize;
\r
358 bank->sectors[i].size = sectsize;
\r
359 bank->sectors[i].is_erased = -1;
\r
360 bank->sectors[i].is_protected = -1;
\r
363 if (ocl->bufalign == 0)
\r
366 if (ocl->buflen == 0)
\r
368 LOG_ERROR("buflen shall be non zero value");
\r
369 return ERROR_FLASH_BANK_INVALID;
\r
372 if ((ocl->bufalign > ocl->buflen) || (ocl->buflen % ocl->bufalign))
\r
374 LOG_ERROR("buflen is not multiple of bufalign");
\r
375 return ERROR_FLASH_BANK_INVALID;
\r
378 if (ocl->buflen % 4)
\r
380 LOG_ERROR("buflen shall be divisible by 4");
\r
381 return ERROR_FLASH_BANK_INVALID;
\r
388 int ocl_info(struct flash_bank_s *bank, char *buf, int buf_size)
\r
394 int ocl_auto_probe(struct flash_bank_s *bank)
\r
396 ocl_priv_t *ocl = bank->driver_priv;
\r
398 if (ocl->buflen == 0 || ocl->bufalign==0)
\r
399 return ERROR_FLASH_BANK_NOT_PROBED;
\r