2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 * This program is dual-licensed; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
27 * For more information contact:
28 * Pulse-Eight Licensing <license@pulse-eight.com>
29 * http://www.pulse-eight.com/
30 * http://www.pulse-eight.net/
34 #include "USBCECAdapterDetection.h"
35 #include "lib/platform/util/StdString.h"
37 #if defined(__APPLE__)
39 #include <sys/param.h>
40 #include <IOKit/IOKitLib.h>
41 #include <IOKit/IOMessage.h>
42 #include <IOKit/IOCFPlugIn.h>
43 #include <IOKit/usb/IOUSBLib.h>
44 #include <IOKit/serial/IOSerialKeys.h>
45 #include <CoreFoundation/CoreFoundation.h>
46 #elif defined(__WINDOWS__)
47 #pragma comment(lib, "advapi32.lib")
48 #pragma comment(lib, "setupapi.lib")
49 #pragma comment(lib, "cfgmgr32.lib")
53 // the virtual COM port only shows up when requesting devices with the raw device guid!
54 static GUID USB_RAW_GUID
= { 0xA5DCBF10, 0x6530, 0x11D2, { 0x90, 0x1F, 0x00, 0xC0, 0x4F, 0xB9, 0x51, 0xED } };
55 static GUID USB_CDC_GUID
= { 0x4D36E978, 0xE325, 0x11CE, { 0xBF, 0xC1, 0x08, 0x00, 0x2B, 0xE1, 0x03, 0x18 } };
57 #elif defined(HAVE_LIBUDEV)
63 #elif defined(__FreeBSD__)
68 #define CEC_VID 0x2548
69 #define CEC_PID 0x1001
70 #define CEC_PID2 0x1002
75 #if defined(HAVE_LIBUDEV)
76 bool TranslateComPort(CStdString
&strString
)
78 CStdString
strTmp(strString
);
80 int iSlash
= strTmp
.Find('/');
83 strTmp
= strTmp
.Left(iSlash
);
85 strString
.Format("%s/%s:1.0/tty", strString
.c_str(), strTmp
.c_str());
92 bool FindComPort(CStdString
&strLocation
)
94 CStdString strPort
= strLocation
;
95 bool bReturn(!strPort
.IsEmpty());
96 CStdString
strConfigLocation(strLocation
);
97 if (TranslateComPort(strConfigLocation
))
100 struct dirent
*dirent
;
101 if((dir
= opendir(strConfigLocation
.c_str())) == NULL
)
104 while ((dirent
= readdir(dir
)) != NULL
)
106 if(strcmp((char*)dirent
->d_name
, "." ) != 0 && strcmp((char*)dirent
->d_name
, ".." ) != 0)
108 strPort
.Format("/dev/%s", dirent
->d_name
);
109 if (!strPort
.IsEmpty())
111 strLocation
= strPort
;
124 bool CUSBCECAdapterDetection::CanAutodetect(void)
126 #if defined(__APPLE__) || defined(HAVE_LIBUDEV) || defined(__WINDOWS__) || defined(__FreeBSD__)
133 #if defined(__WINDOWS__)
134 static bool GetComPortFromHandle(HDEVINFO hDevHandle
, PSP_DEVINFO_DATA devInfoData
, char* strPortName
, unsigned int iSize
)
137 TCHAR strRegPortName
[256];
138 strRegPortName
[0] = _T('\0');
139 DWORD dwSize
= sizeof(strRegPortName
);
142 HKEY hDeviceKey
= SetupDiOpenDevRegKey(hDevHandle
, devInfoData
, DICS_FLAG_GLOBAL
, 0, DIREG_DEV
, KEY_QUERY_VALUE
);
146 // locate the PortName
147 if ((RegQueryValueEx(hDeviceKey
, _T("PortName"), NULL
, &dwType
, reinterpret_cast<LPBYTE
>(strRegPortName
), &dwSize
) == ERROR_SUCCESS
) &&
148 (dwType
== REG_SZ
) &&
149 _tcslen(strRegPortName
) > 3 &&
150 _tcsnicmp(strRegPortName
, _T("COM"), 3) == 0 &&
151 _ttoi(&(strRegPortName
[3])) > 0)
153 // return the port name
154 snprintf(strPortName
, iSize
, "%s", strRegPortName
);
158 RegCloseKey(hDeviceKey
);
163 static bool FindComPortForComposite(const char* strLocation
, char* strPortName
, unsigned int iSize
)
167 // find all devices of the CDC class
168 HDEVINFO hDevHandle
= SetupDiGetClassDevs(&USB_CDC_GUID
, NULL
, NULL
, DIGCF_PRESENT
);
169 if (hDevHandle
== INVALID_HANDLE_VALUE
)
172 // check all devices, whether they match the location or not
175 for (int iPtr
= 0; !bReturn
&& bGetNext
&& iPtr
< 1024 ; iPtr
++)
179 SP_DEVINFO_DATA devInfoData
;
180 devInfoData
.cbSize
= sizeof(SP_DEVINFO_DATA
);
183 if (!SetupDiEnumDeviceInfo(hDevHandle
, iPtr
, &devInfoData
))
187 // check if the location of the _parent_ device matches
188 DEVINST parentDevInst
;
189 if (CM_Get_Parent(&parentDevInst
, devInfoData
.DevInst
, 0) == CR_SUCCESS
)
191 CM_Get_Device_ID(parentDevInst
, strId
, 512, 0);
194 if (!strncmp(strId
, strLocation
, strlen(strLocation
)))
195 bReturn
= GetComPortFromHandle(hDevHandle
, &devInfoData
, strPortName
, iSize
);
200 SetupDiDestroyDeviceInfoList(hDevHandle
);
205 uint8_t CUSBCECAdapterDetection::FindAdapters(cec_adapter_descriptor
*deviceList
, uint8_t iBufSize
, const char *strDevicePath
/* = NULL */)
209 #if defined(__APPLE__)
210 kern_return_t kresult
;
211 char bsdPath
[MAXPATHLEN
] = {0};
212 io_iterator_t serialPortIterator
;
214 CFMutableDictionaryRef classesToMatch
= IOServiceMatching(kIOSerialBSDServiceValue
);
217 CFDictionarySetValue(classesToMatch
, CFSTR(kIOSerialBSDTypeKey
), CFSTR(kIOSerialBSDModemType
));
218 kresult
= IOServiceGetMatchingServices(kIOMasterPortDefault
, classesToMatch
, &serialPortIterator
);
219 if (kresult
== KERN_SUCCESS
)
221 io_object_t serialService
;
222 while ((serialService
= IOIteratorNext(serialPortIterator
)))
224 int iVendor
= 0, iProduct
= 0;
225 CFTypeRef bsdPathAsCFString
;
227 // fetch the device path.
228 bsdPathAsCFString
= IORegistryEntryCreateCFProperty(serialService
,
229 CFSTR(kIOCalloutDeviceKey
), kCFAllocatorDefault
, 0);
230 if (bsdPathAsCFString
)
232 // convert the path from a CFString to a C (NUL-terminated) string.
233 CFStringGetCString((CFStringRef
)bsdPathAsCFString
, bsdPath
, MAXPATHLEN
- 1, kCFStringEncodingUTF8
);
234 CFRelease(bsdPathAsCFString
);
236 // now walk up the hierarchy until we find the entry with vendor/product IDs
237 io_registry_entry_t parent
;
238 CFTypeRef vendorIdAsCFNumber
= NULL
;
239 CFTypeRef productIdAsCFNumber
= NULL
;
240 kern_return_t kresult
= IORegistryEntryGetParentEntry(serialService
, kIOServicePlane
, &parent
);
241 while (kresult
== KERN_SUCCESS
)
243 vendorIdAsCFNumber
= IORegistryEntrySearchCFProperty(parent
,
244 kIOServicePlane
, CFSTR(kUSBVendorID
), kCFAllocatorDefault
, 0);
245 productIdAsCFNumber
= IORegistryEntrySearchCFProperty(parent
,
246 kIOServicePlane
, CFSTR(kUSBProductID
), kCFAllocatorDefault
, 0);
247 if (vendorIdAsCFNumber
&& productIdAsCFNumber
)
249 CFNumberGetValue((CFNumberRef
)vendorIdAsCFNumber
, kCFNumberIntType
, &iVendor
);
250 CFRelease(vendorIdAsCFNumber
);
251 CFNumberGetValue((CFNumberRef
)productIdAsCFNumber
, kCFNumberIntType
, &iProduct
);
252 CFRelease(productIdAsCFNumber
);
253 IOObjectRelease(parent
);
256 io_registry_entry_t oldparent
= parent
;
257 kresult
= IORegistryEntryGetParentEntry(parent
, kIOServicePlane
, &parent
);
258 IOObjectRelease(oldparent
);
260 if (strlen(bsdPath
) && iVendor
== CEC_VID
&& (iProduct
== CEC_PID
|| iProduct
== CEC_PID2
))
262 if (!strDevicePath
|| !strcmp(bsdPath
, strDevicePath
))
264 // on darwin, the device path is the same as the comm path.
265 if (iFound
== 0 || strcmp(deviceList
[iFound
-1].strComName
, bsdPath
))
267 snprintf(deviceList
[iFound
].strComPath
, sizeof(deviceList
[iFound
].strComPath
), "%s", bsdPath
);
268 snprintf(deviceList
[iFound
].strComName
, sizeof(deviceList
[iFound
].strComName
), "%s", bsdPath
);
269 deviceList
[iFound
].iVendorId
= iVendor
;
270 deviceList
[iFound
].iProductId
= iProduct
;
271 deviceList
[iFound
].adapterType
= ADAPTERTYPE_P8_EXTERNAL
; // will be overridden when not doing a "quick scan" by the actual type
277 IOObjectRelease(serialService
);
280 IOObjectRelease(serialPortIterator
);
282 #elif defined(HAVE_LIBUDEV)
284 if (!(udev
= udev_new()))
287 struct udev_enumerate
*enumerate
;
288 struct udev_list_entry
*devices
, *dev_list_entry
;
289 struct udev_device
*dev
, *pdev
;
290 enumerate
= udev_enumerate_new(udev
);
291 udev_enumerate_scan_devices(enumerate
);
292 devices
= udev_enumerate_get_list_entry(enumerate
);
293 udev_list_entry_foreach(dev_list_entry
, devices
)
296 strPath
= udev_list_entry_get_name(dev_list_entry
);
298 dev
= udev_device_new_from_syspath(udev
, strPath
);
302 pdev
= udev_device_get_parent(udev_device_get_parent(dev
));
303 if (!pdev
|| !udev_device_get_sysattr_value(pdev
,"idVendor") || !udev_device_get_sysattr_value(pdev
, "idProduct"))
305 udev_device_unref(dev
);
309 int iVendor
, iProduct
;
310 sscanf(udev_device_get_sysattr_value(pdev
, "idVendor"), "%x", &iVendor
);
311 sscanf(udev_device_get_sysattr_value(pdev
, "idProduct"), "%x", &iProduct
);
312 if (iVendor
== CEC_VID
&& (iProduct
== CEC_PID
|| iProduct
== CEC_PID2
))
314 CStdString
strPath(udev_device_get_syspath(pdev
));
315 if (!strDevicePath
|| !strcmp(strPath
.c_str(), strDevicePath
))
317 CStdString
strComm(strPath
);
318 if (FindComPort(strComm
) && (iFound
== 0 || strcmp(deviceList
[iFound
-1].strComName
, strComm
.c_str())))
320 snprintf(deviceList
[iFound
].strComPath
, sizeof(deviceList
[iFound
].strComPath
), "%s", strPath
.c_str());
321 snprintf(deviceList
[iFound
].strComName
, sizeof(deviceList
[iFound
].strComName
), "%s", strComm
.c_str());
322 deviceList
[iFound
].iVendorId
= iVendor
;
323 deviceList
[iFound
].iProductId
= iProduct
;
324 deviceList
[iFound
].adapterType
= ADAPTERTYPE_P8_EXTERNAL
; // will be overridden when not doing a "quick scan" by the actual type
329 udev_device_unref(dev
);
332 udev_enumerate_unref(enumerate
);
334 #elif defined(__WINDOWS__)
336 DWORD required
= 0, iMemberIndex
= 0;
339 SP_DEVICE_INTERFACE_DATA deviceInterfaceData
;
340 deviceInterfaceData
.cbSize
= sizeof(SP_DEVICE_INTERFACE_DATA
);
342 SP_DEVINFO_DATA devInfoData
;
343 devInfoData
.cbSize
= sizeof(SP_DEVINFO_DATA
);
346 if ((hDevHandle
= SetupDiGetClassDevs(&USB_RAW_GUID
, 0, 0, DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
)) == INVALID_HANDLE_VALUE
)
350 TCHAR
*buffer
= NULL
;
351 PSP_DEVICE_INTERFACE_DETAIL_DATA devicedetailData
;
352 while(bResult
&& iFound
< iBufSize
)
354 bResult
= SetupDiEnumDeviceInfo(hDevHandle
, iMemberIndex
, &devInfoData
);
357 bResult
= SetupDiEnumDeviceInterfaces(hDevHandle
, 0, &USB_RAW_GUID
, iMemberIndex
, &deviceInterfaceData
);
362 SetupDiDestroyDeviceInfoList(hDevHandle
);
369 BOOL bDetailResult
= false;
371 // As per MSDN, Get the required buffer size. Call SetupDiGetDeviceInterfaceDetail with a
372 // NULL DeviceInterfaceDetailData pointer, a DeviceInterfaceDetailDataSize of zero,
373 // and a valid RequiredSize variable. In response to such a call, this function returns
374 // the required buffer size at RequiredSize and fails with GetLastError returning
375 // ERROR_INSUFFICIENT_BUFFER.
376 // Allocate an appropriately sized buffer and call the function again to get the interface details.
378 SetupDiGetDeviceInterfaceDetail(hDevHandle
, &deviceInterfaceData
, NULL
, 0, &required
, NULL
);
380 buffer
= new TCHAR
[required
];
381 devicedetailData
= (PSP_DEVICE_INTERFACE_DETAIL_DATA
) buffer
;
382 devicedetailData
->cbSize
= sizeof(SP_INTERFACE_DEVICE_DETAIL_DATA
);
383 nBufferSize
= required
;
386 bDetailResult
= SetupDiGetDeviceInterfaceDetail(hDevHandle
, &deviceInterfaceData
, devicedetailData
, nBufferSize
, &required
, NULL
);
390 // check whether the path matches, if a path was given
391 if (strDevicePath
&& strcmp(strDevicePath
, devicedetailData
->DevicePath
) != 0)
394 // get the vid and pid
395 CStdString strVendorId
;
396 CStdString strProductId
;
397 CStdString
strTmp(devicedetailData
->DevicePath
);
398 strVendorId
.assign(strTmp
.substr(strTmp
.Find("vid_") + 4, 4));
399 strProductId
.assign(strTmp
.substr(strTmp
.Find("pid_") + 4, 4));
400 if (strTmp
.Find("&mi_") >= 0 && strTmp
.Find("&mi_00") < 0)
403 int iVendor
, iProduct
;
404 sscanf(strVendorId
, "%x", &iVendor
);
405 sscanf(strProductId
, "%x", &iProduct
);
408 if (iVendor
!= CEC_VID
|| (iProduct
!= CEC_PID
&& iProduct
!= CEC_PID2
))
412 if (iProduct
== CEC_PID2
)
414 // the 1002 pid indicates a composite device, that needs special treatment
416 CM_Get_Device_ID(devInfoData
.DevInst
, strId
, 512, 0);
417 if (FindComPortForComposite(strId
, deviceList
[iFound
].strComName
, sizeof(deviceList
[iFound
].strComName
)))
419 snprintf(deviceList
[iFound
].strComPath
, sizeof(deviceList
[iFound
].strComPath
), "%s", devicedetailData
->DevicePath
);
420 deviceList
[iFound
].iVendorId
= (uint16_t)iVendor
;
421 deviceList
[iFound
].iProductId
= (uint16_t)iProduct
;
422 deviceList
[iFound
].adapterType
= ADAPTERTYPE_P8_EXTERNAL
; // will be overridden when not doing a "quick scan" by the actual type
426 else if (GetComPortFromHandle(hDevHandle
, &devInfoData
, deviceList
[iFound
].strComName
, sizeof(deviceList
[iFound
].strComName
)))
428 snprintf(deviceList
[iFound
].strComPath
, sizeof(deviceList
[iFound
].strComPath
), "%s", devicedetailData
->DevicePath
);
429 deviceList
[iFound
].iVendorId
= (uint16_t)iVendor
;
430 deviceList
[iFound
].iProductId
= (uint16_t)iProduct
;
431 deviceList
[iFound
].adapterType
= ADAPTERTYPE_P8_EXTERNAL
; // will be overridden when not doing a "quick scan" by the actual type
435 #elif defined(__FreeBSD__)
436 char devicePath
[PATH_MAX
+ 1];
439 for (i
= 0; i
< 8; ++i
)
441 (void)snprintf(devicePath
, sizeof(devicePath
), "/dev/ttyU%d", i
);
442 if (strDevicePath
&& strcmp(devicePath
, strDevicePath
) != 0)
444 if (!access(devicePath
, 0))
446 snprintf(deviceList
[iFound
].strComPath
, sizeof(deviceList
[iFound
].strComPath
), "%s", devicePath
);
447 snprintf(deviceList
[iFound
].strComName
, sizeof(deviceList
[iFound
].strComName
), "%s", devicePath
);
448 deviceList
[iFound
].iVendorId
= CEC_VID
;
449 deviceList
[iFound
].iProductId
= CEC_VID
;
450 deviceList
[iFound
].adapterType
= ADAPTERTYPE_P8_EXTERNAL
; // will be overridden when not doing a "quick scan" by the actual type
455 //silence "unused" warnings
457 ((void) strDevicePath
);
460 iBufSize
= 0; if(!iBufSize
){} /* silence "unused" warning on linux/osx */