blisp/README.md

72 lines
2.4 KiB
Markdown
Raw Normal View History

2023-03-18 19:27:18 +00:00
[![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)
2023-03-18 19:29:21 +00:00
[![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)
2023-03-03 12:20:54 +00:00
2023-03-18 19:31:53 +00:00
<img src="https://user-images.githubusercontent.com/97197236/225784120-09c7e266-69d8-436c-9cf0-78b3745444e7.png" align="left" width="50" > <br clear="right" />
## BLISP
Bouffalo Labs ISP tool & library
2022-09-12 14:47:58 +00:00
2023-03-09 22:15:12 +00:00
This is an open source tool and library for flashing Bouffalo RISC-V MCUs.
2022-09-12 14:47:58 +00:00
2022-11-08 08:37:29 +00:00
**NOTE:** Library API and `blisp` tool cli arguments are not stable yet.
2023-03-18 19:31:53 +00:00
## Supported MCUs
2022-09-12 14:47:58 +00:00
2023-02-28 10:23:18 +00:00
- [x] `bl60x` - BL602 / BL604 / TG7100C / LF686 / LF688
2022-11-20 06:22:36 +00:00
- [x] `bl70x` - BL702 / BL704 / BL706
2023-01-21 13:50:27 +00:00
- [ ] `bl70xl` - BL702L / BL704L
2022-11-08 21:17:40 +00:00
- [ ] `bl606p` - BL606P
- [ ] `bl61x` - BL616 / BL618
- [ ] `bl808` - BL808
2023-03-18 19:31:53 +00:00
## Supported OS
- [x] Windows
- [x] Linux
2023-03-02 03:15:54 +00:00
- [x] MacOS
- [x] FreeBSD
2023-03-12 21:54:49 +00:00
# How to update Pinecil V2
2022-11-08 21:17:40 +00:00
2023-03-09 22:15:12 +00:00
Check out the [wiki page](https://github.com/pine64/blisp/wiki/Update-Pinecil-V2).
# Building from code
2022-11-08 21:17:40 +00:00
2023-03-09 22:15:12 +00:00
### Clone repository
2022-11-20 06:22:47 +00:00
If you have not cloned this repository locally; clone the git repository locally by running
2022-11-20 06:22:47 +00:00
```bash
git clone --recursive https://github.com/pine64/blisp.git
cd blisp
git submodule update --init --recursive
2022-11-20 06:22:47 +00:00
```
2023-03-09 22:15:12 +00:00
### Build the library and command line utility
2022-11-20 06:22:47 +00:00
2022-11-08 21:17:40 +00:00
For building `blisp` command line tool, use following commands:
```bash
mkdir build && cd build
cmake -DBLISP_BUILD_CLI=ON ..
cmake --build .
```
2023-03-10 00:39:20 +00:00
#### Need more build details? [See here](https://github.com/pine64/blisp/wiki/Update-Pinecil-V2#build-blisp-flasher-from-code).
2022-11-08 21:17:40 +00:00
2023-03-18 19:31:53 +00:00
## Usage
2022-11-08 21:17:40 +00:00
For BL70X, BL61X, BL808 and BL606P, connected via USB, you can use following command, which will auto-detect serial port:
```bash
.\blisp.exe write --chip=bl70x --reset .\name_of_firmware.bin
or
.\blisp.exe write -c bl70x --reset .\name_of_firmware.bin
2022-11-08 21:17:40 +00:00
```
For BL60X, you need to specify also the serial port path:
```bash
blisp write --chip bl60x --reset -p /dev/ttyUSB0 name_of_firmware.bin
2022-11-08 21:17:40 +00:00
```
2022-09-12 14:47:58 +00:00