kconfig: Clear "written" flag to avoid data loss
[carl9170fw.git] / README.md
1 # Community AR9170 Linux firmware
2
3 ## Introduction
4
5 This is the firmware for the Atheros ar9170 802.11n devices.
6 The firmware, carl9170.fw, can be used with the carl9170 Linux
7 driver or the tools supplied in the repository.
8
9 ## Build
10
11 ### Build Toolchain
12
13 To build the firmware you will need an SH-2 toolchain.
14 You can use the makefile in this repository to build
15 your own toolchain:
16
17 `# make -C toolchain`
18
19 but be aware that this will take some time and requires
20 about 3-5 GiB disk space.
21
22 ### Build Firmware Image
23
24 The firmware configuration and build process requires the following
25 tools and libraries:
26
27  * gcc 6.0+ (including library and header dependencies)
28
29  * bison/flex
30
31  * cmake 3.8+
32
33 to start the configuration, run:
34
35 `# autogen.sh`
36
37 The configuration is based on the Linux's KConfig utility CLI.
38 For each configurable option, a prompt will appear. To choose
39 the default/previous option simply hit `<Enter>`-key on your
40 keyboard.
41
42 ### Install Firmware
43
44 if you want to "install" your own firmware, you can either
45 do this manually, or by executing:
46
47 `# autogen.sh install`
48
49 This will place a copy with the right filename [adds API rev]
50 into /lib/firmware/[the default path on most Distributions].
51
52 ## Contact
53
54 If you have any patches, you should write
55 to <linux-wireless@vger.kernel.org> and
56 include "carl9170" in the subject line.