Google Git
Sign in
chromium / chromiumos / third_party / virtual-usb-printer / refs/heads/stabilize-15662.76.B
commit40a88480cce4e9de01e7469c9b6f8cf909d406d9[log] [tgz]
authorMike Frysinger <[email protected]>Thu Oct 19 14:37:43 2023
committerChromeos LUCI <[email protected]>Fri Oct 20 03:35:50 2023
tree062b14b7c79e875fb84587a3fe86b7d6d33f23ff
parenta84706954fed8d459413c55d3c3214a2a4546eeb [diff]
PRESUBMIT: switch to cros format

BUG=None
TEST=CQ passes

Change-Id: I16d222f8eb632f1d5f01cd793e5accb3823d7946
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/virtual-usb-printer/+/4955253
Auto-Submit: Mike Frysinger <[email protected]>
Tested-by: Mike Frysinger <[email protected]>
Reviewed-by: Benjamin Gordon <[email protected]>
Commit-Queue: Benjamin Gordon <[email protected]>
3 files changed
tree: 062b14b7c79e875fb84587a3fe86b7d6d33f23ff
  1. config/
  2. docs/
  3. init/
  4. mock_printer/
  5. tools/
  6. .clang-format
  7. BUILD.gn
  8. CPPLINT.cfg
  9. cups_constants.cc
  10. cups_constants.h
  11. device_descriptors.cc
  12. device_descriptors.h
  13. DIR_METADATA
  14. escl_manager.cc
  15. escl_manager.h
  16. escl_manager_test.cc
  17. http_util.cc
  18. http_util.h
  19. http_util_test.cc
  20. ipp_manager.cc
  21. ipp_manager.h
  22. ipp_manager_test.cc
  23. ipp_util.cc
  24. ipp_util.h
  25. ipp_util_test.cc
  26. jpeg_util.cc
  27. jpeg_util.h
  28. jpeg_util_test.cc
  29. LICENSE
  30. load_config.cc
  31. load_config.h
  32. load_config_test.cc
  33. op_commands.cc
  34. op_commands.h
  35. OWNERS
  36. PRESUBMIT.cfg
  37. README.md
  38. server.cc
  39. server.h
  40. smart_buffer.cc
  41. smart_buffer.h
  42. smart_buffer_test.cc
  43. usb_printer.cc
  44. usb_printer.h
  45. usb_printer_test.cc
  46. usbip.cc
  47. usbip.h
  48. usbip_constants.h
  49. value_util.cc
  50. value_util.h
  51. virtual_usb_printer.cc
  52. xml_util.cc
  53. xml_util.h
README.md

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.

Motivation

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

Installation

As of https://crrev.com/c/3093381, virtual-usb-printer is built and installed by default on all test images that support it.

If for some reason you need to build it yourself, you can USE=usbip when building packages for your board - i.e.

USE="usbip" ./build_packages --board=$BOARD
virtual-usb-printer relies on usbip to manifest as a virtual USB device. Most test images seem to come with this built-in by default. If you need to build your own kernel with usbip support, make sure to build with CONFIG_USBIP_CORE and CONFIG_USBIP_VHCI_HCD.

How to Use

virtual-usb-printer can behave like

For ease of human operation, start virtual-usb-printer via its Upstart unit. Pass the appropriate arguments to the invocation as needed.

For example, to start and connect the virtual-usb-printer as an IPP-over-USB printer, issue

start virtual-usb-printer USB_DESCRIPTORS=ippusb_printer.json IPP_ATTRIBUTES=ipp_attributes.json

Consult the Upstart config file to see the arguments understood in this context.

When managed by Upstart, virtual-usb-printer sends its output to the system log.

Configuration

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
  • --output_log_dir - directory path specifying where scan settings will be logged

Using in Tast

Refer to these existing tast tests for examples of how to use the virtual-usb-printer to test the Chromium OS printing stack.

Print Tests

Scan Tests