Skip to content

About

Convert your Android phone to any USB device you like! USB Gadget Tool allows you to create and activate USB device roles, like a mouse or a keyboard. ๐Ÿ› ๐Ÿ›ก๐Ÿ“ฑ

Topics

Resources

Stars

1.1k stars

Watchers

28 watching

Forks

Latest commit

ย 

History

42 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

USB Gadget Tool

USB Gadget Tool Screenshot

Convert your Android phone to any USB device you like!
USB Gadget Tool allows you to create and activate USB device roles, like a mouse or a keyboard. Connected USB hosts (e.g. a normal computer) will then identify your Android device only under that role. It can also be used to deactivate the standard USB Gadget (including mtp, adb, etc.), e.g. for security reasons.

Following USB gadgets are integrated:

  • Keyboard & Mouse (/dev/hidgN)
  • FIDO CTAP (/dev/hidgN; for WebAuthn)
  • Keyboard & FIDO CTAP combined (/dev/hidgN)
  • CCID (/dev/ccid_ctrl, /dev/ccid_bulk)
  • UVC camera (/dev/video?)

USB Gadget Tool requires root permissions and a Kernel with ConfigFS support. Currently the app only enables the USB Gadget. For the usage of these device endpoints (e.g. /dev/hidg0) further apps are required (see Use-Cases). A FIDO CTAP gadget is only usable while such an app answers on its node.

The number in /dev/hidgN depends on the order in which HID functions were created across all gadgets, so the gadget's detail page shows the node of each HID function. The kernel allows at most 4 HID functions across all gadgets, including inactive ones.

Keyboard functions set no_out_endpoint where the kernel supports it, because unread LED reports on an OUT endpoint can make hosts such as macOS pause all keyboard input. On other kernels, and for gadgets created by earlier versions, keep something reading the keyboard's node.

Get it on F-Droid

Use-Cases

Features

  • Comfortable USB gadget management (listing, adding and activating)
  • Adding & activating USB Gadgets during boot
  • Adding functions to USB Gadgets
  • Device info (Kernel version and available gadgets in Kernel)
  • Available in F-Droid store

Roadmap

  • Mount of /config if not available
  • Alert if ConfigFS is not supported
  • Import custom USB Gadget profiles
  • Example USB Gadget usage (USB Gadget Tool currently only manages USB Gadgets, not implementations of these)
  • Optional telemetry to understand better how all the Android vendors compile their kernel (e.g. what USB Gadgets are available)
  • Google Play Store distribution

How does it work?

USB Gadget Tool uses ConfigFS - an userspace API inside the Linux Kernel - for creation of arbitrary USB composite devices. https://www.kernel.org/doc/Documentation/filesystems/configfs/configfs.txt

About

Convert your Android phone to any USB device you like! USB Gadget Tool allows you to create and activate USB device roles, like a mouse or a keyboard. ๐Ÿ› ๐Ÿ›ก๐Ÿ“ฑ

Topics

Resources

Stars

1.1k stars

Watchers

28 watching

Forks

Releases

Contributors

Languages