Skip to content

scripts: runners: bossac: Enable BOSSAC to run on Windows (native) #53783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2023
Merged

scripts: runners: bossac: Enable BOSSAC to run on Windows (native) #53783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions boards/arm/arduino_nano_33_ble/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,13 @@ For example

west flash --bossac=$HOME/.arduino15/packages/arduino/tools/bossac/1.9.1-arduino2/bossac

On Windows you need to use the :file:`bossac.exe` from the `Arduino IDE`_
You will also need to specify the COM port using the --bossac-port argument:

.. code-block:: bash

west flash --bossac=%USERPROFILE%\AppData\Local\Arduino15\packages\arduino\tools\bossac\1.9.1-arduino2\bossac.exe --bossac-port="COMx"

Flashing
========

Expand Down Expand Up @@ -221,3 +228,6 @@ References

.. _TRACE32 as GDB Front-End:
https://www2.lauterbach.com/pdf/frontend_gdb.pdf

.. _Arduino IDE:
https://www.arduino.cc/en/Main/Software
19 changes: 19 additions & 0 deletions doc/develop/flash_debug/host-tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,22 @@ As a quick reference, see these three board documentation pages:

.. _jlink-debug-host-tools:

Enabling BOSSAC on Windows Native [Experimental]
------------------------------------------------
Zephyr SDK´s bossac is only currenty support on Linux and macOS. Windows support
can be achieved by using the bossac version from `BOSSA oficial releases`_.
After installing using default options, the :file:`bossac.exe` must be added to
Windows PATH. A specific bossac executable can be used by passing the
``--bossac`` option, as follows:

.. code-block:: console
west flash -r bossac --bossac="C:\Program Files (x86)\BOSSA\bossac.exe" --bossac-port="COMx"
.. note::

WSL is not currently supported.

J-Link Debug Host Tools
***********************

Expand Down Expand Up @@ -336,3 +352,6 @@ To enable Zephyr RTOS awareness follow the steps described in

.. _Lauterbach TRACE32 Zephyr OS Awareness Manual:
https://www2.lauterbach.com/pdf/rtos_zephyr.pdf

.. _BOSSA oficial releases:
https://github.com/shumatech/BOSSA/releases
10 changes: 7 additions & 3 deletions scripts/west_commands/runners/bossac.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

'''bossac-specific runner (flash only) for Atmel SAM microcontrollers.'''

import os
import pathlib
import pickle
import platform
Expand Down Expand Up @@ -251,9 +252,12 @@ def do_run(self, command, **kwargs):
'could not import edtlib; something may be wrong with the '
'python environment')

if platform.system() == 'Windows':
msg = 'CAUTION: BOSSAC runner not support on Windows!'
raise RuntimeError(msg)
if platform.system() == 'Linux':
if 'microsoft' in platform.uname().release.lower() or \
os.getenv('WSL_DISTRO_NAME') is not None or \
os.getenv('WSL_INTEROP') is not None:
msg = 'CAUTION: BOSSAC runner not supported on WSL!'
raise RuntimeError(msg)
elif platform.system() == 'Darwin' and self.port is None:
self.port = self.get_darwin_user_port_choice()

Expand Down