Anastasia Klimchuk submitted this change.
doc: Add build instructions for NI-845x on Windows
Because this patch adds a new footprint level, Sphinx incorrectly
interprets the 3 asterisks (***) as the start of a bold block,
rather than a footnote marker. To work around this, use sphinx
built-in footprints.
Change-Id: I97ad08632f35aa241b3d19d9ce7711146e3f1f4a
Signed-off-by: Thomas Heijligen <thomas.heijligen@secunet.com>
Signed-off-by: Peter Marheine <pmarheine@chromium.org>
Signed-off-by: Alexander Goncharov <chat@joursoir.net>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/75270
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
---
M doc/dev_guide/building_from_source.rst
M doc/dev_guide/building_with_make.rst
2 files changed, 25 insertions(+), 8 deletions(-)
diff --git a/doc/dev_guide/building_from_source.rst b/doc/dev_guide/building_from_source.rst
index 7503e9e..64250dd 100644
--- a/doc/dev_guide/building_from_source.rst
+++ b/doc/dev_guide/building_from_source.rst
@@ -13,15 +13,17 @@
And the following dependencies:
-* cmocka*
-* linux-headers**
-* libpci**
-* libusb1**
-* libftdi1**
-* libjaylink**
+* cmocka [#b1]_
+* linux-headers [#b2]_
+* libpci [#b2]_
+* libusb1 [#b2]_
+* libftdi1 [#b2]_
+* libjaylink [#b2]_
+* NI-845x driver & library package [#b3]_
-| \* optional, for building unit testing
-| \** optional, depending on the selected programmer
+.. [#b1] | optional, for building unit testing
+.. [#b2] | optional, depending on the selected programmer
+.. [#b3] | optional, proprietary and Windows only. (See Windows build instructions)
If you are cross compiling, install the dependencies for your target.
@@ -34,6 +36,8 @@
meson install -C builddir
+.. _installing-dependencies:
+
Installing dependencies
-----------------------
@@ -85,6 +89,9 @@
Install `MSYS2 <https://www.msys2.org/>`_ and ensure it is `fully updated <https://www.msys2.org/docs/updating/>`_.
* ``libpci`` is not available through the package manager and pci based programmer are not supported on Windows.
+ * ``ni845x_spi`` is only available with the proprietary library from National Instruments. Download and install the driver
+ from `ni.com <https://www.ni.com/en-us/support/downloads/drivers/download.ni-845x-driver-software.html>`_ and build flashrom
+ for **32-bit**. Add ``-Dprogrammer=ni845x_spi`` to your meson configuration.
In the MINGW64 shell run::
diff --git a/doc/dev_guide/building_with_make.rst b/doc/dev_guide/building_with_make.rst
index 90a3e46..710aad3 100644
--- a/doc/dev_guide/building_with_make.rst
+++ b/doc/dev_guide/building_with_make.rst
@@ -21,6 +21,7 @@
* libusb (if you want FT2232, Dediprog or USB-Blaster support)
* libftdi (if you want FT2232 or USB-Blaster support)
* libjaylink (if you want support for SEGGER J-Link and compatible devices)
+ * NI-845x driver & library package (if you want support for NI-845x devices; uses a proprietary driver)
**Linux et al:**
@@ -63,6 +64,15 @@
Install DirectHW from coresystems GmbH.
DirectHW is available at https://www.coreboot.org/DirectHW .
+**To compile on Windows:**
+
+Install MSYS tools (and the NI-845x drivers if desired) as described in
+:ref:`installing-dependencies`.
+
+To build with support for NI-845x::
+
+ make HAS_LIB_NI845X=yes CONFIG_NI845X_SPI=yes
+
**To cross-compile on Linux for DOS:**
Get packages of the DJGPP cross compiler and install them:
To view, visit change 75270. To unsubscribe, or for help writing mail filters, visit settings.