Skip to content

Commit

Permalink
Document a new option for loading an initial design to kpm
Browse files Browse the repository at this point in the history
Inernal-tag: [#62341]
Signed-off-by: gkierzkowski <[email protected]>
  • Loading branch information
gkierzkowski-ant authored and rw1nkler committed Aug 9, 2024
1 parent 3c91260 commit 859f5ba
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/source/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,15 @@ python -m topwrap kpm_run_server
2. Run Topwrap's client application, that will connect to a running Pipeline Manager server app.

```
python -m topwrap kpm_client [-h ip_addr] [-p port] FILES
python -m topwrap kpm_client [-h ip_addr] [-p port] [-d FILE] FILES
```

Topwrap will then try to connect to the server running on `ip_addr:port` and send a specification generated from `FILES`, which should be IP core description yamls.

If `-h` or `-p` options are not specified, ip address `127.0.0.1` and port `9000` will be chosen by default.

If `-d` option is specified, kpm will start with specified design file loaded.

(generating-ip-yamls)=

## Generating IP core description YAMLs
Expand Down
3 changes: 2 additions & 1 deletion docs/source/pipeline_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@ Topwrap can make use of [Kenning Pipeline Manager](https://github.com/antmicro/k
* IP address (`127.0.0.1` is default)
* listening port (`9000` is default)
* yamls describing IP cores, that will be used in the block design
* design to load initially (`None` by default)
An example command, that runs Topwrap's client, may look like this:
```
python -m topwrap kpm_client -h 127.0.0.1 -p 9000 \
topwrap/ips/axi/axi_axil_adapter.yaml \
examples/pwm/ipcores/{litex_pwm.yml,ps7.yaml}
examples/pwm/ipcores/{litex_pwm.yml,ps7.yaml} -d examples/pwm/project.yml
```
3. Create block design in Pipeline Manager
Expand Down

0 comments on commit 859f5ba

Please sign in to comment.