src/pld/pld.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2
   3 /***************************************************************************
   4  *   Copyright (C) 2006 by Dominic Rath                                    *
   5  *   Dominic.Rath@gmx.de                                                   *
   6  ***************************************************************************/
   7
   8 #ifndef OPENOCD_PLD_PLD_H
   9 #define OPENOCD_PLD_PLD_H
  10
  11 #include <helper/command.h>
  12
  13 struct pld_device;
  14
  15 #define __PLD_CREATE_COMMAND(name) \
  16         COMMAND_HELPER(name, struct pld_device *pld)
  17
  18 struct pld_ipdbg_hub {
  19         struct jtag_tap *tap;
  20         unsigned int user_ir_code;
  21 };
  22
  23 struct pld_driver {
  24         const char *name;
  25         __PLD_CREATE_COMMAND((*pld_create_command));
  26         const struct command_registration *commands;
  27         int (*load)(struct pld_device *pld_device, const char *filename);
  28         int (*get_ipdbg_hub)(int user_num, struct pld_device *pld_device, struct pld_ipdbg_hub *hub);
  29 };
  30
  31 #define PLD_CREATE_COMMAND_HANDLER(name) \
  32         static __PLD_CREATE_COMMAND(name)
  33
  34 struct pld_device {
  35         struct pld_driver *driver;
  36         void *driver_priv;
  37         struct pld_device *next;
  38         char *name;
  39 };
  40
  41 int pld_register_commands(struct command_context *cmd_ctx);
  42
  43 struct pld_device *get_pld_device_by_num(int num);
  44 struct pld_device *get_pld_device_by_name(const char *name);
  45 struct pld_device *get_pld_device_by_name_or_numstr(const char *str);
  46
  47 #define ERROR_PLD_DEVICE_INVALID        (-1000)
  48 #define ERROR_PLD_FILE_LOAD_FAILED      (-1001)
  49
  50 extern struct pld_driver efinix_pld;
  51 extern struct pld_driver gatemate_pld;
  52 extern struct pld_driver gowin_pld;
  53 extern struct pld_driver intel_pld;
  54 extern struct pld_driver lattice_pld;
  55 extern struct pld_driver virtex2_pld;
  56
  57 #endif /* OPENOCD_PLD_PLD_H */