Update INSTALL document
[linux-libre-firmware.git] / INSTALL
1 Briefly, running "make" without specifying any targets will build
2 everything. You may not necessarily want everything though and can
3 also specify targets to make. For example:
4
5     make av7110
6
7 Please see the included Makefile for a list of all available targets.
8
9 Once the desired things are built, "make install" will put them into
10 the appropriate place, which is /lib/firmware by default although you
11 can override this with something like:
12
13     make prefix=/desired/path install
14
15 In order to build everything you will need the following on the host
16 system:
17
18     * A C/C++ compiler, like GCC
19     * Cmake
20     * GNU Bison/YACC
21     * GNU Flex
22     * GNU Gperf
23     * GNU Make
24     * GNU Wget
25     * GNU C cross-compiler for AVR
26     * Standard C library for Atmel AVR
27     * GNU C cross-compiler for ARM:
28         - arm-linux-gnueabi-gcc
29         - arm-linux-gnueabi-ld
30         - arm-linux-gnueabi-objcopy
31         - arm-none-eabi-gcc
32         - arm-none-eabi-objcopy
33         - arm-none-eabi-as
34
35 On GNU/Linux distros that use apt you can install these with:
36
37     apt install gcc-avr avr-libc binutils-arm-linux-gnueabi \
38     binutils-arm-none-eabi bison cmake flex g++ gcc \
39     gcc-arm-linux-gnueabi gcc-arm-none-eabi gperf make wget
40
41 CARL9170 Firmware Configuration
42 -------------------------------
43 When building the carl9170 firmware you will be prompted with
44 configuration questions.
45
46 atusb: Firmware for the ATUSB IEEE 802.15.4 USB Adapter
47 -------------------------------------------------------
48
49 To flash the firmware you need dfu-util on the host. Issue
50
51     make dfu
52
53 right after plugging the device into the USB port while the red led is
54 still on.
55
56 Refer to the included README file for more information.
57
58 Licensing
59 ---------
60
61 You can redistribute and/or modify this file under the terms of the
62 GNU General Public License as published by the Free Software
63 Foundation, either version 3 of the License, or (at your option) any
64 later version.