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