Unify uploaded artefact names

changed icon colors

.github/workflows/build.yml

@@ -0,0 +1,141 @@
+name: Build
+on: [push, pull_request]
+
+jobs:
+  build-windows:
+    runs-on: windows-2022
+    defaults:
+      run:
+        shell: cmd
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - uses: lukka/get-cmake@latest
+      - name: Build blisp tool
+        run: |
+          mkdir build
+          cd build
+          cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
+          cmake --build . --config Release
+      - name: Upload results
+        uses: actions/upload-artifact@v3
+        with:
+          name: blips-windows-x86_64.zip
+          path: |
+            build/tools/blisp/Release/blisp.exe
+          if-no-files-found: error
+
+  build-macos:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - uses: lukka/get-cmake@latest
+      - name: Build blisp tool
+        run: |
+          mkdir build
+          cd build
+          cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
+          cmake --build .
+      - name: Upload results
+        uses: actions/upload-artifact@v3
+        with:
+          name: blips-apple-x86_64.zip
+          path: |
+            build/tools/blisp/blisp
+          if-no-files-found: error
+
+  build-linux:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - uses: lukka/get-cmake@latest
+      - name: Build blisp tool
+        run: |
+          mkdir build
+          cd build
+          cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
+          cmake --build .
+      - name: Upload results
+        uses: actions/upload-artifact@v3
+        with:
+          name: blips-linux-x86_64.zip
+          path: |
+            build/tools/blisp/blisp
+          if-no-files-found: error 
+
+  build-linux-alternative-arch:
+    runs-on: ubuntu-latest
+    name: Build on ${{ matrix.distro }} ${{ matrix.arch }}
+
+    # Run steps on a matrix of 4 arch/distro combinations
+    strategy:
+      matrix:
+        include:
+          - arch: aarch64
+            distro: ubuntu_latest
+          - arch: armv7
+            distro: ubuntu_latest
+          - arch: riscv64
+            distro: ubuntu_latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - uses: uraimo/run-on-arch-action@v2
+        name: Build artifact
+        id: build
+        with:
+          arch: ${{ matrix.arch }}
+          distro: ${{ matrix.distro }}
+
+          # Create an artifacts directory
+          setup: |
+            mkdir -p "${PWD}/artifacts"
+
+          # Mount the artifacts directory as /artifacts in the container
+          dockerRunArgs: |
+            --volume "${PWD}/artifacts:/artifacts"
+
+          # Pass some environment variables to the container
+          env: | # YAML, but pipe character is necessary
+            artifact_name: blisp-linux-${{ matrix.arch }}
+
+          # The shell to run commands with in the container
+          shell: /bin/sh
+
+          # Install some dependencies in the container. This speeds up builds if
+          # you are also using githubToken. Any dependencies installed here will
+          # be part of the container image that gets cached, so subsequent
+          # builds don't have to re-install them. The image layer is cached
+          # publicly in your project's package repository, so it is vital that
+          # no secrets are present in the container state or logs.
+          install: |
+            case "${{ matrix.distro }}" in
+              ubuntu*|jessie|stretch|buster|bullseye)
+                apt-get update -q -y
+                apt-get install -q -y git cmake build-essential
+                ;;
+            esac
+
+          # Produce a binary artifact and place it in the mounted volume
+          run: |
+            git config --global --add safe.directory /home/runner/work/blisp/blisp
+            mkdir build
+            cd build
+            cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
+            cmake --build . -j2
+            cp ./tools/blisp/blisp "/artifacts/${artifact_name}"
+            echo "Produced artifact at /artifacts/${artifact_name}"
+
+      - name: Upload results
+        uses: actions/upload-artifact@v3
+        with:
+          name: blisp-linux-${{ matrix.arch }}.zip
+          path: |
+            artifacts/blisp-*
+          if-no-files-found: error 

CMakeLists.txt

