Roland JD-08 Crippled USB Implementation

[nickverlinden]

Hi Rene,

I've been working towards a live performance and am using a custom device based on Circle. I want to attach a synth, and my synth of choice was the Roland JD-08 because on paper it had all the nice promising things, usb powered, usb midi (and audio interface), built-in speaker, ...
This was all very promising until i received the unit and discovered Roland decided not to go with Class Compliant interfaces, even for MIDI. They make you install proprietary drivers. This smells like vender locking. However, searching upon this topic a bit it seems that some are under the impression that Roland just changed a few descriptor things on purpose but the actual implementation under the hood is similar if not completely the same as class compliant devices. I was wondering, looking at these lsusb output if there is a chance to make the MIDI in & out work by detecting this in the Midi detection code in Circle by adding a hardcoded vender id hack or something, or perhaps forcing a specific endpoint from the descriptor to be recognized as a midi endpoint. I don't really know anything about USB so i was hoping you could share your ideas.

Many thanks!
Nick

Here is the lsusb output of the Roland JD-08:

Bus 001 Device 001: ID 0582:028c  
Device Descriptor:
  bLength                18
  bDescriptorType         1
  bcdUSB               2.00
  bDeviceClass          255 [unknown]
  bDeviceSubClass         0 [unknown]
  bDeviceProtocol       255 
  bMaxPacketSize0        64
  idVendor           0x0582 
  idProduct          0x028c 
  bcdDevice            1.00
  iManufacturer           1 
  iProduct                2 
  iSerial                 3 
  bNumConfigurations      1
  Configuration Descriptor:
    bLength                 9
    bDescriptorType         2
    wTotalLength       0x011a
    bNumInterfaces          4
    bConfigurationValue     1
    iConfiguration          0 
    bmAttributes         0x80
      (Bus Powered)
    MaxPower              500mA
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        0
      bAlternateSetting       0
      bNumEndpoints           0
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass    255 [unknown]
      bInterfaceProtocol      0 
      iInterface              0 
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        1
      bAlternateSetting       0
      bNumEndpoints           0
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      2 [unknown]
      bInterfaceProtocol      2 
      iInterface              0 
      ** UNRECOGNIZED:  06 24 f1 01 00 00
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        1
      bAlternateSetting       1
      bNumEndpoints           1
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      2 [unknown]
      bInterfaceProtocol      2 
      iInterface              0 
      ** UNRECOGNIZED:  07 24 01 01 00 03 00
      ** UNRECOGNIZED:  0b 24 02 01 02 04 20 01 80 bb 00
      ** UNRECOGNIZED:  06 24 f1 04 56 00
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x0d  EP 13 OUT
        bmAttributes            5
          Transfer Type            Isochronous
          Synch Type               Asynchronous
          Usage Type               Data
        wMaxPacketSize     0x003c  1x 60 bytes
        bInterval               1
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        1
      bAlternateSetting       2
      bNumEndpoints           1
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      2 [unknown]
      bInterfaceProtocol      2 
      iInterface              0 
      ** UNRECOGNIZED:  07 24 01 01 00 03 00
      ** UNRECOGNIZED:  0b 24 02 01 02 04 20 01 80 bb 00
      ** UNRECOGNIZED:  06 24 f1 04 56 00
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x0d  EP 13 OUT
        bmAttributes            5
          Transfer Type            Isochronous
          Synch Type               Asynchronous
          Usage Type               Data
        wMaxPacketSize     0x003c  1x 60 bytes
        bInterval               1
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        2
      bAlternateSetting       0
      bNumEndpoints           0
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      2 [unknown]
      bInterfaceProtocol      1 
      iInterface              0 
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        2
      bAlternateSetting       1
      bNumEndpoints           1
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      2 [unknown]
      bInterfaceProtocol      1 
      iInterface              0 
      ** UNRECOGNIZED:  07 24 01 04 00 03 00
      ** UNRECOGNIZED:  0b 24 02 01 08 04 20 01 80 bb 00
      ** UNRECOGNIZED:  06 24 f1 04 56 00
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x8e  EP 14 IN
        bmAttributes           37
          Transfer Type            Isochronous
          Synch Type               Asynchronous
          Usage Type               Implicit feedback Data
        wMaxPacketSize     0x00e4  1x 228 bytes
        bInterval               1
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        2
      bAlternateSetting       2
      bNumEndpoints           1
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      2 [unknown]
      bInterfaceProtocol      1 
      iInterface              0 
      ** UNRECOGNIZED:  07 24 01 04 00 03 00
      ** UNRECOGNIZED:  0b 24 02 01 02 04 20 01 80 bb 00
      ** UNRECOGNIZED:  06 24 f1 04 56 00
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x8e  EP 14 IN
        bmAttributes           37
          Transfer Type            Isochronous
          Synch Type               Asynchronous
          Usage Type               Implicit feedback Data
        wMaxPacketSize     0x003c  1x 60 bytes
        bInterval               1
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        3
      bAlternateSetting       0
      bNumEndpoints           2
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      3 [unknown]
      bInterfaceProtocol      0 
      iInterface              0 
      ** UNRECOGNIZED:  06 24 f1 02 01 01
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x03  EP 3 OUT
        bmAttributes            2
          Transfer Type            Bulk
          Synch Type               None
          Usage Type               Data
        wMaxPacketSize     0x0200  1x 512 bytes
        bInterval               1
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x84  EP 4 IN
        bmAttributes            2
          Transfer Type            Bulk
          Synch Type               None
          Usage Type               Data
        wMaxPacketSize     0x0200  1x 512 bytes
        bInterval               0
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        3
      bAlternateSetting       1
      bNumEndpoints           2
      bInterfaceClass       255 [unknown]
      bInterfaceSubClass      3 [unknown]
      bInterfaceProtocol      0 
      iInterface              0 
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x03  EP 3 OUT
        bmAttributes            3
          Transfer Type            Interrupt
          Synch Type               None
          Usage Type               Data
        wMaxPacketSize     0x0200  1x 512 bytes
        bInterval               4
      Endpoint Descriptor:
        bLength                 7
        bDescriptorType         5
        bEndpointAddress     0x85  EP 5 IN
        bmAttributes            3
          Transfer Type            Interrupt
          Synch Type               None
          Usage Type               Data
        wMaxPacketSize     0x0200  1x 512 bytes
        bInterval               4
