Skip to content

Commit

Permalink
doc: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
patrislav1 committed Sep 16, 2024
1 parent 05dbb25 commit 4f66272
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,15 @@ sudo make install
make package
```

## Troubleshooting
## Workarounds for upstream driver

### Can't build on Ubuntu 22.04 / Kernel 5.19
### Kernel compatibility

There is a [unmerged PR on the Xilinx driver](https://github.com/Xilinx/dma_ip_drivers/pull/179) following a breaking change in the DMA API. Until Xilinx merges this, the fix has to be applied manually.
Since Xilinx upstream driver is poorly maintained and does not build with a current kernel, this package uses a [community fork](https://github.com/alonbl/dma_ip_drivers/tree/alonbl) ([alonbl's stable patchset](https://github.com/Xilinx/dma_ip_drivers/pull/240)).

```bash
cd dma_ip_drivers
git remote add fix [email protected]:vkomenda/dma_ip_drivers.git
git pull fix
git checkout fix/dma-compat-fix-linux-5.19
```
### Versioning

Since Xilinx does not bump the version of the upstream driver, this package uses a different versioning.

## Debugging

Expand All @@ -47,4 +44,4 @@ So the preparation step from above becomes:
```
git submodule init && git submodule update
mkdir build && cd build && cmake -DXDMA_DEBUG='1' ..
```
```

0 comments on commit 4f66272

Please sign in to comment.