laiyp/lib_xua
1
0
Fork 0
forked from PAWPAW-Mirror/lib_xua
Code Pull Requests Activity

Fixes for doc build (#270)

Browse Source 
Document moving and rename. Fixes for latest xdoc.
This commit is contained in:
Ross Owen
2022-06-01 10:39:02 +01:00
committed by GitHub
parent 266711caf7
commit 9edef4a1f1
21 changed files with 20 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
doc/dfu/rst/building_xmos_dfu.rst Normal file
View File

@@ -0,0 +1,56 @@
.. _usb_audiosec_building_xmos_dfu:
Building the XMOS DFU loader
============================
The XMOS DFU loader is provided as source as part of the USB Audio
framework, located in lib_xua/host/xmosdfu.
The loader is compiled using libusb, the code for the loader is contained in the
file ``xmosdfu.cpp``
macOS
-----
To build the loader a Makefile is provided, which can be run as follows:
``make -f Makefile.OSX64 all``
This Makefile contains the following:
.. 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
Windows
-------
To build on Windows, you must first install Visual Studio 2019 Build Tools with
C++ support. `This is available from Microsoft's website. <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_
To build, open a Developer Command Prompt via the start menu and navigate to the
xmosdfu folder. The command to build is as follows:
``nmake /f Makefile.Win32``
This Makefile contains the following:
.. literalinclude:: Makefile.Win32