ref: c1cf9fdebe0d4cbc43c5d676e1ace62f2d994086
src/libs/mynewt-nimble/nimble/host/src/ble_gatts.c
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 |
/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ #include <stddef.h> #include <stdlib.h> #include <string.h> #include "nimble/ble.h" #include "host/ble_uuid.h" #include "host/ble_store.h" #include "ble_hs_priv.h" #define BLE_GATTS_INCLUDE_SZ 6 #define BLE_GATTS_CHR_MAX_SZ 19 static const ble_uuid_t *uuid_pri = BLE_UUID16_DECLARE(BLE_ATT_UUID_PRIMARY_SERVICE); static const ble_uuid_t *uuid_sec = BLE_UUID16_DECLARE(BLE_ATT_UUID_SECONDARY_SERVICE); static const ble_uuid_t *uuid_inc = BLE_UUID16_DECLARE(BLE_ATT_UUID_INCLUDE); static const ble_uuid_t *uuid_chr = BLE_UUID16_DECLARE(BLE_ATT_UUID_CHARACTERISTIC); static const ble_uuid_t *uuid_ccc = BLE_UUID16_DECLARE(BLE_GATT_DSC_CLT_CFG_UUID16); static const struct ble_gatt_svc_def **ble_gatts_svc_defs; static int ble_gatts_num_svc_defs; struct ble_gatts_svc_entry { const struct ble_gatt_svc_def *svc; uint16_t handle; /* 0 means unregistered. */ uint16_t end_group_handle; /* 0xffff means unset. */ }; static struct ble_gatts_svc_entry *ble_gatts_svc_entries; static uint16_t ble_gatts_num_svc_entries; static os_membuf_t *ble_gatts_clt_cfg_mem; static struct os_mempool ble_gatts_clt_cfg_pool; struct ble_gatts_clt_cfg { uint16_t chr_val_handle; uint8_t flags; uint8_t allowed; }; /** A cached array of handles for the configurable characteristics. */ static struct ble_gatts_clt_cfg *ble_gatts_clt_cfgs; static int ble_gatts_num_cfgable_chrs; STATS_SECT_DECL(ble_gatts_stats) ble_gatts_stats; STATS_NAME_START(ble_gatts_stats) STATS_NAME(ble_gatts_stats, svcs) STATS_NAME(ble_gatts_stats, chrs) STATS_NAME(ble_gatts_stats, dscs) STATS_NAME(ble_gatts_stats, svc_def_reads) STATS_NAME(ble_gatts_stats, svc_inc_reads) STATS_NAME(ble_gatts_stats, chr_def_reads) STATS_NAME(ble_gatts_stats, chr_val_reads) STATS_NAME(ble_gatts_stats, chr_val_writes) STATS_NAME(ble_gatts_stats, dsc_reads) STATS_NAME(ble_gatts_stats, dsc_writes) STATS_NAME_END(ble_gatts_stats) static int ble_gatts_svc_access(uint16_t conn_handle, uint16_t attr_handle, uint8_t op, uint16_t offset, struct os_mbuf **om, void *arg) { const struct ble_gatt_svc_def *svc; uint8_t *buf; STATS_INC(ble_gatts_stats, svc_def_reads); BLE_HS_DBG_ASSERT(op == BLE_ATT_ACCESS_OP_READ); svc = arg; buf = os_mbuf_extend(*om, ble_uuid_length(svc->uuid)); if (buf == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } ble_uuid_flat(svc->uuid, buf); return 0; } static int ble_gatts_inc_access(uint16_t conn_handle, uint16_t attr_handle, uint8_t op, uint16_t offset, struct os_mbuf **om, void *arg) { const struct ble_gatts_svc_entry *entry; uint16_t uuid16; uint8_t *buf; STATS_INC(ble_gatts_stats, svc_inc_reads); BLE_HS_DBG_ASSERT(op == BLE_ATT_ACCESS_OP_READ); entry = arg; buf = os_mbuf_extend(*om, 4); if (buf == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } put_le16(buf + 0, entry->handle); put_le16(buf + 2, entry->end_group_handle); /* Only include the service UUID if it has a 16-bit representation. */ uuid16 = ble_uuid_u16(entry->svc->uuid); if (uuid16 != 0) { buf = os_mbuf_extend(*om, 2); if (buf == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } put_le16(buf, uuid16); } return 0; } static uint16_t ble_gatts_chr_clt_cfg_allowed(const struct ble_gatt_chr_def *chr) { uint16_t flags; flags = 0; if (chr->flags & BLE_GATT_CHR_F_NOTIFY) { flags |= BLE_GATTS_CLT_CFG_F_NOTIFY; } if (chr->flags & BLE_GATT_CHR_F_INDICATE) { flags |= BLE_GATTS_CLT_CFG_F_INDICATE; } return flags; } static uint8_t ble_gatts_att_flags_from_chr_flags(ble_gatt_chr_flags chr_flags) { uint8_t att_flags; att_flags = 0; if (chr_flags & BLE_GATT_CHR_F_READ) { att_flags |= BLE_ATT_F_READ; } if (chr_flags & (BLE_GATT_CHR_F_WRITE_NO_RSP | BLE_GATT_CHR_F_WRITE)) { att_flags |= BLE_ATT_F_WRITE; } if (chr_flags & BLE_GATT_CHR_F_READ_ENC) { att_flags |= BLE_ATT_F_READ_ENC; } if (chr_flags & BLE_GATT_CHR_F_READ_AUTHEN) { att_flags |= BLE_ATT_F_READ_AUTHEN; } if (chr_flags & BLE_GATT_CHR_F_READ_AUTHOR) { att_flags |= BLE_ATT_F_READ_AUTHOR; } if (chr_flags & BLE_GATT_CHR_F_WRITE_ENC) { att_flags |= BLE_ATT_F_WRITE_ENC; } if (chr_flags & BLE_GATT_CHR_F_WRITE_AUTHEN) { att_flags |= BLE_ATT_F_WRITE_AUTHEN; } if (chr_flags & BLE_GATT_CHR_F_WRITE_AUTHOR) { att_flags |= BLE_ATT_F_WRITE_AUTHOR; } return att_flags; } static uint8_t ble_gatts_chr_properties(const struct ble_gatt_chr_def *chr) { uint8_t properties; properties = 0; if (chr->flags & BLE_GATT_CHR_F_BROADCAST) { properties |= BLE_GATT_CHR_PROP_BROADCAST; } if (chr->flags & BLE_GATT_CHR_F_READ) { properties |= BLE_GATT_CHR_PROP_READ; } if (chr->flags & BLE_GATT_CHR_F_WRITE_NO_RSP) { properties |= BLE_GATT_CHR_PROP_WRITE_NO_RSP; } if (chr->flags & BLE_GATT_CHR_F_WRITE) { properties |= BLE_GATT_CHR_PROP_WRITE; } if (chr->flags & BLE_GATT_CHR_F_NOTIFY) { properties |= BLE_GATT_CHR_PROP_NOTIFY; } if (chr->flags & BLE_GATT_CHR_F_INDICATE) { properties |= BLE_GATT_CHR_PROP_INDICATE; } if (chr->flags & BLE_GATT_CHR_F_AUTH_SIGN_WRITE) { properties |= BLE_GATT_CHR_PROP_AUTH_SIGN_WRITE; } if (chr->flags & (BLE_GATT_CHR_F_RELIABLE_WRITE | BLE_GATT_CHR_F_AUX_WRITE)) { properties |= BLE_GATT_CHR_PROP_EXTENDED; } return properties; } static int ble_gatts_chr_def_access(uint16_t conn_handle, uint16_t attr_handle, uint8_t op, uint16_t offset, struct os_mbuf **om, void *arg) { const struct ble_gatt_chr_def *chr; uint8_t *buf; STATS_INC(ble_gatts_stats, chr_def_reads); BLE_HS_DBG_ASSERT(op == BLE_ATT_ACCESS_OP_READ); chr = arg; buf = os_mbuf_extend(*om, 3); if (buf == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } buf[0] = ble_gatts_chr_properties(chr); /* The value attribute is always immediately after the declaration. */ put_le16(buf + 1, attr_handle + 1); buf = os_mbuf_extend(*om, ble_uuid_length(chr->uuid)); if (buf == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } ble_uuid_flat(chr->uuid, buf); return 0; } static int ble_gatts_chr_is_sane(const struct ble_gatt_chr_def *chr) { if (chr->uuid == NULL) { return 0; } if (chr->access_cb == NULL) { return 0; } /* XXX: Check properties. */ return 1; } static uint8_t ble_gatts_chr_op(uint8_t att_op) { switch (att_op) { case BLE_ATT_ACCESS_OP_READ: return BLE_GATT_ACCESS_OP_READ_CHR; case BLE_ATT_ACCESS_OP_WRITE: return BLE_GATT_ACCESS_OP_WRITE_CHR; default: BLE_HS_DBG_ASSERT(0); return BLE_GATT_ACCESS_OP_READ_CHR; } } static void ble_gatts_chr_inc_val_stat(uint8_t gatt_op) { switch (gatt_op) { case BLE_GATT_ACCESS_OP_READ_CHR: STATS_INC(ble_gatts_stats, chr_val_reads); break; case BLE_GATT_ACCESS_OP_WRITE_CHR: STATS_INC(ble_gatts_stats, chr_val_writes); break; default: break; } } /** * Indicates whether the set of registered services can be modified. The * service set is mutable if: * o No peers are connected, and * o No GAP operations are active (advertise, discover, or connect). * * @return true if the GATT service set can be modified; * false otherwise. */ static bool ble_gatts_mutable(void) { /* Ensure no active GAP procedures. */ if (ble_gap_adv_active() || ble_gap_disc_active() || ble_gap_conn_active()) { return false; } /* Ensure no established connections. */ if (ble_hs_conn_first() != NULL) { return false; } return true; } static int ble_gatts_val_access(uint16_t conn_handle, uint16_t attr_handle, uint16_t offset, struct ble_gatt_access_ctxt *gatt_ctxt, struct os_mbuf **om, ble_gatt_access_fn *access_cb, void *cb_arg) { uint16_t initial_len; int attr_len; int new_om; int rc; switch (gatt_ctxt->op) { case BLE_GATT_ACCESS_OP_READ_CHR: case BLE_GATT_ACCESS_OP_READ_DSC: /* A characteristic value is being read. * * If the read specifies an offset of 0: * just append the characteristic value directly onto the response * mbuf. * * Else: * allocate a new mbuf to hold the characteristic data, then append * the requested portion onto the response mbuf. */ if (offset == 0) { new_om = 0; gatt_ctxt->om = *om; } else { new_om = 1; gatt_ctxt->om = os_msys_get_pkthdr(0, 0); if (gatt_ctxt->om == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } } initial_len = OS_MBUF_PKTLEN(gatt_ctxt->om); rc = access_cb(conn_handle, attr_handle, gatt_ctxt, cb_arg); if (rc == 0) { attr_len = OS_MBUF_PKTLEN(gatt_ctxt->om) - initial_len - offset; if (attr_len >= 0) { if (new_om) { os_mbuf_appendfrom(*om, gatt_ctxt->om, offset, attr_len); } } else { rc = BLE_ATT_ERR_INVALID_OFFSET; } } if (new_om) { os_mbuf_free_chain(gatt_ctxt->om); } return rc; case BLE_GATT_ACCESS_OP_WRITE_CHR: case BLE_GATT_ACCESS_OP_WRITE_DSC: gatt_ctxt->om = *om; rc = access_cb(conn_handle, attr_handle, gatt_ctxt, cb_arg); *om = gatt_ctxt->om; return rc; default: BLE_HS_DBG_ASSERT(0); return BLE_ATT_ERR_UNLIKELY; } } static int ble_gatts_chr_val_access(uint16_t conn_handle, uint16_t attr_handle, uint8_t att_op, uint16_t offset, struct os_mbuf **om, void *arg) { const struct ble_gatt_chr_def *chr_def; struct ble_gatt_access_ctxt gatt_ctxt; int rc; chr_def = arg; BLE_HS_DBG_ASSERT(chr_def != NULL && chr_def->access_cb != NULL); gatt_ctxt.op = ble_gatts_chr_op(att_op); gatt_ctxt.chr = chr_def; ble_gatts_chr_inc_val_stat(gatt_ctxt.op); rc = ble_gatts_val_access(conn_handle, attr_handle, offset, &gatt_ctxt, om, chr_def->access_cb, chr_def->arg); return rc; } static int ble_gatts_find_svc_entry_idx(const struct ble_gatt_svc_def *svc) { int i; for (i = 0; i < ble_gatts_num_svc_entries; i++) { if (ble_gatts_svc_entries[i].svc == svc) { return i; } } return -1; } static int ble_gatts_svc_incs_satisfied(const struct ble_gatt_svc_def *svc) { int idx; int i; if (svc->includes == NULL) { /* No included services. */ return 1; } for (i = 0; svc->includes[i] != NULL; i++) { idx = ble_gatts_find_svc_entry_idx(svc->includes[i]); if (idx == -1 || ble_gatts_svc_entries[idx].handle == 0) { return 0; } } return 1; } static int ble_gatts_register_inc(struct ble_gatts_svc_entry *entry) { uint16_t handle; int rc; BLE_HS_DBG_ASSERT(entry->handle != 0); BLE_HS_DBG_ASSERT(entry->end_group_handle != 0xffff); rc = ble_att_svr_register(uuid_inc, BLE_ATT_F_READ, 0, &handle, ble_gatts_inc_access, entry); if (rc != 0) { return rc; } return 0; } static uint8_t ble_gatts_dsc_op(uint8_t att_op) { switch (att_op) { case BLE_ATT_ACCESS_OP_READ: return BLE_GATT_ACCESS_OP_READ_DSC; case BLE_ATT_ACCESS_OP_WRITE: return BLE_GATT_ACCESS_OP_WRITE_DSC; default: BLE_HS_DBG_ASSERT(0); return BLE_GATT_ACCESS_OP_READ_DSC; } } static void ble_gatts_dsc_inc_stat(uint8_t gatt_op) { switch (gatt_op) { case BLE_GATT_ACCESS_OP_READ_DSC: STATS_INC(ble_gatts_stats, dsc_reads); break; case BLE_GATT_ACCESS_OP_WRITE_DSC: STATS_INC(ble_gatts_stats, dsc_writes); break; default: break; } } static int ble_gatts_dsc_access(uint16_t conn_handle, uint16_t attr_handle, uint8_t att_op, uint16_t offset, struct os_mbuf **om, void *arg) { const struct ble_gatt_dsc_def *dsc_def; struct ble_gatt_access_ctxt gatt_ctxt; int rc; dsc_def = arg; BLE_HS_DBG_ASSERT(dsc_def != NULL && dsc_def->access_cb != NULL); gatt_ctxt.op = ble_gatts_dsc_op(att_op); gatt_ctxt.dsc = dsc_def; ble_gatts_dsc_inc_stat(gatt_ctxt.op); rc = ble_gatts_val_access(conn_handle, attr_handle, offset, &gatt_ctxt, om, dsc_def->access_cb, dsc_def->arg); return rc; } static int ble_gatts_dsc_is_sane(const struct ble_gatt_dsc_def *dsc) { if (dsc->uuid == NULL) { return 0; } if (dsc->access_cb == NULL) { return 0; } return 1; } static int ble_gatts_register_dsc(const struct ble_gatt_svc_def *svc, const struct ble_gatt_chr_def *chr, const struct ble_gatt_dsc_def *dsc, uint16_t chr_def_handle, ble_gatt_register_fn *register_cb, void *cb_arg) { struct ble_gatt_register_ctxt register_ctxt; uint16_t dsc_handle; int rc; if (!ble_gatts_dsc_is_sane(dsc)) { return BLE_HS_EINVAL; } rc = ble_att_svr_register(dsc->uuid, dsc->att_flags, dsc->min_key_size, &dsc_handle, ble_gatts_dsc_access, (void *)dsc); if (rc != 0) { return rc; } if (register_cb != NULL) { register_ctxt.op = BLE_GATT_REGISTER_OP_DSC; register_ctxt.dsc.handle = dsc_handle; register_ctxt.dsc.svc_def = svc; register_ctxt.dsc.chr_def = chr; register_ctxt.dsc.dsc_def = dsc; register_cb(®ister_ctxt, cb_arg); } STATS_INC(ble_gatts_stats, dscs); return 0; } static int ble_gatts_clt_cfg_find_idx(struct ble_gatts_clt_cfg *cfgs, uint16_t chr_val_handle) { struct ble_gatts_clt_cfg *cfg; int i; for (i = 0; i < ble_gatts_num_cfgable_chrs; i++) { cfg = cfgs + i; if (cfg->chr_val_handle == chr_val_handle) { return i; } } return -1; } static struct ble_gatts_clt_cfg * ble_gatts_clt_cfg_find(struct ble_gatts_clt_cfg *cfgs, uint16_t chr_val_handle) { int idx; idx = ble_gatts_clt_cfg_find_idx(cfgs, chr_val_handle); if (idx == -1) { return NULL; } else { return cfgs + idx; } } static void ble_gatts_subscribe_event(uint16_t conn_handle, uint16_t attr_handle, uint8_t reason, uint8_t prev_flags, uint8_t cur_flags) { if ((prev_flags ^ cur_flags) & ~BLE_GATTS_CLT_CFG_F_RESERVED) { ble_gap_subscribe_event(conn_handle, attr_handle, reason, prev_flags & BLE_GATTS_CLT_CFG_F_NOTIFY, cur_flags & BLE_GATTS_CLT_CFG_F_NOTIFY, prev_flags & BLE_GATTS_CLT_CFG_F_INDICATE, cur_flags & BLE_GATTS_CLT_CFG_F_INDICATE); } } /** * Performs a read or write access on a client characteritic configuration * descriptor (CCCD). * * @param conn The connection of the peer doing the accessing. * @apram attr_handle The handle of the CCCD. * @param att_op The ATT operation being performed (read or * write). * @param ctxt Communication channel between this function and * the caller within the nimble stack. * Semantics depends on the operation being * performed. * @param out_cccd If the CCCD should be persisted as a result of * the access, the data-to-be-persisted gets * written here. If no persistence is * necessary, out_cccd->chr_val_handle is set * to 0. * * @return 0 on success; nonzero on failure. */ static int ble_gatts_clt_cfg_access_locked(struct ble_hs_conn *conn, uint16_t attr_handle, uint8_t att_op, uint16_t offset, struct os_mbuf *om, struct ble_store_value_cccd *out_cccd, uint8_t *out_prev_clt_cfg_flags, uint8_t *out_cur_clt_cfg_flags) { struct ble_gatts_clt_cfg *clt_cfg; uint16_t chr_val_handle; uint16_t flags; uint8_t gatt_op; uint8_t *buf; /* Assume nothing needs to be persisted. */ out_cccd->chr_val_handle = 0; /* We always register the client characteristics descriptor with handle * (chr_val + 1). */ chr_val_handle = attr_handle - 1; if (chr_val_handle > attr_handle) { /* Attribute handle wrapped somehow. */ return BLE_ATT_ERR_UNLIKELY; } clt_cfg = ble_gatts_clt_cfg_find(conn->bhc_gatt_svr.clt_cfgs, chr_val_handle); if (clt_cfg == NULL) { return BLE_ATT_ERR_UNLIKELY; } /* Assume no change in flags. */ *out_prev_clt_cfg_flags = clt_cfg->flags; *out_cur_clt_cfg_flags = clt_cfg->flags; gatt_op = ble_gatts_dsc_op(att_op); ble_gatts_dsc_inc_stat(gatt_op); switch (gatt_op) { case BLE_GATT_ACCESS_OP_READ_DSC: STATS_INC(ble_gatts_stats, dsc_reads); buf = os_mbuf_extend(om, 2); if (buf == NULL) { return BLE_ATT_ERR_INSUFFICIENT_RES; } put_le16(buf, clt_cfg->flags & ~BLE_GATTS_CLT_CFG_F_RESERVED); break; case BLE_GATT_ACCESS_OP_WRITE_DSC: STATS_INC(ble_gatts_stats, dsc_writes); if (OS_MBUF_PKTLEN(om) != 2) { return BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN; } om = os_mbuf_pullup(om, 2); BLE_HS_DBG_ASSERT(om != NULL); flags = get_le16(om->om_data); if ((flags & ~clt_cfg->allowed) != 0) { return BLE_ATT_ERR_REQ_NOT_SUPPORTED; } if (clt_cfg->flags != flags) { clt_cfg->flags = flags; *out_cur_clt_cfg_flags = flags; /* Successful writes get persisted for bonded connections. */ if (conn->bhc_sec_state.bonded) { out_cccd->peer_addr = conn->bhc_peer_addr; out_cccd->peer_addr.type = ble_hs_misc_peer_addr_type_to_id(conn->bhc_peer_addr.type); out_cccd->chr_val_handle = chr_val_handle; out_cccd->flags = clt_cfg->flags; out_cccd->value_changed = 0; } } break; default: BLE_HS_DBG_ASSERT(0); return BLE_ATT_ERR_UNLIKELY; } return 0; } int ble_gatts_clt_cfg_access(uint16_t conn_handle, uint16_t attr_handle, uint8_t op, uint16_t offset, struct os_mbuf **om, void *arg) { struct ble_store_value_cccd cccd_value; struct ble_store_key_cccd cccd_key; struct ble_hs_conn *conn; uint16_t chr_val_handle; uint8_t prev_flags; uint8_t cur_flags; int rc; ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); if (conn == NULL) { rc = BLE_ATT_ERR_UNLIKELY; } else { rc = ble_gatts_clt_cfg_access_locked(conn, attr_handle, op, offset, *om, &cccd_value, &prev_flags, &cur_flags); } ble_hs_unlock(); if (rc != 0) { return rc; } /* The value attribute is always immediately after the declaration. */ chr_val_handle = attr_handle - 1; /* Tell the application if the peer changed its subscription state. */ ble_gatts_subscribe_event(conn_handle, chr_val_handle, BLE_GAP_SUBSCRIBE_REASON_WRITE, prev_flags, cur_flags); /* Persist the CCCD if required. */ if (cccd_value.chr_val_handle != 0) { if (cccd_value.flags == 0) { ble_store_key_from_value_cccd(&cccd_key, &cccd_value); rc = ble_store_delete_cccd(&cccd_key); } else { rc = ble_store_write_cccd(&cccd_value); } } return rc; } static int ble_gatts_register_clt_cfg_dsc(uint16_t *att_handle) { int rc; rc = ble_att_svr_register(uuid_ccc, BLE_ATT_F_READ | BLE_ATT_F_WRITE, 0, att_handle, ble_gatts_clt_cfg_access, NULL); if (rc != 0) { return rc; } STATS_INC(ble_gatts_stats, dscs); return 0; } static int ble_gatts_register_chr(const struct ble_gatt_svc_def *svc, const struct ble_gatt_chr_def *chr, ble_gatt_register_fn *register_cb, void *cb_arg) { struct ble_gatt_register_ctxt register_ctxt; struct ble_gatt_dsc_def *dsc; uint16_t def_handle; uint16_t val_handle; uint16_t dsc_handle; uint8_t att_flags; int rc; if (!ble_gatts_chr_is_sane(chr)) { return BLE_HS_EINVAL; } if (ble_gatts_chr_clt_cfg_allowed(chr) != 0) { if (ble_gatts_num_cfgable_chrs > ble_hs_max_client_configs) { return BLE_HS_ENOMEM; } ble_gatts_num_cfgable_chrs++; } /* Register characteristic definition attribute (cast away const on * callback arg). */ rc = ble_att_svr_register(uuid_chr, BLE_ATT_F_READ, 0, &def_handle, ble_gatts_chr_def_access, (void *)chr); if (rc != 0) { return rc; } /* Register characteristic value attribute (cast away const on callback * arg). */ att_flags = ble_gatts_att_flags_from_chr_flags(chr->flags); rc = ble_att_svr_register(chr->uuid, att_flags, chr->min_key_size, &val_handle, ble_gatts_chr_val_access, (void *)chr); if (rc != 0) { return rc; } BLE_HS_DBG_ASSERT(val_handle == def_handle + 1); if (chr->val_handle != NULL) { *chr->val_handle = val_handle; } if (register_cb != NULL) { register_ctxt.op = BLE_GATT_REGISTER_OP_CHR; register_ctxt.chr.def_handle = def_handle; register_ctxt.chr.val_handle = val_handle; register_ctxt.chr.svc_def = svc; register_ctxt.chr.chr_def = chr; register_cb(®ister_ctxt, cb_arg); } if (ble_gatts_chr_clt_cfg_allowed(chr) != 0) { rc = ble_gatts_register_clt_cfg_dsc(&dsc_handle); if (rc != 0) { return rc; } BLE_HS_DBG_ASSERT(dsc_handle == def_handle + 2); } /* Register each descriptor. */ if (chr->descriptors != NULL) { for (dsc = chr->descriptors; dsc->uuid != NULL; dsc++) { rc = ble_gatts_register_dsc(svc, chr, dsc, def_handle, register_cb, cb_arg); if (rc != 0) { return rc; } } } STATS_INC(ble_gatts_stats, chrs); return 0; } static int ble_gatts_svc_type_to_uuid(uint8_t svc_type, const ble_uuid_t **uuid) { switch (svc_type) { case BLE_GATT_SVC_TYPE_PRIMARY: *uuid = uuid_pri; return 0; case BLE_GATT_SVC_TYPE_SECONDARY: *uuid = uuid_sec; return 0; default: return BLE_HS_EINVAL; } } static int ble_gatts_svc_is_sane(const struct ble_gatt_svc_def *svc) { if (svc->type != BLE_GATT_SVC_TYPE_PRIMARY && svc->type != BLE_GATT_SVC_TYPE_SECONDARY) { return 0; } if (svc->uuid == NULL) { return 0; } return 1; } static int ble_gatts_register_svc(const struct ble_gatt_svc_def *svc, uint16_t *out_handle, ble_gatt_register_fn *register_cb, void *cb_arg) { const struct ble_gatt_chr_def *chr; struct ble_gatt_register_ctxt register_ctxt; const ble_uuid_t *uuid; int idx; int rc; int i; if (!ble_gatts_svc_incs_satisfied(svc)) { return BLE_HS_EAGAIN; } if (!ble_gatts_svc_is_sane(svc)) { return BLE_HS_EINVAL; } /* Prevent spurious maybe-uninitialized gcc warning. */ uuid = NULL; rc = ble_gatts_svc_type_to_uuid(svc->type, &uuid); BLE_HS_DBG_ASSERT_EVAL(rc == 0); /* Register service definition attribute (cast away const on callback * arg). */ rc = ble_att_svr_register(uuid, BLE_ATT_F_READ, 0, out_handle, ble_gatts_svc_access, (void *)svc); if (rc != 0) { return rc; } if (register_cb != NULL) { register_ctxt.op = BLE_GATT_REGISTER_OP_SVC; register_ctxt.svc.handle = *out_handle; register_ctxt.svc.svc_def = svc; register_cb(®ister_ctxt, cb_arg); } /* Register each include. */ if (svc->includes != NULL) { for (i = 0; svc->includes[i] != NULL; i++) { idx = ble_gatts_find_svc_entry_idx(svc->includes[i]); BLE_HS_DBG_ASSERT_EVAL(idx != -1); rc = ble_gatts_register_inc(ble_gatts_svc_entries + idx); if (rc != 0) { return rc; } } } /* Register each characteristic. */ if (svc->characteristics != NULL) { for (chr = svc->characteristics; chr->uuid != NULL; chr++) { rc = ble_gatts_register_chr(svc, chr, register_cb, cb_arg); if (rc != 0) { return rc; } } } STATS_INC(ble_gatts_stats, svcs); return 0; } static int ble_gatts_register_round(int *out_num_registered, ble_gatt_register_fn *cb, void *cb_arg) { struct ble_gatts_svc_entry *entry; uint16_t handle; int rc; int i; *out_num_registered = 0; for (i = 0; i < ble_gatts_num_svc_entries; i++) { entry = ble_gatts_svc_entries + i; if (entry->handle == 0) { rc = ble_gatts_register_svc(entry->svc, &handle, cb, cb_arg); switch (rc) { case 0: /* Service successfully registered. */ entry->handle = handle; entry->end_group_handle = ble_att_svr_prev_handle(); (*out_num_registered)++; break; case BLE_HS_EAGAIN: /* Service could not be registered due to unsatisfied includes. * Try again on the next iteration. */ break; default: return rc; } } } if (*out_num_registered == 0) { /* There is a circular dependency. */ return BLE_HS_EINVAL; } return 0; } /** * Registers a set of services, characteristics, and descriptors to be accessed * by GATT clients. * * @param svcs A table of the service definitions to be * registered. * @param cb The function to call for each service, * characteristic, and descriptor that gets * registered. * @param cb_arg The optional argument to pass to the callback * function. * * @return 0 on success; * BLE_HS_ENOMEM if registration failed due to * resource exhaustion; * BLE_HS_EINVAL if the service definition table * contains an invalid element. */ int ble_gatts_register_svcs(const struct ble_gatt_svc_def *svcs, ble_gatt_register_fn *cb, void *cb_arg) { int total_registered; int cur_registered; int num_svcs; int idx; int rc; int i; for (i = 0; svcs[i].type != BLE_GATT_SVC_TYPE_END; i++) { idx = ble_gatts_num_svc_entries + i; if (idx >= ble_hs_max_services) { return BLE_HS_ENOMEM; } ble_gatts_svc_entries[idx].svc = svcs + i; ble_gatts_svc_entries[idx].handle = 0; ble_gatts_svc_entries[idx].end_group_handle = 0xffff; } num_svcs = i; ble_gatts_num_svc_entries += num_svcs; total_registered = 0; while (total_registered < num_svcs) { rc = ble_gatts_register_round(&cur_registered, cb, cb_arg); if (rc != 0) { return rc; } total_registered += cur_registered; } return 0; } static int ble_gatts_clt_cfg_size(void) { return ble_gatts_num_cfgable_chrs * sizeof (struct ble_gatts_clt_cfg); } /** * Handles GATT server clean up for a terminated connection: * o Informs the application that the peer is no longer subscribed to any * characteristic updates. * o Frees GATT server resources consumed by the connection (CCCDs). */ void ble_gatts_connection_broken(uint16_t conn_handle) { struct ble_gatts_clt_cfg *clt_cfgs; struct ble_hs_conn *conn; int num_clt_cfgs; int rc; int i; /* Find the specified connection and extract its CCCD entries. Extracting * the clt_cfg pointer and setting the original to null is done for two * reasons: * 1. So that the CCCD entries can be safely processed after unlocking * the mutex. * 2. To ensure a subsequent indicate procedure for this peer is not * attempted, as the connection is about to be terminated. This * avoids a spurious notify-tx GAP event callback to the * application. By setting the clt_cfg pointer to null, it is * assured that the connection has no pending indications to send. */ ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); if (conn != NULL) { clt_cfgs = conn->bhc_gatt_svr.clt_cfgs; num_clt_cfgs = conn->bhc_gatt_svr.num_clt_cfgs; conn->bhc_gatt_svr.clt_cfgs = NULL; conn->bhc_gatt_svr.num_clt_cfgs = 0; } ble_hs_unlock(); if (conn == NULL) { return; } /* If there is an indicate procedure in progress for this connection, * inform the application that it has failed. */ ble_gatts_indicate_fail_notconn(conn_handle); /* Now that the mutex is unlocked, inform the application that the peer is * no longer subscribed to any characteristic updates. */ if (clt_cfgs != NULL) { for (i = 0; i < num_clt_cfgs; i++) { ble_gatts_subscribe_event(conn_handle, clt_cfgs[i].chr_val_handle, BLE_GAP_SUBSCRIBE_REASON_TERM, clt_cfgs[i].flags, 0); } rc = os_memblock_put(&ble_gatts_clt_cfg_pool, clt_cfgs); BLE_HS_DBG_ASSERT_EVAL(rc == 0); } } static void ble_gatts_free_svc_defs(void) { free(ble_gatts_svc_defs); ble_gatts_svc_defs = NULL; ble_gatts_num_svc_defs = 0; } static void ble_gatts_free_mem(void) { free(ble_gatts_clt_cfg_mem); ble_gatts_clt_cfg_mem = NULL; free(ble_gatts_svc_entries); ble_gatts_svc_entries = NULL; } int ble_gatts_start(void) { struct ble_att_svr_entry *ha; struct ble_gatt_chr_def *chr; uint16_t allowed_flags; ble_uuid16_t uuid = BLE_UUID16_INIT(BLE_ATT_UUID_CHARACTERISTIC); int num_elems; int idx; int rc; int i; ble_hs_lock(); if (!ble_gatts_mutable()) { rc = BLE_HS_EBUSY; goto done; } ble_gatts_free_mem(); rc = ble_att_svr_start(); if (rc != 0) { goto done; } if (ble_hs_max_client_configs > 0) { ble_gatts_clt_cfg_mem = malloc( OS_MEMPOOL_BYTES(ble_hs_max_client_configs, sizeof (struct ble_gatts_clt_cfg))); if (ble_gatts_clt_cfg_mem == NULL) { rc = BLE_HS_ENOMEM; goto done; } } if (ble_hs_max_services > 0) { ble_gatts_svc_entries = malloc(ble_hs_max_services * sizeof *ble_gatts_svc_entries); if (ble_gatts_svc_entries == NULL) { rc = BLE_HS_ENOMEM; goto done; } } ble_gatts_num_svc_entries = 0; for (i = 0; i < ble_gatts_num_svc_defs; i++) { rc = ble_gatts_register_svcs(ble_gatts_svc_defs[i], ble_hs_cfg.gatts_register_cb, ble_hs_cfg.gatts_register_arg); if (rc != 0) { goto done; } } ble_gatts_free_svc_defs(); if (ble_gatts_num_cfgable_chrs == 0) { rc = 0; goto done; } /* Initialize client-configuration memory pool. */ num_elems = ble_hs_max_client_configs / ble_gatts_num_cfgable_chrs; rc = os_mempool_init(&ble_gatts_clt_cfg_pool, num_elems, ble_gatts_clt_cfg_size(), ble_gatts_clt_cfg_mem, "ble_gatts_clt_cfg_pool"); if (rc != 0) { rc = BLE_HS_EOS; goto done; } /* Allocate the cached array of handles for the configuration * characteristics. */ ble_gatts_clt_cfgs = os_memblock_get(&ble_gatts_clt_cfg_pool); if (ble_gatts_clt_cfgs == NULL) { rc = BLE_HS_ENOMEM; goto done; } /* Fill the cache. */ idx = 0; ha = NULL; while ((ha = ble_att_svr_find_by_uuid(ha, &uuid.u, 0xffff)) != NULL) { chr = ha->ha_cb_arg; allowed_flags = ble_gatts_chr_clt_cfg_allowed(chr); if (allowed_flags != 0) { BLE_HS_DBG_ASSERT_EVAL(idx < ble_gatts_num_cfgable_chrs); ble_gatts_clt_cfgs[idx].chr_val_handle = ha->ha_handle_id + 1; ble_gatts_clt_cfgs[idx].allowed = allowed_flags; ble_gatts_clt_cfgs[idx].flags = 0; idx++; } } done: if (rc != 0) { ble_gatts_free_mem(); ble_gatts_free_svc_defs(); } ble_hs_unlock(); return rc; } int ble_gatts_conn_can_alloc(void) { return ble_gatts_num_cfgable_chrs == 0 || ble_gatts_clt_cfg_pool.mp_num_free > 0; } int ble_gatts_conn_init(struct ble_gatts_conn *gatts_conn) { if (ble_gatts_num_cfgable_chrs > 0) { gatts_conn->clt_cfgs = os_memblock_get(&ble_gatts_clt_cfg_pool); if (gatts_conn->clt_cfgs == NULL) { return BLE_HS_ENOMEM; } /* Initialize the client configuration with a copy of the cache. */ memcpy(gatts_conn->clt_cfgs, ble_gatts_clt_cfgs, ble_gatts_clt_cfg_size()); gatts_conn->num_clt_cfgs = ble_gatts_num_cfgable_chrs; } else { gatts_conn->clt_cfgs = NULL; gatts_conn->num_clt_cfgs = 0; } return 0; } /** * Schedules a notification or indication for the specified peer-CCCD pair. If * the update should be sent immediately, it is indicated in the return code. * * @param conn The connection to schedule the update for. * @param clt_cfg The client config entry corresponding to the * peer and affected characteristic. * * @return The att_op of the update to send immediately, * if any. 0 if nothing should get sent. */ static uint8_t ble_gatts_schedule_update(struct ble_hs_conn *conn, struct ble_gatts_clt_cfg *clt_cfg) { uint8_t att_op; if (!(clt_cfg->flags & BLE_GATTS_CLT_CFG_F_MODIFIED)) { /* Characteristic not modified. Nothing to send. */ att_op = 0; } else if (clt_cfg->flags & BLE_GATTS_CLT_CFG_F_NOTIFY) { /* Notifications always get sent immediately. */ att_op = BLE_ATT_OP_NOTIFY_REQ; } else if (clt_cfg->flags & BLE_GATTS_CLT_CFG_F_INDICATE) { /* Only one outstanding indication per peer is allowed. If we * are still awaiting an ack, mark this CCCD as updated so that * we know to send the indication upon receiving the expected ack. * If there isn't an outstanding indication, send this one now. */ if (conn->bhc_gatt_svr.indicate_val_handle != 0) { att_op = 0; } else { att_op = BLE_ATT_OP_INDICATE_REQ; } } else { /* Peer isn't subscribed to notifications or indications. Nothing to * send. */ att_op = 0; } /* If we will be sending an update, clear the modified flag so that we * don't double-send. */ if (att_op != 0) { clt_cfg->flags &= ~BLE_GATTS_CLT_CFG_F_MODIFIED; } return att_op; } int ble_gatts_send_next_indicate(uint16_t conn_handle) { struct ble_gatts_clt_cfg *clt_cfg; struct ble_hs_conn *conn; uint16_t chr_val_handle; int rc; int i; /* Assume no pending indications. */ chr_val_handle = 0; ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); if (conn != NULL) { for (i = 0; i < conn->bhc_gatt_svr.num_clt_cfgs; i++) { clt_cfg = conn->bhc_gatt_svr.clt_cfgs + i; if (clt_cfg->flags & BLE_GATTS_CLT_CFG_F_MODIFIED) { BLE_HS_DBG_ASSERT(clt_cfg->flags & BLE_GATTS_CLT_CFG_F_INDICATE); chr_val_handle = clt_cfg->chr_val_handle; /* Clear pending flag in anticipation of indication tx. */ clt_cfg->flags &= ~BLE_GATTS_CLT_CFG_F_MODIFIED; break; } } } ble_hs_unlock(); if (conn == NULL) { return BLE_HS_ENOTCONN; } if (chr_val_handle == 0) { return BLE_HS_ENOENT; } rc = ble_gattc_indicate(conn_handle, chr_val_handle); if (rc != 0) { return rc; } return 0; } int ble_gatts_rx_indicate_ack(uint16_t conn_handle, uint16_t chr_val_handle) { struct ble_store_value_cccd cccd_value; struct ble_gatts_clt_cfg *clt_cfg; struct ble_hs_conn *conn; int clt_cfg_idx; int persist; int rc; clt_cfg_idx = ble_gatts_clt_cfg_find_idx(ble_gatts_clt_cfgs, chr_val_handle); if (clt_cfg_idx == -1) { /* This characteristic does not have a CCCD. */ return BLE_HS_ENOENT; } clt_cfg = ble_gatts_clt_cfgs + clt_cfg_idx; if (!(clt_cfg->allowed & BLE_GATTS_CLT_CFG_F_INDICATE)) { /* This characteristic does not allow indications. */ return BLE_HS_ENOENT; } ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); BLE_HS_DBG_ASSERT(conn != NULL); if (conn->bhc_gatt_svr.indicate_val_handle == chr_val_handle) { /* This acknowledgement is expected. */ rc = 0; /* Mark that there is no longer an outstanding txed indicate. */ conn->bhc_gatt_svr.indicate_val_handle = 0; /* Determine if we need to persist that there is no pending indication * for this peer-characteristic pair. If the characteristic has not * been modified since we sent the indication, there is no indication * pending. */ BLE_HS_DBG_ASSERT(conn->bhc_gatt_svr.num_clt_cfgs > clt_cfg_idx); clt_cfg = conn->bhc_gatt_svr.clt_cfgs + clt_cfg_idx; BLE_HS_DBG_ASSERT(clt_cfg->chr_val_handle == chr_val_handle); persist = conn->bhc_sec_state.bonded && !(clt_cfg->flags & BLE_GATTS_CLT_CFG_F_MODIFIED); if (persist) { cccd_value.peer_addr = conn->bhc_peer_addr; cccd_value.peer_addr.type = ble_hs_misc_peer_addr_type_to_id(conn->bhc_peer_addr.type); cccd_value.chr_val_handle = chr_val_handle; cccd_value.flags = clt_cfg->flags; cccd_value.value_changed = 0; } } else { /* This acknowledgement doesn't correspond to the outstanding * indication; ignore it. */ rc = BLE_HS_ENOENT; } ble_hs_unlock(); if (rc != 0) { return rc; } if (persist) { rc = ble_store_write_cccd(&cccd_value); if (rc != 0) { /* XXX: How should this error get reported? */ } } return 0; } void ble_gatts_chr_updated(uint16_t chr_val_handle) { struct ble_store_value_cccd cccd_value; struct ble_store_key_cccd cccd_key; struct ble_gatts_clt_cfg *clt_cfg; struct ble_hs_conn *conn; int new_notifications = 0; int clt_cfg_idx; int persist; int rc; int i; /* Determine if notifications or indications are allowed for this * characteristic. If not, return immediately. */ clt_cfg_idx = ble_gatts_clt_cfg_find_idx(ble_gatts_clt_cfgs, chr_val_handle); if (clt_cfg_idx == -1) { return; } /*** Send notifications and indications to connected devices. */ ble_hs_lock(); for (i = 0; ; i++) { /* XXX: This is inefficient when there are a lot of connections. * Consider using a "foreach" function to walk the connection list. */ conn = ble_hs_conn_find_by_idx(i); if (conn == NULL) { break; } BLE_HS_DBG_ASSERT_EVAL(conn->bhc_gatt_svr.num_clt_cfgs > clt_cfg_idx); clt_cfg = conn->bhc_gatt_svr.clt_cfgs + clt_cfg_idx; BLE_HS_DBG_ASSERT_EVAL(clt_cfg->chr_val_handle == chr_val_handle); /* Mark the CCCD entry as modified. */ clt_cfg->flags |= BLE_GATTS_CLT_CFG_F_MODIFIED; new_notifications = 1; } ble_hs_unlock(); if (new_notifications) { ble_hs_notifications_sched(); } /*** Persist updated flag for unconnected and not-yet-bonded devices. */ /* Retrieve each record corresponding to the modified characteristic. */ cccd_key.peer_addr = *BLE_ADDR_ANY; cccd_key.chr_val_handle = chr_val_handle; cccd_key.idx = 0; while (1) { rc = ble_store_read_cccd(&cccd_key, &cccd_value); if (rc != 0) { /* Read error or no more CCCD records. */ break; } /* Determine if this record needs to be rewritten. */ ble_hs_lock(); conn = ble_hs_conn_find_by_addr(&cccd_key.peer_addr); if (conn == NULL) { /* Device isn't connected; persist the changed flag so that an * update can be sent when the device reconnects and rebonds. */ persist = 1; } else if (cccd_value.flags & BLE_GATTS_CLT_CFG_F_INDICATE) { /* Indication for a connected device; record that the * characteristic has changed until we receive the ack. */ persist = 1; } else { /* Notification for a connected device; we already sent it so there * is no need to persist. */ persist = 0; } ble_hs_unlock(); /* Only persist if the value changed flag wasn't already sent (i.e., * don't overwrite with identical data). */ if (persist && !cccd_value.value_changed) { cccd_value.value_changed = 1; ble_store_write_cccd(&cccd_value); } /* Read the next matching record. */ cccd_key.idx++; } } /** * Sends notifications or indications for the specified characteristic to all * connected devices. The bluetooth spec does not allow more than one * concurrent indication for a single peer, so this function will hold off on * sending such indications. */ static void ble_gatts_tx_notifications_one_chr(uint16_t chr_val_handle) { struct ble_gatts_clt_cfg *clt_cfg; struct ble_hs_conn *conn; uint16_t conn_handle; uint8_t att_op; int clt_cfg_idx; int i; /* Determine if notifications / indications are enabled for this * characteristic. */ clt_cfg_idx = ble_gatts_clt_cfg_find_idx(ble_gatts_clt_cfgs, chr_val_handle); if (clt_cfg_idx == -1) { return; } for (i = 0; ; i++) { ble_hs_lock(); conn = ble_hs_conn_find_by_idx(i); if (conn != NULL) { BLE_HS_DBG_ASSERT_EVAL(conn->bhc_gatt_svr.num_clt_cfgs > clt_cfg_idx); clt_cfg = conn->bhc_gatt_svr.clt_cfgs + clt_cfg_idx; BLE_HS_DBG_ASSERT_EVAL(clt_cfg->chr_val_handle == chr_val_handle); /* Determine what type of command should get sent, if any. */ att_op = ble_gatts_schedule_update(conn, clt_cfg); conn_handle = conn->bhc_handle; } else { /* Silence some spurious gcc warnings. */ att_op = 0; conn_handle = BLE_HS_CONN_HANDLE_NONE; } ble_hs_unlock(); if (conn == NULL) { /* No more connected devices. */ break; } switch (att_op) { case 0: break; case BLE_ATT_OP_NOTIFY_REQ: ble_gattc_notify(conn_handle, chr_val_handle); break; case BLE_ATT_OP_INDICATE_REQ: ble_gattc_indicate(conn_handle, chr_val_handle); break; default: BLE_HS_DBG_ASSERT(0); break; } } } /** * Sends all pending notifications and indications. The bluetooth spec does * not allow more than one concurrent indication for a single peer, so this * function will hold off on sending such indications. */ void ble_gatts_tx_notifications(void) { uint16_t chr_val_handle; int i; for (i = 0; i < ble_gatts_num_cfgable_chrs; i++) { chr_val_handle = ble_gatts_clt_cfgs[i].chr_val_handle; ble_gatts_tx_notifications_one_chr(chr_val_handle); } } void ble_gatts_bonding_established(uint16_t conn_handle) { struct ble_store_value_cccd cccd_value; struct ble_gatts_clt_cfg *clt_cfg; struct ble_gatts_conn *gatt_srv; struct ble_hs_conn *conn; int i; ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); BLE_HS_DBG_ASSERT(conn != NULL); BLE_HS_DBG_ASSERT(conn->bhc_sec_state.bonded); cccd_value.peer_addr = conn->bhc_peer_addr; cccd_value.peer_addr.type = ble_hs_misc_peer_addr_type_to_id(conn->bhc_peer_addr.type); gatt_srv = &conn->bhc_gatt_svr; for (i = 0; i < gatt_srv->num_clt_cfgs; ++i) { clt_cfg = &gatt_srv->clt_cfgs[i]; if (clt_cfg->flags != 0) { cccd_value.chr_val_handle = clt_cfg->chr_val_handle; cccd_value.flags = clt_cfg->flags; cccd_value.value_changed = 0; /* Store write use ble_hs_lock */ ble_hs_unlock(); ble_store_write_cccd(&cccd_value); ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); BLE_HS_DBG_ASSERT(conn != NULL); } } ble_hs_unlock(); } /** * Called when bonding has been restored via the encryption procedure. This * function: * o Restores persisted CCCD entries for the connected peer. * o Sends all pending notifications to the connected peer. * o Sends up to one pending indication to the connected peer; schedules * any remaining pending indications. */ void ble_gatts_bonding_restored(uint16_t conn_handle) { struct ble_store_value_cccd cccd_value; struct ble_store_key_cccd cccd_key; struct ble_gatts_clt_cfg *clt_cfg; struct ble_hs_conn *conn; uint8_t att_op; int rc; ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); BLE_HS_DBG_ASSERT(conn != NULL); BLE_HS_DBG_ASSERT(conn->bhc_sec_state.bonded); cccd_key.peer_addr = conn->bhc_peer_addr; cccd_key.peer_addr.type = ble_hs_misc_peer_addr_type_to_id(conn->bhc_peer_addr.type); cccd_key.chr_val_handle = 0; cccd_key.idx = 0; ble_hs_unlock(); while (1) { rc = ble_store_read_cccd(&cccd_key, &cccd_value); if (rc != 0) { break; } /* Assume no notification or indication will get sent. */ att_op = 0; ble_hs_lock(); conn = ble_hs_conn_find(conn_handle); BLE_HS_DBG_ASSERT(conn != NULL); clt_cfg = ble_gatts_clt_cfg_find(conn->bhc_gatt_svr.clt_cfgs, cccd_value.chr_val_handle); if (clt_cfg != NULL) { clt_cfg->flags = cccd_value.flags; if (cccd_value.value_changed) { /* The characteristic's value changed while the device was * disconnected or unbonded. Schedule the notification or * indication now. */ clt_cfg->flags |= BLE_GATTS_CLT_CFG_F_MODIFIED; att_op = ble_gatts_schedule_update(conn, clt_cfg); } } ble_hs_unlock(); /* Tell the application if the peer changed its subscription state * when it was restored from persistence. */ ble_gatts_subscribe_event(conn_handle, cccd_value.chr_val_handle, BLE_GAP_SUBSCRIBE_REASON_RESTORE, 0, cccd_value.flags); switch (att_op) { case 0: break; case BLE_ATT_OP_NOTIFY_REQ: rc = ble_gattc_notify(conn_handle, cccd_value.chr_val_handle); if (rc == 0) { cccd_value.value_changed = 0; ble_store_write_cccd(&cccd_value); } break; case BLE_ATT_OP_INDICATE_REQ: ble_gattc_indicate(conn_handle, cccd_value.chr_val_handle); break; default: BLE_HS_DBG_ASSERT(0); break; } cccd_key.idx++; } } static struct ble_gatts_svc_entry * ble_gatts_find_svc_entry(const ble_uuid_t *uuid) { struct ble_gatts_svc_entry *entry; int i; for (i = 0; i < ble_gatts_num_svc_entries; i++) { entry = ble_gatts_svc_entries + i; if (ble_uuid_cmp(uuid, entry->svc->uuid) == 0) { return entry; } } return NULL; } static int ble_gatts_find_svc_chr_attr(const ble_uuid_t *svc_uuid, const ble_uuid_t *chr_uuid, struct ble_gatts_svc_entry **out_svc_entry, struct ble_att_svr_entry **out_att_chr) { struct ble_gatts_svc_entry *svc_entry; struct ble_att_svr_entry *att_svc; struct ble_att_svr_entry *next; struct ble_att_svr_entry *cur; svc_entry = ble_gatts_find_svc_entry(svc_uuid); if (svc_entry == NULL) { return BLE_HS_ENOENT; } att_svc = ble_att_svr_find_by_handle(svc_entry->handle); if (att_svc == NULL) { return BLE_HS_EUNKNOWN; } cur = STAILQ_NEXT(att_svc, ha_next); while (1) { if (cur == NULL) { /* Reached end of attribute list without a match. */ return BLE_HS_ENOENT; } next = STAILQ_NEXT(cur, ha_next); if (cur->ha_handle_id == svc_entry->end_group_handle) { /* Reached end of service without a match. */ return BLE_HS_ENOENT; } if (ble_uuid_u16(cur->ha_uuid) == BLE_ATT_UUID_CHARACTERISTIC && next != NULL && ble_uuid_cmp(next->ha_uuid, chr_uuid) == 0) { if (out_svc_entry != NULL) { *out_svc_entry = svc_entry; } if (out_att_chr != NULL) { *out_att_chr = next; } return 0; } cur = next; } } int ble_gatts_find_svc(const ble_uuid_t *uuid, uint16_t *out_handle) { struct ble_gatts_svc_entry *entry; entry = ble_gatts_find_svc_entry(uuid); if (entry == NULL) { return BLE_HS_ENOENT; } if (out_handle != NULL) { *out_handle = entry->handle; } return 0; } int ble_gatts_find_chr(const ble_uuid_t *svc_uuid, const ble_uuid_t *chr_uuid, uint16_t *out_def_handle, uint16_t *out_val_handle) { struct ble_att_svr_entry *att_chr; int rc; rc = ble_gatts_find_svc_chr_attr(svc_uuid, chr_uuid, NULL, &att_chr); if (rc != 0) { return rc; } if (out_def_handle) { *out_def_handle = att_chr->ha_handle_id - 1; } if (out_val_handle) { *out_val_handle = att_chr->ha_handle_id; } return 0; } int ble_gatts_find_dsc(const ble_uuid_t *svc_uuid, const ble_uuid_t *chr_uuid, const ble_uuid_t *dsc_uuid, uint16_t *out_handle) { struct ble_gatts_svc_entry *svc_entry; struct ble_att_svr_entry *att_chr; struct ble_att_svr_entry *cur; uint16_t uuid16; int rc; rc = ble_gatts_find_svc_chr_attr(svc_uuid, chr_uuid, &svc_entry, &att_chr); if (rc != 0) { return rc; } cur = STAILQ_NEXT(att_chr, ha_next); while (1) { if (cur == NULL) { /* Reached end of attribute list without a match. */ return BLE_HS_ENOENT; } if (cur->ha_handle_id > svc_entry->end_group_handle) { /* Reached end of service without a match. */ return BLE_HS_ENOENT; } uuid16 = ble_uuid_u16(cur->ha_uuid); if (uuid16 == BLE_ATT_UUID_CHARACTERISTIC) { /* Reached end of characteristic without a match. */ return BLE_HS_ENOENT; } if (ble_uuid_cmp(cur->ha_uuid, dsc_uuid) == 0) { if (out_handle != NULL) { *out_handle = cur->ha_handle_id; return 0; } } cur = STAILQ_NEXT(cur, ha_next); } } int ble_gatts_add_svcs(const struct ble_gatt_svc_def *svcs) { void *p; int rc; ble_hs_lock(); if (!ble_gatts_mutable()) { rc = BLE_HS_EBUSY; goto done; } p = realloc(ble_gatts_svc_defs, (ble_gatts_num_svc_defs + 1) * sizeof *ble_gatts_svc_defs); if (p == NULL) { rc = BLE_HS_ENOMEM; goto done; } ble_gatts_svc_defs = p; ble_gatts_svc_defs[ble_gatts_num_svc_defs] = svcs; ble_gatts_num_svc_defs++; rc = 0; done: ble_hs_unlock(); return rc; } int ble_gatts_svc_set_visibility(uint16_t handle, int visible) { int i; for (i = 0; i < ble_gatts_num_svc_entries; i++) { struct ble_gatts_svc_entry *entry = &ble_gatts_svc_entries[i]; if (entry->handle == handle) { if (visible) { ble_att_svr_restore_range(entry->handle, entry->end_group_handle); } else { ble_att_svr_hide_range(entry->handle, entry->end_group_handle); } return 0; } } return BLE_HS_ENOENT; } /** * Accumulates counts of each resource type required by the specified service * definition array. This function is generally used to calculate some host * configuration values prior to initialization. This function adds the counts * to the appropriate fields in the supplied ble_gatt_resources object without * clearing them first, so it can be called repeatedly with different inputs to * calculate totals. Be sure to zero the resource struct prior to the first * call to this function. * * @param svcs The service array containing the resource * definitions to be counted. * @param res The resource counts are accumulated in this * struct. * * @return 0 on success; * BLE_HS_EINVAL if the svcs array contains an * invalid resource definition. */ static int ble_gatts_count_resources(const struct ble_gatt_svc_def *svcs, struct ble_gatt_resources *res) { const struct ble_gatt_svc_def *svc; const struct ble_gatt_chr_def *chr; int s; int i; int c; int d; for (s = 0; svcs[s].type != BLE_GATT_SVC_TYPE_END; s++) { svc = svcs + s; if (!ble_gatts_svc_is_sane(svc)) { BLE_HS_DBG_ASSERT(0); return BLE_HS_EINVAL; } /* Each service requires: * o 1 service * o 1 attribute */ res->svcs++; res->attrs++; if (svc->includes != NULL) { for (i = 0; svc->includes[i] != NULL; i++) { /* Each include requires: * o 1 include * o 1 attribute */ res->incs++; res->attrs++; } } if (svc->characteristics != NULL) { for (c = 0; svc->characteristics[c].uuid != NULL; c++) { chr = svc->characteristics + c; if (!ble_gatts_chr_is_sane(chr)) { BLE_HS_DBG_ASSERT(0); return BLE_HS_EINVAL; } /* Each characteristic requires: * o 1 characteristic * o 2 attributes */ res->chrs++; res->attrs += 2; /* If the characteristic permits notifications or indications, * it has a CCCD. */ if (chr->flags & BLE_GATT_CHR_F_NOTIFY || chr->flags & BLE_GATT_CHR_F_INDICATE) { /* Each CCCD requires: * o 1 descriptor * o 1 CCCD * o 1 attribute */ res->dscs++; res->cccds++; res->attrs++; } if (chr->descriptors != NULL) { for (d = 0; chr->descriptors[d].uuid != NULL; d++) { if (!ble_gatts_dsc_is_sane(chr->descriptors + d)) { BLE_HS_DBG_ASSERT(0); return BLE_HS_EINVAL; } /* Each descriptor requires: * o 1 descriptor * o 1 attribute */ res->dscs++; res->attrs++; } } } } } return 0; } int ble_gatts_count_cfg(const struct ble_gatt_svc_def *defs) { struct ble_gatt_resources res = { 0 }; int rc; rc = ble_gatts_count_resources(defs, &res); if (rc != 0) { return rc; } ble_hs_max_services += res.svcs; ble_hs_max_attrs += res.attrs; /* Reserve an extra CCCD for the cache. */ ble_hs_max_client_configs += res.cccds * (MYNEWT_VAL(BLE_MAX_CONNECTIONS) + 1); return 0; } void ble_gatts_lcl_svc_foreach(ble_gatt_svc_foreach_fn cb, void *arg) { int i; for (i = 0; i < ble_gatts_num_svc_entries; i++) { cb(ble_gatts_svc_entries[i].svc, ble_gatts_svc_entries[i].handle, ble_gatts_svc_entries[i].end_group_handle, arg); } } int ble_gatts_reset(void) { int rc; ble_hs_lock(); if (!ble_gatts_mutable()) { rc = BLE_HS_EBUSY; } else { /* Unregister all ATT attributes. */ ble_att_svr_reset(); ble_gatts_num_cfgable_chrs = 0; rc = 0; /* Note: gatts memory gets freed on next call to ble_gatts_start(). */ } ble_hs_unlock(); return rc; } int ble_gatts_init(void) { int rc; ble_gatts_num_cfgable_chrs = 0; ble_gatts_clt_cfgs = NULL; rc = stats_init_and_reg( STATS_HDR(ble_gatts_stats), STATS_SIZE_INIT_PARMS(ble_gatts_stats, STATS_SIZE_32), STATS_NAME_INIT_PARMS(ble_gatts_stats), "ble_gatts"); if (rc != 0) { return BLE_HS_EOS; } return 0; } |