Merge pull request #52 from larry-xmos/xmosdfu_doc_linux_and_pi

xmosdfu: Linux and Raspberry Pi build instructions
This commit is contained in:
Ross Owen
2018-03-29 13:58:08 +01:00
committed by GitHub
2 changed files with 28 additions and 5 deletions

View File

@@ -1,7 +1,7 @@
.. _usb_audiosec_building_xmos_dfu: .. _usb_audiosec_building_xmos_dfu:
Building the XMOS DFU loader - macOS Building the XMOS DFU loader
==================================== ============================
The XMOS DFU loader is provided as source as part of the USB Audio The XMOS DFU loader is provided as source as part of the USB Audio
framework, located in lib_xua/host/xmosdfu. framework, located in lib_xua/host/xmosdfu.
@@ -9,10 +9,33 @@ framework, located in lib_xua/host/xmosdfu.
The loader is compiled using libusb, the code for the loader is contained in the The loader is compiled using libusb, the code for the loader is contained in the
file ``xmosdfu.cpp`` file ``xmosdfu.cpp``
macOS
-----
To build the loader a Makefile is provided, which can be run as follows: To build the loader a Makefile is provided, which can be run as follows:
``make -f Makefile.OSX all`` ``make -f Makefile.OSX64 all``
This Makefile contains the following: This Makefile contains the following:
.. literalinclude:: Makefile.OSX .. literalinclude:: Makefile.OSX64
There is also a 32bit OS X makefile, ``Makefile.OSX32``.
Linux
-----
Similarly to macOS, there are two Linux makefiles provided, ``Makefile.Linux32`` and ``Makefile.Linux64``:
.. literalinclude:: Makefile.Linux64
System-wide libusb is used. On Debian-derived systems this can be installed with:
``apt-get install libusb-1.0.0-dev``
Raspberry Pi
------------
A makefile is provided for Raspbian. libusb is required and can be installed using the ``apt-get`` command from previous Linux section.
.. literalinclude:: Makefile.Pi

View File

@@ -7,4 +7,4 @@ DFU loader for XMOS USB AUDIO devices
Creating factory and upgrade images with XFLASH <factory_image> Creating factory and upgrade images with XFLASH <factory_image>
Using the DFU loader - Windows (via the Thesycon driver) <thesycon_dfu> Using the DFU loader - Windows (via the Thesycon driver) <thesycon_dfu>
Using the DFU loader - macOS (via the XMOS DFU loader) <xmos_dfu> Using the DFU loader - macOS (via the XMOS DFU loader) <xmos_dfu>
Building the XMOS DFU loader - macOS <building_xmos_dfu> Building the XMOS DFU loader <building_xmos_dfu>