Audit and eliminate redundant #include directives in src/{pld,svf,xsvf}.
[fw/openocd] / src / pld / virtex2.c
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 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include "virtex2.h"
25 #include "xilinx_bit.h"
26 #include "pld.h"
27
28
29 int virtex2_register_commands(struct command_context_s *cmd_ctx);
30 int virtex2_pld_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct pld_device_s *pld_device);
31 int virtex2_load(struct pld_device_s *pld_device, char *filename);
32
33 pld_driver_t virtex2_pld =
34 {
35         .name = "virtex2",
36         .register_commands = virtex2_register_commands,
37         .pld_device_command = virtex2_pld_device_command,
38         .load = virtex2_load,
39 };
40
41 int virtex2_set_instr(jtag_tap_t *tap, u32 new_instr)
42 {
43         if (tap==NULL)
44                 return ERROR_FAIL;
45
46         if (buf_get_u32(tap->cur_instr, 0, tap->ir_length) != new_instr)
47         {
48                 scan_field_t field;
49
50                 field.tap = tap;
51                 field.num_bits = tap->ir_length;
52                 field.out_value = calloc(CEIL(field.num_bits, 8), 1);
53                 buf_set_u32(field.out_value, 0, field.num_bits, new_instr);
54
55                 field.in_value = NULL;
56
57
58
59
60
61                 jtag_add_ir_scan(1, &field, TAP_IDLE);
62
63                 free(field.out_value);
64         }
65
66         return ERROR_OK;
67 }
68
69 int virtex2_send_32(struct pld_device_s *pld_device, int num_words, u32 *words)
70 {
71         virtex2_pld_device_t *virtex2_info = pld_device->driver_priv;
72         scan_field_t scan_field;
73         u8 *values;
74         int i;
75
76         values = malloc(num_words * 4);
77
78         scan_field.tap = virtex2_info->tap;
79         scan_field.num_bits = num_words * 32;
80         scan_field.out_value = values;
81         scan_field.in_value = NULL;
82
83         for (i = 0; i < num_words; i++)
84                 buf_set_u32(values + 4 * i, 0, 32, flip_u32(*words++, 32));
85
86         virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
87
88         jtag_add_dr_scan(1, &scan_field, TAP_DRPAUSE);
89
90         free(values);
91
92         return ERROR_OK;
93 }
94
95
96 int virtex2_receive_32(struct pld_device_s *pld_device, int num_words, u32 *words)
97 {
98         virtex2_pld_device_t *virtex2_info = pld_device->driver_priv;
99         scan_field_t scan_field;
100
101         scan_field.tap = virtex2_info->tap;
102         scan_field.num_bits = 32;
103         scan_field.out_value = NULL;
104         u8 tmp[4];
105         scan_field.in_value = tmp;
106
107         virtex2_set_instr(virtex2_info->tap, 0x4); /* CFG_OUT */
108
109         while (num_words--)
110         {
111                 jtag_add_dr_scan_now(1, &scan_field, TAP_DRPAUSE);
112
113                 *words++=flip_u32(le_to_h_u32(tmp), 32);
114         }
115
116         return ERROR_OK;
117 }
118
119 int virtex2_read_stat(struct pld_device_s *pld_device, u32 *status)
120 {
121         u32 data[5];
122
123         jtag_add_tlr();
124
125         data[0] = 0xaa995566; /* synch word */
126         data[1] = 0x2800E001; /* Type 1, read, address 7, 1 word */
127         data[2] = 0x20000000; /* NOOP (Type 1, read, address 0, 0 words */
128         data[3] = 0x20000000; /* NOOP */
129         data[4] = 0x20000000; /* NOOP */
130         virtex2_send_32(pld_device, 5, data);
131
132         virtex2_receive_32(pld_device, 1, status);
133
134         jtag_execute_queue();
135
136         LOG_DEBUG("status: 0x%8.8x", *status);
137
138         return ERROR_OK;
139 }
140
141 int virtex2_load(struct pld_device_s *pld_device, char *filename)
142 {
143         virtex2_pld_device_t *virtex2_info = pld_device->driver_priv;
144         xilinx_bit_file_t bit_file;
145         int retval;
146         unsigned int i;
147
148         scan_field_t field;
149
150         field.tap = virtex2_info->tap;
151
152         field.in_value = NULL;
153
154
155
156
157
158         if ((retval = xilinx_read_bit_file(&bit_file, filename)) != ERROR_OK)
159                 return retval;
160
161         jtag_add_end_state(TAP_IDLE);
162         virtex2_set_instr(virtex2_info->tap, 0xb); /* JPROG_B */
163         jtag_execute_queue();
164         jtag_add_sleep(1000);
165
166         virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
167         jtag_execute_queue();
168
169         for (i = 0; i < bit_file.length; i++)
170                 bit_file.data[i] = flip_u32(bit_file.data[i], 8);
171
172         field.num_bits = bit_file.length * 8;
173         field.out_value = bit_file.data;
174
175         jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
176         jtag_execute_queue();
177
178         jtag_add_tlr();
179
180         jtag_add_end_state(TAP_IDLE);
181         virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
182         jtag_add_runtest(13, TAP_IDLE);
183         virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
184         virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
185         virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
186         jtag_add_runtest(13, TAP_IDLE);
187         virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
188         jtag_execute_queue();
189
190         return ERROR_OK;
191 }
192
193 int virtex2_handle_read_stat_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
194 {
195         pld_device_t *device;
196         virtex2_pld_device_t *virtex2_info;
197         u32 status;
198
199         if (argc < 1)
200         {
201                 command_print(cmd_ctx, "usage: virtex2 read_stat <num>");
202                 return ERROR_OK;
203         }
204
205         device = get_pld_device_by_num(strtoul(args[0], NULL, 0));
206         if (!device)
207         {
208                 command_print(cmd_ctx, "pld device '#%s' is out of bounds", args[0]);
209                 return ERROR_OK;
210         }
211
212         virtex2_info = device->driver_priv;
213
214         virtex2_read_stat(device, &status);
215
216         command_print(cmd_ctx, "virtex2 status register: 0x%8.8x", status);
217
218         return ERROR_OK;
219 }
220
221 int virtex2_register_commands(struct command_context_s *cmd_ctx)
222 {
223         command_t *virtex2_cmd = register_command(cmd_ctx, NULL, "virtex2", NULL, COMMAND_ANY, "virtex2 specific commands");
224
225         register_command(cmd_ctx, virtex2_cmd, "read_stat", virtex2_handle_read_stat_command, COMMAND_EXEC,
226                                          "read Virtex-II status register");
227
228         return ERROR_OK;
229 }
230
231 int virtex2_pld_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct pld_device_s *pld_device)
232 {
233         jtag_tap_t *tap;
234
235         virtex2_pld_device_t *virtex2_info;
236
237         if (argc < 2)
238         {
239                 LOG_WARNING("incomplete pld device 'virtex2' configuration");
240                 return ERROR_PLD_DEVICE_INVALID;
241         }
242
243         tap = jtag_TapByString( args[1] );
244         if( tap == NULL ){
245                 command_print( cmd_ctx, "Tap: %s does not exist", args[1] );
246                 return ERROR_OK;
247         }
248
249         virtex2_info = malloc(sizeof(virtex2_pld_device_t));
250         pld_device->driver_priv = virtex2_info;
251         virtex2_info->tap = tap;
252
253         return ERROR_OK;
254 }