src/flash/nor/ocl.c

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Pavel Chromy                                    *
   3  *   chromy@asix.cz                                                        *
   4  *                                                                         *
   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.                                   *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  17  ***************************************************************************/
  18
  19 #ifdef HAVE_CONFIG_H
  20 #include "config.h"
  21 #endif
  22
  23 #include "imp.h"
  24 #include "ocl.h"
  25 #include <target/embeddedice.h>
  26
  27 struct ocl_priv {
  28         struct arm_jtag *jtag_info;
  29         unsigned int buflen;
  30         unsigned int bufalign;
  31 };
  32
  33 /* flash_bank ocl 0 0 0 0 <target#> */
  34 FLASH_BANK_COMMAND_HANDLER(ocl_flash_bank_command)
  35 {
  36         struct arm7_9_common *arm7_9;
  37         struct ocl_priv *ocl;
  38
  39         if (CMD_ARGC < 6)
  40                 return ERROR_COMMAND_SYNTAX_ERROR;
  41
  42         arm7_9 = target_to_arm7_9(bank->target);
  43         if (!is_arm7_9(arm7_9))
  44                 return ERROR_TARGET_INVALID;
  45
  46         ocl = bank->driver_priv = malloc(sizeof(struct ocl_priv));
  47         ocl->jtag_info = &arm7_9->jtag_info;
  48         ocl->buflen = 0;
  49         ocl->bufalign = 1;
  50
  51         return ERROR_OK;
  52 }
  53
  54 static int ocl_erase(struct flash_bank *bank, unsigned int first,
  55                 unsigned int last)
  56 {
  57         struct ocl_priv *ocl = bank->driver_priv;
  58         int retval;
  59         uint32_t dcc_buffer[3];
  60
  61         /* check preconditions */
  62         if (bank->num_sectors == 0)
  63                 return ERROR_FLASH_BANK_NOT_PROBED;
  64
  65         if (bank->target->state != TARGET_RUNNING) {
  66                 LOG_ERROR("target has to be running to communicate with the loader");
  67                 return ERROR_TARGET_NOT_RUNNING;
  68         }
  69
  70         if ((first == 0) && (last == bank->num_sectors - 1)) {
  71                 dcc_buffer[0] = OCL_ERASE_ALL;
  72                 retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 1);
  73                 if (retval != ERROR_OK)
  74                         return retval;
  75         } else {
  76                 dcc_buffer[0] = OCL_ERASE_BLOCK;
  77                 dcc_buffer[1] = first;
  78                 dcc_buffer[2] = last;
  79                 retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 3);
  80                 if (retval != ERROR_OK)
  81                         return retval;
  82         }
  83
  84         /* wait for response, fixed timeout of 1 s */
  85         retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000);
  86         if (retval != ERROR_OK)
  87                 return retval;
  88
  89         /* receive response */
  90         retval = embeddedice_receive(ocl->jtag_info, dcc_buffer + 1, 1);
  91         if (retval != ERROR_OK)
  92                 return retval;
  93
  94         if (dcc_buffer[1] != OCL_CMD_DONE) {
  95                 if (dcc_buffer[0] == OCL_ERASE_ALL)
  96                         LOG_ERROR("loader response to OCL_ERASE_ALL 0x%08" PRIx32 "", dcc_buffer[1]);
  97                 else
  98                         LOG_ERROR("loader response to OCL_ERASE_BLOCK 0x%08" PRIx32 "", dcc_buffer[1]);
  99                 return ERROR_FLASH_OPERATION_FAILED;
 100         }
 101
 102         return ERROR_OK;
 103 }
 104
 105 static int ocl_write(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
 106 {
 107         struct ocl_priv *ocl = bank->driver_priv;
 108         int retval;
 109         uint32_t *dcc_buffer;
 110         uint32_t *dcc_bufptr;
 111         int byteofs;
 112         int runlen;
 113         uint32_t chksum;
 114
 115         int i;
 116
 117         /* check preconditions */
 118         if (ocl->buflen == 0 || ocl->bufalign == 0)
 119                 return ERROR_FLASH_BANK_NOT_PROBED;
 120
 121         if (bank->target->state != TARGET_RUNNING) {
 122                 LOG_ERROR("target has to be running to communicate with the loader");
 123                 return ERROR_TARGET_NOT_RUNNING;
 124         }
 125
 126         /* allocate buffer for max. ocl buffer + overhead */
 127         dcc_buffer = malloc(sizeof(uint32_t)*(ocl->buflen/4 + 3));
 128
 129         while (count) {
 130                 if (count + (offset % ocl->bufalign) > ocl->buflen)
 131                         runlen = ocl->buflen - (offset % ocl->bufalign);
 132                 else
 133                         runlen = count;
 134
 135                 dcc_buffer[0] = OCL_FLASH_BLOCK | runlen;
 136                 dcc_buffer[1] = offset;
 137                 dcc_bufptr = &dcc_buffer[2];
 138
 139                 *dcc_bufptr = 0xffffffff;
 140                 byteofs = (offset % ocl->bufalign) % 4;
 141                 chksum = OCL_CHKS_INIT;
 142
 143                 /* copy data to DCC buffer in proper byte order and properly aligned */
 144                 for (i = 0; i < runlen; i++) {
 145                         switch (byteofs++) {
 146                                 case 0:
 147                                         *dcc_bufptr &= *(buffer++) | 0xffffff00;
 148                                         break;
 149                                 case 1:
 150                                         *dcc_bufptr &= ((*(buffer++)) << 8) | 0xffff00ff;
 151                                         break;
 152                                 case 2:
 153                                         *dcc_bufptr &= ((*(buffer++)) << 16) | 0xff00ffff;
 154                                         break;
 155                                 case 3:
 156                                         *dcc_bufptr &= ((*(buffer++)) << 24) | 0x00ffffff;
 157                                         chksum ^= *(dcc_bufptr++);
 158                                         *dcc_bufptr = 0xffffffff;
 159                                         byteofs = 0;
 160                                         break;
 161                         }
 162                 }
 163
 164                 /* add the remaining word to checksum */
 165                 if (byteofs)
 166                         chksum ^= *(dcc_bufptr++);
 167
 168                 *(dcc_bufptr++) = chksum;
 169
 170                 /* send the data */
 171                 retval = embeddedice_send(ocl->jtag_info, dcc_buffer, dcc_bufptr-dcc_buffer);
 172                 if (retval != ERROR_OK) {
 173                         free(dcc_buffer);
 174                   return retval;
 175                 }
 176
 177                 /* wait for response, fixed timeout of 1 s */
 178                 retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000);
 179                 if (retval != ERROR_OK) {
 180                         free(dcc_buffer);
 181                         return retval;
 182                 }
 183
 184                 /* receive response */
 185                 retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 186                 if (retval != ERROR_OK) {
 187                         free(dcc_buffer);
 188                         return retval;
 189                 }
 190
 191                 if (dcc_buffer[0] != OCL_CMD_DONE) {
 192                         LOG_ERROR("loader response to OCL_FLASH_BLOCK 0x%08" PRIx32 "", dcc_buffer[0]);
 193                         free(dcc_buffer);
 194                         return ERROR_FLASH_OPERATION_FAILED;
 195                 }
 196
 197                 count -= runlen;
 198                 offset += runlen;
 199         }
 200
 201         free(dcc_buffer);
 202         return ERROR_OK;
 203 }
 204
 205 static int ocl_probe(struct flash_bank *bank)
 206 {
 207         struct ocl_priv *ocl = bank->driver_priv;
 208         int retval;
 209         uint32_t dcc_buffer[1];
 210         int sectsize;
 211
 212         /* purge pending data in DCC */
 213         embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 214
 215         dcc_buffer[0] = OCL_PROBE;
 216         retval = embeddedice_send(ocl->jtag_info, dcc_buffer, 1);
 217         if (retval != ERROR_OK)
 218                 return retval;
 219
 220         /* wait for response, fixed timeout of 1 s */
 221         retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 1000);
 222         if (retval != ERROR_OK)
 223                 return retval;
 224
 225         /* receive response */
 226         retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 227         if (retval != ERROR_OK)
 228                 return retval;
 229
 230         if (dcc_buffer[0] != OCL_CMD_DONE) {
 231                 LOG_ERROR("loader response to OCL_PROBE 0x%08" PRIx32 "", dcc_buffer[0]);
 232                 return ERROR_FLASH_OPERATION_FAILED;
 233         }
 234
 235         /* receive and fill in parameters, detection of loader is important, receive it one by one */
 236         retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0);
 237         if (retval != ERROR_OK)
 238                 return retval;
 239         retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 240         if (retval != ERROR_OK)
 241                 return retval;
 242         bank->base = dcc_buffer[0];
 243
 244         retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0);
 245         if (retval != ERROR_OK)
 246                 return retval;
 247         retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 248         if (retval != ERROR_OK)
 249                 return retval;
 250         bank->size = dcc_buffer[0];
 251
 252         retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0);
 253         if (retval != ERROR_OK)
 254                 return retval;
 255         retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 256         if (retval != ERROR_OK)
 257                 return retval;
 258         bank->num_sectors = dcc_buffer[0];
 259
 260         retval = embeddedice_handshake(ocl->jtag_info, EICE_COMM_CTRL_WBIT, 0);
 261         if (retval != ERROR_OK)
 262                 return retval;
 263         retval = embeddedice_receive(ocl->jtag_info, dcc_buffer, 1);
 264         if (retval != ERROR_OK)
 265                 return retval;
 266         ocl->buflen = dcc_buffer[0] & 0xffff;
 267         ocl->bufalign = dcc_buffer[0] >> 16;
 268
 269         bank->sectors = realloc(bank->sectors, sizeof(struct flash_sector)*bank->num_sectors);
 270         if (bank->num_sectors == 0) {
 271                 LOG_ERROR("number of sectors shall be non zero value");
 272                 return ERROR_FLASH_BANK_INVALID;
 273         }
 274         if (bank->size % bank->num_sectors) {
 275                 LOG_ERROR("bank size not divisible by number of sectors");
 276                 return ERROR_FLASH_BANK_INVALID;
 277         }
 278         sectsize = bank->size / bank->num_sectors;
 279         for (unsigned int i = 0; i < bank->num_sectors; i++) {
 280                 bank->sectors[i].offset = i * sectsize;
 281                 bank->sectors[i].size = sectsize;
 282                 bank->sectors[i].is_erased = -1;
 283                 bank->sectors[i].is_protected = -1;
 284         }
 285
 286         if (ocl->bufalign == 0)
 287                 ocl->bufalign = 1;
 288
 289         if (ocl->buflen == 0) {
 290                 LOG_ERROR("buflen shall be non zero value");
 291                 return ERROR_FLASH_BANK_INVALID;
 292         }
 293
 294         if ((ocl->bufalign > ocl->buflen) || (ocl->buflen % ocl->bufalign)) {
 295                 LOG_ERROR("buflen is not multiple of bufalign");
 296                 return ERROR_FLASH_BANK_INVALID;
 297         }
 298
 299         if (ocl->buflen % 4) {
 300                 LOG_ERROR("buflen shall be divisible by 4");
 301                 return ERROR_FLASH_BANK_INVALID;
 302         }
 303
 304         return ERROR_OK;
 305 }
 306
 307 static int ocl_auto_probe(struct flash_bank *bank)
 308 {
 309         struct ocl_priv *ocl = bank->driver_priv;
 310
 311         if (ocl->buflen == 0 || ocl->bufalign == 0)
 312                 return ERROR_FLASH_BANK_NOT_PROBED;
 313
 314         return ERROR_OK;
 315 }
 316
 317 const struct flash_driver ocl_flash = {
 318         .name = "ocl",
 319         .flash_bank_command = ocl_flash_bank_command,
 320         .erase = ocl_erase,
 321         .write = ocl_write,
 322         .read = default_flash_read,
 323         .probe = ocl_probe,
 324         .erase_check = default_flash_blank_check,
 325         .auto_probe = ocl_auto_probe,
 326         .free_driver_priv = default_flash_free_driver_priv,
 327 };