Clone this repo:
  1. b1af92a virtual-usb-printer: check requested scan params by Fletcher Woodruff · 5 weeks ago master stabilize-13360.B
  2. e9f0af4 virtual-usb-printer: result should have same lifecycle as ipp_manager by Qijiang Fan · 6 weeks ago
  3. c073c93 virtual-usb-printer: remove base::JSONReader::.*Deprecated methods by hscham · 6 weeks ago firmware-puff-13324.B
  4. 1913247 virtual-usb-printer: support ScanJobs DELETE by Fletcher Woodruff · 7 weeks ago release-R85-13310.B
  5. 2bccbc1 virtual-usb-printer: add parse error by Fletcher Woodruff · 9 weeks ago factory-endeavour-13295.B

Virtual USB Printer

Virtual USB Printer provides a server which can be used with USBIP in order to emulate a USB printing device and bind it to the system as if it were physically connected to a USB port.

Virtual USB Printer supports both regular USB printers as well as IPP-over-USB devices.


This project was created in order to make on-device tests which check for any regressions in the native USB printing system.


  • USBIP - userspace program for binding virtual device to system
  • USBIP kernel modules:

In order to actually “connect” the virtual printer to the system the USBIP program is used.

USBIP is typically used to export real USB devices over a network so that other systems on the network can bind them and treat them as connected devices.

For the purposes of the virtual printer, only the client portion of USBIP is required so that the virtual device can be bound to the system.


Currently the USBIP program is only installed by default for the elm and betty boards.

In order to install it on your test image, you need to build an image with the usbip USE flag enabled. To do this, all you need to to is run build_packages with the USE flag enabled.

USE="usbip" ./build_packages --board=$BOARD

How to Use

Run the virtual-usb-printer program:

virtual-usb-printer --descriptors_path=<path>

(Optional) Check the list of exported printers with USBIP:

usbip list -r localhost

Should return something like this:

Exportable USB devices
 - localhost
        1-1: Canon, Inc. : unknown product (04a9:27e8)
           : /sys/devices/pci0000:00/0000:00:01.2/usb1/1-1
           : (Defined at Interface level) (00/00/00)
           : 0 - Printer / Printer Bidirectional (07/01/02)

Bind the virtual printer to the system:

usbip attach -r localhost -b 1-1

Once the device has been attached it should appear in the list of connected USB devices (lsusb), and can be used with the native printing system in Chrome OS.


The printer's USB descriptors and defined IPP attributes can be configured using a JSON file and are loaded at run-time using command line flags. Example configurations can be found in the config/ directory.

The configuration files can be loaded with the following flags:

  • --descriptors_path - full path to the JSON file which defines the USB descriptors
  • --attributes_path - full path to the JSON file which defines the supported IPP attributes
    • Only needed for IPP-over-USB printer configurations
  • --record_doc_path - full path to the file used to record documents received from print jobs

Using in Tast

There are currently existing tast tests which leverage virtual-usb-printer in order to test native printing. The following can be used as examples in order to write new tests:

  • Add USB Printer
    • Tests that adding a basic USB printer works correctly
  • Print USB
    • Tests that the full print pipeline works correctly for a basic USB printer
  • Print IPPUSB
    • Tests that the full print pipeline for IPP-over-USB printing works correctly
    • This also tests that the automatic_usb_printer_configurer is able to automatically configure an IPP everywhere printer