Device Qualifier (for other device speed):
  bLength                10
  bDescriptorType         6
  bcdUSB               2.00
  bDeviceClass          255 [unknown]
  bDeviceSubClass         0 [unknown]
  bDeviceProtocol       255 
  bMaxPacketSize0        64
  bNumConfigurations      1
can't get debug descriptor: No such file or directory
Device Status:     0x0000
  (Bus Powered)

And this is the lsusb output of a USB to MIDI dongle:

Bus 001 Device 002: ID 1a86:752d  
Device Descriptor:
  bLength                18
  bDescriptorType         1
  bcdUSB               1.10
  bDeviceClass            0 [unknown]
  bDeviceSubClass         0 [unknown]
  bDeviceProtocol         0 
  bMaxPacketSize0         8
  idVendor           0x1a86 
  idProduct          0x752d 
  bcdDevice            2.54
  iManufacturer           0 
  iProduct                2 
  iSerial                 0 
  bNumConfigurations      1
  Configuration Descriptor:
    bLength                 9
    bDescriptorType         2
    wTotalLength       0x0075
    bNumInterfaces          2
    bConfigurationValue     1
    iConfiguration          0 
    bmAttributes         0x80
      (Bus Powered)
    MaxPower               96mA
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        0
      bAlternateSetting       0
      bNumEndpoints           0
      bInterfaceClass         1 [unknown]
      bInterfaceSubClass      1 [unknown]
      bInterfaceProtocol      0 
      iInterface              0 
      AudioControl Interface Descriptor:
        bLength                 9
        bDescriptorType        36
        bDescriptorSubtype      1 (HEADER)
        bcdADC               1.00
        wTotalLength       0x0009
        bInCollection           1
        baInterfaceNr(0)        1
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        1
      bAlternateSetting       0
      bNumEndpoints           2
      bInterfaceClass         1 [unknown]
      bInterfaceSubClass      3 [unknown]
      bInterfaceProtocol      0 
      iInterface              0 
      MIDIStreaming Interface Descriptor:
        bLength                 7
        bDescriptorType        36
        bDescriptorSubtype      1 (HEADER)
        bcdADC               1.00
        wTotalLength       0x0051
      MIDIStreaming Interface Descriptor:
        bLength                 6
        bDescriptorType        36
        bDescriptorSubtype      2 (MIDI_IN_JACK)
        bJackType               1 Embedded
        bJackID                 2
        iJack                   0 
      MIDIStreaming Interface Descriptor:
        bLength                 6
        bDescriptorType        36
        bDescriptorSubtype      2 (MIDI_IN_JACK)
        bJackType               1 Embedded
        bJackID                 3
        iJack                   0 
      MIDIStreaming Interface Descriptor:
        bLength                 6
        bDescriptorType        36
        bDescriptorSubtype      2 (MIDI_IN_JACK)
        bJackType               2 External
        bJackID                 6
        iJack                   0 
      MIDIStreaming Interface Descriptor:
        bLength                 9
        bDescriptorType        36
        bDescriptorSubtype      3 (MIDI_OUT_JACK)
        bJackType               1 Embedded
        bJackID                 7
        bNrInputPins            1
        baSourceID( 0)          6
        BaSourcePin( 0)         1
        iJack                   0 
      MIDIStreaming Interface Descriptor:
        bLength                 9
        bDescriptorType        36
        bDescriptorSubtype      3 (MIDI_OUT_JACK)
        bJackType               2 External
        bJackID                 4
        bNrInputPins            1
        baSourceID( 0)          2
        BaSourcePin( 0)         1
        iJack                   0 
      MIDIStreaming Interface Descriptor:
        bLength                 9
        bDescriptorType        36
        bDescriptorSubtype      3 (MIDI_OUT_JACK)
        bJackType               2 External
        bJackID                 5
        bNrInputPins            1
        baSourceID( 0)          3
        BaSourcePin( 0)         1
        iJack                   0 
      Endpoint Descriptor:
        bLength                 9
        bDescriptorType         5
        bEndpointAddress     0x02  EP 2 OUT
        bmAttributes            2
          Transfer Type            Bulk
          Synch Type               None
          Usage Type               Data
        wMaxPacketSize     0x0020  1x 32 bytes
        bInterval               0
        bRefresh                0
        bSynchAddress           0
        MIDIStreaming Endpoint Descriptor:
          bLength                 6
          bDescriptorType        37
          bDescriptorSubtype      1 (Invalid)
          bNumEmbMIDIJack         2
          baAssocJackID( 0)       2
          baAssocJackID( 1)       3
      Endpoint Descriptor:
        bLength                 9
        bDescriptorType         5
        bEndpointAddress     0x82  EP 2 IN
        bmAttributes            2
          Transfer Type            Bulk
          Synch Type               None
          Usage Type               Data
        wMaxPacketSize     0x0020  1x 32 bytes
        bInterval               0
        bRefresh                0
        bSynchAddress           0
        MIDIStreaming Endpoint Descriptor:
          bLength                 5
          bDescriptorType        37
          bDescriptorSubtype      1 (Invalid)
          bNumEmbMIDIJack         1
          baAssocJackID( 0)       7
