Add a README.
[librecmc/open-ath9k-htc-firmware.git] / README
1 This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
2 802.11n NICs.
3
4
5 What is this exactly?
6 ---------------------
7
8 This is the firmware which resides in RAM on the AR7010/AR9271 NICs.
9 It is used by ath9k (Linux) and athn (OpenBSD) to provide wireless
10 services.
11
12
13 Ok, what are those NICs?
14 ------------------------
15
16 The AR7010 is a USB/PCIe SoC with onboard RAM, ROM and flash.
17 It comes with an external wireless chip connected via PCIe - typically
18 an AR9280 or AR9285.
19
20 The AR9271 is a USB/Wifi SoC with onboad RAM, ROM, flash and the
21 actual wireless chip.  The wireless core is an off-shoot of the AR9285.
22 It is a single-chip solution.
23
24 How do I build it?
25 ------------------
26
27 You're in for a treat.
28
29 * You first have to build the toolchain.
30
31   * Linux:
32
33   $ make toolchain
34
35   * FreeBSD:
36
37   $ gmake toolchain
38
39   (Yes, I made this work on FreeBSD as well.)
40
41 * Next, build the firmware.
42
43   * Linux:
44
45   $ ./build
46
47   * FreeBSD:
48
49   edit the build script, change make to gmake, and then
50
51   $ ./build
52
53 You will end up with two .fw files - one for the AR7010 and one for
54 the AR9271.
55
56
57 Then what?
58 ----------
59
60 You need to then copy this into the relevant location for your operating
61 system.  Yes, this means you need a driver.  No, there's no FreeBSD
62 driver yet for this particular chipset, sorry.
63
64
65 Further information
66 -------------------
67
68 Bug tracking and email list will appear here shortly.
69
70
71