Merge branch 'master' into write

Co-authored-by: River <97197236+River-b@users.noreply.github.com>

.gitignore

@@ -75,3 +75,4 @@ fabric.properties
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
+build/

CMakeLists.txt

@@ -49,6 +49,9 @@ elseif(UNIX AND NOT APPLE)
             ${CMAKE_SOURCE_DIR}/vendor/libserialport/linux_termios.c)
     target_compile_definitions(libblisp_obj PRIVATE
             LIBSERIALPORT_ATBUILD
+            HAVE_TERMIOS2_SPEED
+            HAVE_STRUCT_TERMIOS2
+            HAVE_DECL_BOTHER
             "SP_API=__attribute__((visibility(\"default\")))"
             "SP_PRIV=__attribute__((visibility(\"hidden\")))")
     write_file(${CMAKE_SOURCE_DIR}/vendor/libserialport/config.h "// bypass errors.")

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Marek Kraus <gamelaster@outlook.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

README.md

@@ -1,19 +1,33 @@
 # Bouffalo Labs ISP tool & library
 
-Tool and library for flashing their RISC-V MCUs.
+Open source tool and library for flashing Bouffalo RISC-V MCUs.
 
 **NOTE:** Library API and `blisp` tool cli arguments are not stable yet.
 
 # Supported MCUs
 
-- [X] `bl60x` - BL602 / BL604
-- [X] `bl70x` - BL702 / BL704 / BL706 
+- [x] `bl60x` - BL602 / BL604
+- [x] `bl70x` - BL702 / BL704 / BL706
 - [ ] `bl606p` - BL606P
 - [ ] `bl61x` - BL616 / BL618
 - [ ] `bl808` - BL808
 
