88566746 | 25-Jan-2022 |
Juraj Linkeš <juraj.linkes@pantheon.tech> |
doc: update arm64 cross build of numactl
Numactl cross compilation doesn't work with clang, remove it and fix the GCC cross compiler executable name.
Signed-off-by: Juraj Linkeš <juraj.linkes@panth
doc: update arm64 cross build of numactl
Numactl cross compilation doesn't work with clang, remove it and fix the GCC cross compiler executable name.
Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech> Acked-by: Ruifeng Wang <ruifeng.wang@arm.com>
show more ...
|
6dad5e1e | 25-Jan-2022 |
Juraj Linkeš <juraj.linkes@pantheon.tech> |
doc: add arm64 toolchain names update instructions
The newer versions have an extra -none- in the name.
Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech> Acked-by: Ruifeng Wang <ruifeng.wang
doc: add arm64 toolchain names update instructions
The newer versions have an extra -none- in the name.
Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech> Acked-by: Ruifeng Wang <ruifeng.wang@arm.com>
show more ...
|
6a4b58b8 | 25-Jan-2022 |
Juraj Linkeš <juraj.linkes@pantheon.tech> |
doc: add CFLAGS/LDFLAGS alternatives for arm64 cross build
Remove CFLAGS and LDFLAGS since Meson doesn't support them well enough. Add Meson alternatives: -Dc_args and -Dc_link_args on the command l
doc: add CFLAGS/LDFLAGS alternatives for arm64 cross build
Remove CFLAGS and LDFLAGS since Meson doesn't support them well enough. Add Meson alternatives: -Dc_args and -Dc_link_args on the command line and in cross files.
Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech> Acked-by: Ruifeng Wang <ruifeng.wang@arm.com>
show more ...
|
ba4132c5 | 15-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: add hyperlinks to driver guides in Linux guide
The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list.
Signed-off
doc: add hyperlinks to driver guides in Linux guide
The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
70d882d2 | 15-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: add hyperlinks to other docs from Linux guide
The document roadmap section called out the titles of other documents, but these are better as hyperlinks.
Signed-off-by: Bruce Richardson <bruce.
doc: add hyperlinks to other docs from Linux guide
The document roadmap section called out the titles of other documents, but these are better as hyperlinks.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
44bb0d67 | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: change informational warnings to notes in Linux guide
There are two warnings in the VFIO section about limitations of VFIO and limitations on who can bind/unbind devices. Since these don't actu
doc: change informational warnings to notes in Linux guide
There are two warnings in the VFIO section about limitations of VFIO and limitations on who can bind/unbind devices. Since these don't actually describe any unsafe conditions, and are more informational, we can change these to notes. This also helps emphasise the other warnings in the documents which flag genuine security concerns.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
a243f085 | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: consolidate VFIO content on Linux drivers page
Rather than having separate sections for VFIO and VFIO no-iommu mode, as well as a separate section further down the document on troubleshooting V
doc: consolidate VFIO content on Linux drivers page
Rather than having separate sections for VFIO and VFIO no-iommu mode, as well as a separate section further down the document on troubleshooting VFIO, we can consolidate all these as subsections into a primary VFIO section. This section starts with the basics of VFIO use, then covers no-iommu mode, before moving on to the more advanced topics such as creating VFs and ending with the troubleshooting subsection.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
e077832e | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: move UIO section to the end of Linux drivers page
To further de-emphasise UIO over the alternatives, we can move the UIO section of the drivers page to the end of the document, giving more prom
doc: move UIO section to the end of Linux drivers page
To further de-emphasise UIO over the alternatives, we can move the UIO section of the drivers page to the end of the document, giving more prominence to VFIO and bifurcated drivers.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
79603b8c | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: split VFIO section in Linux guide
The VFIO section of the page about Linux drivers was rather long and unstructured. This can be improved by splitting it up into subsections, to cover the speci
doc: split VFIO section in Linux guide
The VFIO section of the page about Linux drivers was rather long and unstructured. This can be improved by splitting it up into subsections, to cover the specifics of memory limits and creating VFs. When moving the various text notes into the relevant subsections, we can drop the note about kernels earlier than 3.6, since DPDK no longer supports kernels that old.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
465fd836 | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: emphasise VFIO over UIO-based modules in Linux guide
VFIO is to be strongly preferred over UIO-based modules, so update our text and examples to only refer to VFIO, giving an initial reference
doc: emphasise VFIO over UIO-based modules in Linux guide
VFIO is to be strongly preferred over UIO-based modules, so update our text and examples to only refer to VFIO, giving an initial reference at the start to UIO as a fallback option.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
74673f4b | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: move device binding up in Linux guide
While the details of VFIO and UIO may be of interest to some, most users of the doc are likely primarily interested in how to bind their devices to the ker
doc: move device binding up in Linux guide
While the details of VFIO and UIO may be of interest to some, most users of the doc are likely primarily interested in how to bind their devices to the kernel driver and then move on to running the app. Therefore, the most important part of the "Linux Drivers" section of the GSG is the subsection on "Binding and Unbinding", so put that first.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
5cb05460 | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: make UIO safety warning more visible in Linux guide
The GSG has a note warning that use of UIO is inherently unsafe due to lack of IOMMU protection. However, this was only flagged as a "NOTE",
doc: make UIO safety warning more visible in Linux guide
The GSG has a note warning that use of UIO is inherently unsafe due to lack of IOMMU protection. However, this was only flagged as a "NOTE", meaning it could easily be missed. Changing the rst tag from "note" to "warning" and moving it to the top of the UIO subsection makes this a lot more visible to users.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
b421909c | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: fix missing note on UIO module in Linux guide
The docs on binding drivers was updated as part of the removal of the igb_uio module from the main DPDK repo. As part of that update, a note about
doc: fix missing note on UIO module in Linux guide
The docs on binding drivers was updated as part of the removal of the igb_uio module from the main DPDK repo. As part of that update, a note about uio_pci_generic requiring legacy interrupts was removed, but should have been kept.
Fixes: 56bb5841fd06 ("kernel/linux: remove igb_uio") Cc: stable@dpdk.org
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
c265d586 | 16-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: replace characters for (R) symbol in Linux guide
Some IDEs, such as eclipse, complained on save about the use of special characters in the (R) symbol in linux GSG doc. We can replace those with
doc: replace characters for (R) symbol in Linux guide
Some IDEs, such as eclipse, complained on save about the use of special characters in the (R) symbol in linux GSG doc. We can replace those with the equivalent "|reg|" text, and including isonum.txt.
Cc: stable@dpdk.org
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
0e45ace5 | 10-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: remove IOMMU pass-through from Linux guide
The "Linux Drivers" section of the GSG already notes that, for use of UIO, the IOMMU must be disabled or put into pass-through mode. Therefore, there
doc: remove IOMMU pass-through from Linux guide
The "Linux Drivers" section of the GSG already notes that, for use of UIO, the IOMMU must be disabled or put into pass-through mode. Therefore, there is no need to duplicate this information in the "additional functionality" section. Also the kernel configuration options documented in the section are enabled as standard on all common distro kernels, so the information should not be needed in a GSG doc.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
e3671ec1 | 10-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: drop reference to KNI from Linux guide
The KNI library is disabled by default in DPDK and is already documented in the programmers guide and also in the sample application guide. There are also
doc: drop reference to KNI from Linux guide
The KNI library is disabled by default in DPDK and is already documented in the programmers guide and also in the sample application guide. There are also in-kernel alternatives to it. Therefore, we can drop the (already fairly minimal) reference to it from the Linux GSG.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
3d883660 | 10-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: shorten details on HPET use
As best we can tell, the HPET timers are not commonly used, so there is little need to give extensive detail and commentry on them in the Linux GSG. As such, we can
doc: shorten details on HPET use
As best we can tell, the HPET timers are not commonly used, so there is little need to give extensive detail and commentry on them in the Linux GSG. As such, we can reduce the GSG section to just a single subsection and also move it down the page below items which are likely of greater importance.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
e2075e0d | 10-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: expand list of directories in Linux guide
Not all directories were given in the GSG document, but many of those omitted would be of interest to users, e.g. "doc", "license" and "usertools" dire
doc: expand list of directories in Linux guide
Not all directories were given in the GSG document, but many of those omitted would be of interest to users, e.g. "doc", "license" and "usertools" directories. Adding these leaves only "devtools", and "kernel" as the only undocumented directories, so add them in too for completeness.
When updating the section, add "including" to the line leading up to the directory list, indicating that, while the list is currently complete, it is not guaranteed to always be.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
167c0860 | 10-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: merge Linux requirements for applications build
When building end-applications linked with DPDK, the only additional tool needed is pkg-config/pkgconf. However, the standard development tools m
doc: merge Linux requirements for applications build
When building end-applications linked with DPDK, the only additional tool needed is pkg-config/pkgconf. However, the standard development tools meta-packages on most distro's include this as standard, meaning it does not really require its own section. The one outlier in the existing text is "alpine" where it is not present when using "libc-dev" target. However, changing "gcc" and "libc-dev" to "alpine-sdk" metapackage aligns alpine with the other distros in this regard.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|
40356b62 | 10-Mar-2022 |
Bruce Richardson <bruce.richardson@intel.com> |
doc: remove duplicated note about UEFI secure boot
A note about secure boot not allowing UIO is present in both the system requirements section and the driver binding section. This fits better in th
doc: remove duplicated note about UEFI secure boot
A note about secure boot not allowing UIO is present in both the system requirements section and the driver binding section. This fits better in the driver binding section, so the copy in system requirements can be removed. The document in general now also emphasises VFIO over UIO more than when this note was first added, reducing the need for this warning to be repeated.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
show more ...
|