remove ar5416SetMulticastFilter
[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 What is this exactly?
5 ---------------------
6
7 This is the firmware which resides in RAM on the AR7010/AR9271 NICs.
8 It is used by ath9k (Linux) and athn (OpenBSD) to provide wireless
9 services.
10
11 What licence is this covered by?
12 --------------------------------
13
14 The Qualcomm Atheros owned code is under the ClearBSD licence.
15
16 The NOTICES.TXT file contains copyright notices for software which
17 this firmware release leverages.
18
19 There is some code that is based off of work done under contract
20 but is owned by Qualcomm Atheros; the original copyright statements
21 from that work are in NOTICES.TXT.
22
23 The Tensilica code (xtos/xtensa) is distributed with permission from
24 Tensilica, Inc., under the MIT licence.
25
26 There are three ECOS source files distributed under the terms of
27 the GPLv2, with a caveat that linking or using the source files does
28 not bring the rest of the binary under the GPLv2.  Please read the
29 ECOS caveats in more detail.
30
31
32 Ok, what are those NICs?
33 ------------------------
34
35 The AR7010 is a USB/PCIe SoC with onboard RAM, ROM and flash.
36 It comes with an external wireless chip connected via PCIe - typically
37 an AR9280 or AR9287.
38
39 The AR9271 is a USB/Wifi SoC with onboad RAM, ROM, flash and the
40 actual wireless chip.  The wireless core is an off-shoot of the AR9285.
41 It is a single-chip solution.
42
43 How do I build it?
44 ------------------
45
46 You're in for a treat.
47
48 * You first have to build the toolchain.
49
50   * Linux:
51
52   $ make toolchain
53
54   * FreeBSD:
55
56   $ gmake toolchain
57
58   (Yes, I made this work on FreeBSD as well.)
59
60 * Next, build the firmware.
61
62   * Linux:
63
64   $ make firmware
65
66   * FreeBSD:
67
68   edit the build script, change make to gmake, and then
69
70   $ ./build
71
72 You will end up with two .fw files - one for the AR7010 and one for
73 the AR9271 in the target_firmware directory.
74
75
76 Then what?
77 ----------
78
79 You need to then copy this into the relevant location for your operating
80 system.  Yes, this means you need a driver.  No, there's no FreeBSD
81 driver yet for this particular chipset, sorry.
82
83
84 Where do I file bugs?
85 ---------------------
86
87 Please file bugs in github - http://github.com/qca/open-ath9k-htc-firmware/issues .
88
89
90 Mailing lists?
91 --------------
92
93 Here you go:
94
95 http://lists.infradead.org/mailman/listinfo/ath9k_htc_fw
96
97 And
98
99 ath9k_htc_fw@lists.infradead.org
100