Skip to content

Update README.md#231

Merged
joao-victor-s merged 1 commit intomasterfrom
update-readme
May 27, 2025
Merged

Update README.md#231
joao-victor-s merged 1 commit intomasterfrom
update-readme

Conversation

@joao-victor-s
Copy link

No description provided.

README.md Outdated

To configure a build using XVC:

cmake ~/openmmc/ -DBOARD=afc -DVERSION=4.0 -DDEBUG_PROBE=xvc -DXVC_HOST=de-23rabpm-co-cratectrl -DXVC_PORT=2542
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer not using real our internal hostname / port here. Change it to -DXVC_HOST=xvc_hostname -DXVC_PORT=xvc_port_number

README.md Outdated
Comment on lines +85 to +89
Explanation of relevant flags:
- `DDEBUG_PROBE`: Selects the debug interface.
- `DXVC_HOST`: Hostname or IP address of the crate controller running the XVC server.
- `DXVC_PORT`: TCP port for the XVC server (dafault 2542).
- `DVERSION`: Specifies the AFC version to be flashed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer removing this, these flags are already covered previously.

README.md Outdated

This will create a `openocd.cfg` file in `<build_dir>/out`.

In scenarios where the AFC board is in M7 (Error State) or M1 (Shutdown State), the Xilinx Virtual Cable (XVC) interface is particularly useful, allowing firmware upgrades over Ethernet via JTAG. This enables recovery without physical access to the crate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For AFCv4.0 cards, you can program the MMC microcontroller via Xilinx XVC protocol if your MicroTCA crate supports it using the backplane JTAG interface. First, make sure the FPGA is powered off (M1 state), then configure the XVC hostname and port:

README.md Outdated
### OpenOCD
Flashing the MMC microcontroller via SWD/JTAG is supported for CMSIS-DAP and Jlink compatible probes through OpenOCD. You can specify the debug probe with the flag `-DDEBUG_PROBE=<probe_name>`, valid options are `cmsis-dap` (default), `jlink`, `digilent_jtag_hs3` and `xvc` (support is not merged to the official OpenOCD source yet, so you build our patched version: https://github.com/lnls-dig/openocd/tree/fix-afcv3-flashing).

You can specify the debug probe in the CMake configuration with the -DDEBUG_PROBE=<probe_name> flag. Example for CMSIS-DAP:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This information is redundant, read the previous paragraph.

@joao-victor-s joao-victor-s force-pushed the update-readme branch 2 times, most recently from d891cf5 to e1cca9b Compare May 27, 2025 12:33
Copy link
Member

@augustofg augustofg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@joao-victor-s joao-victor-s merged commit 05df7cb into master May 27, 2025
7 checks passed
@joao-victor-s joao-victor-s deleted the update-readme branch May 27, 2025 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants