fpgautils.c 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426
  1. /*
  2. * Copyright 2012-2013 Luke Dashjr
  3. * Copyright 2013 Con Kolivas
  4. * Copyright 2012 Andrew Smith
  5. * Copyright 2013 Xiangfu
  6. *
  7. * This program is free software; you can redistribute it and/or modify it
  8. * under the terms of the GNU General Public License as published by the Free
  9. * Software Foundation; either version 3 of the License, or (at your option)
  10. * any later version. See COPYING for more details.
  11. */
  12. #include "config.h"
  13. #ifdef WIN32
  14. #include <winsock2.h>
  15. #endif
  16. #include <ctype.h>
  17. #include <stdarg.h>
  18. #include <stdbool.h>
  19. #include <stdint.h>
  20. #include <stdlib.h>
  21. #include <sys/types.h>
  22. #include <dirent.h>
  23. #include <string.h>
  24. #ifdef HAVE_SYS_FILE_H
  25. #include <sys/file.h>
  26. #endif
  27. #ifdef HAVE_LIBUSB
  28. #include <libusb.h>
  29. #endif
  30. #include "miner.h"
  31. #ifndef WIN32
  32. #include <errno.h>
  33. #include <termios.h>
  34. #include <sys/ioctl.h>
  35. #include <sys/stat.h>
  36. #include <unistd.h>
  37. #include <fcntl.h>
  38. #ifndef O_CLOEXEC
  39. #define O_CLOEXEC 0
  40. #endif
  41. #else /* WIN32 */
  42. #include <windows.h>
  43. #ifdef HAVE_WIN_DDKUSB
  44. #include <setupapi.h>
  45. #include <usbioctl.h>
  46. #include <usbiodef.h>
  47. #endif
  48. #include <io.h>
  49. #include <utlist.h>
  50. #define dlsym (void*)GetProcAddress
  51. #define dlclose FreeLibrary
  52. typedef unsigned long FT_STATUS;
  53. typedef PVOID FT_HANDLE;
  54. __stdcall FT_STATUS (*FT_ListDevices)(PVOID pArg1, PVOID pArg2, DWORD Flags);
  55. __stdcall FT_STATUS (*FT_Open)(int idx, FT_HANDLE*);
  56. __stdcall FT_STATUS (*FT_GetComPortNumber)(FT_HANDLE, LPLONG lplComPortNumber);
  57. __stdcall FT_STATUS (*FT_Close)(FT_HANDLE);
  58. const uint32_t FT_OPEN_BY_SERIAL_NUMBER = 1;
  59. const uint32_t FT_OPEN_BY_DESCRIPTION = 2;
  60. const uint32_t FT_LIST_ALL = 0x20000000;
  61. const uint32_t FT_LIST_BY_INDEX = 0x40000000;
  62. const uint32_t FT_LIST_NUMBER_ONLY = 0x80000000;
  63. enum {
  64. FT_OK,
  65. };
  66. #endif /* WIN32 */
  67. #ifdef HAVE_LIBUDEV
  68. #include <libudev.h>
  69. #include <sys/ioctl.h>
  70. #endif
  71. #include "logging.h"
  72. #include "lowlevel.h"
  73. #include "miner.h"
  74. #include "util.h"
  75. #include "fpgautils.h"
  76. struct lowlevel_driver lowl_vcom;
  77. struct detectone_meta_info_t detectone_meta_info;
  78. void clear_detectone_meta_info(void)
  79. {
  80. detectone_meta_info = (struct detectone_meta_info_t){
  81. .manufacturer = NULL,
  82. };
  83. }
  84. #define _vcom_unique_id(devpath) devpath_to_devid(devpath)
  85. struct lowlevel_device_info *_vcom_devinfo_findorcreate(struct lowlevel_device_info ** const devinfo_list, const char * const devpath)
  86. {
  87. struct lowlevel_device_info *devinfo;
  88. char * const devid = _vcom_unique_id(devpath);
  89. HASH_FIND_STR(*devinfo_list, devid, devinfo);
  90. if (!devinfo)
  91. {
  92. devinfo = malloc(sizeof(*devinfo));
  93. *devinfo = (struct lowlevel_device_info){
  94. .lowl = &lowl_vcom,
  95. .path = strdup(devpath),
  96. .devid = devid,
  97. };
  98. HASH_ADD_KEYPTR(hh, *devinfo_list, devinfo->devid, strlen(devid), devinfo);
  99. }
  100. else
  101. free(devid);
  102. return devinfo;
  103. }
  104. #ifdef HAVE_LIBUDEV
  105. static
  106. void _decode_udev_enc(char *o, const char *s)
  107. {
  108. while(s[0])
  109. {
  110. if (s[0] == '\\' && s[1] == 'x' && s[2] && s[3])
  111. {
  112. hex2bin((void*)(o++), &s[2], 1);
  113. s += 4;
  114. }
  115. else
  116. (o++)[0] = (s++)[0];
  117. }
  118. o[0] = '\0';
  119. }
  120. static
  121. char *_decode_udev_enc_dup(const char *s)
  122. {
  123. if (!s)
  124. return NULL;
  125. char *o = malloc(strlen(s) + 1);
  126. if (!o)
  127. {
  128. applog(LOG_ERR, "Failed to malloc in _decode_udev_enc_dup");
  129. return NULL;
  130. }
  131. _decode_udev_enc(o, s);
  132. return o;
  133. }
  134. static
  135. void _vcom_devinfo_scan_udev(struct lowlevel_device_info ** const devinfo_list)
  136. {
  137. struct udev *udev = udev_new();
  138. struct udev_enumerate *enumerate = udev_enumerate_new(udev);
  139. struct udev_list_entry *list_entry;
  140. struct lowlevel_device_info *devinfo;
  141. udev_enumerate_add_match_subsystem(enumerate, "tty");
  142. udev_enumerate_add_match_property(enumerate, "ID_SERIAL", "*");
  143. udev_enumerate_scan_devices(enumerate);
  144. udev_list_entry_foreach(list_entry, udev_enumerate_get_list_entry(enumerate)) {
  145. struct udev_device *device = udev_device_new_from_syspath(
  146. udev_enumerate_get_udev(enumerate),
  147. udev_list_entry_get_name(list_entry)
  148. );
  149. if (!device)
  150. continue;
  151. const char * const devpath = udev_device_get_devnode(device);
  152. devinfo = _vcom_devinfo_findorcreate(devinfo_list, devpath);
  153. BFGINIT(devinfo->manufacturer, _decode_udev_enc_dup(udev_device_get_property_value(device, "ID_VENDOR_ENC")));
  154. BFGINIT(devinfo->product, _decode_udev_enc_dup(udev_device_get_property_value(device, "ID_MODEL_ENC")));
  155. BFGINIT(devinfo->serial, _decode_udev_enc_dup(udev_device_get_property_value(device, "ID_SERIAL_SHORT")));
  156. udev_device_unref(device);
  157. }
  158. udev_enumerate_unref(enumerate);
  159. udev_unref(udev);
  160. }
  161. #endif
  162. #ifndef WIN32
  163. static
  164. void _vcom_devinfo_scan_devserial(struct lowlevel_device_info ** const devinfo_list)
  165. {
  166. DIR *D;
  167. struct dirent *de;
  168. const char udevdir[] = "/dev/serial/by-id";
  169. char devpath[sizeof(udevdir) + 1 + NAME_MAX];
  170. char *devfile = devpath + sizeof(udevdir);
  171. struct lowlevel_device_info *devinfo;
  172. D = opendir(udevdir);
  173. if (!D)
  174. return;
  175. memcpy(devpath, udevdir, sizeof(udevdir) - 1);
  176. devpath[sizeof(udevdir) - 1] = '/';
  177. while ( (de = readdir(D)) ) {
  178. if (strncmp(de->d_name, "usb-", 4))
  179. continue;
  180. strcpy(devfile, de->d_name);
  181. devinfo = _vcom_devinfo_findorcreate(devinfo_list, devpath);
  182. if (!(devinfo->manufacturer || devinfo->product || devinfo->serial))
  183. devinfo->product = strdup(devfile);
  184. }
  185. closedir(D);
  186. }
  187. #endif
  188. #ifndef WIN32
  189. static
  190. char *_sysfs_do_read(char *buf, size_t bufsz, const char *devpath, char *devfile, const char *append)
  191. {
  192. FILE *F;
  193. strcpy(devfile, append);
  194. F = fopen(devpath, "r");
  195. if (F)
  196. {
  197. if (fgets(buf, bufsz, F))
  198. {
  199. size_t L = strlen(buf);
  200. while (isCspace(buf[--L]))
  201. buf[L] = '\0';
  202. }
  203. else
  204. buf[0] = '\0';
  205. fclose(F);
  206. }
  207. else
  208. buf[0] = '\0';
  209. return buf[0] ? buf : NULL;
  210. }
  211. static
  212. void _sysfs_find_tty(char *devpath, char *devfile, const char *prod, struct lowlevel_device_info ** const devinfo_list)
  213. {
  214. struct lowlevel_device_info *devinfo;
  215. DIR *DT;
  216. struct dirent *de;
  217. char ttybuf[0x10] = "/dev/";
  218. char manuf[0x40], serial[0x40];
  219. char *mydevfile = strdup(devfile);
  220. DT = opendir(devpath);
  221. if (!DT)
  222. goto out;
  223. while ( (de = readdir(DT)) )
  224. {
  225. if (strncmp(de->d_name, "tty", 3))
  226. continue;
  227. if (!de->d_name[3])
  228. {
  229. // "tty" directory: recurse (needed for ttyACM)
  230. sprintf(devfile, "%s/tty", mydevfile);
  231. _sysfs_find_tty(devpath, devfile, prod, devinfo_list);
  232. continue;
  233. }
  234. if (strncmp(&de->d_name[3], "USB", 3) && strncmp(&de->d_name[3], "ACM", 3))
  235. continue;
  236. strcpy(&ttybuf[5], de->d_name);
  237. devinfo = _vcom_devinfo_findorcreate(devinfo_list, ttybuf);
  238. BFGINIT(devinfo->manufacturer, maybe_strdup(_sysfs_do_read(manuf, sizeof(manuf), devpath, devfile, "/manufacturer")));
  239. BFGINIT(devinfo->product, maybe_strdup(prod));
  240. BFGINIT(devinfo->serial, maybe_strdup(_sysfs_do_read(serial, sizeof(serial), devpath, devfile, "/serial")));
  241. }
  242. closedir(DT);
  243. out:
  244. free(mydevfile);
  245. }
  246. static
  247. void _vcom_devinfo_scan_sysfs(struct lowlevel_device_info ** const devinfo_list)
  248. {
  249. DIR *D, *DS;
  250. struct dirent *de;
  251. const char devroot[] = "/sys/bus/usb/devices";
  252. const size_t devrootlen = sizeof(devroot) - 1;
  253. char devpath[sizeof(devroot) + (NAME_MAX * 3)];
  254. char prod[0x40];
  255. char *devfile, *upfile;
  256. size_t len, len2;
  257. D = opendir(devroot);
  258. if (!D)
  259. return;
  260. memcpy(devpath, devroot, devrootlen);
  261. devpath[devrootlen] = '/';
  262. while ( (de = readdir(D)) )
  263. {
  264. len = strlen(de->d_name);
  265. upfile = &devpath[devrootlen + 1];
  266. memcpy(upfile, de->d_name, len);
  267. devfile = upfile + len;
  268. if (!_sysfs_do_read(prod, sizeof(prod), devpath, devfile, "/product"))
  269. prod[0] = '\0';
  270. devfile[0] = '\0';
  271. DS = opendir(devpath);
  272. if (!DS)
  273. continue;
  274. devfile[0] = '/';
  275. ++devfile;
  276. while ( (de = readdir(DS)) )
  277. {
  278. if (strncmp(de->d_name, upfile, len))
  279. continue;
  280. len2 = strlen(de->d_name);
  281. memcpy(devfile, de->d_name, len2 + 1);
  282. _sysfs_find_tty(devpath, devfile, prod[0] ? prod : NULL, devinfo_list);
  283. }
  284. closedir(DS);
  285. }
  286. closedir(D);
  287. }
  288. #endif
  289. #ifdef HAVE_WIN_DDKUSB
  290. static const GUID WIN_GUID_DEVINTERFACE_USB_HOST_CONTROLLER = { 0x3ABF6F2D, 0x71C4, 0x462A, {0x8A, 0x92, 0x1E, 0x68, 0x61, 0xE6, 0xAF, 0x27} };
  291. static
  292. char *windows_usb_get_port_path(HANDLE hubh, const int portno)
  293. {
  294. size_t namesz;
  295. ULONG rsz;
  296. {
  297. USB_NODE_CONNECTION_NAME pathinfo = {
  298. .ConnectionIndex = portno,
  299. };
  300. if (!(DeviceIoControl(hubh, IOCTL_USB_GET_NODE_CONNECTION_NAME, &pathinfo, sizeof(pathinfo), &pathinfo, sizeof(pathinfo), &rsz, NULL) && rsz >= sizeof(pathinfo)))
  301. applogfailinfor(NULL, LOG_ERR, "ioctl (1)", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  302. namesz = pathinfo.ActualLength;
  303. }
  304. const size_t bufsz = sizeof(USB_NODE_CONNECTION_NAME) + namesz;
  305. uint8_t buf[bufsz];
  306. USB_NODE_CONNECTION_NAME *path = (USB_NODE_CONNECTION_NAME *)buf;
  307. *path = (USB_NODE_CONNECTION_NAME){
  308. .ConnectionIndex = portno,
  309. };
  310. if (!(DeviceIoControl(hubh, IOCTL_USB_GET_NODE_CONNECTION_NAME, path, bufsz, path, bufsz, &rsz, NULL) && rsz >= sizeof(*path)))
  311. applogfailinfor(NULL, LOG_ERR, "ioctl (2)", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  312. return ucs2tochar_dup(path->NodeName, path->ActualLength);
  313. }
  314. static
  315. char *windows_usb_get_string(HANDLE hubh, const int portno, const uint8_t descid)
  316. {
  317. if (!descid)
  318. return NULL;
  319. const size_t descsz_max = sizeof(USB_STRING_DESCRIPTOR) + MAXIMUM_USB_STRING_LENGTH;
  320. const size_t reqsz = sizeof(USB_DESCRIPTOR_REQUEST) + descsz_max;
  321. uint8_t buf[reqsz];
  322. USB_DESCRIPTOR_REQUEST * const req = (USB_DESCRIPTOR_REQUEST *)buf;
  323. USB_STRING_DESCRIPTOR * const desc = (USB_STRING_DESCRIPTOR *)&req[1];
  324. *req = (USB_DESCRIPTOR_REQUEST){
  325. .ConnectionIndex = portno,
  326. .SetupPacket = {
  327. .wValue = (USB_STRING_DESCRIPTOR_TYPE << 8) | descid,
  328. .wIndex = 0,
  329. .wLength = descsz_max,
  330. },
  331. };
  332. // Need to explicitly zero the output memory
  333. memset(desc, '\0', descsz_max);
  334. ULONG descsz;
  335. if (!DeviceIoControl(hubh, IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION, req, reqsz, req, reqsz, &descsz, NULL))
  336. applogfailinfor(NULL, LOG_DEBUG, "ioctl", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  337. if (descsz < 2 || desc->bDescriptorType != USB_STRING_DESCRIPTOR_TYPE || desc->bLength > descsz - sizeof(USB_DESCRIPTOR_REQUEST) || desc->bLength % 2)
  338. applogfailr(NULL, LOG_ERR, "sanity check");
  339. return ucs2tochar_dup(desc->bString, desc->bLength);
  340. }
  341. static void _vcom_devinfo_scan_windows__hub(struct lowlevel_device_info **, const char *);
  342. static
  343. void _vcom_devinfo_scan_windows__hubport(struct lowlevel_device_info ** const devinfo_list, HANDLE hubh, const int portno)
  344. {
  345. struct lowlevel_device_info *devinfo;
  346. const size_t conninfosz = sizeof(USB_NODE_CONNECTION_INFORMATION) + (sizeof(USB_PIPE_INFO) * 30);
  347. uint8_t buf[conninfosz];
  348. USB_NODE_CONNECTION_INFORMATION * const conninfo = (USB_NODE_CONNECTION_INFORMATION *)buf;
  349. conninfo->ConnectionIndex = portno;
  350. ULONG respsz;
  351. if (!DeviceIoControl(hubh, IOCTL_USB_GET_NODE_CONNECTION_INFORMATION, conninfo, conninfosz, conninfo, conninfosz, &respsz, NULL))
  352. applogfailinfor(, LOG_ERR, "ioctl", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  353. if (conninfo->ConnectionStatus != DeviceConnected)
  354. return;
  355. if (conninfo->DeviceIsHub)
  356. {
  357. const char * const hubpath = windows_usb_get_port_path(hubh, portno);
  358. if (hubpath)
  359. _vcom_devinfo_scan_windows__hub(devinfo_list, hubpath);
  360. return;
  361. }
  362. const USB_DEVICE_DESCRIPTOR * const devdesc = &conninfo->DeviceDescriptor;
  363. char * const serial = windows_usb_get_string(hubh, portno, devdesc->iSerialNumber);
  364. if (!serial)
  365. {
  366. out:
  367. free(serial);
  368. return;
  369. }
  370. const size_t slen = strlen(serial);
  371. char subkey[52 + slen + 18 + 1];
  372. sprintf(subkey, "SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_%04x&PID_%04x\\%s\\Device Parameters",
  373. (unsigned)devdesc->idVendor, (unsigned)devdesc->idProduct, serial);
  374. HKEY hkey;
  375. int e;
  376. if (ERROR_SUCCESS != (e = RegOpenKey(HKEY_LOCAL_MACHINE, subkey, &hkey)))
  377. {
  378. applogfailinfo(LOG_ERR, "open Device Parameters registry key", "%s", bfg_strerror(e, BST_SYSTEM));
  379. goto out;
  380. }
  381. char devpath[0x10] = "\\\\.\\";
  382. DWORD type, sz = sizeof(devpath) - 4;
  383. if (ERROR_SUCCESS != (e = RegQueryValueExA(hkey, "PortName", NULL, &type, (LPBYTE)&devpath[4], &sz)))
  384. {
  385. applogfailinfo(LOG_ERR, "get PortName registry key value", "%s", bfg_strerror(e, BST_SYSTEM));
  386. RegCloseKey(hkey);
  387. goto out;
  388. }
  389. RegCloseKey(hkey);
  390. if (type != REG_SZ)
  391. {
  392. applogfailinfor(, LOG_ERR, "get expected type for PortName registry key value", "%ld", (long)type);
  393. goto out;
  394. }
  395. devinfo = _vcom_devinfo_findorcreate(devinfo_list, devpath);
  396. BFGINIT(devinfo->manufacturer, windows_usb_get_string(hubh, portno, devdesc->iManufacturer));
  397. BFGINIT(devinfo->product, windows_usb_get_string(hubh, portno, devdesc->iProduct));
  398. if (devinfo->serial)
  399. free(serial);
  400. else
  401. devinfo->serial = serial;
  402. }
  403. static
  404. void _vcom_devinfo_scan_windows__hub(struct lowlevel_device_info ** const devinfo_list, const char * const hubpath)
  405. {
  406. HANDLE hubh;
  407. USB_NODE_INFORMATION nodeinfo;
  408. {
  409. char deviceName[4 + strlen(hubpath) + 1];
  410. sprintf(deviceName, "\\\\.\\%s", hubpath);
  411. hubh = CreateFile(deviceName, GENERIC_WRITE, FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL);
  412. if (hubh == INVALID_HANDLE_VALUE)
  413. applogr(, LOG_ERR, "Error opening USB hub device %s for autodetect: %s", deviceName, bfg_strerror(GetLastError(), BST_SYSTEM));
  414. }
  415. ULONG nBytes;
  416. if (!DeviceIoControl(hubh, IOCTL_USB_GET_NODE_INFORMATION, &nodeinfo, sizeof(nodeinfo), &nodeinfo, sizeof(nodeinfo), &nBytes, NULL))
  417. applogfailinfor(, LOG_ERR, "ioctl", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  418. const int portcount = nodeinfo.u.HubInformation.HubDescriptor.bNumberOfPorts;
  419. for (int i = 1; i <= portcount; ++i)
  420. _vcom_devinfo_scan_windows__hubport(devinfo_list, hubh, i);
  421. CloseHandle(hubh);
  422. }
  423. static
  424. char *windows_usb_get_root_hub_path(HANDLE hcntlrh)
  425. {
  426. size_t namesz;
  427. ULONG rsz;
  428. {
  429. USB_ROOT_HUB_NAME pathinfo;
  430. if (!(DeviceIoControl(hcntlrh, IOCTL_USB_GET_ROOT_HUB_NAME, 0, 0, &pathinfo, sizeof(pathinfo), &rsz, NULL) && rsz >= sizeof(pathinfo)))
  431. applogfailinfor(NULL, LOG_ERR, "ioctl (1)", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  432. namesz = pathinfo.ActualLength;
  433. }
  434. const size_t bufsz = sizeof(USB_ROOT_HUB_NAME) + namesz;
  435. uint8_t buf[bufsz];
  436. USB_ROOT_HUB_NAME *hubpath = (USB_ROOT_HUB_NAME *)buf;
  437. if (!(DeviceIoControl(hcntlrh, IOCTL_USB_GET_ROOT_HUB_NAME, NULL, 0, hubpath, bufsz, &rsz, NULL) && rsz >= sizeof(*hubpath)))
  438. applogfailinfor(NULL, LOG_ERR, "ioctl (2)", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  439. return ucs2tochar_dup(hubpath->RootHubName, hubpath->ActualLength);
  440. }
  441. static
  442. void _vcom_devinfo_scan_windows__hcntlr(struct lowlevel_device_info ** const devinfo_list, HDEVINFO *devinfo, const int i)
  443. {
  444. SP_DEVICE_INTERFACE_DATA devifacedata = {
  445. .cbSize = sizeof(devifacedata),
  446. };
  447. if (!SetupDiEnumDeviceInterfaces(*devinfo, 0, (LPGUID)&WIN_GUID_DEVINTERFACE_USB_HOST_CONTROLLER, i, &devifacedata))
  448. applogfailinfor(, LOG_ERR, "SetupDiEnumDeviceInterfaces", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  449. DWORD detailsz;
  450. if (!(!SetupDiGetDeviceInterfaceDetail(*devinfo, &devifacedata, NULL, 0, &detailsz, NULL) && GetLastError() == ERROR_INSUFFICIENT_BUFFER))
  451. applogfailinfor(, LOG_ERR, "SetupDiEnumDeviceInterfaceDetail (1)", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  452. PSP_DEVICE_INTERFACE_DETAIL_DATA detail = alloca(detailsz);
  453. detail->cbSize = sizeof(*detail);
  454. if (!SetupDiGetDeviceInterfaceDetail(*devinfo, &devifacedata, detail, detailsz, &detailsz, NULL))
  455. applogfailinfor(, LOG_ERR, "SetupDiEnumDeviceInterfaceDetail (2)", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  456. HANDLE hcntlrh = CreateFile(detail->DevicePath, GENERIC_WRITE, FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL);
  457. if (hcntlrh == INVALID_HANDLE_VALUE)
  458. applogfailinfor(, LOG_DEBUG, "open USB host controller device", "%s", bfg_strerror(GetLastError(), BST_SYSTEM));
  459. char * const hubpath = windows_usb_get_root_hub_path(hcntlrh);
  460. CloseHandle(hcntlrh);
  461. _vcom_devinfo_scan_windows__hub(devinfo_list, hubpath);
  462. free(hubpath);
  463. }
  464. static
  465. void _vcom_devinfo_scan_windows(struct lowlevel_device_info ** const devinfo_list)
  466. {
  467. HDEVINFO devinfo;
  468. devinfo = SetupDiGetClassDevs(&WIN_GUID_DEVINTERFACE_USB_HOST_CONTROLLER, NULL, NULL, (DIGCF_PRESENT | DIGCF_DEVICEINTERFACE));
  469. SP_DEVINFO_DATA devinfodata = {
  470. .cbSize = sizeof(devinfodata),
  471. };
  472. for (int i = 0; SetupDiEnumDeviceInfo(devinfo, i, &devinfodata); ++i)
  473. _vcom_devinfo_scan_windows__hcntlr(devinfo_list, &devinfo, i);
  474. SetupDiDestroyDeviceInfoList(devinfo);
  475. }
  476. #endif
  477. #ifdef WIN32
  478. #define LOAD_SYM(sym) do { \
  479. if (!(sym = dlsym(dll, #sym))) { \
  480. applog(LOG_DEBUG, "Failed to load " #sym ", not using FTDI autodetect"); \
  481. goto out; \
  482. } \
  483. } while(0)
  484. static
  485. char *_ftdi_get_string(char *buf, int i, DWORD flags)
  486. {
  487. if (FT_OK != FT_ListDevices((PVOID)i, buf, FT_LIST_BY_INDEX | flags))
  488. return NULL;
  489. return buf[0] ? buf : NULL;
  490. }
  491. static
  492. void _vcom_devinfo_scan_ftdi(struct lowlevel_device_info ** const devinfo_list)
  493. {
  494. char devpath[] = "\\\\.\\COMnnnnn";
  495. char *devpathnum = &devpath[7];
  496. char **bufptrs;
  497. char *buf;
  498. char serial[64];
  499. struct lowlevel_device_info *devinfo;
  500. DWORD i;
  501. FT_STATUS ftStatus;
  502. DWORD numDevs;
  503. HMODULE dll = LoadLibrary("FTD2XX.DLL");
  504. if (!dll) {
  505. applog(LOG_DEBUG, "FTD2XX.DLL failed to load, not using FTDI autodetect");
  506. return;
  507. }
  508. LOAD_SYM(FT_ListDevices);
  509. LOAD_SYM(FT_Open);
  510. LOAD_SYM(FT_GetComPortNumber);
  511. LOAD_SYM(FT_Close);
  512. ftStatus = FT_ListDevices(&numDevs, NULL, FT_LIST_NUMBER_ONLY);
  513. if (ftStatus != FT_OK) {
  514. applog(LOG_DEBUG, "FTDI device count failed, not using FTDI autodetect");
  515. goto out;
  516. }
  517. applog(LOG_DEBUG, "FTDI reports %u devices", (unsigned)numDevs);
  518. buf = alloca(65 * numDevs);
  519. bufptrs = alloca(sizeof(*bufptrs) * (numDevs + 1));
  520. for (i = 0; i < numDevs; ++i)
  521. bufptrs[i] = &buf[i * 65];
  522. bufptrs[numDevs] = NULL;
  523. ftStatus = FT_ListDevices(bufptrs, &numDevs, FT_LIST_ALL | FT_OPEN_BY_DESCRIPTION);
  524. if (ftStatus != FT_OK) {
  525. applog(LOG_DEBUG, "FTDI device list failed, not using FTDI autodetect");
  526. goto out;
  527. }
  528. for (i = numDevs; i > 0; ) {
  529. --i;
  530. bufptrs[i][64] = '\0';
  531. FT_HANDLE ftHandle;
  532. if (FT_OK != FT_Open(i, &ftHandle))
  533. continue;
  534. LONG lComPortNumber;
  535. ftStatus = FT_GetComPortNumber(ftHandle, &lComPortNumber);
  536. FT_Close(ftHandle);
  537. if (FT_OK != ftStatus || lComPortNumber < 0)
  538. continue;
  539. applog(LOG_ERR, "FT_GetComPortNumber(%p (%ld), %ld)", ftHandle, (long)i, (long)lComPortNumber);
  540. sprintf(devpathnum, "%d", (int)lComPortNumber);
  541. devinfo = _vcom_devinfo_findorcreate(devinfo_list, devpath);
  542. BFGINIT(devinfo->product, (bufptrs[i] && bufptrs[i][0]) ? strdup(bufptrs[i]) : NULL);
  543. BFGINIT(devinfo->serial, maybe_strdup(_ftdi_get_string(serial, i, FT_OPEN_BY_SERIAL_NUMBER)));
  544. }
  545. out:
  546. dlclose(dll);
  547. }
  548. #endif
  549. #ifdef WIN32
  550. extern void _vcom_devinfo_scan_querydosdevice(struct lowlevel_device_info **);
  551. #else
  552. extern void _vcom_devinfo_scan_lsdev(struct lowlevel_device_info **);
  553. #endif
  554. extern bool lowl_usb_attach_kernel_driver(const struct lowlevel_device_info *);
  555. bool vcom_lowl_probe_wrapper(const struct lowlevel_device_info * const info, detectone_func_t detectone)
  556. {
  557. if (info->lowl != &lowl_vcom)
  558. {
  559. if (info->lowl == &lowl_usb)
  560. {
  561. if (lowl_usb_attach_kernel_driver(info))
  562. bfg_need_detect_rescan = true;
  563. }
  564. return false;
  565. }
  566. detectone_meta_info = (struct detectone_meta_info_t){
  567. .manufacturer = info->manufacturer,
  568. .product = info->product,
  569. .serial = info->serial,
  570. };
  571. const bool rv = detectone(info->path);
  572. clear_detectone_meta_info();
  573. return rv;
  574. }
  575. bool _serial_autodetect_found_cb(struct lowlevel_device_info * const devinfo, void *userp)
  576. {
  577. detectone_func_t detectone = userp;
  578. if (bfg_claim_any(NULL, devinfo->path, devinfo->devid))
  579. {
  580. applog(LOG_DEBUG, "%s (%s) is already claimed, skipping probe", devinfo->path, devinfo->devid);
  581. return false;
  582. }
  583. if (devinfo->lowl != &lowl_vcom)
  584. {
  585. if (devinfo->lowl == &lowl_usb)
  586. {
  587. if (lowl_usb_attach_kernel_driver(devinfo))
  588. bfg_need_detect_rescan = true;
  589. }
  590. else
  591. applog(LOG_WARNING, "Non-VCOM %s (%s) matched", devinfo->path, devinfo->devid);
  592. return false;
  593. }
  594. detectone_meta_info = (struct detectone_meta_info_t){
  595. .manufacturer = devinfo->manufacturer,
  596. .product = devinfo->product,
  597. .serial = devinfo->serial,
  598. };
  599. const bool rv = detectone(devinfo->path);
  600. clear_detectone_meta_info();
  601. return rv;
  602. }
  603. int _serial_autodetect(detectone_func_t detectone, ...)
  604. {
  605. va_list needles;
  606. char *needles_array[0x10];
  607. int needlecount = 0;
  608. va_start(needles, detectone);
  609. while ( (needles_array[needlecount++] = va_arg(needles, void *)) )
  610. {}
  611. va_end(needles);
  612. return _lowlevel_detect(_serial_autodetect_found_cb, NULL, (const char **)needles_array, detectone);
  613. }
  614. static
  615. struct lowlevel_device_info *vcom_devinfo_scan()
  616. {
  617. struct lowlevel_device_info *devinfo_hash = NULL;
  618. struct lowlevel_device_info *devinfo_list = NULL;
  619. struct lowlevel_device_info *devinfo, *tmp;
  620. // All 3 USB Strings available:
  621. #ifndef WIN32
  622. _vcom_devinfo_scan_sysfs(&devinfo_hash);
  623. #endif
  624. #ifdef HAVE_WIN_DDKUSB
  625. _vcom_devinfo_scan_windows(&devinfo_hash);
  626. #endif
  627. #ifdef HAVE_LIBUDEV
  628. _vcom_devinfo_scan_udev(&devinfo_hash);
  629. #endif
  630. // Missing Manufacturer:
  631. #ifdef WIN32
  632. _vcom_devinfo_scan_ftdi(&devinfo_hash);
  633. #endif
  634. // All blobbed together:
  635. #ifndef WIN32
  636. _vcom_devinfo_scan_devserial(&devinfo_hash);
  637. #endif
  638. // No info:
  639. #ifdef WIN32
  640. _vcom_devinfo_scan_querydosdevice(&devinfo_hash);
  641. #else
  642. _vcom_devinfo_scan_lsdev(&devinfo_hash);
  643. #endif
  644. // Convert hash to simple list
  645. HASH_ITER(hh, devinfo_hash, devinfo, tmp)
  646. {
  647. LL_PREPEND(devinfo_list, devinfo);
  648. }
  649. return devinfo_list;
  650. }
  651. struct _device_claim {
  652. struct device_drv *drv;
  653. char *devpath;
  654. UT_hash_handle hh;
  655. };
  656. struct device_drv *bfg_claim_any(struct device_drv * const api, const char *verbose, const char * const devpath)
  657. {
  658. static struct _device_claim *claims = NULL;
  659. struct _device_claim *c;
  660. HASH_FIND_STR(claims, devpath, c);
  661. if (c)
  662. {
  663. if (verbose && opt_debug)
  664. {
  665. char logbuf[LOGBUFSIZ];
  666. logbuf[0] = '\0';
  667. if (api)
  668. tailsprintf(logbuf, sizeof(logbuf), "%s device ", api->dname);
  669. if (verbose[0])
  670. tailsprintf(logbuf, sizeof(logbuf), "%s (%s)", verbose, devpath);
  671. else
  672. tailsprintf(logbuf, sizeof(logbuf), "%s", devpath);
  673. tailsprintf(logbuf, sizeof(logbuf), " already claimed by ");
  674. if (api)
  675. tailsprintf(logbuf, sizeof(logbuf), "other ");
  676. tailsprintf(logbuf, sizeof(logbuf), "driver: %s", c->drv->dname);
  677. _applog(LOG_DEBUG, logbuf);
  678. }
  679. return c->drv;
  680. }
  681. if (!api)
  682. return NULL;
  683. c = malloc(sizeof(*c));
  684. c->devpath = strdup(devpath);
  685. c->drv = api;
  686. HASH_ADD_KEYPTR(hh, claims, c->devpath, strlen(devpath), c);
  687. return NULL;
  688. }
  689. struct device_drv *bfg_claim_any2(struct device_drv * const api, const char * const verbose, const char * const llname, const char * const path)
  690. {
  691. const size_t llnamesz = strlen(llname);
  692. const size_t pathsz = strlen(path);
  693. char devpath[llnamesz + 1 + pathsz + 1];
  694. memcpy(devpath, llname, llnamesz);
  695. devpath[llnamesz] = ':';
  696. memcpy(&devpath[llnamesz+1], path, pathsz + 1);
  697. return bfg_claim_any(api, verbose, devpath);
  698. }
  699. char *devpath_to_devid(const char * const devpath)
  700. {
  701. #ifndef WIN32
  702. char *devs = malloc(6 + (sizeof(dev_t) * 2) + 1);
  703. {
  704. struct stat my_stat;
  705. if (stat(devpath, &my_stat))
  706. return NULL;
  707. memcpy(devs, "dev_t:", 6);
  708. bin2hex(&devs[6], &my_stat.st_rdev, sizeof(dev_t));
  709. }
  710. #else
  711. char *p = strstr(devpath, "COM"), *p2;
  712. if (!p)
  713. return NULL;
  714. const int com = strtol(&p[3], &p2, 10);
  715. if (p2 == p)
  716. return NULL;
  717. char dummy;
  718. const int sz = snprintf(&dummy, 1, "%d", com);
  719. char *devs = malloc(4 + sz + 1);
  720. sprintf(devs, "com:%d", com);
  721. #endif
  722. return devs;
  723. }
  724. struct device_drv *bfg_claim_serial(struct device_drv * const api, const bool verbose, const char * const devpath)
  725. {
  726. char * const devs = _vcom_unique_id(devpath);
  727. if (!devs)
  728. return false;
  729. struct device_drv * const rv = bfg_claim_any(api, (verbose ? devpath : NULL), devs);
  730. free(devs);
  731. return rv;
  732. }
  733. char *bfg_make_devid_usb(const uint8_t usbbus, const uint8_t usbaddr)
  734. {
  735. char * const devpath = malloc(12);
  736. sprintf(devpath, "usb:%03u:%03u", (unsigned)usbbus, (unsigned)usbaddr);
  737. return devpath;
  738. }
  739. struct device_drv *bfg_claim_usb(struct device_drv * const api, const bool verbose, const uint8_t usbbus, const uint8_t usbaddr)
  740. {
  741. char * const devpath = bfg_make_devid_usb(usbbus, usbaddr);
  742. struct device_drv * const rv = bfg_claim_any(api, verbose ? "" : NULL, devpath);
  743. free(devpath);
  744. return rv;
  745. }
  746. #ifdef HAVE_LIBUSB
  747. void cgpu_copy_libusb_strings(struct cgpu_info *cgpu, libusb_device *usb)
  748. {
  749. unsigned char buf[0x20];
  750. libusb_device_handle *h;
  751. struct libusb_device_descriptor desc;
  752. if (LIBUSB_SUCCESS != libusb_open(usb, &h))
  753. return;
  754. if (libusb_get_device_descriptor(usb, &desc))
  755. {
  756. libusb_close(h);
  757. return;
  758. }
  759. if ((!cgpu->dev_manufacturer) && libusb_get_string_descriptor_ascii(h, desc.iManufacturer, buf, sizeof(buf)) >= 0)
  760. cgpu->dev_manufacturer = strdup((void *)buf);
  761. if ((!cgpu->dev_product) && libusb_get_string_descriptor_ascii(h, desc.iProduct, buf, sizeof(buf)) >= 0)
  762. cgpu->dev_product = strdup((void *)buf);
  763. if ((!cgpu->dev_serial) && libusb_get_string_descriptor_ascii(h, desc.iSerialNumber, buf, sizeof(buf)) >= 0)
  764. cgpu->dev_serial = strdup((void *)buf);
  765. libusb_close(h);
  766. }
  767. #endif
  768. // This code is purely for debugging but is very useful for that
  769. // It also took quite a bit of effort so I left it in
  770. // #define TERMIOS_DEBUG 1
  771. // Here to include it at compile time
  772. // It's off by default
  773. #ifndef WIN32
  774. #ifdef TERMIOS_DEBUG
  775. #define BITSSET "Y"
  776. #define BITSNOTSET "N"
  777. int tiospeed(speed_t speed)
  778. {
  779. switch (speed) {
  780. #define IOSPEED(baud) \
  781. case B ## baud: \
  782. return baud; \
  783. // END
  784. #include "iospeeds_local.h"
  785. #undef IOSPEED
  786. default:
  787. return -1;
  788. }
  789. }
  790. void termios_debug(const char *devpath, struct termios *my_termios, const char *msg)
  791. {
  792. applog(LOG_DEBUG, "TIOS: Open %s attributes %s: ispeed=%d ospeed=%d",
  793. devpath, msg, tiospeed(cfgetispeed(my_termios)), tiospeed(cfgetispeed(my_termios)));
  794. #define ISSETI(b) ((my_termios->c_iflag | (b)) ? BITSSET : BITSNOTSET)
  795. applog(LOG_DEBUG, "TIOS: c_iflag: IGNBRK=%s BRKINT=%s IGNPAR=%s PARMRK=%s INPCK=%s ISTRIP=%s INLCR=%s IGNCR=%s ICRNL=%s IUCLC=%s IXON=%s IXANY=%s IOFF=%s IMAXBEL=%s IUTF8=%s",
  796. ISSETI(IGNBRK), ISSETI(BRKINT), ISSETI(IGNPAR), ISSETI(PARMRK),
  797. ISSETI(INPCK), ISSETI(ISTRIP), ISSETI(INLCR), ISSETI(IGNCR),
  798. ISSETI(ICRNL), ISSETI(IUCLC), ISSETI(IXON), ISSETI(IXANY),
  799. ISSETI(IXOFF), ISSETI(IMAXBEL), ISSETI(IUTF8));
  800. #define ISSETO(b) ((my_termios->c_oflag | (b)) ? BITSSET : BITSNOTSET)
  801. #define VALO(b) (my_termios->c_oflag | (b))
  802. applog(LOG_DEBUG, "TIOS: c_oflag: OPOST=%s OLCUC=%s ONLCR=%s OCRNL=%s ONOCR=%s ONLRET=%s OFILL=%s OFDEL=%s NLDLY=%d CRDLY=%d TABDLY=%d BSDLY=%d VTDLY=%d FFDLY=%d",
  803. ISSETO(OPOST), ISSETO(OLCUC), ISSETO(ONLCR), ISSETO(OCRNL),
  804. ISSETO(ONOCR), ISSETO(ONLRET), ISSETO(OFILL), ISSETO(OFDEL),
  805. VALO(NLDLY), VALO(CRDLY), VALO(TABDLY), VALO(BSDLY),
  806. VALO(VTDLY), VALO(FFDLY));
  807. #define ISSETC(b) ((my_termios->c_cflag | (b)) ? BITSSET : BITSNOTSET)
  808. #define VALC(b) (my_termios->c_cflag | (b))
  809. applog(LOG_DEBUG, "TIOS: c_cflag: CBAUDEX=%s CSIZE=%d CSTOPB=%s CREAD=%s PARENB=%s PARODD=%s HUPCL=%s CLOCAL=%s"
  810. #ifdef LOBLK
  811. " LOBLK=%s"
  812. #endif
  813. " CMSPAR=%s CRTSCTS=%s",
  814. ISSETC(CBAUDEX), VALC(CSIZE), ISSETC(CSTOPB), ISSETC(CREAD),
  815. ISSETC(PARENB), ISSETC(PARODD), ISSETC(HUPCL), ISSETC(CLOCAL),
  816. #ifdef LOBLK
  817. ISSETC(LOBLK),
  818. #endif
  819. ISSETC(CMSPAR), ISSETC(CRTSCTS));
  820. #define ISSETL(b) ((my_termios->c_lflag | (b)) ? BITSSET : BITSNOTSET)
  821. applog(LOG_DEBUG, "TIOS: c_lflag: ISIG=%s ICANON=%s XCASE=%s ECHO=%s ECHOE=%s ECHOK=%s ECHONL=%s ECHOCTL=%s ECHOPRT=%s ECHOKE=%s"
  822. #ifdef DEFECHO
  823. " DEFECHO=%s"
  824. #endif
  825. " FLUSHO=%s NOFLSH=%s TOSTOP=%s PENDIN=%s IEXTEN=%s",
  826. ISSETL(ISIG), ISSETL(ICANON), ISSETL(XCASE), ISSETL(ECHO),
  827. ISSETL(ECHOE), ISSETL(ECHOK), ISSETL(ECHONL), ISSETL(ECHOCTL),
  828. ISSETL(ECHOPRT), ISSETL(ECHOKE),
  829. #ifdef DEFECHO
  830. ISSETL(DEFECHO),
  831. #endif
  832. ISSETL(FLUSHO), ISSETL(NOFLSH), ISSETL(TOSTOP), ISSETL(PENDIN),
  833. ISSETL(IEXTEN));
  834. #define VALCC(b) (my_termios->c_cc[b])
  835. applog(LOG_DEBUG, "TIOS: c_cc: VINTR=0x%02x VQUIT=0x%02x VERASE=0x%02x VKILL=0x%02x VEOF=0x%02x VMIN=%u VEOL=0x%02x VTIME=%u VEOL2=0x%02x"
  836. #ifdef VSWTCH
  837. " VSWTCH=0x%02x"
  838. #endif
  839. " VSTART=0x%02x VSTOP=0x%02x VSUSP=0x%02x"
  840. #ifdef VDSUSP
  841. " VDSUSP=0x%02x"
  842. #endif
  843. " VLNEXT=0x%02x VWERASE=0x%02x VREPRINT=0x%02x VDISCARD=0x%02x"
  844. #ifdef VSTATUS
  845. " VSTATUS=0x%02x"
  846. #endif
  847. ,
  848. VALCC(VINTR), VALCC(VQUIT), VALCC(VERASE), VALCC(VKILL),
  849. VALCC(VEOF), VALCC(VMIN), VALCC(VEOL), VALCC(VTIME),
  850. VALCC(VEOL2),
  851. #ifdef VSWTCH
  852. VALCC(VSWTCH),
  853. #endif
  854. VALCC(VSTART), VALCC(VSTOP), VALCC(VSUSP),
  855. #ifdef VDSUSP
  856. VALCC(VDSUSP),
  857. #endif
  858. VALCC(VLNEXT), VALCC(VWERASE),
  859. VALCC(VREPRINT), VALCC(VDISCARD)
  860. #ifdef VSTATUS
  861. ,VALCC(VSTATUS)
  862. #endif
  863. );
  864. }
  865. #endif /* TERMIOS_DEBUG */
  866. speed_t tiospeed_t(int baud)
  867. {
  868. switch (baud) {
  869. #define IOSPEED(baud) \
  870. case baud: \
  871. return B ## baud; \
  872. // END
  873. #include "iospeeds_local.h"
  874. #undef IOSPEED
  875. default:
  876. return B0;
  877. }
  878. }
  879. #endif /* WIN32 */
  880. bool valid_baud(int baud)
  881. {
  882. switch (baud) {
  883. #define IOSPEED(baud) \
  884. case baud: \
  885. return true; \
  886. // END
  887. #include "iospeeds_local.h"
  888. #undef IOSPEED
  889. default:
  890. return false;
  891. }
  892. }
  893. /* NOTE: Linux only supports uint8_t (decisecond) timeouts; limiting it in
  894. * this interface buys us warnings when bad constants are passed in.
  895. */
  896. int serial_open(const char *devpath, unsigned long baud, uint8_t timeout, bool purge)
  897. {
  898. #ifdef WIN32
  899. HANDLE hSerial = CreateFile(devpath, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
  900. if (unlikely(hSerial == INVALID_HANDLE_VALUE))
  901. {
  902. DWORD e = GetLastError();
  903. switch (e) {
  904. case ERROR_ACCESS_DENIED:
  905. applog(LOG_ERR, "Do not have user privileges required to open %s", devpath);
  906. break;
  907. case ERROR_SHARING_VIOLATION:
  908. applog(LOG_ERR, "%s is already in use by another process", devpath);
  909. break;
  910. default:
  911. applog(LOG_DEBUG, "Open %s failed, GetLastError:%u", devpath, (unsigned)e);
  912. break;
  913. }
  914. return -1;
  915. }
  916. // thanks to af_newbie for pointers about this
  917. COMMCONFIG comCfg = {0};
  918. comCfg.dwSize = sizeof(COMMCONFIG);
  919. comCfg.wVersion = 1;
  920. comCfg.dcb.DCBlength = sizeof(DCB);
  921. comCfg.dcb.BaudRate = baud;
  922. comCfg.dcb.fBinary = 1;
  923. comCfg.dcb.fDtrControl = DTR_CONTROL_ENABLE;
  924. comCfg.dcb.fRtsControl = RTS_CONTROL_ENABLE;
  925. comCfg.dcb.ByteSize = 8;
  926. SetCommConfig(hSerial, &comCfg, sizeof(comCfg));
  927. // Code must specify a valid timeout value (0 means don't timeout)
  928. const DWORD ctoms = ((DWORD)timeout * 100);
  929. COMMTIMEOUTS cto = {ctoms, 0, ctoms, 0, ctoms};
  930. SetCommTimeouts(hSerial, &cto);
  931. if (purge) {
  932. PurgeComm(hSerial, PURGE_RXABORT);
  933. PurgeComm(hSerial, PURGE_TXABORT);
  934. PurgeComm(hSerial, PURGE_RXCLEAR);
  935. PurgeComm(hSerial, PURGE_TXCLEAR);
  936. }
  937. return _open_osfhandle((intptr_t)hSerial, 0);
  938. #else
  939. int fdDev = open(devpath, O_RDWR | O_CLOEXEC | O_NOCTTY);
  940. if (unlikely(fdDev == -1))
  941. {
  942. if (errno == EACCES)
  943. applog(LOG_ERR, "Do not have user privileges required to open %s", devpath);
  944. else
  945. applog(LOG_DEBUG, "Open %s failed: %s", devpath, bfg_strerror(errno, BST_ERRNO));
  946. return -1;
  947. }
  948. #if defined(LOCK_EX) && defined(LOCK_NB)
  949. if (likely(!flock(fdDev, LOCK_EX | LOCK_NB)))
  950. applog(LOG_DEBUG, "Acquired exclusive advisory lock on %s", devpath);
  951. else
  952. if (errno == EWOULDBLOCK)
  953. {
  954. applog(LOG_ERR, "%s is already in use by another process", devpath);
  955. close(fdDev);
  956. return -1;
  957. }
  958. else
  959. applog(LOG_WARNING, "Failed to acquire exclusive lock on %s: %s (ignoring)", devpath, bfg_strerror(errno, BST_ERRNO));
  960. #endif
  961. struct termios my_termios;
  962. tcgetattr(fdDev, &my_termios);
  963. #ifdef TERMIOS_DEBUG
  964. termios_debug(devpath, &my_termios, "before");
  965. #endif
  966. if (baud)
  967. {
  968. speed_t speed = tiospeed_t(baud);
  969. if (speed == B0)
  970. applog(LOG_WARNING, "Unrecognized baud rate: %lu", baud);
  971. else
  972. {
  973. cfsetispeed(&my_termios, speed);
  974. cfsetospeed(&my_termios, speed);
  975. }
  976. }
  977. my_termios.c_cflag &= ~(CSIZE | PARENB);
  978. my_termios.c_cflag |= CS8;
  979. my_termios.c_cflag |= CREAD;
  980. #ifdef USE_AVALON
  981. // my_termios.c_cflag |= CRTSCTS;
  982. #endif
  983. my_termios.c_cflag |= CLOCAL;
  984. my_termios.c_iflag &= ~(IGNBRK | BRKINT | PARMRK |
  985. ISTRIP | INLCR | IGNCR | ICRNL | IXON);
  986. my_termios.c_oflag &= ~OPOST;
  987. my_termios.c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
  988. // Code must specify a valid timeout value (0 means don't timeout)
  989. my_termios.c_cc[VTIME] = (cc_t)timeout;
  990. my_termios.c_cc[VMIN] = 0;
  991. #ifdef TERMIOS_DEBUG
  992. termios_debug(devpath, &my_termios, "settings");
  993. #endif
  994. tcsetattr(fdDev, TCSANOW, &my_termios);
  995. #ifdef TERMIOS_DEBUG
  996. tcgetattr(fdDev, &my_termios);
  997. termios_debug(devpath, &my_termios, "after");
  998. #endif
  999. if (purge)
  1000. tcflush(fdDev, TCIOFLUSH);
  1001. return fdDev;
  1002. #endif
  1003. }
  1004. int serial_close(const int fd)
  1005. {
  1006. #if defined(LOCK_EX) && defined(LOCK_NB) && defined(LOCK_UN)
  1007. flock(fd, LOCK_UN);
  1008. #endif
  1009. return close(fd);
  1010. }
  1011. ssize_t _serial_read(int fd, char *buf, size_t bufsiz, char *eol)
  1012. {
  1013. ssize_t len, tlen = 0;
  1014. while (bufsiz) {
  1015. len = read(fd, buf, eol ? 1 : bufsiz);
  1016. if (len < 1)
  1017. break;
  1018. tlen += len;
  1019. if (eol && *eol == buf[0])
  1020. break;
  1021. buf += len;
  1022. bufsiz -= len;
  1023. }
  1024. return tlen;
  1025. }
  1026. #define bailout(...) do { \
  1027. applog(__VA_ARGS__); \
  1028. return NULL; \
  1029. } while(0)
  1030. #define check_magic(L) do { \
  1031. if (1 != fread(buf, 1, 1, f)) \
  1032. bailout(LOG_ERR, "%s: Error reading bitstream ('%c')", \
  1033. repr, L); \
  1034. if (buf[0] != L) \
  1035. bailout(LOG_ERR, "%s: Firmware has wrong magic ('%c')", \
  1036. repr, L); \
  1037. } while(0)
  1038. #define read_str(eng) do { \
  1039. if (1 != fread(buf, 2, 1, f)) \
  1040. bailout(LOG_ERR, "%s: Error reading bitstream (" eng " len)", \
  1041. repr); \
  1042. len = (ubuf[0] << 8) | ubuf[1]; \
  1043. if (len >= sizeof(buf)) \
  1044. bailout(LOG_ERR, "%s: Firmware " eng " too long", \
  1045. repr); \
  1046. if (1 != fread(buf, len, 1, f)) \
  1047. bailout(LOG_ERR, "%s: Error reading bitstream (" eng ")", \
  1048. repr); \
  1049. buf[len] = '\0'; \
  1050. } while(0)
  1051. void _bitstream_not_found(const char *repr, const char *fn)
  1052. {
  1053. applog(LOG_ERR, "ERROR: Unable to load '%s', required for %s to work!", fn, repr);
  1054. applog(LOG_ERR, "ERROR: Please read README.FPGA for instructions");
  1055. }
  1056. FILE *open_xilinx_bitstream(const char *dname, const char *repr, const char *fwfile, unsigned long *out_len)
  1057. {
  1058. char buf[0x100];
  1059. unsigned char *ubuf = (unsigned char*)buf;
  1060. unsigned long len;
  1061. char *p;
  1062. FILE *f = open_bitstream(dname, fwfile);
  1063. if (!f)
  1064. {
  1065. _bitstream_not_found(repr, fwfile);
  1066. return NULL;
  1067. }
  1068. if (1 != fread(buf, 2, 1, f))
  1069. bailout(LOG_ERR, "%s: Error reading bitstream (magic)",
  1070. repr);
  1071. if (buf[0] || buf[1] != 9)
  1072. bailout(LOG_ERR, "%s: Firmware has wrong magic (9)",
  1073. repr);
  1074. if (-1 == fseek(f, 11, SEEK_CUR))
  1075. bailout(LOG_ERR, "%s: Firmware seek failed",
  1076. repr);
  1077. check_magic('a');
  1078. read_str("design name");
  1079. applog(LOG_DEBUG, "%s: Firmware file %s info:",
  1080. repr, fwfile);
  1081. applog(LOG_DEBUG, " Design name: %s", buf);
  1082. p = strrchr(buf, ';') ?: buf;
  1083. p = strrchr(buf, '=') ?: p;
  1084. if (p[0] == '=')
  1085. ++p;
  1086. unsigned long fwusercode = (unsigned long)strtoll(p, &p, 16);
  1087. if (p[0] != '\0')
  1088. bailout(LOG_ERR, "%s: Bad usercode in bitstream file",
  1089. repr);
  1090. if (fwusercode == 0xffffffff)
  1091. bailout(LOG_ERR, "%s: Firmware doesn't support user code",
  1092. repr);
  1093. applog(LOG_DEBUG, " Version: %u, build %u", (unsigned)((fwusercode >> 8) & 0xff), (unsigned)(fwusercode & 0xff));
  1094. check_magic('b');
  1095. read_str("part number");
  1096. applog(LOG_DEBUG, " Part number: %s", buf);
  1097. check_magic('c');
  1098. read_str("build date");
  1099. applog(LOG_DEBUG, " Build date: %s", buf);
  1100. check_magic('d');
  1101. read_str("build time");
  1102. applog(LOG_DEBUG, " Build time: %s", buf);
  1103. check_magic('e');
  1104. if (1 != fread(buf, 4, 1, f))
  1105. bailout(LOG_ERR, "%s: Error reading bitstream (data len)",
  1106. repr);
  1107. len = ((unsigned long)ubuf[0] << 24) | ((unsigned long)ubuf[1] << 16) | (ubuf[2] << 8) | ubuf[3];
  1108. applog(LOG_DEBUG, " Bitstream size: %lu", len);
  1109. *out_len = len;
  1110. return f;
  1111. }
  1112. bool load_bitstream_intelhex(bytes_t *rv, const char *dname, const char *repr, const char *fn)
  1113. {
  1114. char buf[0x100];
  1115. size_t sz;
  1116. uint8_t xsz, xrt;
  1117. uint16_t xaddr;
  1118. FILE *F = open_bitstream(dname, fn);
  1119. if (!F)
  1120. return false;
  1121. while (!feof(F))
  1122. {
  1123. if (unlikely(ferror(F)))
  1124. {
  1125. applog(LOG_ERR, "Error reading '%s'", fn);
  1126. goto ihxerr;
  1127. }
  1128. if (!fgets(buf, sizeof(buf), F))
  1129. goto ihxerr;
  1130. if (unlikely(buf[0] != ':'))
  1131. goto ihxerr;
  1132. if (unlikely(!(
  1133. hex2bin(&xsz, &buf[1], 1)
  1134. && hex2bin((unsigned char*)&xaddr, &buf[3], 2)
  1135. && hex2bin(&xrt, &buf[7], 1)
  1136. )))
  1137. {
  1138. applog(LOG_ERR, "Error parsing in '%s'", fn);
  1139. goto ihxerr;
  1140. }
  1141. switch (xrt)
  1142. {
  1143. case 0: // data
  1144. break;
  1145. case 1: // EOF
  1146. fclose(F);
  1147. return true;
  1148. default:
  1149. applog(LOG_ERR, "Unsupported record type in '%s'", fn);
  1150. goto ihxerr;
  1151. }
  1152. xaddr = be16toh(xaddr);
  1153. sz = bytes_len(rv);
  1154. bytes_resize(rv, xaddr + xsz);
  1155. if (sz < xaddr)
  1156. memset(&bytes_buf(rv)[sz], 0xff, xaddr - sz);
  1157. if (unlikely(!(hex2bin(&bytes_buf(rv)[xaddr], &buf[9], xsz))))
  1158. {
  1159. applog(LOG_ERR, "Error parsing data in '%s'", fn);
  1160. goto ihxerr;
  1161. }
  1162. // TODO: checksum
  1163. }
  1164. ihxerr:
  1165. fclose(F);
  1166. bytes_reset(rv);
  1167. return false;
  1168. }
  1169. bool load_bitstream_bytes(bytes_t *rv, const char *dname, const char *repr, const char *fileprefix)
  1170. {
  1171. FILE *F;
  1172. size_t fplen = strlen(fileprefix);
  1173. char fnbuf[fplen + 4 + 1];
  1174. int e;
  1175. bytes_reset(rv);
  1176. memcpy(fnbuf, fileprefix, fplen);
  1177. strcpy(&fnbuf[fplen], ".bin");
  1178. F = open_bitstream(dname, fnbuf);
  1179. if (F)
  1180. {
  1181. char buf[0x100];
  1182. size_t sz;
  1183. while ( (sz = fread(buf, 1, sizeof(buf), F)) )
  1184. bytes_append(rv, buf, sz);
  1185. e = ferror(F);
  1186. fclose(F);
  1187. if (unlikely(e))
  1188. {
  1189. applog(LOG_ERR, "Error reading '%s'", fnbuf);
  1190. bytes_reset(rv);
  1191. }
  1192. else
  1193. return true;
  1194. }
  1195. strcpy(&fnbuf[fplen], ".ihx");
  1196. if (load_bitstream_intelhex(rv, dname, repr, fnbuf))
  1197. return true;
  1198. // TODO: Xilinx
  1199. _bitstream_not_found(repr, fnbuf);
  1200. return false;
  1201. }
  1202. #ifndef WIN32
  1203. int get_serial_cts(int fd)
  1204. {
  1205. int flags;
  1206. if (!fd)
  1207. return -1;
  1208. ioctl(fd, TIOCMGET, &flags);
  1209. return (flags & TIOCM_CTS) ? 1 : 0;
  1210. }
  1211. int set_serial_rts(int fd, int rts)
  1212. {
  1213. int flags;
  1214. if (!fd)
  1215. return -1;
  1216. ioctl(fd, TIOCMGET, &flags);
  1217. if (rts)
  1218. flags |= TIOCM_RTS;
  1219. else
  1220. flags &= ~TIOCM_RTS;
  1221. ioctl(fd, TIOCMSET, &flags);
  1222. return flags & TIOCM_CTS;
  1223. }
  1224. #else
  1225. int get_serial_cts(const int fd)
  1226. {
  1227. if (!fd)
  1228. return -1;
  1229. const HANDLE fh = (HANDLE)_get_osfhandle(fd);
  1230. if (!fh)
  1231. return -1;
  1232. DWORD flags;
  1233. if (!GetCommModemStatus(fh, &flags))
  1234. return -1;
  1235. return (flags & MS_CTS_ON) ? 1 : 0;
  1236. }
  1237. #endif // ! WIN32
  1238. struct lowlevel_driver lowl_vcom = {
  1239. .dname = "vcom",
  1240. .devinfo_scan = vcom_devinfo_scan,
  1241. };