wl1251: Fix memory leak in data path command handling
[pandora-wifi.git] / README
1
2 Linux Wireless compatibility package
3 =====================================
4
5 This is a Linux wireless compatibility package which provides the latest
6 Linux wireless subsystem enhancements for kernels 2.6.25 and above.
7 It is technically possible to support kernels < 2.6.25 but more
8 work is required for that.
9 It also provides Linux bluetooth subsystem enhancements for kernels 2.6.27 and above.
10
11 If you'd like to keep the wireless-testing git repository local as well,
12 please read out git-guide which explains how to achieve this:
13
14 http://wireless.kernel.org/en/developers/git-guide
15
16 With a local git repository you can update the compatibility package yourself. 
17 For more information on how to do this please refer the Developers section below.
18
19 Documentation
20 ------------
21
22 This package is also documented online and has more-up-to date
23 information online than on this README file. You should read the wiki page
24 and not rely on this README:
25
26 http://wireless.kernel.org/en/users/Download
27
28 Subscribe to the wiki page to get updates on the documentation.
29
30 Where to get the latest
31 -----------------------
32
33 This package lets you build your own 'latest', all you need is a local git repository
34 checkout of wireless-testing.git. However since not many users are expected to keep
35 a local git repository of wireless-testing we provide daily snapshots of this
36 package + the wireless subsystem code. You can find the latest snapshot at:
37
38 http://wireless.kernel.org/en/users/Download
39
40 Selecting your driver
41 ---------------------
42
43 If you know the driver you want you can select it with our
44 helper script:
45
46 ./scripts/driver-select
47
48 Run that script to see more information.
49
50 Building, and installing
51 ------------------------
52
53 Build: build the latest linux wireless subsystem
54
55         make
56
57 Install:
58
59 We use the updates/ directory so your distribution's drivers are left intact.
60
61         sudo make install
62
63 Uninstall:
64
65 This nukes our changes to updates/ so you can go back to using your
66 distribution's supported drivers.
67
68         sudo make uninstall
69
70 Load:
71
72 Reboot unless you know what you are doing.
73
74
75 Bluetooth modules can be seperately compiled and installed using below commands
76
77 Build:
78         make bt
79
80 Install:
81         sudo make btinstall
82
83 Uninstall:
84         sudo make btuninstall
85
86 Load:
87         sudo make btload
88
89 Unload:
90         sudo make btunload
91
92 Drivers
93 -------
94
95 This is the list of drivers this package provides. It adds
96 all new drivers or drivers which keep being updated which you might
97 be interested in.
98
99 Driver
100 adm8211
101 ath5k
102 ath9h
103 ar9170
104 b43
105 b43legacy
106 iwl3945
107 iwlagn
108 ipw2100
109 ipw2200
110 libertas_cs (Libertas)
111 ub8xxx      (Libertas)
112 p54pci
113 p54usb
114 rt2400pci (rt2x00)
115 rt2500pci (rt2x00)
116 rt2500usb (rt2x00)
117 rt61pci   (rt2x00)
118 rt73usb   (rt2x00)
119 rtl8180 (Realtek)
120 rtl8187 (Realtek)
121 zd1211rw
122
123 This package also provides more drivers which may be documented here
124
125 For a complete list see:
126
127 http://wireless.kernel.org/en/users/Download
128
129 Non-wireless drivers
130 --------------------
131
132 To support b43 ssb is also provided, and since ssb is also provided
133 we provide b44 (the ethernet driverl).
134
135 The new rfkill drivers also provided and backported.
136
137 Bluetooth drivers:
138 bluetooth
139 btusb
140 hci_uart
141 btsdio
142 btuart_cs
143 bluecard_cs
144 bfusb
145
146 Firmware:
147 ---------
148
149 If your driver needs firmware please be sure to check the driver page
150 for that driver here:
151
152 http://wireless.kernel.org/en/users/Drivers
153
154 Why?
155 ----
156
157 For users or developers stuck on older kernels that want to help test or 
158 patch wireless work. Additionally if you're on a recent kernel this lets
159 you get the latest and greatest wireless-testing git work without much effort.
160 This may mean new drivers for some users. Last but not least we hope this
161 will encourage vendors and developers to post patches upstream first
162 rather than forking or maintaining their own mac80211 releases with
163 their own patches for their own drivers.
164
165 Building for external kernels
166 ----------------------------------
167
168 If you have a kernel you do not have installed but yet want to build the
169 compat-wireless-2.6 drivers for it you can use this syntax:
170
171 make KLIB=/home/mcgrof/kernels/linux-2.6.23.9 KLIB_BUILD=/home/mcgrof/kernels/linux-2.6.23.9
172
173 If you have a kernel installed, which is not your currently running kernel (e.g. via
174 distro updates; plus its corresponding kernel-dev package), you can use this syntax:
175
176 make  KLIB=/lib/modules/2.6.30.6-53.fc11.x86_64
177
178   and to install to your system's root path for the non-running kernel:
179
180 make  KLIB=/lib/modules/2.6.30.6-53.fc11.x86_64 KMODPATH_ARG='INSTALL_MOD_PATH=' install
181
182 Bugs
183 -----
184
185 If you've found a bug please report it to our linux-wireless mailing list:
186
187 linux-wireless@vger.kernel.org
188
189 Report the bug because you are working with the latest and greatest.
190 If your bug is compatibility-related then we should still try to fix
191 it within the compat.[ch] work.
192
193 ChangeLog
194 ---------
195
196 Here you see the list of changes to all wireless drivers, the wireless core and mac80211.
197
198 http://git.kernel.org/?p=linux/kernel/git/linville/wireless-testing.git;a=log;
199
200 This views all the changes on the 'everything' branch of wireless-testing.git.
201
202 License
203 -------
204
205 This work is a subset of the Linux kernel as such we keep the kernel's
206 Copyright practice. Some files have their own copyright and in those
207 cases the license is mentioned in the file. All additional work made
208 to building this package is licensed under the GPLv2.
209
210 Developers
211 ----------
212
213 Compatibility work goes into compat/compat.[ch]. If using those files do 
214 not suffice additional actual code changes can go into compat/compat.diff.
215
216 If you have your own wireless-testing git tree, before running admin-update.sh
217 be sure to set your GIT_TREE variable. For example:
218
219 export GIT_TREE=/home/mcgrof/wireless-testing/
220
221 scripts/admin-clean.sh          - Cleans the compat-wireless-2.6 tree
222 scripts/admin-update.sh         - Updates compat-wireless-2.6 with your git tree
223 scripts/admin-refresh.sh        - Does the above two
224
225 TODO
226 ----
227
228 * Compatibilty work for 2.6.18 --> 2.6.21
229
230 Patches for compatibility work
231 ------------------------------
232
233 Please send patches against:
234
235 git://git.kernel.org/pub/scm/linux/kernel/git/mcgrof/compat-wireless-2.6.git
236
237 To: Luis R. Rodriguez <mcgrof@winlab.rutgers.edu>
238 CC: linux-wireless@vger.kernel.org
239 Subject: [PATCH] compat-2.6: backport foo
240
241 Patches for drivers
242 -------------------
243
244 If you'd like to send patches for a driver though you can send it using our 
245 Submitting Patches guideline:
246
247 http://wireless.kernel.org/en/developers/SubmittingPatches
248