+# Supported Devices
+- [X] [Pinecil V2](https://wiki.pine64.org/wiki/Pinecil)
+
 # Building
 
+## Clone repository
+
+If you have not cloned this repository locally; check out the git repository locally by running
+
+```bash
+git clone --recursive https://github.com/pine64/blisp.git
+cd blisp
+```
+
+## Build the library and command line utility
+
 For building `blisp` command line tool, use following commands:
 
 ```bash
@@ -27,7 +41,7 @@ cmake --build .
 For BL70X, BL61X, BL808 and BL606P, connected via USB, you can use following command, which will auto-detect serial port:
 
 ```bash
-blisp --chip bl70x --reset name_of_firmware.bin
+blisp write --chip bl70x --reset name_of_firmware.bin
 ```
 
 For BL60X, you need to specify also the serial port path:
@@ -36,6 +50,92 @@ For BL60X, you need to specify also the serial port path:
 blisp --chip bl60x --reset -p /dev/ttyUSB0 name_of_firmware.bin
 ```
 
+# Updating Pinecil V2: How to build BLISP Flasher
+
+_Note: This has been tested on x86-64. The build process also works on aarch64 and armv7._
+
+## Linux Steps
+
+⛔ Do not use the Pinecil DC barrel jack while updating firmware or you may destroy your PC. ⛔
+
+1. **Linux set-up**
+```
+git clone --recursive https://github.com/pine64/blisp.git
+cd blisp
+mkdir build && cd build
+cmake -DBLISP_BUILD_CLI=ON ..
+cmake --build .
+mkdir tools/blisp/data
+mkdir -p tools/blisp/data/bl70x
+```
+  Note: the blisp command will now be in build/tools/blisp/ folder and could later be run with flags as ` ./tools/blisp/blisp` unless you cd into that folder.
+
+2. Get and cp or mv eflash_loader_32m.bin  to  bl70x folder
+```
+/build/tools/blisp/data/bl70x/eflash_loader_32m.bin
+``` 
+   a. Download [eflash*32m.bin here](https://github.com/River-b/blisp/tree/master/eflash).
+   b. Move eflash*32m.bin to the build/tools/data/bl70x folder 
+   b. Move eflash*32m.bin to the folder  build/tools/data/bl70x 
+   c. If it is a Zip, then unzip & move it.
+```
+unzip eflash_loader_32m.zip -d tools/blisp/data/bl70x/
+```
+
+3. **Get V2 firmware** from Github Ralim's IronOS
+
+   a. Download the newest stable [firmware release here](https://github.com/Ralim/IronOS).
+
+   b. Or download the Beta firmware [IronOS here](https://github.com/Ralim/IronOS/actions/runs/3545583488)
+      Scroll to the very bottom of the page and download **Pinecilv2**. This link is to [beta that has BLE and also works for EPR chargers](https://github.com/Ralim/IronOS/actions/runs/3545583488)
+   
+   d. Extract **Pinecilv2.zip** and select a single language file (English = ```Pinecilv2_EN.bin```).
+   
+   e. Move the Pinecilv2_EN.bin (or selected language) into the same folder as the blisp command.
+```
+build/tools/blisp/Pinecilv2_EN.bin
+```
+can delete all the rest of the Pinecilv2**.zip as it is not needed.
+
+4. Connect Pinecil to PC/laptop: long hold [`-`]  , then connect cable. Can release the [-] after about 15-20second. V2 screen should be Empty/black,  if not, then repeat connection, or find another cable/port. Pinecil connects as a serial COM port.
+
+5. If this fails, see [troubleshooting below](https://github.com/River-b/blisp/blob/master/README.md#troubleshooting).
+
+6. If you are in  the folder  `blisp/build/tools/blisp/`   then execute 
+```
+sudo ./blisp write -c bl70x --reset Pinecilv2_EN.bin
+```
+Note: if a different language was selected, replace `Pinecilv2_**.bin` above with the chosen file name.
+
+7. Almost done: unplug from the PC and restart V2. Hold down the minus `(-)` button to see the new version number.
+
+8. Before making menu changes, it is recommended to first [Restore Settings to Default](https://github.com/Ralim/IronOS/blob/dev/Documentation/GettingStarted.md#settings-menu).
+   Simply go to Advanced settings > Restore default settings, confirm using the `(+)` button. This sets all menu items to defaults, keeps the same firmware version, and does not affect any Boot-up logo art if applicable. Setting  defaults first avoids unexpected behavior due to some changes in upgrades.
+   
+9. Congradulations, and [Stay Fluxey, my friends!](https://www.reddit.com/r/PINE64official/comments/xk9vxu/most_interesting_man_in_the_world_i_dont_always/?utm_source=share&utm_medium=web2x&context=3)
+
+## Troubleshooting
+1. If the Pinecil V2 fails to connect to the PC, check the `dmesg` command output.
+
+    a. try different cable: usb-C to C is recommended over Usb-A, especially if you are having issues.
+    
+    b. don't use a USB hub, directly connect to the USB port on the PC or laptop.
+    
+    c. try different Usb ports (usb-c recommended). Sometimes the rear ports on a PC are better because they are directly connected to the motherboard.
+    
+    d. try a different PC/laptop
+    
+2. It is important to hold down the `(-)` minus button _before_ plugging in the Usb-c cable, and do not release the button for another 15-20 seconds. Try to hold it a little longer before releasing if your computer is slow and it is not working. In rare circumstances on fussy USB ports, keep holding the `(-)` for the entire update.
+
+3. If all of this fails, then join one of the [Live Community Chat channels linked](https://wiki.pine64.org/wiki/Pinecil#Community_links) in the Pinecil Wiki as volunteers there might be able to help.
+
+4. Open a an new issue ticket in this Github/Blisp flasher at https://github.com/pine64/blisp/issues
+
+5. See [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil) for hardware information.
+
+6. See [Github Ralim's IronOS](https://ralim.github.io/IronOS/#getting-started) for firmware/software information. This is only the Flasher that loads the firmware; all Pinecil firmware documents and menu instructions are in IronOS.
+
+
 # To Do
 
 - [ ] Another code style

include/blisp.h

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #ifndef _LIBBLISP_H
 #define _LIBBLISP_H
 

include/blisp_chip.h

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #ifndef _BLISP_CHIP_H
 #define _BLISP_CHIP_H
 

include/blisp_util.h

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #ifndef _BLISP_UTIL_H
 #define _BLISP_UTIL_H
 

lib/blisp.c

@@ -1,9 +1,15 @@
+// SPDX-License-Identifier: MIT
 #include <blisp.h>
+#include <blisp_util.h>
 #include <libserialport.h>
 #include <malloc.h>
 #include <stdio.h>
 #include <string.h>
-#include <blisp_util.h>
+
+#ifdef __linux__
+#include <linux/serial.h>
+#include <sys/ioctl.h>
+#endif
 
 #define DEBUG
 
@@ -69,7 +75,20 @@ int32_t blisp_device_open(struct blisp_device* device, const char* port_name)
 //    } else {
         device->current_baud_rate = 500000;
 //    }
-    sp_set_baudrate(serial_port, device->current_baud_rate);
+
+#if 0
+    int fd;
+    sp_get_port_handle(serial_port, &fd);
+    struct serial_struct serial;
+    ioctl(fd, TIOCGSERIAL, &serial);
+//    serial.flags &= ~(ASYNC_LOW_LATENCY);
+    serial.flags |= ASYNC_LOW_LATENCY;
+    ioctl(fd, TIOCSSERIAL, &serial);
+#endif
+    ret = sp_set_baudrate(serial_port, device->current_baud_rate);
+    if (ret != SP_OK) {
+        return -1; // TODO: Handle this
+    }
     device->serial_port = serial_port;
 
     return 0;
@@ -106,7 +125,7 @@ int32_t blisp_receive_response(struct blisp_device* device, bool expect_payload)
     // TODO: Check checksum
     int ret;
     struct sp_port* serial_port = device->serial_port;
-    ret = sp_blocking_read(serial_port, &device->rx_buffer[0], 2, 500);
+    ret = sp_blocking_read(serial_port, &device->rx_buffer[0], 2, 1000);
     if (ret < 2) {
 #ifdef DEBUG
         fprintf(stderr, "Failed to receive response. (ret = %d)\n", ret);
@@ -146,14 +165,13 @@ blisp_device_handshake(struct blisp_device* device, bool in_ef_loader) {
         sp_set_dtr(serial_port, SP_DTR_OFF);
         sleep_ms(100);
         sp_set_rts(serial_port, SP_RTS_OFF);
+        sleep_ms(50); // Wait a bit so BootROM can init
     }
 
     uint32_t bytes_count = device->chip->handshake_byte_multiplier * (float)device->current_baud_rate / 10.0f;
     if (bytes_count > 600) bytes_count = 600;
     memset(handshake_buffer, 'U', bytes_count);
 
-//    sp_flush(serial_port, SP_BUF_BOTH);
-
     for (uint8_t i = 0; i < 5; i++) {
         if (!in_ef_loader) {
             if (device->is_usb) {
@@ -166,12 +184,16 @@ blisp_device_handshake(struct blisp_device* device, bool in_ef_loader) {
         if (ret < 0) {
             return -1;
         }
-        ret = sp_blocking_read(serial_port, device->rx_buffer, 20, 1000);
-        if (ret >= 2) {
-            for (uint8_t j = 0; j < (ret - 1); j++) {
-                if (device->rx_buffer[j] == 'O' && device->rx_buffer[j + 1] == 'K') {
-                    return 0;
+
+        if (!in_ef_loader && !device->is_usb) {
+            sp_drain(serial_port); // Wait for write to send all data
+            sp_flush(serial_port, SP_BUF_INPUT); // Flush garbage out of RX
         }
+
+        ret = sp_blocking_read(serial_port, device->rx_buffer, 2, 50);
+        if (ret >= 2) {
+            if (device->rx_buffer[0] == 'O' && device->rx_buffer[1] == 'K') {
+                return 0;
             }
         }
     }

lib/chip/blisp_chip_bl60x.c

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #include "blisp.h"
 
 struct blisp_chip blisp_chip_bl60x = {

lib/chip/blisp_chip_bl70x.c

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #include "blisp.h"
 
 struct blisp_chip blisp_chip_bl70x = {

tools/blisp/src/cmd.h

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #ifndef BLISP_CMD_H
 #define BLISP_CMD_H
 

tools/blisp/src/cmd/write.c

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #include "../cmd.h"
 #include "argtable3.h"
 #include <blisp.h>
@@ -25,13 +26,43 @@ static struct arg_lit* reset;
 static struct arg_end* end;
 static void* cmd_write_argtable[6];
 
+#ifdef __APPLE__
+// Ugh. This stuff is just so messy without C++17 or Qt...
+// These are not thread safe, but it doesn't place the responsibility
+// to free an allocated buffer on the caller.nn
+#include <string.h>
+#include <assert.h>
+#include <stdlib.h>
+
+static void get_executable_path(char* buffer_out, uint32_t max_size) {
+  assert (max_size >= PATH_MAX); // n.b. 1024 on MacOS. 4K on most Linux.
+
+  char raw_path_name[PATH_MAX];  // $HOME/../../var/tmp/x
+  char real_path_name[PATH_MAX]; // /var/tmp/x
+  uint32_t raw_path_size = sizeof(raw_path_name);
+
+  if(!_NSGetExecutablePath(raw_path_name, &raw_path_size)) {
+    realpath(raw_path_name, real_path_name);
+  }
+  // *real_path_name  is appropriately sized and null terminated.
+  strcpy(buffer_out, real_path_name);
+}
+#endif
+
 ssize_t
 get_binary_folder(char* buffer, uint32_t buffer_size) {
 #ifdef __linux__
-    readlink("/proc/self/exe", buffer, buffer_size); // TODO: Error handling
+    if (readlink("/proc/self/exe", buffer, buffer_size) <= 0) {
+        return -1;
+    }
+    char* pos = strrchr(buffer, '/');
+#elif defined(__APPLE__)
+  get_executable_path(buffer, buffer_size);
   char* pos = strrchr(buffer, '/');
 #else
-    GetModuleFileName(NULL, buffer, buffer_size);
+    if (GetModuleFileName(NULL, buffer, buffer_size) <= 0) {
+        return -1;
+    }
     char* pos = strrchr(buffer, '\\');
 #endif
     pos[0] = '\0';
@@ -251,12 +282,28 @@ void blisp_flash_firmware() {
 
     char exe_path[PATH_MAX];
     char eflash_loader_path[PATH_MAX];
-    get_binary_folder(exe_path, PATH_MAX); // TODO: Error handling
-    snprintf(eflash_loader_path, PATH_MAX, "%s/data/%s/eflash_loader_%s.bin", exe_path, device.chip->type_str, device.chip->default_eflash_loader_xtal);
-
-    eflash_loader_file = fopen(eflash_loader_path, "rb"); // TODO: Error handling
-    uint8_t eflash_loader_header[176]; // TODO: Remap it to the boot header struct
-    fread(eflash_loader_header, 176, 1, eflash_loader_file); // TODO: Error handling
+    if (get_binary_folder(exe_path, PATH_MAX) <= 0) {
+        fprintf(stderr, "Failed to find executable path to search for the "
+                        "eflash loader\n");
+        goto exit1;
+    }
+    snprintf(eflash_loader_path, PATH_MAX, "%s/data/%s/eflash_loader_%s.bin",
+             exe_path, device.chip->type_str,
+             device.chip->default_eflash_loader_xtal);
+    printf("Loading the eflash loader file from disk\n");
+    eflash_loader_file
+        = fopen(eflash_loader_path, "rb"); // TODO: Error handling
+    if (eflash_loader_file == NULL) {
+        fprintf(stderr,
+                "Could not open the eflash loader file from disk.\n"
+                "Does \"%s\" exist?\n",
+                eflash_loader_path);
+        goto exit1;
+    }
+    uint8_t
+        eflash_loader_header[176]; // TODO: Remap it to the boot header struct
+    fread(eflash_loader_header, 176, 1,
+          eflash_loader_file); // TODO: Error handling
 
     printf("Loading eflash_loader...\n");
     ret = blisp_device_load_boot_header(&device, eflash_loader_header);

tools/blisp/src/main.c

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 #include "argtable3.h"
 #include "cmd.h"
 #include <stdbool.h>