common/cmd_fpga.c

   1 /*
   2  * (C) Copyright 2000, 2001
   3  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  *
  23  */
  24
  25 /*
  26  *  FPGA support
  27  */
  28 #include <common.h>
  29 #include <command.h>
  30 #if defined(CONFIG_CMD_NET)
  31 #include <net.h>
  32 #endif
  33 #include <fpga.h>
  34 #include <malloc.h>
  35
  36 #if 0
  37 #define FPGA_DEBUG
  38 #endif
  39
  40 #ifdef  FPGA_DEBUG
  41 #define PRINTF(fmt,args...)     printf (fmt ,##args)
  42 #else
  43 #define PRINTF(fmt,args...)
  44 #endif
  45
  46 /* Local functions */
  47 static int fpga_get_op (char *opstr);
  48
  49 /* Local defines */
  50 #define FPGA_NONE   -1
  51 #define FPGA_INFO   0
  52 #define FPGA_LOAD   1
  53 #define FPGA_LOADB  2
  54 #define FPGA_DUMP   3
  55 #define FPGA_LOADMK 4
  56
  57 /* Convert bitstream data and load into the fpga */
  58 int fpga_loadbitstream(unsigned long dev, char* fpgadata, size_t size)
  59 {
  60 #if defined(CONFIG_FPGA_XILINX)
  61         unsigned int length;
  62         unsigned int swapsize;
  63         char buffer[80];
  64         unsigned char *dataptr;
  65         unsigned int i;
  66         int rc;
  67
  68         dataptr = (unsigned char *)fpgadata;
  69
  70         /* skip the first bytes of the bitsteam, their meaning is unknown */
  71         length = (*dataptr << 8) + *(dataptr+1);
  72         dataptr+=2;
  73         dataptr+=length;
  74
  75         /* get design name (identifier, length, string) */
  76         length = (*dataptr << 8) + *(dataptr+1);
  77         dataptr+=2;
  78         if (*dataptr++ != 0x61) {
  79                 PRINTF ("%s: Design name identifier not recognized in bitstream\n",
  80                         __FUNCTION__ );
  81                 return FPGA_FAIL;
  82         }
  83
  84         length = (*dataptr << 8) + *(dataptr+1);
  85         dataptr+=2;
  86         for(i=0;i<length;i++)
  87                 buffer[i] = *dataptr++;
  88
  89         printf("  design filename = \"%s\"\n", buffer);
  90
  91         /* get part number (identifier, length, string) */
  92         if (*dataptr++ != 0x62) {
  93                 printf("%s: Part number identifier not recognized in bitstream\n",
  94                         __FUNCTION__ );
  95                 return FPGA_FAIL;
  96         }
  97
  98         length = (*dataptr << 8) + *(dataptr+1);
  99         dataptr+=2;
 100         for(i=0;i<length;i++)
 101                 buffer[i] = *dataptr++;
 102         printf("  part number = \"%s\"\n", buffer);
 103
 104         /* get date (identifier, length, string) */
 105         if (*dataptr++ != 0x63) {
 106                 printf("%s: Date identifier not recognized in bitstream\n",
 107                        __FUNCTION__);
 108                 return FPGA_FAIL;
 109         }
 110
 111         length = (*dataptr << 8) + *(dataptr+1);
 112         dataptr+=2;
 113         for(i=0;i<length;i++)
 114                 buffer[i] = *dataptr++;
 115         printf("  date = \"%s\"\n", buffer);
 116
 117         /* get time (identifier, length, string) */
 118         if (*dataptr++ != 0x64) {
 119                 printf("%s: Time identifier not recognized in bitstream\n",__FUNCTION__);
 120                 return FPGA_FAIL;
 121         }
 122
 123         length = (*dataptr << 8) + *(dataptr+1);
 124         dataptr+=2;
 125         for(i=0;i<length;i++)
 126                 buffer[i] = *dataptr++;
 127         printf("  time = \"%s\"\n", buffer);
 128
 129         /* get fpga data length (identifier, length) */
 130         if (*dataptr++ != 0x65) {
 131                 printf("%s: Data length identifier not recognized in bitstream\n",
 132                         __FUNCTION__);
 133                 return FPGA_FAIL;
 134         }
 135         swapsize = ((unsigned int) *dataptr     <<24) +
 136                    ((unsigned int) *(dataptr+1) <<16) +
 137                    ((unsigned int) *(dataptr+2) <<8 ) +
 138                    ((unsigned int) *(dataptr+3)     ) ;
 139         dataptr+=4;
 140         printf("  bytes in bitstream = %d\n", swapsize);
 141
 142         rc = fpga_load(dev, dataptr, swapsize);
 143         return rc;
 144 #else
 145         printf("Bitstream support only for Xilinx devices\n");
 146         return FPGA_FAIL;
 147 #endif
 148 }
 149
 150 /* ------------------------------------------------------------------------- */
 151 /* command form:
 152  *   fpga <op> <device number> <data addr> <datasize>
 153  * where op is 'load', 'dump', or 'info'
 154  * If there is no device number field, the fpga environment variable is used.
 155  * If there is no data addr field, the fpgadata environment variable is used.
 156  * The info command requires no data address field.
 157  */
 158 int do_fpga (cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
 159 {
 160         int op, dev = FPGA_INVALID_DEVICE;
 161         size_t data_size = 0;
 162         void *fpga_data = NULL;
 163         char *devstr = getenv ("fpga");
 164         char *datastr = getenv ("fpgadata");
 165         int rc = FPGA_FAIL;
 166         int wrong_parms = 0;
 167 #if defined (CONFIG_FIT)
 168         const char *fit_uname = NULL;
 169         ulong fit_addr;
 170 #endif
 171
 172         if (devstr)
 173                 dev = (int) simple_strtoul (devstr, NULL, 16);
 174         if (datastr)
 175                 fpga_data = (void *) simple_strtoul (datastr, NULL, 16);
 176
 177         switch (argc) {
 178         case 5:         /* fpga <op> <dev> <data> <datasize> */
 179                 data_size = simple_strtoul (argv[4], NULL, 16);
 180
 181         case 4:         /* fpga <op> <dev> <data> */
 182 #if defined(CONFIG_FIT)
 183                 if (fit_parse_subimage (argv[3], (ulong)fpga_data,
 184                                         &fit_addr, &fit_uname)) {
 185                         fpga_data = (void *)fit_addr;
 186                         debug ("*  fpga: subimage '%s' from FIT image at 0x%08lx\n",
 187                                         fit_uname, fit_addr);
 188                 } else
 189 #endif
 190                 {
 191                         fpga_data = (void *) simple_strtoul (argv[3], NULL, 16);
 192                         debug ("*  fpga: cmdline image address = 0x%08lx\n", (ulong)fpga_data);
 193                 }
 194                 PRINTF ("%s: fpga_data = 0x%x\n", __FUNCTION__, (uint) fpga_data);
 195
 196         case 3:         /* fpga <op> <dev | data addr> */
 197                 dev = (int) simple_strtoul (argv[2], NULL, 16);
 198                 PRINTF ("%s: device = %d\n", __FUNCTION__, dev);
 199                 /* FIXME - this is a really weak test */
 200                 if ((argc == 3) && (dev > fpga_count ())) {     /* must be buffer ptr */
 201                         PRINTF ("%s: Assuming buffer pointer in arg 3\n",
 202                                 __FUNCTION__);
 203
 204 #if defined(CONFIG_FIT)
 205                         if (fit_parse_subimage (argv[2], (ulong)fpga_data,
 206                                                 &fit_addr, &fit_uname)) {
 207                                 fpga_data = (void *)fit_addr;
 208                                 debug ("*  fpga: subimage '%s' from FIT image at 0x%08lx\n",
 209                                                 fit_uname, fit_addr);
 210                         } else
 211 #endif
 212                         {
 213                                 fpga_data = (void *) dev;
 214                                 debug ("*  fpga: cmdline image address = 0x%08lx\n", (ulong)fpga_data);
 215                         }
 216
 217                         PRINTF ("%s: fpga_data = 0x%x\n",
 218                                 __FUNCTION__, (uint) fpga_data);
 219                         dev = FPGA_INVALID_DEVICE;      /* reset device num */
 220                 }
 221
 222         case 2:         /* fpga <op> */
 223                 op = (int) fpga_get_op (argv[1]);
 224                 break;
 225
 226         default:
 227                 PRINTF ("%s: Too many or too few args (%d)\n",
 228                         __FUNCTION__, argc);
 229                 op = FPGA_NONE; /* force usage display */
 230                 break;
 231         }
 232
 233         if (dev == FPGA_INVALID_DEVICE) {
 234                 puts("FPGA device not specified\n");
 235                 op = FPGA_NONE;
 236         }
 237
 238         switch (op) {
 239         case FPGA_NONE:
 240         case FPGA_INFO:
 241                 break;
 242         case FPGA_LOAD:
 243         case FPGA_LOADB:
 244         case FPGA_DUMP:
 245                 if (!fpga_data || !data_size)
 246                         wrong_parms = 1;
 247                 break;
 248         case FPGA_LOADMK:
 249                 if (!fpga_data)
 250                         wrong_parms = 1;
 251                 break;
 252         }
 253
 254         if (wrong_parms) {
 255                 puts("Wrong parameters for FPGA request\n");
 256                 op = FPGA_NONE;
 257         }
 258
 259         switch (op) {
 260         case FPGA_NONE:
 261                 return cmd_usage(cmdtp);
 262
 263         case FPGA_INFO:
 264                 rc = fpga_info (dev);
 265                 break;
 266
 267         case FPGA_LOAD:
 268                 rc = fpga_load (dev, fpga_data, data_size);
 269                 break;
 270
 271         case FPGA_LOADB:
 272                 rc = fpga_loadbitstream(dev, fpga_data, data_size);
 273                 break;
 274
 275         case FPGA_LOADMK:
 276                 switch (genimg_get_format (fpga_data)) {
 277                 case IMAGE_FORMAT_LEGACY:
 278                         {
 279                                 image_header_t *hdr = (image_header_t *)fpga_data;
 280                                 ulong   data;
 281
 282                                 data = (ulong)image_get_data (hdr);
 283                                 data_size = image_get_data_size (hdr);
 284                                 rc = fpga_load (dev, (void *)data, data_size);
 285                         }
 286                         break;
 287 #if defined(CONFIG_FIT)
 288                 case IMAGE_FORMAT_FIT:
 289                         {
 290                                 const void *fit_hdr = (const void *)fpga_data;
 291                                 int noffset;
 292                                 const void *fit_data;
 293
 294                                 if (fit_uname == NULL) {
 295                                         puts ("No FIT subimage unit name\n");
 296                                         return 1;
 297                                 }
 298
 299                                 if (!fit_check_format (fit_hdr)) {
 300                                         puts ("Bad FIT image format\n");
 301                                         return 1;
 302                                 }
 303
 304                                 /* get fpga component image node offset */
 305                                 noffset = fit_image_get_node (fit_hdr, fit_uname);
 306                                 if (noffset < 0) {
 307                                         printf ("Can't find '%s' FIT subimage\n", fit_uname);
 308                                         return 1;
 309                                 }
 310
 311                                 /* verify integrity */
 312                                 if (!fit_image_check_hashes (fit_hdr, noffset)) {
 313                                         puts ("Bad Data Hash\n");
 314                                         return 1;
 315                                 }
 316
 317                                 /* get fpga subimage data address and length */
 318                                 if (fit_image_get_data (fit_hdr, noffset, &fit_data, &data_size)) {
 319                                         puts ("Could not find fpga subimage data\n");
 320                                         return 1;
 321                                 }
 322
 323                                 rc = fpga_load (dev, fit_data, data_size);
 324                         }
 325                         break;
 326 #endif
 327                 default:
 328                         puts ("** Unknown image type\n");
 329                         rc = FPGA_FAIL;
 330                         break;
 331                 }
 332                 break;
 333
 334         case FPGA_DUMP:
 335                 rc = fpga_dump (dev, fpga_data, data_size);
 336                 break;
 337
 338         default:
 339                 printf ("Unknown operation\n");
 340                 return cmd_usage(cmdtp);
 341         }
 342         return (rc);
 343 }
 344
 345 /*
 346  * Map op to supported operations.  We don't use a table since we
 347  * would just have to relocate it from flash anyway.
 348  */
 349 static int fpga_get_op (char *opstr)
 350 {
 351         int op = FPGA_NONE;
 352
 353         if (!strcmp ("info", opstr)) {
 354                 op = FPGA_INFO;
 355         } else if (!strcmp ("loadb", opstr)) {
 356                 op = FPGA_LOADB;
 357         } else if (!strcmp ("load", opstr)) {
 358                 op = FPGA_LOAD;
 359         } else if (!strcmp ("loadmk", opstr)) {
 360                 op = FPGA_LOADMK;
 361         } else if (!strcmp ("dump", opstr)) {
 362                 op = FPGA_DUMP;
 363         }
 364
 365         if (op == FPGA_NONE) {
 366                 printf ("Unknown fpga operation \"%s\"\n", opstr);
 367         }
 368         return op;
 369 }
 370
 371 U_BOOT_CMD (fpga, 6, 1, do_fpga,
 372         "loadable FPGA image support",
 373         "[operation type] [device number] [image address] [image size]\n"
 374         "fpga operations:\n"
 375         "  dump\t[dev]\t\t\tLoad device to memory buffer\n"
 376         "  info\t[dev]\t\t\tlist known device information\n"
 377         "  load\t[dev] [address] [size]\tLoad device from memory buffer\n"
 378         "  loadb\t[dev] [address] [size]\t"
 379         "Load device from bitstream buffer (Xilinx only)\n"
 380         "  loadmk [dev] [address]\tLoad device generated with mkimage"
 381 #if defined(CONFIG_FIT)
 382         "\n"
 383         "\tFor loadmk operating on FIT format uImage address must include\n"
 384         "\tsubimage unit name in the form of addr:<subimg_uname>"
 385 #endif
 386 );