PLD: usage/help updates
[openocd.git] / src / pld / virtex2.c
blobbbf6b66751548d2eb49bf7e2f67619321592c4aa
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
24 #include "virtex2.h"
25 #include "xilinx_bit.h"
26 #include "pld.h"
29 static int virtex2_set_instr(struct jtag_tap *tap, uint32_t new_instr)
31 if (tap == NULL)
32 return ERROR_FAIL;
34 if (buf_get_u32(tap->cur_instr, 0, tap->ir_length) != new_instr)
36 struct scan_field field;
38 field.tap = tap;
39 field.num_bits = tap->ir_length;
40 field.out_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
41 buf_set_u32(field.out_value, 0, field.num_bits, new_instr);
42 field.in_value = NULL;
44 jtag_add_ir_scan(1, &field, jtag_set_end_state(TAP_IDLE));
46 free(field.out_value);
49 return ERROR_OK;
52 static int virtex2_send_32(struct pld_device *pld_device,
53 int num_words, uint32_t *words)
55 struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
56 struct scan_field scan_field;
57 uint8_t *values;
58 int i;
60 values = malloc(num_words * 4);
62 scan_field.tap = virtex2_info->tap;
63 scan_field.num_bits = num_words * 32;
64 scan_field.out_value = values;
65 scan_field.in_value = NULL;
67 for (i = 0; i < num_words; i++)
68 buf_set_u32(values + 4 * i, 0, 32, flip_u32(*words++, 32));
70 virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
72 jtag_add_dr_scan(1, &scan_field, jtag_set_end_state(TAP_DRPAUSE));
74 free(values);
76 return ERROR_OK;
79 static __inline__ void virtexflip32(jtag_callback_data_t arg)
81 uint8_t *in = (uint8_t *)arg;
82 *((uint32_t *)in) = flip_u32(le_to_h_u32(in), 32);
85 static int virtex2_receive_32(struct pld_device *pld_device,
86 int num_words, uint32_t *words)
88 struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
89 struct scan_field scan_field;
91 scan_field.tap = virtex2_info->tap;
92 scan_field.num_bits = 32;
93 scan_field.out_value = NULL;
94 scan_field.in_value = NULL;
96 virtex2_set_instr(virtex2_info->tap, 0x4); /* CFG_OUT */
98 while (num_words--)
100 scan_field.in_value = (uint8_t *)words;
102 jtag_add_dr_scan(1, &scan_field, jtag_set_end_state(TAP_DRPAUSE));
104 jtag_add_callback(virtexflip32, (jtag_callback_data_t)words);
106 words++;;
109 return ERROR_OK;
112 static int virtex2_read_stat(struct pld_device *pld_device, uint32_t *status)
114 uint32_t data[5];
116 jtag_add_tlr();
118 data[0] = 0xaa995566; /* synch word */
119 data[1] = 0x2800E001; /* Type 1, read, address 7, 1 word */
120 data[2] = 0x20000000; /* NOOP (Type 1, read, address 0, 0 words */
121 data[3] = 0x20000000; /* NOOP */
122 data[4] = 0x20000000; /* NOOP */
123 virtex2_send_32(pld_device, 5, data);
125 virtex2_receive_32(pld_device, 1, status);
127 jtag_execute_queue();
129 LOG_DEBUG("status: 0x%8.8" PRIx32 "", *status);
131 return ERROR_OK;
134 static int virtex2_load(struct pld_device *pld_device, const char *filename)
136 struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
137 struct xilinx_bit_file bit_file;
138 int retval;
139 unsigned int i;
140 struct scan_field field;
142 field.tap = virtex2_info->tap;
143 field.in_value = NULL;
145 if ((retval = xilinx_read_bit_file(&bit_file, filename)) != ERROR_OK)
146 return retval;
148 jtag_set_end_state(TAP_IDLE);
149 virtex2_set_instr(virtex2_info->tap, 0xb); /* JPROG_B */
150 jtag_execute_queue();
151 jtag_add_sleep(1000);
153 virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
154 jtag_execute_queue();
156 for (i = 0; i < bit_file.length; i++)
157 bit_file.data[i] = flip_u32(bit_file.data[i], 8);
159 field.num_bits = bit_file.length * 8;
160 field.out_value = bit_file.data;
162 jtag_add_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE));
163 jtag_execute_queue();
165 jtag_add_tlr();
167 jtag_set_end_state(TAP_IDLE);
168 virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
169 jtag_add_runtest(13, jtag_set_end_state(TAP_IDLE));
170 virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
171 virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
172 virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
173 jtag_add_runtest(13, jtag_set_end_state(TAP_IDLE));
174 virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
175 jtag_execute_queue();
177 return ERROR_OK;
180 COMMAND_HANDLER(virtex2_handle_read_stat_command)
182 struct pld_device *device;
183 struct virtex2_pld_device *virtex2_info;
184 uint32_t status;
186 if (CMD_ARGC < 1)
188 command_print(CMD_CTX, "usage: virtex2 read_stat <num>");
189 return ERROR_OK;
192 unsigned dev_id;
193 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], dev_id);
194 device = get_pld_device_by_num(dev_id);
195 if (!device)
197 command_print(CMD_CTX, "pld device '#%s' is out of bounds", CMD_ARGV[0]);
198 return ERROR_OK;
201 virtex2_info = device->driver_priv;
203 virtex2_read_stat(device, &status);
205 command_print(CMD_CTX, "virtex2 status register: 0x%8.8" PRIx32 "", status);
207 return ERROR_OK;
210 PLD_DEVICE_COMMAND_HANDLER(virtex2_pld_device_command)
212 struct jtag_tap *tap;
214 struct virtex2_pld_device *virtex2_info;
216 if (CMD_ARGC < 2)
218 LOG_WARNING("incomplete pld device 'virtex2' configuration");
219 return ERROR_PLD_DEVICE_INVALID;
222 tap = jtag_tap_by_string(CMD_ARGV[1]);
223 if (tap == NULL) {
224 command_print(CMD_CTX, "Tap: %s does not exist", CMD_ARGV[1]);
225 return ERROR_OK;
228 virtex2_info = malloc(sizeof(struct virtex2_pld_device));
229 virtex2_info->tap = tap;
231 pld->driver_priv = virtex2_info;
233 return ERROR_OK;
236 static const struct command_registration virtex2_exec_command_handlers[] = {
238 .name = "read_stat",
239 .mode = COMMAND_EXEC,
240 .handler = virtex2_handle_read_stat_command,
241 .help = "read status register",
242 .usage = "pld_num",
244 COMMAND_REGISTRATION_DONE
246 static const struct command_registration virtex2_command_handler[] = {
248 .name = "virtex2",
249 .mode = COMMAND_ANY,
250 .help = "Virtex-II specific commands",
251 .chain = virtex2_exec_command_handlers,
253 COMMAND_REGISTRATION_DONE
256 struct pld_driver virtex2_pld = {
257 .name = "virtex2",
258 .commands = virtex2_command_handler,
259 .pld_device_command = &virtex2_pld_device_command,
260 .load = &virtex2_load,