@@ -20,30 +20,33 @@ add_library(libblisp_static STATIC $<TARGET_OBJECTS:libblisp_obj>)
 
 set_target_properties(libblisp PROPERTIES
         PUBLIC_HEADER "include/blisp.h"
-        VERSION 0.0.1
+        VERSION 0.0.3
         SOVERSION 1
         LIBRARY_OUTPUT_DIRECTORY "shared"
         OUTPUT_NAME "blisp")
 
 set_target_properties(libblisp_static PROPERTIES
         PUBLIC_HEADER "include/blisp.h"
-        VERSION 0.0.1
-        SOVERSION 2
+        VERSION 0.0.3
+        SOVERSION 1
         ARCHIVE_OUTPUT_DIRECTORY "static"
         OUTPUT_NAME "blisp")
 
+if(NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
 target_sources(libblisp_obj PRIVATE
         ${CMAKE_SOURCE_DIR}/vendor/libserialport/serialport.c
         ${CMAKE_SOURCE_DIR}/vendor/libserialport/timing.c)
 
 target_include_directories(libblisp_obj PRIVATE ${CMAKE_SOURCE_DIR}/vendor/libserialport)
+endif()
 
 if(WIN32)
-    target_link_libraries(libblisp_obj PRIVATE Setupapi.lib)
+    target_link_libraries(libblisp PRIVATE Setupapi.lib)
+    target_link_libraries(libblisp_static PRIVATE Setupapi.lib)
     target_compile_definitions(libblisp_obj PRIVATE LIBSERIALPORT_MSBUILD)
     target_sources(libblisp_obj PRIVATE
             ${CMAKE_SOURCE_DIR}/vendor/libserialport/windows.c)
-elseif(UNIX AND NOT APPLE)
+elseif(UNIX AND NOT APPLE AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
     target_sources(libblisp_obj PRIVATE
             ${CMAKE_SOURCE_DIR}/vendor/libserialport/linux.c
             ${CMAKE_SOURCE_DIR}/vendor/libserialport/linux_termios.c)
@@ -55,6 +58,10 @@ elseif(UNIX AND NOT APPLE)
             "SP_API=__attribute__((visibility(\"default\")))"
             "SP_PRIV=__attribute__((visibility(\"hidden\")))")
     write_file(${CMAKE_SOURCE_DIR}/vendor/libserialport/config.h "// bypass errors.")
+elseif(UNIX AND ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
+    target_include_directories(libblisp_obj PRIVATE /usr/local/include/)
+    target_link_libraries(libblisp PRIVATE -L/usr/local/lib usb serialport)
+    target_link_libraries(libblisp_static PRIVATE -L/usr/local/lib usb serialport)
 elseif(APPLE)
     target_sources(libblisp_obj PRIVATE
             ${CMAKE_SOURCE_DIR}/vendor/libserialport/macosx.c)

README.md

@@ -1,34 +1,51 @@
-# Bouffalo Labs ISP tool & library
+[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fpine64%2Fblisp&count_bg=%235791AC&title_bg=%23555555&icon=airplayaudio.svg&icon_color=%23D2D9DD&title=hits&edge_flat=false)](https://github.com/pine64/blisp/wiki/Update-Pinecil-V2)
+[![GitHub all downloads](https://img.shields.io/github/downloads/pine64/blisp/total?color=5791ac&logo=docusign&logoColor=white)](https://github.com/pine64/blisp/releases/tag/v0.0.3)
+[![Discord](https://img.shields.io/discord/463237927984693259?color=5791ac&logo=discord&logoColor=white)](https://discord.com/invite/pine64)
+[![GitHub release](https://img.shields.io/github/v/release/pine64/blisp?color=5791ac)](https://github.com/pine64/blisp/releases/tag/v0.0.3)
 
-Open source tool and library for flashing Bouffalo RISC-V MCUs.
+<img src="./img/Gradient-white-blue-03.png" align="left" width="60" > <br clear="left" />
+# BLISP 
+
+Bouffalo Labs ISP (in-system-programming) tool & library: an open source tool to flash Bouffalo RISC-V MCUs.
 
 **NOTE:** Library API and `blisp` tool cli arguments are not stable yet.
+<br>
 
-# Supported MCUs
-
-- [x] `bl60x` - BL602 / BL604
+## Supported MCUs
+- [x] `bl60x` - BL602 / BL604 / TG7100C / LF686 / LF688
 - [x] `bl70x` - BL702 / BL704 / BL706
-- [ ] `bl606p` - BL606P
-- [ ] `bl61x` - BL616 / BL618
-- [ ] `bl808` - BL808
+<br>
 
-# Supported OS
-- [x] Windows
-- [x] Linux
-- [ ] Apple (WIP: work-in-progress)
+## Supported Devices 
+ | System  | <img width="15" src="https://cdn.simpleicons.org/Windows11/5791ac" /> Windows | <img width="15" src="https://cdn.simpleicons.org/Apple/5791ac" /> MacOS| <img width="17" src="https://cdn.simpleicons.org/Linux/5791ac" /> Linux| <img width="15" src="https://cdn.simpleicons.org/Freebsd/5791ac" /> FreeBSD |
+ | :-----: | :------: | :------: | :------: | :------: |
+ | Pinecil V2  |<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />|<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />| <img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />| <img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" /> |
+ | Pinecone  |<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />|<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />|<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />| <img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" /> |
+ <br>
+ 
+## How to update Pinecil V2
 
-# Building
+Download the newest release of [Blisp updater here](https://github.com/pine64/blisp/releases/).
 
-## Clone repository
+Check out the [wiki page](https://github.com/pine64/blisp/wiki/Update-Pinecil-V2) for install instructions.
+<br><br>
+
+## Building from code
+
+### Clone repository
 
 If you have not cloned this repository locally; clone the git repository locally by running
 
 ```bash
 git clone --recursive https://github.com/pine64/blisp.git
 cd blisp
+git submodule update --init --recursive
 ```
 
-## Build the library and command line utility
+If vendor/argtable3 and vendor/libserialport/ are empty, this last step has
+failed and should be investigated.
+
+### Build the library and command line utility
 
 For building `blisp` command line tool, use following commands:
 
@@ -37,21 +54,33 @@ mkdir build && cd build
 cmake -DBLISP_BUILD_CLI=ON ..
 cmake --build .
 ```
+#### Need more build details? [See here](https://github.com/pine64/blisp/wiki/Update-Pinecil-V2#build-blisp-flasher-from-code).
 
-# Usage
+## Usage
 
-For BL70X, BL61X, BL808 and BL606P, connected via USB, you can use following command, which will auto-detect serial port:
+For BL70X, BL61X, BL808 and BL606P, connected via USB, you can use following command, which will auto-detect serial port on Windows:
 
 ```bash
-blisp write --chip bl70x --reset name_of_firmware.bin
+.\blisp.exe write --chip=bl70x --reset .\name_of_firmware.bin
+or
+.\blisp.exe write -c bl70x --reset .\name_of_firmware.bin
 ```
 
 For BL60X, you need to specify also the serial port path:
 
 ```bash
-blisp --chip bl60x --reset -p /dev/ttyUSB0 name_of_firmware.bin
+blisp write --chip bl60x --reset -p /dev/ttyUSB0 name_of_firmware.bin
 ```
 
-# How to flash Pinecil V2
+If you wish to see additional debugging, set the environmental
+variable LIBSERIALPORT_DEBUG before running. You can either export this
+in your shell or change it for a single run via
 
-Check out the [wiki page](https://github.com/pine64/blisp/wiki/Update-Pinecil-V2).
+```bash
+  LIBSERIALPORT_DEBUG=y ./a.out write -c bl70x -p /dev/tty.usbmodem0000000200001
+```
+
+Because this is done at the lowest level of serial communication, the
+displays aren't packet-aware or know about the chip's command set or such.
+This is really only useful for debugging systems-level issues withing
+the device or blisp itself.

lib/blisp.c

@@ -13,6 +13,12 @@
 
 #define DEBUG
 
+static void drain(struct sp_port* port) {
+#if defined(__APPLE__) || defined(__FreeBSD__)
+    sp_drain(port);
+#endif
+}
+
 int32_t blisp_device_init(struct blisp_device* device,
                           struct blisp_chip* chip) {
   device->chip = chip;
@@ -73,13 +79,13 @@ int32_t blisp_device_open(struct blisp_device* device, const char* port_name) {
   sp_set_stopbits(serial_port, 1);
   sp_set_flowcontrol(serial_port, SP_FLOWCONTROL_NONE);
 
-  uint32_t vid, pid;
+  int vid, pid;
   sp_get_port_usb_vid_pid(serial_port, &vid, &pid);
   device->is_usb = pid == 0xFFFF;
   //  if (device->is_usb) {
   //    device->current_baud_rate = 2000000;
   //  } else {
-  device->current_baud_rate = 500000;
+  device->current_baud_rate = 460800;
   //  }
 
 #if 0
@@ -130,6 +136,8 @@ int32_t blisp_send_command(struct blisp_device* device,
     blisp_dlog("Received error or not written all data: %d", ret);
     return BLISP_ERR_UNKNOWN;
   }
+  drain(serial_port);
+
   return BLISP_OK;
 }
 
@@ -191,9 +199,12 @@ int32_t blisp_device_handshake(struct blisp_device* device, bool in_ef_loader) {
     if (!in_ef_loader) {
       if (device->is_usb) {
         sp_blocking_write(serial_port, "BOUFFALOLAB5555RESET\0\0", 22, 100);
+        drain(serial_port);
       }
     }
     ret = sp_blocking_write(serial_port, handshake_buffer, bytes_count, 500);
+	// not sure about Apple part, but FreeBSD needs it
+	drain(serial_port);
     if (ret < 0) {
       blisp_dlog("Handshake write failed, ret %d", ret);
       return BLISP_ERR_UNKNOWN;
@@ -210,6 +221,7 @@ int32_t blisp_device_handshake(struct blisp_device* device, bool in_ef_loader) {
         return BLISP_OK;
       }
     }
+
   }
   blisp_dlog("Received no response from chip.");
   return BLISP_ERR_NO_RESPONSE;

lib/blisp_easy.c

@@ -24,6 +24,8 @@ static int64_t blisp_easy_transport_size(struct blisp_easy_transport* transport)
     return transport->data.memory.data_size;
   } else {
     // TODO: Implement
+	  printf("%s() Warning: calling non-implemented function\n", __func__);
+	  return -1;
   }
 }
 
@@ -57,17 +59,27 @@ int32_t blisp_easy_load_segment_data(
     struct blisp_easy_transport* segment_transport,
     blisp_easy_progress_callback progress_callback) {
   int32_t ret;
+#ifdef __APPLE__
+  const uint16_t buffer_max_size = 252 * 16;
+#else
+  const uint16_t buffer_max_size = 4092;
+#endif
+
 
   uint32_t sent_data = 0;
   uint32_t buffer_size = 0;
+#ifdef _WIN32
   uint8_t buffer[4092];
+#else
+  uint8_t buffer[buffer_max_size];
+#endif
 
   blisp_easy_report_progress(progress_callback, 0, segment_size);
 
   while (sent_data < segment_size) {
     buffer_size = segment_size - sent_data;
-    if (buffer_size > 4092) {
-      buffer_size = 4092;
+    if (buffer_size > buffer_max_size) {
+      buffer_size = buffer_max_size;
     }
     blisp_easy_transport_read(segment_transport, buffer,
                               buffer_size);  // TODO: Error Handling
@@ -319,15 +331,25 @@ int32_t blisp_easy_flash_write(struct blisp_device* device,
                                uint32_t data_size,
                                blisp_easy_progress_callback progress_callback) {
   int32_t ret;
+#if defined (__APPLE__) || defined (__FreeBSD__)
+  const uint16_t buffer_max_size = 372 * 1;
+#else
+  const uint16_t buffer_max_size = 2052;
+#endif
+
   uint32_t sent_data = 0;
   uint32_t buffer_size = 0;
-  uint8_t buffer[8184];
+#ifdef _WIN32
+  uint8_t buffer[2052];
+#else
+  uint8_t buffer[buffer_max_size];
+#endif
   blisp_easy_report_progress(progress_callback, 0, data_size);
 
   while (sent_data < data_size) {
     buffer_size = data_size - sent_data;
-    if (buffer_size > 2052) {
-      buffer_size = 2052;
+    if (buffer_size > buffer_max_size) {
+      buffer_size = buffer_max_size;
     }
     blisp_easy_transport_read(data_transport, buffer,
                               buffer_size);  // TODO: Error Handling

lib/chip/blisp_chip_bl60x.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-#include <malloc.h>
+#include <stdlib.h>
 #include <string.h>
 #include "../../data/bl60x_eflash_loader.h"
 #include "blisp.h"

lib/chip/blisp_chip_bl70x.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-#include <malloc.h>
+#include <stdlib.h>
 #include <string.h>
 #include "../../data/bl70x_eflash_loader.h"
 #include "blisp.h"

tools/blisp/CMakeLists.txt

@@ -1,3 +1,6 @@
+set(ARGTABLE3_ENABLE_TESTS OFF CACHE BOOL "Enable unit tests")
+set(ARGTABLE3_ENABLE_EXAMPLES OFF CACHE BOOL "Enable examples")
+#set(ARGTABLE3_REPLACE_GETOPT OFF CACHE BOOL "Replace getopt in the system C library")
 add_subdirectory(${CMAKE_SOURCE_DIR}/vendor/argtable3 ${CMAKE_CURRENT_BINARY_DIR}/argtable3)
 
 add_executable(blisp src/main.c src/cmd/write.c src/util.c src/common.c src/cmd/iot.c)

tools/blisp/src/common.c

@@ -3,7 +3,7 @@
 #include <argtable3.h>
 #include <blisp.h>
 #include <inttypes.h>
-#include <malloc.h>
+#include <stdlib.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <string.h>
@@ -11,7 +11,7 @@
 #include "util.h"
 
 void blisp_common_progress_callback(uint32_t current_value, uint32_t max_value) {
-  printf("%" PRIu32 "b / %ldb (%.2f%%)\n", current_value, max_value,
+  printf("%" PRIu32 "b / %u (%.2f%%)\n", current_value, max_value,
          (((float)current_value / (float)max_value) * 100.0f));
 }
 

tools/blisp/src/main.c

@@ -45,7 +45,7 @@ int8_t args_parse_exec(int argc, char** argv) {
       print_help();
       return 1;
     } else if (version->count) {
-      printf("blisp 0.0.1\n");
+      printf("blisp v0.0.3\n");
       printf("Copyright (C) 2023 Marek Kraus and PINE64 Community\n");
       return 1;
     }

tools/blisp/src/util.c

@@ -9,6 +9,8 @@
 // These are not thread safe, but it doesn't place the responsibility
 // to free an allocated buffer on the caller.nn
 
+#include <stdlib.h>
+
 static void util_get_executable_path(char* buffer_out, uint32_t max_size) {
   assert(max_size >= PATH_MAX);  // n.b. 1024 on MacOS. 4K on most Linux.
 
@@ -33,6 +35,11 @@ ssize_t util_get_binary_folder(char* buffer, uint32_t buffer_size) {
 #elif defined(__APPLE__)
   util_get_executable_path(buffer, buffer_size);
   char* pos = strrchr(buffer, '/');
+#elif __FreeBSD__
+  if (readlink("/proc/curproc/file", buffer, buffer_size) <= 0) {
+    return -1;
+  }
+  char* pos = strrchr(buffer, '/');
 #else
   if (GetModuleFileName(NULL, buffer, buffer_size) <= 0) {
     return -1;

tools/blisp/src/util.h

@@ -4,9 +4,7 @@
 
 #include <stdint.h>
 
-#ifdef __linux__
-#include <unistd.h>
-#elif defined(_MSC_VER)
+#if defined(_MSC_VER)
 #include <BaseTsd.h>
 typedef SSIZE_T ssize_t;
 #include <windows.h>
@@ -14,10 +12,9 @@ typedef SSIZE_T ssize_t;
 #elif defined(__APPLE__)
 #include <sys/syslimits.h>
 #include <assert.h>
-#endif
-
-#ifdef __linux__
-#include <linux/limits.h>
+#include <sys/types.h>
+#else
+#include <unistd.h>
 #endif
 
 ssize_t util_get_binary_folder(char* buffer, uint32_t buffer_size);