1 /***************************************************************************
2 * Copyright (C) 2007 by Pavel Chromy *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
26 #include "embeddedice.h"
31 struct arm_jtag *jtag_info;
33 unsigned int bufalign;
36 static int ocl_erase_check(struct flash_bank *bank)
41 static int ocl_protect_check(struct flash_bank *bank)
46 /* flash_bank ocl 0 0 0 0 <target#> */
47 FLASH_BANK_COMMAND_HANDLER(ocl_flash_bank_command)
49 struct arm7_9_common *arm7_9;
54 LOG_WARNING("incomplete flash_bank ocl configuration");
55 return ERROR_FLASH_BANK_INVALID;
58 arm7_9 = target_to_arm7_9(bank->target);
59 if (!is_arm7_9(arm7_9))
60 return ERROR_TARGET_INVALID;
62 ocl = bank->driver_priv = malloc(sizeof(struct ocl_priv));
63 ocl->jtag_info = &arm7_9->jtag_info;
70 static int ocl_erase(struct flash_bank *bank, int first, int last)
72 struct ocl_priv *ocl = bank->driver_priv;
74 uint32_t dcc_buffer[3];
76 /* check preconditions */
77 if (bank->num_sectors == 0)
78 return ERROR_FLASH_BANK_NOT_PROBED;
80 if (bank->target->state != TARGET_RUNNING)
82 LOG_ERROR("target has to be running to communicate with the loader");
83 return ERROR_TARGET_NOT_RUNNING;
86 if ((first == 0) && (last == bank->num_sectors - 1))
88 dcc_buffer[0] = OCL_ERASE_ALL;
89 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
94 dcc_buffer[0] = OCL_ERASE_BLOCK;
95 dcc_buffer[1] = first;
97 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 3) != ERROR_OK))
101 /* wait for response, fixed timeout of 1 s */
102 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000) != ERROR_OK))
104 if (retval == ERROR_TARGET_TIMEOUT)
105 LOG_ERROR("loader not responding");
109 /* receive response */
110 if ((retval = embeddedice_receive(ocl->jtag_info, dcc_buffer + 1, 1) != ERROR_OK))
113 if (dcc_buffer[1] != OCL_CMD_DONE)
115 if (dcc_buffer[0] == OCL_ERASE_ALL)
116 LOG_ERROR("loader response to OCL_ERASE_ALL 0x%08" PRIx32 "", dcc_buffer[1]);
118 LOG_ERROR("loader response to OCL_ERASE_BLOCK 0x%08" PRIx32 "", dcc_buffer[1]);
119 return ERROR_FLASH_OPERATION_FAILED;
125 static int ocl_protect(struct flash_bank *bank, int set, int first, int last)
130 static int ocl_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
132 struct ocl_priv *ocl = bank->driver_priv;
134 uint32_t *dcc_buffer;
135 uint32_t *dcc_bufptr;
142 /* check preconditions */
143 if (ocl->buflen == 0 || ocl->bufalign == 0)
144 return ERROR_FLASH_BANK_NOT_PROBED;
146 if (bank->target->state != TARGET_RUNNING)
148 LOG_ERROR("target has to be running to communicate with the loader");
149 return ERROR_TARGET_NOT_RUNNING;
152 /* allocate buffer for max. ocl buffer + overhead */
153 dcc_buffer = malloc(sizeof(uint32_t)*(ocl->buflen/4 + 3));
157 if (count + (offset % ocl->bufalign) > ocl->buflen)
158 runlen = ocl->buflen - (offset % ocl->bufalign);
162 dcc_buffer[0] = OCL_FLASH_BLOCK | runlen;
163 dcc_buffer[1] = offset;
164 dcc_bufptr = &dcc_buffer[2];
166 *dcc_bufptr = 0xffffffff;
167 byteofs = (offset % ocl->bufalign) % 4;
168 chksum = OCL_CHKS_INIT;
170 /* copy data to DCC buffer in proper byte order and properly aligned */
171 for (i = 0; i < runlen; i++)
176 *dcc_bufptr &= *(buffer++) | 0xffffff00;
179 *dcc_bufptr &= ((*(buffer++)) << 8) | 0xffff00ff;
182 *dcc_bufptr &= ((*(buffer++)) << 16) | 0xff00ffff;
185 *dcc_bufptr &= ((*(buffer++)) << 24) | 0x00ffffff;
186 chksum ^= *(dcc_bufptr++);
187 *dcc_bufptr = 0xffffffff;
193 /* add the remaining word to checksum */
195 chksum ^= *(dcc_bufptr++);
197 *(dcc_bufptr++) = chksum;
200 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, dcc_bufptr-dcc_buffer)) != ERROR_OK)
206 /* wait for response, fixed timeout of 1 s */
207 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000) != ERROR_OK))
209 if (retval == ERROR_TARGET_TIMEOUT)
210 LOG_ERROR("loader not responding");
215 /* receive response */
216 if ((retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
222 if (dcc_buffer[0] != OCL_CMD_DONE)
224 LOG_ERROR("loader response to OCL_FLASH_BLOCK 0x%08" PRIx32 "", dcc_buffer[0]);
226 return ERROR_FLASH_OPERATION_FAILED;
237 static int ocl_probe(struct flash_bank *bank)
239 struct ocl_priv *ocl = bank->driver_priv;
241 uint32_t dcc_buffer[1];
245 /* purge pending data in DCC */
246 embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
248 dcc_buffer[0] = OCL_PROBE;
249 if ((retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
252 /* wait for response, fixed timeout of 1 s */
253 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000) != ERROR_OK))
255 if (retval == ERROR_TARGET_TIMEOUT)
256 LOG_ERROR("loader not responding");
260 /* receive response */
261 if ((retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
264 if (dcc_buffer[0] != OCL_CMD_DONE)
266 LOG_ERROR("loader response to OCL_PROBE 0x%08" PRIx32 "", dcc_buffer[0]);
267 return ERROR_FLASH_OPERATION_FAILED;
270 /* receive and fill in parameters, detection of loader is important, receive it one by one */
271 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
272 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
274 bank->base = dcc_buffer[0];
276 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
277 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
279 bank->size = dcc_buffer[0];
281 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
282 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
284 bank->num_sectors = dcc_buffer[0];
286 if ((retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0) != ERROR_OK)
287 || (retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1) != ERROR_OK))
289 ocl->buflen = dcc_buffer[0] & 0xffff;
290 ocl->bufalign = dcc_buffer[0] >> 16;
292 bank->sectors = realloc(bank->sectors, sizeof(struct flash_sector)*bank->num_sectors);
293 if (bank->num_sectors == 0)
295 LOG_ERROR("number of sectors shall be non zero value");
296 return ERROR_FLASH_BANK_INVALID;
298 if (bank->size % bank->num_sectors) {
299 LOG_ERROR("bank size not divisible by number of sectors");
300 return ERROR_FLASH_BANK_INVALID;
302 sectsize = bank->size / bank->num_sectors;
303 for (i = 0; i < bank->num_sectors; i++)
305 bank->sectors[i].offset = i * sectsize;
306 bank->sectors[i].size = sectsize;
307 bank->sectors[i].is_erased = -1;
308 bank->sectors[i].is_protected = -1;
311 if (ocl->bufalign == 0)
314 if (ocl->buflen == 0)
316 LOG_ERROR("buflen shall be non zero value");
317 return ERROR_FLASH_BANK_INVALID;
320 if ((ocl->bufalign > ocl->buflen) || (ocl->buflen % ocl->bufalign))
322 LOG_ERROR("buflen is not multiple of bufalign");
323 return ERROR_FLASH_BANK_INVALID;
328 LOG_ERROR("buflen shall be divisible by 4");
329 return ERROR_FLASH_BANK_INVALID;
335 static int ocl_info(struct flash_bank *bank, char *buf, int buf_size)
340 static int ocl_auto_probe(struct flash_bank *bank)
342 struct ocl_priv *ocl = bank->driver_priv;
344 if (ocl->buflen == 0 || ocl->bufalign == 0)
345 return ERROR_FLASH_BANK_NOT_PROBED;
350 struct flash_driver ocl_flash = {
352 .flash_bank_command = &ocl_flash_bank_command,
354 .protect = &ocl_protect,
357 .erase_check = &ocl_erase_check,
358 .protect_check = &ocl_protect_check,
360 .auto_probe = &ocl_auto_probe,