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