1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
|
/*
* This file is part of the libjaylink project.
*
* Copyright (C) 2014-2016 Marc Schink <jaylink-dev@marcschink.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#ifdef _WIN32
#include <winsock2.h>
#else
#include <sys/socket.h>
#include <arpa/inet.h>
#endif
#ifdef HAVE_LIBUSB
#include <libusb.h>
#endif
#include "libjaylink.h"
#include "libjaylink-internal.h"
/**
* @file
*
* Device enumeration and handling.
*/
/** @cond PRIVATE */
#define CMD_GET_VERSION 0x01
#define CMD_GET_HW_STATUS 0x07
#define CMD_REGISTER 0x09
#define CMD_GET_HW_INFO 0xc1
#define CMD_GET_COUNTERS 0xc2
#define CMD_GET_FREE_MEMORY 0xd4
#define CMD_GET_CAPS 0xe8
#define CMD_GET_EXT_CAPS 0xed
#define CMD_GET_HW_VERSION 0xf0
#define CMD_READ_CONFIG 0xf2
#define CMD_WRITE_CONFIG 0xf3
#define REG_CMD_REGISTER 0x64
#define REG_CMD_UNREGISTER 0x65
/** Size of the registration header in bytes. */
#define REG_HEADER_SIZE 8
/** Minimum registration information size in bytes. */
#define REG_MIN_SIZE 0x4c
/** Maximum registration information size in bytes. */
#define REG_MAX_SIZE 0x200
/** Size of a connection entry in bytes. */
#define REG_CONN_INFO_SIZE 16
/* The maximum path depth according to the USB 3.0 specification. */
#define MAX_USB_PATH_DEPTH 7
/** @endcond */
/** @private */
JAYLINK_PRIV struct jaylink_device *device_allocate(
struct jaylink_context *ctx)
{
struct jaylink_device *dev;
struct list *list;
dev = malloc(sizeof(struct jaylink_device));
if (!dev)
return NULL;
list = list_prepend(ctx->devs, dev);
if (!list) {
free(dev);
return NULL;
}
ctx->devs = list;
dev->ctx = ctx;
dev->ref_count = 1;
return dev;
}
static struct jaylink_device **allocate_device_list(size_t length)
{
struct jaylink_device **list;
list = malloc(sizeof(struct jaylink_device *) * (length + 1));
if (!list)
return NULL;
list[length] = NULL;
return list;
}
/**
* Get available devices.
*
* @param[in,out] ctx libjaylink context.
* @param[out] devs Newly allocated array which contains instances of available
* devices on success, and undefined on failure. The array is
* NULL-terminated and must be free'd by the caller with
* jaylink_free_devices().
* @param[out] count Number of available devices on success, and undefined on
* failure. Can be NULL.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_MALLOC Memory allocation error.
* @retval JAYLINK_ERR Other error conditions.
*
* @see jaylink_discovery_scan()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_devices(struct jaylink_context *ctx,
struct jaylink_device ***devs, size_t *count)
{
size_t num;
struct list *item;
struct jaylink_device **tmp;
struct jaylink_device *dev;
if (!ctx || !devs)
return JAYLINK_ERR_ARG;
num = list_length(ctx->discovered_devs);
tmp = allocate_device_list(num);
if (!tmp) {
log_err(ctx, "Failed to allocate device list");
return JAYLINK_ERR_MALLOC;
}
item = ctx->discovered_devs;
for (size_t i = 0; i < num; i++) {
dev = (struct jaylink_device *)item->data;
tmp[i] = jaylink_ref_device(dev);
item = item->next;
}
if (count)
*count = num;
*devs = tmp;
return JAYLINK_OK;
}
/**
* Free devices.
*
* @param[in,out] devs Array of device instances. Must be NULL-terminated.
* @param[in] unref Determines whether the device instances should be
* unreferenced.
*
* @see jaylink_get_devices()
*
* @since 0.1.0
*/
JAYLINK_API void jaylink_free_devices(struct jaylink_device **devs, bool unref)
{
if (!devs)
return;
if (unref) {
for (size_t i = 0; devs[i]; i++)
jaylink_unref_device(devs[i]);
}
free(devs);
}
/**
* Get the host interface of a device.
*
* @param[in] dev Device instance.
* @param[out] iface Host interface of the device on success, and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_device_get_host_interface(
const struct jaylink_device *dev,
enum jaylink_host_interface *iface)
{
if (!dev || !iface)
return JAYLINK_ERR_ARG;
*iface = dev->iface;
return JAYLINK_OK;
}
/**
* Get the serial number of a device.
*
* @note This serial number is for enumeration purpose only and might differ
* from the real serial number of the device.
*
* @param[in] dev Device instance.
* @param[out] serial_number Serial number of the device on success, and
* undefined on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_AVAILABLE Serial number is not available.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_device_get_serial_number(
const struct jaylink_device *dev, uint32_t *serial_number)
{
if (!dev || !serial_number)
return JAYLINK_ERR_ARG;
if (!dev->has_serial_number)
return JAYLINK_ERR_NOT_AVAILABLE;
*serial_number = dev->serial_number;
return JAYLINK_OK;
}
/**
* Get the USB address of a device.
*
* @note Identification of a device with the USB address is deprecated and the
* serial number should be used instead.
*
* @param[in] dev Device instance.
* @param[out] address USB address of the device on success, and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_USB only.
*
* @see jaylink_device_get_serial_number()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_device_get_usb_address(
const struct jaylink_device *dev,
enum jaylink_usb_address *address)
{
if (!dev || !address)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_USB)
return JAYLINK_ERR_NOT_SUPPORTED;
#ifdef HAVE_LIBUSB
*address = dev->usb_address;
return JAYLINK_OK;
#else
return JAYLINK_ERR_NOT_SUPPORTED;
#endif
}
/**
* Get the USB bus and port numbers of a device.
*
* @param[in] dev Device instance.
* @param[out] bus The bus number of the device on success and undefined on
* failure.
* @param[out] ports Newly allocated array which contains the port numbers on
* success and is undefined on failure. The array must be
* free'd by the caller.
* @param[out] length Length of the port array on success and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_MALLOC Memory allocation error.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_USB only.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_device_get_usb_bus_ports(
const struct jaylink_device *dev, uint8_t *bus,
uint8_t **ports, size_t *length)
{
if (!dev || !bus || !ports || !length)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_USB)
return JAYLINK_ERR_NOT_SUPPORTED;
#ifdef HAVE_LIBUSB
struct jaylink_context *ctx = dev->ctx;
int ret;
*ports = malloc(MAX_USB_PATH_DEPTH * sizeof(uint8_t));
if (!*ports) {
return JAYLINK_ERR_MALLOC;
}
ret = libusb_get_port_numbers(dev->usb_dev, *ports,
MAX_USB_PATH_DEPTH);
if (ret == LIBUSB_ERROR_OVERFLOW) {
log_err(ctx, "Failed to get port numbers: %s",
libusb_error_name(ret));
return JAYLINK_ERR_ARG;
}
*length = ret;
*bus = libusb_get_bus_number(dev->usb_dev);
return JAYLINK_OK;
#else
return JAYLINK_ERR_NOT_SUPPORTED;
#endif
}
/**
* Get the IPv4 address string of a device.
*
* @param[in] dev Device instance.
* @param[out] address IPv4 address string in quad-dotted decimal format of the
* device on success and undefined on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_TCP only.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_device_get_ipv4_address(
const struct jaylink_device *dev, char *address)
{
if (!dev || !address)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_TCP)
return JAYLINK_ERR_NOT_SUPPORTED;
memcpy(address, dev->ipv4_address, sizeof(dev->ipv4_address));
return JAYLINK_OK;
}
/**
* Get the MAC address of a device.
*
* @param[in] dev Device instance.
* @param[out] address MAC address of the device on success and undefined on
* failure. The length of the MAC address is
* #JAYLINK_MAC_ADDRESS_LENGTH bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_TCP only.
* @retval JAYLINK_ERR_NOT_AVAILABLE MAC address is not available.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_device_get_mac_address(
const struct jaylink_device *dev, uint8_t *address)
{
if (!dev || !address)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_TCP)
return JAYLINK_ERR_NOT_SUPPORTED;
if (!dev->has_mac_address)
return JAYLINK_ERR_NOT_AVAILABLE;
memcpy(address, dev->mac_address, sizeof(dev->mac_address));
return JAYLINK_OK;
}
/**
* Get the hardware version of a device.
*
* @note The hardware type can not be obtained by this function, use
* jaylink_get_hardware_version() instead.
*
* @param[in] dev Device instance.
* @param[out] version Hardware version of the device on success and undefined
* on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_TCP only.
* @retval JAYLINK_ERR_NOT_AVAILABLE Hardware version is not available.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_device_get_hardware_version(
const struct jaylink_device *dev,
struct jaylink_hardware_version *version)
{
if (!dev || !version)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_TCP)
return JAYLINK_ERR_NOT_SUPPORTED;
if (!dev->has_hw_version)
return JAYLINK_ERR_NOT_AVAILABLE;
*version = dev->hw_version;
return JAYLINK_OK;
}
/**
* Get the product name of a device.
*
* @param[in] dev Device instance.
* @param[out] name Product name of the device on success and undefined on
* failure. The maximum length of the product name is
* #JAYLINK_PRODUCT_NAME_MAX_LENGTH bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_TCP only.
* @retval JAYLINK_ERR_NOT_AVAILABLE Product name is not available.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_device_get_product_name(
const struct jaylink_device *dev, char *name)
{
if (!dev || !name)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_TCP)
return JAYLINK_ERR_NOT_SUPPORTED;
if (!dev->has_product_name)
return JAYLINK_ERR_NOT_AVAILABLE;
memcpy(name, dev->product_name, sizeof(dev->product_name));
return JAYLINK_OK;
}
/**
* Get the nickname of a device.
*
* @param[in] dev Device instance.
* @param[out] nickname Nickname of the device on success and undefined on
* failure. The maximum length of the nickname is
* #JAYLINK_NICKNAME_MAX_LENGTH bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_NOT_SUPPORTED Supported for devices with host interface
* #JAYLINK_HIF_TCP only.
* @retval JAYLINK_ERR_NOT_AVAILABLE Nickname is not available.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_device_get_nickname(const struct jaylink_device *dev,
char *nickname)
{
if (!dev || !nickname)
return JAYLINK_ERR_ARG;
if (dev->iface != JAYLINK_HIF_TCP)
return JAYLINK_ERR_NOT_SUPPORTED;
if (!dev->has_nickname)
return JAYLINK_ERR_NOT_AVAILABLE;
memcpy(nickname, dev->nickname, sizeof(dev->nickname));
return JAYLINK_OK;
}
/**
* Increment the reference count of a device.
*
* @param[in,out] dev Device instance.
*
* @return The given device instance on success, or NULL on invalid argument.
*
* @since 0.1.0
*/
JAYLINK_API struct jaylink_device *jaylink_ref_device(
struct jaylink_device *dev)
{
if (!dev)
return NULL;
dev->ref_count++;
return dev;
}
/**
* Decrement the reference count of a device.
*
* @param[in,out] dev Device instance.
*
* @since 0.1.0
*/
JAYLINK_API void jaylink_unref_device(struct jaylink_device *dev)
{
struct jaylink_context *ctx;
if (!dev)
return;
dev->ref_count--;
if (!dev->ref_count) {
ctx = dev->ctx;
ctx->devs = list_remove(dev->ctx->devs, dev);
if (dev->iface == JAYLINK_HIF_USB) {
#ifdef HAVE_LIBUSB
log_dbg(ctx, "Device destroyed (bus:address = "
"%03u:%03u)",
libusb_get_bus_number(dev->usb_dev),
libusb_get_device_address(dev->usb_dev));
libusb_unref_device(dev->usb_dev);
#endif
} else if (dev->iface == JAYLINK_HIF_TCP) {
log_dbg(ctx, "Device destroyed (IPv4 address = %s)",
dev->ipv4_address);
} else {
log_err(ctx, "BUG: Invalid host interface: %u",
dev->iface);
}
free(dev);
}
}
static struct jaylink_device_handle *allocate_device_handle(
struct jaylink_device *dev)
{
struct jaylink_device_handle *devh;
devh = malloc(sizeof(struct jaylink_device_handle));
if (!devh)
return NULL;
devh->dev = jaylink_ref_device(dev);
return devh;
}
static void free_device_handle(struct jaylink_device_handle *devh)
{
jaylink_unref_device(devh->dev);
free(devh);
}
/**
* Open a device.
*
* @param[in,out] dev Device instance.
* @param[out] devh Newly allocated handle for the opened device on success,
* and undefined on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_MALLOC Memory allocation error.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_open(struct jaylink_device *dev,
struct jaylink_device_handle **devh)
{
int ret;
struct jaylink_device_handle *handle;
if (!dev || !devh)
return JAYLINK_ERR_ARG;
handle = allocate_device_handle(dev);
if (!handle) {
log_err(dev->ctx, "Device handle malloc failed");
return JAYLINK_ERR_MALLOC;
}
ret = transport_open(handle);
if (ret != JAYLINK_OK) {
free_device_handle(handle);
return ret;
}
*devh = handle;
return JAYLINK_OK;
}
/**
* Close a device.
*
* @param[in,out] devh Device instance.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_close(struct jaylink_device_handle *devh)
{
int ret;
if (!devh)
return JAYLINK_ERR_ARG;
ret = transport_close(devh);
free_device_handle(devh);
return ret;
}
/**
* Get the device instance from a device handle.
*
* @note The reference count of the device instance is not increased.
*
* @param[in] devh Device handle.
*
* @return The device instance on success, or NULL on invalid argument.
*
* @since 0.1.0
*/
JAYLINK_API struct jaylink_device *jaylink_get_device(
struct jaylink_device_handle *devh)
{
if (!devh)
return NULL;
return devh->dev;
}
/**
* Retrieve the firmware version of a device.
*
* @param[in,out] devh Device handle.
* @param[out] version Newly allocated string which contains the firmware
* version on success, and undefined if @p length is zero
* or on failure. The string is null-terminated and must be
* free'd by the caller.
* @param[out] length Length of the firmware version string including trailing
* null-terminator on success, and undefined on failure.
* Zero if no firmware version string is available.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_MALLOC Memory allocation error.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_firmware_version(
struct jaylink_device_handle *devh, char **version,
size_t *length)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[2];
uint16_t dummy;
char *tmp;
if (!devh || !version || !length)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, 2, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_VERSION;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 2);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
dummy = buffer_get_u16(buf, 0);
*length = dummy;
if (!dummy)
return JAYLINK_OK;
ret = transport_start_read(devh, dummy);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
tmp = malloc(dummy);
if (!tmp) {
log_err(ctx, "Firmware version string malloc failed");
return JAYLINK_ERR_MALLOC;
}
ret = transport_read(devh, (uint8_t *)tmp, dummy);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
free(tmp);
return ret;
}
/* Last byte is reserved for null-terminator. */
tmp[dummy - 1] = 0;
*version = tmp;
return JAYLINK_OK;
}
/**
* Retrieve the hardware information of a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_GET_HW_INFO capability.
*
* @param[in,out] devh Device handle.
* @param[in] mask A bit field where each set bit represents hardware
* information to request. See #jaylink_hardware_info for a
* description of the hardware information and their bit
* positions.
* @param[out] info Array to store the hardware information on success. Its
* content is undefined on failure. The array must be large
* enough to contain at least as many elements as bits set in
* @a mask.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_hardware_info(struct jaylink_device_handle *devh,
uint32_t mask, uint32_t *info)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[5];
unsigned int num;
unsigned int length;
if (!devh || !mask || !info)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
num = 0;
for (unsigned int i = 0; i < 32; i++) {
if (mask & (1 << i))
num++;
}
length = num * sizeof(uint32_t);
ret = transport_start_write_read(devh, 5, length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_HW_INFO;
buffer_set_u32(buf, mask, 1);
ret = transport_write(devh, buf, 5);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, (uint8_t *)info, length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
for (unsigned int i = 0; i < num; i++)
info[i] = buffer_get_u32((uint8_t *)info,
i * sizeof(uint32_t));
return JAYLINK_OK;
}
/**
* Retrieve the counter values of a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_GET_COUNTERS capability.
*
* @param[in,out] devh Device handle.
* @param[in] mask A bit field where each set bit represents a counter value to
* request. See #jaylink_counter for a description of the
* counters and their bit positions.
* @param[out] values Array to store the counter values on success. Its content
* is undefined on failure. The array must be large enough
* to contain at least as many elements as bits set in @p
* mask.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.2.0
*/
JAYLINK_API int jaylink_get_counters(struct jaylink_device_handle *devh,
uint32_t mask, uint32_t *values)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[5];
unsigned int num;
unsigned int length;
if (!devh || !mask || !values)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
num = 0;
for (unsigned int i = 0; i < 32; i++) {
if (mask & (1 << i))
num++;
}
length = num * sizeof(uint32_t);
ret = transport_start_write_read(devh, 5, length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_COUNTERS;
buffer_set_u32(buf, mask, 1);
ret = transport_write(devh, buf, 5);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, (uint8_t *)values, length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
for (unsigned int i = 0; i < num; i++)
values[i] = buffer_get_u32((uint8_t *)values,
i * sizeof(uint32_t));
return JAYLINK_OK;
}
/**
* Retrieve the hardware version of a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_GET_HW_VERSION capability.
*
* @warning This function may return a value for @p version where
* #jaylink_hardware_version::type is not covered by
* #jaylink_hardware_type.
*
* @param[in,out] devh Device handle.
* @param[out] version Hardware version on success, and undefined on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_hardware_version(
struct jaylink_device_handle *devh,
struct jaylink_hardware_version *version)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[4];
uint32_t tmp;
if (!devh || !version)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, 4, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_HW_VERSION;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
tmp = buffer_get_u32(buf, 0);
version->type = (tmp / 1000000) % 100;
version->major = (tmp / 10000) % 100;
version->minor = (tmp / 100) % 100;
version->revision = tmp % 100;
return JAYLINK_OK;
}
/**
* Retrieve the hardware status of a device.
*
* @param[in,out] devh Device handle.
* @param[out] status Hardware status on success, and undefined on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_hardware_status(struct jaylink_device_handle *devh,
struct jaylink_hardware_status *status)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[8];
if (!devh || !status)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, 8, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_HW_STATUS;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 8);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
status->target_voltage = buffer_get_u16(buf, 0);
status->tck = buf[2];
status->tdi = buf[3];
status->tdo = buf[4];
status->tms = buf[5];
status->tres = buf[6];
status->trst = buf[7];
return JAYLINK_OK;
}
/**
* Retrieve the capabilities of a device.
*
* The capabilities are stored in a 32-bit bit array consisting of
* #JAYLINK_DEV_CAPS_SIZE bytes where each individual bit represents a
* capability. The first bit of this array is the least significant bit of the
* first byte and the following bits are sequentially numbered in order of
* increasing bit significance and byte index. A set bit indicates a supported
* capability. See #jaylink_device_capability for a description of the
* capabilities and their bit positions.
*
* @param[in,out] devh Device handle.
* @param[out] caps Buffer to store capabilities on success. Its content is
* undefined on failure. The buffer must be large enough to
* contain at least #JAYLINK_DEV_CAPS_SIZE bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @see jaylink_get_extended_caps()
* @see jaylink_has_cap()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_caps(struct jaylink_device_handle *devh,
uint8_t *caps)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh || !caps)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, JAYLINK_DEV_CAPS_SIZE, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_CAPS;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, caps, JAYLINK_DEV_CAPS_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Retrieve the extended capabilities of a device.
*
* The extended capabilities are stored in a 256-bit bit array consisting of
* #JAYLINK_DEV_EXT_CAPS_SIZE bytes. See jaylink_get_caps() for a further
* description of how the capabilities are represented in this bit array. For a
* description of the capabilities and their bit positions, see
* #jaylink_device_capability.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_GET_EXT_CAPS capability.
*
* @param[in,out] devh Device handle.
* @param[out] caps Buffer to store capabilities on success. Its content is
* undefined on failure. The buffer must be large enough to
* contain at least #JAYLINK_DEV_EXT_CAPS_SIZE bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @see jaylink_get_caps()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_extended_caps(struct jaylink_device_handle *devh,
uint8_t *caps)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh || !caps)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, JAYLINK_DEV_EXT_CAPS_SIZE,
true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_EXT_CAPS;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, caps, JAYLINK_DEV_EXT_CAPS_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Retrieve the size of free memory of a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_GET_FREE_MEMORY capability.
*
* @param[in,out] devh Device handle.
* @param[out] size Size of free memory in bytes on success, and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_get_free_memory(struct jaylink_device_handle *devh,
uint32_t *size)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[4];
if (!devh || !size)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, 4, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_GET_FREE_MEMORY;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
*size = buffer_get_u32(buf, 0);
return JAYLINK_OK;
}
/**
* Read the raw configuration data of a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_READ_CONFIG capability.
*
* @param[in,out] devh Device handle.
* @param[out] config Buffer to store configuration data on success. Its
* content is undefined on failure. The buffer must be large
* enough to contain at least
* #JAYLINK_DEV_CONFIG_SIZE bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_read_raw_config(struct jaylink_device_handle *devh,
uint8_t *config)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh || !config)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 1, JAYLINK_DEV_CONFIG_SIZE,
true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_READ_CONFIG;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, config, JAYLINK_DEV_CONFIG_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Write the raw configuration data of a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_WRITE_CONFIG capability.
*
* @param[in,out] devh Device handle.
* @param[in] config Buffer to write configuration data from. The size of the
* configuration data is expected to be
* #JAYLINK_DEV_CONFIG_SIZE bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_write_raw_config(struct jaylink_device_handle *devh,
const uint8_t *config)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh || !config)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1 + JAYLINK_DEV_CONFIG_SIZE, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_WRITE_CONFIG;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_write(devh, config, JAYLINK_DEV_CONFIG_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
static void parse_conn_table(struct jaylink_connection *conns,
const uint8_t *buffer, uint16_t num, uint16_t entry_size)
{
size_t offset;
struct in_addr in;
offset = 0;
for (unsigned int i = 0; i < num; i++) {
conns[i].pid = buffer_get_u32(buffer, offset);
in.s_addr = buffer_get_u32(buffer, offset + 4);
/*
* Use inet_ntoa() instead of inet_ntop() because the latter
* requires at least Windows Vista.
*/
strcpy(conns[i].hid, inet_ntoa(in));
conns[i].iid = buffer[offset + 8];
conns[i].cid = buffer[offset + 9];
conns[i].handle = buffer_get_u16(buffer, offset + 10);
conns[i].timestamp = buffer_get_u32(buffer, offset + 12);
offset = offset + entry_size;
}
}
static bool _inet_pton(const char *str, struct in_addr *in)
{
#ifdef _WIN32
int ret;
struct sockaddr_in sock_in;
int length;
length = sizeof(sock_in);
/*
* Use WSAStringToAddress() instead of inet_pton() because the latter
* requires at least Windows Vista.
*/
ret = WSAStringToAddress((LPTSTR)str, AF_INET, NULL,
(LPSOCKADDR)&sock_in, &length);
if (ret != 0)
return false;
*in = sock_in.sin_addr;
#else
if (inet_pton(AF_INET, str, in) != 1)
return false;
#endif
return true;
}
/**
* Register a connection on a device.
*
* A connection can be registered by using 0 as handle. Additional information
* about the connection can be attached whereby the timestamp is a read-only
* value and therefore ignored for registration. On success, a new handle
* greater than 0 is obtained from the device.
*
* However, if an obtained handle does not appear in the list of device
* connections, the connection was not registered because the maximum number of
* connections on the device is reached.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_REGISTER capability.
*
* Example code:
* @code{.c}
* static bool register_connection(struct jaylink_device_handle *devh,
* struct jaylink_connection *conn)
* {
* int ret;
* struct jaylink_connection conns[JAYLINK_MAX_CONNECTIONS];
* bool found_handle;
* size_t count;
*
* conn->handle = 0;
* conn->pid = 0;
* strcpy(conn->hid, "0.0.0.0");
* conn->iid = 0;
* conn->cid = 0;
*
* ret = jaylink_register(devh, conn, conns, &count);
*
* if (ret != JAYLINK_OK) {
* printf("jaylink_register() failed: %s.\n",
* jaylink_strerror(ret));
* return false;
* }
*
* found_handle = false;
*
* for (size_t i = 0; i < count; i++) {
* if (conns[i].handle == conn->handle) {
* found_handle = true;
* break;
* }
* }
*
* if (!found_handle) {
* printf("Maximum number of connections reached.\n");
* return false;
* }
*
* printf("Connection successfully registered.\n");
*
* return true;
* }
* @endcode
*
* @param[in,out] devh Device handle.
* @param[in,out] connection Connection to register on the device.
* @param[out] connections Array to store device connections on success.
* Its content is undefined on failure. The array must
* be large enough to contain at least
* #JAYLINK_MAX_CONNECTIONS elements.
* @param[out] count Number of device connections on success, and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_PROTO Protocol violation.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @see jaylink_unregister()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_register(struct jaylink_device_handle *devh,
struct jaylink_connection *connection,
struct jaylink_connection *connections, size_t *count)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[REG_MAX_SIZE];
uint16_t handle;
uint16_t num;
uint16_t entry_size;
uint32_t size;
uint32_t table_size;
uint16_t info_size;
struct in_addr in;
if (!devh || !connection || !connections || !count)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
buf[0] = CMD_REGISTER;
buf[1] = REG_CMD_REGISTER;
buffer_set_u32(buf, connection->pid, 2);
if (!_inet_pton(connection->hid, &in))
return JAYLINK_ERR_ARG;
buffer_set_u32(buf, in.s_addr, 6);
buf[10] = connection->iid;
buf[11] = connection->cid;
buffer_set_u16(buf, connection->handle, 12);
ret = transport_start_write_read(devh, 14, REG_MIN_SIZE, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_write(devh, buf, 14);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, REG_MIN_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
handle = buffer_get_u16(buf, 0);
num = buffer_get_u16(buf, 2);
entry_size = buffer_get_u16(buf, 4);
info_size = buffer_get_u16(buf, 6);
if (num > JAYLINK_MAX_CONNECTIONS) {
log_err(ctx, "Maximum number of device connections exceeded: "
"%u", num);
return JAYLINK_ERR_PROTO;
}
if (entry_size != REG_CONN_INFO_SIZE) {
log_err(ctx, "Invalid connection entry size: %u bytes",
entry_size);
return JAYLINK_ERR_PROTO;
}
table_size = num * entry_size;
size = REG_HEADER_SIZE + table_size + info_size;
if (size > REG_MAX_SIZE) {
log_err(ctx, "Maximum registration information size exceeded: "
"%u bytes", size);
return JAYLINK_ERR_PROTO;
}
if (size > REG_MIN_SIZE) {
ret = transport_start_read(devh, size - REG_MIN_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return JAYLINK_ERR;
}
ret = transport_read(devh, buf + REG_MIN_SIZE,
size - REG_MIN_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return JAYLINK_ERR;
}
}
if (!handle) {
log_err(ctx, "Obtained invalid connection handle");
return JAYLINK_ERR_PROTO;
}
connection->handle = handle;
parse_conn_table(connections, buf + REG_HEADER_SIZE, num, entry_size);
*count = num;
return JAYLINK_OK;
}
/**
* Unregister a connection from a device.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_REGISTER capability.
*
* @param[in,out] devh Device handle.
* @param[in,out] connection Connection to unregister from the device.
* @param[out] connections Array to store device connections on success.
* Its content is undefined on failure. The array must
* be large enough to contain at least
* #JAYLINK_MAX_CONNECTIONS elements.
* @param[out] count Number of device connections on success, and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_PROTO Protocol violation.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @see jaylink_register()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_unregister(struct jaylink_device_handle *devh,
const struct jaylink_connection *connection,
struct jaylink_connection *connections, size_t *count)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[REG_MAX_SIZE];
uint16_t num;
uint16_t entry_size;
uint32_t size;
uint32_t table_size;
uint16_t info_size;
struct in_addr in;
if (!devh || !connection || !connections || !count)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
buf[0] = CMD_REGISTER;
buf[1] = REG_CMD_UNREGISTER;
buffer_set_u32(buf, connection->pid, 2);
if (!_inet_pton(connection->hid, &in))
return JAYLINK_ERR_ARG;
buffer_set_u32(buf, in.s_addr, 6);
buf[10] = connection->iid;
buf[11] = connection->cid;
buffer_set_u16(buf, connection->handle, 12);
ret = transport_start_write_read(devh, 14, REG_MIN_SIZE, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_write(devh, buf, 14);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, REG_MIN_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
num = buffer_get_u16(buf, 2);
entry_size = buffer_get_u16(buf, 4);
info_size = buffer_get_u16(buf, 6);
if (num > JAYLINK_MAX_CONNECTIONS) {
log_err(ctx, "Maximum number of device connections exceeded: "
"%u", num);
return JAYLINK_ERR_PROTO;
}
if (entry_size != REG_CONN_INFO_SIZE) {
log_err(ctx, "Invalid connection entry size: %u bytes",
entry_size);
return JAYLINK_ERR_PROTO;
}
table_size = num * entry_size;
size = REG_HEADER_SIZE + table_size + info_size;
if (size > REG_MAX_SIZE) {
log_err(ctx, "Maximum registration information size exceeded: "
"%u bytes", size);
return JAYLINK_ERR_PROTO;
}
if (size > REG_MIN_SIZE) {
ret = transport_start_read(devh, size - REG_MIN_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return JAYLINK_ERR;
}
ret = transport_read(devh, buf + REG_MIN_SIZE,
size - REG_MIN_SIZE);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return JAYLINK_ERR;
}
}
parse_conn_table(connections, buf + REG_HEADER_SIZE, num, entry_size);
*count = num;
return JAYLINK_OK;
}
|