src/jtag/hla: free allocated memory in hl_interface_quit()
[fw/openocd] / src / jtag / hla / hla_interface.c
index eb9b43dc69c07a6da827972ec59e82f119d1e345..cb9ef3969021f382b8c621dc19a64b4d7c53ffa5 100644 (file)
@@ -16,9 +16,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 
 #include <target/target.h>
 
-static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, 0}, 0, 0 };
+static struct hl_interface_s hl_if = { {0, 0, { 0 }, { 0 }, 0, HL_TRANSPORT_UNKNOWN, false, -1}, 0, 0 };
 
 int hl_interface_open(enum hl_transports tr)
 {
        LOG_DEBUG("hl_interface_open");
 
+       enum reset_types jtag_reset_config = jtag_get_reset_config();
+
+       if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
+               if (jtag_reset_config & RESET_SRST_NO_GATING)
+                       hl_if.param.connect_under_reset = true;
+               else
+                       LOG_WARNING("\'srst_nogate\' reset_config option is required");
+       }
+
        /* set transport mode */
        hl_if.param.transport = tr;
 
@@ -63,7 +70,7 @@ int hl_interface_init_target(struct target *t)
         * can setup the private pointer in the tap structure
         * if the interface match the tap idcode
         */
-       res = hl_if.layout->api->idcode(hl_if.fd, &t->tap->idcode);
+       res = hl_if.layout->api->idcode(hl_if.handle, &t->tap->idcode);
 
        if (res != ERROR_OK)
                return res;
@@ -75,15 +82,19 @@ int hl_interface_init_target(struct target *t)
                uint32_t expected = t->tap->expected_ids[ii];
 
                /* treat "-expected-id 0" as a "don't-warn" wildcard */
-               if (!expected || (t->tap->idcode == expected)) {
+               if (!expected || !t->tap->idcode ||
+                   (t->tap->idcode == expected)) {
                        found = 1;
                        break;
                }
        }
 
        if (found == 0) {
-               LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08x",
-                               t->tap->idcode);
+               LOG_WARNING("UNEXPECTED idcode: 0x%08" PRIx32, t->tap->idcode);
+               for (ii = 0; ii < limit; ii++)
+                       LOG_ERROR("expected %u of %u: 0x%08" PRIx32, ii + 1, limit,
+                               t->tap->expected_ids[ii]);
+
                return ERROR_FAIL;
        }
 
@@ -105,50 +116,103 @@ static int hl_interface_quit(void)
 {
        LOG_DEBUG("hl_interface_quit");
 
+       if (hl_if.layout->api->close)
+               hl_if.layout->api->close(hl_if.handle);
+
+       jtag_command_queue_reset();
+
+       free((void *)hl_if.param.device_desc);
+       free((void *)hl_if.param.serial);
+
        return ERROR_OK;
 }
 
-static int hl_interface_speed(int speed)
+static int hl_interface_execute_queue(void)
 {
-       LOG_DEBUG("hl_interface_speed: ignore speed %d", speed);
+       LOG_DEBUG("hl_interface_execute_queue: ignored");
 
        return ERROR_OK;
 }
 
-static int hl_speed_div(int speed, int *khz)
+int hl_interface_init_reset(void)
 {
-       *khz = speed;
+       /* incase the adapter has not already handled asserting srst
+        * we will attempt it again */
+       if (hl_if.param.connect_under_reset) {
+               jtag_add_reset(0, 1);
+               hl_if.layout->api->assert_srst(hl_if.handle, 0);
+       } else {
+               jtag_add_reset(0, 0);
+       }
+
        return ERROR_OK;
 }
 
-static int hl_khz(int khz, int *jtag_speed)
+static int hl_interface_khz(int khz, int *jtag_speed)
 {
-       *jtag_speed = khz;
+       if (hl_if.layout->api->speed == NULL)
+               return ERROR_OK;
+
+       *jtag_speed = hl_if.layout->api->speed(hl_if.handle, khz, true);
        return ERROR_OK;
 }
 
-static int hl_interface_execute_queue(void)
+static int hl_interface_speed_div(int speed, int *khz)
 {
-       LOG_DEBUG("hl_interface_execute_queue: ignored");
-
+       *khz = speed;
        return ERROR_OK;
 }
 
