From 2eb4cd9162ebef031bdea041177fa5130247e13a Mon Sep 17 00:00:00 2001
From: Philippe Teuwen <phil@teuwen.org>
Date: Wed, 1 May 2019 01:31:29 +0200
Subject: [PATCH] jtag comments

---
 tools/jtag_openocd/interface-armusbocd.cfg   | 4 ++--
 tools/jtag_openocd/interface-busblaster.cfg  | 2 +-
 tools/jtag_openocd/interface-buspirate.cfg   | 2 +-
 tools/jtag_openocd/interface-jlink.cfg       | 3 ++-
 tools/jtag_openocd/interface-jtagkey.cfg     | 4 ++--
 tools/jtag_openocd/interface-wiggler.cfg     | 1 +
 tools/jtag_openocd/openocd_flash_recovery.sh | 2 +-
 7 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/tools/jtag_openocd/interface-armusbocd.cfg b/tools/jtag_openocd/interface-armusbocd.cfg
index 4f5c6bb93..e4689e21b 100644
--- a/tools/jtag_openocd/interface-armusbocd.cfg
+++ b/tools/jtag_openocd/interface-armusbocd.cfg
@@ -1,8 +1,8 @@
-#define our ports
+# Ports
 telnet_port 4444
 gdb_port 3333
 
-#commands specific to the Olimex ARM-USB-OCD Dongle
+# Commands specific to the Olimex ARM-USB-OCD Dongle
 interface ft2232
 ft2232_device_desc "Olimex OpenOCD JTAG"
 ft2232_layout "olimex-jtag"
diff --git a/tools/jtag_openocd/interface-busblaster.cfg b/tools/jtag_openocd/interface-busblaster.cfg
index 4d3ac032e..337e9a2de 100644
--- a/tools/jtag_openocd/interface-busblaster.cfg
+++ b/tools/jtag_openocd/interface-busblaster.cfg
@@ -1,8 +1,8 @@
-## General OpenOCD configuration
 # Ports
 telnet_port 4444
 gdb_port 3333
 
+# Commands specific to the Bus Blaster
 interface ftdi
 ftdi_device_desc "Dual RS232-HS"
 ftdi_vid_pid 0x0403 0x6010
diff --git a/tools/jtag_openocd/interface-buspirate.cfg b/tools/jtag_openocd/interface-buspirate.cfg
index 66d0ce614..4ed5b88a5 100644
--- a/tools/jtag_openocd/interface-buspirate.cfg
+++ b/tools/jtag_openocd/interface-buspirate.cfg
@@ -2,7 +2,7 @@
 telnet_port 4444
 gdb_port 3333
 
-# Interface
+# Commands specific to the BusPirate
 interface buspirate
 buspirate_port /dev/ttyUSB0
 adapter_khz 1000
diff --git a/tools/jtag_openocd/interface-jlink.cfg b/tools/jtag_openocd/interface-jlink.cfg
index fe6c892f8..56a04fef2 100644
--- a/tools/jtag_openocd/interface-jlink.cfg
+++ b/tools/jtag_openocd/interface-jlink.cfg
@@ -1,7 +1,8 @@
-#define our ports
+# Ports
 telnet_port 4444
 gdb_port 3333
 
+# Commands specific to the Segger J-Link
 interface jlink
 transport select jtag
 adapter_khz 1000
diff --git a/tools/jtag_openocd/interface-jtagkey.cfg b/tools/jtag_openocd/interface-jtagkey.cfg
index 305dfd7da..3e48c08df 100644
--- a/tools/jtag_openocd/interface-jtagkey.cfg
+++ b/tools/jtag_openocd/interface-jtagkey.cfg
@@ -1,8 +1,8 @@
-#define our ports
+# Ports
 telnet_port 4444
 gdb_port 3333
 
-#commands specific to the Amontec JTAGKey
+# Commands specific to the Amontec JTAGKey
 interface ft2232
 ft2232_device_desc "Amontec JTAGkey A"
 ft2232_layout jtagkey
diff --git a/tools/jtag_openocd/interface-wiggler.cfg b/tools/jtag_openocd/interface-wiggler.cfg
index 024ed9710..88448de82 100644
--- a/tools/jtag_openocd/interface-wiggler.cfg
+++ b/tools/jtag_openocd/interface-wiggler.cfg
@@ -1,6 +1,7 @@
 telnet_port 4444
 gdb_port 3333
 
+# Commands specific to the Wiggler
 interface parport
 parport_port 0x378
 parport_cable wiggler
diff --git a/tools/jtag_openocd/openocd_flash_recovery.sh b/tools/jtag_openocd/openocd_flash_recovery.sh
index 06a92990b..b51076d5a 100755
--- a/tools/jtag_openocd/openocd_flash_recovery.sh
+++ b/tools/jtag_openocd/openocd_flash_recovery.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Example for 512kb version, using Segger Jlink:
+# Example using Segger Jlink:
 CONFIG_CHIP=chip-at91sam7s.cfg
 CONFIG_IF=interface-jlink.cfg
 IMAGE=../../recovery/proxmark3_recovery.bin