https://github.com/lowrisc/hyperdebug-firmware

Hyperdebug Firmware
https://github.com/lowrisc/hyperdebug-firmware

Last synced: 1 day ago
JSON representation

Hyperdebug Firmware

• Host: GitHub
• URL: https://github.com/lowrisc/hyperdebug-firmware
• Owner: lowRISC
• License: apache-2.0
• Created: 2023-04-03T22:29:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-10T16:35:26.000Z (6 months ago)
• Last Synced: 2024-05-10T17:41:45.091Z (6 months ago)
• Language: Starlark
• Size: 30.3 KB
• Stars: 0
• Watchers: 9
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hyperdebug Firmware

This repository provides the build and release process for the hyperdebug

firmware used by the [OpenTitan](https://github.com/lowRISC/opentitan)

project.  Hyperdebug is a standard

[NUCLEO-L552ZE-Q](https://www.st.com/en/evaluation-tools/nucleo-l552ze-q.html)

board that provide debug and I/O connectivity with the OpenTitan FPGA

development board.

The hyperdebug firmware is a variant of the [Chromium

EC](https://chromium.googlesource.com/chromiumos/platform/ec) firmware.

## Updating

This repository does not contain the Chromium EC source code.  Instead,

we reference Chromium's git repository at the commit that contains the

features we need for hyperdebug (this allows the hyperdebug firmware

release to be independent from EC releases).

To change the version of EC firmware used as hyperdebug firmware, update

the `git_repository` rule in [`//third_party/chromium/repos.bzl`](third_party/chromium/repos.bzl).

```

git_repository(

    name = "ec_src",

    remote = "https://chromium.googlesource.com/chromiumos/platform/ec",

    commit = "17c8bc295fb6c2a258efadb4a52f04a0f494ec0d",

    build_file = "//third_party/chromium:BUILD.ec_src.bazel",

)

```

After updating the rule, build and release the new firmware.

## Building

To build the hyperdebug firmware, issue the following command:

```

bazel build :hyperdebug-firmware

```

This will emit a `hyperdebug-firmware.tar.gz` archive containing the firmware

binary and support files.

## Releasing

To perform a release of the firmware, use the **Create Release** flow

in the **Actions** tab.  It is suggested that you use a `release_tag`

patterned after the build date: `YYYYMMDD_RR`, where:

- `YYYY` is the year.

- `MM` is the month.

- `DD` is the day.

- `RR` is the number of the release on that date, starting at `01`.

To perform a manual release of the firmware, issue the following command:

```

RELEASE_TAG="YYYYMMDD_RR"

bazel run :release -- ${RELEASE_TAG}

```

This will build the firmware archive, create a git tag and publish the

release artifacts to github.