drivers/fpga/fpga.c

   1 /*
   2  * (C) Copyright 2002
   3  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 /* Generic FPGA support */
   9 #include <common.h>             /* core U-Boot definitions */
  10 #include <xilinx.h>             /* xilinx specific definitions */
  11 #include <altera.h>             /* altera specific definitions */
  12 #include <lattice.h>
  13
  14 /* Local definitions */
  15 #ifndef CONFIG_MAX_FPGA_DEVICES
  16 #define CONFIG_MAX_FPGA_DEVICES         5
  17 #endif
  18
  19 /* Local static data */
  20 static int next_desc = FPGA_INVALID_DEVICE;
  21 static fpga_desc desc_table[CONFIG_MAX_FPGA_DEVICES];
  22
  23 /*
  24  * fpga_no_sup
  25  * 'no support' message function
  26  */
  27 static void fpga_no_sup(char *fn, char *msg)
  28 {
  29         if (fn && msg)
  30                 printf("%s: No support for %s.\n", fn, msg);
  31         else if (msg)
  32                 printf("No support for %s.\n", msg);
  33         else
  34                 printf("No FPGA support!\n");
  35 }
  36
  37
  38 /* fpga_get_desc
  39  *      map a device number to a descriptor
  40  */
  41 const fpga_desc *const fpga_get_desc(int devnum)
  42 {
  43         fpga_desc *desc = (fpga_desc *)NULL;
  44
  45         if ((devnum >= 0) && (devnum < next_desc)) {
  46                 desc = &desc_table[devnum];
  47                 debug("%s: found fpga descriptor #%d @ 0x%p\n",
  48                       __func__, devnum, desc);
  49         }
  50
  51         return desc;
  52 }
  53
  54 /*
  55  * fpga_validate
  56  *      generic parameter checking code
  57  */
  58 const fpga_desc *const fpga_validate(int devnum, const void *buf,
  59                                      size_t bsize, char *fn)
  60 {
  61         const fpga_desc *desc = fpga_get_desc(devnum);
  62
  63         if (!desc)
  64                 printf("%s: Invalid device number %d\n", fn, devnum);
  65
  66         if (!buf) {
  67                 printf("%s: Null buffer.\n", fn);
  68                 return (fpga_desc * const)NULL;
  69         }
  70         return desc;
  71 }
  72
  73 /*
  74  * fpga_dev_info
  75  *      generic multiplexing code
  76  */
  77 static int fpga_dev_info(int devnum)
  78 {
  79         int ret_val = FPGA_FAIL; /* assume failure */
  80         const fpga_desc * const desc = fpga_get_desc(devnum);
  81
  82         if (desc) {
  83                 debug("%s: Device Descriptor @ 0x%p\n",
  84                       __func__, desc->devdesc);
  85
  86                 switch (desc->devtype) {
  87                 case fpga_xilinx:
  88 #if defined(CONFIG_FPGA_XILINX)
  89                         printf("Xilinx Device\nDescriptor @ 0x%p\n", desc);
  90                         ret_val = xilinx_info(desc->devdesc);
  91 #else
  92                         fpga_no_sup((char *)__func__, "Xilinx devices");
  93 #endif
  94                         break;
  95                 case fpga_altera:
  96 #if defined(CONFIG_FPGA_ALTERA)
  97                         printf("Altera Device\nDescriptor @ 0x%p\n", desc);
  98                         ret_val = altera_info(desc->devdesc);
  99 #else
 100                         fpga_no_sup((char *)__func__, "Altera devices");
 101 #endif
 102                         break;
 103                 case fpga_lattice:
 104 #if defined(CONFIG_FPGA_LATTICE)
 105                         printf("Lattice Device\nDescriptor @ 0x%p\n", desc);
 106                         ret_val = lattice_info(desc->devdesc);
 107 #else
 108                         fpga_no_sup((char *)__func__, "Lattice devices");
 109 #endif
 110                         break;
 111                 default:
 112                         printf("%s: Invalid or unsupported device type %d\n",
 113                                __func__, desc->devtype);
 114                 }
 115         } else {
 116                 printf("%s: Invalid device number %d\n", __func__, devnum);
 117         }
 118
 119         return ret_val;
 120 }
 121
 122 /*
 123  * fpga_init is usually called from misc_init_r() and MUST be called
 124  * before any of the other fpga functions are used.
 125  */
 126 void fpga_init(void)
 127 {
 128         next_desc = 0;
 129         memset(desc_table, 0, sizeof(desc_table));
 130
 131         debug("%s\n", __func__);
 132 }
 133
 134 /*
 135  * fpga_count
 136  * Basic interface function to get the current number of devices available.
 137  */
 138 int fpga_count(void)
 139 {
 140         return next_desc;
 141 }
 142
 143 /*
 144  * fpga_add
 145  *      Add the device descriptor to the device table.
 146  */
 147 int fpga_add(fpga_type devtype, void *desc)
 148 {
 149         int devnum = FPGA_INVALID_DEVICE;
 150
 151         if (next_desc < 0) {
 152                 printf("%s: FPGA support not initialized!\n", __func__);
 153         } else if ((devtype > fpga_min_type) && (devtype < fpga_undefined)) {
 154                 if (desc) {
 155                         if (next_desc < CONFIG_MAX_FPGA_DEVICES) {
 156                                 devnum = next_desc;
 157                                 desc_table[next_desc].devtype = devtype;
 158                                 desc_table[next_desc++].devdesc = desc;
 159                         } else {
 160                                 printf("%s: Exceeded Max FPGA device count\n",
 161                                        __func__);
 162                         }
 163                 } else {
 164                         printf("%s: NULL device descriptor\n", __func__);
 165                 }
 166         } else {
 167                 printf("%s: Unsupported FPGA type %d\n", __func__, devtype);
 168         }
 169
 170         return devnum;
 171 }
 172
 173 /*
 174  * Return 1 if the fpga data is partial.
 175  * This is only required for fpga drivers that support bitstream_type.
 176  */
 177 int __weak fpga_is_partial_data(int devnum, size_t img_len)
 178 {
 179         return 0;
 180 }
 181
 182 /*
 183  * Convert bitstream data and load into the fpga
 184  */
 185 int __weak fpga_loadbitstream(int devnum, char *fpgadata, size_t size,
 186                               bitstream_type bstype)
 187 {
 188         printf("Bitstream support not implemented for this FPGA device\n");
 189         return FPGA_FAIL;
 190 }
 191
 192 #if defined(CONFIG_CMD_FPGA_LOADFS)
 193 int fpga_fsload(int devnum, const void *buf, size_t size,
 194                  fpga_fs_info *fpga_fsinfo)
 195 {
 196         int ret_val = FPGA_FAIL;           /* assume failure */
 197         const fpga_desc *desc = fpga_validate(devnum, buf, size,
 198                                               (char *)__func__);
 199
 200         if (desc) {
 201                 switch (desc->devtype) {
 202                 case fpga_xilinx:
 203 #if defined(CONFIG_FPGA_XILINX)
 204                         ret_val = xilinx_loadfs(desc->devdesc, buf, size,
 205                                                 fpga_fsinfo);
 206 #else
 207                         fpga_no_sup((char *)__func__, "Xilinx devices");
 208 #endif
 209                         break;
 210                 default:
 211                         printf("%s: Invalid or unsupported device type %d\n",
 212                                __func__, desc->devtype);
 213                 }
 214         }
 215
 216         return ret_val;
 217 }
 218 #endif
 219
 220 /*
 221  * Generic multiplexing code
 222  */
 223 int fpga_load(int devnum, const void *buf, size_t bsize, bitstream_type bstype)
 224 {
 225         int ret_val = FPGA_FAIL;           /* assume failure */
 226         const fpga_desc *desc = fpga_validate(devnum, buf, bsize,
 227                                               (char *)__func__);
 228
 229         if (desc) {
 230                 switch (desc->devtype) {
 231                 case fpga_xilinx:
 232 #if defined(CONFIG_FPGA_XILINX)
 233                         ret_val = xilinx_load(desc->devdesc, buf, bsize,
 234                                               bstype);
 235 #else
 236                         fpga_no_sup((char *)__func__, "Xilinx devices");
 237 #endif
 238                         break;
 239                 case fpga_altera:
 240 #if defined(CONFIG_FPGA_ALTERA)
 241                         ret_val = altera_load(desc->devdesc, buf, bsize);
 242 #else
 243                         fpga_no_sup((char *)__func__, "Altera devices");
 244 #endif
 245                         break;
 246                 case fpga_lattice:
 247 #if defined(CONFIG_FPGA_LATTICE)
 248                         ret_val = lattice_load(desc->devdesc, buf, bsize);
 249 #else
 250                         fpga_no_sup((char *)__func__, "Lattice devices");
 251 #endif
 252                         break;
 253                 default:
 254                         printf("%s: Invalid or unsupported device type %d\n",
 255                                __func__, desc->devtype);
 256                 }
 257         }
 258
 259         return ret_val;
 260 }
 261
 262 /*
 263  * fpga_dump
 264  *      generic multiplexing code
 265  */
 266 int fpga_dump(int devnum, const void *buf, size_t bsize)
 267 {
 268         int ret_val = FPGA_FAIL;           /* assume failure */
 269         const fpga_desc *desc = fpga_validate(devnum, buf, bsize,
 270                                               (char *)__func__);
 271
 272         if (desc) {
 273                 switch (desc->devtype) {
 274                 case fpga_xilinx:
 275 #if defined(CONFIG_FPGA_XILINX)
 276                         ret_val = xilinx_dump(desc->devdesc, buf, bsize);
 277 #else
 278                         fpga_no_sup((char *)__func__, "Xilinx devices");
 279 #endif
 280                         break;
 281                 case fpga_altera:
 282 #if defined(CONFIG_FPGA_ALTERA)
 283                         ret_val = altera_dump(desc->devdesc, buf, bsize);
 284 #else
 285                         fpga_no_sup((char *)__func__, "Altera devices");
 286 #endif
 287                         break;
 288                 case fpga_lattice:
 289 #if defined(CONFIG_FPGA_LATTICE)
 290                         ret_val = lattice_dump(desc->devdesc, buf, bsize);
 291 #else
 292                         fpga_no_sup((char *)__func__, "Lattice devices");
 293 #endif
 294                         break;
 295                 default:
 296                         printf("%s: Invalid or unsupported device type %d\n",
 297                                __func__, desc->devtype);
 298                 }
 299         }
 300
 301         return ret_val;
 302 }
 303
 304 /*
 305  * fpga_info
 306  *      front end to fpga_dev_info.  If devnum is invalid, report on all
 307  *      available devices.
 308  */
 309 int fpga_info(int devnum)
 310 {
 311         if (devnum == FPGA_INVALID_DEVICE) {
 312                 if (next_desc > 0) {
 313                         int dev;
 314
 315                         for (dev = 0; dev < next_desc; dev++)
 316                                 fpga_dev_info(dev);
 317
 318                         return FPGA_SUCCESS;
 319                 } else {
 320                         printf("%s: No FPGA devices available.\n", __func__);
 321                         return FPGA_FAIL;
 322                 }
 323         }
 324
 325         return fpga_dev_info(devnum);
 326 }