mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-03-02 04:13:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update links, use nav for newer mkdocs

Browse Source
This commit is contained in:
Matthias Ringwald 2021-03-07 16:53:42 +01:00
parent 1714068dcc
commit 3c7822d846
10 changed files with 15 additions and 15 deletions
chipset
README.md
doc/manual
markdown2mkdocs.pymarkdown2tex.pymkdocs-template.ymlmkdocs2html.py
port
windows-h4-da14585
README.md
windows-h4-zephyr
README.md
windows-h4
README.md
windows-winusb-intel
README.md
windows-winusb
README.md

8
chipset/README.md

@ -292,22 +292,22 @@ CC256xB | 0x1B90 | 6.7.16
CC256xC | 0x9a1a | 6.12.26
WL18xx | 0xac20 | 11.8.32
**SCO data:** Routing of SCO data can be configured with the [HCI_VS_Write_SCO_Configuration](http://processors.wiki.ti.com/index.php/CC256x_VS_HCI_Commands#HCI_VS_Write_SCO_Configuration_.280xFE10.29) command.
**SCO data:** Routing of SCO data can be configured with the `HCI_VS_Write_SCO_Configuration` command.
**Baud rate** can be set with [HCI_VS_Update_UART_HCI_Baudrate](http://processors.wiki.ti.com/index.php/CC256x_VS_HCI_Commands#HCI_VS_Update_UART_HCI_Baudrate_.280xFF36.29). The chipset confirms the change with a command complete event after which the local UART is set to the new speed. Oddly enough, the CC256x chipsets ignore the incoming CTS line during this particular command complete response.
**Baud rate** can be set with `HCI_VS_Update_UART_HCI_Baudrate`. The chipset confirms the change with a command complete event after which the local UART is set to the new speed. Oddly enough, the CC256x chipsets ignore the incoming CTS line during this particular command complete response.
If you've implemented the hal_uart_dma.h without an additional ring buffer (as recommended!) and you have a bit of delay, e.g. because of thread switching on a RTOS, this could cause a UART overrun.
If this happens, BTstack provides a workaround in the HCI H4 transport implementation by adding `ENABLE_CC256X_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND`.
If this is enabled, the H4 transport layer will resort to "deep packet inspection" to first check if its a TI controller and then wait for the HCI_VS_Update_UART_HCI_Baudrate.
When detected, it will tweak the next UART read to expect the HCI Command Complete event.
**BD Addr** can be set with [HCI_VS_Write_BD_Addr](2.2.1 HCI_VS_Write_BD_Addr (0xFC06)) although all chipsets have an official address stored.
**BD Addr** can be set with `HCI_VS_Write_BD_Addr` although all chipsets have an official address stored.
**Init Scripts.** In order to use the CC256x chipset an initialization script must be obtained and converted into a C file for use with BTstack. For newer revisions, TI provides a main.bts and a ble_add_on.bts that need to be combined.
The Makefile at *chipset/cc256x/Makefile.inc* is able to automatically download and convert the requested file. It does this by:
- Downloading one or more [BTS files](http://processors.wiki.ti.com/index.php/CC256x_Downloads) for your chipset.
- Downloading one or more `BTS files` for your chipset.
- Running the Python script:
<!-- -->

2
doc/manual/markdown2mkdocs.py

@ -75,7 +75,7 @@ def main(argv):
with open(yml_file, 'r') as yin:
doc = yaml.load(yin, Loader=yaml.SafeLoader)
for page in doc["pages"]:
for page in doc["nav"]:
mk_file = list(page.values())[0]
source_file = md_template +"/"+ mk_file
dest_file = md_final +"/"+ mk_file

2
doc/manual/markdown2tex.py

@ -61,7 +61,7 @@ def main(argv):
with open(mk_file, 'w') as aout:
with open(yml_file, 'r') as yin:
doc = yaml.load(yin, Loader=yaml.SafeLoader)
for page in doc["pages"]:
for page in doc["nav"]:
title = list(page.keys())[0]
md_file = list(page.values())[0]
with open(docs_folder +"/"+ md_file, 'r') as mdin:

2
doc/manual/mkdocs-template.yml

@ -3,7 +3,7 @@ site_dir: btstack
docs_dir: docs_final
extra_css: ['btstack.css']
use_directory_urls: false
pages:
nav:
- 'Welcome': index.md
- 'Quick Start': quick_start.md
- 'BTstack Architecture': architecture.md

6
doc/manual/mkdocs2html.py

@ -12,11 +12,11 @@ def writeCodeBlock(aout, code, references):
def main(argv):
html_path = "btstack/examples/examples/"
html_path = "btstack/examples/"
html_tmppath = html_path + "tmp/"
html_in = html_path + "index.html"
html_tmp = html_tmppath + "index.html"
html_in = html_path + "examples.html"
html_tmp = html_tmppath + "examples.html"
references = pickle.load(open( "tmp/references.p", "rb" ))
os.mkdir(html_tmppath)

2
port/windows-h4-da14585/README.md

@ -12,7 +12,7 @@ Tested with the official DA14585 Dev Kit Basic on OS X and Windows 10.
## Toolchain
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](mingw.org), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
We've used the Msys2 package available from the [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 64-bit start menu item to compile 64-bit binaries.

2
port/windows-h4-zephyr/README.md

@ -30,7 +30,7 @@ always start the examples with the correct `-u COMx` option.
## Toolchain
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](mingw.org), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
We've used the Msys2 package available from the [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 64-bit start menu item to compile 64-bit binaries.

2
port/windows-h4/README.md

@ -6,7 +6,7 @@ Make sure to manually reset the Bluetooth Controller before starting any of the
## Toolchain
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](mingw.org), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
We've used the Msys2 package available from the [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 64-bit start menu item to compile 64-bit binaries.

2
port/windows-winusb-intel/README.md

@ -18,7 +18,7 @@ It works like this:
## Toolchain
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](mingw.org), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
We've used the Msys2 package available from the [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 32-bit start menu item to compile 32-bit binaries that run on both 32/64-bit systems.

2
port/windows-winusb/README.md

@ -17,7 +17,7 @@ It works like this:
## Toolchain
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](mingw.org), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
The port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
We've used the Msys2 package available from the [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 64-bit start menu item to compile 64-bit binaries.