How to Configure our Printer to Communicate with IPP-USB Protocol.?

[sahayap]

Hello Team,
Greetings,
Currently we are developing IPP-USB support for our printer platform, its arm based with Linux kernel version 4.1.18, we have ported the following packages in to Linux kernel,

1. CUPS 2.3.1
2. Dbus
3. Avahi
4. PAPPL-Retro based Printer Driver Application for legacy CUPS printer driver

we run our printer driver application using the following command
printer-driver-application server -o server-port=631 -o host-name=airprint-001.local &

Then We add the printer using the following method,

on a local PC, we open the Web interface of our printer application (http://printerip:631 )and using Add Printer option and add our printer.

on our Printer platform, we run the ippfind, and it return the following output
ipp://airprint-001.local:631/printers/XT5-43

On Mac PC, our printer successfully detected as Air print and working well.

IPP-USB Support
By default the linux kernel has only one printer interface, which is bi-directional printer (7-1-2) Now to support IPP-USB, we added 3 more IPP_USB interface(7-1-4) using configfs on linux kernel. (/dev/g_printer0, /dev/g_printer1, /dev/g_printer2 and /dev/g_printer3)

When we connect our printer to Linux PC, it successfully enumerated 4 interface each interface with different endpoint addresses.

when we use ippusbxd it successfully detected as IPP-USB printer, and produice the following output

> <-435507392>Note: Counting IPP-over-USB interfaces ...
> <-435507392>Note: Interface 0, Alt 0: Class 7, Subclass 1, Protocol 2
> <-435507392>Note: Interface 1, Alt 0: Class 7, Subclass 1, Protocol 4
> <-435507392>Note:    -> is IPP-over-USB
> <-435507392>Note: Interface 2, Alt 0: Class 7, Subclass 1, Protocol 4
> <-435507392>Note:    -> is IPP-over-USB
> <-435507392>Note: Interface 3, Alt 0: Class 7, Subclass 1, Protocol 4
> <-435507392>Note:    -> is IPP-over-USB
> <-435507392>Note:    -> 3 Interfaces
> <-435507392>Note: USB device ID: MFG:BIXOLON;MDL:XT5-40;CMD:BXL_2;CLS:PRINTER;DES:BIXOLON XT5-40;
> 
> <-435507392>Note: USB interfaces pool: 3 interfaces
> <-435507392>Note: IPv4: Binding to 127.0.0.1:60000
> <-435507392>Note: IPv6: Binding to [::1]:60000
> <-435507392>Note: Access to desired port failed, trying alternative port 60001
> <-435507392>Note: IPv4: Binding to 127.0.0.1:60001
> <-435507392>Note: IPv6: Binding to [::1]:60001
> 60001|<-435507392>Note: Port: 60001, IPv4 available, IPv6 available
> <-435507392>Note: Using signal handler SIGNAL
> <-435507392>Note: Registered unplug callback
> <-480274688>Note: USB unplug event observer thread starting
> <-435507392>Note: Waiting for Avahi server.
> <-435507392>Note: DNS-SD initialized.

and bind our printer to 127.0.0.1:60000, when we try to open the printer interface on 127.0.0.1:60000, there is no response data from the printer. host can send the data but printer doesn't retun any data.

> <-235839680>Note: DNS-SD initialized.
> <-235839680>Note: Using IPv4
> <-235839680>Note: Registering thread #1
> <-235839680>Note: Threads currently running: #1
> <-297392384>Note: Thread #1: Starting
> <-297392384>Note: Thread #1: M 0x7f12e0000b20: Client msg starting
> <-297392384>Note: TCP: Getting 4096 bytes
> <-297392384>Note: TCP: Got 500 bytes
> <-297392384>Note: HTTP: got 500 bytes so: pkt has 500 bytes, msg has 500 bytes
> <-297392384>Note: http: Message completed: Received size >= claimed size
> <-297392384>Note: http: Packet completed: Packet full
> <-297392384>Note: TCP: Want more 0 bytes; Message completed
> <-297392384>Note: TCP: Received 500 bytes
> <-297392384>Note: Thread #1: M 0x7f12e0000b20: Interface #0: acquired usb conn
> <-297392384>Note: Thread #1: M 0x7f12e0000b20 P 0x7f12e0000b70: Pkt from tcp (buffer size: 500)
> ===
>   00000000  47 45 54 20 2f 20 48 54 54 50 2f 31 2e 31 0d 0a  GET / HTTP/1.1..
>   00000010  48 6f 73 74 3a 20 31 32 37 2e 30 2e 30 2e 31 3a  Host: 127.0.0.1:
>   00000020  36 30 30 30 30 0d 0a 55 73 65 72 2d 41 67 65 6e  60000..User-Agen
>   00000030  74 3a 20 4d 6f 7a 69 6c 6c 61 2f 35 2e 30 20 28  t: Mozilla/5.0 (
>   00000040  58 31 31 3b 20 55 62 75 6e 74 75 3b 20 4c 69 6e  X11; Ubuntu; Lin
>   00000050  75 78 20 78 38 36 5f 36 34 3b 20 72 76 3a 31 30  ux x86_64; rv:10
>   00000060  39 2e 30 29 20 47 65 63 6b 6f 2f 32 30 31 30 30  9.0) Gecko/20100
>   00000070  31 30 31 20 46 69 72 65 66 6f 78 2f 31 31 31 2e  101 Firefox/111.
>   00000080  30 0d 0a 41 63 63 65 70 74 3a 20 74 65 78 74 2f  0..Accept: text/
>   00000090  68 74 6d 6c 2c 61 70 70 6c 69 63 61 74 69 6f 6e  html,application
>   000000a0  2f 78 68 74 6d 6c 2b 78 6d 6c 2c 61 70 70 6c 69  /xhtml+xml,appli
>   000000b0  63 61 74 69 6f 6e 2f 78 6d 6c 3b 71 3d 30 2e 39  cation/xml;q=0.9
>   000000c0  2c 69 6d 61 67 65 2f 61 76 69 66 2c 69 6d 61 67  ,image/avif,imag
>   000000d0  65 2f 77 65 62 70 2c 2a 2f 2a 3b 71 3d 30 2e 38  e/webp,*/*;q=0.8
>   000000e0  0d 0a 41 63 63 65 70 74 2d 4c 61 6e 67 75 61 67  ..Accept-Languag
>   000000f0  65 3a 20 65 6e 2d 55 53 2c 65 6e 3b 71 3d 30 2e  e: en-US,en;q=0.
>   00000100  35 0d 0a 41 63 63 65 70 74 2d 45 6e 63 6f 64 69  5..Accept-Encodi
>   00000110  6e 67 3a 20 67 7a 69 70 2c 20 64 65 66 6c 61 74  ng: gzip, deflat
>   00000120  65 2c 20 62 72 0d 0a 43 6f 6e 6e 65 63 74 69 6f  e, br..Connectio
>   00000130  6e 3a 20 6b 65 65 70 2d 61 6c 69 76 65 0d 0a 43  n: keep-alive..C
>   00000140  6f 6f 6b 69 65 3a 20 6f 72 67 2e 63 75 70 73 2e  ookie: org.cups.
>   00000150  73 69 64 3d 36 37 62 62 63 34 39 38 38 30 66 62  sid=67bbc49880fb
>   00000160  30 66 33 34 62 30 66 37 39 61 31 61 36 35 65 36  0f34b0f79a1a65e6
>   00000170  63 66 64 63 0d 0a 55 70 67 72 61 64 65 2d 49 6e  cfdc..Upgrade-In
>   00000180  73 65 63 75 72 65 2d 52 65 71 75 65 73 74 73 3a  secure-Requests:
>   00000190  20 31 0d 0a 53 65 63 2d 46 65 74 63 68 2d 44 65   1..Sec-Fetch-De
>   000001a0  73 74 3a 20 64 6f 63 75 6d 65 6e 74 0d 0a 53 65  st: document..Se
>   000001b0  63 2d 46 65 74 63 68 2d 4d 6f 64 65 3a 20 6e 61  c-Fetch-Mode: na
>   000001c0  76 69 67 61 74 65 0d 0a 53 65 63 2d 46 65 74 63  vigate..Sec-Fetc
>   000001d0  68 2d 53 69 74 65 3a 20 6e 6f 6e 65 0d 0a 53 65  h-Site: none..Se
>   000001e0  63 2d 46 65 74 63 68 2d 55 73 65 72 3a 20 3f 31  c-Fetch-User: ?1
>   000001f0  0d 0a 0d 0a                                      ....
> ===
> <-297392384>Note: P 0x7f12e0000b70: USB: want to send 500 bytes
> <-297392384>Note: P 0x7f12e0000b70: USB: sent 500 bytes
> <-297392384>Note: P 0x7f12e0000b70: USB: sent 500 bytes in total
> <-297392384>Note: Thread #1: M 0x7f12e0000b20 P 0x7f12e0000b70: Interface #0: Client pkt done
> <-297392384>Note: Thread #1: M 0x7f12e0000b20: Interface #0: Client msg completed
> <-297392384>Note: Thread #1: M 0x7f12e0000bb0: Interface #0: Server msg starting
> <-297392384>Error: bulk xfer timed out, retrying ...
> <-297392384>Error: tried reading 4096 bytes, actually read 0 bytes
> <-297392384>Note: No bytes received for 1 sec.
> <-297392384>Error: bulk xfer timed out, retrying ...
> <-297392384>Error: tried reading 4096 bytes, actually read 0 bytes
> <-297392384>Note: No bytes received for 2 sec.
> <-297392384>Error: bulk xfer timed out, retrying ...
> <-297392384>Error: tried reading 4096 bytes, actually read 0 bytes
> <-297392384>Note: No bytes received for 3 sec.
> <-297392384>Error: bulk xfer timed out, retrying ...
> <-297392384>Error: tried reading 4096 bytes, actually read 0 bytes
> <-297392384>Note: No bytes received for 4 sec.
> <-297392384>Error: bulk xfer timed out, retrying ...
> <-297392384>Error: tried reading 4096 bytes, actually read 0 bytes
> <-297392384>Note: No bytes received for 5 sec.
> <-297392384>Error: bulk xfer timed out, retrying ...
> <-297392384>Error: tried reading 4096 bytes, actually read 0 bytes
> <-297392384>Note: No bytes received for 6 sec.

Could you please guild us to identify the issue and move forward to implement the IPP-USB printer feature.

Thank you.

[michaelrsweet]

OK, so this is better discussed over in the PAPPL project. But some quick feedback:

1. Why are you using such an old version of CUPS?
2. What version of PAPPL are you using?
3. What log messages are produced by the printer application?
4. What does "dmesg" report on your embedded board?

I suspect you might be running into a problem with the DWC2/3 driver and your embedded board - ippusbxd is seeing the USB gadgets but isn't able to successfully send data. Also, is this an off-the-shelf ARM board or something custom? USB signaling requires a proper ground plane for high-speed (480Mbit/sec) to work, but discovery/interface selection happens at full-speed (12Mbit/sec) so it isn't always obvious there is a problem.

[sahayap]

Hello Michael,
Thank you so much for your response,

1. Why are you using such an old version of CUPS?

We are using our legacy cups filter for cups-raster application, so we used Old version CUPS.

2. What version of PAPPL are you using?

pappl-1.3.1, pappl-retrofit-1.0b2, libcupsfilters-2.0b2 and libppd-2.0b4

3. What log messages are produced by the printer application?
   **

Nothing

**
4. What does "dmesg" report on your embedded board?
When connect our printer to Linux PC got the following dmesg

[ 40.573728] configfs-gadget gadget: high-speed config #1: c
[ 40.573781] configfs-gadget gadget: Using interface 0
[ 40.573796] configfs-gadget gadget: Using interface 1
[ 40.573808] configfs-gadget gadget: Using interface 2
[ 40.573820] configfs-gadget gadget: Using interface 3

When using the ippusbxd -d on Linux PC got the following

[ 40.573820] configfs-gadget gadget: Using interface 3
[ 209.017727] configfs-gadget gadget: Using interface 3
[ 215.023383] configfs-gadget gadget: Using interface 3
[ 221.028819] configfs-gadget gadget: Using interface 3
[ 227.034766] configfs-gadget gadget: Using interface 3
[ 233.040494] configfs-gadget gadget: Using interface 3
[ 239.046215] configfs-gadget gadget: Using interface 3
[ 245.052709] configfs-gadget gadget: Using interface 3
[ 251.058389] configfs-gadget gadget: Using interface 3
[ 257.063745] configfs-gadget gadget: Using interface 3
[ 263.069422] configfs-gadget gadget: Using interface 3

I think our printer is interface is discovered as high speed device. so its not a problem
In Addition, our printer is working well with Mac Airprint, on Mac PC its detected as secure Airprint and working well. so i think our hardware is not a problem.

We have installed only one printer using our printer PAAPL-Retro application, when we open the our printer application stat file under /var/lib/bixolon-printer-app/ folder, it gives the following outout

cat /var/lib/bixolon-printer-app/bixolon-printer-app.state

DNSSDName CUPS Driver Bixolon Printer Application
Contact
DefaultPrinterID 1
MaxImageSize 429496729 16384 16384
NextPrinterID 11
UUID urn:uuid:c2e733b2-1b7d-391d-6cec-c02eb6d6b824
Printer did="MFG:Bixolon;MDL:XT5-43;CMD:PWGRaster,URF,application/vnd.printer-specific,PDF,JPEG,PNG;" driver="bixolon--xt-5-43--user-added-en" id="3" name="BIXOLON_XT5_40" uri="socket://localhost/"
DNSSDName BIXOLON_XT5_40
Contact
MaxActiveJobs 0
MaxCompletedJobs 100
NextJobId 4
ImpressionsCompleted 0
identify-actions-default sound
media-col-default length="15240" name="na_index-4x6_4x6in" source="default" type="0-direct" width="10160"
media-col-ready0 length="15240" name="na_index-4x6_4x6in" source="default" type="0-direct" width="10160"
orientation-requested-default none
print-color-mode-default monochrome
print-content-optimize-default auto
print-quality-default normal
print-scaling-default auto
sides-default one-sided
printer-resolution-default 300x300dpi
sensor-type-default gap
rotation-angle-default no-rotation
no-of-copies-default 1
custom-no-of-copies-default 1
printer-status-check-default enable
darkness-default 14
x-margin-default 0-mm
custom-x-margin-default 1
y-margin-default 0-mm
custom-y-margin-default 1
print-rate-default 6-0-inches-sec
black-mark-offset-default 0-mm
tear-off-offset-default 0-mm
cutter-default none
custom-cutter-default 1
rewinder-default no
compressed-printing-default non-compressed
Job completed="964802806" created="964802800" format="application/pdf" id="3" impressions="1" name="FRANCE_DHL_PR.pdf" processing="964802800" state="9" username="sahaya"
Job completed="964802298" created="964802292" format="application/pdf" id="2" impressions="1" name="FRANCE_DHL_PR.pdf" processing="964802292" state="9" username="sahaya"
Job completed="964715493" created="964715490" format="application/pdf" id="1" impressions="1" name="Test Page" processing="964715490" state="9" username="guest"
/Printer

I am bit confused here, do we need to add another usb printer as well using our printer application? just this printer alone enough for ipp-usb support?

Thank you,

• Sahaya P

[michaelrsweet]

OK, so when you run your printer application, add the log-level and log-file options so you get details about what is happening:

printer-driver-application server -o server-port=631 -o host-name=airprint-001.local -o log-level=debug -o log-file=/var/log/printer-driver-application.log &

WRT my final comments, what I mean is that the USB gadget (device) driver is responsible for handling the USB I/O, with PAPPL providing the IPP-USB protocol support. But if the USB hardware or driver is faulty then PAPPL will not be able to successfully provide those IPP-USB endpoints for you.

[sahayap]

Hello Michael,
I would like to express my gratitude for your valuable suggestions. I have incorporated the suggested changes into the pappl-retro and pappl libraries. As a result, the gadget setup log messages are now displayed, and the IPP-USB communication is functioning smoothly. I am pleased to inform you that I am able to print from both Linux and Mac OS via IPP-USB.

However, I have observed an unusual behavior in Mac OS. When our printer is connected to a Mac via USB, only the USB AirPrint option is visible in the print dialog, while the AirPrint Bonjour option is absent. Interestingly, when we disconnect the USB, the AirPrint Bonjour option reappears in the print dialog. I am curious to know if this behavior is normal or if it is possible to have both printers (USB and Bonjour) visible simultaneously.

Thank you once again for your guidance.
Sahaya P

[michaelrsweet]

This is as designed on macOS - if you have an AirPrint printer that is visible via both USB and network, you'll only see the USB device listed but it "remembers" the network version as well so you can use the same queue to print over USB and Wi-Fi/Ethernet. :)

Connecting via IPP-USB also allows the Mac to (optionally) get your printer on the Mac's Wi-Fi network - if you provide Wi-Fi callbacks in your printer application PAPPL will automatically support this.

[sahayap]

Hello Michael,

I wanted to express my gratitude for providing me with the explanation earlier. After testing the solution on a Mac, I can confirm that it is working as expected. However, I have come across another issue that I would like to bring to your attention.

When we connect our printers via USB on Mac OS, the print dialog suppose to show 2 USB printers however, it shows only one USB printer ( IPP-USB). Unfortunately, it does not show the normal (bi-directional 7-1-2) printer. Could you please explain the possible reasons behind this issue and provide me with guidance on how to resolve it.

Thank you once again for your assistance.
Sahaya P

[michaelrsweet]

OK, so when your printer supports IPP-USB, then macOS will only use IPP-USB, by design.

[sahayap]

Hello Michael,

Always thank you for your help,
I wanted to bring to your attention an issue we are currently facing with our printer setup on Mac PCs. We have installed the CUPS driver and connected our printer to one of the Mac PCs. Interestingly, both the IPP-USB and the regular USB printer were automatically detected.

The problem arises when we attempt to print. The IPP-USB connection initiates the printing process within 5 seconds, while the regular USB connection takes more than 2 minutes to start printing. This discrepancy has left us perplexed, and we are unsure of the cause or how to rectify it.

I am reaching out to seek your expertise in understanding why this disparity occurs and how we can resolve it. Your guidance in this matter would be greatly appreciated so that we can proceed smoothly.

Thank you for your prompt attention and assistance.
Sahaya P

[sahayap]

The device's read poll waits for 10 seconds for every incoming transactions, resulting in significant delays.