openocd: fix SPDX tag format for files .c
[fw/openocd] / src / jtag / hla / hla_transport.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2
3 /***************************************************************************
4  *   Copyright (C) 2011 by Mathias Kuester                                 *
5  *   Mathias Kuester <kesmtp@freenet.de>                                   *
6  *                                                                         *
7  *   Copyright (C) 2012 by Spencer Oliver                                  *
8  *   spen@spen-soft.co.uk                                                  *
9  ***************************************************************************/
10
11 #ifdef HAVE_CONFIG_H
12 #include "config.h"
13 #endif
14
15 /* project specific includes */
16 #include <jtag/interface.h>
17 #include <jtag/tcl.h>
18 #include <transport/transport.h>
19 #include <helper/time_support.h>
20 #include <target/target.h>
21 #include <jtag/hla/hla_tcl.h>
22 #include <jtag/hla/hla_transport.h>
23 #include <jtag/hla/hla_interface.h>
24
25 COMMAND_HANDLER(hl_transport_jtag_command)
26 {
27         LOG_DEBUG("hl_transport_jtag_command");
28
29         return ERROR_OK;
30 }
31
32 COMMAND_HANDLER(hl_transport_reset_command)
33 {
34         return hl_interface_init_reset();
35 }
36
37 static const struct command_registration hl_swd_transport_subcommand_handlers[] = {
38         {
39          .name = "newdap",
40          .mode = COMMAND_CONFIG,
41          .jim_handler = jim_hl_newtap,
42          .help = "declare a new SWD DAP",
43          },
44         COMMAND_REGISTRATION_DONE
45 };
46
47 static const struct command_registration hl_swd_transport_command_handlers[] = {
48         {
49          .name = "swd",
50          .mode = COMMAND_ANY,
51          .help = "SWD command group",
52          .usage = "",
53          .chain = hl_swd_transport_subcommand_handlers,
54          },
55         COMMAND_REGISTRATION_DONE
56 };
57
58 static const struct command_registration hl_transport_jtag_subcommand_handlers[] = {
59         {
60          .name = "newtap",
61          .mode = COMMAND_CONFIG,
62          .jim_handler = jim_hl_newtap,
63          .help = "Create a new TAP instance named basename.tap_type, "
64          "and appends it to the scan chain.",
65          .usage = "basename tap_type '-irlen' count "
66          "['-expected_id' number]",
67          },
68         {
69          .name = "init",
70          .mode = COMMAND_ANY,
71          .handler = hl_transport_jtag_command,
72          .usage = ""
73          },
74         {
75          .name = "arp_init",
76          .mode = COMMAND_ANY,
77          .handler = hl_transport_jtag_command,
78          .usage = ""
79          },
80         {
81          .name = "arp_init-reset",
82          .mode = COMMAND_ANY,
83          .handler = hl_transport_reset_command,
84          .usage = ""
85          },
86         {
87          .name = "tapisenabled",
88          .mode = COMMAND_EXEC,
89          .jim_handler = jim_jtag_tap_enabler,
90          },
91         {
92          .name = "tapenable",
93          .mode = COMMAND_EXEC,
94          .jim_handler = jim_jtag_tap_enabler,
95          },
96         {
97          .name = "tapdisable",
98          .mode = COMMAND_EXEC,
99          .handler = hl_transport_jtag_command,
100          .usage = "",
101          },
102         {
103          .name = "configure",
104          .mode = COMMAND_EXEC,
105          .handler = hl_transport_jtag_command,
106          .usage = "",
107          },
108         {
109          .name = "cget",
110          .mode = COMMAND_EXEC,
111          .jim_handler = jim_jtag_configure,
112          },
113         {
114          .name = "names",
115          .mode = COMMAND_ANY,
116          .handler = hl_transport_jtag_command,
117          .usage = "",
118          },
119
120         COMMAND_REGISTRATION_DONE
121 };
122
123 static const struct command_registration hl_jtag_transport_command_handlers[] = {
124         {
125          .name = "jtag",
126          .mode = COMMAND_ANY,
127          .help = "perform jtag tap actions",
128          .usage = "",
129          .chain = hl_transport_jtag_subcommand_handlers,
130          },
131         {
132          .name = "jtag_ntrst_delay",
133          .mode = COMMAND_ANY,
134          .handler = hl_transport_jtag_command,
135          .usage = "",
136          },
137         COMMAND_REGISTRATION_DONE
138 };
139
140
141 static int hl_transport_init(struct command_context *cmd_ctx)
142 {
143         LOG_DEBUG("hl_transport_init");
144         struct target *t = get_current_target(cmd_ctx);
145         struct transport *transport;
146         enum hl_transports tr;
147
148         if (!t) {
149                 LOG_ERROR("no current target");
150                 return ERROR_FAIL;
151         }
152
153         transport = get_current_transport();
154
155         if (!transport) {
156                 LOG_ERROR("no transport selected");
157                 return ERROR_FAIL;
158         }
159
160         LOG_DEBUG("current transport %s", transport->name);
161
162         /* get selected transport as enum */
163         tr = HL_TRANSPORT_UNKNOWN;
164
165         if (strcmp(transport->name, "hla_swd") == 0)
166                 tr = HL_TRANSPORT_SWD;
167         else if (strcmp(transport->name, "hla_jtag") == 0)
168                 tr = HL_TRANSPORT_JTAG;
169
170         int retval = hl_interface_open(tr);
171
172         if (retval != ERROR_OK)
173                 return retval;
174
175         return hl_interface_init_target(t);
176 }
177
178 static int hl_jtag_transport_select(struct command_context *cmd_ctx)
179 {
180         LOG_DEBUG("hl_jtag_transport_select");
181
182         /* NOTE:  interface init must already have been done.
183          * That works with only C code ... no Tcl glue required.
184          */
185
186         return register_commands(cmd_ctx, NULL, hl_jtag_transport_command_handlers);
187 }
188
189 static int hl_swd_transport_select(struct command_context *cmd_ctx)
190 {
191         LOG_DEBUG("hl_swd_transport_select");
192         return register_commands(cmd_ctx, NULL, hl_swd_transport_command_handlers);
193 }
194
195 static struct transport hl_swd_transport = {
196         .name = "hla_swd",
197         .select = hl_swd_transport_select,
198         .init = hl_transport_init,
199         .override_target = hl_interface_override_target,
200 };
201
202 static struct transport hl_jtag_transport = {
203         .name = "hla_jtag",
204         .select = hl_jtag_transport_select,
205         .init = hl_transport_init,
206         .override_target = hl_interface_override_target,
207 };
208
209 const char *hl_transports[] = { "hla_swd", "hla_jtag", NULL };
210
211 static void hl_constructor(void) __attribute__ ((constructor));
212 static void hl_constructor(void)
213 {
214         transport_register(&hl_swd_transport);
215         transport_register(&hl_jtag_transport);
216 }
217
218 bool transport_is_hla(void)
219 {
220         struct transport *t;
221         t = get_current_transport();
222         return t == &hl_swd_transport || t == &hl_jtag_transport;
223 }