scripts: runners: Introduce bflb_mcu_tool runner

[VynDragon]

Introduces one of the official flash tools for bouffalolab platforms

Caveat: It does not like a python version above 3.11

[pdgendt]

Is there a HAL that this runner can be moved to?

[VynDragon]

Is there a HAL that this runner can be moved to?

Why would this be in the HAL?

[pdgendt]

Is there a HAL that this runner can be moved to?

Why would this be in the HAL?

If the runner is useless without sources originating from a HAL, it would limit the scope of the runner to that HAL, and reduce the maintenance for Zephyr itself.

[VynDragon]

It is not useless without sources originating from the HAL, the runner is installable via pypi and comparable to minichlink or esptool.py.

[VynDragon]

Someone is going to have to explain to me how i content ruff here, it hasn't accepted any of the possible orders.

[pdgendt]

Someone is going to have to explain to me how i content ruff here, it hasn't accepted any of the possible orders.

$ ruff check --fix scripts/west_commands/runners/bflb_mcu_tool.py
$ ruff format scripts/west_commands/runners/bflb_mcu_tool.py

[VynDragon]

ruff check --fix scripts/west_commands/runners/bflb_mcu_tool.py

Thank you, that was a incredibly useless error message for what the issue was.

I also disagree with the assessment that there should not be 2 line jumps between imports and the start of the code.

[pdgendt]

Caveat: It does not like a python version above 3.11

Besides that, if you install the pypi package, it downloads an entire JLink executable + libraries. I doubt this desired/allowed.

$ ls -la .venv/lib/python3.12/site-packages/bflb_mcu_tool/utils/jlink
.rwxr-xr-x 316k pdgendt 24 Apr 16:21 JLink.exe
.rw-r--r--  19M pdgendt 24 Apr 16:21 JLink_x64.dll
.rw-r--r--  18M pdgendt 24 Apr 16:21 JLinkARM.dll
.rw-r--r--  16M pdgendt 24 Apr 16:21 libjlinkarm.dylib

[pdgendt]

Putting a tentative -1 for now.

[VynDragon]

That is neither in the scope of this PR, a problem in this PR, or addressable in this PR.
Best I can do is bring it up to pypi and the vendor.

[carlescufi]

What pip package exactly is causing the trouble here? I don't see anything added to requirements?

[pdgendt]

What pip package exactly is causing the trouble here? I don't see anything added to requirements?

The package bflb-mic-tool needs to be installed for this runner to work, it's printed as an error if missing,

[carlescufi]

What pip package exactly is causing the trouble here? I don't see anything added to requirements?

The package bflb-mic-tool needs to be installed for this runner to work, it's printed as an error if missing,

But we have that for all tools. In fact we should use self.require() instead, shouldn't we? in no case should we be installing this package for the user in my opinion.

[carlescufi]

That is neither in the scope of this PR, a problem in this PR, or addressable in this PR. Best I can do is bring it up to pypi and the vendor.

Please do that. Also there's additional info here: bouffalolab/bouffalo_sdk#93. Perhaps you can open an issue in that repo?

After another look, I agree that bundling the JLink binaries may not be acceptable.

[VynDragon]

What pip package exactly is causing the trouble here? I don't see anything added to requirements?

The package bflb-mic-tool needs to be installed for this runner to work, it's printed as an error if missing,

But we have that for all tools. In fact we should use self.require() instead, shouldn't we? in no case should we be installing this package for the user in my opinion.

I didnt know about that feature, ill looking making it a requirement style thing.

Please do that. Also there's additional info here: bouffalolab/bouffalo_sdk#93. Perhaps you can open an issue in that repo?

After another look, I agree that bundling the JLink binaries may not be acceptable.

I dont disagree that it is a issue (and likely should not even be on pypi either), I have already contacted the vendor through a privileged channel and it might get fixed quickly.

[VynDragon]

Rebased on main.

Outdated

[nandojve]

I could flash the device but when install I got this error:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
pyocd 0.36.0 requires pylink-square<2.0,>=1.0, but you have pylink-square 0.5.0 which is incompatible.

Linux
python3.11 and python3.13

[VynDragon]

That's normal and not related to this, you can ignore it.

[nandojve]

Hi @VynDragon ,

That's normal and not related to this, you can ignore it.

It not seems to be the case, see below:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
bflb-mcu-tool-uart 1.10.0 requires pylink-square==0.5.0, but you have pylink-square 1.6.0 which is incompatible.

That the dependency is too old and need to be updated, see setup.py.
This possible will broke easy on future again. So, need to ask to Bouffalo Lab to make dependency >= instead ==.
I would recommend to then to update to latest versions, if possible.

    install_requires=[
        "toml==0.10.0",
        "configobj==5.0.9",
        "cryptography==37.0.4",
        "pycklink>=0.1.1",
        "pyserial==3.5",
-        "pylink-square==0.5.0",
+        "pylink-square>=1.6.0",
        "portalocker==2.0.0",
        "telnetlib-313-and-up; python_version > '3.12'"
    ],
    python_requires=">=3.6",
    zip_safe=False,

[VynDragon]

Right, ill mail them and ask.

[VynDragon]

It should be good now, please check

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud