From 1e11dd776a37a1a28c952cd885c0a14c4ee3dd34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Wed, 18 Jan 2023 17:55:58 +0100 Subject: [PATCH] [docs] Move resources to chip family docs --- SUMMARY.md | 22 +++---- docs/flashing/platformio.md | 2 +- docs/platform/beken-72xx/README.md | 23 ++++++-- docs/platform/beken-72xx/flashing.md | 5 ++ docs/platform/realtek-amb/README.md | 53 +++++++++++++++++ docs/platform/realtek-ambz/README.md | 46 +++++++++++++++ .../{realtek => realtek-ambz}/debugging.md | 0 .../exception-decoder.md | 0 docs/platform/realtek-ambz/flashing.md | 5 ++ docs/platform/realtek/README.md | 26 --------- docs/resources/SUMMARY.md | 2 + .../beken-flash.md} | 58 +------------------ docs/resources/documents.md | 20 +++++++ 13 files changed, 163 insertions(+), 99 deletions(-) create mode 100644 docs/platform/realtek-amb/README.md create mode 100644 docs/platform/realtek-ambz/README.md rename docs/platform/{realtek => realtek-ambz}/debugging.md (100%) rename docs/platform/{realtek => realtek-ambz}/exception-decoder.md (100%) delete mode 100644 docs/platform/realtek/README.md create mode 100644 docs/resources/SUMMARY.md rename docs/{resources.md => resources/beken-flash.md} (55%) create mode 100644 docs/resources/documents.md diff --git a/SUMMARY.md b/SUMMARY.md index 9cd6806..7badd4c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,19 +4,19 @@ * [📲 Flashing/dumping](docs/flashing/) * [💻 Supported boards & chips](docs/status/supported.md) * 📖 Reference + * Chip families + * [Beken BK72xx](docs/platform/beken-72xx/README.md) + * [Realtek Ameba - info](docs/platform/realtek-amb/README.md) + * [Realtek AmebaZ](docs/platform/realtek-ambz/README.md) + * [Debugging](docs/platform/realtek-ambz/debugging.md) + * [Exception decoder](docs/platform/realtek-ambz/exception-decoder.md) + * C library + * [Built-in functions](docs/platform/realtek-ambz/stdlib.md) + * [Memory management](docs/platform/realtek-ambz/memory-management.md) * [🔧 LT configuration](docs/reference/config.md) * [✔️ Implementation status](docs/status/arduino.md) * [🔌 Boards documentation](boards/) * [🔋 Examples](examples/) - * Chip families - * [Beken BK72xx](docs/platform/beken-72xx/README.md) - * Realtek AmebaZ Series - * [General info](docs/platform/realtek/README.md) - * [Debugging](docs/platform/realtek/debugging.md) - * [Exception decoder](docs/platform/realtek/exception-decoder.md) - * C library - * [Built-in functions](docs/platform/realtek-ambz/stdlib.md) - * [Memory management](docs/platform/realtek-ambz/memory-management.md) * [📖 LibreTuya API](docs/reference/lt-api.md) * [LT class reference](ltapi/class_libre_tuya.md) * [Common methods](ltapi/_libre_tuya_a_p_i_8h.md) @@ -54,5 +54,5 @@ * [✈️ OTA format](docs/ota/README.md) * [uf2ota.py tool](docs/ota/uf2ota.md) * [uf2ota.h library](docs/ota/library.md) -* [📓 TODO](TODO.md) -* [🔗 Resources](docs/resources.md) + * [📓 TODO](TODO.md) +* [🔗 Resources](docs/resources/) diff --git a/docs/flashing/platformio.md b/docs/flashing/platformio.md index c3f3763..09c561e 100644 --- a/docs/flashing/platformio.md +++ b/docs/flashing/platformio.md @@ -9,7 +9,7 @@ PlatformIO projects developed with LibreTuya can be flashed just like any other ## Built-in flasher -LibreTuya has a built-in firmware uploader, based on [ltchiptool](tool/ltchiptool.md). Pressing `Upload` in PlatformIO IDE does all the work for you. +LibreTuya has a built-in firmware uploader, based on [ltchiptool](tools/ltchiptool.md). Pressing `Upload` in PlatformIO IDE does all the work for you. If you have more than one COM port, configure your PIO project first: diff --git a/docs/platform/beken-72xx/README.md b/docs/platform/beken-72xx/README.md index e561ee9..cd8ef15 100644 --- a/docs/platform/beken-72xx/README.md +++ b/docs/platform/beken-72xx/README.md @@ -1,17 +1,32 @@ -# Beken 72xx - notes +# Beken 72xx + +## Resources + +Name | Notes +------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------- +[BK7231U Datasheet v0.71](https://cdn.discordapp.com/attachments/983843871320580096/1050461302537064508/BK7231Uv0.71.zh-CN.en.pdf) | Machine-translated to English +[BL2028N Datasheet v1.0](https://cdn.discordapp.com/attachments/983843871320580096/1050461346111697028/BL2028N_Datasheet_v1.0.pdf) | BL2028N is a "clone" of BK7231N +[BK72XX SDK User Manual 3.0.3](https://cdn.discordapp.com/attachments/983843871320580096/1003661237730672730/BK72XX_SDK_User_Manual-3.0.3.pdf) | Machine-translated to English +[BEKEN WiFi SDK API Reference 3.0.27](https://cdn.discordapp.com/attachments/983843871320580096/1003661237349003355/BEKEN_WiFi_SDK_API_Reference-3.0.27_compressed.pdf) | Machine-translated to English +[Beken SDK documentation (online)](http://docs.bekencorp.com/backup/v3.0/) | Not much here +[`encrypt v0.3` source code](https://github.com/ghsecuritylab/tysdk_for_bk7231/tree/master/toolchain/encrypt_crc) | +[`ota_tools` source code](https://github.com/tiancj/rtt_ota_tools) | Encryption routines and FPGA code used on the chip +[BK7231 OpenOCD debugging](https://www.elektroda.com/rtvforum/viewtopic.php?p=20028605#20028605) | From Elektroda.pl user `@xabean` + +## General info There are many chip variations in this SoC family: -- BK7231 +- BK7231 - marked BK7321QN40, so we're calling it "BK7231Q" to reduce confusion - BK7231T - BK7231N - BK7231S - BK7231U -The "officially existing" ones are BK7231, BK7231N and BK7231U. These are supported by Beken SDKs, such as `bdk_freertos`, although `bk7231s_alios_sdk` also existed at some point. +The "officially existing" ones are BK7231Q, BK7231N and BK7231U. These are supported by Beken SDKs, such as `bdk_freertos`, although `bk7231s_alios_sdk` also existed at some point. - BK7231N is substantially different than the other chips, so running T code on N (and vice versa) is not directly possible. -- BK7231 does not have eFuse. +- BK7231Q does not have eFuse. - there are some references to U meaning USB support - T seems to be exclusive to Tuya boards (that would explain the name); in the T SDK from Tuya, `CFG_SOC_NAME` is set to `SOC_BK7231U` - T's bootloader greets with `BK7231S_1.0.5` on UART diff --git a/docs/platform/beken-72xx/flashing.md b/docs/platform/beken-72xx/flashing.md index ea9ebf7..541c25a 100644 --- a/docs/platform/beken-72xx/flashing.md +++ b/docs/platform/beken-72xx/flashing.md @@ -1,5 +1,10 @@ # Download mode - Beken 72xx +
+ +[Read chip docs](README.md){ .md-button } +
+ Downloading is done using UART. For best experience, you should have two USB<->UART adapters plugged in: - One for flashing, preferably a real FT232RL or a good alternative. This connects to UART1 of the chip. diff --git a/docs/platform/realtek-amb/README.md b/docs/platform/realtek-amb/README.md new file mode 100644 index 0000000..4016d7e --- /dev/null +++ b/docs/platform/realtek-amb/README.md @@ -0,0 +1,53 @@ +# Realtek Ameba + +The logic behind naming of Realtek chips and their series took me some time to figure out: + +- RTL8xxxA - Ameba1/Ameba Series +- RTL8xxxB - [AmebaZ Series](../realtek-ambz/README.md) +- RTL8xxxC - AmebaZ2/ZII Series +- RTL8xxxCS - Ameba CS Series +- RTL8xxxD - AmebaD Series +- [Realtek product pages](https://www.realtek.com/en/products/communications-network-ics/category/802-11b-g-n) + +As such, there are numerous CPUs with the same numbers but different series. Different Ameba series are not compatible with each other, which makes them require different code and SDKs. + +
+ + [![Realtek Ameba Series table](https://media.discordapp.net/attachments/983843871320580096/986231890879066172/unknown.png){ height="500" }](https://media.discordapp.net/attachments/983843871320580096/986231890879066172/unknown.png) +
Ameba series comparison table
+
+ +## Table from [www.e-paper-display.com](https://www.e-paper-display.com/products_detail/productId%3D529.html) + +(modified a bit) + +Realtek P/N | Series | Protocol | CPU | Frequency | SRAM | UART | SPI | I2S | ADC/DAC +------------|-----------|----------------|--------|-----------|---------| -----|-----|-----|-------- +RTL8710BN | Ameba Z | WiFi | ARM M4 | 125M | 256KB | 1 | 1 | N | Y/N +RTL8710BX | Ameba Z | WiFi | ARM M4 | 62.5M | 256KB | 1 | 1 | N | Y/N +RTL8710CX | Ameba Zii | WiFi | ARM M4 | 100M | 256KB | 3 | 1 | N | N/N +RTL8710CM | Ameba Zii | WiFi | ARM M4 | 100M | 256K+4M | 3 | 1 | N | N/N +RTL8720CN | Ameba Zii | WiFi+BLE4.2 | ARM M4 | 100M | 256KB | 2 | 1 | N | N/N +RTL8720CF | Ameba Zii | WiFi+BLE4.2 | ARM M4 | 100M | 256KB | 2 | 1 | N | N/N +RTL8720CM | Ameba Zii | WiFi+BLE4.2 | ARM M4 | 100M | 256KB | 2 | 1 | N | N/N +RTL8720CS | Ameba CS | WiFi+BLE5 Mesh | M0+M4 | 200M | 512KB | 2 | 2 | Y | Y/Y +RTL8721CSM | Ameba CS | WiFi+BLE5 Mesh | M0+M4 | 200M | 512K+4M | 3 | 2 | Y | Y/Y +RTL8722CSM | Ameba CS | WiFi+BLE5 Mesh | M0+M4 | 200M | 512K+4M | 4 | 2 | Y | Y/Y +RTL8720DN | Ameba D | 2.4G+5G+BLE5 | M0+M4 | 200M | 512K | 2 | 1 | Y | Y/Y +RTL8721DM | Ameba D | 2.4G+5G+BLE5 | M0+M4 | 200M | 512K+4M | 3 | 2 | Y | Y/Y +RTL8722DM | Ameba D | 2.4G+5G+BLE5 | M0+M4 | 200M | 512K+4M | 4 | 2 | Y | Y/Y + +## Other chips + +- [RTL8195AM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8195am) +- RTL8710AF (found in amb1_arduino) +- [RTL8711AM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8711am) +- [RTL8710BN](https://www.realtek.com/en/products/communications-network-ics/item/rtl8710bn) +- RTL8710BX (found in Tuya product pages) +- RTL8710B? (found in amb1_sdk) +- RTL8711B? (found in amb1_sdk) +- [RTL8710CM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8710cm) +- RTL8722CSM (found in ambd_arduino) +- RTL8720DN (found in ambd_arduino) +- [RTL8721DM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8721dm) +- RTL8722DM (found in ambd_arduino) diff --git a/docs/platform/realtek-ambz/README.md b/docs/platform/realtek-ambz/README.md new file mode 100644 index 0000000..6d127fc --- /dev/null +++ b/docs/platform/realtek-ambz/README.md @@ -0,0 +1,46 @@ +# Realtek AmebaZ + +## Resources + +Name | Notes +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------ +[Realtek Ameba-Z datasheet v3.4](https://web.archive.org/web/20211203124711if_/https://adelectronicsru.files.wordpress.com/2018/10/um0114-realtek-ameba-z-data-sheet-v3-4.pdf) | +[Ameba1/AmebaZ SDK](https://github.com/ambiot/amb1_sdk) | + +## Realtek documents + +Code | Name +-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +  | From **amb1_sdk** +AN0004 | [Realtek low power wi-fi mp user guide](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0004%20Realtek%20low%20power%20wi-fi%20mp%20user%20guide.pdf) +AN0011 | [Realtek wlan simple configuration](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0011%20Realtek%20wlan%20simple%20configuration.pdf) +AN0012 | [Realtek secure socket layer(ssl)](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0012%20Realtek%20secure%20socket%20layer(ssl).pdf) +AN0025 | [Realtek at command](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0025%20Realtek%20at%20command.pdf) +AN0033 | [Realtek Ameba-1 over the air firmware update](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0033%20Realtek%20Ameba-1%20over%20the%20air%20firmware%20update.pdf) +AN0045 | [Realtek Ameba-1 power modes](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0045%20Realtek%20Ameba-1%20power%20modes.pdf) +AN0046 | [Realtek Ameba uart adapter](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0046%20Realtek%20Ameba%20uart%20adapter.pdf) +AN0060 | [Realtek UART update user manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0060%20Realtek%20UART%20update%20user%20manual.pdf) +AN0075 | [Realtek Ameba-all at command v2.0](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0075%20Realtek%20Ameba-all%20at%20command%20v2.0.pdf) +AN0096 | [Realtek xmodem UART update user manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0096%20Realtek%20xmodem%20UART%20update%20user%20manual.pdf) +AN0110 | [Realtek Ameba-Z over the air firmware update](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0110%20Realtek%20Ameba-Z%20over%20the%20air%20firmware%20update.pdf) +AN0111 | [Realtek Ameba-Z FreeRTOS tickless](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0111%20Realtek%20Ameba-Z%20FreeRTOS%20tickless.pdf) +UM0006 | [Realtek wificonf application programming interface](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0006%20Realtek%20wificonf%20application%20programming%20interface.pdf) +UM0014 | [Realtek web server user guide](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0014%20Realtek%20web%20server%20user%20guide.pdf) +UM0023 | [Realtek Ameba-1 build environment setup - iar](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0023%20Realtek%20Ameba-1%20build%20environment%20setup%20-%20iar.pdf) +UM0027 | [Realtek Ameba-1 crypto engine](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0027%20Realtek%20Ameba-1%20crypto%20engine.pdf) +UM0034 | [Realtek Ameba-1 memory layout](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0034%20Realtek%20Ameba-1%20memory%20layout.pdf) +UM0039 | [Realtek Ameba-1 SDK quick start](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0039%20Realtek%20Ameba-1%20SDK%20quick%20start.pdf) +UM0048 | [Realtek Ameba1 DEV 1v0 User Manual_1v8_20160328](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0048%20Realtek%20Ameba1%20DEV%201v0%20User%20Manual_1v8_20160328.pdf) +UM0060 | [Realtek Ameba-1 mqtt user guide](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0060%20Realtek%20Ameba-1%20mqtt%20user%20guide.pdf) +UM0096 | [Realtek Ameba build environment setup - gcc](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0096%20Realtek%20Ameba%20build%20environment%20setup%20-%20gcc.pdf) +UM0096 | [Realtek Ameba-1 build environment setup - gcc](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0096%20Realtek%20Ameba-1%20build%20environment%20setup%20-%20gcc.pdf) +UM0101 | [Realtek Ameba-1 peripheral developerment user manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0101%20Realtek%20Ameba-1%20peripheral%20developerment%20user%20manual.pdf) +UM0110 | [Realtek Ameba-Z build environment setup - iar](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0110%20Realtek%20Ameba-Z%20build%20environment%20setup%20-%20iar.pdf) +UM0111 | [Realtek Ameba-Z memory layout](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0111%20Realtek%20Ameba-Z%20memory%20layout.pdf) +UM0112 | [Realtek Ameba-Z SDK quick start](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0112%20Realtek%20Ameba-Z%20SDK%20quick%20start.pdf) +UM0113 | [Realtek Ameba-Z DEV 1v0 User Manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0113%20Realtek%20Ameba-Z%20DEV%201v0%20User%20Manual.pdf) +UM0115 | [Realtek Ameba-Z Introduction](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0115%20Realtek%20Ameba-Z%20Introduction.pdf) +UM0116 | [Realtek Ameba-Z SDK change](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0116%20Realtek%20Ameba-Z%20SDK%20change.pdf) +UM0120 | [Realtek Ameba-Z User Configuration](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0120%20Realtek%20Ameba-Z%20User%20Configuration.pdf) +UM0121 | [Realtek Ameba-Z suspend resume api](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0121%20Realtek%20Ameba-Z%20suspend%20resume%20api.pdf) +UM0123 | [Realtek Ameba-Z power modes](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0123%20Realtek%20Ameba-Z%20power%20modes.pdf) diff --git a/docs/platform/realtek/debugging.md b/docs/platform/realtek-ambz/debugging.md similarity index 100% rename from docs/platform/realtek/debugging.md rename to docs/platform/realtek-ambz/debugging.md diff --git a/docs/platform/realtek/exception-decoder.md b/docs/platform/realtek-ambz/exception-decoder.md similarity index 100% rename from docs/platform/realtek/exception-decoder.md rename to docs/platform/realtek-ambz/exception-decoder.md diff --git a/docs/platform/realtek-ambz/flashing.md b/docs/platform/realtek-ambz/flashing.md index 74358dd..ee90b37 100644 --- a/docs/platform/realtek-ambz/flashing.md +++ b/docs/platform/realtek-ambz/flashing.md @@ -1,5 +1,10 @@ # Download mode - Realtek AmebaZ +
+ +[Read chip docs](README.md){ .md-button } +
+ Downloading is done using UART2 (sometimes called Log_UART). Refer to your board documentation to find the correct pins. You need a good USB<->UART adapter (preferably a real FT232RL) for the process. **Read [Using ltchiptool](../../flashing/tools/ltchiptool.md) to learn the flashing procedure** diff --git a/docs/platform/realtek/README.md b/docs/platform/realtek/README.md deleted file mode 100644 index ade3901..0000000 --- a/docs/platform/realtek/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Realtek Ameba - notes - -The logic behind naming of Realtek chips and their series took me some time to figure out: - -- RTL8xxxA - Ameba1/Ameba Series -- RTL8xxxB - AmebaZ Series -- RTL8xxxC - AmebaZ2/ZII Series -- RTL8xxxD - AmebaD Series - -As such, there are numerous CPUs with the same numbers but different series, which makes them require different code and SDKs. - -- [RTL8195AM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8195am) -- RTL8710AF (found in amb1_arduino) -- [RTL8711AM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8711am) -- [RTL8710BN](https://www.realtek.com/en/products/communications-network-ics/item/rtl8710bn) -- RTL8710BX (found in Tuya product pages) -- RTL8710B? (found in amb1_sdk) -- RTL8711B? (found in amb1_sdk) -- [RTL8710CM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8710cm) -- RTL8722CSM (found in ambd_arduino) -- RTL8720DN (found in ambd_arduino) -- [RTL8721DM](https://www.realtek.com/en/products/communications-network-ics/item/rtl8721dm) -- RTL8722DM (found in ambd_arduino) -- and probably many more - -Different Ameba series are not compatible with each other. Apparently, there isn't an official public SDK for AmebaZ that can support C++ properly. diff --git a/docs/resources/SUMMARY.md b/docs/resources/SUMMARY.md new file mode 100644 index 0000000..ff57c8d --- /dev/null +++ b/docs/resources/SUMMARY.md @@ -0,0 +1,2 @@ +* [Documents](documents.md) +* [Beken Flash Chip List](beken-flash.md) diff --git a/docs/resources.md b/docs/resources/beken-flash.md similarity index 55% rename from docs/resources.md rename to docs/resources/beken-flash.md index c882f17..5305202 100644 --- a/docs/resources.md +++ b/docs/resources/beken-flash.md @@ -1,60 +1,4 @@ -# Resources - -## Realtek - -Code | Name --------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -  | From **amb1_sdk** -AN0004 | [Realtek low power wi-fi mp user guide](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0004%20Realtek%20low%20power%20wi-fi%20mp%20user%20guide.pdf) -AN0011 | [Realtek wlan simple configuration](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0011%20Realtek%20wlan%20simple%20configuration.pdf) -AN0012 | [Realtek secure socket layer(ssl)](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0012%20Realtek%20secure%20socket%20layer(ssl).pdf) -AN0025 | [Realtek at command](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0025%20Realtek%20at%20command.pdf) -AN0033 | [Realtek Ameba-1 over the air firmware update](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0033%20Realtek%20Ameba-1%20over%20the%20air%20firmware%20update.pdf) -AN0045 | [Realtek Ameba-1 power modes](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0045%20Realtek%20Ameba-1%20power%20modes.pdf) -AN0046 | [Realtek Ameba uart adapter](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0046%20Realtek%20Ameba%20uart%20adapter.pdf) -AN0060 | [Realtek UART update user manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0060%20Realtek%20UART%20update%20user%20manual.pdf) -AN0075 | [Realtek Ameba-all at command v2.0](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0075%20Realtek%20Ameba-all%20at%20command%20v2.0.pdf) -AN0096 | [Realtek xmodem UART update user manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0096%20Realtek%20xmodem%20UART%20update%20user%20manual.pdf) -AN0110 | [Realtek Ameba-Z over the air firmware update](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0110%20Realtek%20Ameba-Z%20over%20the%20air%20firmware%20update.pdf) -AN0111 | [Realtek Ameba-Z FreeRTOS tickless](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/AN0111%20Realtek%20Ameba-Z%20FreeRTOS%20tickless.pdf) -UM0006 | [Realtek wificonf application programming interface](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0006%20Realtek%20wificonf%20application%20programming%20interface.pdf) -UM0014 | [Realtek web server user guide](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0014%20Realtek%20web%20server%20user%20guide.pdf) -UM0023 | [Realtek Ameba-1 build environment setup - iar](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0023%20Realtek%20Ameba-1%20build%20environment%20setup%20-%20iar.pdf) -UM0027 | [Realtek Ameba-1 crypto engine](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0027%20Realtek%20Ameba-1%20crypto%20engine.pdf) -UM0034 | [Realtek Ameba-1 memory layout](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0034%20Realtek%20Ameba-1%20memory%20layout.pdf) -UM0039 | [Realtek Ameba-1 SDK quick start](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0039%20Realtek%20Ameba-1%20SDK%20quick%20start.pdf) -UM0048 | [Realtek Ameba1 DEV 1v0 User Manual_1v8_20160328](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0048%20Realtek%20Ameba1%20DEV%201v0%20User%20Manual_1v8_20160328.pdf) -UM0060 | [Realtek Ameba-1 mqtt user guide](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0060%20Realtek%20Ameba-1%20mqtt%20user%20guide.pdf) -UM0096 | [Realtek Ameba build environment setup - gcc](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0096%20Realtek%20Ameba%20build%20environment%20setup%20-%20gcc.pdf) -UM0096 | [Realtek Ameba-1 build environment setup - gcc](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0096%20Realtek%20Ameba-1%20build%20environment%20setup%20-%20gcc.pdf) -UM0101 | [Realtek Ameba-1 peripheral developerment user manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0101%20Realtek%20Ameba-1%20peripheral%20developerment%20user%20manual.pdf) -UM0110 | [Realtek Ameba-Z build environment setup - iar](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0110%20Realtek%20Ameba-Z%20build%20environment%20setup%20-%20iar.pdf) -UM0111 | [Realtek Ameba-Z memory layout](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0111%20Realtek%20Ameba-Z%20memory%20layout.pdf) -UM0112 | [Realtek Ameba-Z SDK quick start](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0112%20Realtek%20Ameba-Z%20SDK%20quick%20start.pdf) -UM0113 | [Realtek Ameba-Z DEV 1v0 User Manual](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0113%20Realtek%20Ameba-Z%20DEV%201v0%20User%20Manual.pdf) -UM0115 | [Realtek Ameba-Z Introduction](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0115%20Realtek%20Ameba-Z%20Introduction.pdf) -UM0116 | [Realtek Ameba-Z SDK change](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0116%20Realtek%20Ameba-Z%20SDK%20change.pdf) -UM0120 | [Realtek Ameba-Z User Configuration](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0120%20Realtek%20Ameba-Z%20User%20Configuration.pdf) -UM0121 | [Realtek Ameba-Z suspend resume api](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0121%20Realtek%20Ameba-Z%20suspend%20resume%20api.pdf) -UM0123 | [Realtek Ameba-Z power modes](https://raw.githubusercontent.com/ambiot/amb1_sdk/0c8da639b097f01c60e419405aecfafab1d08e43/doc/UM0123%20Realtek%20Ameba-Z%20power%20modes.pdf) -  | From **ambd_sdk** -AN0004 | [Realtek low power wi-fi mp user guide](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0004%20Realtek%20low%20power%20wi-fi%20mp%20user%20guide.pdf) -AN0011 | [Realtek wlan simple configuration](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0011%20Realtek%20wlan%20simple%20configuration.pdf) -AN0012 | [Realtek secure socket layer(ssl)](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0012%20Realtek%20secure%20socket%20layer(ssl).pdf) -AN0025 | [Realtek at command](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0025%20Realtek%20at%20command.pdf) -AN0075 | [Realtek Ameba-all at command v2.0](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0075%20Realtek%20Ameba-all%20at%20command%20v2.0.pdf) -AN0096 | [Realtek Ameba-all xmodem uart update firmware](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0096%20Realtek%20Ameba-all%20xmodem%20uart%20update%20firmware.pdf) -AN0400 | [Ameba-D Application Note](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0400%20Ameba-D%20Application%20Note.pdf) -UM0150 | [Realtek Ameba CoAP User Guide](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/UM0150%20Realtek%20Ameba%20CoAP%20User%20Guide.pdf) -UM0201 | [Ameba Common BT Application User Manual EN](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/UM0201%20Ameba%20Common%20BT%20Application%20User%20Manual%20EN.pdf) -  | Found elsewhere -AN0400 | [Ameba-D Application Note_v3_watermark](https://files.seeedstudio.com/products/102110419/Basic%20documents/AN0400%20Ameba-D%20Application%20Note_v3_watermark.pdf) -AN0500 | [Realtek Ameba-ZII application note](https://www.e-paper-display.com/99IOT/00015797-AN0500-Realtek-Ameba-ZII-application-note.en_233850.pdf) -  | [Realtek Ameba-ZII datasheet v0.8](https://www.e-paper-display.com/Ameba-Z_II_DataSheet_v0r8_RTL8720Cx_20190424%29.pdf) -UM0114 | [Realtek Ameba-Z datasheet v3.4](https://web.archive.org/web/20211203124711if_/https://adelectronicsru.files.wordpress.com/2018/10/um0114-realtek-ameba-z-data-sheet-v3-4.pdf) -  | [Product pages / realtek.com](https://www.realtek.com/en/products/communications-network-ics/category/802-11b-g-n) - -## Beken Flash Chip List +# Beken Flash Chip List | Chip ID | Location | Manufacturer | Device | Size | SR Size | Line Mode | CMP Post | Protect Post | Protect Mask | Protect All | Protect None | Protect Half | Unprotect Last Block | QE Bit Post | QE Bit | M Value | Mode Sel | Unprotect | Protect | cwMsk | sb | lb | SR Read | SR Write | |------------|----------|--------------|-----------|---------|---------|-----------|----------|--------------|--------------|-------------|--------------|--------------|----------------------|-------------|--------|---------|----------|-----------|---------|--------------------------|----|----|---------|----------| diff --git a/docs/resources/documents.md b/docs/resources/documents.md new file mode 100644 index 0000000..16dd7d5 --- /dev/null +++ b/docs/resources/documents.md @@ -0,0 +1,20 @@ +# Documents + +## Realtek + +Code | Name +-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +  | From **ambd_sdk** +AN0004 | [Realtek low power wi-fi mp user guide](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0004%20Realtek%20low%20power%20wi-fi%20mp%20user%20guide.pdf) +AN0011 | [Realtek wlan simple configuration](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0011%20Realtek%20wlan%20simple%20configuration.pdf) +AN0012 | [Realtek secure socket layer(ssl)](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0012%20Realtek%20secure%20socket%20layer(ssl).pdf) +AN0025 | [Realtek at command](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0025%20Realtek%20at%20command.pdf) +AN0075 | [Realtek Ameba-all at command v2.0](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0075%20Realtek%20Ameba-all%20at%20command%20v2.0.pdf) +AN0096 | [Realtek Ameba-all xmodem uart update firmware](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0096%20Realtek%20Ameba-all%20xmodem%20uart%20update%20firmware.pdf) +AN0400 | [Ameba-D Application Note](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/AN0400%20Ameba-D%20Application%20Note.pdf) +UM0150 | [Realtek Ameba CoAP User Guide](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/UM0150%20Realtek%20Ameba%20CoAP%20User%20Guide.pdf) +UM0201 | [Ameba Common BT Application User Manual EN](https://raw.githubusercontent.com/ambiot/ambd_sdk/12dab4363fd0087eb4874461f8d3f6094110595f/doc/UM0201%20Ameba%20Common%20BT%20Application%20User%20Manual%20EN.pdf) +  | Found elsewhere +AN0400 | [Ameba-D Application Note_v3_watermark](https://files.seeedstudio.com/products/102110419/Basic%20documents/AN0400%20Ameba-D%20Application%20Note_v3_watermark.pdf) +AN0500 | [Realtek Ameba-ZII application note](https://www.e-paper-display.com/99IOT/00015797-AN0500-Realtek-Ameba-ZII-application-note.en_233850.pdf) +  | [Realtek Ameba-ZII datasheet v0.8](https://www.e-paper-display.com/Ameba-Z_II_DataSheet_v0r8_RTL8720Cx_20190424%29.pdf)