Chriesibaum's BSDL File Parser

When I was tinkering around with JTAG and BSDL files, I realized that there was no truly functional BSDL file parser for Python. Perhaps I simply didn't search hard enough. In any case, many packages are no longer up to date or have broken dependencies. Let's get our hands dirty - a few moments later and here is what I needed. If you can use it too, I'm happy to receive any inputs.

Basic usage:

Download and install the package from pypi.org. It's recommended to install the package into a virtual Python environment.

pip install cb_bsdl_parser

There are two tools available to examine BSDL files:

• cb_bsdl_check: To check a BSDL file
• cb_bsdl_info: To get basic data and info from a BSDL file

cb_bsdl_check <bsdl_file> [options]

cb_bsdl_info <bsdl_file> [--cell CELL] [--print-bsr-table]

To use it in your Python project, create a BSDL object and extract the needed data:

bsdl = CBBsdl('bsdl_file.bsdl')

bsdl.get_entity_name()

# get the pin mapping as a dict:
pin_map = bsdl.get_pin_map()

# or just print the boundary scan table:
bsdl.print_bsr_table()

There is a handful of more methods available to extract other data from the BSDL file.

Development

Dev tool installation

The development is mainly being done on an Ubuntu 24.04 box. To set up a dev environment, use Python 3 and install the following packages:

pip install -r requirements.txt
pip install -r requirements_dev.txt

To use antlr4, install it from the deb package sources/store:

sudo apt install antlr4

Note: If a Python virtual environment installs antlr4-tools, its antlr4 wrapper may fail offline with a .m2/repository/org/antlr/antlr4 error.

Current parser generation setup (no VSCode ANTLR required):

• Preferred: venv-local jar at /tmp/venv_cb_bsdl_parser/tools/antlr4-4.13.2-complete.jar
• Fallback: /usr/bin/antlr4
• Last fallback: antlr4 from PATH

If needed, place a local ANTLR jar into the active venv:

source envsetup.sh
mkdir -p "$VIRTUAL_ENV/tools"
curl -fL -o "$VIRTUAL_ENV/tools/antlr4-4.13.2-complete.jar" \
	https://repo1.maven.org/maven2/org/antlr/antlr4/4.13.2/antlr4-4.13.2-complete.jar

About Café - The Heart of Coding! ;-)

Do you like this project and want to support it? I appreciate every single Café – it keeps me going! You can also sponsor the project on github sponsors? Thanks for your support!