Device Status:     0x0000
  (Bus Powered)

[rsta2]

Hi Nick, for a quick test please change the string in this line to "int255-3-0": https://github.com/rsta2/circle/blob/master/lib/usb/usbdevicefactory.cpp#L175 If we are lucky, this could already work for USB MIDI with the JD-08. If not, please let me know, which messages you get e.g. from test/usb-midi-send. BTW. Circle already supports the Roland UM-ONE MIDI interface, which has also different descriptors from USB Audio class MIDI devices, but the structure of its descriptors is a bit more simple than the descriptors of the JD-08.

[nickverlinden]

Hi Rene,

That sounded promising, but unfortunately it doesn't seem to work. Not i also changed the product id to match the JD08.

Tried adding:

else if (   pName->Compare ("int255-3-0") == 0
			|| pName->Compare ("ven582-28c") == 0)		// Roland JD-08 MIDI interface
	{
		pResult = new CUSBMIDIHostDevice (pParent);
	}

Got this back on the console:

00:00:04.26 usbdev1-4: Device ven582-28c found (HS)
00:00:04.26 usbdev1-4: Product: Roland Boutique
00:00:04.32 usbdev1-4: Using device/interface ven582-28c
00:00:04.32 usbdev1-4: Function is not supported
00:00:04.33 usbdev1-4: Function is not supported
00:00:04.33 usbdev1-4: Function is not supported
00:00:04.33 usbdev1-4: Function is not supported
00:00:04.34 usbdev1-4: Function is not supported
00:00:04.34 usbdev1-4: Function is not supported
00:00:04.35 usbdev1-4: Function is not supported
00:00:04.35 usbdev1-4: Function is not supported
00:00:05.23 umsd: Capacity is 29604 MByte
00:00:05.23 usbhub: Port 2: Device configured
00:00:05.31 usbhub: Port 3: Device configured
00:00:05.31 umidihost: Invalid configuration descriptor (offset 0x9)
00:00:05.32 umidihost: Dumping 0x11A bytes starting at 0x24CD8EC0
00:00:05.32 umidihost: 8EC0: 09 02 1A 01 04 01 00 80-FA 09 04 00 00 00 FF FF
00:00:05.33 umidihost: 8ED0: 00 00 09 04 01 00 00 FF-02 02 00 06 24 F1 01 00
00:00:05.34 umidihost: 8EE0: 00 09 04 01 01 01 FF 02-02 00 07 24 01 01 00 03
00:00:05.34 umidihost: 8EF0: 00 0B 24 02 01 02 04 20-01 80 BB 00 06 24 F1 04
00:00:05.35 umidihost: 8F00: 56 00 07 05 0D 05 3C 00-01 07 25 01 00 00 00 00
00:00:05.36 umidihost: 8F10: 09 04 01 02 01 FF 02 02-00 07 24 01 01 00 03 00
00:00:05.36 umidihost: 8F20: 0B 24 02 01 02 04 20 01-80 BB 00 06 24 F1 04 56
00:00:05.37 umidihost: 8F30: 00 07 05 0D 05 3C 00 01-07 25 01 00 00 00 00 09
00:00:05.38 umidihost: 8F40: 04 02 00 00 FF 02 01 00-09 04 02 01 01 FF 02 01
00:00:05.38 umidihost: 8F50: 00 07 24 01 04 00 03 00-0B 24 02 01 08 04 20 01
00:00:05.39 umidihost: 8F60: 80 BB 00 06 24 F1 04 56-00 07 05 8E 25 E4 00 01
00:00:05.40 umidihost: 8F70: 07 25 01 00 00 00 00 09-04 02 02 01 FF 02 01 00
00:00:05.40 umidihost: 8F80: 07 24 01 04 00 03 00 0B-24 02 01 02 04 20 01 80
00:00:05.41 umidihost: 8F90: BB 00 06 24 F1 04 56 00-07 05 8E 25 3C 00 01 07
00:00:05.42 umidihost: 8FA0: 25 01 00 00 00 00 09 04-03 00 02 FF 03 00 00 06
00:00:05.42 umidihost: 8FB0: 24 F1 02 01 01 07 05 03-02 00 02 01 07 05 84 02
00:00:05.43 umidihost: 8FC0: 00 02 00 09 04 03 01 02-FF 03 00 00 07 05 03 03
00:00:05.44 umidihost: 8FD0: 00 02 04 07 05 85 03 00-02 04 FF FF FF FF FF FF

