PLD: review scope of functions
[openocd.git] / src / pld / pld.h
1 /***************************************************************************
2 * Copyright (C) 2006 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
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, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #ifndef PLD_H
21 #define PLD_H
22
23 #include <helper/command.h>
24
25 struct pld_device;
26
27 #define __PLD_DEVICE_COMMAND(name) \
28 COMMAND_HELPER(name, struct pld_device *pld)
29
30 struct pld_driver
31 {
32 char *name;
33 __PLD_DEVICE_COMMAND((*pld_device_command));
34 const struct command_registration *commands;
35 int (*load)(struct pld_device *pld_device, const char *filename);
36 };
37
38 #define PLD_DEVICE_COMMAND_HANDLER(name) static __PLD_DEVICE_COMMAND(name)
39
40 struct pld_device
41 {
42 struct pld_driver *driver;
43 void *driver_priv;
44 struct pld_device *next;
45 };
46
47 int pld_register_commands(struct command_context *cmd_ctx);
48
49 struct pld_device *get_pld_device_by_num(int num);
50
51 #define ERROR_PLD_DEVICE_INVALID (-1000)
52 #define ERROR_PLD_FILE_LOAD_FAILED (-1001)
53
54 #endif /* PLD_H */