3rd-party: document third-party libraries and their license type

This commit is contained in:
Matthias Ringwald 2019-08-30 10:47:08 +02:00
parent 7846277fa5
commit ca8ea3f59e
2 changed files with 17 additions and 1 deletions

14
3rd-party/README.md vendored Normal file
View File

@ -0,0 +1,14 @@
# List of Third-Party Libaries
This folder contains all third-party libarires used by BTstack. The following table lists their source, license type, and what it is used for.
Library | License | Used | Notes
----------------------------------------------------------------------------------------------------------------|---------------|------------------|----------
[Android SBC Codec](https://android.googlesource.com/platform/external/bluetooth/bluedroid/+/master/embdrv/sbc) | Apache 2.0 | HFP WBS, A2DP | optimized audio codec
[hxcmod-player](https://github.com/jfdelnero/HxCModPlayer) | Custom | A2DP Source Demo | mod music player
[lwIP](http://savannah.nongnu.org/projects/lwip/) | BSD 3-Clause | PAN Demo | complete network stack
[md5](http://openwall.info/wiki/people/solar/software/public-domain-source-code/md5) | Public Domain | PBAP | cryptographic hash function
[micro-ecc](https://github.com/kmackay/micro-ecc) | BSD 2-Clause | LE SC, Mesh | elliptic curve library
[segger-rtt](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/) | BSD 3-Clause | HCI PacketLog | high-speed logging with SEGGER J-Link debug probes (development)
[tinydir](https://github.com/cxong/tinydir) | BSD 2-Clause | GAP Bonding | get a directory listing on POSIX + Windwows systems
[Yxml](https://dev.yorhel.nl/yxml) | MIT | PBAP | minimal stream XML parser

View File

@ -18,8 +18,11 @@ BTstack is free for non-commercial use. However, for commercial use, <a href="ma
**Documentation:** [HTML](http://bluekitchen-gmbh.com/btstack/develop/), [PDF](http://bluekitchen-gmbh.com/btstack_develop.pdf) **Documentation:** [HTML](http://bluekitchen-gmbh.com/btstack/develop/), [PDF](http://bluekitchen-gmbh.com/btstack_develop.pdf)
**Third-party libraries (FOSS):** [List of used libaries and their licenses](https://bluekitchen-gmbh.com/btstack/3rd-party/)
**Discussion and Community Support:** [BTstack Google Group](http://groups.google.com/group/btstack-dev) **Discussion and Community Support:** [BTstack Google Group](http://groups.google.com/group/btstack-dev)
### Supported Protocols and Profiles ### Supported Protocols and Profiles
**Protocols:** L2CAP (incl. LE Data Channels), RFCOMM, SDP, BNEP, AVDTP, AVCTP, ATT, SM (incl. LE Secure Connections). **Protocols:** L2CAP (incl. LE Data Channels), RFCOMM, SDP, BNEP, AVDTP, AVCTP, ATT, SM (incl. LE Secure Connections).
@ -33,7 +36,6 @@ BTstack is free for non-commercial use. However, for commercial use, <a href="ma
It has been qualified with the Bluetooth SIG (QDID 110883) for GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP profiles and It has been qualified with the Bluetooth SIG (QDID 110883) for GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP profiles and
GATT, SM of the Bluetooth 5 specification. For information on MFi/iAP2 support, please <a href="mailto:contact@bluekitchen-gmbh.com">contact us</a>. GATT, SM of the Bluetooth 5 specification. For information on MFi/iAP2 support, please <a href="mailto:contact@bluekitchen-gmbh.com">contact us</a>.
## Evaluation Platforms ## Evaluation Platforms
#### Embedded Platforms: #### Embedded Platforms: