util/find_usbdebug/find_usbdebug.sh

   1 #!/bin/bash
   2
   3 # Copyright 2008 Carl-Daniel Hailfinger
   4 # Copyright 2015 Stefan Tauner
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; version 2 of the License.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 LANG=C
  16 # Some tools emit errors that don't matter (bugs in lspci/PCI firmware and lsusb).
  17 # To shown them anyway (e.g. for debugging) comment next line.
  18 exec 2>/dev/null
  19
  20 if [ "$1" = "-h" ]; then
  21         printf "Usage: $0 [-h | path to dmesg log]
  22
  23 This script tries to find USB ports compatible with USB2/EHCI debug devices and
  24 helps you to find their physical locations. To that end, attach at least one
  25 uniquely identifiable device to a USB port and run this script. The device needs
  26 to be visible in the output of \"lsusb -t\" (debug devices are often *not*!).
  27
  28 After determining compatibility of the USB controllers the script will print the
  29 devices attached to the debug port as shown by lsusb. If nothing shows up simply
  30 switch ports and repeat the process.
  31
  32 Note: usually only one port is supported for debugging.\n"
  33         exit 0
  34 fi
  35 uid=`id -u`
  36 if [ "$uid" -ne 0 ]; then
  37         echo "Must be run as root. Exiting."
  38         exit 1
  39 fi
  40 dmesgfile=$1
  41
  42 find_devs_in_tree () {
  43         bus=$1
  44         port=$2
  45         busstr=`printf "Bus %02d" "$bus"`
  46         portstr="Port $port"
  47
  48         hubs_to_ignore="8087:0020 8087:0024"
  49         reqlvl=1
  50
  51         found=
  52         # Iterate over the output of lsusb -t because it contains the physical port numbers
  53         while IFS='' read -r line; do
  54                 # We need to keep track of the current bus "branch"
  55                 # Look out for lines starting with /: (that indicate a bus)
  56                 if [ "${line#*/:}" != "$line" ]; then
  57                         if [ "${line#*$busstr}" != "$line" ]; then
  58                                 cur_bus=$busstr
  59                         else
  60                                 cur_bus=
  61                         fi
  62                         continue
  63                 fi
  64
  65                 # Skip all lines not belonging to the wanted bus number
  66                 if [ "$cur_bus" != "$busstr" ]; then
  67                         continue
  68                 fi
  69
  70                 # Calculate current USB tier/level
  71                 spaces="${line%%[!' ']*}"
  72                 curlvl=$((${#spaces} / 4))
  73                 if [ $curlvl -ne $reqlvl ]; then
  74                         continue
  75                 fi
  76
  77                 # Fetch USB IDs of the current device
  78                 dev=`echo ${line#*Dev } | cut -d ',' -f 1`
  79                 lsusbline=`lsusb -s "$bus":"$dev"`
  80                 if [[ ! "$lsusbline" =~ .*([[:xdigit:]]{4}:[[:xdigit:]]{4}) ]]; then
  81                         printf "Unexpected output from \"%s\": \"%s\"\n" "lsusb -s $bus:$dev" "$usbline"
  82                         exit 1
  83                 fi
  84                 ids=${BASH_REMATCH[1]}
  85
  86                 # Skip over rate matching hubs
  87                 if [[ "$hubs_to_ignore" == *"$ids"* ]]; then
  88                         ((reqlvl += 1))
  89                         continue
  90                 fi
  91
  92                 # Check for matching physical USB port
  93                 if [ "${line#*$portstr}" != "$line" ]; then
  94                         echo "$lsusbline"
  95                         return
  96                 fi
  97         done<< EOF
  98 $(lsusb -t)
  99 EOF
 100         if [ -z "$found" ]; then
 101                 echo "none"
 102         fi
 103 }
 104
 105 debug_lspci_devs=`lspci -nvvD |
 106         grep -i "^[0-9a-f]\|debug port" |
 107         grep -iB1 --no-group-separator "debug port" |
 108         grep -vi "debug port" |
 109         cut -f 1 -d" " |
 110         sort |
 111         xargs echo`
 112
 113 if [ -z "$debug_lspci_devs" ]; then
 114         printf "No USB controller with debug capability found by lspci.\n
 115 Possible reasons: lspci too old, USB controller does not support a debug device, ... Exiting.\n"
 116         exit 1
 117 fi
 118 printf "The following PCI devices support a USB debug port (says lspci): $debug_lspci_devs\n"
 119
 120 debug_dmesg_devs_with_port=`( test -z "$dmesgfile" &&
 121         dmesg ||
 122         cat "$dmesgfile") |
 123         grep -i "ehci.*debug port" |
 124         sed "s/.* \([0-9a-f]*:*[0-9a-f]\{2\}:[0-9a-f]\{2\}\.[0-9a-f]\).*ebug port /\1 /" |
 125         sort`
 126
 127 debug_dmesg_devs=`echo "$debug_dmesg_devs_with_port" |
 128         cut -f 1 -d" " |
 129         xargs echo`
 130
 131 if [ -z "$debug_dmesg_devs" ]; then
 132         printf "dmesg does not show any supported ports.\n
 133 Possible reasons: dmesg scrolled off, kernel too old, USB controller does not support a debug device, ... Exiting.\n
 134 Note: You can specify a file containing kernel messages as an argument to this program (e.g. /var/log/dmesg)."
 135         exit 1
 136 fi
 137
 138 if [ "$debug_lspci_devs" != "$debug_dmesg_devs" ]; then
 139         echo "lspci and the kernel do not agree on USB debug device support. Exiting."
 140         exit 1
 141 fi
 142
 143 printf "and the kernel agrees, good.\n\n"
 144
 145 while true; do
 146         for dev in $debug_dmesg_devs; do
 147                 bus=`lsusb -v |
 148                         grep "^Bus\|iSerial.*" |
 149                         grep -B1 --no-group-separator "iSerial.*$dev" |
 150                         grep "^Bus" |
 151                         sed "s/Bus *0*\([0-9a-f]*\).*/\1/"`
 152                 port=`echo "$debug_dmesg_devs_with_port" |
 153                         grep "^$dev" |
 154                         cut -f 2 -d" "`
 155
 156                 echo "Device(s) currently connected to the debug-capable port $port on PCI device $dev, USB bus $bus:"
 157
 158                 find_devs_in_tree "$bus" "$port"
 159                 echo
 160         done
 161
 162         echo "Enter 'q' to abort or anything else to repeat"
 163         read -r r
 164         if [ $? -ne 0 -o "$r" = "q" ]; then
 165                 break;
 166         fi
 167 done
 168
 169 exit 0