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