OpenOCD
virtex2.c
Go to the documentation of this file.
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 
3 /***************************************************************************
4  * Copyright (C) 2006 by Dominic Rath *
5  * Dominic.Rath@gmx.de *
6  ***************************************************************************/
7 
8 #ifdef HAVE_CONFIG_H
9 #include "config.h"
10 #endif
11 
12 #include "virtex2.h"
13 #include "xilinx_bit.h"
14 #include "pld.h"
15 
16 static int virtex2_set_instr(struct jtag_tap *tap, uint32_t new_instr)
17 {
18  if (!tap)
19  return ERROR_FAIL;
20 
21  if (buf_get_u32(tap->cur_instr, 0, tap->ir_length) != new_instr) {
22  struct scan_field field;
23 
24  field.num_bits = tap->ir_length;
25  void *t = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
26  field.out_value = t;
27  buf_set_u32(t, 0, field.num_bits, new_instr);
28  field.in_value = NULL;
29 
30  jtag_add_ir_scan(tap, &field, TAP_IDLE);
31 
32  free(t);
33  }
34 
35  return ERROR_OK;
36 }
37 
39  int num_words, uint32_t *words)
40 {
41  struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
42  struct scan_field scan_field;
43  uint8_t *values;
44  int i;
45 
46  values = malloc(num_words * 4);
47 
48  scan_field.num_bits = num_words * 32;
49  scan_field.out_value = values;
51 
52  for (i = 0; i < num_words; i++)
53  buf_set_u32(values + 4 * i, 0, 32, flip_u32(*words++, 32));
54 
55  virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
56 
57  jtag_add_dr_scan(virtex2_info->tap, 1, &scan_field, TAP_DRPAUSE);
58 
59  free(values);
60 
61  return ERROR_OK;
62 }
63 
64 static inline void virtexflip32(jtag_callback_data_t arg)
65 {
66  uint8_t *in = (uint8_t *)arg;
67  *((uint32_t *)arg) = flip_u32(le_to_h_u32(in), 32);
68 }
69 
71  int num_words, uint32_t *words)
72 {
73  struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
74  struct scan_field scan_field;
75 
76  scan_field.num_bits = 32;
79 
80  virtex2_set_instr(virtex2_info->tap, 0x4); /* CFG_OUT */
81 
82  while (num_words--) {
83  scan_field.in_value = (uint8_t *)words;
84 
85  jtag_add_dr_scan(virtex2_info->tap, 1, &scan_field, TAP_DRPAUSE);
86 
88 
89  words++;
90  }
91 
92  return ERROR_OK;
93 }
94 
95 static int virtex2_read_stat(struct pld_device *pld_device, uint32_t *status)
96 {
97  uint32_t data[5];
98 
99  jtag_add_tlr();
100 
101  data[0] = 0xaa995566; /* synch word */
102  data[1] = 0x2800E001; /* Type 1, read, address 7, 1 word */
103  data[2] = 0x20000000; /* NOOP (Type 1, read, address 0, 0 words */
104  data[3] = 0x20000000; /* NOOP */
105  data[4] = 0x20000000; /* NOOP */
106  virtex2_send_32(pld_device, 5, data);
107 
109 
111 
112  LOG_DEBUG("status: 0x%8.8" PRIx32 "", *status);
113 
114  return ERROR_OK;
115 }
116 
117 static int virtex2_load(struct pld_device *pld_device, const char *filename)
118 {
119  struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
120  struct xilinx_bit_file bit_file;
121  int retval;
122  unsigned int i;
123  struct scan_field field;
124 
125  field.in_value = NULL;
126 
127  retval = xilinx_read_bit_file(&bit_file, filename);
128  if (retval != ERROR_OK)
129  return retval;
130 
131  virtex2_set_instr(virtex2_info->tap, 0xb); /* JPROG_B */
133  jtag_add_sleep(1000);
134 
135  virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
137 
138  for (i = 0; i < bit_file.length; i++)
139  bit_file.data[i] = flip_u32(bit_file.data[i], 8);
140 
141  field.num_bits = bit_file.length * 8;
142  field.out_value = bit_file.data;
143 
144  jtag_add_dr_scan(virtex2_info->tap, 1, &field, TAP_DRPAUSE);
146 
147  jtag_add_tlr();
148 
149  if (!(virtex2_info->no_jstart))
150  virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
152  virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
153  virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
154  if (!(virtex2_info->no_jstart))
155  virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
157  virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
159 
160  xilinx_free_bit_file(&bit_file);
161 
162  return ERROR_OK;
163 }
164 
165 COMMAND_HANDLER(virtex2_handle_read_stat_command)
166 {
167  struct pld_device *device;
168  uint32_t status;
169 
170  if (CMD_ARGC < 1)
172 
173  unsigned dev_id;
174  COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], dev_id);
175  device = get_pld_device_by_num(dev_id);
176  if (!device) {
177  command_print(CMD, "pld device '#%s' is out of bounds", CMD_ARGV[0]);
178  return ERROR_FAIL;
179  }
180 
182 
183  command_print(CMD, "virtex2 status register: 0x%8.8" PRIx32 "", status);
184 
185  return ERROR_OK;
186 }
187 
188 PLD_DEVICE_COMMAND_HANDLER(virtex2_pld_device_command)
189 {
190  struct jtag_tap *tap;
191 
192  struct virtex2_pld_device *virtex2_info;
193 
194  if (CMD_ARGC < 2)
196 
198  if (!tap) {
199  command_print(CMD, "Tap: %s does not exist", CMD_ARGV[1]);
200  return ERROR_FAIL;
201  }
202 
203  virtex2_info = malloc(sizeof(struct virtex2_pld_device));
204  virtex2_info->tap = tap;
205 
206  virtex2_info->no_jstart = 0;
207  if (CMD_ARGC >= 3)
208  COMMAND_PARSE_NUMBER(int, CMD_ARGV[2], virtex2_info->no_jstart);
209 
210  pld->driver_priv = virtex2_info;
211 
212  return ERROR_OK;
213 }
214 
215 static const struct command_registration virtex2_exec_command_handlers[] = {
216  {
217  .name = "read_stat",
218  .mode = COMMAND_EXEC,
219  .handler = virtex2_handle_read_stat_command,
220  .help = "read status register",
221  .usage = "pld_num",
222  },
224 };
225 static const struct command_registration virtex2_command_handler[] = {
226  {
227  .name = "virtex2",
228  .mode = COMMAND_ANY,
229  .help = "Virtex-II specific commands",
230  .usage = "",
232  },
234 };
235 
236 struct pld_driver virtex2_pld = {
237  .name = "virtex2",
238  .commands = virtex2_command_handler,
239  .pld_device_command = &virtex2_pld_device_command,
240  .load = &virtex2_load,
241 };
static const struct device_t * device
Definition: at91rm9200.c:94
uint32_t flip_u32(uint32_t value, unsigned int num)
Definition: binarybuffer.c:166
static uint32_t buf_get_u32(const uint8_t *_buffer, unsigned first, unsigned num)
Retrieves num bits from _buffer, starting at the first bit, returning the bits in a 32-bit word.
Definition: binarybuffer.h:98
static void buf_set_u32(uint8_t *_buffer, unsigned first, unsigned num, uint32_t value)
Sets num bits in _buffer, starting at the first bit, using the bits in value.
Definition: binarybuffer.h:30
void command_print(struct command_invocation *cmd, const char *format,...)
Definition: command.c:473
#define CMD
Use this macro to access the command being handled, rather than accessing the variable directly.
Definition: command.h:140
#define CMD_ARGV
Use this macro to access the arguments for the command being handled, rather than accessing the varia...
Definition: command.h:155
#define ERROR_COMMAND_SYNTAX_ERROR
Definition: command.h:385
#define CMD_ARGC
Use this macro to access the number of arguments for the command being handled, rather than accessing...
Definition: command.h:150
#define COMMAND_PARSE_NUMBER(type, in, out)
parses the string in into out as a type, or prints a command error and passes the error code to the c...
Definition: command.h:425
#define COMMAND_REGISTRATION_DONE
Use this as the last entry in an array of command_registration records.
Definition: command.h:247
@ COMMAND_ANY
Definition: command.h:42
@ COMMAND_EXEC
Definition: command.h:40
struct jtag_tap * jtag_tap_by_string(const char *s)
Definition: jtag/core.c:237
int jtag_execute_queue(void)
For software FIFO implementations, the queued commands can be executed during this call or earlier.
Definition: jtag/core.c:1037
void jtag_add_tlr(void)
Run a TAP_RESET reset where the end state is TAP_RESET, regardless of the start state.
Definition: jtag/core.c:478
void jtag_add_sleep(uint32_t us)
Definition: jtag/core.c:870
void jtag_add_ir_scan(struct jtag_tap *active, struct scan_field *in_fields, tap_state_t state)
Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
Definition: jtag/core.c:374
void jtag_add_runtest(int num_cycles, tap_state_t state)
Goes to TAP_IDLE (if we're not already there), cycle precisely num_cycles in the TAP_IDLE state,...
Definition: jtag/core.c:592
void jtag_add_dr_scan(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
Generate a DR SCAN using the fields passed to the function.
Definition: jtag/core.c:451
void jtag_add_callback(jtag_callback1_t f, jtag_callback_data_t data0)
A simpler version of jtag_add_callback4().
@ TAP_DRPAUSE
Definition: jtag.h:43
@ TAP_IDLE
Definition: jtag.h:52
intptr_t jtag_callback_data_t
Defines the type of data passed to the jtag_callback_t interface.
Definition: jtag.h:333
#define ERROR_FAIL
Definition: log.h:161
#define LOG_DEBUG(expr ...)
Definition: log.h:109
#define ERROR_OK
Definition: log.h:155
struct pld_device * get_pld_device_by_num(int num)
Definition: pld.c:29
const char * name
Definition: command.h:229
Definition: jtag.h:100
uint8_t * cur_instr
current instruction
Definition: jtag.h:131
int ir_length
size of instruction register
Definition: jtag.h:109
Definition: pld.h:28
void * driver_priv
Definition: pld.h:30
Definition: pld.h:18
const char * name
Definition: pld.h:19
This structure defines a single scan field in the scan.
Definition: jtag.h:86
int num_bits
The number of bits this field specifies.
Definition: jtag.h:88
uint8_t * in_value
A pointer to a 32-bit memory location for data scanned out.
Definition: jtag.h:92
const uint8_t * out_value
A pointer to value to be scanned into the device.
Definition: jtag.h:90
struct jtag_tap * tap
Definition: virtex2.h:14
uint32_t length
Definition: xilinx_bit.h:19
uint8_t * data
Definition: xilinx_bit.h:20
#define DIV_ROUND_UP(m, n)
Rounds m up to the nearest multiple of n using division.
Definition: types.h:79
static uint32_t le_to_h_u32(const uint8_t *buf)
Definition: types.h:112
#define NULL
Definition: usb.h:16
uint8_t status[4]
Definition: vdebug.c:17
static int virtex2_send_32(struct pld_device *pld_device, int num_words, uint32_t *words)
Definition: virtex2.c:38
static int virtex2_read_stat(struct pld_device *pld_device, uint32_t *status)
Definition: virtex2.c:95
static const struct command_registration virtex2_command_handler[]
Definition: virtex2.c:225
static int virtex2_set_instr(struct jtag_tap *tap, uint32_t new_instr)
Definition: virtex2.c:16
COMMAND_HANDLER(virtex2_handle_read_stat_command)
Definition: virtex2.c:165
PLD_DEVICE_COMMAND_HANDLER(virtex2_pld_device_command)
Definition: virtex2.c:188
static int virtex2_load(struct pld_device *pld_device, const char *filename)
Definition: virtex2.c:117
static int virtex2_receive_32(struct pld_device *pld_device, int num_words, uint32_t *words)
Definition: virtex2.c:70
struct pld_driver virtex2_pld
Definition: virtex2.c:236
static void virtexflip32(jtag_callback_data_t arg)
Definition: virtex2.c:64
static const struct command_registration virtex2_exec_command_handlers[]
Definition: virtex2.c:215
void xilinx_free_bit_file(struct xilinx_bit_file *bit_file)
Definition: xilinx_bit.c:141
int xilinx_read_bit_file(struct xilinx_bit_file *bit_file, const char *filename)
Definition: xilinx_bit.c:60