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