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