[rsta2]

OK, here is another patch, which should at least do the descriptor handling for the JD-08 right:

diff --git a/lib/usb/usbdevicefactory.cpp b/lib/usb/usbdevicefactory.cpp
index 099f8a98..0a92b5cc 100644
--- a/lib/usb/usbdevicefactory.cpp
+++ b/lib/usb/usbdevicefactory.cpp
@@ -173,7 +173,8 @@ CUSBFunction *CUSBDeviceFactory::GetDevice (CUSBFunction *pParent, CString *pNam
 #endif
 #ifndef EXCLUDE_USB_MIDI
 	else if (   pName->Compare ("int1-3-0") == 0
-		 || pName->Compare ("ven582-12a") == 0)		// Roland UM-ONE MIDI interface
+		 || pName->Compare ("ven582-12a") == 0		// Roland UM-ONE MIDI interface
+		 || pName->Compare ("ven582-28c") == 0)		// Roland JD-08
 	{
 		pResult = new CUSBMIDIHostDevice (pParent);
 	}
diff --git a/lib/usb/usbmidihost.cpp b/lib/usb/usbmidihost.cpp
index 1d1f19b5..90d221e5 100644
--- a/lib/usb/usbmidihost.cpp
+++ b/lib/usb/usbmidihost.cpp
@@ -43,6 +43,18 @@ CUSBMIDIHostDevice::CUSBMIDIHostDevice (CUSBFunction *pFunction)
 	m_pPacketBuffer (0),
 	m_hTimer (0)
 {
+	const TUSBDeviceDescriptor *pDeviceDesc = GetDevice ()->GetDeviceDescriptor ();
+	assert (pDeviceDesc != 0);
+
+	// special handling for Roland JD-08
+	if (   pDeviceDesc->idVendor  == 0x0582
+	    && pDeviceDesc->idProduct == 0x028C)
+	{
+		if (!SelectInterfaceByClass (255, 3, 0))
+		{
+			CLogger::Get ()->Write (FromMIDI, LogError, "Cannot select interface");
+		}
+	}
 }
 
 CUSBMIDIHostDevice::~CUSBMIDIHostDevice (void)