-int hl_interface_init_reset(void)
+static int hl_interface_speed(int speed)
 {
-       enum reset_types jtag_reset_config = jtag_get_reset_config();
+       if (hl_if.layout->api->speed == NULL)
+               return ERROR_OK;
 
-       if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
-               if (jtag_reset_config & RESET_SRST_NO_GATING) {
-                       jtag_add_reset(0, 1);
-                       hl_if.layout->api->assert_srst(hl_if.fd, 0);
+       if (hl_if.handle == NULL) {
+               /* pass speed as initial param as interface not open yet */
+               hl_if.param.initial_interface_speed = speed;
+               return ERROR_OK;
+       }
+
+       hl_if.layout->api->speed(hl_if.handle, speed, false);
+
+       return ERROR_OK;
+}
+
+int hl_interface_override_target(const char **targetname)
+{
+       if (hl_if.layout->api->override_target) {
+               if (hl_if.layout->api->override_target(*targetname)) {
+                       *targetname = "hla_target";
+                       return ERROR_OK;
                } else
-                       LOG_WARNING("\'srst_nogate\' reset_config option is required");
+                       return ERROR_FAIL;
+       }
+       return ERROR_FAIL;
+}
+
+int hl_interface_config_trace(bool enabled, enum tpio_pin_protocol pin_protocol,
+                             uint32_t port_size, unsigned int *trace_freq)
+{
+       if (hl_if.layout->api->config_trace)
+               return hl_if.layout->api->config_trace(hl_if.handle, enabled, pin_protocol,
+                                                      port_size, trace_freq);
+       else if (enabled) {
+               LOG_ERROR("The selected interface does not support tracing");
+               return ERROR_FAIL;
        }
 
        return ERROR_OK;
 }
 
+int hl_interface_poll_trace(uint8_t *buf, size_t *size)
+{
+       if (hl_if.layout->api->poll_trace)
+               return hl_if.layout->api->poll_trace(hl_if.handle, buf, size);
+
+       return ERROR_FAIL;
+}
+
 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
 {
        LOG_DEBUG("hl_interface_handle_device_desc_command");
@@ -205,30 +269,42 @@ COMMAND_HANDLER(hl_interface_handle_layout_command)
 
 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
 {
-       LOG_DEBUG("hl_interface_handle_vid_pid_command");
-
-       if (CMD_ARGC != 2) {
-               LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
+       if (CMD_ARGC > HLA_MAX_USB_IDS * 2) {
+               LOG_WARNING("ignoring extra IDs in hla_vid_pid "
+                       "(maximum is %d pairs)", HLA_MAX_USB_IDS);
+               CMD_ARGC = HLA_MAX_USB_IDS * 2;
+       }
+       if (CMD_ARGC < 2 || (CMD_ARGC & 1)) {
+               LOG_WARNING("incomplete hla_vid_pid configuration directive");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
-       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
+       unsigned i;
+       for (i = 0; i < CMD_ARGC; i += 2) {
+               COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i], hl_if.param.vid[i / 2]);
+               COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], hl_if.param.pid[i / 2]);
+       }
+
+       /*
+        * Explicitly terminate, in case there are multiple instances of
+        * hla_vid_pid.
+        */
+       hl_if.param.vid[i / 2] = hl_if.param.pid[i / 2] = 0;
 
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(stlink_interface_handle_api_command)
+COMMAND_HANDLER(interface_handle_hla_command)
 {
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       unsigned new_api;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
-       if ((new_api == 0) || (new_api > 2))
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       if (!hl_if.layout->api->custom_command) {
+               LOG_ERROR("The selected adapter doesn't support custom commands");
+               return ERROR_FAIL;
+       }
 
-       hl_if.param.api = new_api;
+       hl_if.layout->api->custom_command(hl_if.handle, CMD_ARGV[0]);
 
        return ERROR_OK;
 }
@@ -263,11 +339,11 @@ static const struct command_registration hl_interface_command_handlers[] = {
         .usage = "(vid pid)* ",
         },
         {
-        .name = "stlink_api",
-        .handler = &stlink_interface_handle_api_command,
-        .mode = COMMAND_CONFIG,
-        .help = "set the desired stlink api level",
-        .usage = "api version 1 or 2",
+        .name = "hla_command",
+        .handler = &interface_handle_hla_command,
+        .mode = COMMAND_EXEC,
+        .help = "execute a custom adapter-specific command",
+        .usage = "hla_command <command>",
         },
        COMMAND_REGISTRATION_DONE
 };
@@ -279,8 +355,10 @@ struct jtag_interface hl_interface = {
        .transports = hl_transports,
        .init = hl_interface_init,
        .quit = hl_interface_quit,
-       .speed = hl_interface_speed,
-       .speed_div = hl_speed_div,
-       .khz = hl_khz,
        .execute_queue = hl_interface_execute_queue,
+       .speed = &hl_interface_speed,
+       .khz = &hl_interface_khz,
+       .speed_div = &hl_interface_speed_div,
+       .config_trace = &hl_interface_config_trace,
+       .poll_trace = &hl_interface_poll_trace,
 };