src/jtag/commands.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2009 Zachary T Welch                                    *
   9  *   zw@superlucidity.net                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef JTAG_COMMANDS_H
  27 #define JTAG_COMMANDS_H
  28
  29 #include "jtag.h"
  30
  31 /**
  32  * The inferred type of a scan_command_s structure, indicating whether
  33  * the command has the host scan in from the device, the host scan out
  34  * to the device, or both.
  35  */
  36 enum scan_type {
  37         /// From device to host,
  38         SCAN_IN = 1,
  39         /// From host to device,
  40         SCAN_OUT = 2,
  41         /// Full-duplex scan.
  42         SCAN_IO = 3
  43 };
  44
  45 /**
  46  * The scan_command provide a means of encapsulating a set of scan_field_s
  47  * structures that should be scanned in/out to the device.
  48  */
  49 struct scan_command {
  50         /// instruction/not data scan
  51         bool ir_scan;
  52         /// number of fields in *fields array
  53         int num_fields;
  54         /// pointer to an array of data scan fields
  55         struct scan_field* fields;
  56         /// state in which JTAG commands should finish
  57         tap_state_t end_state;
  58 };
  59
  60 struct statemove_command {
  61         /// state in which JTAG commands should finish
  62         tap_state_t end_state;
  63 };
  64
  65 struct pathmove_command {
  66         /// number of states in *path
  67         int num_states;
  68         /// states that have to be passed
  69         tap_state_t* path;
  70 };
  71
  72 struct runtest_command {
  73         /// number of cycles to spend in Run-Test/Idle state
  74         int num_cycles;
  75         /// state in which JTAG commands should finish
  76         tap_state_t end_state;
  77 };
  78
  79
  80 struct stableclocks_command {
  81         /// number of clock cycles that should be sent
  82         int num_cycles;
  83 };
  84
  85
  86 typedef struct reset_command_s
  87 {
  88         /// Set TRST output: 0 = deassert, 1 = assert, -1 = no change
  89         int trst;
  90         /// Set SRST output: 0 = deassert, 1 = assert, -1 = no change
  91         int srst;
  92 } reset_command_t;
  93
  94 typedef struct end_state_command_s
  95 {
  96         /// state in which JTAG commands should finish
  97         tap_state_t end_state;
  98 } end_state_command_t;
  99
 100 typedef struct sleep_command_s
 101 {
 102         /// number of microseconds to sleep
 103         uint32_t us;
 104 } sleep_command_t;
 105
 106 /**
 107  * Defines a container type that hold a pointer to a JTAG command
 108  * structure of any defined type.
 109  */
 110 typedef union jtag_command_container_u
 111 {
 112         struct scan_command*         scan;
 113         struct statemove_command*    statemove;
 114         struct pathmove_command*     pathmove;
 115         struct runtest_command*      runtest;
 116         struct stableclocks_command* stableclocks;
 117         reset_command_t*        reset;
 118         end_state_command_t*    end_state;
 119         sleep_command_t* sleep;
 120 } jtag_command_container_t;
 121
 122 /**
 123  * The type of the @c jtag_command_container_u contained by a
 124  * @c jtag_command_s structure.
 125  */
 126 enum jtag_command_type {
 127         JTAG_SCAN         = 1,
 128         JTAG_STATEMOVE    = 2,
 129         JTAG_RUNTEST      = 3,
 130         JTAG_RESET        = 4,
 131         JTAG_PATHMOVE     = 6,
 132         JTAG_SLEEP        = 7,
 133         JTAG_STABLECLOCKS = 8
 134 };
 135
 136 typedef struct jtag_command_s
 137 {
 138         jtag_command_container_t cmd;
 139         enum jtag_command_type   type;
 140         struct jtag_command_s*   next;
 141 } jtag_command_t;
 142
 143 /// The current queue of jtag_command_s structures.
 144 extern jtag_command_t* jtag_command_queue;
 145
 146 void* cmd_queue_alloc(size_t size);
 147 void cmd_queue_free(void);
 148
 149 void jtag_queue_command(jtag_command_t *cmd);
 150 void jtag_command_queue_reset(void);
 151
 152 enum scan_type jtag_scan_type(const struct scan_command* cmd);
 153 int jtag_scan_size(const struct scan_command* cmd);
 154 int jtag_read_buffer(uint8_t* buffer, const struct scan_command* cmd);
 155 int jtag_build_buffer(const struct scan_command* cmd, uint8_t** buffer);
 156
 157 #endif // JTAG_COMMANDS_H