@@ -75,11 +87,12 @@ boolean CUSBMIDIHostDevice::Configure (void)
 		return FALSE;
 	}
 
-	// special handling for Roland UM-ONE MIDI interface
+	// special handling for Roland UM-ONE and JD-08
 	const TUSBDeviceDescriptor *pDeviceDesc = GetDevice ()->GetDeviceDescriptor ();
 	assert (pDeviceDesc != 0);
-	boolean bIsRolandUMOne =    pDeviceDesc->idVendor  == 0x0582
-				 && pDeviceDesc->idProduct == 0x012A;
+	boolean bIsRoland =    pDeviceDesc->idVendor == 0x0582
+			    && (   pDeviceDesc->idProduct == 0x012A
+			        || pDeviceDesc->idProduct == 0x028C);
 
 	// Our strategy for now is simple: we'll take the first MIDI streaming
 	// bulk-in endpoint on this interface we can find.  To distinguish
@@ -96,7 +109,7 @@ boolean CUSBMIDIHostDevice::Configure (void)
 			continue;
 		}
 
-		if (!bIsRolandUMOne)
+		if (!bIsRoland)
 		{
 			TUSBMIDIStreamingEndpointDescriptor *pMIDIDesc =
 				(TUSBMIDIStreamingEndpointDescriptor *) GetDescriptor (DESCRIPTOR_CS_ENDPOINT);

The necessary modification in devicefactory.cpp is included.

[nickverlinden]

Amazing Rene, it works. Thank you very much!

[rsta2]

You are welcome. I added the patch to the develop branch. Thanks for testing!