retire out_mask - not used anywhere
[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(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                 
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_IDLE);
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.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->tap, 0x5); /* CFG_IN */
96
97         jtag_add_dr_scan(1, &scan_field, TAP_DRPAUSE);
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.tap = virtex2_info->tap;
117         scan_field.num_bits = 32;
118         scan_field.out_value = NULL;
119         scan_field.in_value = NULL;
120         scan_field.in_check_value = NULL;
121         scan_field.in_check_mask = NULL;
122         scan_field.in_handler = virtex2_jtag_buf_to_u32; /* deprecated! invoke this from user code! */
123
124         virtex2_set_instr(virtex2_info->tap, 0x4); /* CFG_OUT */
125
126         while (num_words--)
127         {
128                 scan_field.in_handler_priv = words++;
129                 jtag_add_dr_scan(1, &scan_field, TAP_DRPAUSE);
130         }
131
132         return ERROR_OK;
133 }
134
135 int virtex2_read_stat(struct pld_device_s *pld_device, u32 *status)
136 {
137         u32 data[5];
138
139         jtag_add_tlr();
140
141         data[0] = 0xaa995566; /* synch word */
142         data[1] = 0x2800E001; /* Type 1, read, address 7, 1 word */
143         data[2] = 0x20000000; /* NOOP (Type 1, read, address 0, 0 words */
144         data[3] = 0x20000000; /* NOOP */
145         data[4] = 0x20000000; /* NOOP */
146         virtex2_send_32(pld_device, 5, data);
147
148         virtex2_receive_32(pld_device, 1, status);
149
150         jtag_execute_queue();
151
152         LOG_DEBUG("status: 0x%8.8x", *status);
153
154         return ERROR_OK;
155 }
156
157 int virtex2_load(struct pld_device_s *pld_device, char *filename)
158 {
159         virtex2_pld_device_t *virtex2_info = pld_device->driver_priv;
160         xilinx_bit_file_t bit_file;
161         int retval;
162         unsigned int i;
163
164         scan_field_t field;
165
166         field.tap = virtex2_info->tap;
167         
168         field.in_value = NULL;
169         field.in_check_value = NULL;
170         field.in_check_mask = NULL;
171         field.in_handler = NULL;
172         field.in_handler_priv = NULL;
173
174         if ((retval = xilinx_read_bit_file(&bit_file, filename)) != ERROR_OK)
175                 return retval;
176
177         jtag_add_end_state(TAP_IDLE);
178         virtex2_set_instr(virtex2_info->tap, 0xb); /* JPROG_B */
179         jtag_execute_queue();
180         jtag_add_sleep(1000);
181
182         virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
183         jtag_execute_queue();
184
185         for (i = 0; i < bit_file.length; i++)
186                 bit_file.data[i] = flip_u32(bit_file.data[i], 8);
187
188         field.num_bits = bit_file.length * 8;
189         field.out_value = bit_file.data;
190
191         jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
192         jtag_execute_queue();
193
194         jtag_add_tlr();
195
196         jtag_add_end_state(TAP_IDLE);
197         virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
198         jtag_add_runtest(13, TAP_IDLE);
199         virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
200         virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
201         virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
202         jtag_add_runtest(13, TAP_IDLE);
203         virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
204         jtag_execute_queue();
205
206         return ERROR_OK;
207 }
208
209 int virtex2_handle_read_stat_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
210 {
211         pld_device_t *device;
212         virtex2_pld_device_t *virtex2_info;
213         u32 status;
214
215         if (argc < 1)
216         {
217                 command_print(cmd_ctx, "usage: virtex2 read_stat <num>");
218                 return ERROR_OK;
219         }
220
221         device = get_pld_device_by_num(strtoul(args[0], NULL, 0));
222         if (!device)
223         {
224                 command_print(cmd_ctx, "pld device '#%s' is out of bounds", args[0]);
225                 return ERROR_OK;
226         }
227
228         virtex2_info = device->driver_priv;
229
230         virtex2_read_stat(device, &status);
231
232         command_print(cmd_ctx, "virtex2 status register: 0x%8.8x", status);
233
234         return ERROR_OK;
235 }
236
237 int virtex2_register_commands(struct command_context_s *cmd_ctx)
238 {
239         command_t *virtex2_cmd = register_command(cmd_ctx, NULL, "virtex2", NULL, COMMAND_ANY, "virtex2 specific commands");
240
241         register_command(cmd_ctx, virtex2_cmd, "read_stat", virtex2_handle_read_stat_command, COMMAND_EXEC,
242                                          "read Virtex-II status register");
243
244         return ERROR_OK;
245 }
246
247 int virtex2_pld_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct pld_device_s *pld_device)
248 {
249         jtag_tap_t *tap;
250
251         virtex2_pld_device_t *virtex2_info;
252
253         if (argc < 2)
254         {
255                 LOG_WARNING("incomplete pld device 'virtex2' configuration");
256                 return ERROR_PLD_DEVICE_INVALID;
257         }
258
259         tap = jtag_TapByString( args[1] );
260         if( tap == NULL ){
261                 command_print( cmd_ctx, "Tap: %s does not exist", args[1] );
262                 return ERROR_OK;
263         }
264
265         virtex2_info = malloc(sizeof(virtex2_pld_device_t));
266         pld_device->driver_priv = virtex2_info;
267         virtex2_info->tap = tap;
268
269         return ERROR_OK;
270 }