debug/README

   1 This is a set of tools for debugging the b43 driver and/or firmware.
   2 Note that it is licensed under the GNU GPL version 3 ONLY!
   3
   4 Installing:
   5         Run the install.py script as root.
   6
   7 *******************************************************************************
   8 *  b43-fwdump                                                                 *
   9 *******************************************************************************
  10
  11 b43-fwdump is an utility for dumping the current status of the device firmware
  12 on a running device. It has some auto-detection mechanisms. So if you have
  13 only one card in the machine, it will dump the firmware state of that card, if
  14 called without any parameters.
  15 Use the --shm option, if you want a Shared Memory dump.
  16 Use the --binary option, if you want b43-fwdump to automatically dump the
  17 disassembled code at the current PC. This is convenient for debugging
  18 firmware crashes.
  19
  20 Note that b43-fwdump _must_ be run as root, as it needs direct access to the
  21 hardware through debugfs.
  22 Debugfs must be mounted and you must have a recent driver with support for raw
  23 hardware access through debugfs.
  24 If you get error messages about missing debugfs files, make sure to upgrade to
  25 the latest development snapshot of the b43 driver.
  26
  27 *******************************************************************************
  28 *  b43-beautifier                                                             *
  29 *******************************************************************************
  30
  31 b43-beautifier is a tool to replace constant expressions in raw disassembled
  32 firmware code with human-readable #defined names.
  33
  34 The tool requires either the disassembled source code or a binary (which it
  35 will disassemble then) to start with. See the --asmfile and --binfile
  36 parameters.
  37 It also requires a path to the directory containing the hardware definitions.
  38 This is the "common" subdirectory found in the b43-ucode GIT repository.
  39 See the --defs parameter.
  40
  41
  42
  43
  44 Please be careful when using these tools. Some of them have direct access to
  45 the hardware, so you can easily crash something.
  46
  47         Michael