diff options
author | Dan Williams <dcbw@redhat.com> | 2007-06-18 12:10:33 -0400 |
---|---|---|
committer | John W. Linville <linville@tuxdriver.com> | 2007-06-28 07:48:47 -0400 |
commit | 7dcf5284d12d7b59359a503d35797295f085f327 (patch) | |
tree | 1f72239e10d1270b45b681e2cbdee6943ec96bd5 /drivers/net/wireless/libertas/README | |
parent | 18c96c3497aa871608d57ca5e08de3558159a6c9 (diff) |
[PATCH] libertas: remove private ioctls
Signed-off-by: Christoph Hellwig <hch@infradead.org>
Acked-by: Dan Williams <dcbw@redhat.com>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
Diffstat (limited to 'drivers/net/wireless/libertas/README')
-rw-r--r-- | drivers/net/wireless/libertas/README | 275 |
1 files changed, 0 insertions, 275 deletions
diff --git a/drivers/net/wireless/libertas/README b/drivers/net/wireless/libertas/README index 1f92f50b643c..0b133ce63805 100644 --- a/drivers/net/wireless/libertas/README +++ b/drivers/net/wireless/libertas/README | |||
@@ -28,281 +28,6 @@ DRIVER LOADING | |||
28 | 28 | ||
29 | insmod usb8388.ko [fw_name=usb8388.bin] | 29 | insmod usb8388.ko [fw_name=usb8388.bin] |
30 | 30 | ||
31 | ===================== | ||
32 | IWPRIV COMMAND | ||
33 | ===================== | ||
34 | |||
35 | NAME | ||
36 | This manual describes the usage of private commands used in Marvell WLAN | ||
37 | Linux Driver. All the commands available in Wlanconfig will not be available | ||
38 | in the iwpriv. | ||
39 | |||
40 | SYNOPSIS | ||
41 | iwpriv <ethX> <command> [sub-command] ... | ||
42 | |||
43 | iwpriv ethX setregioncode <n> | ||
44 | iwpriv ethX getregioncode | ||
45 | |||
46 | Version 5 Command: | ||
47 | iwpriv ethX ledgpio <n> | ||
48 | |||
49 | BT Commands: | ||
50 | The blinding table (BT) contains a list of mac addresses that will be, | ||
51 | by default, ignored by the firmware. It is also possible to invert this | ||
52 | behavior so that we will ignore all traffic except for the portion | ||
53 | coming from mac addresess in the list. It is primarily used for | ||
54 | debugging and testing networks. It can be edited and inspected with | ||
55 | the following commands: | ||
56 | |||
57 | iwpriv ethX bt_reset | ||
58 | iwpriv ethX bt_add <mac_address> | ||
59 | iwpriv ethX bt_del <mac_address> | ||
60 | iwpriv ethX bt_list <id> | ||
61 | iwpriv ethX bt_get_invert <n> | ||
62 | iwpriv ethX bt_set_invert <n> | ||
63 | |||
64 | FWT Commands: | ||
65 | The forwarding table (FWT) is a feature used to manage mesh network | ||
66 | routing in the firmware. The FWT is essentially a routing table that | ||
67 | associates a destination mac address (da) with a next hop receiver | ||
68 | address (ra). The FWT can be inspected and edited with the following | ||
69 | iwpriv commands, which are described in greater detail below. | ||
70 | Eventually, the table will be automatically maintained by a custom | ||
71 | routing protocol. | ||
72 | |||
73 | NOTE: FWT commands replace the previous DFT commands. What were the DFT | ||
74 | commands?, you might ask. They were an earlier API to the firmware that | ||
75 | implemented a simple MAC-layer forwarding mechanism. In the unlikely | ||
76 | event that you were using these commands, you must migrate to the new | ||
77 | FWT commands which can be used to achieve the same functionality. | ||
78 | |||
79 | iwpriv ethX fwt_add [parameters] | ||
80 | iwpriv ethX fwt_del [parameters] | ||
81 | iwpriv ethX fwt_lookup [parameters] | ||
82 | iwpriv ethX fwt_list [parameters] | ||
83 | iwpriv ethX fwt_list_route [parameters] | ||
84 | iwpriv ethX fwt_list_neigh [parameters] | ||
85 | iwpriv ethX fwt_reset [parameters] | ||
86 | iwpriv ethX fwt_cleanup | ||
87 | iwpriv ethX fwt_time | ||
88 | |||
89 | MESH Commands: | ||
90 | |||
91 | The MESH commands are used to configure various features of the mesh | ||
92 | routing protocol. The following commands are supported: | ||
93 | |||
94 | iwpriv ethX mesh_get_ttl | ||
95 | iwpriv ethX mesh_set_ttl ttl | ||
96 | |||
97 | DESCRIPTION | ||
98 | Those commands are used to send additional commands to the Marvell WLAN | ||
99 | card via the Linux device driver. | ||
100 | |||
101 | The ethX parameter specifies the network device that is to be used to | ||
102 | perform this command on. it could be eth0, eth1 etc. | ||
103 | |||
104 | setregioncode | ||
105 | This command is used to set the region code in the station. | ||
106 | where value is 'region code' for various regions like | ||
107 | USA FCC, Canada IC, Spain, France, Europe ETSI, Japan ... | ||
108 | |||
109 | Usage: | ||
110 | iwpriv ethX setregioncode 0x10: set region code to USA (0x10). | ||
111 | |||
112 | getregioncode | ||
113 | This command is used to get the region code information set in the | ||
114 | station. | ||
115 | |||
116 | ledgpio | ||
117 | This command is used to set/get LEDs. | ||
118 | |||
119 | iwpriv ethX ledgpio <LEDs> | ||
120 | will set the corresponding LED for the GPIO Line. | ||
121 | |||
122 | iwpriv ethX ledgpio | ||
123 | will give u which LEDs are Enabled. | ||
124 | |||
125 | Usage: | ||
126 | iwpriv eth1 ledgpio 1 0 2 1 3 4 | ||
127 | will enable | ||
128 | LED 1 -> GPIO 0 | ||
129 | LED 2 -> GPIO 1 | ||
130 | LED 3 -> GPIO 4 | ||
131 | |||
132 | iwpriv eth1 ledgpio | ||
133 | shows LED information in the format as mentioned above. | ||
134 | |||
135 | Note: LED0 is invalid | ||
136 | Note: Maximum Number of LEDs are 16. | ||
137 | |||
138 | fwt_add | ||
139 | This command is used to insert an entry into the FWT table. The list of | ||
140 | parameters must follow the following structure: | ||
141 | |||
142 | iwpriv ethX fwt_add da ra [metric dir rate ssn dsn hopcount ttl expiration sleepmode snr] | ||
143 | |||
144 | The parameters between brackets are optional, but they must appear in | ||
145 | the order specified. For example, if you want to specify the metric, | ||
146 | you must also specify the dir, ssn, and dsn but you need not specify the | ||
147 | hopcount, expiration, sleepmode, or snr. Any unspecified parameters | ||
148 | will be assigned the defaults specified below. | ||
149 | |||
150 | The different parameters are:- | ||
151 | da -- DA MAC address in the form 00:11:22:33:44:55 | ||
152 | ra -- RA MAC address in the form 00:11:22:33:44:55 | ||
153 | metric -- route metric (cost: smaller-metric routes are | ||
154 | preferred, default is 0) | ||
155 | dir -- direction (1 for direct, 0 for reverse, | ||
156 | default is 1) | ||
157 | rate -- data rate used for transmission to the RA, | ||
158 | as specified for the rateadapt command, | ||
159 | default is 3 (11Mbps) | ||
160 | ssn -- Source Sequence Number (time at the RA for | ||
161 | reverse routes. Default is 0) | ||
162 | dsn -- Destination Sequence Number (time at the DA | ||
163 | for direct routes. Default is 0) | ||
164 | hopcount -- hop count (currently unused, default is 0) | ||
165 | ttl -- TTL (Only used in reverse entries) | ||
166 | expiration -- entry expiration (in ticks, where a tick is | ||
167 | 1024us, or ~ 1ms. Use 0 for an indefinite | ||
168 | entry, default is 0) | ||
169 | sleepmode -- RA's sleep mode (currently unused, default is | ||
170 | 0) | ||
171 | snr -- SNR in the link to RA (currently unused, | ||
172 | default is 0) | ||
173 | |||
174 | The command does not return anything. | ||
175 | |||
176 | fwt_del | ||
177 | This command is used to remove an entry to the FWT table. The list of | ||
178 | parameters must follow the following structure: | ||
179 | |||
180 | iwpriv ethX fwt_del da ra [dir] | ||
181 | |||
182 | where the different parameters are:- | ||
183 | da -- DA MAC address (in the form "00:11:22:33:44:55") | ||
184 | ra -- RA MAC address (in the form "00:11:22:33:44:55") | ||
185 | dir -- direction (1 for direct, 0 for reverse, | ||
186 | default is 1) | ||
187 | |||
188 | The command does not return anything. | ||
189 | |||
190 | fwt_lookup | ||
191 | This command is used to get the best route in the FWT table to a given | ||
192 | host. The only parameter is the MAC address of the host that is being | ||
193 | looked for. | ||
194 | |||
195 | iwpriv ethX fwt_lookup da | ||
196 | |||
197 | where:- | ||
198 | da -- DA MAC address (in the form "00:11:22:33:44:55") | ||
199 | |||
200 | The command returns an output string identical to the one returned by | ||
201 | fwt_list described below. | ||
202 | |||
203 | |||
204 | fwt_list | ||
205 | This command is used to list a route from the FWT table. The only | ||
206 | parameter is the index into the table. If you want to list all the | ||
207 | routes in a table, start with index=0, and keep listing until you get a | ||
208 | "(null)" string. Note that the indicies may change as the fwt is | ||
209 | updated. It is expected that most users will not use fwt_list directly, | ||
210 | but that a utility similar to the traditional route command will be used | ||
211 | to invoke fwt_list over and over. | ||
212 | |||
213 | iwpriv ethX fwt_list index | ||
214 | |||
215 | The output is a string of the following form: | ||
216 | |||
217 | da ra valid metric dir rate ssn dsn hopcount ttl expiration | ||
218 | sleepmode snr precursor | ||
219 | |||
220 | where the different fields are:- | ||
221 | da -- DA MAC address (in the form "00:11:22:33:44:55") | ||
222 | ra -- RA MAC address (in the form "00:11:22:33:44:55") | ||
223 | valid -- whether the route is valid (0 if not valid) | ||
224 | metric -- route metric (cost: smaller-metric routes are preferred) | ||
225 | dir -- direction (1 for direct, 0 for reverse) | ||
226 | rate -- data rate used for transmission to the RA, | ||
227 | as specified for the rateadapt command | ||
228 | ssn -- Source Sequence Number (time at the RA for reverse routes) | ||
229 | dsn -- Destination Sequence Number (time at the DA for direct routes) | ||
230 | hopcount -- hop count (currently unused) | ||
231 | ttl -- TTL (only used in reverse entries) | ||
232 | expiration -- entry expiration (in ticks, where a tick is 1024us, or ~ 1ms. Use 0 for an indefinite entry) | ||
233 | sleepmode -- RA's sleep mode (currently unused) | ||
234 | snr -- SNR in the link to RA (currently unused) | ||
235 | precursor -- predecessor in direct routes | ||
236 | |||
237 | fwt_list_route | ||
238 | This command is equivalent to fwt_list. | ||
239 | |||
240 | fwt_list_neigh | ||
241 | This command is used to list a neighbor from the FWT table. The only | ||
242 | parameter is the neighbor ID. If you want to list all the neighbors in a | ||
243 | table, start with nid=0, and keep incrementing nid until you get a | ||
244 | "(null)" string. Note that the nid from a fwt_list_route command can be | ||
245 | used as an input to this command. Also note that this command is meant | ||
246 | mostly for debugging. It is expected that users will use fwt_lookup. | ||
247 | One important reason for this is that the neighbor id may change as the | ||
248 | neighbor table is altered. | ||
249 | |||
250 | iwpriv ethX fwt_list_neigh nid | ||
251 | |||
252 | The output is a string of the following form: | ||
253 | |||
254 | ra sleepmode snr references | ||
255 | |||
256 | where the different fields are:- | ||
257 | ra -- RA MAC address (in the form "00:11:22:33:44:55") | ||
258 | sleepmode -- RA's sleep mode (currently unused) | ||
259 | snr -- SNR in the link to RA (currently unused) | ||
260 | references -- RA's reference counter | ||
261 | |||
262 | fwt_reset | ||
263 | This command is used to reset the FWT table, getting rid of all the | ||
264 | entries. There are no input parameters. | ||
265 | |||
266 | iwpriv ethX fwt_reset | ||
267 | |||
268 | The command does not return anything. | ||
269 | |||
270 | fwt_cleanup | ||
271 | This command is used to perform user-based garbage recollection. The | ||
272 | FWT table is checked, and all the entries that are expired or invalid | ||
273 | are cleaned. Note that this is exported to the driver for debugging | ||
274 | purposes, as garbage collection is also fired by the firmware when in | ||
275 | space problems. There are no input parameters. | ||
276 | |||
277 | iwpriv ethX fwt_cleanup | ||
278 | |||
279 | The command does returns the number of invalid/expired routes deleted. | ||
280 | |||
281 | fwt_time | ||
282 | This command returns a card's internal time representation. It is this | ||
283 | time that is used to represent the expiration times of FWT entries. The | ||
284 | number is not consistent from card to card; it is simply a timer count. | ||
285 | The fwt_time command is used to inspect the timer so that expiration | ||
286 | times reported by fwt_list can be properly interpreted. | ||
287 | |||
288 | iwpriv ethX fwt_time | ||
289 | |||
290 | mesh_get_ttl | ||
291 | |||
292 | The mesh ttl is the number of hops a mesh packet can traverse before it | ||
293 | is dropped. This parameter is used to prevent infinite loops in the | ||
294 | mesh network. The value returned by this function is the ttl assigned | ||
295 | to all mesh packets. Currently there is no way to control the ttl on a | ||
296 | per packet or per socket basis. | ||
297 | |||
298 | iwpriv ethX mesh_get_ttl | ||
299 | |||
300 | mesh_set_ttl ttl | ||
301 | |||
302 | Set the ttl. The argument must be between 0 and 255. | ||
303 | |||
304 | iwpriv ethX mesh_set_ttl <ttl> | ||
305 | |||
306 | ========================= | 31 | ========================= |
307 | ETHTOOL | 32 | ETHTOOL |
308 | ========================= | 33 | ========================= |