Merge branch 'dev' into dev

1 files changed, 23 insertions, 1 deletions

diff --git a/Documentation/Logo.md b/Documentation/Logo.md
index 9734fda3..a4947091 100644
--- a/Documentation/Logo.md
+++ b/Documentation/Logo.md
@@ -38,7 +38,7 @@ The model should be replaced by one of the following options:
 - `miniware` for older Miniware Irons -> TS100, TS80, TS80P
 - `pinecilv1` for the Pinecil V1
 - `pinecilv2` for the Pinecil V2
-- `ts101` for the Miniware TS101 [^1]
+- `ts101` for the Miniware TS101 [^1] [^2]
 - `s60` for the Squire S60 [^1]
 - `mhp30` for the Miniware MHP30
 
@@ -50,6 +50,28 @@ After processing its expected to have a `.hex` and `.dfu` file created to be use
 Note: make sure your image file is in the same folder as script files (img2logo.py, output_dfu.py, output_hex.py).
 
 [^1] Note that these devices have larger resolution screens that the logo system supports right now. Fixes are coming for this soon, roughly scheduled for 2.23.
+[^2] The TS101 requires extra steps, see below.
+
+### TS101 Quirks
+
+When Miniware designed the TS101 they cut cost by using an STM32 clone with some odd quirks. They also re-wrote their USB bootloader, which has introduced new bugs for us to deal with.
+Their bootloader appears to have kept the existing limit of not being able to flash small hex files, but they no longer fall for the older "just repeat the content" trick and instead reject the file.
+Additionally, while the MCU in use has 128K of flash, their bootloader (at least for me) fails to write to anything above 99K. It _looks_ like a watchdog reset or hard crash. Unsure.
+
+This has flow on effects, where the settings can still be located in the upper ~28K of flash, but it cant be used for anything we flash over USB.
+Of that 100K we can use, they waste 32K of it for their bootloader (Old bootloaders were 16K).
+This means the main "app" of IronOS is limited to around 67K (100K-32K for bootloader, -1K for logo).
+
+For this device the Logo is not located at the end of flash but instead at the last writable page (99K).
+
+Additionally, as we need to do a large write, to avoid having to waste more flash space; the logo is merged with the normal firmware. This means that the firmware and logo are flashed together once.
+Future updates can be done without merging as it will leave the logo data there as normal firmware doesnt touch that area of flash.
+
+To do this, download the latest version of IronOS and merge it with the logo using the `--merge` command line argument.
+
+To create the logo file for a TS101 the full command looks like `python3 img2logo.py <image file path> <output folder path> -m ts101 --merge <Path to main firmware>`.
+
+For this reason, there are no TS101 logo's generated by the IronOS-Meta repo.
 
 ## Flashing the Logo