openocd: remove NULL comparisons with checkpatch [1/2]
[fw/openocd] / src / jtag / drivers / driver.c
index fece0f1ef9d803b7b109fd071d2adecd6c23fe2e..dbe3b0819b538f2645eed717a40eb793503b1e79 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2009 SoftPLC Corporation                                *
  *   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 "config.h"
 #endif
 
+#include <jtag/jtag.h>
 #include <jtag/interface.h>
-#include "minidriver.h"
+#include <jtag/commands.h>
+#include <jtag/minidriver.h>
 #include <helper/command.h>
 
-struct jtag_callback_entry
-{
+struct jtag_callback_entry {
        struct jtag_callback_entry *next;
 
        jtag_callback_t callback;
@@ -46,8 +46,8 @@ struct jtag_callback_entry
        jtag_callback_data_t data3;
 };
 
-static struct jtag_callback_entry *jtag_callback_queue_head = NULL;
-static struct jtag_callback_entry *jtag_callback_queue_tail = NULL;
+static struct jtag_callback_entry *jtag_callback_queue_head;
+static struct jtag_callback_entry *jtag_callback_queue_tail;
 
 static void jtag_callback_queue_reset(void)
 {
@@ -55,81 +55,49 @@ static void jtag_callback_queue_reset(void)
        jtag_callback_queue_tail = NULL;
 }
 
-/**
- * Copy a struct scan_field for insertion into the queue.
- *
- * This allocates a new copy of out_value using cmd_queue_alloc.
- */
-static void cmd_queue_scan_field_clone(struct scan_field * dst, const struct scan_field * src)
-{
-       dst->tap                = src->tap;
-       dst->num_bits   = src->num_bits;
-       dst->out_value  = buf_cpy(src->out_value, cmd_queue_alloc(DIV_ROUND_UP(src->num_bits, 8)), src->num_bits);
-       dst->in_value   = src->in_value;
-}
-
-
 /**
  * see jtag_add_ir_scan()
  *
  */
-int interface_jtag_add_ir_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
+int interface_jtag_add_ir_scan(struct jtag_tap *active,
+               const struct scan_field *in_fields, tap_state_t state)
 {
        size_t num_taps = jtag_tap_count_enabled();
 
-       struct jtag_command * cmd               = cmd_queue_alloc(sizeof(struct jtag_command));
-       struct scan_command * scan              = cmd_queue_alloc(sizeof(struct scan_command));
-       struct scan_field * out_fields  = cmd_queue_alloc(num_taps  * sizeof(struct scan_field));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct scan_command *scan = cmd_queue_alloc(sizeof(struct scan_command));
+       struct scan_field *out_fields = cmd_queue_alloc(num_taps  * sizeof(struct scan_field));
 
        jtag_queue_command(cmd);
 
-       cmd->type                               = JTAG_SCAN;
-       cmd->cmd.scan                   = scan;
-
-       scan->ir_scan                   = true;
-       scan->num_fields                = num_taps;     /* one field per device */
-       scan->fields                    = out_fields;
-       scan->end_state                 = state;
+       cmd->type = JTAG_SCAN;
+       cmd->cmd.scan = scan;
 
+       scan->ir_scan = true;
+       scan->num_fields = num_taps;    /* one field per device */
+       scan->fields = out_fields;
+       scan->end_state = state;
 
-       struct scan_field * field = out_fields; /* keep track where we insert data */
+       struct scan_field *field = out_fields;  /* keep track where we insert data */
 
        /* loop over all enabled TAPs */
 
-       for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
-       {
+       for (struct jtag_tap *tap = jtag_tap_next_enabled(NULL); tap; tap = jtag_tap_next_enabled(tap)) {
                /* search the input field list for fields for the current TAP */
 
-               bool found = false;
-
-               for (int j = 0; j < in_num_fields; j++)
-               {
-                       if (tap != in_fields[j].tap)
-                               continue;
-
+               if (tap == active) {
                        /* if TAP is listed in input fields, copy the value */
-
-                       found = true;
-
                        tap->bypass = 0;
 
-                       assert(in_fields[j].num_bits == tap->ir_length); /* input fields must have the same length as the TAP's IR */
-
-                       cmd_queue_scan_field_clone(field, in_fields + j);
-
-                       break;
-               }
-
-               if (!found)
-               {
+                       jtag_scan_field_clone(field, in_fields);
+               } else {
                        /* if a TAP isn't listed in input fields, set it to BYPASS */
 
                        tap->bypass = 1;
 
-                       field->tap                      = tap;
-                       field->num_bits         = tap->ir_length;
-                       field->out_value        = buf_set_ones(cmd_queue_alloc(DIV_ROUND_UP(tap->ir_length, 8)), tap->ir_length);
-                       field->in_value         = NULL; /* do not collect input for tap's in bypass */
+                       field->num_bits = tap->ir_length;
+                       field->out_value = buf_set_ones(cmd_queue_alloc(DIV_ROUND_UP(tap->ir_length, 8)), tap->ir_length);
+                       field->in_value = NULL; /* do not collect input for tap's in bypass */
                }
 
                /* update device information */
@@ -137,90 +105,58 @@ int interface_jtag_add_ir_scan(int in_num_fields, const struct scan_field *in_fi
 
                field++;
        }
-
-       assert(field == out_fields + num_taps); /* paranoia: jtag_tap_count_enabled() and jtag_tap_next_enabled() not in sync */
-
-       return ERROR_OK;
-}
-
-/**
- * see jtag_add_plain_ir_scan()
- *
- */
-int interface_jtag_add_plain_ir_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
-{
-
-       struct jtag_command * cmd               = cmd_queue_alloc(sizeof(struct jtag_command));
-       struct scan_command * scan              = cmd_queue_alloc(sizeof(struct scan_command));
-       struct scan_field * out_fields  = cmd_queue_alloc(in_num_fields * sizeof(struct scan_field));
-
-       jtag_queue_command(cmd);
-
-       cmd->type                               = JTAG_SCAN;
-       cmd->cmd.scan                   = scan;
-
-       scan->ir_scan                   = true;
-       scan->num_fields                = in_num_fields;
-       scan->fields                    = out_fields;
-       scan->end_state                 = state;
-
-       for (int i = 0; i < in_num_fields; i++)
-               cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
+       /* paranoia: jtag_tap_count_enabled() and jtag_tap_next_enabled() not in sync */
+       assert(field == out_fields + num_taps);
 
        return ERROR_OK;
 }
 
-
-
 /**
  * see jtag_add_dr_scan()
  *
  */
-int interface_jtag_add_dr_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
+int interface_jtag_add_dr_scan(struct jtag_tap *active, int in_num_fields,
+               const struct scan_field *in_fields, tap_state_t state)
 {
        /* count devices in bypass */
 
        size_t bypass_devices = 0;
 
-       for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
-       {
+       for (struct jtag_tap *tap = jtag_tap_next_enabled(NULL); tap; tap = jtag_tap_next_enabled(tap)) {
                if (tap->bypass)
                        bypass_devices++;
        }
 
-       struct jtag_command * cmd               = cmd_queue_alloc(sizeof(struct jtag_command));
-       struct scan_command * scan              = cmd_queue_alloc(sizeof(struct scan_command));
-       struct scan_field * out_fields  = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(struct scan_field));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct scan_command *scan = cmd_queue_alloc(sizeof(struct scan_command));
+       struct scan_field *out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(struct scan_field));
 
        jtag_queue_command(cmd);
 
-       cmd->type                               = JTAG_SCAN;
-       cmd->cmd.scan                   = scan;
+       cmd->type = JTAG_SCAN;
+       cmd->cmd.scan = scan;
 
-       scan->ir_scan                   = false;
-       scan->num_fields                = in_num_fields + bypass_devices;
-       scan->fields                    = out_fields;
-       scan->end_state                 = state;
+       scan->ir_scan = false;
+       scan->num_fields = in_num_fields + bypass_devices;
+       scan->fields = out_fields;
+       scan->end_state = state;
 
-
-       struct scan_field * field = out_fields; /* keep track where we insert data */
+       struct scan_field *field = out_fields;  /* keep track where we insert data */
 
        /* loop over all enabled TAPs */
 
-       for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
-       {
+       for (struct jtag_tap *tap = jtag_tap_next_enabled(NULL); tap; tap = jtag_tap_next_enabled(tap)) {
                /* if TAP is not bypassed insert matching input fields */
 
-               if (!tap->bypass)
-               {
-                       struct scan_field * start_field = field;        /* keep initial position for assert() */
-
-                       for (int j = 0; j < in_num_fields; j++)
-                       {
-                               if (tap != in_fields[j].tap)
-                                       continue;
+               if (!tap->bypass) {
+                       assert(active == tap);
+#ifndef NDEBUG
+                       /* remember initial position for assert() */
+                       struct scan_field *start_field = field;
+#endif /* NDEBUG */
 
-                               cmd_queue_scan_field_clone(field, in_fields + j);
+                       for (int j = 0; j < in_num_fields; j++) {
+                               jtag_scan_field_clone(field, in_fields + j);
 
                                field++;
                        }
@@ -229,12 +165,10 @@ int interface_jtag_add_dr_scan(int in_num_fields, const struct scan_field *in_fi
                }
 
                /* if a TAP is bypassed, generated a dummy bit*/
-               else
-               {
-                       field->tap                      = tap;
-                       field->num_bits         = 1;
-                       field->out_value        = NULL;
-                       field->in_value         = NULL;
+               else {
+                       field->num_bits = 1;
+                       field->out_value = NULL;
+                       field->in_value = NULL;
 
                        field++;
                }
@@ -245,140 +179,78 @@ int interface_jtag_add_dr_scan(int in_num_fields, const struct scan_field *in_fi
        return ERROR_OK;
 }
 
-
-
-/**
- * Generate a DR SCAN using the array of output values passed to the function
- *
- * This function assumes that the parameter target_tap specifies the one TAP
- * that is not bypassed. All other TAPs must be bypassed and the function will
- * generate a dummy 1bit field for them.
- *
- * For the target_tap a sequence of output-only fields will be generated where
- * each field has the size num_bits and the field's values are taken from
- * the array value.
- *
- * The bypass status of TAPs is set by jtag_add_ir_scan().
- *
- */
-void interface_jtag_add_dr_out(struct jtag_tap *target_tap,
-               int in_num_fields,
-               const int *num_bits,
-               const uint32_t *value,
-               tap_state_t end_state)
+static int jtag_add_plain_scan(int num_bits, const uint8_t *out_bits,
+               uint8_t *in_bits, tap_state_t state, bool ir_scan)
 {
-       /* count devices in bypass */
-
-       size_t bypass_devices = 0;
-
-       for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
-       {
-               if (tap->bypass)
-                       bypass_devices++;
-       }
-
-
-       struct jtag_command * cmd               = cmd_queue_alloc(sizeof(struct jtag_command));
-       struct scan_command * scan              = cmd_queue_alloc(sizeof(struct scan_command));
-       struct scan_field * out_fields  = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(struct scan_field));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct scan_command *scan = cmd_queue_alloc(sizeof(struct scan_command));
+       struct scan_field *out_fields = cmd_queue_alloc(sizeof(struct scan_field));
 
        jtag_queue_command(cmd);
 
-       cmd->type                               = JTAG_SCAN;
-       cmd->cmd.scan                   = scan;
-
-       scan->ir_scan                   = false;
-       scan->num_fields                = in_num_fields + bypass_devices;
-       scan->fields                    = out_fields;
-       scan->end_state                 = end_state;
-
-
-       bool target_tap_match   = false;
-
-       struct scan_field * field = out_fields; /* keep track where we insert data */
-
-       /* loop over all enabled TAPs */
-
-       for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
-       {
-               /* if TAP is not bypassed insert matching input fields */
-
-               if (!tap->bypass)
-               {
-                       assert(tap == target_tap); /* target_tap must match the one not bypassed TAP */
+       cmd->type = JTAG_SCAN;
+       cmd->cmd.scan = scan;
 
-                       target_tap_match = true;
+       scan->ir_scan = ir_scan;
+       scan->num_fields = 1;
+       scan->fields = out_fields;
+       scan->end_state = state;
 
-                       for (int j = 0; j < in_num_fields; j++)
-                       {
-                               uint8_t out_value[4];
-                               size_t scan_size = num_bits[j];
-                               buf_set_u32(out_value, 0, scan_size, value[j]);
+       out_fields->num_bits = num_bits;
+       out_fields->out_value = buf_cpy(out_bits, cmd_queue_alloc(DIV_ROUND_UP(num_bits, 8)), num_bits);
+       out_fields->in_value = in_bits;
 
-                               field->tap                      = tap;
-                               field->num_bits         = scan_size;
-                               field->out_value        = buf_cpy(out_value, cmd_queue_alloc(DIV_ROUND_UP(scan_size, 8)), scan_size);
-                               field->in_value         = NULL;
-
-                               field++;
-                       }
-               }
-
-               /* if a TAP is bypassed, generated a dummy bit*/
-               else
-               {
-
-                       field->tap                              = tap;
-                       field->num_bits                 = 1;
-                       field->out_value                = NULL;
-                       field->in_value                 = NULL;
+       return ERROR_OK;
+}
 
-                       field++;
-               }
-       }
+int interface_jtag_add_plain_dr_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits, tap_state_t state)
+{
+       return jtag_add_plain_scan(num_bits, out_bits, in_bits, state, false);
+}
 
-       assert(target_tap_match);       /* target_tap should be enabled and not bypassed */
+int interface_jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits, tap_state_t state)
+{
+       return jtag_add_plain_scan(num_bits, out_bits, in_bits, state, true);
 }
 
-/**
- * see jtag_add_plain_dr_scan()
- *
- */
-int interface_jtag_add_plain_dr_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
+int interface_jtag_add_tlr(void)
 {
-       struct jtag_command * cmd               = cmd_queue_alloc(sizeof(struct jtag_command));
-       struct scan_command * scan              = cmd_queue_alloc(sizeof(struct scan_command));
-       struct scan_field * out_fields  = cmd_queue_alloc(in_num_fields * sizeof(struct scan_field));
+       tap_state_t state = TAP_RESET;
 
-       jtag_queue_command(cmd);
+       /* allocate memory for a new list member */
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
 
-       cmd->type                               = JTAG_SCAN;
-       cmd->cmd.scan                   = scan;
+       jtag_queue_command(cmd);
 
-       scan->ir_scan                   = false;
-       scan->num_fields                = in_num_fields;
-       scan->fields                    = out_fields;
-       scan->end_state                 = state;
+       cmd->type = JTAG_TLR_RESET;
 
-       for (int i = 0; i < in_num_fields; i++)
-               cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
+       cmd->cmd.statemove = cmd_queue_alloc(sizeof(struct statemove_command));
+       cmd->cmd.statemove->end_state = state;
 
        return ERROR_OK;
 }
 
-int interface_jtag_add_tlr(void)
+int interface_add_tms_seq(unsigned num_bits, const uint8_t *seq, enum tap_state state)
 {
-       tap_state_t state = TAP_RESET;
+       struct jtag_command *cmd;
 
-       /* allocate memory for a new list member */
-       struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       if (!cmd)
+               return ERROR_FAIL;
 
-       jtag_queue_command(cmd);
+       cmd->type = JTAG_TMS;
+       cmd->cmd.tms = cmd_queue_alloc(sizeof(*cmd->cmd.tms));
+       if (!cmd->cmd.tms)
+               return ERROR_FAIL;
 
-       cmd->type = JTAG_STATEMOVE;
+       /* copy the bits; our caller doesn't guarantee they'll persist */
+       cmd->cmd.tms->num_bits = num_bits;
+       cmd->cmd.tms->bits = buf_cpy(seq,
+                       cmd_queue_alloc(DIV_ROUND_UP(num_bits, 8)), num_bits);
+       if (!cmd->cmd.tms->bits)
+               return ERROR_FAIL;
 
-       cmd->cmd.statemove = cmd_queue_alloc(sizeof(struct statemove_command));
-       cmd->cmd.statemove->end_state = state;
+       jtag_queue_command(cmd);
 
        return ERROR_OK;
 }
@@ -386,7 +258,7 @@ int interface_jtag_add_tlr(void)
 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
 {
        /* allocate memory for a new list member */
-       struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
 
        jtag_queue_command(cmd);
 
@@ -405,7 +277,7 @@ int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
 {
        /* allocate memory for a new list member */
-       struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
 
        jtag_queue_command(cmd);
 
@@ -421,7 +293,7 @@ int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
 int interface_jtag_add_clocks(int num_cycles)
 {
        /* allocate memory for a new list member */
-       struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
 
        jtag_queue_command(cmd);
 
@@ -436,7 +308,7 @@ int interface_jtag_add_clocks(int num_cycles)
 int interface_jtag_add_reset(int req_trst, int req_srst)
 {
        /* allocate memory for a new list member */
-       struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
 
        jtag_queue_command(cmd);
 
@@ -452,7 +324,7 @@ int interface_jtag_add_reset(int req_trst, int req_srst)
 int interface_jtag_add_sleep(uint32_t us)
 {
        /* allocate memory for a new list member */
-       struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
+       struct jtag_command *cmd = cmd_queue_alloc(sizeof(struct jtag_command));
 
        jtag_queue_command(cmd);
 
@@ -465,7 +337,9 @@ int interface_jtag_add_sleep(uint32_t us)
 }
 
 /* add callback to end of queue */
-void interface_jtag_add_callback4(jtag_callback_t callback, jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
+void interface_jtag_add_callback4(jtag_callback_t callback,
+               jtag_callback_data_t data0, jtag_callback_data_t data1,
+               jtag_callback_data_t data2, jtag_callback_data_t data3)
 {
        struct jtag_callback_entry *entry = cmd_queue_alloc(sizeof(struct jtag_callback_entry));
 
@@ -476,12 +350,10 @@ void interface_jtag_add_callback4(jtag_callback_t callback, jtag_callback_data_t
        entry->data2 = data2;
        entry->data3 = data3;
 
-       if (jtag_callback_queue_head == NULL)
-       {
+       if (!jtag_callback_queue_head) {
                jtag_callback_queue_head = entry;
                jtag_callback_queue_tail = entry;
-       } else
-       {
+       } else {
                jtag_callback_queue_tail->next = entry;
                jtag_callback_queue_tail = entry;
        }
@@ -489,17 +361,15 @@ void interface_jtag_add_callback4(jtag_callback_t callback, jtag_callback_data_t
 
 int interface_jtag_execute_queue(void)
 {
-       static int reentry = 0;
+       static int reentry;
 
-       assert(reentry==0);
+       assert(reentry == 0);
        reentry++;
 
        int retval = default_interface_jtag_execute_queue();
-       if (retval == ERROR_OK)
-       {
+       if (retval == ERROR_OK) {
                struct jtag_callback_entry *entry;
-               for (entry = jtag_callback_queue_head; entry != NULL; entry = entry->next)
-               {
+               for (entry = jtag_callback_queue_head; entry; entry = entry->next) {
                        retval = entry->callback(entry->data0, entry->data1, entry->data2, entry->data3);
                        if (retval != ERROR_OK)
                                break;
@@ -514,7 +384,8 @@ int interface_jtag_execute_queue(void)
        return retval;
 }
 
-static int jtag_convert_to_callback4(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
+static int jtag_convert_to_callback4(jtag_callback_data_t data0,
+               jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
 {
        ((jtag_callback1_t)data1)(data0);
        return ERROR_OK;
@@ -525,3 +396,14 @@ void interface_jtag_add_callback(jtag_callback1_t callback, jtag_callback_data_t
        jtag_add_callback4(jtag_convert_to_callback4, data0, (jtag_callback_data_t)callback, 0, 0);
 }
 
+void jtag_add_callback(jtag_callback1_t f, jtag_callback_data_t data0)
+{
+       interface_jtag_add_callback(f, data0);
+}
+
+void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
+               jtag_callback_data_t data1, jtag_callback_data_t data2,
+               jtag_callback_data_t data3)
+{
+       interface_jtag_add_callback4(f, data0, data1, data2, data3);
+}