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