2 * Functions implementing wlan scan IOCTL and firmware command APIs
4 * IOCTL handlers as well as command preperation and response routines
5 * for sending scan commands to the firmware.
7 #include <linux/etherdevice.h>
8 #include <asm/unaligned.h>
16 //! Approximate amount of data needed to pass a scan result back to iwlist
17 #define MAX_SCAN_CELL_SIZE (IW_EV_ADDR_LEN \
24 + 40) /* 40 for WPAIE */
26 //! Memory needed to store a max sized channel List TLV for a firmware scan
27 #define CHAN_TLV_MAX_SIZE (sizeof(struct mrvlietypesheader) \
28 + (MRVDRV_MAX_CHANNELS_PER_SCAN \
29 * sizeof(struct chanscanparamset)))
31 //! Memory needed to store a max number/size SSID TLV for a firmware scan
32 #define SSID_TLV_MAX_SIZE (1 * sizeof(struct mrvlietypes_ssidparamset))
34 //! Maximum memory needed for a cmd_ds_802_11_scan with all TLVs at max
35 #define MAX_SCAN_CFG_ALLOC (sizeof(struct cmd_ds_802_11_scan) \
36 + CHAN_TLV_MAX_SIZE + SSID_TLV_MAX_SIZE)
38 //! The maximum number of channels the firmware can scan per command
39 #define MRVDRV_MAX_CHANNELS_PER_SCAN 14
42 * @brief Number of channels to scan per firmware scan command issuance.
44 * Number restricted to prevent hitting the limit on the amount of scan data
45 * returned in a single firmware scan command.
47 #define MRVDRV_CHANNELS_PER_SCAN_CMD 4
49 //! Scan time specified in the channel TLV for each channel for passive scans
50 #define MRVDRV_PASSIVE_SCAN_CHAN_TIME 100
52 //! Scan time specified in the channel TLV for each channel for active scans
53 #define MRVDRV_ACTIVE_SCAN_CHAN_TIME 100
55 static int lbs_ret_80211_scan(struct lbs_private *priv, unsigned long dummy,
56 struct cmd_header *resp);
58 /*********************************************************************/
60 /* Misc helper functions */
62 /*********************************************************************/
65 * @brief Unsets the MSB on basic rates
67 * Scan through an array and unset the MSB for basic data rates.
69 * @param rates buffer of data rates
70 * @param len size of buffer
72 static void lbs_unset_basic_rate_flags(u8 *rates, size_t len)
76 for (i = 0; i < len; i++)
81 static inline void clear_bss_descriptor(struct bss_descriptor *bss)
83 /* Don't blow away ->list, just BSS data */
84 memset(bss, 0, offsetof(struct bss_descriptor, list));
88 * @brief Compare two SSIDs
90 * @param ssid1 A pointer to ssid to compare
91 * @param ssid2 A pointer to ssid to compare
93 * @return 0: ssid is same, otherwise is different
95 int lbs_ssid_cmp(uint8_t *ssid1, uint8_t ssid1_len, uint8_t *ssid2,
98 if (ssid1_len != ssid2_len)
101 return memcmp(ssid1, ssid2, ssid1_len);
104 static inline int is_same_network(struct bss_descriptor *src,
105 struct bss_descriptor *dst)
107 /* A network is only a duplicate if the channel, BSSID, and ESSID
108 * all match. We treat all <hidden> with the same BSSID and channel
110 return ((src->ssid_len == dst->ssid_len) &&
111 (src->channel == dst->channel) &&
112 !compare_ether_addr(src->bssid, dst->bssid) &&
113 !memcmp(src->ssid, dst->ssid, src->ssid_len));
119 /*********************************************************************/
121 /* Main scanning support */
123 /*********************************************************************/
126 * @brief Create a channel list for the driver to scan based on region info
128 * Only used from lbs_scan_setup_scan_config()
130 * Use the driver region/band information to construct a comprehensive list
131 * of channels to scan. This routine is used for any scan that is not
132 * provided a specific channel list to scan.
134 * @param priv A pointer to struct lbs_private structure
135 * @param scanchanlist Output parameter: resulting channel list to scan
139 static int lbs_scan_create_channel_list(struct lbs_private *priv,
140 struct chanscanparamset *scanchanlist)
142 struct region_channel *scanregion;
143 struct chan_freq_power *cfp;
151 /* Set the default scan type to the user specified type, will later
152 * be changed to passive on a per channel basis if restricted by
153 * regulatory requirements (11d or 11h)
155 scantype = CMD_SCAN_TYPE_ACTIVE;
157 for (rgnidx = 0; rgnidx < ARRAY_SIZE(priv->region_channel); rgnidx++) {
158 if (priv->enable11d && (priv->connect_status != LBS_CONNECTED)
159 && (priv->mesh_connect_status != LBS_CONNECTED)) {
160 /* Scan all the supported chan for the first scan */
161 if (!priv->universal_channel[rgnidx].valid)
163 scanregion = &priv->universal_channel[rgnidx];
165 /* clear the parsed_region_chan for the first scan */
166 memset(&priv->parsed_region_chan, 0x00,
167 sizeof(priv->parsed_region_chan));
169 if (!priv->region_channel[rgnidx].valid)
171 scanregion = &priv->region_channel[rgnidx];
174 for (nextchan = 0; nextchan < scanregion->nrcfp; nextchan++, chanidx++) {
175 struct chanscanparamset *chan = &scanchanlist[chanidx];
177 cfp = scanregion->CFP + nextchan;
180 scantype = lbs_get_scan_type_11d(cfp->channel,
181 &priv->parsed_region_chan);
183 if (scanregion->band == BAND_B || scanregion->band == BAND_G)
184 chan->radiotype = CMD_SCAN_RADIO_TYPE_BG;
186 if (scantype == CMD_SCAN_TYPE_PASSIVE) {
187 chan->maxscantime = cpu_to_le16(MRVDRV_PASSIVE_SCAN_CHAN_TIME);
188 chan->chanscanmode.passivescan = 1;
190 chan->maxscantime = cpu_to_le16(MRVDRV_ACTIVE_SCAN_CHAN_TIME);
191 chan->chanscanmode.passivescan = 0;
194 chan->channumber = cfp->channel;
201 * Add SSID TLV of the form:
205 * ssid 4d 4e 54 45 53 54
207 static int lbs_scan_add_ssid_tlv(struct lbs_private *priv, u8 *tlv)
209 struct mrvlietypes_ssidparamset *ssid_tlv = (void *)tlv;
211 ssid_tlv->header.type = cpu_to_le16(TLV_TYPE_SSID);
212 ssid_tlv->header.len = cpu_to_le16(priv->scan_ssid_len);
213 memcpy(ssid_tlv->ssid, priv->scan_ssid, priv->scan_ssid_len);
214 return sizeof(ssid_tlv->header) + priv->scan_ssid_len;
218 * Add CHANLIST TLV of the form
220 * TLV-ID CHANLIST 01 01
222 * channel 1 00 01 00 00 00 64 00
226 * min scan time 00 00
227 * max scan time 64 00
228 * channel 2 00 02 00 00 00 64 00
229 * channel 3 00 03 00 00 00 64 00
230 * channel 4 00 04 00 00 00 64 00
231 * channel 5 00 05 00 00 00 64 00
232 * channel 6 00 06 00 00 00 64 00
233 * channel 7 00 07 00 00 00 64 00
234 * channel 8 00 08 00 00 00 64 00
235 * channel 9 00 09 00 00 00 64 00
236 * channel 10 00 0a 00 00 00 64 00
237 * channel 11 00 0b 00 00 00 64 00
238 * channel 12 00 0c 00 00 00 64 00
239 * channel 13 00 0d 00 00 00 64 00
242 static int lbs_scan_add_chanlist_tlv(uint8_t *tlv,
243 struct chanscanparamset *chan_list,
246 size_t size = sizeof(struct chanscanparamset) *chan_count;
247 struct mrvlietypes_chanlistparamset *chan_tlv = (void *)tlv;
249 chan_tlv->header.type = cpu_to_le16(TLV_TYPE_CHANLIST);
250 memcpy(chan_tlv->chanscanparam, chan_list, size);
251 chan_tlv->header.len = cpu_to_le16(size);
252 return sizeof(chan_tlv->header) + size;
256 * Add RATES TLV of the form
260 * rates 82 84 8b 96 0c 12 18 24 30 48 60 6c
262 * The rates are in lbs_bg_rates[], but for the 802.11b
263 * rates the high bit isn't set.
265 static int lbs_scan_add_rates_tlv(uint8_t *tlv)
268 struct mrvlietypes_ratesparamset *rate_tlv = (void *)tlv;
270 rate_tlv->header.type = cpu_to_le16(TLV_TYPE_RATES);
271 tlv += sizeof(rate_tlv->header);
272 for (i = 0; i < MAX_RATES; i++) {
273 *tlv = lbs_bg_rates[i];
276 /* This code makes sure that the 802.11b rates (1 MBit/s, 2
277 MBit/s, 5.5 MBit/s and 11 MBit/s get's the high bit set.
278 Note that the values are MBit/s * 2, to mark them as
279 basic rates so that the firmware likes it better */
280 if (*tlv == 0x02 || *tlv == 0x04 ||
281 *tlv == 0x0b || *tlv == 0x16)
285 rate_tlv->header.len = cpu_to_le16(i);
286 return sizeof(rate_tlv->header) + i;
290 * Generate the CMD_802_11_SCAN command with the proper tlv
291 * for a bunch of channels.
293 static int lbs_do_scan(struct lbs_private *priv, uint8_t bsstype,
294 struct chanscanparamset *chan_list, int chan_count)
297 struct cmd_ds_802_11_scan *scan_cmd;
298 uint8_t *tlv; /* pointer into our current, growing TLV storage area */
300 lbs_deb_enter_args(LBS_DEB_SCAN, "bsstype %d, chanlist[].chan %d, chan_count %d",
301 bsstype, chan_list ? chan_list[0].channumber : -1,
304 /* create the fixed part for scan command */
305 scan_cmd = kzalloc(MAX_SCAN_CFG_ALLOC, GFP_KERNEL);
306 if (scan_cmd == NULL)
309 tlv = scan_cmd->tlvbuffer;
310 /* TODO: do we need to scan for a specific BSSID?
311 memcpy(scan_cmd->bssid, priv->scan_bssid, ETH_ALEN); */
312 scan_cmd->bsstype = bsstype;
315 if (priv->scan_ssid_len)
316 tlv += lbs_scan_add_ssid_tlv(priv, tlv);
317 if (chan_list && chan_count)
318 tlv += lbs_scan_add_chanlist_tlv(tlv, chan_list, chan_count);
319 tlv += lbs_scan_add_rates_tlv(tlv);
321 /* This is the final data we are about to send */
322 scan_cmd->hdr.size = cpu_to_le16(tlv - (uint8_t *)scan_cmd);
323 lbs_deb_hex(LBS_DEB_SCAN, "SCAN_CMD", (void *)scan_cmd,
325 lbs_deb_hex(LBS_DEB_SCAN, "SCAN_TLV", scan_cmd->tlvbuffer,
326 tlv - scan_cmd->tlvbuffer);
328 ret = __lbs_cmd(priv, CMD_802_11_SCAN, &scan_cmd->hdr,
329 le16_to_cpu(scan_cmd->hdr.size),
330 lbs_ret_80211_scan, 0);
334 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
339 * @brief Internal function used to start a scan based on an input config
341 * Use the input user scan configuration information when provided in
342 * order to send the appropriate scan commands to firmware to populate or
343 * update the internal driver scan table
345 * @param priv A pointer to struct lbs_private structure
346 * @param full_scan Do a full-scan (blocking)
348 * @return 0 or < 0 if error
350 int lbs_scan_networks(struct lbs_private *priv, int full_scan)
353 struct chanscanparamset *chan_list;
354 struct chanscanparamset *curr_chans;
356 uint8_t bsstype = CMD_BSS_TYPE_ANY;
357 int numchannels = MRVDRV_CHANNELS_PER_SCAN_CMD;
358 union iwreq_data wrqu;
359 #ifdef CONFIG_LIBERTAS_DEBUG
360 struct bss_descriptor *iter;
362 DECLARE_MAC_BUF(mac);
365 lbs_deb_enter_args(LBS_DEB_SCAN, "full_scan %d", full_scan);
367 /* Cancel any partial outstanding partial scans if this scan
370 if (full_scan && delayed_work_pending(&priv->scan_work))
371 cancel_delayed_work(&priv->scan_work);
373 /* User-specified bsstype or channel list
374 TODO: this can be implemented if some user-space application
375 need the feature. Formerly, it was accessible from debugfs,
376 but then nowhere used.
378 if (user_cfg->bsstype)
379 bsstype = user_cfg->bsstype;
382 lbs_deb_scan("numchannels %d, bsstype %d\n", numchannels, bsstype);
384 /* Create list of channels to scan */
385 chan_list = kzalloc(sizeof(struct chanscanparamset) *
386 LBS_IOCTL_USER_SCAN_CHAN_MAX, GFP_KERNEL);
388 lbs_pr_alert("SCAN: chan_list empty\n");
392 /* We want to scan all channels */
393 chan_count = lbs_scan_create_channel_list(priv, chan_list);
395 netif_stop_queue(priv->dev);
396 netif_carrier_off(priv->dev);
397 if (priv->mesh_dev) {
398 netif_stop_queue(priv->mesh_dev);
399 netif_carrier_off(priv->mesh_dev);
402 /* Prepare to continue an interrupted scan */
403 lbs_deb_scan("chan_count %d, scan_channel %d\n",
404 chan_count, priv->scan_channel);
405 curr_chans = chan_list;
406 /* advance channel list by already-scanned-channels */
407 if (priv->scan_channel > 0) {
408 curr_chans += priv->scan_channel;
409 chan_count -= priv->scan_channel;
412 /* Send scan command(s)
413 * numchannels contains the number of channels we should maximally scan
414 * chan_count is the total number of channels to scan
418 int to_scan = min(numchannels, chan_count);
419 lbs_deb_scan("scanning %d of %d channels\n",
420 to_scan, chan_count);
421 ret = lbs_do_scan(priv, bsstype, curr_chans,
424 lbs_pr_err("SCAN_CMD failed\n");
427 curr_chans += to_scan;
428 chan_count -= to_scan;
430 /* somehow schedule the next part of the scan */
431 if (chan_count && !full_scan &&
432 !priv->surpriseremoved) {
433 /* -1 marks just that we're currently scanning */
434 if (priv->scan_channel < 0)
435 priv->scan_channel = to_scan;
437 priv->scan_channel += to_scan;
438 cancel_delayed_work(&priv->scan_work);
439 queue_delayed_work(priv->work_thread, &priv->scan_work,
440 msecs_to_jiffies(300));
441 /* skip over GIWSCAN event */
446 memset(&wrqu, 0, sizeof(union iwreq_data));
447 wireless_send_event(priv->dev, SIOCGIWSCAN, &wrqu, NULL);
449 #ifdef CONFIG_LIBERTAS_DEBUG
450 /* Dump the scan table */
451 mutex_lock(&priv->lock);
452 lbs_deb_scan("scan table:\n");
453 list_for_each_entry(iter, &priv->network_list, list)
454 lbs_deb_scan("%02d: BSSID %s, RSSI %d, SSID '%s'\n",
455 i++, print_mac(mac, iter->bssid), iter->rssi,
456 escape_essid(iter->ssid, iter->ssid_len));
457 mutex_unlock(&priv->lock);
461 priv->scan_channel = 0;
464 if (priv->connect_status == LBS_CONNECTED) {
465 netif_carrier_on(priv->dev);
466 if (!priv->tx_pending_len)
467 netif_wake_queue(priv->dev);
469 if (priv->mesh_dev && (priv->mesh_connect_status == LBS_CONNECTED)) {
470 netif_carrier_on(priv->mesh_dev);
471 if (!priv->tx_pending_len)
472 netif_wake_queue(priv->mesh_dev);
476 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
480 void lbs_scan_worker(struct work_struct *work)
482 struct lbs_private *priv =
483 container_of(work, struct lbs_private, scan_work.work);
485 lbs_deb_enter(LBS_DEB_SCAN);
486 lbs_scan_networks(priv, 0);
487 lbs_deb_leave(LBS_DEB_SCAN);
491 /*********************************************************************/
493 /* Result interpretation */
495 /*********************************************************************/
498 * @brief Interpret a BSS scan response returned from the firmware
500 * Parse the various fixed fields and IEs passed back for a a BSS probe
501 * response or beacon from the scan command. Record information as needed
502 * in the scan table struct bss_descriptor for that entry.
504 * @param bss Output parameter: Pointer to the BSS Entry
508 static int lbs_process_bss(struct bss_descriptor *bss,
509 uint8_t **pbeaconinfo, int *bytesleft)
511 struct ieeetypes_fhparamset *pFH;
512 struct ieeetypes_dsparamset *pDS;
513 struct ieeetypes_cfparamset *pCF;
514 struct ieeetypes_ibssparamset *pibss;
515 DECLARE_MAC_BUF(mac);
516 struct ieeetypes_countryinfoset *pcountryinfo;
517 uint8_t *pos, *end, *p;
518 uint8_t n_ex_rates = 0, got_basic_rates = 0, n_basic_rates = 0;
519 uint16_t beaconsize = 0;
522 lbs_deb_enter(LBS_DEB_SCAN);
524 if (*bytesleft >= sizeof(beaconsize)) {
525 /* Extract & convert beacon size from the command buffer */
526 beaconsize = get_unaligned_le16(*pbeaconinfo);
527 *bytesleft -= sizeof(beaconsize);
528 *pbeaconinfo += sizeof(beaconsize);
531 if (beaconsize == 0 || beaconsize > *bytesleft) {
532 *pbeaconinfo += *bytesleft;
538 /* Initialize the current working beacon pointer for this BSS iteration */
540 end = pos + beaconsize;
542 /* Advance the return beacon pointer past the current beacon */
543 *pbeaconinfo += beaconsize;
544 *bytesleft -= beaconsize;
546 memcpy(bss->bssid, pos, ETH_ALEN);
547 lbs_deb_scan("process_bss: BSSID %s\n", print_mac(mac, bss->bssid));
550 if ((end - pos) < 12) {
551 lbs_deb_scan("process_bss: Not enough bytes left\n");
557 * next 4 fields are RSSI, time stamp, beacon interval,
558 * and capability information
561 /* RSSI is 1 byte long */
563 lbs_deb_scan("process_bss: RSSI %d\n", *pos);
566 /* time stamp is 8 bytes long */
569 /* beacon interval is 2 bytes long */
570 bss->beaconperiod = get_unaligned_le16(pos);
573 /* capability information is 2 bytes long */
574 bss->capability = get_unaligned_le16(pos);
575 lbs_deb_scan("process_bss: capabilities 0x%04x\n", bss->capability);
578 if (bss->capability & WLAN_CAPABILITY_PRIVACY)
579 lbs_deb_scan("process_bss: WEP enabled\n");
580 if (bss->capability & WLAN_CAPABILITY_IBSS)
581 bss->mode = IW_MODE_ADHOC;
583 bss->mode = IW_MODE_INFRA;
585 /* rest of the current buffer are IE's */
586 lbs_deb_scan("process_bss: IE len %zd\n", end - pos);
587 lbs_deb_hex(LBS_DEB_SCAN, "process_bss: IE info", pos, end - pos);
589 /* process variable IE */
590 while (pos <= end - 2) {
591 struct ieee80211_info_element * elem = (void *)pos;
593 if (pos + elem->len > end) {
594 lbs_deb_scan("process_bss: error in processing IE, "
595 "bytes left < IE length\n");
601 bss->ssid_len = elem->len;
602 memcpy(bss->ssid, elem->data, elem->len);
603 lbs_deb_scan("got SSID IE: '%s', len %u\n",
604 escape_essid(bss->ssid, bss->ssid_len),
608 case MFIE_TYPE_RATES:
609 n_basic_rates = min_t(uint8_t, MAX_RATES, elem->len);
610 memcpy(bss->rates, elem->data, n_basic_rates);
612 lbs_deb_scan("got RATES IE\n");
615 case MFIE_TYPE_FH_SET:
616 pFH = (struct ieeetypes_fhparamset *) pos;
617 memmove(&bss->phyparamset.fhparamset, pFH,
618 sizeof(struct ieeetypes_fhparamset));
619 lbs_deb_scan("got FH IE\n");
622 case MFIE_TYPE_DS_SET:
623 pDS = (struct ieeetypes_dsparamset *) pos;
624 bss->channel = pDS->currentchan;
625 memcpy(&bss->phyparamset.dsparamset, pDS,
626 sizeof(struct ieeetypes_dsparamset));
627 lbs_deb_scan("got DS IE, channel %d\n", bss->channel);
630 case MFIE_TYPE_CF_SET:
631 pCF = (struct ieeetypes_cfparamset *) pos;
632 memcpy(&bss->ssparamset.cfparamset, pCF,
633 sizeof(struct ieeetypes_cfparamset));
634 lbs_deb_scan("got CF IE\n");
637 case MFIE_TYPE_IBSS_SET:
638 pibss = (struct ieeetypes_ibssparamset *) pos;
639 bss->atimwindow = le16_to_cpu(pibss->atimwindow);
640 memmove(&bss->ssparamset.ibssparamset, pibss,
641 sizeof(struct ieeetypes_ibssparamset));
642 lbs_deb_scan("got IBSS IE\n");
645 case MFIE_TYPE_COUNTRY:
646 pcountryinfo = (struct ieeetypes_countryinfoset *) pos;
647 lbs_deb_scan("got COUNTRY IE\n");
648 if (pcountryinfo->len < sizeof(pcountryinfo->countrycode)
649 || pcountryinfo->len > 254) {
650 lbs_deb_scan("process_bss: 11D- Err CountryInfo len %d, min %zd, max 254\n",
651 pcountryinfo->len, sizeof(pcountryinfo->countrycode));
656 memcpy(&bss->countryinfo, pcountryinfo, pcountryinfo->len + 2);
657 lbs_deb_hex(LBS_DEB_SCAN, "process_bss: 11d countryinfo",
658 (uint8_t *) pcountryinfo,
659 (int) (pcountryinfo->len + 2));
662 case MFIE_TYPE_RATES_EX:
663 /* only process extended supported rate if data rate is
664 * already found. Data rate IE should come before
665 * extended supported rate IE
667 lbs_deb_scan("got RATESEX IE\n");
668 if (!got_basic_rates) {
669 lbs_deb_scan("... but ignoring it\n");
673 n_ex_rates = elem->len;
674 if (n_basic_rates + n_ex_rates > MAX_RATES)
675 n_ex_rates = MAX_RATES - n_basic_rates;
677 p = bss->rates + n_basic_rates;
678 memcpy(p, elem->data, n_ex_rates);
681 case MFIE_TYPE_GENERIC:
682 if (elem->len >= 4 &&
683 elem->data[0] == 0x00 && elem->data[1] == 0x50 &&
684 elem->data[2] == 0xf2 && elem->data[3] == 0x01) {
685 bss->wpa_ie_len = min(elem->len + 2, MAX_WPA_IE_LEN);
686 memcpy(bss->wpa_ie, elem, bss->wpa_ie_len);
687 lbs_deb_scan("got WPA IE\n");
688 lbs_deb_hex(LBS_DEB_SCAN, "WPA IE", bss->wpa_ie, elem->len);
689 } else if (elem->len >= MARVELL_MESH_IE_LENGTH &&
690 elem->data[0] == 0x00 && elem->data[1] == 0x50 &&
691 elem->data[2] == 0x43 && elem->data[3] == 0x04) {
692 lbs_deb_scan("got mesh IE\n");
695 lbs_deb_scan("got generic IE: %02x:%02x:%02x:%02x, len %d\n",
696 elem->data[0], elem->data[1],
697 elem->data[2], elem->data[3],
703 lbs_deb_scan("got RSN IE\n");
704 bss->rsn_ie_len = min(elem->len + 2, MAX_WPA_IE_LEN);
705 memcpy(bss->rsn_ie, elem, bss->rsn_ie_len);
706 lbs_deb_hex(LBS_DEB_SCAN, "process_bss: RSN_IE",
707 bss->rsn_ie, elem->len);
711 lbs_deb_scan("got IE 0x%04x, len %d\n",
712 elem->id, elem->len);
716 pos += elem->len + 2;
720 bss->last_scanned = jiffies;
721 lbs_unset_basic_rate_flags(bss->rates, sizeof(bss->rates));
726 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
731 * @brief Send a scan command for all available channels filtered on a spec
733 * Used in association code and from debugfs
735 * @param priv A pointer to struct lbs_private structure
736 * @param ssid A pointer to the SSID to scan for
737 * @param ssid_len Length of the SSID
739 * @return 0-success, otherwise fail
741 int lbs_send_specific_ssid_scan(struct lbs_private *priv, uint8_t *ssid,
746 lbs_deb_enter_args(LBS_DEB_SCAN, "SSID '%s'\n",
747 escape_essid(ssid, ssid_len));
752 memcpy(priv->scan_ssid, ssid, ssid_len);
753 priv->scan_ssid_len = ssid_len;
755 lbs_scan_networks(priv, 1);
756 if (priv->surpriseremoved) {
762 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
769 /*********************************************************************/
771 /* Support for Wireless Extensions */
773 /*********************************************************************/
776 #define MAX_CUSTOM_LEN 64
778 static inline char *lbs_translate_scan(struct lbs_private *priv,
779 struct iw_request_info *info,
780 char *start, char *stop,
781 struct bss_descriptor *bss)
783 struct chan_freq_power *cfp;
784 char *current_val; /* For rates */
785 struct iw_event iwe; /* Temporary buffer */
787 #define PERFECT_RSSI ((uint8_t)50)
788 #define WORST_RSSI ((uint8_t)0)
789 #define RSSI_DIFF ((uint8_t)(PERFECT_RSSI - WORST_RSSI))
792 lbs_deb_enter(LBS_DEB_SCAN);
794 cfp = lbs_find_cfp_by_band_and_channel(priv, 0, bss->channel);
796 lbs_deb_scan("Invalid channel number %d\n", bss->channel);
801 /* First entry *MUST* be the BSSID */
803 iwe.u.ap_addr.sa_family = ARPHRD_ETHER;
804 memcpy(iwe.u.ap_addr.sa_data, &bss->bssid, ETH_ALEN);
805 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_ADDR_LEN);
808 iwe.cmd = SIOCGIWESSID;
809 iwe.u.data.flags = 1;
810 iwe.u.data.length = min((uint32_t) bss->ssid_len, (uint32_t) IW_ESSID_MAX_SIZE);
811 start = iwe_stream_add_point(info, start, stop, &iwe, bss->ssid);
814 iwe.cmd = SIOCGIWMODE;
815 iwe.u.mode = bss->mode;
816 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_UINT_LEN);
819 iwe.cmd = SIOCGIWFREQ;
820 iwe.u.freq.m = (long)cfp->freq * 100000;
822 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_FREQ_LEN);
824 /* Add quality statistics */
826 iwe.u.qual.updated = IW_QUAL_ALL_UPDATED;
827 iwe.u.qual.level = SCAN_RSSI(bss->rssi);
829 rssi = iwe.u.qual.level - MRVDRV_NF_DEFAULT_SCAN_VALUE;
831 (100 * RSSI_DIFF * RSSI_DIFF - (PERFECT_RSSI - rssi) *
832 (15 * (RSSI_DIFF) + 62 * (PERFECT_RSSI - rssi))) /
833 (RSSI_DIFF * RSSI_DIFF);
834 if (iwe.u.qual.qual > 100)
835 iwe.u.qual.qual = 100;
837 if (priv->NF[TYPE_BEACON][TYPE_NOAVG] == 0) {
838 iwe.u.qual.noise = MRVDRV_NF_DEFAULT_SCAN_VALUE;
840 iwe.u.qual.noise = CAL_NF(priv->NF[TYPE_BEACON][TYPE_NOAVG]);
843 /* Locally created ad-hoc BSSs won't have beacons if this is the
844 * only station in the adhoc network; so get signal strength
845 * from receive statistics.
847 if ((priv->mode == IW_MODE_ADHOC) && priv->adhoccreate
848 && !lbs_ssid_cmp(priv->curbssparams.ssid,
849 priv->curbssparams.ssid_len,
850 bss->ssid, bss->ssid_len)) {
852 snr = priv->SNR[TYPE_RXPD][TYPE_AVG] / AVG_SCALE;
853 nf = priv->NF[TYPE_RXPD][TYPE_AVG] / AVG_SCALE;
854 iwe.u.qual.level = CAL_RSSI(snr, nf);
856 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_QUAL_LEN);
858 /* Add encryption capability */
859 iwe.cmd = SIOCGIWENCODE;
860 if (bss->capability & WLAN_CAPABILITY_PRIVACY) {
861 iwe.u.data.flags = IW_ENCODE_ENABLED | IW_ENCODE_NOKEY;
863 iwe.u.data.flags = IW_ENCODE_DISABLED;
865 iwe.u.data.length = 0;
866 start = iwe_stream_add_point(info, start, stop, &iwe, bss->ssid);
868 current_val = start + iwe_stream_lcp_len(info);
870 iwe.cmd = SIOCGIWRATE;
871 iwe.u.bitrate.fixed = 0;
872 iwe.u.bitrate.disabled = 0;
873 iwe.u.bitrate.value = 0;
875 for (j = 0; bss->rates[j] && (j < sizeof(bss->rates)); j++) {
876 /* Bit rate given in 500 kb/s units */
877 iwe.u.bitrate.value = bss->rates[j] * 500000;
878 current_val = iwe_stream_add_value(info, start, current_val,
879 stop, &iwe, IW_EV_PARAM_LEN);
881 if ((bss->mode == IW_MODE_ADHOC) && priv->adhoccreate
882 && !lbs_ssid_cmp(priv->curbssparams.ssid,
883 priv->curbssparams.ssid_len,
884 bss->ssid, bss->ssid_len)) {
885 iwe.u.bitrate.value = 22 * 500000;
886 current_val = iwe_stream_add_value(info, start, current_val,
887 stop, &iwe, IW_EV_PARAM_LEN);
889 /* Check if we added any event */
890 if ((current_val - start) > iwe_stream_lcp_len(info))
893 memset(&iwe, 0, sizeof(iwe));
894 if (bss->wpa_ie_len) {
895 char buf[MAX_WPA_IE_LEN];
896 memcpy(buf, bss->wpa_ie, bss->wpa_ie_len);
898 iwe.u.data.length = bss->wpa_ie_len;
899 start = iwe_stream_add_point(info, start, stop, &iwe, buf);
902 memset(&iwe, 0, sizeof(iwe));
903 if (bss->rsn_ie_len) {
904 char buf[MAX_WPA_IE_LEN];
905 memcpy(buf, bss->rsn_ie, bss->rsn_ie_len);
907 iwe.u.data.length = bss->rsn_ie_len;
908 start = iwe_stream_add_point(info, start, stop, &iwe, buf);
912 char custom[MAX_CUSTOM_LEN];
915 iwe.cmd = IWEVCUSTOM;
916 p += snprintf(p, MAX_CUSTOM_LEN, "mesh-type: olpc");
917 iwe.u.data.length = p - custom;
918 if (iwe.u.data.length)
919 start = iwe_stream_add_point(info, start, stop,
924 lbs_deb_leave_args(LBS_DEB_SCAN, "start %p", start);
930 * @brief Handle Scan Network ioctl
932 * @param dev A pointer to net_device structure
933 * @param info A pointer to iw_request_info structure
934 * @param vwrq A pointer to iw_param structure
935 * @param extra A pointer to extra data buf
937 * @return 0 --success, otherwise fail
939 int lbs_set_scan(struct net_device *dev, struct iw_request_info *info,
940 union iwreq_data *wrqu, char *extra)
942 struct lbs_private *priv = dev->priv;
945 lbs_deb_enter(LBS_DEB_WEXT);
947 if (!netif_running(dev)) {
952 /* mac80211 does this:
953 struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
954 if (sdata->type != IEEE80211_IF_TYPE_xxx) {
960 if (wrqu->data.length == sizeof(struct iw_scan_req) &&
961 wrqu->data.flags & IW_SCAN_THIS_ESSID) {
962 struct iw_scan_req *req = (struct iw_scan_req *)extra;
963 priv->scan_ssid_len = req->essid_len;
964 memcpy(priv->scan_ssid, req->essid, priv->scan_ssid_len);
965 lbs_deb_wext("set_scan, essid '%s'\n",
966 escape_essid(priv->scan_ssid, priv->scan_ssid_len));
968 priv->scan_ssid_len = 0;
971 if (!delayed_work_pending(&priv->scan_work))
972 queue_delayed_work(priv->work_thread, &priv->scan_work,
973 msecs_to_jiffies(50));
974 /* set marker that currently a scan is taking place */
975 priv->scan_channel = -1;
977 if (priv->surpriseremoved)
981 lbs_deb_leave_args(LBS_DEB_WEXT, "ret %d", ret);
987 * @brief Handle Retrieve scan table ioctl
989 * @param dev A pointer to net_device structure
990 * @param info A pointer to iw_request_info structure
991 * @param dwrq A pointer to iw_point structure
992 * @param extra A pointer to extra data buf
994 * @return 0 --success, otherwise fail
996 int lbs_get_scan(struct net_device *dev, struct iw_request_info *info,
997 struct iw_point *dwrq, char *extra)
999 #define SCAN_ITEM_SIZE 128
1000 struct lbs_private *priv = dev->priv;
1003 char *stop = ev + dwrq->length;
1004 struct bss_descriptor *iter_bss;
1005 struct bss_descriptor *safe;
1007 lbs_deb_enter(LBS_DEB_WEXT);
1009 /* iwlist should wait until the current scan is finished */
1010 if (priv->scan_channel)
1013 /* Update RSSI if current BSS is a locally created ad-hoc BSS */
1014 if ((priv->mode == IW_MODE_ADHOC) && priv->adhoccreate)
1015 lbs_prepare_and_send_command(priv, CMD_802_11_RSSI, 0,
1016 CMD_OPTION_WAITFORRSP, 0, NULL);
1018 mutex_lock(&priv->lock);
1019 list_for_each_entry_safe (iter_bss, safe, &priv->network_list, list) {
1021 unsigned long stale_time;
1023 if (stop - ev < SCAN_ITEM_SIZE) {
1028 /* For mesh device, list only mesh networks */
1029 if (dev == priv->mesh_dev && !iter_bss->mesh)
1032 /* Prune old an old scan result */
1033 stale_time = iter_bss->last_scanned + DEFAULT_MAX_SCAN_AGE;
1034 if (time_after(jiffies, stale_time)) {
1035 list_move_tail(&iter_bss->list, &priv->network_free_list);
1036 clear_bss_descriptor(iter_bss);
1040 /* Translate to WE format this entry */
1041 next_ev = lbs_translate_scan(priv, info, ev, stop, iter_bss);
1042 if (next_ev == NULL)
1046 mutex_unlock(&priv->lock);
1048 dwrq->length = (ev - extra);
1051 lbs_deb_leave_args(LBS_DEB_WEXT, "ret %d", err);
1058 /*********************************************************************/
1060 /* Command execution */
1062 /*********************************************************************/
1066 * @brief This function handles the command response of scan
1068 * Called from handle_cmd_response() in cmdrespc.
1070 * The response buffer for the scan command has the following
1073 * .-----------------------------------------------------------.
1074 * | header (4 * sizeof(u16)): Standard command response hdr |
1075 * .-----------------------------------------------------------.
1076 * | bufsize (u16) : sizeof the BSS Description data |
1077 * .-----------------------------------------------------------.
1078 * | NumOfSet (u8) : Number of BSS Descs returned |
1079 * .-----------------------------------------------------------.
1080 * | BSSDescription data (variable, size given in bufsize) |
1081 * .-----------------------------------------------------------.
1082 * | TLV data (variable, size calculated using header->size, |
1083 * | bufsize and sizeof the fixed fields above) |
1084 * .-----------------------------------------------------------.
1086 * @param priv A pointer to struct lbs_private structure
1087 * @param resp A pointer to cmd_ds_command
1091 static int lbs_ret_80211_scan(struct lbs_private *priv, unsigned long dummy,
1092 struct cmd_header *resp)
1094 struct cmd_ds_802_11_scan_rsp *scanresp = (void *)resp;
1095 struct bss_descriptor *iter_bss;
1096 struct bss_descriptor *safe;
1098 uint16_t scanrespsize;
1104 lbs_deb_enter(LBS_DEB_SCAN);
1106 /* Prune old entries from scan table */
1107 list_for_each_entry_safe (iter_bss, safe, &priv->network_list, list) {
1108 unsigned long stale_time = iter_bss->last_scanned + DEFAULT_MAX_SCAN_AGE;
1109 if (time_before(jiffies, stale_time))
1111 list_move_tail (&iter_bss->list, &priv->network_free_list);
1112 clear_bss_descriptor(iter_bss);
1115 if (scanresp->nr_sets > MAX_NETWORK_COUNT) {
1116 lbs_deb_scan("SCAN_RESP: too many scan results (%d, max %d)\n",
1117 scanresp->nr_sets, MAX_NETWORK_COUNT);
1122 bytesleft = le16_to_cpu(scanresp->bssdescriptsize);
1123 lbs_deb_scan("SCAN_RESP: bssdescriptsize %d\n", bytesleft);
1125 scanrespsize = le16_to_cpu(resp->size);
1126 lbs_deb_scan("SCAN_RESP: scan results %d\n", scanresp->nr_sets);
1128 bssinfo = scanresp->bssdesc_and_tlvbuffer;
1130 /* The size of the TLV buffer is equal to the entire command response
1131 * size (scanrespsize) minus the fixed fields (sizeof()'s), the
1132 * BSS Descriptions (bssdescriptsize as bytesLef) and the command
1133 * response header (S_DS_GEN)
1135 tlvbufsize = scanrespsize - (bytesleft + sizeof(scanresp->bssdescriptsize)
1136 + sizeof(scanresp->nr_sets)
1140 * Process each scan response returned (scanresp->nr_sets). Save
1141 * the information in the newbssentry and then insert into the
1142 * driver scan table either as an update to an existing entry
1143 * or as an addition at the end of the table
1145 for (idx = 0; idx < scanresp->nr_sets && bytesleft; idx++) {
1146 struct bss_descriptor new;
1147 struct bss_descriptor *found = NULL;
1148 struct bss_descriptor *oldest = NULL;
1149 DECLARE_MAC_BUF(mac);
1151 /* Process the data fields and IEs returned for this BSS */
1152 memset(&new, 0, sizeof (struct bss_descriptor));
1153 if (lbs_process_bss(&new, &bssinfo, &bytesleft) != 0) {
1154 /* error parsing the scan response, skipped */
1155 lbs_deb_scan("SCAN_RESP: process_bss returned ERROR\n");
1159 /* Try to find this bss in the scan table */
1160 list_for_each_entry (iter_bss, &priv->network_list, list) {
1161 if (is_same_network(iter_bss, &new)) {
1166 if ((oldest == NULL) ||
1167 (iter_bss->last_scanned < oldest->last_scanned))
1172 /* found, clear it */
1173 clear_bss_descriptor(found);
1174 } else if (!list_empty(&priv->network_free_list)) {
1175 /* Pull one from the free list */
1176 found = list_entry(priv->network_free_list.next,
1177 struct bss_descriptor, list);
1178 list_move_tail(&found->list, &priv->network_list);
1179 } else if (oldest) {
1180 /* If there are no more slots, expire the oldest */
1182 clear_bss_descriptor(found);
1183 list_move_tail(&found->list, &priv->network_list);
1188 lbs_deb_scan("SCAN_RESP: BSSID %s\n", print_mac(mac, new.bssid));
1190 /* Copy the locally created newbssentry to the scan table */
1191 memcpy(found, &new, offsetof(struct bss_descriptor, list));
1197 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);