Loading...
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 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 | // SPDX-License-Identifier: GPL-2.0 /* * Mellanox BlueField I2C bus driver * * Copyright (C) 2020 Mellanox Technologies, Ltd. */ #include <linux/acpi.h> #include <linux/bitfield.h> #include <linux/delay.h> #include <linux/err.h> #include <linux/interrupt.h> #include <linux/i2c.h> #include <linux/io.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/mutex.h> #include <linux/of.h> #include <linux/platform_device.h> #include <linux/string.h> /* Defines what functionality is present. */ #define MLXBF_I2C_FUNC_SMBUS_BLOCK \ (I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_BLOCK_PROC_CALL) #define MLXBF_I2C_FUNC_SMBUS_DEFAULT \ (I2C_FUNC_SMBUS_BYTE | I2C_FUNC_SMBUS_BYTE_DATA | \ I2C_FUNC_SMBUS_WORD_DATA | I2C_FUNC_SMBUS_I2C_BLOCK | \ I2C_FUNC_SMBUS_PROC_CALL) #define MLXBF_I2C_FUNC_ALL \ (MLXBF_I2C_FUNC_SMBUS_DEFAULT | MLXBF_I2C_FUNC_SMBUS_BLOCK | \ I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SLAVE) /* Shared resources info in BlueField platforms. */ #define MLXBF_I2C_COALESCE_TYU_ADDR 0x02801300 #define MLXBF_I2C_COALESCE_TYU_SIZE 0x010 #define MLXBF_I2C_GPIO_TYU_ADDR 0x02802000 #define MLXBF_I2C_GPIO_TYU_SIZE 0x100 #define MLXBF_I2C_COREPLL_TYU_ADDR 0x02800358 #define MLXBF_I2C_COREPLL_TYU_SIZE 0x008 #define MLXBF_I2C_COREPLL_YU_ADDR 0x02800c30 #define MLXBF_I2C_COREPLL_YU_SIZE 0x00c #define MLXBF_I2C_COREPLL_RSH_YU_ADDR 0x13409824 #define MLXBF_I2C_COREPLL_RSH_YU_SIZE 0x00c #define MLXBF_I2C_SHARED_RES_MAX 3 /* * Note that the following SMBus, CAUSE, GPIO and PLL register addresses * refer to their respective offsets relative to the corresponding * memory-mapped region whose addresses are specified in either the DT or * the ACPI tables or above. */ /* * SMBus Master core clock frequency. Timing configurations are * strongly dependent on the core clock frequency of the SMBus * Master. Default value is set to 400MHz. */ #define MLXBF_I2C_TYU_PLL_OUT_FREQ (400 * 1000 * 1000) /* Reference clock for Bluefield - 156 MHz. */ #define MLXBF_I2C_PLL_IN_FREQ 156250000ULL /* Constant used to determine the PLL frequency. */ #define MLNXBF_I2C_COREPLL_CONST 16384ULL #define MLXBF_I2C_FREQUENCY_1GHZ 1000000000ULL /* PLL registers. */ #define MLXBF_I2C_CORE_PLL_REG1 0x4 #define MLXBF_I2C_CORE_PLL_REG2 0x8 /* OR cause register. */ #define MLXBF_I2C_CAUSE_OR_EVTEN0 0x14 #define MLXBF_I2C_CAUSE_OR_CLEAR 0x18 /* Arbiter Cause Register. */ #define MLXBF_I2C_CAUSE_ARBITER 0x1c /* * Cause Status flags. Note that those bits might be considered * as interrupt enabled bits. */ /* Transaction ended with STOP. */ #define MLXBF_I2C_CAUSE_TRANSACTION_ENDED BIT(0) /* Master arbitration lost. */ #define MLXBF_I2C_CAUSE_M_ARBITRATION_LOST BIT(1) /* Unexpected start detected. */ #define MLXBF_I2C_CAUSE_UNEXPECTED_START BIT(2) /* Unexpected stop detected. */ #define MLXBF_I2C_CAUSE_UNEXPECTED_STOP BIT(3) /* Wait for transfer continuation. */ #define MLXBF_I2C_CAUSE_WAIT_FOR_FW_DATA BIT(4) /* Failed to generate STOP. */ #define MLXBF_I2C_CAUSE_PUT_STOP_FAILED BIT(5) /* Failed to generate START. */ #define MLXBF_I2C_CAUSE_PUT_START_FAILED BIT(6) /* Clock toggle completed. */ #define MLXBF_I2C_CAUSE_CLK_TOGGLE_DONE BIT(7) /* Transfer timeout occurred. */ #define MLXBF_I2C_CAUSE_M_FW_TIMEOUT BIT(8) /* Master busy bit reset. */ #define MLXBF_I2C_CAUSE_M_GW_BUSY_FALL BIT(9) #define MLXBF_I2C_CAUSE_MASTER_ARBITER_BITS_MASK GENMASK(9, 0) #define MLXBF_I2C_CAUSE_MASTER_STATUS_ERROR \ (MLXBF_I2C_CAUSE_M_ARBITRATION_LOST | \ MLXBF_I2C_CAUSE_UNEXPECTED_START | \ MLXBF_I2C_CAUSE_UNEXPECTED_STOP | \ MLXBF_I2C_CAUSE_PUT_STOP_FAILED | \ MLXBF_I2C_CAUSE_PUT_START_FAILED | \ MLXBF_I2C_CAUSE_CLK_TOGGLE_DONE | \ MLXBF_I2C_CAUSE_M_FW_TIMEOUT) /* * Slave cause status flags. Note that those bits might be considered * as interrupt enabled bits. */ /* Write transaction received successfully. */ #define MLXBF_I2C_CAUSE_WRITE_SUCCESS BIT(0) /* Read transaction received, waiting for response. */ #define MLXBF_I2C_CAUSE_READ_WAIT_FW_RESPONSE BIT(13) /* Slave busy bit reset. */ #define MLXBF_I2C_CAUSE_S_GW_BUSY_FALL BIT(18) /* Cause coalesce registers. */ #define MLXBF_I2C_CAUSE_COALESCE_0 0x00 #define MLXBF_I2C_CAUSE_TYU_SLAVE_BIT 3 #define MLXBF_I2C_CAUSE_YU_SLAVE_BIT 1 /* Functional enable register. */ #define MLXBF_I2C_GPIO_0_FUNC_EN_0 0x28 /* Force OE enable register. */ #define MLXBF_I2C_GPIO_0_FORCE_OE_EN 0x30 /* * Note that Smbus GWs are on GPIOs 30:25. Two pins are used to control * SDA/SCL lines: * * SMBUS GW0 -> bits[26:25] * SMBUS GW1 -> bits[28:27] * SMBUS GW2 -> bits[30:29] */ #define MLXBF_I2C_GPIO_SMBUS_GW_PINS(num) (25 + ((num) << 1)) /* Note that gw_id can be 0,1 or 2. */ #define MLXBF_I2C_GPIO_SMBUS_GW_MASK(num) \ (0xffffffff & (~(0x3 << MLXBF_I2C_GPIO_SMBUS_GW_PINS(num)))) #define MLXBF_I2C_GPIO_SMBUS_GW_RESET_PINS(num, val) \ ((val) & MLXBF_I2C_GPIO_SMBUS_GW_MASK(num)) #define MLXBF_I2C_GPIO_SMBUS_GW_ASSERT_PINS(num, val) \ ((val) | (0x3 << MLXBF_I2C_GPIO_SMBUS_GW_PINS(num))) /* * Defines SMBus operating frequency and core clock frequency. * According to ADB files, default values are compliant to 100KHz SMBus * @ 400MHz core clock. The driver should be able to calculate core * frequency based on PLL parameters. */ #define MLXBF_I2C_COREPLL_FREQ MLXBF_I2C_TYU_PLL_OUT_FREQ /* Core PLL TYU configuration. */ #define MLXBF_I2C_COREPLL_CORE_F_TYU_MASK GENMASK(15, 3) #define MLXBF_I2C_COREPLL_CORE_OD_TYU_MASK GENMASK(19, 16) #define MLXBF_I2C_COREPLL_CORE_R_TYU_MASK GENMASK(25, 20) /* Core PLL YU configuration. */ #define MLXBF_I2C_COREPLL_CORE_F_YU_MASK GENMASK(25, 0) #define MLXBF_I2C_COREPLL_CORE_OD_YU_MASK GENMASK(3, 0) #define MLXBF_I2C_COREPLL_CORE_R_YU_MASK GENMASK(31, 26) /* SMBus timing parameters. */ #define MLXBF_I2C_SMBUS_TIMER_SCL_LOW_SCL_HIGH 0x00 #define MLXBF_I2C_SMBUS_TIMER_FALL_RISE_SPIKE 0x04 #define MLXBF_I2C_SMBUS_TIMER_THOLD 0x08 #define MLXBF_I2C_SMBUS_TIMER_TSETUP_START_STOP 0x0c #define MLXBF_I2C_SMBUS_TIMER_TSETUP_DATA 0x10 #define MLXBF_I2C_SMBUS_THIGH_MAX_TBUF 0x14 #define MLXBF_I2C_SMBUS_SCL_LOW_TIMEOUT 0x18 #define MLXBF_I2C_SHIFT_0 0 #define MLXBF_I2C_SHIFT_8 8 #define MLXBF_I2C_SHIFT_16 16 #define MLXBF_I2C_SHIFT_24 24 #define MLXBF_I2C_MASK_8 GENMASK(7, 0) #define MLXBF_I2C_MASK_16 GENMASK(15, 0) #define MLXBF_I2C_MST_ADDR_OFFSET 0x200 /* SMBus Master GW. */ #define MLXBF_I2C_SMBUS_MASTER_GW 0x0 /* Number of bytes received and sent. */ #define MLXBF_I2C_YU_SMBUS_RS_BYTES 0x100 #define MLXBF_I2C_RSH_YU_SMBUS_RS_BYTES 0x10c /* Packet error check (PEC) value. */ #define MLXBF_I2C_SMBUS_MASTER_PEC 0x104 /* Status bits (ACK/NACK/FW Timeout). */ #define MLXBF_I2C_SMBUS_MASTER_STATUS 0x108 /* SMbus Master Finite State Machine. */ #define MLXBF_I2C_YU_SMBUS_MASTER_FSM 0x110 #define MLXBF_I2C_RSH_YU_SMBUS_MASTER_FSM 0x100 /* SMBus master GW control bits offset in MLXBF_I2C_SMBUS_MASTER_GW[31:3]. */ #define MLXBF_I2C_MASTER_LOCK_BIT BIT(31) /* Lock bit. */ #define MLXBF_I2C_MASTER_BUSY_BIT BIT(30) /* Busy bit. */ #define MLXBF_I2C_MASTER_START_BIT BIT(29) /* Control start. */ #define MLXBF_I2C_MASTER_CTL_WRITE_BIT BIT(28) /* Control write phase. */ #define MLXBF_I2C_MASTER_CTL_READ_BIT BIT(19) /* Control read phase. */ #define MLXBF_I2C_MASTER_STOP_BIT BIT(3) /* Control stop. */ #define MLXBF_I2C_MASTER_ENABLE \ (MLXBF_I2C_MASTER_LOCK_BIT | MLXBF_I2C_MASTER_BUSY_BIT | \ MLXBF_I2C_MASTER_START_BIT | MLXBF_I2C_MASTER_STOP_BIT) #define MLXBF_I2C_MASTER_ENABLE_WRITE \ (MLXBF_I2C_MASTER_ENABLE | MLXBF_I2C_MASTER_CTL_WRITE_BIT) #define MLXBF_I2C_MASTER_ENABLE_READ \ (MLXBF_I2C_MASTER_ENABLE | MLXBF_I2C_MASTER_CTL_READ_BIT) #define MLXBF_I2C_MASTER_WRITE_SHIFT 21 /* Control write bytes */ #define MLXBF_I2C_MASTER_SEND_PEC_SHIFT 20 /* Send PEC byte when set to 1 */ #define MLXBF_I2C_MASTER_PARSE_EXP_SHIFT 11 /* Control parse expected bytes */ #define MLXBF_I2C_MASTER_SLV_ADDR_SHIFT 12 /* Slave address */ #define MLXBF_I2C_MASTER_READ_SHIFT 4 /* Control read bytes */ /* SMBus master GW Data descriptor. */ #define MLXBF_I2C_MASTER_DATA_DESC_ADDR 0x80 #define MLXBF_I2C_MASTER_DATA_DESC_SIZE 0x80 /* Size in bytes. */ /* Maximum bytes to read/write per SMBus transaction. */ #define MLXBF_I2C_MASTER_DATA_R_LENGTH MLXBF_I2C_MASTER_DATA_DESC_SIZE #define MLXBF_I2C_MASTER_DATA_W_LENGTH (MLXBF_I2C_MASTER_DATA_DESC_SIZE - 1) /* All bytes were transmitted. */ #define MLXBF_I2C_SMBUS_STATUS_BYTE_CNT_DONE BIT(0) /* NACK received. */ #define MLXBF_I2C_SMBUS_STATUS_NACK_RCV BIT(1) /* Slave's byte count >128 bytes. */ #define MLXBF_I2C_SMBUS_STATUS_READ_ERR BIT(2) /* Timeout occurred. */ #define MLXBF_I2C_SMBUS_STATUS_FW_TIMEOUT BIT(3) #define MLXBF_I2C_SMBUS_MASTER_STATUS_MASK GENMASK(3, 0) #define MLXBF_I2C_SMBUS_MASTER_STATUS_ERROR \ (MLXBF_I2C_SMBUS_STATUS_NACK_RCV | \ MLXBF_I2C_SMBUS_STATUS_READ_ERR | \ MLXBF_I2C_SMBUS_STATUS_FW_TIMEOUT) #define MLXBF_I2C_SMBUS_MASTER_FSM_STOP_MASK BIT(31) #define MLXBF_I2C_SMBUS_MASTER_FSM_PS_STATE_MASK BIT(15) #define MLXBF_I2C_SLV_ADDR_OFFSET 0x400 /* SMBus slave GW. */ #define MLXBF_I2C_SMBUS_SLAVE_GW 0x0 /* Number of bytes received and sent from/to master. */ #define MLXBF_I2C_SMBUS_SLAVE_RS_MASTER_BYTES 0x100 /* Packet error check (PEC) value. */ #define MLXBF_I2C_SMBUS_SLAVE_PEC 0x104 /* SMBus slave Finite State Machine (FSM). */ #define MLXBF_I2C_SMBUS_SLAVE_FSM 0x110 /* * Should be set when all raised causes handled, and cleared by HW on * every new cause. */ #define MLXBF_I2C_SMBUS_SLAVE_READY 0x12c /* SMBus slave GW control bits offset in MLXBF_I2C_SMBUS_SLAVE_GW[31:19]. */ #define MLXBF_I2C_SLAVE_BUSY_BIT BIT(30) /* Busy bit. */ #define MLXBF_I2C_SLAVE_WRITE_BIT BIT(29) /* Control write enable. */ #define MLXBF_I2C_SLAVE_ENABLE \ (MLXBF_I2C_SLAVE_BUSY_BIT | MLXBF_I2C_SLAVE_WRITE_BIT) #define MLXBF_I2C_SLAVE_WRITE_BYTES_SHIFT 22 /* Number of bytes to write. */ #define MLXBF_I2C_SLAVE_SEND_PEC_SHIFT 21 /* Send PEC byte shift. */ /* SMBus slave GW Data descriptor. */ #define MLXBF_I2C_SLAVE_DATA_DESC_ADDR 0x80 #define MLXBF_I2C_SLAVE_DATA_DESC_SIZE 0x80 /* Size in bytes. */ /* SMbus slave configuration registers. */ #define MLXBF_I2C_SMBUS_SLAVE_ADDR_CFG 0x114 #define MLXBF_I2C_SMBUS_SLAVE_ADDR_CNT 16 #define MLXBF_I2C_SMBUS_SLAVE_ADDR_EN_BIT BIT(7) #define MLXBF_I2C_SMBUS_SLAVE_ADDR_MASK GENMASK(6, 0) /* * Timeout is given in microsends. Note also that timeout handling is not * exact. */ #define MLXBF_I2C_SMBUS_TIMEOUT (300 * 1000) /* 300ms */ #define MLXBF_I2C_SMBUS_LOCK_POLL_TIMEOUT (300 * 1000) /* 300ms */ /* Polling frequency in microseconds. */ #define MLXBF_I2C_POLL_FREQ_IN_USEC 200 #define MLXBF_I2C_SMBUS_OP_CNT_1 1 #define MLXBF_I2C_SMBUS_OP_CNT_2 2 #define MLXBF_I2C_SMBUS_OP_CNT_3 3 #define MLXBF_I2C_SMBUS_MAX_OP_CNT MLXBF_I2C_SMBUS_OP_CNT_3 /* Helper macro to define an I2C resource parameters. */ #define MLXBF_I2C_RES_PARAMS(addr, size, str) \ { \ .start = (addr), \ .end = (addr) + (size) - 1, \ .name = (str) \ } enum { MLXBF_I2C_TIMING_100KHZ = 100000, MLXBF_I2C_TIMING_400KHZ = 400000, MLXBF_I2C_TIMING_1000KHZ = 1000000, }; enum { MLXBF_I2C_F_READ = BIT(0), MLXBF_I2C_F_WRITE = BIT(1), MLXBF_I2C_F_NORESTART = BIT(3), MLXBF_I2C_F_SMBUS_OPERATION = BIT(4), MLXBF_I2C_F_SMBUS_BLOCK = BIT(5), MLXBF_I2C_F_SMBUS_PEC = BIT(6), MLXBF_I2C_F_SMBUS_PROCESS_CALL = BIT(7), }; /* Mellanox BlueField chip type. */ enum mlxbf_i2c_chip_type { MLXBF_I2C_CHIP_TYPE_1, /* Mellanox BlueField-1 chip. */ MLXBF_I2C_CHIP_TYPE_2, /* Mellanox BlueField-2 chip. */ MLXBF_I2C_CHIP_TYPE_3 /* Mellanox BlueField-3 chip. */ }; /* List of chip resources that are being accessed by the driver. */ enum { MLXBF_I2C_SMBUS_RES, MLXBF_I2C_MST_CAUSE_RES, MLXBF_I2C_SLV_CAUSE_RES, MLXBF_I2C_COALESCE_RES, MLXBF_I2C_SMBUS_TIMER_RES, MLXBF_I2C_SMBUS_MST_RES, MLXBF_I2C_SMBUS_SLV_RES, MLXBF_I2C_COREPLL_RES, MLXBF_I2C_GPIO_RES, MLXBF_I2C_END_RES }; /* Encapsulates timing parameters. */ struct mlxbf_i2c_timings { u16 scl_high; /* Clock high period. */ u16 scl_low; /* Clock low period. */ u8 sda_rise; /* Data rise time. */ u8 sda_fall; /* Data fall time. */ u8 scl_rise; /* Clock rise time. */ u8 scl_fall; /* Clock fall time. */ u16 hold_start; /* Hold time after (REPEATED) START. */ u16 hold_data; /* Data hold time. */ u16 setup_start; /* REPEATED START condition setup time. */ u16 setup_stop; /* STOP condition setup time. */ u16 setup_data; /* Data setup time. */ u16 pad; /* Padding. */ u16 buf; /* Bus free time between STOP and START. */ u16 thigh_max; /* Thigh max. */ u32 timeout; /* Detect clock low timeout. */ }; struct mlxbf_i2c_smbus_operation { u32 flags; u32 length; /* Buffer length in bytes. */ u8 *buffer; }; struct mlxbf_i2c_smbus_request { u8 slave; u8 operation_cnt; struct mlxbf_i2c_smbus_operation operation[MLXBF_I2C_SMBUS_MAX_OP_CNT]; }; struct mlxbf_i2c_resource { void __iomem *io; struct resource *params; struct mutex *lock; /* Mutex to protect mlxbf_i2c_resource. */ u8 type; }; struct mlxbf_i2c_chip_info { enum mlxbf_i2c_chip_type type; /* Chip shared resources that are being used by the I2C controller. */ struct mlxbf_i2c_resource *shared_res[MLXBF_I2C_SHARED_RES_MAX]; /* Callback to calculate the core PLL frequency. */ u64 (*calculate_freq)(struct mlxbf_i2c_resource *corepll_res); /* Registers' address offset */ u32 smbus_master_rs_bytes_off; u32 smbus_master_fsm_off; }; struct mlxbf_i2c_priv { const struct mlxbf_i2c_chip_info *chip; struct i2c_adapter adap; struct mlxbf_i2c_resource *smbus; struct mlxbf_i2c_resource *timer; struct mlxbf_i2c_resource *mst; struct mlxbf_i2c_resource *slv; struct mlxbf_i2c_resource *mst_cause; struct mlxbf_i2c_resource *slv_cause; struct mlxbf_i2c_resource *coalesce; u64 frequency; /* Core frequency in Hz. */ int bus; /* Physical bus identifier. */ int irq; struct i2c_client *slave[MLXBF_I2C_SMBUS_SLAVE_ADDR_CNT]; u32 resource_version; }; /* Core PLL frequency. */ static u64 mlxbf_i2c_corepll_frequency; static struct resource mlxbf_i2c_coalesce_tyu_params = MLXBF_I2C_RES_PARAMS(MLXBF_I2C_COALESCE_TYU_ADDR, MLXBF_I2C_COALESCE_TYU_SIZE, "COALESCE_MEM"); static struct resource mlxbf_i2c_corepll_tyu_params = MLXBF_I2C_RES_PARAMS(MLXBF_I2C_COREPLL_TYU_ADDR, MLXBF_I2C_COREPLL_TYU_SIZE, "COREPLL_MEM"); static struct resource mlxbf_i2c_corepll_yu_params = MLXBF_I2C_RES_PARAMS(MLXBF_I2C_COREPLL_YU_ADDR, MLXBF_I2C_COREPLL_YU_SIZE, "COREPLL_MEM"); static struct resource mlxbf_i2c_corepll_rsh_yu_params = MLXBF_I2C_RES_PARAMS(MLXBF_I2C_COREPLL_RSH_YU_ADDR, MLXBF_I2C_COREPLL_RSH_YU_SIZE, "COREPLL_MEM"); static struct resource mlxbf_i2c_gpio_tyu_params = MLXBF_I2C_RES_PARAMS(MLXBF_I2C_GPIO_TYU_ADDR, MLXBF_I2C_GPIO_TYU_SIZE, "GPIO_MEM"); static struct mutex mlxbf_i2c_coalesce_lock; static struct mutex mlxbf_i2c_corepll_lock; static struct mutex mlxbf_i2c_gpio_lock; static struct mlxbf_i2c_resource mlxbf_i2c_coalesce_res[] = { [MLXBF_I2C_CHIP_TYPE_1] = { .params = &mlxbf_i2c_coalesce_tyu_params, .lock = &mlxbf_i2c_coalesce_lock, .type = MLXBF_I2C_COALESCE_RES }, {} }; static struct mlxbf_i2c_resource mlxbf_i2c_corepll_res[] = { [MLXBF_I2C_CHIP_TYPE_1] = { .params = &mlxbf_i2c_corepll_tyu_params, .lock = &mlxbf_i2c_corepll_lock, .type = MLXBF_I2C_COREPLL_RES }, [MLXBF_I2C_CHIP_TYPE_2] = { .params = &mlxbf_i2c_corepll_yu_params, .lock = &mlxbf_i2c_corepll_lock, .type = MLXBF_I2C_COREPLL_RES, }, [MLXBF_I2C_CHIP_TYPE_3] = { .params = &mlxbf_i2c_corepll_rsh_yu_params, .lock = &mlxbf_i2c_corepll_lock, .type = MLXBF_I2C_COREPLL_RES, } }; static struct mlxbf_i2c_resource mlxbf_i2c_gpio_res[] = { [MLXBF_I2C_CHIP_TYPE_1] = { .params = &mlxbf_i2c_gpio_tyu_params, .lock = &mlxbf_i2c_gpio_lock, .type = MLXBF_I2C_GPIO_RES }, {} }; static u8 mlxbf_i2c_bus_count; static struct mutex mlxbf_i2c_bus_lock; /* * Function to poll a set of bits at a specific address; it checks whether * the bits are equal to zero when eq_zero is set to 'true', and not equal * to zero when eq_zero is set to 'false'. * Note that the timeout is given in microseconds. */ static u32 mlxbf_i2c_poll(void __iomem *io, u32 addr, u32 mask, bool eq_zero, u32 timeout) { u32 bits; timeout = (timeout / MLXBF_I2C_POLL_FREQ_IN_USEC) + 1; do { bits = readl(io + addr) & mask; if (eq_zero ? bits == 0 : bits != 0) return eq_zero ? 1 : bits; udelay(MLXBF_I2C_POLL_FREQ_IN_USEC); } while (timeout-- != 0); return 0; } /* * SW must make sure that the SMBus Master GW is idle before starting * a transaction. Accordingly, this function polls the Master FSM stop * bit; it returns false when the bit is asserted, true if not. */ static bool mlxbf_i2c_smbus_master_wait_for_idle(struct mlxbf_i2c_priv *priv) { u32 mask = MLXBF_I2C_SMBUS_MASTER_FSM_STOP_MASK; u32 addr = priv->chip->smbus_master_fsm_off; u32 timeout = MLXBF_I2C_SMBUS_TIMEOUT; if (mlxbf_i2c_poll(priv->mst->io, addr, mask, true, timeout)) return true; return false; } /* * wait for the lock to be released before acquiring it. */ static bool mlxbf_i2c_smbus_master_lock(struct mlxbf_i2c_priv *priv) { if (mlxbf_i2c_poll(priv->mst->io, MLXBF_I2C_SMBUS_MASTER_GW, MLXBF_I2C_MASTER_LOCK_BIT, true, MLXBF_I2C_SMBUS_LOCK_POLL_TIMEOUT)) return true; return false; } static void mlxbf_i2c_smbus_master_unlock(struct mlxbf_i2c_priv *priv) { /* Clear the gw to clear the lock */ writel(0, priv->mst->io + MLXBF_I2C_SMBUS_MASTER_GW); } static bool mlxbf_i2c_smbus_transaction_success(u32 master_status, u32 cause_status) { /* * When transaction ended with STOP, all bytes were transmitted, * and no NACK received, then the transaction ended successfully. * On the other hand, when the GW is configured with the stop bit * de-asserted then the SMBus expects the following GW configuration * for transfer continuation. */ if ((cause_status & MLXBF_I2C_CAUSE_WAIT_FOR_FW_DATA) || ((cause_status & MLXBF_I2C_CAUSE_TRANSACTION_ENDED) && (master_status & MLXBF_I2C_SMBUS_STATUS_BYTE_CNT_DONE) && !(master_status & MLXBF_I2C_SMBUS_STATUS_NACK_RCV))) return true; return false; } /* * Poll SMBus master status and return transaction status, * i.e. whether succeeded or failed. I2C and SMBus fault codes * are returned as negative numbers from most calls, with zero * or some positive number indicating a non-fault return. */ static int mlxbf_i2c_smbus_check_status(struct mlxbf_i2c_priv *priv) { u32 master_status_bits; u32 cause_status_bits; /* * GW busy bit is raised by the driver and cleared by the HW * when the transaction is completed. The busy bit is a good * indicator of transaction status. So poll the busy bit, and * then read the cause and master status bits to determine if * errors occurred during the transaction. */ mlxbf_i2c_poll(priv->mst->io, MLXBF_I2C_SMBUS_MASTER_GW, MLXBF_I2C_MASTER_BUSY_BIT, true, MLXBF_I2C_SMBUS_TIMEOUT); /* Read cause status bits. */ cause_status_bits = readl(priv->mst_cause->io + MLXBF_I2C_CAUSE_ARBITER); cause_status_bits &= MLXBF_I2C_CAUSE_MASTER_ARBITER_BITS_MASK; /* * Parse both Cause and Master GW bits, then return transaction status. */ master_status_bits = readl(priv->mst->io + MLXBF_I2C_SMBUS_MASTER_STATUS); master_status_bits &= MLXBF_I2C_SMBUS_MASTER_STATUS_MASK; if (mlxbf_i2c_smbus_transaction_success(master_status_bits, cause_status_bits)) return 0; /* * In case of timeout on GW busy, the ISR will clear busy bit but * transaction ended bits cause will not be set so the transaction * fails. Then, we must check Master GW status bits. */ if ((master_status_bits & MLXBF_I2C_SMBUS_MASTER_STATUS_ERROR) && (cause_status_bits & (MLXBF_I2C_CAUSE_TRANSACTION_ENDED | MLXBF_I2C_CAUSE_M_GW_BUSY_FALL))) return -EIO; if (cause_status_bits & MLXBF_I2C_CAUSE_MASTER_STATUS_ERROR) return -EAGAIN; return -ETIMEDOUT; } static void mlxbf_i2c_smbus_write_data(struct mlxbf_i2c_priv *priv, const u8 *data, u8 length, u32 addr, bool is_master) { u8 offset, aligned_length; u32 data32; aligned_length = round_up(length, 4); /* * Copy data bytes from 4-byte aligned source buffer. * Data copied to the Master GW Data Descriptor MUST be shifted * left so the data starts at the MSB of the descriptor registers * as required by the underlying hardware. Enable byte swapping * when writing data bytes to the 32 * 32-bit HW Data registers * a.k.a Master GW Data Descriptor. */ for (offset = 0; offset < aligned_length; offset += sizeof(u32)) { data32 = *((u32 *)(data + offset)); if (is_master) iowrite32be(data32, priv->mst->io + addr + offset); else iowrite32be(data32, priv->slv->io + addr + offset); } } static void mlxbf_i2c_smbus_read_data(struct mlxbf_i2c_priv *priv, u8 *data, u8 length, u32 addr, bool is_master) { u32 data32, mask; u8 byte, offset; mask = sizeof(u32) - 1; /* * Data bytes in the Master GW Data Descriptor are shifted left * so the data starts at the MSB of the descriptor registers as * set by the underlying hardware. Enable byte swapping while * reading data bytes from the 32 * 32-bit HW Data registers * a.k.a Master GW Data Descriptor. */ for (offset = 0; offset < (length & ~mask); offset += sizeof(u32)) { if (is_master) data32 = ioread32be(priv->mst->io + addr + offset); else data32 = ioread32be(priv->slv->io + addr + offset); *((u32 *)(data + offset)) = data32; } if (!(length & mask)) return; if (is_master) data32 = ioread32be(priv->mst->io + addr + offset); else data32 = ioread32be(priv->slv->io + addr + offset); for (byte = 0; byte < (length & mask); byte++) { data[offset + byte] = data32 & GENMASK(7, 0); data32 = ror32(data32, MLXBF_I2C_SHIFT_8); } } static int mlxbf_i2c_smbus_enable(struct mlxbf_i2c_priv *priv, u8 slave, u8 len, u8 block_en, u8 pec_en, bool read) { u32 command; /* Set Master GW control word. */ if (read) { command = MLXBF_I2C_MASTER_ENABLE_READ; command |= rol32(len, MLXBF_I2C_MASTER_READ_SHIFT); } else { command = MLXBF_I2C_MASTER_ENABLE_WRITE; command |= rol32(len, MLXBF_I2C_MASTER_WRITE_SHIFT); } command |= rol32(slave, MLXBF_I2C_MASTER_SLV_ADDR_SHIFT); command |= rol32(block_en, MLXBF_I2C_MASTER_PARSE_EXP_SHIFT); command |= rol32(pec_en, MLXBF_I2C_MASTER_SEND_PEC_SHIFT); /* Clear status bits. */ writel(0x0, priv->mst->io + MLXBF_I2C_SMBUS_MASTER_STATUS); /* Set the cause data. */ writel(~0x0, priv->mst_cause->io + MLXBF_I2C_CAUSE_OR_CLEAR); /* Zero PEC byte. */ writel(0x0, priv->mst->io + MLXBF_I2C_SMBUS_MASTER_PEC); /* Zero byte count. */ writel(0x0, priv->mst->io + priv->chip->smbus_master_rs_bytes_off); /* GW activation. */ writel(command, priv->mst->io + MLXBF_I2C_SMBUS_MASTER_GW); /* * Poll master status and check status bits. An ACK is sent when * completing writing data to the bus (Master 'byte_count_done' bit * is set to 1). */ return mlxbf_i2c_smbus_check_status(priv); } static int mlxbf_i2c_smbus_start_transaction(struct mlxbf_i2c_priv *priv, struct mlxbf_i2c_smbus_request *request) { u8 data_desc[MLXBF_I2C_MASTER_DATA_DESC_SIZE] = { 0 }; u8 op_idx, data_idx, data_len, write_len, read_len; struct mlxbf_i2c_smbus_operation *operation; u8 read_en, write_en, block_en, pec_en; u8 slave, flags, addr; u8 *read_buf; int ret = 0; if (request->operation_cnt > MLXBF_I2C_SMBUS_MAX_OP_CNT) return -EINVAL; read_buf = NULL; data_idx = 0; read_en = 0; write_en = 0; write_len = 0; read_len = 0; block_en = 0; pec_en = 0; slave = request->slave & GENMASK(6, 0); addr = slave << 1; /* * Try to acquire the smbus gw lock before any reads of the GW register since * a read sets the lock. */ if (WARN_ON(!mlxbf_i2c_smbus_master_lock(priv))) return -EBUSY; /* Check whether the HW is idle */ if (WARN_ON(!mlxbf_i2c_smbus_master_wait_for_idle(priv))) { ret = -EBUSY; goto out_unlock; } /* Set first byte. */ data_desc[data_idx++] = addr; for (op_idx = 0; op_idx < request->operation_cnt; op_idx++) { operation = &request->operation[op_idx]; flags = operation->flags; /* * Note that read and write operations might be handled by a * single command. If the MLXBF_I2C_F_SMBUS_OPERATION is set * then write command byte and set the optional SMBus specific * bits such as block_en and pec_en. These bits MUST be * submitted by the first operation only. */ if (op_idx == 0 && flags & MLXBF_I2C_F_SMBUS_OPERATION) { block_en = flags & MLXBF_I2C_F_SMBUS_BLOCK; pec_en = flags & MLXBF_I2C_F_SMBUS_PEC; } if (flags & MLXBF_I2C_F_WRITE) { write_en = 1; write_len += operation->length; if (data_idx + operation->length > MLXBF_I2C_MASTER_DATA_DESC_SIZE) { ret = -ENOBUFS; goto out_unlock; } memcpy(data_desc + data_idx, operation->buffer, operation->length); data_idx += operation->length; } /* * We assume that read operations are performed only once per * SMBus transaction. *TBD* protect this statement so it won't * be executed twice? or return an error if we try to read more * than once? */ if (flags & MLXBF_I2C_F_READ) { read_en = 1; /* Subtract 1 as required by HW. */ read_len = operation->length - 1; read_buf = operation->buffer; } } /* Set Master GW data descriptor. */ data_len = write_len + 1; /* Add one byte of the slave address. */ /* * Note that data_len cannot be 0. Indeed, the slave address byte * must be written to the data registers. */ mlxbf_i2c_smbus_write_data(priv, (const u8 *)data_desc, data_len, MLXBF_I2C_MASTER_DATA_DESC_ADDR, true); if (write_en) { ret = mlxbf_i2c_smbus_enable(priv, slave, write_len, block_en, pec_en, 0); if (ret) goto out_unlock; } if (read_en) { /* Write slave address to Master GW data descriptor. */ mlxbf_i2c_smbus_write_data(priv, (const u8 *)&addr, 1, MLXBF_I2C_MASTER_DATA_DESC_ADDR, true); ret = mlxbf_i2c_smbus_enable(priv, slave, read_len, block_en, pec_en, 1); if (!ret) { /* Get Master GW data descriptor. */ mlxbf_i2c_smbus_read_data(priv, data_desc, read_len + 1, MLXBF_I2C_MASTER_DATA_DESC_ADDR, true); /* Get data from Master GW data descriptor. */ memcpy(read_buf, data_desc, read_len + 1); } /* * After a read operation the SMBus FSM ps (present state) * needs to be 'manually' reset. This should be removed in * next tag integration. */ writel(MLXBF_I2C_SMBUS_MASTER_FSM_PS_STATE_MASK, priv->mst->io + priv->chip->smbus_master_fsm_off); } out_unlock: mlxbf_i2c_smbus_master_unlock(priv); return ret; } /* I2C SMBus protocols. */ static void mlxbf_i2c_smbus_quick_command(struct mlxbf_i2c_smbus_request *request, u8 read) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_1; request->operation[0].length = 0; request->operation[0].flags = MLXBF_I2C_F_WRITE; request->operation[0].flags |= read ? MLXBF_I2C_F_READ : 0; } static void mlxbf_i2c_smbus_byte_func(struct mlxbf_i2c_smbus_request *request, u8 *data, bool read, bool pec_check) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_1; request->operation[0].length = 1; request->operation[0].length += pec_check; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION; request->operation[0].flags |= read ? MLXBF_I2C_F_READ : MLXBF_I2C_F_WRITE; request->operation[0].flags |= pec_check ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = data; } static void mlxbf_i2c_smbus_data_byte_func(struct mlxbf_i2c_smbus_request *request, u8 *command, u8 *data, bool read, bool pec_check) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_2; request->operation[0].length = 1; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION | MLXBF_I2C_F_WRITE; request->operation[0].flags |= pec_check ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = command; request->operation[1].length = 1; request->operation[1].length += pec_check; request->operation[1].flags = read ? MLXBF_I2C_F_READ : MLXBF_I2C_F_WRITE; request->operation[1].buffer = data; } static void mlxbf_i2c_smbus_data_word_func(struct mlxbf_i2c_smbus_request *request, u8 *command, u8 *data, bool read, bool pec_check) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_2; request->operation[0].length = 1; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION | MLXBF_I2C_F_WRITE; request->operation[0].flags |= pec_check ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = command; request->operation[1].length = 2; request->operation[1].length += pec_check; request->operation[1].flags = read ? MLXBF_I2C_F_READ : MLXBF_I2C_F_WRITE; request->operation[1].buffer = data; } static void mlxbf_i2c_smbus_i2c_block_func(struct mlxbf_i2c_smbus_request *request, u8 *command, u8 *data, u8 *data_len, bool read, bool pec_check) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_2; request->operation[0].length = 1; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION | MLXBF_I2C_F_WRITE; request->operation[0].flags |= pec_check ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = command; /* * As specified in the standard, the max number of bytes to read/write * per block operation is 32 bytes. In Golan code, the controller can * read up to 128 bytes and write up to 127 bytes. */ request->operation[1].length = (*data_len + pec_check > I2C_SMBUS_BLOCK_MAX) ? I2C_SMBUS_BLOCK_MAX : *data_len + pec_check; request->operation[1].flags = read ? MLXBF_I2C_F_READ : MLXBF_I2C_F_WRITE; /* * Skip the first data byte, which corresponds to the number of bytes * to read/write. */ request->operation[1].buffer = data + 1; *data_len = request->operation[1].length; /* Set the number of byte to read. This will be used by userspace. */ if (read) data[0] = *data_len; } static void mlxbf_i2c_smbus_block_func(struct mlxbf_i2c_smbus_request *request, u8 *command, u8 *data, u8 *data_len, bool read, bool pec_check) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_2; request->operation[0].length = 1; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION | MLXBF_I2C_F_WRITE; request->operation[0].flags |= MLXBF_I2C_F_SMBUS_BLOCK; request->operation[0].flags |= pec_check ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = command; request->operation[1].length = (*data_len + pec_check > I2C_SMBUS_BLOCK_MAX) ? I2C_SMBUS_BLOCK_MAX : *data_len + pec_check; request->operation[1].flags = read ? MLXBF_I2C_F_READ : MLXBF_I2C_F_WRITE; request->operation[1].buffer = data + 1; *data_len = request->operation[1].length; /* Set the number of bytes to read. This will be used by userspace. */ if (read) data[0] = *data_len; } static void mlxbf_i2c_smbus_process_call_func(struct mlxbf_i2c_smbus_request *request, u8 *command, u8 *data, bool pec_check) { request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_3; request->operation[0].length = 1; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION | MLXBF_I2C_F_WRITE; request->operation[0].flags |= MLXBF_I2C_F_SMBUS_BLOCK; request->operation[0].flags |= pec_check ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = command; request->operation[1].length = 2; request->operation[1].flags = MLXBF_I2C_F_WRITE; request->operation[1].buffer = data; request->operation[2].length = 3; request->operation[2].flags = MLXBF_I2C_F_READ; request->operation[2].buffer = data; } static void mlxbf_i2c_smbus_blk_process_call_func(struct mlxbf_i2c_smbus_request *request, u8 *command, u8 *data, u8 *data_len, bool pec_check) { u32 length; request->operation_cnt = MLXBF_I2C_SMBUS_OP_CNT_3; request->operation[0].length = 1; request->operation[0].flags = MLXBF_I2C_F_SMBUS_OPERATION | MLXBF_I2C_F_WRITE; request->operation[0].flags |= MLXBF_I2C_F_SMBUS_BLOCK; request->operation[0].flags |= (pec_check) ? MLXBF_I2C_F_SMBUS_PEC : 0; request->operation[0].buffer = command; length = (*data_len + pec_check > I2C_SMBUS_BLOCK_MAX) ? I2C_SMBUS_BLOCK_MAX : *data_len + pec_check; request->operation[1].length = length - pec_check; request->operation[1].flags = MLXBF_I2C_F_WRITE; request->operation[1].buffer = data; request->operation[2].length = length; request->operation[2].flags = MLXBF_I2C_F_READ; request->operation[2].buffer = data; *data_len = length; /* including PEC byte. */ } /* Initialization functions. */ static bool mlxbf_i2c_has_chip_type(struct mlxbf_i2c_priv *priv, u8 type) { return priv->chip->type == type; } static struct mlxbf_i2c_resource * mlxbf_i2c_get_shared_resource(struct mlxbf_i2c_priv *priv, u8 type) { const struct mlxbf_i2c_chip_info *chip = priv->chip; struct mlxbf_i2c_resource *res; u8 res_idx = 0; for (res_idx = 0; res_idx < MLXBF_I2C_SHARED_RES_MAX; res_idx++) { res = chip->shared_res[res_idx]; if (res && res->type == type) return res; } return NULL; } static int mlxbf_i2c_init_resource(struct platform_device *pdev, struct mlxbf_i2c_resource **res, u8 type) { struct mlxbf_i2c_resource *tmp_res; struct device *dev = &pdev->dev; if (!res || *res || type >= MLXBF_I2C_END_RES) return -EINVAL; tmp_res = devm_kzalloc(dev, sizeof(struct mlxbf_i2c_resource), GFP_KERNEL); if (!tmp_res) return -ENOMEM; tmp_res->io = devm_platform_get_and_ioremap_resource(pdev, type, &tmp_res->params); if (IS_ERR(tmp_res->io)) { devm_kfree(dev, tmp_res); return PTR_ERR(tmp_res->io); } tmp_res->type = type; *res = tmp_res; return 0; } static u32 mlxbf_i2c_get_ticks(struct mlxbf_i2c_priv *priv, u64 nanoseconds, bool minimum) { u64 frequency; u32 ticks; /* * Compute ticks as follow: * * Ticks * Time = --------- x 10^9 => Ticks = Time x Frequency x 10^-9 * Frequency */ frequency = priv->frequency; ticks = (nanoseconds * frequency) / MLXBF_I2C_FREQUENCY_1GHZ; /* * The number of ticks is rounded down and if minimum is equal to 1 * then add one tick. */ if (minimum) ticks++; return ticks; } static u32 mlxbf_i2c_set_timer(struct mlxbf_i2c_priv *priv, u64 nsec, bool opt, u32 mask, u8 shift) { u32 val = (mlxbf_i2c_get_ticks(priv, nsec, opt) & mask) << shift; return val; } static void mlxbf_i2c_set_timings(struct mlxbf_i2c_priv *priv, const struct mlxbf_i2c_timings *timings) { u32 timer; timer = mlxbf_i2c_set_timer(priv, timings->scl_high, false, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_0); timer |= mlxbf_i2c_set_timer(priv, timings->scl_low, false, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_16); writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_TIMER_SCL_LOW_SCL_HIGH); timer = mlxbf_i2c_set_timer(priv, timings->sda_rise, false, MLXBF_I2C_MASK_8, MLXBF_I2C_SHIFT_0); timer |= mlxbf_i2c_set_timer(priv, timings->sda_fall, false, MLXBF_I2C_MASK_8, MLXBF_I2C_SHIFT_8); timer |= mlxbf_i2c_set_timer(priv, timings->scl_rise, false, MLXBF_I2C_MASK_8, MLXBF_I2C_SHIFT_16); timer |= mlxbf_i2c_set_timer(priv, timings->scl_fall, false, MLXBF_I2C_MASK_8, MLXBF_I2C_SHIFT_24); writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_TIMER_FALL_RISE_SPIKE); timer = mlxbf_i2c_set_timer(priv, timings->hold_start, true, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_0); timer |= mlxbf_i2c_set_timer(priv, timings->hold_data, true, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_16); writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_TIMER_THOLD); timer = mlxbf_i2c_set_timer(priv, timings->setup_start, true, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_0); timer |= mlxbf_i2c_set_timer(priv, timings->setup_stop, true, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_16); writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_TIMER_TSETUP_START_STOP); timer = mlxbf_i2c_set_timer(priv, timings->setup_data, true, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_0); writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_TIMER_TSETUP_DATA); timer = mlxbf_i2c_set_timer(priv, timings->buf, false, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_0); timer |= mlxbf_i2c_set_timer(priv, timings->thigh_max, false, MLXBF_I2C_MASK_16, MLXBF_I2C_SHIFT_16); writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_THIGH_MAX_TBUF); timer = timings->timeout; writel(timer, priv->timer->io + MLXBF_I2C_SMBUS_SCL_LOW_TIMEOUT); } enum mlxbf_i2c_timings_config { MLXBF_I2C_TIMING_CONFIG_100KHZ, MLXBF_I2C_TIMING_CONFIG_400KHZ, MLXBF_I2C_TIMING_CONFIG_1000KHZ, }; /* * Note that the mlxbf_i2c_timings->timeout value is not related to the * bus frequency, it is impacted by the time it takes the driver to * complete data transmission before transaction abort. */ static const struct mlxbf_i2c_timings mlxbf_i2c_timings[] = { [MLXBF_I2C_TIMING_CONFIG_100KHZ] = { .scl_high = 4810, .scl_low = 5000, .hold_start = 4000, .setup_start = 4800, .setup_stop = 4000, .setup_data = 250, .sda_rise = 50, .sda_fall = 50, .scl_rise = 50, .scl_fall = 50, .hold_data = 300, .buf = 20000, .thigh_max = 5000, .timeout = 106500 }, [MLXBF_I2C_TIMING_CONFIG_400KHZ] = { .scl_high = 1011, .scl_low = 1300, .hold_start = 600, .setup_start = 700, .setup_stop = 600, .setup_data = 100, .sda_rise = 50, .sda_fall = 50, .scl_rise = 50, .scl_fall = 50, .hold_data = 300, .buf = 20000, .thigh_max = 5000, .timeout = 106500 }, [MLXBF_I2C_TIMING_CONFIG_1000KHZ] = { .scl_high = 600, .scl_low = 1300, .hold_start = 600, .setup_start = 600, .setup_stop = 600, .setup_data = 100, .sda_rise = 50, .sda_fall = 50, .scl_rise = 50, .scl_fall = 50, .hold_data = 300, .buf = 20000, .thigh_max = 5000, .timeout = 106500 } }; static int mlxbf_i2c_init_timings(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { enum mlxbf_i2c_timings_config config_idx; struct device *dev = &pdev->dev; u32 config_khz; int ret; ret = device_property_read_u32(dev, "clock-frequency", &config_khz); if (ret < 0) config_khz = I2C_MAX_STANDARD_MODE_FREQ; switch (config_khz) { default: /* Default settings is 100 KHz. */ pr_warn("Illegal value %d: defaulting to 100 KHz\n", config_khz); fallthrough; case I2C_MAX_STANDARD_MODE_FREQ: config_idx = MLXBF_I2C_TIMING_CONFIG_100KHZ; break; case I2C_MAX_FAST_MODE_FREQ: config_idx = MLXBF_I2C_TIMING_CONFIG_400KHZ; break; case I2C_MAX_FAST_MODE_PLUS_FREQ: config_idx = MLXBF_I2C_TIMING_CONFIG_1000KHZ; break; } mlxbf_i2c_set_timings(priv, &mlxbf_i2c_timings[config_idx]); return 0; } static int mlxbf_i2c_get_gpio(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *gpio_res; struct device *dev = &pdev->dev; struct resource *params; resource_size_t size; gpio_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_GPIO_RES); if (!gpio_res) return -EPERM; /* * The GPIO region in TYU space is shared among I2C busses. * This function MUST be serialized to avoid racing when * claiming the memory region and/or setting up the GPIO. */ lockdep_assert_held(gpio_res->lock); /* Check whether the memory map exist. */ if (gpio_res->io) return 0; params = gpio_res->params; size = resource_size(params); if (!devm_request_mem_region(dev, params->start, size, params->name)) return -EFAULT; gpio_res->io = devm_ioremap(dev, params->start, size); if (!gpio_res->io) { devm_release_mem_region(dev, params->start, size); return -ENOMEM; } return 0; } static int mlxbf_i2c_release_gpio(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *gpio_res; struct device *dev = &pdev->dev; struct resource *params; gpio_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_GPIO_RES); if (!gpio_res) return 0; mutex_lock(gpio_res->lock); if (gpio_res->io) { /* Release the GPIO resource. */ params = gpio_res->params; devm_iounmap(dev, gpio_res->io); devm_release_mem_region(dev, params->start, resource_size(params)); } mutex_unlock(gpio_res->lock); return 0; } static int mlxbf_i2c_get_corepll(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *corepll_res; struct device *dev = &pdev->dev; struct resource *params; resource_size_t size; corepll_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_COREPLL_RES); if (!corepll_res) return -EPERM; /* * The COREPLL region in TYU space is shared among I2C busses. * This function MUST be serialized to avoid racing when * claiming the memory region. */ lockdep_assert_held(corepll_res->lock); /* Check whether the memory map exist. */ if (corepll_res->io) return 0; params = corepll_res->params; size = resource_size(params); if (!devm_request_mem_region(dev, params->start, size, params->name)) return -EFAULT; corepll_res->io = devm_ioremap(dev, params->start, size); if (!corepll_res->io) { devm_release_mem_region(dev, params->start, size); return -ENOMEM; } return 0; } static int mlxbf_i2c_release_corepll(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *corepll_res; struct device *dev = &pdev->dev; struct resource *params; corepll_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_COREPLL_RES); mutex_lock(corepll_res->lock); if (corepll_res->io) { /* Release the CorePLL resource. */ params = corepll_res->params; devm_iounmap(dev, corepll_res->io); devm_release_mem_region(dev, params->start, resource_size(params)); } mutex_unlock(corepll_res->lock); return 0; } static int mlxbf_i2c_init_master(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *gpio_res; struct device *dev = &pdev->dev; u32 config_reg; int ret; /* This configuration is only needed for BlueField 1. */ if (!mlxbf_i2c_has_chip_type(priv, MLXBF_I2C_CHIP_TYPE_1)) return 0; gpio_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_GPIO_RES); if (!gpio_res) return -EPERM; /* * The GPIO region in TYU space is shared among I2C busses. * This function MUST be serialized to avoid racing when * claiming the memory region and/or setting up the GPIO. */ mutex_lock(gpio_res->lock); ret = mlxbf_i2c_get_gpio(pdev, priv); if (ret < 0) { dev_err(dev, "Failed to get gpio resource"); mutex_unlock(gpio_res->lock); return ret; } /* * TYU - Configuration for GPIO pins. Those pins must be asserted in * MLXBF_I2C_GPIO_0_FUNC_EN_0, i.e. GPIO 0 is controlled by HW, and must * be reset in MLXBF_I2C_GPIO_0_FORCE_OE_EN, i.e. GPIO_OE will be driven * instead of HW_OE. * For now, we do not reset the GPIO state when the driver is removed. * First, it is not necessary to disable the bus since we are using * the same busses. Then, some busses might be shared among Linux and * platform firmware; disabling the bus might compromise the system * functionality. */ config_reg = readl(gpio_res->io + MLXBF_I2C_GPIO_0_FUNC_EN_0); config_reg = MLXBF_I2C_GPIO_SMBUS_GW_ASSERT_PINS(priv->bus, config_reg); writel(config_reg, gpio_res->io + MLXBF_I2C_GPIO_0_FUNC_EN_0); config_reg = readl(gpio_res->io + MLXBF_I2C_GPIO_0_FORCE_OE_EN); config_reg = MLXBF_I2C_GPIO_SMBUS_GW_RESET_PINS(priv->bus, config_reg); writel(config_reg, gpio_res->io + MLXBF_I2C_GPIO_0_FORCE_OE_EN); mutex_unlock(gpio_res->lock); return 0; } static u64 mlxbf_i2c_calculate_freq_from_tyu(struct mlxbf_i2c_resource *corepll_res) { u64 core_frequency; u8 core_od, core_r; u32 corepll_val; u16 core_f; corepll_val = readl(corepll_res->io + MLXBF_I2C_CORE_PLL_REG1); /* Get Core PLL configuration bits. */ core_f = FIELD_GET(MLXBF_I2C_COREPLL_CORE_F_TYU_MASK, corepll_val); core_od = FIELD_GET(MLXBF_I2C_COREPLL_CORE_OD_TYU_MASK, corepll_val); core_r = FIELD_GET(MLXBF_I2C_COREPLL_CORE_R_TYU_MASK, corepll_val); /* * Compute PLL output frequency as follow: * * CORE_F + 1 * PLL_OUT_FREQ = PLL_IN_FREQ * ---------------------------- * (CORE_R + 1) * (CORE_OD + 1) * * Where PLL_OUT_FREQ and PLL_IN_FREQ refer to CoreFrequency * and PadFrequency, respectively. */ core_frequency = MLXBF_I2C_PLL_IN_FREQ * (++core_f); core_frequency /= (++core_r) * (++core_od); return core_frequency; } static u64 mlxbf_i2c_calculate_freq_from_yu(struct mlxbf_i2c_resource *corepll_res) { u32 corepll_reg1_val, corepll_reg2_val; u64 corepll_frequency; u8 core_od, core_r; u32 core_f; corepll_reg1_val = readl(corepll_res->io + MLXBF_I2C_CORE_PLL_REG1); corepll_reg2_val = readl(corepll_res->io + MLXBF_I2C_CORE_PLL_REG2); /* Get Core PLL configuration bits */ core_f = FIELD_GET(MLXBF_I2C_COREPLL_CORE_F_YU_MASK, corepll_reg1_val); core_r = FIELD_GET(MLXBF_I2C_COREPLL_CORE_R_YU_MASK, corepll_reg1_val); core_od = FIELD_GET(MLXBF_I2C_COREPLL_CORE_OD_YU_MASK, corepll_reg2_val); /* * Compute PLL output frequency as follow: * * CORE_F / 16384 * PLL_OUT_FREQ = PLL_IN_FREQ * ---------------------------- * (CORE_R + 1) * (CORE_OD + 1) * * Where PLL_OUT_FREQ and PLL_IN_FREQ refer to CoreFrequency * and PadFrequency, respectively. */ corepll_frequency = (MLXBF_I2C_PLL_IN_FREQ * core_f) / MLNXBF_I2C_COREPLL_CONST; corepll_frequency /= (++core_r) * (++core_od); return corepll_frequency; } static int mlxbf_i2c_calculate_corepll_freq(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { const struct mlxbf_i2c_chip_info *chip = priv->chip; struct mlxbf_i2c_resource *corepll_res; struct device *dev = &pdev->dev; u64 *freq = &priv->frequency; int ret; corepll_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_COREPLL_RES); if (!corepll_res) return -EPERM; /* * First, check whether the TYU core Clock frequency is set. * The TYU core frequency is the same for all I2C busses; when * the first device gets probed the frequency is determined and * stored into a globally visible variable. So, first of all, * check whether the frequency is already set. Here, we assume * that the frequency is expected to be greater than 0. */ mutex_lock(corepll_res->lock); if (!mlxbf_i2c_corepll_frequency) { if (!chip->calculate_freq) { mutex_unlock(corepll_res->lock); return -EPERM; } ret = mlxbf_i2c_get_corepll(pdev, priv); if (ret < 0) { dev_err(dev, "Failed to get corePLL resource"); mutex_unlock(corepll_res->lock); return ret; } mlxbf_i2c_corepll_frequency = chip->calculate_freq(corepll_res); } mutex_unlock(corepll_res->lock); *freq = mlxbf_i2c_corepll_frequency; return 0; } static int mlxbf_i2c_slave_enable(struct mlxbf_i2c_priv *priv, struct i2c_client *slave) { u8 reg, reg_cnt, byte, addr_tmp; u32 slave_reg, slave_reg_tmp; if (!priv) return -EPERM; reg_cnt = MLXBF_I2C_SMBUS_SLAVE_ADDR_CNT >> 2; /* * Read the slave registers. There are 4 * 32-bit slave registers. * Each slave register can hold up to 4 * 8-bit slave configuration: * 1) A 7-bit address * 2) And a status bit (1 if enabled, 0 if not). * Look for the next available slave register slot. */ for (reg = 0; reg < reg_cnt; reg++) { slave_reg = readl(priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_ADDR_CFG + reg * 0x4); /* * Each register holds 4 slave addresses. So, we have to keep * the byte order consistent with the value read in order to * update the register correctly, if needed. */ slave_reg_tmp = slave_reg; for (byte = 0; byte < 4; byte++) { addr_tmp = slave_reg_tmp & GENMASK(7, 0); /* * If an enable bit is not set in the * MLXBF_I2C_SMBUS_SLAVE_ADDR_CFG register, then the * slave address slot associated with that bit is * free. So set the enable bit and write the * slave address bits. */ if (!(addr_tmp & MLXBF_I2C_SMBUS_SLAVE_ADDR_EN_BIT)) { slave_reg &= ~(MLXBF_I2C_SMBUS_SLAVE_ADDR_MASK << (byte * 8)); slave_reg |= (slave->addr << (byte * 8)); slave_reg |= MLXBF_I2C_SMBUS_SLAVE_ADDR_EN_BIT << (byte * 8); writel(slave_reg, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_ADDR_CFG + (reg * 0x4)); /* * Set the slave at the corresponding index. */ priv->slave[(reg * 4) + byte] = slave; return 0; } /* Parse next byte. */ slave_reg_tmp >>= 8; } } return -EBUSY; } static int mlxbf_i2c_slave_disable(struct mlxbf_i2c_priv *priv, u8 addr) { u8 addr_tmp, reg, reg_cnt, byte; u32 slave_reg, slave_reg_tmp; reg_cnt = MLXBF_I2C_SMBUS_SLAVE_ADDR_CNT >> 2; /* * Read the slave registers. There are 4 * 32-bit slave registers. * Each slave register can hold up to 4 * 8-bit slave configuration: * 1) A 7-bit address * 2) And a status bit (1 if enabled, 0 if not). * Check if addr is present in the registers. */ for (reg = 0; reg < reg_cnt; reg++) { slave_reg = readl(priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_ADDR_CFG + reg * 0x4); /* Check whether the address slots are empty. */ if (!slave_reg) continue; /* * Check if addr matches any of the 4 slave addresses * in the register. */ slave_reg_tmp = slave_reg; for (byte = 0; byte < 4; byte++) { addr_tmp = slave_reg_tmp & MLXBF_I2C_SMBUS_SLAVE_ADDR_MASK; /* * Parse slave address bytes and check whether the * slave address already exists. */ if (addr_tmp == addr) { /* Clear the slave address slot. */ slave_reg &= ~(GENMASK(7, 0) << (byte * 8)); writel(slave_reg, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_ADDR_CFG + (reg * 0x4)); /* Free slave at the corresponding index */ priv->slave[(reg * 4) + byte] = NULL; return 0; } /* Parse next byte. */ slave_reg_tmp >>= 8; } } return -ENXIO; } static int mlxbf_i2c_init_coalesce(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *coalesce_res; struct resource *params; resource_size_t size; int ret = 0; /* * Unlike BlueField-1 platform, the coalesce registers is a dedicated * resource in the next generations of BlueField. */ if (mlxbf_i2c_has_chip_type(priv, MLXBF_I2C_CHIP_TYPE_1)) { coalesce_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_COALESCE_RES); if (!coalesce_res) return -EPERM; /* * The Cause Coalesce group in TYU space is shared among * I2C busses. This function MUST be serialized to avoid * racing when claiming the memory region. */ lockdep_assert_held(mlxbf_i2c_gpio_res->lock); /* Check whether the memory map exist. */ if (coalesce_res->io) { priv->coalesce = coalesce_res; return 0; } params = coalesce_res->params; size = resource_size(params); if (!request_mem_region(params->start, size, params->name)) return -EFAULT; coalesce_res->io = ioremap(params->start, size); if (!coalesce_res->io) { release_mem_region(params->start, size); return -ENOMEM; } priv->coalesce = coalesce_res; } else { ret = mlxbf_i2c_init_resource(pdev, &priv->coalesce, MLXBF_I2C_COALESCE_RES); } return ret; } static int mlxbf_i2c_release_coalesce(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct mlxbf_i2c_resource *coalesce_res; struct device *dev = &pdev->dev; struct resource *params; resource_size_t size; coalesce_res = priv->coalesce; if (coalesce_res->io) { params = coalesce_res->params; size = resource_size(params); if (mlxbf_i2c_has_chip_type(priv, MLXBF_I2C_CHIP_TYPE_1)) { mutex_lock(coalesce_res->lock); iounmap(coalesce_res->io); release_mem_region(params->start, size); mutex_unlock(coalesce_res->lock); } else { devm_release_mem_region(dev, params->start, size); } } return 0; } static int mlxbf_i2c_init_slave(struct platform_device *pdev, struct mlxbf_i2c_priv *priv) { struct device *dev = &pdev->dev; u32 int_reg; int ret; /* Reset FSM. */ writel(0, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_FSM); /* * Enable slave cause interrupt bits. Drive * MLXBF_I2C_CAUSE_READ_WAIT_FW_RESPONSE and * MLXBF_I2C_CAUSE_WRITE_SUCCESS, these are enabled when an external * masters issue a Read and Write, respectively. But, clear all * interrupts first. */ writel(~0, priv->slv_cause->io + MLXBF_I2C_CAUSE_OR_CLEAR); int_reg = MLXBF_I2C_CAUSE_READ_WAIT_FW_RESPONSE; int_reg |= MLXBF_I2C_CAUSE_WRITE_SUCCESS; writel(int_reg, priv->slv_cause->io + MLXBF_I2C_CAUSE_OR_EVTEN0); /* Finally, set the 'ready' bit to start handling transactions. */ writel(0x1, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_READY); /* Initialize the cause coalesce resource. */ ret = mlxbf_i2c_init_coalesce(pdev, priv); if (ret < 0) { dev_err(dev, "failed to initialize cause coalesce\n"); return ret; } return 0; } static bool mlxbf_i2c_has_coalesce(struct mlxbf_i2c_priv *priv, bool *read, bool *write) { const struct mlxbf_i2c_chip_info *chip = priv->chip; u32 coalesce0_reg, cause_reg; u8 slave_shift, is_set; *write = false; *read = false; slave_shift = chip->type != MLXBF_I2C_CHIP_TYPE_1 ? MLXBF_I2C_CAUSE_YU_SLAVE_BIT : priv->bus + MLXBF_I2C_CAUSE_TYU_SLAVE_BIT; coalesce0_reg = readl(priv->coalesce->io + MLXBF_I2C_CAUSE_COALESCE_0); is_set = coalesce0_reg & (1 << slave_shift); if (!is_set) return false; /* Check the source of the interrupt, i.e. whether a Read or Write. */ cause_reg = readl(priv->slv_cause->io + MLXBF_I2C_CAUSE_ARBITER); if (cause_reg & MLXBF_I2C_CAUSE_READ_WAIT_FW_RESPONSE) *read = true; else if (cause_reg & MLXBF_I2C_CAUSE_WRITE_SUCCESS) *write = true; /* Clear cause bits. */ writel(~0x0, priv->slv_cause->io + MLXBF_I2C_CAUSE_OR_CLEAR); return true; } static bool mlxbf_i2c_slave_wait_for_idle(struct mlxbf_i2c_priv *priv, u32 timeout) { u32 mask = MLXBF_I2C_CAUSE_S_GW_BUSY_FALL; u32 addr = MLXBF_I2C_CAUSE_ARBITER; if (mlxbf_i2c_poll(priv->slv_cause->io, addr, mask, false, timeout)) return true; return false; } static struct i2c_client *mlxbf_i2c_get_slave_from_addr( struct mlxbf_i2c_priv *priv, u8 addr) { int i; for (i = 0; i < MLXBF_I2C_SMBUS_SLAVE_ADDR_CNT; i++) { if (!priv->slave[i]) continue; if (priv->slave[i]->addr == addr) return priv->slave[i]; } return NULL; } /* * Send byte to 'external' smbus master. This function is executed when * an external smbus master wants to read data from the BlueField. */ static int mlxbf_i2c_irq_send(struct mlxbf_i2c_priv *priv, u8 recv_bytes) { u8 data_desc[MLXBF_I2C_SLAVE_DATA_DESC_SIZE] = { 0 }; u8 write_size, pec_en, addr, value, byte_cnt; struct i2c_client *slave; u32 control32, data32; int ret = 0; /* * Read the first byte received from the external master to * determine the slave address. This byte is located in the * first data descriptor register of the slave GW. */ data32 = ioread32be(priv->slv->io + MLXBF_I2C_SLAVE_DATA_DESC_ADDR); addr = (data32 & GENMASK(7, 0)) >> 1; /* * Check if the slave address received in the data descriptor register * matches any of the slave addresses registered. If there is a match, * set the slave. */ slave = mlxbf_i2c_get_slave_from_addr(priv, addr); if (!slave) { ret = -ENXIO; goto clear_csr; } /* * An I2C read can consist of a WRITE bit transaction followed by * a READ bit transaction. Indeed, slave devices often expect * the slave address to be followed by the internal address. * So, write the internal address byte first, and then, send the * requested data to the master. */ if (recv_bytes > 1) { i2c_slave_event(slave, I2C_SLAVE_WRITE_REQUESTED, &value); value = (data32 >> 8) & GENMASK(7, 0); ret = i2c_slave_event(slave, I2C_SLAVE_WRITE_RECEIVED, &value); i2c_slave_event(slave, I2C_SLAVE_STOP, &value); if (ret < 0) goto clear_csr; } /* * Send data to the master. Currently, the driver supports * READ_BYTE, READ_WORD and BLOCK READ protocols. The * hardware can send up to 128 bytes per transfer which is * the total size of the data registers. */ i2c_slave_event(slave, I2C_SLAVE_READ_REQUESTED, &value); for (byte_cnt = 0; byte_cnt < MLXBF_I2C_SLAVE_DATA_DESC_SIZE; byte_cnt++) { data_desc[byte_cnt] = value; i2c_slave_event(slave, I2C_SLAVE_READ_PROCESSED, &value); } /* Send a stop condition to the backend. */ i2c_slave_event(slave, I2C_SLAVE_STOP, &value); /* Set the number of bytes to write to master. */ write_size = (byte_cnt - 1) & 0x7f; /* Write data to Slave GW data descriptor. */ mlxbf_i2c_smbus_write_data(priv, data_desc, byte_cnt, MLXBF_I2C_SLAVE_DATA_DESC_ADDR, false); pec_en = 0; /* Disable PEC since it is not supported. */ /* Prepare control word. */ control32 = MLXBF_I2C_SLAVE_ENABLE; control32 |= rol32(write_size, MLXBF_I2C_SLAVE_WRITE_BYTES_SHIFT); control32 |= rol32(pec_en, MLXBF_I2C_SLAVE_SEND_PEC_SHIFT); writel(control32, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_GW); /* * Wait until the transfer is completed; the driver will wait * until the GW is idle, a cause will rise on fall of GW busy. */ mlxbf_i2c_slave_wait_for_idle(priv, MLXBF_I2C_SMBUS_TIMEOUT); clear_csr: /* Release the Slave GW. */ writel(0x0, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_RS_MASTER_BYTES); writel(0x0, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_PEC); writel(0x1, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_READY); return ret; } /* * Receive bytes from 'external' smbus master. This function is executed when * an external smbus master wants to write data to the BlueField. */ static int mlxbf_i2c_irq_recv(struct mlxbf_i2c_priv *priv, u8 recv_bytes) { u8 data_desc[MLXBF_I2C_SLAVE_DATA_DESC_SIZE] = { 0 }; struct i2c_client *slave; u8 value, byte, addr; int ret = 0; /* Read data from Slave GW data descriptor. */ mlxbf_i2c_smbus_read_data(priv, data_desc, recv_bytes, MLXBF_I2C_SLAVE_DATA_DESC_ADDR, false); addr = data_desc[0] >> 1; /* * Check if the slave address received in the data descriptor register * matches any of the slave addresses registered. */ slave = mlxbf_i2c_get_slave_from_addr(priv, addr); if (!slave) { ret = -EINVAL; goto clear_csr; } /* * Notify the slave backend that an smbus master wants to write data * to the BlueField. */ i2c_slave_event(slave, I2C_SLAVE_WRITE_REQUESTED, &value); /* Send the received data to the slave backend. */ for (byte = 1; byte < recv_bytes; byte++) { value = data_desc[byte]; ret = i2c_slave_event(slave, I2C_SLAVE_WRITE_RECEIVED, &value); if (ret < 0) break; } /* * Send a stop event to the slave backend, to signal * the end of the write transactions. */ i2c_slave_event(slave, I2C_SLAVE_STOP, &value); clear_csr: /* Release the Slave GW. */ writel(0x0, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_RS_MASTER_BYTES); writel(0x0, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_PEC); writel(0x1, priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_READY); return ret; } static irqreturn_t mlxbf_i2c_irq(int irq, void *ptr) { struct mlxbf_i2c_priv *priv = ptr; bool read, write, irq_is_set; u32 rw_bytes_reg; u8 recv_bytes; /* * Read TYU interrupt register and determine the source of the * interrupt. Based on the source of the interrupt one of the * following actions are performed: * - Receive data and send response to master. * - Send data and release slave GW. * * Handle read/write transaction only. CRmaster and Iarp requests * are ignored for now. */ irq_is_set = mlxbf_i2c_has_coalesce(priv, &read, &write); if (!irq_is_set || (!read && !write)) { /* Nothing to do here, interrupt was not from this device. */ return IRQ_NONE; } /* * The MLXBF_I2C_SMBUS_SLAVE_RS_MASTER_BYTES includes the number of * bytes from/to master. These are defined by 8-bits each. If the lower * 8 bits are set, then the master expect to read N bytes from the * slave, if the higher 8 bits are sent then the slave expect N bytes * from the master. */ rw_bytes_reg = readl(priv->slv->io + MLXBF_I2C_SMBUS_SLAVE_RS_MASTER_BYTES); recv_bytes = (rw_bytes_reg >> 8) & GENMASK(7, 0); /* * For now, the slave supports 128 bytes transfer. Discard remaining * data bytes if the master wrote more than * MLXBF_I2C_SLAVE_DATA_DESC_SIZE, i.e, the actual size of the slave * data descriptor. * * Note that we will never expect to transfer more than 128 bytes; as * specified in the SMBus standard, block transactions cannot exceed * 32 bytes. */ recv_bytes = recv_bytes > MLXBF_I2C_SLAVE_DATA_DESC_SIZE ? MLXBF_I2C_SLAVE_DATA_DESC_SIZE : recv_bytes; if (read) mlxbf_i2c_irq_send(priv, recv_bytes); else mlxbf_i2c_irq_recv(priv, recv_bytes); return IRQ_HANDLED; } /* Return negative errno on error. */ static s32 mlxbf_i2c_smbus_xfer(struct i2c_adapter *adap, u16 addr, unsigned short flags, char read_write, u8 command, int size, union i2c_smbus_data *data) { struct mlxbf_i2c_smbus_request request = { 0 }; struct mlxbf_i2c_priv *priv; bool read, pec; u8 byte_cnt; request.slave = addr; read = (read_write == I2C_SMBUS_READ); pec = flags & I2C_FUNC_SMBUS_PEC; switch (size) { case I2C_SMBUS_QUICK: mlxbf_i2c_smbus_quick_command(&request, read); dev_dbg(&adap->dev, "smbus quick, slave 0x%02x\n", addr); break; case I2C_SMBUS_BYTE: mlxbf_i2c_smbus_byte_func(&request, read ? &data->byte : &command, read, pec); dev_dbg(&adap->dev, "smbus %s byte, slave 0x%02x.\n", read ? "read" : "write", addr); break; case I2C_SMBUS_BYTE_DATA: mlxbf_i2c_smbus_data_byte_func(&request, &command, &data->byte, read, pec); dev_dbg(&adap->dev, "smbus %s byte data at 0x%02x, slave 0x%02x.\n", read ? "read" : "write", command, addr); break; case I2C_SMBUS_WORD_DATA: mlxbf_i2c_smbus_data_word_func(&request, &command, (u8 *)&data->word, read, pec); dev_dbg(&adap->dev, "smbus %s word data at 0x%02x, slave 0x%02x.\n", read ? "read" : "write", command, addr); break; case I2C_SMBUS_I2C_BLOCK_DATA: byte_cnt = data->block[0]; mlxbf_i2c_smbus_i2c_block_func(&request, &command, data->block, &byte_cnt, read, pec); dev_dbg(&adap->dev, "i2c %s block data, %d bytes at 0x%02x, slave 0x%02x.\n", read ? "read" : "write", byte_cnt, command, addr); break; case I2C_SMBUS_BLOCK_DATA: byte_cnt = read ? I2C_SMBUS_BLOCK_MAX : data->block[0]; mlxbf_i2c_smbus_block_func(&request, &command, data->block, &byte_cnt, read, pec); dev_dbg(&adap->dev, "smbus %s block data, %d bytes at 0x%02x, slave 0x%02x.\n", read ? "read" : "write", byte_cnt, command, addr); break; case I2C_FUNC_SMBUS_PROC_CALL: mlxbf_i2c_smbus_process_call_func(&request, &command, (u8 *)&data->word, pec); dev_dbg(&adap->dev, "process call, wr/rd at 0x%02x, slave 0x%02x.\n", command, addr); break; case I2C_FUNC_SMBUS_BLOCK_PROC_CALL: byte_cnt = data->block[0]; mlxbf_i2c_smbus_blk_process_call_func(&request, &command, data->block, &byte_cnt, pec); dev_dbg(&adap->dev, "block process call, wr/rd %d bytes, slave 0x%02x.\n", byte_cnt, addr); break; default: dev_dbg(&adap->dev, "Unsupported I2C/SMBus command %d\n", size); return -EOPNOTSUPP; } priv = i2c_get_adapdata(adap); return mlxbf_i2c_smbus_start_transaction(priv, &request); } static int mlxbf_i2c_reg_slave(struct i2c_client *slave) { struct mlxbf_i2c_priv *priv = i2c_get_adapdata(slave->adapter); struct device *dev = &slave->dev; int ret; /* * Do not support ten bit chip address and do not use Packet Error * Checking (PEC). */ if (slave->flags & (I2C_CLIENT_TEN | I2C_CLIENT_PEC)) { dev_err(dev, "SMBus PEC and 10 bit address not supported\n"); return -EAFNOSUPPORT; } ret = mlxbf_i2c_slave_enable(priv, slave); if (ret) dev_err(dev, "Surpassed max number of registered slaves allowed\n"); return 0; } static int mlxbf_i2c_unreg_slave(struct i2c_client *slave) { struct mlxbf_i2c_priv *priv = i2c_get_adapdata(slave->adapter); struct device *dev = &slave->dev; int ret; /* * Unregister slave by: * 1) Disabling the slave address in hardware * 2) Freeing priv->slave at the corresponding index */ ret = mlxbf_i2c_slave_disable(priv, slave->addr); if (ret) dev_err(dev, "Unable to find slave 0x%x\n", slave->addr); return ret; } static u32 mlxbf_i2c_functionality(struct i2c_adapter *adap) { return MLXBF_I2C_FUNC_ALL; } static struct mlxbf_i2c_chip_info mlxbf_i2c_chip[] = { [MLXBF_I2C_CHIP_TYPE_1] = { .type = MLXBF_I2C_CHIP_TYPE_1, .shared_res = { [0] = &mlxbf_i2c_coalesce_res[MLXBF_I2C_CHIP_TYPE_1], [1] = &mlxbf_i2c_corepll_res[MLXBF_I2C_CHIP_TYPE_1], [2] = &mlxbf_i2c_gpio_res[MLXBF_I2C_CHIP_TYPE_1] }, .calculate_freq = mlxbf_i2c_calculate_freq_from_tyu, .smbus_master_rs_bytes_off = MLXBF_I2C_YU_SMBUS_RS_BYTES, .smbus_master_fsm_off = MLXBF_I2C_YU_SMBUS_MASTER_FSM }, [MLXBF_I2C_CHIP_TYPE_2] = { .type = MLXBF_I2C_CHIP_TYPE_2, .shared_res = { [0] = &mlxbf_i2c_corepll_res[MLXBF_I2C_CHIP_TYPE_2] }, .calculate_freq = mlxbf_i2c_calculate_freq_from_yu, .smbus_master_rs_bytes_off = MLXBF_I2C_YU_SMBUS_RS_BYTES, .smbus_master_fsm_off = MLXBF_I2C_YU_SMBUS_MASTER_FSM }, [MLXBF_I2C_CHIP_TYPE_3] = { .type = MLXBF_I2C_CHIP_TYPE_3, .shared_res = { [0] = &mlxbf_i2c_corepll_res[MLXBF_I2C_CHIP_TYPE_3] }, .calculate_freq = mlxbf_i2c_calculate_freq_from_yu, .smbus_master_rs_bytes_off = MLXBF_I2C_RSH_YU_SMBUS_RS_BYTES, .smbus_master_fsm_off = MLXBF_I2C_RSH_YU_SMBUS_MASTER_FSM } }; static const struct i2c_algorithm mlxbf_i2c_algo = { .smbus_xfer = mlxbf_i2c_smbus_xfer, .functionality = mlxbf_i2c_functionality, .reg_slave = mlxbf_i2c_reg_slave, .unreg_slave = mlxbf_i2c_unreg_slave, }; static struct i2c_adapter_quirks mlxbf_i2c_quirks = { .max_read_len = MLXBF_I2C_MASTER_DATA_R_LENGTH, .max_write_len = MLXBF_I2C_MASTER_DATA_W_LENGTH, }; static const struct acpi_device_id mlxbf_i2c_acpi_ids[] = { { "MLNXBF03", (kernel_ulong_t)&mlxbf_i2c_chip[MLXBF_I2C_CHIP_TYPE_1] }, { "MLNXBF23", (kernel_ulong_t)&mlxbf_i2c_chip[MLXBF_I2C_CHIP_TYPE_2] }, { "MLNXBF31", (kernel_ulong_t)&mlxbf_i2c_chip[MLXBF_I2C_CHIP_TYPE_3] }, {}, }; MODULE_DEVICE_TABLE(acpi, mlxbf_i2c_acpi_ids); static int mlxbf_i2c_acpi_probe(struct device *dev, struct mlxbf_i2c_priv *priv) { const struct acpi_device_id *aid; u64 bus_id; int ret; if (acpi_disabled) return -ENOENT; aid = acpi_match_device(mlxbf_i2c_acpi_ids, dev); if (!aid) return -ENODEV; priv->chip = (struct mlxbf_i2c_chip_info *)aid->driver_data; ret = acpi_dev_uid_to_integer(ACPI_COMPANION(dev), &bus_id); if (ret) { dev_err(dev, "Cannot retrieve UID\n"); return ret; } priv->bus = bus_id; return 0; } static int mlxbf_i2c_probe(struct platform_device *pdev) { struct device *dev = &pdev->dev; struct mlxbf_i2c_priv *priv; struct i2c_adapter *adap; u32 resource_version; int irq, ret; priv = devm_kzalloc(dev, sizeof(struct mlxbf_i2c_priv), GFP_KERNEL); if (!priv) return -ENOMEM; ret = mlxbf_i2c_acpi_probe(dev, priv); if (ret < 0) return ret; /* This property allows the driver to stay backward compatible with older * ACPI tables. * Starting BlueField-3 SoC, the "smbus" resource was broken down into 3 * separate resources "timer", "master" and "slave". */ if (device_property_read_u32(dev, "resource_version", &resource_version)) resource_version = 0; priv->resource_version = resource_version; if (priv->chip->type < MLXBF_I2C_CHIP_TYPE_3 && resource_version == 0) { priv->timer = devm_kzalloc(dev, sizeof(struct mlxbf_i2c_resource), GFP_KERNEL); if (!priv->timer) return -ENOMEM; priv->mst = devm_kzalloc(dev, sizeof(struct mlxbf_i2c_resource), GFP_KERNEL); if (!priv->mst) return -ENOMEM; priv->slv = devm_kzalloc(dev, sizeof(struct mlxbf_i2c_resource), GFP_KERNEL); if (!priv->slv) return -ENOMEM; ret = mlxbf_i2c_init_resource(pdev, &priv->smbus, MLXBF_I2C_SMBUS_RES); if (ret < 0) return dev_err_probe(dev, ret, "Cannot fetch smbus resource info"); priv->timer->io = priv->smbus->io; priv->mst->io = priv->smbus->io + MLXBF_I2C_MST_ADDR_OFFSET; priv->slv->io = priv->smbus->io + MLXBF_I2C_SLV_ADDR_OFFSET; } else { ret = mlxbf_i2c_init_resource(pdev, &priv->timer, MLXBF_I2C_SMBUS_TIMER_RES); if (ret < 0) return dev_err_probe(dev, ret, "Cannot fetch timer resource info"); ret = mlxbf_i2c_init_resource(pdev, &priv->mst, MLXBF_I2C_SMBUS_MST_RES); if (ret < 0) return dev_err_probe(dev, ret, "Cannot fetch master resource info"); ret = mlxbf_i2c_init_resource(pdev, &priv->slv, MLXBF_I2C_SMBUS_SLV_RES); if (ret < 0) return dev_err_probe(dev, ret, "Cannot fetch slave resource info"); } ret = mlxbf_i2c_init_resource(pdev, &priv->mst_cause, MLXBF_I2C_MST_CAUSE_RES); if (ret < 0) return dev_err_probe(dev, ret, "Cannot fetch cause master resource info"); ret = mlxbf_i2c_init_resource(pdev, &priv->slv_cause, MLXBF_I2C_SLV_CAUSE_RES); if (ret < 0) return dev_err_probe(dev, ret, "Cannot fetch cause slave resource info"); adap = &priv->adap; adap->owner = THIS_MODULE; adap->class = I2C_CLASS_HWMON; adap->algo = &mlxbf_i2c_algo; adap->quirks = &mlxbf_i2c_quirks; adap->dev.parent = dev; adap->dev.of_node = dev->of_node; adap->nr = priv->bus; snprintf(adap->name, sizeof(adap->name), "i2c%d", adap->nr); i2c_set_adapdata(adap, priv); /* Read Core PLL frequency. */ ret = mlxbf_i2c_calculate_corepll_freq(pdev, priv); if (ret < 0) { dev_err(dev, "cannot get core clock frequency\n"); /* Set to default value. */ priv->frequency = MLXBF_I2C_COREPLL_FREQ; } /* * Initialize master. * Note that a physical bus might be shared among Linux and firmware * (e.g., ATF). Thus, the bus should be initialized and ready and * bus initialization would be unnecessary. This requires additional * knowledge about physical busses. But, since an extra initialization * does not really hurt, then keep the code as is. */ ret = mlxbf_i2c_init_master(pdev, priv); if (ret < 0) return dev_err_probe(dev, ret, "failed to initialize smbus master %d", priv->bus); mlxbf_i2c_init_timings(pdev, priv); mlxbf_i2c_init_slave(pdev, priv); irq = platform_get_irq(pdev, 0); if (irq < 0) return irq; ret = devm_request_irq(dev, irq, mlxbf_i2c_irq, IRQF_SHARED | IRQF_PROBE_SHARED, dev_name(dev), priv); if (ret < 0) return dev_err_probe(dev, ret, "Cannot get irq %d\n", irq); priv->irq = irq; platform_set_drvdata(pdev, priv); ret = i2c_add_numbered_adapter(adap); if (ret < 0) return ret; mutex_lock(&mlxbf_i2c_bus_lock); mlxbf_i2c_bus_count++; mutex_unlock(&mlxbf_i2c_bus_lock); return 0; } static void mlxbf_i2c_remove(struct platform_device *pdev) { struct mlxbf_i2c_priv *priv = platform_get_drvdata(pdev); struct device *dev = &pdev->dev; struct resource *params; if (priv->chip->type < MLXBF_I2C_CHIP_TYPE_3 && priv->resource_version == 0) { params = priv->smbus->params; devm_release_mem_region(dev, params->start, resource_size(params)); } else { params = priv->timer->params; devm_release_mem_region(dev, params->start, resource_size(params)); params = priv->mst->params; devm_release_mem_region(dev, params->start, resource_size(params)); params = priv->slv->params; devm_release_mem_region(dev, params->start, resource_size(params)); } params = priv->mst_cause->params; devm_release_mem_region(dev, params->start, resource_size(params)); params = priv->slv_cause->params; devm_release_mem_region(dev, params->start, resource_size(params)); /* * Release shared resources. This should be done when releasing * the I2C controller. */ mutex_lock(&mlxbf_i2c_bus_lock); if (--mlxbf_i2c_bus_count == 0) { mlxbf_i2c_release_coalesce(pdev, priv); mlxbf_i2c_release_corepll(pdev, priv); mlxbf_i2c_release_gpio(pdev, priv); } mutex_unlock(&mlxbf_i2c_bus_lock); devm_free_irq(dev, priv->irq, priv); i2c_del_adapter(&priv->adap); } static struct platform_driver mlxbf_i2c_driver = { .probe = mlxbf_i2c_probe, .remove_new = mlxbf_i2c_remove, .driver = { .name = "i2c-mlxbf", .acpi_match_table = ACPI_PTR(mlxbf_i2c_acpi_ids), }, }; static int __init mlxbf_i2c_init(void) { mutex_init(&mlxbf_i2c_coalesce_lock); mutex_init(&mlxbf_i2c_corepll_lock); mutex_init(&mlxbf_i2c_gpio_lock); mutex_init(&mlxbf_i2c_bus_lock); return platform_driver_register(&mlxbf_i2c_driver); } module_init(mlxbf_i2c_init); static void __exit mlxbf_i2c_exit(void) { platform_driver_unregister(&mlxbf_i2c_driver); mutex_destroy(&mlxbf_i2c_bus_lock); mutex_destroy(&mlxbf_i2c_gpio_lock); mutex_destroy(&mlxbf_i2c_corepll_lock); mutex_destroy(&mlxbf_i2c_coalesce_lock); } module_exit(mlxbf_i2c_exit); MODULE_DESCRIPTION("Mellanox BlueField I2C bus driver"); MODULE_AUTHOR("Khalil Blaiech <kblaiech@nvidia.com>"); MODULE_AUTHOR("Asmaa Mnebhi <asmaa@nvidia.com>"); MODULE_LICENSE("GPL v2"); |