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 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
#![deny(missing_docs, unsafe_code)]
#![cfg_attr(not(target_family = "windows"), allow(clippy::unnecessary_cast))]
// FT_X_SERIES_CBUS_
use libftd2xx_ffi::{
FT_X_SERIES_CBUS_BCD_CHARGER, FT_X_SERIES_CBUS_BCD_CHARGER_N, FT_X_SERIES_CBUS_BITBANG_RD,
FT_X_SERIES_CBUS_BITBANG_WR, FT_X_SERIES_CBUS_CLK12, FT_X_SERIES_CBUS_CLK24,
FT_X_SERIES_CBUS_CLK6, FT_X_SERIES_CBUS_DRIVE_0, FT_X_SERIES_CBUS_DRIVE_1,
FT_X_SERIES_CBUS_I2C_RXF, FT_X_SERIES_CBUS_I2C_TXE, FT_X_SERIES_CBUS_IOMODE,
FT_X_SERIES_CBUS_KEEP_AWAKE, FT_X_SERIES_CBUS_PWREN, FT_X_SERIES_CBUS_RXLED,
FT_X_SERIES_CBUS_SLEEP, FT_X_SERIES_CBUS_TIMESTAMP, FT_X_SERIES_CBUS_TRISTATE,
FT_X_SERIES_CBUS_TXDEN, FT_X_SERIES_CBUS_TXLED, FT_X_SERIES_CBUS_TXRXLED,
FT_X_SERIES_CBUS_VBUS_SENSE,
};
// FT_232H_CBUS_
use libftd2xx_ffi::{
FT_232H_CBUS_CLK15, FT_232H_CBUS_CLK30, FT_232H_CBUS_CLK7_5, FT_232H_CBUS_DRIVE_0,
FT_232H_CBUS_DRIVE_1, FT_232H_CBUS_IOMODE, FT_232H_CBUS_PWREN, FT_232H_CBUS_RXLED,
FT_232H_CBUS_SLEEP, FT_232H_CBUS_TRISTATE, FT_232H_CBUS_TXDEN, FT_232H_CBUS_TXLED,
FT_232H_CBUS_TXRXLED,
};
// FT_232R_CBUS_
use libftd2xx_ffi::{
FT_232R_CBUS_BITBANG_RD, FT_232R_CBUS_BITBANG_WR, FT_232R_CBUS_CLK12, FT_232R_CBUS_CLK24,
FT_232R_CBUS_CLK48, FT_232R_CBUS_CLK6, FT_232R_CBUS_IOMODE, FT_232R_CBUS_PWRON,
FT_232R_CBUS_RXLED, FT_232R_CBUS_SLEEP, FT_232R_CBUS_TXDEN, FT_232R_CBUS_TXLED,
FT_232R_CBUS_TXRXLED,
};
// FT_BITMODE_
use libftd2xx_ffi::{
FT_BITMODE_ASYNC_BITBANG, FT_BITMODE_CBUS_BITBANG, FT_BITMODE_FAST_SERIAL, FT_BITMODE_MCU_HOST,
FT_BITMODE_MPSSE, FT_BITMODE_RESET, FT_BITMODE_SYNC_BITBANG, FT_BITMODE_SYNC_FIFO,
};
// FT_DEVICE_
use libftd2xx_ffi::{
FT_DEVICE_100AX, FT_DEVICE_2232C, FT_DEVICE_2232H, FT_DEVICE_2232HA, FT_DEVICE_2232HP,
FT_DEVICE_2233HP, FT_DEVICE_232H, FT_DEVICE_232HP, FT_DEVICE_232R, FT_DEVICE_233HP,
FT_DEVICE_4222H_0, FT_DEVICE_4222H_1_2, FT_DEVICE_4222H_3, FT_DEVICE_4222_PROG,
FT_DEVICE_4232H, FT_DEVICE_4232HA, FT_DEVICE_4232HP, FT_DEVICE_4233HP, FT_DEVICE_900,
FT_DEVICE_930, FT_DEVICE_AM, FT_DEVICE_BM, FT_DEVICE_UMFTPD3A, FT_DEVICE_UNKNOWN,
FT_DEVICE_X_SERIES,
};
// FT_DRIVER_TYPE_
use libftd2xx_ffi::{FT_DRIVER_TYPE_D2XX, FT_DRIVER_TYPE_VCP};
// FT_EEPROM_
use libftd2xx_ffi::{
FT_EEPROM_2232H, FT_EEPROM_232H, FT_EEPROM_232R, FT_EEPROM_4232H, FT_EEPROM_HEADER,
FT_EEPROM_X_SERIES,
};
use super::{EepromStringsError, EepromValueError};
use crate::util::slice_into_string;
use std::fmt;
/// Maximum length of common FTDI strings.
pub const STRING_LEN: usize = 64;
/// Bits per word.
///
/// This is used by the [`set_data_characteristics`] method.
///
/// [`set_data_characteristics`]: crate::FtdiCommon::set_data_characteristics
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default)]
#[repr(u8)]
pub enum BitsPerWord {
/// 7 bits per word.
Bits7 = 7,
/// 8 bits per word.
#[default]
Bits8 = 8,
}
impl From<BitsPerWord> for u8 {
fn from(val: BitsPerWord) -> u8 {
val as u8
}
}
/// Stop bits.
///
/// This is used by the [`set_data_characteristics`] method.
///
/// [`set_data_characteristics`]: crate::FtdiCommon::set_data_characteristics
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default)]
#[repr(u8)]
pub enum StopBits {
/// 1 stop bit.
#[default]
Bits1 = 0,
/// 2 stop bits.
Bits2 = 2,
}
impl From<StopBits> for u8 {
fn from(val: StopBits) -> u8 {
val as u8
}
}
/// Serial parity bits.
///
/// This is used by the [`set_data_characteristics`] method.
///
/// [`set_data_characteristics`]: crate::FtdiCommon::set_data_characteristics
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default)]
#[repr(u8)]
pub enum Parity {
/// No pairty.
#[default]
No = 0,
/// Odd parity.
Odd = 1,
/// Even parity.
Even = 2,
/// Mark parity.
Mark = 3,
/// Space parity.
Space = 4,
}
impl From<Parity> for u8 {
fn from(val: Parity) -> u8 {
val as u8
}
}
// These get around an annoyance with bindgen generating different types for
// enums on Linux vs Windows.
const DEVICE_BM: u32 = FT_DEVICE_BM as u32;
const DEVICE_AM: u32 = FT_DEVICE_AM as u32;
const DEVICE_100AX: u32 = FT_DEVICE_100AX as u32;
const DEVICE_UNKNOWN: u32 = FT_DEVICE_UNKNOWN as u32;
const DEVICE_2232C: u32 = FT_DEVICE_2232C as u32;
const DEVICE_232R: u32 = FT_DEVICE_232R as u32;
const DEVICE_2232H: u32 = FT_DEVICE_2232H as u32;
const DEVICE_4232H: u32 = FT_DEVICE_4232H as u32;
const DEVICE_232H: u32 = FT_DEVICE_232H as u32;
const DEVICE_X_SERIES: u32 = FT_DEVICE_X_SERIES as u32;
const DEVICE_4222H_0: u32 = FT_DEVICE_4222H_0 as u32;
const DEVICE_4222H_1_2: u32 = FT_DEVICE_4222H_1_2 as u32;
const DEVICE_4222H_3: u32 = FT_DEVICE_4222H_3 as u32;
const DEVICE_4222_PROG: u32 = FT_DEVICE_4222_PROG as u32;
const DEVICE_900: u32 = FT_DEVICE_900 as u32;
const DEVICE_930: u32 = FT_DEVICE_930 as u32;
const DEVICE_UMFTPD3A: u32 = FT_DEVICE_UMFTPD3A as u32;
const DEVICE_2233HP: u32 = FT_DEVICE_2233HP as u32;
const DEVICE_4233HP: u32 = FT_DEVICE_4233HP as u32;
const DEVICE_2232HP: u32 = FT_DEVICE_2232HP as u32;
const DEVICE_4232HP: u32 = FT_DEVICE_4232HP as u32;
const DEVICE_233HP: u32 = FT_DEVICE_233HP as u32;
const DEVICE_232HP: u32 = FT_DEVICE_232HP as u32;
const DEVICE_2232HA: u32 = FT_DEVICE_2232HA as u32;
const DEVICE_4232HA: u32 = FT_DEVICE_4232HA as u32;
/// FTDI device types.
///
/// There is an unfortunate lack of documentation for which chip shows up as
/// which device with the FTD2XX driver.
///
/// This is used in the [`DeviceInfo`] struct.
#[allow(non_camel_case_types)]
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default)]
#[repr(u32)]
#[allow(clippy::upper_case_acronyms)]
pub enum DeviceType {
/// FTDI BM device.
FTBM = DEVICE_BM,
/// FTDI AM device.
FTAM = DEVICE_AM,
/// FTDI 100AX device.
FT100AX = DEVICE_100AX,
/// Unknown FTDI device.
///
/// This frequently occurs on Linux when the VCP FTDI driver is in use.
///
/// The driver can be removed with these commands.
/// ```bash
/// sudo rmmod ftdi_sio
/// sudo rmmod usbserial
/// ```
/// See [FTDI Drivers Installation Guide for Linux] for more details.
///
/// [FTDI Drivers Installation Guide for Linux]: http://www.ftdichip.cn/Support/Documents/AppNotes/AN_220_FTDI_Drivers_Installation_Guide_for_Linux.pdf
#[default]
Unknown = DEVICE_UNKNOWN,
/// FTDI 2232C device.
///
/// The FTDI 2232D also appears as a FTDI 2232C.
FT2232C = DEVICE_2232C,
/// FTDI 232R device.
FT232R = DEVICE_232R,
/// FT2232H device.
FT2232H = DEVICE_2232H,
/// FT4232H device.
FT4232H = DEVICE_4232H,
/// FT232H device.
FT232H = DEVICE_232H,
/// FTDI x series device.
FT_X_SERIES = DEVICE_X_SERIES,
/// FT4222H device.
FT4222H_0 = DEVICE_4222H_0,
/// FT4222H device.
FT4222H_1_2 = DEVICE_4222H_1_2,
/// FT4222H device.
FT4222H_3 = DEVICE_4222H_3,
/// FT4222 device.
FT4222_PROG = DEVICE_4222_PROG,
/// FT900 device.
FT900 = DEVICE_900,
/// FT930 device.
FT930 = DEVICE_930,
/// FTUMFTPD3A device.
FTUMFTPD3A = DEVICE_UMFTPD3A,
/// FT2233HP device.
FT2233HP = DEVICE_2233HP,
/// FT4233HP device.
FT4233HP = DEVICE_4233HP,
/// FT2232HP device.
FT2232HP = DEVICE_2232HP,
/// FT4232HP device.
FT4232HP = DEVICE_4232HP,
/// FT233HP device.
FT233HP = DEVICE_233HP,
/// FT232HP device.
FT232HP = DEVICE_232HP,
/// FT2232HA device.
FT2232HA = DEVICE_2232HA,
/// FT4232HA device.
FT4232HA = DEVICE_4232HA,
}
impl DeviceType {
/// Get a device type with a USB product ID.
///
/// This is not entirely accurate since some devices share the same PID.
///
/// # Example
///
/// ```
/// use libftd2xx::DeviceType;
///
/// let my_device: Option<DeviceType> = DeviceType::with_pid(0x6014);
/// assert_eq!(my_device, Some(DeviceType::FT232H));
/// ```
pub const fn with_pid(pid: u16) -> Option<DeviceType> {
if pid == 0x6001 {
Some(DeviceType::FTAM)
} else if pid == 0x6010 {
Some(DeviceType::FT2232H)
} else if pid == 0x6011 {
Some(DeviceType::FT4232H)
} else if pid == 0x6048 {
Some(DeviceType::FT4232HA)
} else if pid == 0x6014 {
Some(DeviceType::FT232H)
} else if pid == 0x6015 {
Some(DeviceType::FT_X_SERIES)
} else {
None
}
}
}
#[test]
fn device_type_default() {
let default: DeviceType = Default::default();
assert_eq!(DeviceType::Unknown, default);
}
impl From<u32> for DeviceType {
fn from(value: u32) -> DeviceType {
match value {
DEVICE_AM => DeviceType::FTBM,
DEVICE_BM => DeviceType::FTAM,
DEVICE_100AX => DeviceType::FT100AX,
DEVICE_UNKNOWN => DeviceType::Unknown,
DEVICE_2232C => DeviceType::FT2232C,
DEVICE_232R => DeviceType::FT232R,
DEVICE_2232H => DeviceType::FT2232H,
DEVICE_4232H => DeviceType::FT4232H,
DEVICE_4232HA => DeviceType::FT4232HA,
DEVICE_232H => DeviceType::FT232H,
DEVICE_X_SERIES => DeviceType::FT_X_SERIES,
DEVICE_4222H_0 => DeviceType::FT4222H_0,
DEVICE_4222H_1_2 => DeviceType::FT4222H_1_2,
DEVICE_4222H_3 => DeviceType::FT4222H_3,
DEVICE_4222_PROG => DeviceType::FT4222_PROG,
_ => panic!("unknown device: {value}"),
}
}
}
/// D2XX version structure.
///
/// **Note** this is not a [SemVer]. [SemVer] defines the last number as the
/// patch number, whereas FTDI uses it as a build number.
///
/// This is returned by [`library_version`] and [`driver_version`].
///
/// [`library_version`]: crate::library_version
/// [`driver_version`]: crate::FtdiCommon::driver_version
/// [SemVer]: https://semver.org/
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub struct Version {
/// Major version.
pub major: u8,
/// Minor version.
pub minor: u8,
/// Build number.
pub build: u8,
}
#[cfg(test)]
mod version {
use super::*;
macro_rules! case {
($name:ident, ($a:expr, $b:expr, $c:expr), ($d:expr, $e:expr, $f:expr)) => {
#[test]
fn $name() {
let big = Version::new($a, $b, $c);
let little = Version::new($d, $e, $f);
assert!(big > little);
assert!(little < big);
}
};
}
case!(case_1, (0, 0, 1), (0, 0, 0));
case!(case_2, (0, 1, 0), (0, 0, 0));
case!(case_3, (1, 0, 0), (0, 0, 0));
case!(case_4, (2, 2, 2), (1, 1, 1));
case!(case_5, (255, 255, 255), (254, 255, 255));
case!(case_6, (1, 0, 0), (0, 255, 255));
case!(case_7, (13, 255, 0), (13, 254, 255));
#[test]
fn display() {
assert_eq!(
format!("{}", Version::with_raw(0x00030115)),
String::from("3.1.15")
)
}
}
impl fmt::Display for Version {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}.{}.{}", self.major, self.minor, self.build)
}
}
fn bcd_decode(value: u8) -> u8 {
let nibble_lo: u8 = value & 0xF;
let nibble_hi: u8 = (value >> 4) & 0xF;
assert!(nibble_lo < 0xA);
assert!(nibble_hi < 0xA);
nibble_hi * 10 + nibble_lo
}
impl Version {
/// Create a new version structure from decimal values.
///
/// # Example
///
/// ```
/// use libftd2xx::Version;
///
/// let version = Version::new(3, 1, 15);
/// assert_eq!(
/// version,
/// Version {
/// major: 3,
/// minor: 1,
/// build: 15
/// }
/// );
/// ```
pub const fn new(major: u8, minor: u8, build: u8) -> Version {
Version {
major,
minor,
build,
}
}
/// Create a new version structure from [binary-coded decimal] (BCD) values.
///
/// # Example
///
/// ```
/// use libftd2xx::Version;
///
/// let version = Version::with_bcd(0x03, 0x01, 0x15);
/// assert_eq!(version, Version::new(3, 1, 15));
/// ```
///
/// [binary-coded decimal]: https://en.wikipedia.org/wiki/Binary-coded_decimal
pub fn with_bcd(major: u8, minor: u8, build: u8) -> Version {
Version::new(bcd_decode(major), bcd_decode(minor), bcd_decode(build))
}
/// Create a new version structure from the raw C-API value.
///
/// # Example
///
/// ```
/// use libftd2xx::Version;
///
/// let version = Version::with_raw(0x00030115);
/// assert_eq!(version, Version::new(3, 1, 15));
/// ```
pub fn with_raw(value: u32) -> Version {
Version::with_bcd(
((value >> 16) & 0xFF) as u8,
((value >> 8) & 0xFF) as u8,
(value & 0xFF) as u8,
)
}
}
/// BitModes for the FTDI ports.
///
/// This structure is passed to [`set_bit_mode`] to set the bit mode.
///
/// [`set_bit_mode`]: crate::FtdiCommon::set_bit_mode
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
pub enum BitMode {
/// Reset.
Reset = FT_BITMODE_RESET as u8,
/// Asynchronous bit bang.
AsyncBitbang = FT_BITMODE_ASYNC_BITBANG as u8,
/// MPSSE (FT2232, FT2232H, FT4232H(A) and FT232H devices only)
Mpsse = FT_BITMODE_MPSSE as u8,
/// Synchronous Bit Bang
/// (FT232R, FT245R,FT2232, FT2232H, FT4232H and FT232H devices only)
SyncBitbang = FT_BITMODE_SYNC_BITBANG as u8,
/// MCU Host Bus Emulation Mode
/// (FT2232, FT2232H, FT4232Hand FT232H devices only)
McuHost = FT_BITMODE_MCU_HOST as u8,
/// FastOpto-Isolated Serial Mode
/// (FT2232, FT2232H, FT4232H and FT232H devices only)
FastSerial = FT_BITMODE_FAST_SERIAL as u8,
/// CBUS Bit Bang Mode (FT232R and FT232H devices only)
CbusBitbang = FT_BITMODE_CBUS_BITBANG as u8,
/// Single Channel Synchronous 245 FIFO Mode
/// (FT2232H and FT232H devices only)
SyncFifo = FT_BITMODE_SYNC_FIFO as u8,
}
impl From<u8> for BitMode {
fn from(x: u8) -> BitMode {
match x {
x if x == BitMode::Reset as u8 => BitMode::Reset,
x if x == BitMode::AsyncBitbang as u8 => BitMode::AsyncBitbang,
x if x == BitMode::Mpsse as u8 => BitMode::Mpsse,
x if x == BitMode::SyncBitbang as u8 => BitMode::SyncBitbang,
x if x == BitMode::McuHost as u8 => BitMode::McuHost,
x if x == BitMode::FastSerial as u8 => BitMode::FastSerial,
x if x == BitMode::CbusBitbang as u8 => BitMode::CbusBitbang,
x if x == BitMode::SyncFifo as u8 => BitMode::SyncFifo,
_ => panic!("invalid BitMode value: {x}"),
}
}
}
#[test]
fn bit_mode_sanity() {
assert_eq!(BitMode::Reset as u8, 0x00);
assert_eq!(BitMode::AsyncBitbang as u8, 0x01);
assert_eq!(BitMode::Mpsse as u8, 0x02);
assert_eq!(BitMode::SyncBitbang as u8, 0x04);
assert_eq!(BitMode::McuHost as u8, 0x08);
assert_eq!(BitMode::FastSerial as u8, 0x10);
assert_eq!(BitMode::CbusBitbang as u8, 0x20);
assert_eq!(BitMode::SyncFifo as u8, 0x40);
}
/// USB device speed.
///
/// This is used in the [`DeviceInfo`] struct.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[repr(u8)]
pub enum Speed {
/// High speed USB.
HighSpeed,
/// Full speed USB.
FullSpeed,
}
impl From<u32> for Speed {
fn from(value: u32) -> Speed {
if value == 0 {
Speed::FullSpeed
} else {
Speed::HighSpeed
}
}
}
/// FTDI device status.
///
/// This is returned by [`status`](crate::FtdiCommon::status).
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub struct DeviceStatus {
/// Number of characters in the receive queue.
pub ammount_in_rx_queue: u32,
/// Number of characters in the transmit queue.
pub ammount_in_tx_queue: u32,
/// Current state of the event status.
pub event_status: u32,
}
/// FTDI modem status.
///
/// This is returned by [`modem_status`](crate::FtdiCommon::modem_status).
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub struct ModemStatus(u32);
impl ModemStatus {
/// Construct a new `ModemStatus` from a raw value.
pub const fn new(status: u32) -> ModemStatus {
ModemStatus(status)
}
/// Get the line status byte.
pub fn line_status(&self) -> u8 {
u8::try_from(((self.0) >> 8) & 0xFF).unwrap()
}
/// Get the modem status byte.
pub fn modem_status(&self) -> u8 {
u8::try_from((self.0) & 0xFF).unwrap()
}
/// Clear to send (CTS) status.
pub fn clear_to_send(&self) -> bool {
self.modem_status() & 0x10 != 0
}
/// Data set ready (DSR) status.
pub fn data_set_ready(&self) -> bool {
self.modem_status() & 0x20 != 0
}
/// Ring indicator (RI) status.
pub fn ring_indicator(&self) -> bool {
self.modem_status() & 0x40 != 0
}
/// Data carrier detect (DCD) status.
pub fn data_carrier_detect(&self) -> bool {
self.modem_status() & 0x80 != 0
}
/// Overrun error (OE) status.
pub fn overrun_error(&self) -> bool {
self.line_status() & 0x02 != 0
}
/// Parity error (PE) status.
pub fn parity_error(&self) -> bool {
self.line_status() & 0x04 != 0
}
/// Framing error (FE) status.
pub fn framing_error(&self) -> bool {
self.line_status() & 0x08 != 0
}
/// Break interrupt (BI) status.
pub fn break_interrupt(&self) -> bool {
self.line_status() & 0x10 != 0
}
}
/// FTDI device information.
///
/// This is returned by [`list_devices`] and [`device_info`].
///
/// [`list_devices`]: crate::list_devices
/// [`device_info`]: crate::FtdiCommon::device_info
#[derive(Clone, Eq, PartialEq, Default, Ord, PartialOrd)]
pub struct DeviceInfo {
/// `true` if the port is open.
pub port_open: bool,
/// USB link speed.
///
/// This will be `None` when getting the information of an open device with
/// the [`device_info`] function.
///
/// [`device_info`]: crate::FtdiCommon::device_info
pub speed: Option<Speed>,
/// FTDI device type.
pub device_type: DeviceType,
/// FTDI USB device vendor ID.
///
/// This is typically `0x0403`.
pub vendor_id: u16,
/// FTDI USB product ID.
///
/// Typical FTDI product IDs:
/// * `0x6001` FT232AM/FT232BM/FT232R
/// * `0x6010` FT2232C/FT2232D/FT2232H
/// * `0x6011` FT4232/FT4232H
/// * `0x6048` FT4232HA
/// * `0x6014` FT232H
/// * `0x6015` FT230X/FT231X/FT234X
pub product_id: u16,
/// Device serial number.
///
/// This is assumed to be UTF-8.
/// Data that is not UTF-8 will appear as the replacement character �.
pub serial_number: String,
/// Device description.
///
/// This is assumed to be UTF-8.
/// Data that is not UTF-8 will appear as the replacement character �.
pub description: String,
}
pub fn vid_pid_from_id(id: u32) -> (u16, u16) {
(((id >> 16) & 0xFFFF) as u16, (id & 0xFFFF) as u16)
}
#[test]
fn test_vid_pid_from_id() {
assert_eq!((0x0403, 0x6014), vid_pid_from_id(0x04036014))
}
impl fmt::Debug for DeviceInfo {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"DeviceInfo {{ \
port_open: {}, \
speed: {:?}, \
device_type: {:?}, \
vendor_id: 0x{:04X}, \
product_id: 0x{:04X}, \
serial_number: {}, \
description: {} \
}}",
self.port_open,
self.speed,
self.device_type,
self.vendor_id,
self.product_id,
self.serial_number,
self.description,
)
}
}
// These get around an annoyance with bindgen generating different types for
// preprocessor macros on Linux vs Windows.
const DRIVER_TYPE_D2XX: u8 = FT_DRIVER_TYPE_D2XX as u8;
const DRIVER_TYPE_VCP: u8 = FT_DRIVER_TYPE_VCP as u8;
/// FTDI driver type.
///
/// This is used in EEPROM structures.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
#[allow(clippy::upper_case_acronyms)]
pub enum DriverType {
/// FTDI D2XX driver.
D2XX = DRIVER_TYPE_D2XX,
/// FTDI VCP driver.
Vcp = DRIVER_TYPE_VCP,
}
impl TryFrom<u8> for DriverType {
type Error = EepromValueError;
fn try_from(value: u8) -> Result<DriverType, EepromValueError> {
match value {
DRIVER_TYPE_D2XX => Ok(DriverType::D2XX),
DRIVER_TYPE_VCP => Ok(DriverType::Vcp),
_ => Err(EepromValueError::new(value)),
}
}
}
impl From<DriverType> for u8 {
fn from(dt: DriverType) -> Self {
dt as u8
}
}
/// FTDI pin drive currents.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[repr(u8)]
pub enum DriveCurrent {
/// 4mA drive current.
Milliamps4 = 4,
/// 8mA drive current.
Milliamps8 = 8,
/// 12mA drive current.
Milliamps12 = 12,
/// 16mA drive current.
Milliamps16 = 16,
}
impl TryFrom<u8> for DriveCurrent {
type Error = EepromValueError;
fn try_from(value: u8) -> Result<Self, Self::Error> {
match value {
4 => Ok(DriveCurrent::Milliamps4),
8 => Ok(DriveCurrent::Milliamps8),
12 => Ok(DriveCurrent::Milliamps12),
16 => Ok(DriveCurrent::Milliamps16),
_ => Err(EepromValueError::new(value)),
}
}
}
/// FT1248 clock polarity
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
pub enum ClockPolarity {
/// Clock idle low.
IdleLow = 0,
/// Clock idle high.
IdleHigh = 1,
}
impl From<u8> for ClockPolarity {
fn from(value: u8) -> ClockPolarity {
if value == 0 {
ClockPolarity::IdleLow
} else {
ClockPolarity::IdleHigh
}
}
}
/// FT1248 byte order.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
#[allow(clippy::upper_case_acronyms)]
pub enum ByteOrder {
/// LSB first.
LSB,
/// MSB first.
MSB,
}
impl From<u8> for ByteOrder {
fn from(value: u8) -> ByteOrder {
if value == 0 {
ByteOrder::MSB
} else {
ByteOrder::LSB
}
}
}
// Implements From<u8> for cbus enums
macro_rules! cbus_enum {
(
$(#[$OUTER:meta])*
pub enum $NAME:ident {
$(
$(#[$INNER:ident $($ARGS:tt)*])*
$FIELD:ident = $VALUE:ident,
)+
}
) => {
$(#[$OUTER])*
pub enum $NAME {
$(
$(#[$INNER $($ARGS)*])*
$FIELD = $VALUE,
)*
}
impl TryFrom<u8> for $NAME {
type Error = EepromValueError;
fn try_from(value: u8) -> Result<$NAME, Self::Error> {
match value {
$(
$VALUE => Ok($NAME::$FIELD),
)*
_ => Err(
Self::Error::new(value)
),
}
}
}
};
}
// These get around an annoyance with bindgen generating different types for
// preprocessor macros on Linux vs Windows.
const NORM_232H_CBUS_TRISTATE: u8 = FT_232H_CBUS_TRISTATE as u8;
const NORM_232H_CBUS_TXLED: u8 = FT_232H_CBUS_TXLED as u8;
const NORM_232H_CBUS_RXLED: u8 = FT_232H_CBUS_RXLED as u8;
const NORM_232H_CBUS_TXRXLED: u8 = FT_232H_CBUS_TXRXLED as u8;
const NORM_232H_CBUS_PWREN: u8 = FT_232H_CBUS_PWREN as u8;
const NORM_232H_CBUS_SLEEP: u8 = FT_232H_CBUS_SLEEP as u8;
const NORM_232H_CBUS_DRIVE_0: u8 = FT_232H_CBUS_DRIVE_0 as u8;
const NORM_232H_CBUS_DRIVE_1: u8 = FT_232H_CBUS_DRIVE_1 as u8;
const NORM_232H_CBUS_IOMODE: u8 = FT_232H_CBUS_IOMODE as u8;
const NORM_232H_CBUS_TXDEN: u8 = FT_232H_CBUS_TXDEN as u8;
const NORM_232H_CBUS_CLK30: u8 = FT_232H_CBUS_CLK30 as u8;
const NORM_232H_CBUS_CLK15: u8 = FT_232H_CBUS_CLK15 as u8;
const NORM_232H_CBUS_CLK7_5: u8 = FT_232H_CBUS_CLK7_5 as u8;
cbus_enum!(
/// FT232H CBUS options.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
pub enum Cbus232h {
/// Tristate.
Tristate = NORM_232H_CBUS_TRISTATE,
/// TX LED.
TxLed = NORM_232H_CBUS_TXLED,
/// RX LED.
RxLed = NORM_232H_CBUS_RXLED,
/// TX and RX LED.
TxRxLed = NORM_232H_CBUS_TXRXLED,
/// Power enable.
PowerEnable = NORM_232H_CBUS_PWREN,
/// Sleep.
Sleep = NORM_232H_CBUS_SLEEP,
/// Drive pin to logic 0.
Drive0 = NORM_232H_CBUS_DRIVE_0,
/// Drive pin to logic 1.
Drive1 = NORM_232H_CBUS_DRIVE_1,
/// IO Mode doe CBUS bit-bang.
IoMode = NORM_232H_CBUS_IOMODE,
/// TX data enable.
TxDen = NORM_232H_CBUS_TXDEN,
/// 30MHz clock.
Clk30 = NORM_232H_CBUS_CLK30,
/// 15MHz clock.
Clk15 = NORM_232H_CBUS_CLK15,
/// 7.5MHz clock.
Clk7_5 = NORM_232H_CBUS_CLK7_5,
}
);
/// EEPROM strings structure.
///
/// This structure contains the strings programmed into EEPROM that are common
/// across all FTDI devices.
///
/// This is used by the [`eeprom_read`] and [`eeprom_program`] methods.
///
/// [`eeprom_read`]: crate::FtdiEeprom::eeprom_read
/// [`eeprom_program`]: crate::FtdiEeprom::eeprom_program
#[derive(Debug, Default, Clone, Eq, PartialEq)]
pub struct EepromStrings {
manufacturer: String,
manufacturer_id: String,
description: String,
serial_number: String,
}
impl EepromStrings {
/// Create a new EEPROM strings structure.
pub fn with_strs(
manufacturer: &str,
manufacturer_id: &str,
description: &str,
serial_number: &str,
) -> Result<Self, EepromStringsError> {
let mut ret = Self::default();
ret.set_manufacturer(manufacturer.to_string())?;
ret.set_manufacturer_id(manufacturer_id.to_string())?;
ret.set_description(description.to_string())?;
ret.set_serial_number(serial_number.to_string())?;
Ok(ret)
}
/// Create a new EEPROM strings structure from raw slices.
pub fn with_slices(
manufacturer: &[i8],
manufacturer_id: &[i8],
description: &[i8],
serial_number: &[i8],
) -> Result<Self, EepromStringsError> {
let mut ret = Self::default();
ret.set_manufacturer(slice_into_string(manufacturer))?;
ret.set_manufacturer_id(slice_into_string(manufacturer_id))?;
ret.set_description(slice_into_string(description))?;
ret.set_serial_number(slice_into_string(serial_number))?;
Ok(ret)
}
/// Total length of the `manufacturer`, `manufacturer_id`,
/// `description`, and `serial_number` strings.
///
/// Together these strings cannot exceed 96 characters.
pub fn string_len(&self) -> usize {
self.manufacturer.len()
+ self.manufacturer_id.len()
+ self.description.len()
+ self.serial_number.len()
}
/// Manufacturer string.
pub fn manufacturer(&self) -> String {
self.manufacturer.clone()
}
/// Set the manufacturer string.
///
/// # Requirements
///
/// * Less than or equal to 64 characters.
/// * The total length of the `manufacturer`, `manufacturer_id`,
/// `description`, and `serial_number` strings can not exceed
/// 96 characters.
pub fn set_manufacturer(&mut self, value: String) -> Result<(), EepromStringsError> {
if value.len() > EepromStringsError::MAX_LEN
|| self.manufacturer_id.len() + self.description.len() + self.serial_number.len()
> EepromStringsError::MAX_TOTAL_LEN
{
Err(EepromStringsError {
manufacturer: value.len(),
manufacturer_id: self.manufacturer_id.len(),
description: self.description.len(),
serial_number: self.serial_number.len(),
})
} else {
self.manufacturer = value;
Ok(())
}
}
/// Manufacturer ID string.
pub fn manufacturer_id(&self) -> String {
self.manufacturer_id.clone()
}
/// Set the manufacturer ID string.
///
/// The first two characters of this string should be the same as
/// the first two characters of the device serial number.
/// For example, if your manufacturer ID is "FTDI" your serial
/// number should start with "FT".
///
/// # Requirements
///
/// * Less than or equal to 64 characters.
/// * The total length of the `manufacturer`, `manufacturer_id`,
/// `description`, and `serial_number` strings can not exceed
/// 96 characters.
pub fn set_manufacturer_id(&mut self, value: String) -> Result<(), EepromStringsError> {
if value.len() > EepromStringsError::MAX_LEN
|| self.manufacturer.len() + self.description.len() + self.serial_number.len()
> EepromStringsError::MAX_TOTAL_LEN
{
Err(EepromStringsError {
manufacturer: self.manufacturer.len(),
manufacturer_id: value.len(),
description: self.description.len(),
serial_number: self.serial_number.len(),
})
} else {
self.manufacturer_id = value;
Ok(())
}
}
/// Description string.
pub fn description(&self) -> String {
self.description.clone()
}
/// Set the description string.
///
/// # Requirements
///
/// * Less than or equal to 64 characters.
/// * The total length of the `manufacturer`, `manufacturer_id`,
/// `description`, and `serial_number` strings can not exceed
/// 96 characters.
pub fn set_description(&mut self, value: String) -> Result<(), EepromStringsError> {
if value.len() > EepromStringsError::MAX_LEN
|| self.manufacturer.len() + self.manufacturer_id.len() + self.serial_number.len()
> EepromStringsError::MAX_TOTAL_LEN
{
Err(EepromStringsError {
manufacturer: self.manufacturer.len(),
manufacturer_id: self.manufacturer_id.len(),
description: value.len(),
serial_number: self.serial_number.len(),
})
} else {
self.description = value;
Ok(())
}
}
/// Serial number string.
pub fn serial_number(&self) -> String {
self.serial_number.clone()
}
/// Set the manufacturer ID string.
///
/// The first two characters of this string should be the same as
/// the first two characters of the device serial number.
/// For example, if your manufacturer ID is "FTDI" your serial
/// number should start with "FT".
///
/// # Requirements
///
/// * Less than or equal to 64 characters.
/// * The total length of the `manufacturer`, `manufacturer_id`,
/// `description`, and `serial_number` strings can not exceed
/// 96 characters.
pub fn set_serial_number(&mut self, value: String) -> Result<(), EepromStringsError> {
if value.len() > EepromStringsError::MAX_LEN
|| self.manufacturer.len() + self.manufacturer_id.len() + self.description.len()
> EepromStringsError::MAX_TOTAL_LEN
{
Err(EepromStringsError {
manufacturer: self.manufacturer.len(),
manufacturer_id: self.manufacturer_id.len(),
description: self.description.len(),
serial_number: value.len(),
})
} else {
self.serial_number = value;
Ok(())
}
}
}
/// EEPROM structure for the FT232H.
///
/// This is used by the [`eeprom_read`] and [`eeprom_program`] methods.
///
/// [`eeprom_read`]: crate::FtdiEeprom::eeprom_read
/// [`eeprom_program`]: crate::FtdiEeprom::eeprom_program
#[derive(Debug, Copy, Clone)]
pub struct Eeprom232h(FT_EEPROM_232H);
impl From<Eeprom232h> for FT_EEPROM_232H {
fn from(val: Eeprom232h) -> FT_EEPROM_232H {
val.0
}
}
impl From<FT_EEPROM_232H> for Eeprom232h {
fn from(val: FT_EEPROM_232H) -> Eeprom232h {
Eeprom232h(val)
}
}
impl Default for Eeprom232h {
fn default() -> Self {
let mut header = EepromHeader::default();
header.set_device_type(DeviceType::FT232H);
header.set_product_id(0x6014);
Self(FT_EEPROM_232H {
common: header.0,
ACDriveCurrent: 4,
ADDriveCurrent: 4,
ACSlowSlew: 0,
ACSchmittInput: 0,
ADSlowSlew: 0,
ADSchmittInput: 0,
Cbus0: 0,
Cbus1: 0,
Cbus2: 0,
Cbus3: 0,
Cbus4: 0,
Cbus5: 0,
Cbus6: 0,
Cbus7: 0,
Cbus8: 0,
Cbus9: 0,
FT1248Cpol: 0,
FT1248Lsb: 0,
FT1248FlowControl: 0,
IsFifo: 0,
IsFifoTar: 0,
IsFastSer: 0,
IsFT1248: 0,
PowerSaveEnable: 0,
DriverType: DriverType::D2XX.into(),
})
}
}
/// EEPROM structure for the FT232R.
///
/// This is used by the [`eeprom_read`] and [`eeprom_program`] methods.
///
/// [`eeprom_read`]: crate::FtdiEeprom::eeprom_read
/// [`eeprom_program`]: crate::FtdiEeprom::eeprom_program
#[derive(Debug, Copy, Clone)]
pub struct Eeprom232r(FT_EEPROM_232R);
impl From<Eeprom232r> for FT_EEPROM_232R {
fn from(val: Eeprom232r) -> FT_EEPROM_232R {
val.0
}
}
impl From<FT_EEPROM_232R> for Eeprom232r {
fn from(val: FT_EEPROM_232R) -> Eeprom232r {
Eeprom232r(val)
}
}
impl Default for Eeprom232r {
fn default() -> Self {
let mut header = EepromHeader::default();
header.set_device_type(DeviceType::FT232R);
header.set_product_id(0x6001);
Self(FT_EEPROM_232R {
common: header.0,
IsHighCurrent: 0,
UseExtOsc: 0,
InvertTXD: 0,
InvertRXD: 0,
InvertRTS: 0,
InvertCTS: 0,
InvertDTR: 0,
InvertDSR: 0,
InvertDCD: 0,
InvertRI: 0,
Cbus0: 0,
Cbus1: 0,
Cbus2: 0,
Cbus3: 0,
Cbus4: 0,
DriverType: DriverType::D2XX.into(),
})
}
}
/// EEPROM structure for the FT2232H.
///
/// This is used by the [`eeprom_read`] and [`eeprom_program`] methods.
///
/// [`eeprom_read`]: crate::FtdiEeprom::eeprom_read
/// [`eeprom_program`]: crate::FtdiEeprom::eeprom_program
#[derive(Debug, Copy, Clone)]
pub struct Eeprom2232h(FT_EEPROM_2232H);
impl From<Eeprom2232h> for FT_EEPROM_2232H {
fn from(val: Eeprom2232h) -> FT_EEPROM_2232H {
val.0
}
}
impl From<FT_EEPROM_2232H> for Eeprom2232h {
fn from(val: FT_EEPROM_2232H) -> Eeprom2232h {
Eeprom2232h(val)
}
}
impl Default for Eeprom2232h {
fn default() -> Self {
let mut header = EepromHeader::default();
header.set_device_type(DeviceType::FT2232H);
header.set_product_id(0x6011);
Self(FT_EEPROM_2232H {
common: header.0,
ALDriveCurrent: 4,
BLDriveCurrent: 4,
AHDriveCurrent: 4,
BHDriveCurrent: 4,
ALSlowSlew: 0,
ALSchmittInput: 0,
AHSlowSlew: 0,
AHSchmittInput: 0,
BLSlowSlew: 0,
BLSchmittInput: 0,
BHSlowSlew: 0,
BHSchmittInput: 0,
AIsFifo: 0,
AIsFifoTar: 0,
AIsFastSer: 0,
BIsFifo: 0,
BIsFifoTar: 0,
BIsFastSer: 0,
PowerSaveEnable: 0,
ADriverType: DriverType::D2XX.into(),
BDriverType: DriverType::D2XX.into(),
})
}
}
impl Eeprom2232h {
/// Get the EEPROM header.
pub fn header(&self) -> EepromHeader {
EepromHeader((self.0).common)
}
/// Set the EEPROM header.
pub fn set_header(&mut self, header: EepromHeader) {
(self.0).common = header.into()
}
}
/// EEPROM structure for the FT4232H.
///
/// This is used by the [`eeprom_read`] and [`eeprom_program`] methods.
///
/// [`eeprom_read`]: crate::FtdiEeprom::eeprom_read
/// [`eeprom_program`]: crate::FtdiEeprom::eeprom_program
#[derive(Debug, Copy, Clone)]
pub struct Eeprom4232h(FT_EEPROM_4232H);
impl From<Eeprom4232h> for FT_EEPROM_4232H {
fn from(val: Eeprom4232h) -> FT_EEPROM_4232H {
val.0
}
}
impl From<FT_EEPROM_4232H> for Eeprom4232h {
fn from(val: FT_EEPROM_4232H) -> Eeprom4232h {
Eeprom4232h(val)
}
}
impl Default for Eeprom4232h {
fn default() -> Self {
let mut header = EepromHeader::default();
header.set_device_type(DeviceType::FT4232H);
header.set_product_id(0x6011);
Self(FT_EEPROM_4232H {
common: header.0,
ADriveCurrent: 4,
BDriveCurrent: 4,
CDriveCurrent: 4,
DDriveCurrent: 4,
ASlowSlew: 0,
ASchmittInput: 0,
BSlowSlew: 0,
BSchmittInput: 0,
CSlowSlew: 0,
CSchmittInput: 0,
DSlowSlew: 0,
DSchmittInput: 0,
ARIIsTXDEN: 0,
BRIIsTXDEN: 0,
CRIIsTXDEN: 0,
DRIIsTXDEN: 0,
ADriverType: DriverType::D2XX.into(),
BDriverType: DriverType::D2XX.into(),
CDriverType: DriverType::D2XX.into(),
DDriverType: DriverType::D2XX.into(),
})
}
}
impl Eeprom4232h {
/// Get the EEPROM header.
pub fn header(&self) -> EepromHeader {
EepromHeader((self.0).common)
}
/// Set the EEPROM header.
pub fn set_header(&mut self, header: EepromHeader) {
(self.0).common = header.into()
}
}
/// EEPROM structure for the FT X series.
///
/// This is used by the [`eeprom_read`] and [`eeprom_program`] methods.
///
/// [`eeprom_read`]: crate::FtdiEeprom::eeprom_read
/// [`eeprom_program`]: crate::FtdiEeprom::eeprom_program
#[derive(Debug, Copy, Clone)]
pub struct EepromXSeries(FT_EEPROM_X_SERIES);
impl From<EepromXSeries> for FT_EEPROM_X_SERIES {
fn from(val: EepromXSeries) -> FT_EEPROM_X_SERIES {
val.0
}
}
impl From<FT_EEPROM_X_SERIES> for EepromXSeries {
fn from(val: FT_EEPROM_X_SERIES) -> EepromXSeries {
EepromXSeries(val)
}
}
impl Default for EepromXSeries {
fn default() -> Self {
let mut header = EepromHeader::default();
header.set_device_type(DeviceType::FT_X_SERIES);
header.set_product_id(0x6015);
header.set_max_current(90);
Self(FT_EEPROM_X_SERIES {
common: header.0,
ACSlowSlew: 0,
ACSchmittInput: 0,
ACDriveCurrent: 4,
ADSlowSlew: 0,
ADSchmittInput: 0,
ADDriveCurrent: 4,
Cbus0: 0,
Cbus1: 0,
Cbus2: 0,
Cbus3: 0,
Cbus4: 0,
Cbus5: FT_X_SERIES_CBUS_VBUS_SENSE as u8,
Cbus6: FT_X_SERIES_CBUS_KEEP_AWAKE as u8,
InvertTXD: 0,
InvertRXD: 0,
InvertRTS: 0,
InvertCTS: 0,
InvertDTR: 0,
InvertDSR: 0,
InvertDCD: 0,
InvertRI: 0,
BCDEnable: 0,
BCDForceCbusPWREN: 0,
BCDDisableSleep: 0,
I2CSlaveAddress: 0,
I2CDeviceId: 0,
I2CDisableSchmitt: 0,
FT1248Cpol: 0,
FT1248Lsb: 0,
FT1248FlowControl: 0,
RS485EchoSuppress: 0,
PowerSaveEnable: 0,
DriverType: 0,
})
}
}
impl EepromXSeries {
/// Get the EEPROM header.
pub fn header(&self) -> EepromHeader {
EepromHeader((self.0).common)
}
/// Set the EEPROM header.
pub fn set_header(&mut self, header: EepromHeader) {
(self.0).common = header.into()
}
/// get battery charge enable
pub fn battery_charge_enable(&self) -> bool {
//assume nonzero
self.0.BCDEnable != 0
}
/// set battery charge enable
pub fn set_battery_charge_enable(&mut self, val: bool) {
self.0.BCDEnable = val.into();
}
/// get battery charge force power enable
pub fn battery_charge_force_power_enable(&self) -> bool {
self.0.BCDForceCbusPWREN != 0
}
/// set battery charge force power enable
pub fn set_battery_charge_force_power_enable(&mut self, val: bool) {
self.0.BCDForceCbusPWREN = val.into()
}
/// get battery charge deactivate sleep
pub fn battery_charge_deactivate_sleep(&self) -> bool {
self.0.BCDDisableSleep != 0
}
/// set battery charge deactivate sleep
pub fn set_battery_charge_deactivate_sleep(&mut self, val: bool) {
self.0.BCDDisableSleep = val.into()
}
}
/// FTDI EEPROM header common to all FTDI devices.
#[derive(Debug, Copy, Clone)]
pub struct EepromHeader(FT_EEPROM_HEADER);
impl EepromHeader {
/// Set the FTDI device type.
pub fn set_device_type(&mut self, device_type: DeviceType) {
(self.0).deviceType = device_type as u32;
}
/// FTDI USB device vendor ID.
///
/// This is typically `0x0403`.
pub fn vendor_id(&self) -> u16 {
(self.0).VendorId
}
/// Set the FTDI USB device vendor ID.
pub fn set_vendor_id(&mut self, value: u16) {
(self.0).VendorId = value
}
/// FTDI USB product ID.
///
/// Typical FTDI product IDs:
/// * `0x6001` FT232AM/FT232BM/FT232R
/// * `0x6010` FT2232C/FT2232D/FT2232H
/// * `0x6011` FT4232/FT4232H
/// * `0x6014` FT232H
/// * `0x6015` FT230X/FT231X/FT234X
pub fn product_id(&self) -> u16 {
(self.0).ProductId
}
/// Set the FTDI USB product ID.
pub fn set_product_id(&mut self, value: u16) {
(self.0).ProductId = value
}
/// Serial Number Enable.
///
/// `true` if the serial number is to be used.
///
/// The documentation is unclear what *exactly* this means.
pub fn serial_number_enable(&self) -> bool {
(self.0).SerNumEnable != 0
}
/// Set Serial Number Enable.
pub fn set_serial_number_enable(&mut self, value: bool) {
(self.0).SerNumEnable = value.into()
}
/// Maximum bus current.
///
/// The unit for this value is milliamps, and the value range is
/// 0-500 mA.
pub fn max_current(&self) -> u16 {
(self.0).MaxPower
}
/// Set maximum bus current in milliamps.
///
/// Values greater than 500 mA (`500u16`) will result in panic.
pub fn set_max_current(&mut self, value: u16) {
assert!(value <= 500, "{value} exceeds 500 mA limit");
(self.0).MaxPower = value
}
/// Device power source.
///
/// * `true` if the device is self-powered (not powered by USB bus).
/// * `false` if the device is powered by the USB bus.
pub fn self_powered(&self) -> bool {
(self.0).SelfPowered != 0
}
/// Set device power source.
///
/// * `true` if the device is self-powered (not powered by USB bus).
/// * `false` if the device is powered by the USB bus.
pub fn set_self_powered(&mut self, value: bool) {
(self.0).SelfPowered = value.into()
}
/// Remote wakeup capabilities.
///
/// USB remote wakeup is the ability for the device to resume the PC from
/// USB suspend (sleep) state.
///
/// * `true` if the device is capable of remote wakeup.
/// * `false` if the device is not capable of remote wakeup.
pub fn remote_wakeup(&self) -> bool {
(self.0).RemoteWakeup != 0
}
/// Set remote wakeup capabilities.
///
/// USB remote wakeup is the ability for the device to resume the PC from
/// USB suspend (sleep) state.
///
/// * `true` if the device is capable of remote wakeup.
/// * `false` if the device is not capable of remote wakeup.
pub fn set_remote_wakeup(&mut self, value: bool) {
(self.0).RemoteWakeup = value.into()
}
/// Pull down in suspend mode.
///
/// * `true` if pull-down in suspend is enabled.
/// * `false` if pull-down in suspend is disabled.
pub fn pull_down_enable(&self) -> bool {
(self.0).PullDownEnable != 0
}
/// Set pull down in suspend mode.
///
/// * `true` if pull-down in suspend is enabled.
/// * `false` if pull-down in suspend is disabled.
pub fn set_pull_down_enable(&mut self, value: bool) {
(self.0).PullDownEnable = value.into()
}
}
impl Default for EepromHeader {
fn default() -> Self {
Self(FT_EEPROM_HEADER {
deviceType: DeviceType::Unknown as u32,
VendorId: 0x0403,
ProductId: 0x6000,
SerNumEnable: 1,
MaxPower: 150,
SelfPowered: 0,
RemoteWakeup: 0,
PullDownEnable: 0,
})
}
}
impl From<FT_EEPROM_HEADER> for EepromHeader {
fn from(val: FT_EEPROM_HEADER) -> EepromHeader {
EepromHeader(val)
}
}
impl From<EepromHeader> for FT_EEPROM_HEADER {
fn from(val: EepromHeader) -> FT_EEPROM_HEADER {
val.0
}
}
impl Eeprom232h {
/// Get the EEPROM header.
pub fn header(&self) -> EepromHeader {
EepromHeader((self.0).common)
}
/// Set the EEPROM header.
pub fn set_header(&mut self, header: EepromHeader) {
(self.0).common = header.into()
}
/// FT1248 clock polarity.
pub fn ft1248_cpol(&self) -> ClockPolarity {
(self.0).FT1248Cpol.into()
}
/// Set FT1248 clock polarity.
pub fn set_ft1248_cpol(&mut self, value: ClockPolarity) {
(self.0).FT1248Cpol = value as u8
}
/// FT1248 byte order.
pub fn ft1248_byteorder(&self) -> ByteOrder {
(self.0).FT1248Lsb.into()
}
/// Set FT1248 byte order.
pub fn set_ft1248_byteorder(&mut self, value: ByteOrder) {
(self.0).FT1248Lsb = value as u8
}
/// FT1248 flow control enable.
pub fn ft1248_flow_control(&self) -> bool {
(self.0).FT1248FlowControl != 0
}
/// Set FT1248 flow control enable.
pub fn set_ft1248_flow_control(&mut self, value: bool) {
(self.0).FT1248FlowControl = value.into()
}
/// FT245 FIFO interface mode.
pub fn is_fifo(&self) -> bool {
(self.0).IsFifo != 0
}
/// Set FT245 FIFO interface mode.
pub fn set_is_fifo(&mut self, value: bool) {
(self.0).IsFifo = value.into()
}
/// FT245 FIFO CPU target mode.
pub fn is_fifo_target(&self) -> bool {
(self.0).IsFifoTar != 0
}
/// Set FT245 FIFO CPU target mode.
pub fn set_is_fifo_target(&mut self, value: bool) {
(self.0).IsFifoTar = value.into()
}
/// Fast serial interface mode.
pub fn is_fast_serial(&self) -> bool {
(self.0).IsFastSer != 0
}
/// Set Fast serial interface mode.
pub fn set_is_fast_serial(&mut self, value: bool) {
(self.0).IsFastSer = value.into()
}
/// FT1248 interface mode.
pub fn is_ft1248(&self) -> bool {
(self.0).IsFT1248 != 0
}
/// Set FT1248 interface mode.
pub fn set_is_ft1248(&mut self, value: bool) {
(self.0).IsFT1248 = value.into()
}
/// Power save enable.
///
/// Use a pin to save power for self-powered designs.
pub fn power_save_enable(&self) -> bool {
(self.0).PowerSaveEnable != 0
}
/// Set power save enable.
pub fn set_power_save_enable(&mut self, value: bool) {
(self.0).PowerSaveEnable = value.into()
}
}
macro_rules! impl_bus_pins {
($NAME:ident, $($FIELD:ident),+) => {
impl $NAME {
$(
paste::item! {
#[doc = "Slow slew for bus " $FIELD "."]
///
/// `true` if the pins on this bus have slow slew.
pub fn [<$FIELD:lower _slow_slew>](&self) -> bool {
(self.0).[<$FIELD:upper SlowSlew>] != 0
}
#[doc = "Set slow slew for bus " $FIELD "."]
pub fn [<set_ $FIELD:lower _slow_slew>](&mut self, value: bool) {
(self.0).[<$FIELD:upper SlowSlew>] = value.into()
}
#[doc = "Schmitt input for bus " $FIELD "."]
///
/// `true` if the pins on this bus are Schmitt input.
pub fn [<$FIELD:lower _schmitt_input>](&self) -> bool {
(self.0).[<$FIELD:upper SchmittInput>] != 0
}
#[doc = "Set Schmitt input for bus " $FIELD "."]
pub fn [<set_ $FIELD:lower _schmitt_input>](&mut self, value: bool) {
(self.0).[<$FIELD:upper SchmittInput>] = value.into()
}
#[doc = "Drive current for bus " $FIELD "."]
///
/// This is the drive current for the pins on this bus.
pub fn [<$FIELD:lower _drive_current>](&self) -> Result<DriveCurrent, EepromValueError> {
DriveCurrent::try_from((self.0).[<$FIELD:upper DriveCurrent>])
}
#[doc = "Drive current unchecked for bus " $FIELD "."]
///
/// Valid values are 4mA, 8mA, 12mA, or 16mA,
/// represented by 4u8, 8u8, 12u8, or 16u8 respectively.
///
/// This is the **unchecked** raw value retrived from the EEPROM and it may
/// not be a valid value.
pub fn [<$FIELD:lower _drive_current_unchecked>](&self) -> u8 {
(self.0).[<$FIELD:upper DriveCurrent>]
}
#[doc = "Set drive current for bus " $FIELD "."]
pub fn [<set_ $FIELD:lower _drive_current>](&mut self, value: DriveCurrent) {
(self.0).[<$FIELD:upper DriveCurrent>] = value as u8
}
}
)*
}
};
}
macro_rules! impl_driver_type {
($NAME:ident) => {
impl $NAME {
/// Get the device driver type.
pub fn driver_type(&self) -> Result<DriverType, EepromValueError> {
DriverType::try_from((self.0).DriverType)
}
/// Get the unchecked device driver type.
///
/// This is the **unchecked** raw value retrieved from the
/// EEPROM and it may not be a valid value.
pub fn driver_type_unchecked(&self) -> u8 {
(self.0).DriverType
}
/// Set the device driver type.
pub fn set_driver_type(&mut self, value: DriverType) {
(self.0).DriverType = value as u8
}
}
};
($NAME:ident, $($FIELD:ident),+) => {
impl $NAME {
paste::item! {
$(
#[doc = "Get the driver type for port " $FIELD "."]
pub fn [<$FIELD:lower _driver_type>](&self) -> Result<DriverType, EepromValueError> {
DriverType::try_from((self.0).[<$FIELD:upper DriverType>])
}
#[doc = "Get the unchecked driver type for port " $FIELD "."]
///
/// This is the **unchecked** raw value retrieved from the
/// EEPROM and it may not be a valid value.
pub fn [<$FIELD:lower _driver_type_unchecked>](&self) -> u8 {
(self.0).[<$FIELD:upper DriverType>]
}
#[doc = "Set the driver type for port " $FIELD "."]
pub fn [<set_ $FIELD:lower _driver_type>](&mut self, value: DriverType) {
(self.0).[<$FIELD:upper DriverType>] = value as u8
}
)*
}
}
};
}
macro_rules! impl_tx_data_enable {
($NAME:ident, $($FIELD:ident),+) => {
impl $NAME {
$(
paste::item! {
#[doc = "Use port " $FIELD " as RS485 TX data enable."]
pub fn [<$FIELD:lower _ri_is_tx_data_enable>](&self) -> bool {
(self.0).[<$FIELD:upper RIIsTXDEN>] != 0
}
#[doc = "Use port " $FIELD " as RS485 TX data enable."]
pub fn [<set_ $FIELD:lower _ri_is_tx_data_enable>](&mut self, value: bool) {
(self.0).[<$FIELD:upper RIIsTXDEN>] = value.into()
}
}
)*
}
};
}
macro_rules! impl_invert_232_signals {
($NAME:ident, $($FIELD:ident),+) => {
impl $NAME {
$(
paste::item! {
#[doc = "Get if " $FIELD " is inverted."]
pub fn [<invert_ $FIELD:lower>](&self) -> bool {
return (self.0).[<Invert $FIELD:upper>] == 1;
}
#[doc = "Set whether " $FIELD " is inverted."]
pub fn [<set_invert_ $FIELD:lower>](&mut self, val: bool) {
(self.0).[<Invert $FIELD:upper>] = val as u8;
}
}
)*
}
};
}
macro_rules! impl_cbus {
(
$NAME:ident,
$ENUM:ident,
$($FIELD:ident,)+
) => {
impl $NAME {
$(
paste::item! {
#[doc = "Get the unchecked value of the " $FIELD " pin."]
///
/// This is the **unchecked** raw value retrieved from the
/// EEPROM and it may not be a valid value.
pub fn [<$FIELD:lower _unchecked>](&self) -> u8 {
(self.0).$FIELD
}
#[doc = "Get the value of the " $FIELD " pin."]
pub fn [<$FIELD:lower>](&self) -> Result<$ENUM, EepromValueError> {
$ENUM::try_from((self.0).$FIELD)
}
#[doc = "Get the value of the " $FIELD " pin."]
pub fn [<set_ $FIELD:lower>](&mut self, value: $ENUM) {
(self.0).$FIELD = value as u8;
}
}
)*
}
};
}
// this is where most of the boilerplate is implemented
//Ft232h
impl_bus_pins!(Eeprom232h, AD, AC);
impl_cbus!(
Eeprom232h, Cbus232h, Cbus0, Cbus1, Cbus2, Cbus3, Cbus4, Cbus5, Cbus6, Cbus7, Cbus8, Cbus9,
);
impl_driver_type!(Eeprom232h);
//Ft232r
impl_driver_type!(Eeprom232r);
impl_invert_232_signals!(Eeprom232r, TXD, RXD, RTS, CTS, DTR, DSR, DCD, RI);
//Ft4232h
impl_bus_pins!(Eeprom4232h, A, B, C, D);
impl_tx_data_enable!(Eeprom4232h, A, B, C, D);
impl_driver_type!(Eeprom4232h, A, B, C, D);
//FtXseries
impl_cbus!(EepromXSeries, CbusX, Cbus5, Cbus6,);
impl_driver_type!(EepromXSeries);
impl_bus_pins!(EepromXSeries, AC, AD);
impl_invert_232_signals!(EepromXSeries, TXD, RXD, RTS, CTS, DTR, DSR, DCD, RI);
// These get around an annoyance with bindgen generating different types for
// preprocessor macros on Linux vs Windows.
const NORM_232R_CBUS_TXDEN: u8 = FT_232R_CBUS_TXDEN as u8;
const NORM_232R_CBUS_PWRON: u8 = FT_232R_CBUS_PWRON as u8;
const NORM_232R_CBUS_RXLED: u8 = FT_232R_CBUS_RXLED as u8;
const NORM_232R_CBUS_TXLED: u8 = FT_232R_CBUS_TXLED as u8;
const NORM_232R_CBUS_TXRXLED: u8 = FT_232R_CBUS_TXRXLED as u8;
const NORM_232R_CBUS_SLEEP: u8 = FT_232R_CBUS_SLEEP as u8;
const NORM_232R_CBUS_CLK48: u8 = FT_232R_CBUS_CLK48 as u8;
const NORM_232R_CBUS_CLK24: u8 = FT_232R_CBUS_CLK24 as u8;
const NORM_232R_CBUS_CLK12: u8 = FT_232R_CBUS_CLK12 as u8;
const NORM_232R_CBUS_CLK6: u8 = FT_232R_CBUS_CLK6 as u8;
const NORM_232R_CBUS_IOMODE: u8 = FT_232R_CBUS_IOMODE as u8;
const NORM_232R_CBUS_BITBANG_WR: u8 = FT_232R_CBUS_BITBANG_WR as u8;
const NORM_232R_CBUS_BITBANG_RD: u8 = FT_232R_CBUS_BITBANG_RD as u8;
cbus_enum!(
/// FT232R CBUS options.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
pub enum Cbus232r {
/// TX data enable.
TxDataEnable = NORM_232R_CBUS_TXDEN,
/// Power on.
PowerOn = NORM_232R_CBUS_PWRON,
/// RX LED.
RxLed = NORM_232R_CBUS_RXLED,
/// TX LED.
TxLed = NORM_232R_CBUS_TXLED,
/// TX and RX LED.
TxRxLed = NORM_232R_CBUS_TXRXLED,
/// Sleep.
Sleep = NORM_232R_CBUS_SLEEP,
/// 48MHz clock.
Clk48 = NORM_232R_CBUS_CLK48,
/// 24MHz clock.
Clk24 = NORM_232R_CBUS_CLK24,
/// 12MHz clock.
Clk12 = NORM_232R_CBUS_CLK12,
/// 6MHz clock.
Clk6 = NORM_232R_CBUS_CLK6,
/// IO mode for CBUS bit-bang.
IoMode = NORM_232R_CBUS_IOMODE,
/// Bit-bang write stobe.
BitbangWrite = NORM_232R_CBUS_BITBANG_WR,
/// Bit-bang read stobe.
BitbangRead = NORM_232R_CBUS_BITBANG_RD,
}
);
// These get around an annoyance with bindgen generating different types for
// preprocessor macros on Linux vs Windows.
const NORM_X_SERIES_CBUS_TRISTATE: u8 = FT_X_SERIES_CBUS_TRISTATE as u8;
const NORM_X_SERIES_CBUS_TXLED: u8 = FT_X_SERIES_CBUS_TXLED as u8;
const NORM_X_SERIES_CBUS_RXLED: u8 = FT_X_SERIES_CBUS_RXLED as u8;
const NORM_X_SERIES_CBUS_TXRXLED: u8 = FT_X_SERIES_CBUS_TXRXLED as u8;
const NORM_X_SERIES_CBUS_PWREN: u8 = FT_X_SERIES_CBUS_PWREN as u8;
const NORM_X_SERIES_CBUS_SLEEP: u8 = FT_X_SERIES_CBUS_SLEEP as u8;
const NORM_X_SERIES_CBUS_DRIVE_0: u8 = FT_X_SERIES_CBUS_DRIVE_0 as u8;
const NORM_X_SERIES_CBUS_DRIVE_1: u8 = FT_X_SERIES_CBUS_DRIVE_1 as u8;
const NORM_X_SERIES_CBUS_IOMODE: u8 = FT_X_SERIES_CBUS_IOMODE as u8;
const NORM_X_SERIES_CBUS_TXDEN: u8 = FT_X_SERIES_CBUS_TXDEN as u8;
const NORM_X_SERIES_CBUS_CLK24: u8 = FT_X_SERIES_CBUS_CLK24 as u8;
const NORM_X_SERIES_CBUS_CLK12: u8 = FT_X_SERIES_CBUS_CLK12 as u8;
const NORM_X_SERIES_CBUS_CLK6: u8 = FT_X_SERIES_CBUS_CLK6 as u8;
const NORM_X_SERIES_CBUS_BCD_CHARGER: u8 = FT_X_SERIES_CBUS_BCD_CHARGER as u8;
const NORM_X_SERIES_CBUS_BCD_CHARGER_N: u8 = FT_X_SERIES_CBUS_BCD_CHARGER_N as u8;
const NORM_X_SERIES_CBUS_I2C_TXE: u8 = FT_X_SERIES_CBUS_I2C_TXE as u8;
const NORM_X_SERIES_CBUS_I2C_RXF: u8 = FT_X_SERIES_CBUS_I2C_RXF as u8;
const NORM_X_SERIES_CBUS_VBUS_SENSE: u8 = FT_X_SERIES_CBUS_VBUS_SENSE as u8;
const NORM_X_SERIES_CBUS_BITBANG_WR: u8 = FT_X_SERIES_CBUS_BITBANG_WR as u8;
const NORM_X_SERIES_CBUS_BITBANG_RD: u8 = FT_X_SERIES_CBUS_BITBANG_RD as u8;
const NORM_X_SERIES_CBUS_TIMESTAMP: u8 = FT_X_SERIES_CBUS_TIMESTAMP as u8;
const NORM_X_SERIES_CBUS_KEEP_AWAKE: u8 = FT_X_SERIES_CBUS_KEEP_AWAKE as u8;
cbus_enum!(
/// FT X Series CBUS options.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
pub enum CbusX {
/// Tristate.
Tristate = NORM_X_SERIES_CBUS_TRISTATE,
/// TX LED.
TxLed = NORM_X_SERIES_CBUS_TXLED,
/// RX LED.
RxLed = NORM_X_SERIES_CBUS_RXLED,
/// TX and RX LED.
TxRxLed = NORM_X_SERIES_CBUS_TXRXLED,
/// Power enable.
PowerEnable = NORM_X_SERIES_CBUS_PWREN,
/// Sleep.
Sleep = NORM_X_SERIES_CBUS_SLEEP,
/// Drive pin to logic 0.
Drive0 = NORM_X_SERIES_CBUS_DRIVE_0,
/// Drive pin to logic 1.
Drive1 = NORM_X_SERIES_CBUS_DRIVE_1,
/// IO Mode doe CBUS bit-bang.
IoMode = NORM_X_SERIES_CBUS_IOMODE,
/// TX data enable.
TxDen = NORM_X_SERIES_CBUS_TXDEN,
/// 24MHz clock.
Clk24 = NORM_X_SERIES_CBUS_CLK24,
/// 12MHz clock.
Clk12 = NORM_X_SERIES_CBUS_CLK12,
/// 6MHz clock.
Clk6 = NORM_X_SERIES_CBUS_CLK6,
/// Battery charger detected.
BatteryCharger = NORM_X_SERIES_CBUS_BCD_CHARGER,
/// Battery charger detected inverted.
BatteryChargerN = NORM_X_SERIES_CBUS_BCD_CHARGER_N,
/// I2C Tx empty.
I2cTxEmpty = NORM_X_SERIES_CBUS_I2C_TXE,
/// I2C Rx full.
I2cRxFull = NORM_X_SERIES_CBUS_I2C_RXF,
/// Detect VBUS.
VbusSense = NORM_X_SERIES_CBUS_VBUS_SENSE,
/// Bit-bang write strobe.
BitbangWrite = NORM_X_SERIES_CBUS_BITBANG_WR,
/// Bit-bang read strobe.
BitbangRead = NORM_X_SERIES_CBUS_BITBANG_RD,
/// Toggle output when a USB SOF token is received.
Timestamp = NORM_X_SERIES_CBUS_TIMESTAMP,
/// No documentation is provided by the source.
KeepAwake = NORM_X_SERIES_CBUS_KEEP_AWAKE,
}
);