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/types.h>
8 #include <linux/kernel.h>
9 #include <linux/etherdevice.h>
10 #include <linux/if_arp.h>
11 #include <asm/unaligned.h>
12 #include <net/lib80211.h>
21 //! Approximate amount of data needed to pass a scan result back to iwlist
22 #define MAX_SCAN_CELL_SIZE (IW_EV_ADDR_LEN \
23 + IEEE80211_MAX_SSID_LEN \
27 + IEEE80211_MAX_SSID_LEN \
29 + 40) /* 40 for WPAIE */
31 //! Memory needed to store a max sized channel List TLV for a firmware scan
32 #define CHAN_TLV_MAX_SIZE (sizeof(struct mrvl_ie_header) \
33 + (MRVDRV_MAX_CHANNELS_PER_SCAN \
34 * sizeof(struct chanscanparamset)))
36 //! Memory needed to store a max number/size SSID TLV for a firmware scan
37 #define SSID_TLV_MAX_SIZE (1 * sizeof(struct mrvl_ie_ssid_param_set))
39 //! Maximum memory needed for a cmd_ds_802_11_scan with all TLVs at max
40 #define MAX_SCAN_CFG_ALLOC (sizeof(struct cmd_ds_802_11_scan) \
41 + CHAN_TLV_MAX_SIZE + SSID_TLV_MAX_SIZE)
43 //! The maximum number of channels the firmware can scan per command
44 #define MRVDRV_MAX_CHANNELS_PER_SCAN 14
47 * @brief Number of channels to scan per firmware scan command issuance.
49 * Number restricted to prevent hitting the limit on the amount of scan data
50 * returned in a single firmware scan command.
52 #define MRVDRV_CHANNELS_PER_SCAN_CMD 4
54 //! Scan time specified in the channel TLV for each channel for passive scans
55 #define MRVDRV_PASSIVE_SCAN_CHAN_TIME 100
57 //! Scan time specified in the channel TLV for each channel for active scans
58 #define MRVDRV_ACTIVE_SCAN_CHAN_TIME 100
60 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
62 static int lbs_ret_80211_scan(struct lbs_private *priv, unsigned long dummy,
63 struct cmd_header *resp);
65 /*********************************************************************/
67 /* Misc helper functions */
69 /*********************************************************************/
72 * @brief Unsets the MSB on basic rates
74 * Scan through an array and unset the MSB for basic data rates.
76 * @param rates buffer of data rates
77 * @param len size of buffer
79 static void lbs_unset_basic_rate_flags(u8 *rates, size_t len)
83 for (i = 0; i < len; i++)
88 static inline void clear_bss_descriptor(struct bss_descriptor *bss)
90 /* Don't blow away ->list, just BSS data */
91 memset(bss, 0, offsetof(struct bss_descriptor, list));
95 * @brief Compare two SSIDs
97 * @param ssid1 A pointer to ssid to compare
98 * @param ssid2 A pointer to ssid to compare
100 * @return 0: ssid is same, otherwise is different
102 int lbs_ssid_cmp(uint8_t *ssid1, uint8_t ssid1_len, uint8_t *ssid2,
105 if (ssid1_len != ssid2_len)
108 return memcmp(ssid1, ssid2, ssid1_len);
111 static inline int is_same_network(struct bss_descriptor *src,
112 struct bss_descriptor *dst)
114 /* A network is only a duplicate if the channel, BSSID, and ESSID
115 * all match. We treat all <hidden> with the same BSSID and channel
117 return ((src->ssid_len == dst->ssid_len) &&
118 (src->channel == dst->channel) &&
119 !compare_ether_addr(src->bssid, dst->bssid) &&
120 !memcmp(src->ssid, dst->ssid, src->ssid_len));
125 /*********************************************************************/
127 /* Region channel support */
129 /*********************************************************************/
131 #define LBS_TX_PWR_DEFAULT 20 /*100mW */
132 #define LBS_TX_PWR_US_DEFAULT 20 /*100mW */
133 #define LBS_TX_PWR_JP_DEFAULT 16 /*50mW */
134 #define LBS_TX_PWR_FR_DEFAULT 20 /*100mW */
135 #define LBS_TX_PWR_EMEA_DEFAULT 20 /*100mW */
137 /* Format { channel, frequency (MHz), maxtxpower } */
138 /* band: 'B/G', region: USA FCC/Canada IC */
139 static struct chan_freq_power channel_freq_power_US_BG[] = {
140 {1, 2412, LBS_TX_PWR_US_DEFAULT},
141 {2, 2417, LBS_TX_PWR_US_DEFAULT},
142 {3, 2422, LBS_TX_PWR_US_DEFAULT},
143 {4, 2427, LBS_TX_PWR_US_DEFAULT},
144 {5, 2432, LBS_TX_PWR_US_DEFAULT},
145 {6, 2437, LBS_TX_PWR_US_DEFAULT},
146 {7, 2442, LBS_TX_PWR_US_DEFAULT},
147 {8, 2447, LBS_TX_PWR_US_DEFAULT},
148 {9, 2452, LBS_TX_PWR_US_DEFAULT},
149 {10, 2457, LBS_TX_PWR_US_DEFAULT},
150 {11, 2462, LBS_TX_PWR_US_DEFAULT}
153 /* band: 'B/G', region: Europe ETSI */
154 static struct chan_freq_power channel_freq_power_EU_BG[] = {
155 {1, 2412, LBS_TX_PWR_EMEA_DEFAULT},
156 {2, 2417, LBS_TX_PWR_EMEA_DEFAULT},
157 {3, 2422, LBS_TX_PWR_EMEA_DEFAULT},
158 {4, 2427, LBS_TX_PWR_EMEA_DEFAULT},
159 {5, 2432, LBS_TX_PWR_EMEA_DEFAULT},
160 {6, 2437, LBS_TX_PWR_EMEA_DEFAULT},
161 {7, 2442, LBS_TX_PWR_EMEA_DEFAULT},
162 {8, 2447, LBS_TX_PWR_EMEA_DEFAULT},
163 {9, 2452, LBS_TX_PWR_EMEA_DEFAULT},
164 {10, 2457, LBS_TX_PWR_EMEA_DEFAULT},
165 {11, 2462, LBS_TX_PWR_EMEA_DEFAULT},
166 {12, 2467, LBS_TX_PWR_EMEA_DEFAULT},
167 {13, 2472, LBS_TX_PWR_EMEA_DEFAULT}
170 /* band: 'B/G', region: Spain */
171 static struct chan_freq_power channel_freq_power_SPN_BG[] = {
172 {10, 2457, LBS_TX_PWR_DEFAULT},
173 {11, 2462, LBS_TX_PWR_DEFAULT}
176 /* band: 'B/G', region: France */
177 static struct chan_freq_power channel_freq_power_FR_BG[] = {
178 {10, 2457, LBS_TX_PWR_FR_DEFAULT},
179 {11, 2462, LBS_TX_PWR_FR_DEFAULT},
180 {12, 2467, LBS_TX_PWR_FR_DEFAULT},
181 {13, 2472, LBS_TX_PWR_FR_DEFAULT}
184 /* band: 'B/G', region: Japan */
185 static struct chan_freq_power channel_freq_power_JPN_BG[] = {
186 {1, 2412, LBS_TX_PWR_JP_DEFAULT},
187 {2, 2417, LBS_TX_PWR_JP_DEFAULT},
188 {3, 2422, LBS_TX_PWR_JP_DEFAULT},
189 {4, 2427, LBS_TX_PWR_JP_DEFAULT},
190 {5, 2432, LBS_TX_PWR_JP_DEFAULT},
191 {6, 2437, LBS_TX_PWR_JP_DEFAULT},
192 {7, 2442, LBS_TX_PWR_JP_DEFAULT},
193 {8, 2447, LBS_TX_PWR_JP_DEFAULT},
194 {9, 2452, LBS_TX_PWR_JP_DEFAULT},
195 {10, 2457, LBS_TX_PWR_JP_DEFAULT},
196 {11, 2462, LBS_TX_PWR_JP_DEFAULT},
197 {12, 2467, LBS_TX_PWR_JP_DEFAULT},
198 {13, 2472, LBS_TX_PWR_JP_DEFAULT},
199 {14, 2484, LBS_TX_PWR_JP_DEFAULT}
203 * the structure for channel, frequency and power
205 struct region_cfp_table {
207 struct chan_freq_power *cfp_BG;
212 * the structure for the mapping between region and CFP
214 static struct region_cfp_table region_cfp_table[] = {
216 channel_freq_power_US_BG,
217 ARRAY_SIZE(channel_freq_power_US_BG),
220 {0x20, /*CANADA IC */
221 channel_freq_power_US_BG,
222 ARRAY_SIZE(channel_freq_power_US_BG),
225 {0x30, /*EU*/ channel_freq_power_EU_BG,
226 ARRAY_SIZE(channel_freq_power_EU_BG),
229 {0x31, /*SPAIN*/ channel_freq_power_SPN_BG,
230 ARRAY_SIZE(channel_freq_power_SPN_BG),
233 {0x32, /*FRANCE*/ channel_freq_power_FR_BG,
234 ARRAY_SIZE(channel_freq_power_FR_BG),
237 {0x40, /*JAPAN*/ channel_freq_power_JPN_BG,
238 ARRAY_SIZE(channel_freq_power_JPN_BG),
241 /*Add new region here */
245 * @brief This function finds the CFP in
246 * region_cfp_table based on region and band parameter.
248 * @param region The region code
249 * @param band The band
250 * @param cfp_no A pointer to CFP number
251 * @return A pointer to CFP
253 static struct chan_freq_power *lbs_get_region_cfp_table(u8 region, int *cfp_no)
257 lbs_deb_enter(LBS_DEB_MAIN);
259 end = ARRAY_SIZE(region_cfp_table);
261 for (i = 0; i < end ; i++) {
262 lbs_deb_main("region_cfp_table[i].region=%d\n",
263 region_cfp_table[i].region);
264 if (region_cfp_table[i].region == region) {
265 *cfp_no = region_cfp_table[i].cfp_no_BG;
266 lbs_deb_leave(LBS_DEB_MAIN);
267 return region_cfp_table[i].cfp_BG;
271 lbs_deb_leave_args(LBS_DEB_MAIN, "ret NULL");
275 int lbs_set_regiontable(struct lbs_private *priv, u8 region, u8 band)
280 struct chan_freq_power *cfp;
283 lbs_deb_enter(LBS_DEB_MAIN);
285 memset(priv->region_channel, 0, sizeof(priv->region_channel));
287 cfp = lbs_get_region_cfp_table(region, &cfp_no);
289 priv->region_channel[i].nrcfp = cfp_no;
290 priv->region_channel[i].CFP = cfp;
292 lbs_deb_main("wrong region code %#x in band B/G\n",
297 priv->region_channel[i].valid = 1;
298 priv->region_channel[i].region = region;
299 priv->region_channel[i].band = band;
302 lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
309 /*********************************************************************/
311 /* Main scanning support */
313 /*********************************************************************/
316 * @brief Create a channel list for the driver to scan based on region info
318 * Only used from lbs_scan_setup_scan_config()
320 * Use the driver region/band information to construct a comprehensive list
321 * of channels to scan. This routine is used for any scan that is not
322 * provided a specific channel list to scan.
324 * @param priv A pointer to struct lbs_private structure
325 * @param scanchanlist Output parameter: resulting channel list to scan
329 static int lbs_scan_create_channel_list(struct lbs_private *priv,
330 struct chanscanparamset *scanchanlist)
332 struct region_channel *scanregion;
333 struct chan_freq_power *cfp;
341 /* Set the default scan type to the user specified type, will later
342 * be changed to passive on a per channel basis if restricted by
343 * regulatory requirements (11d or 11h)
345 scantype = CMD_SCAN_TYPE_ACTIVE;
347 for (rgnidx = 0; rgnidx < ARRAY_SIZE(priv->region_channel); rgnidx++) {
348 if (!priv->region_channel[rgnidx].valid)
350 scanregion = &priv->region_channel[rgnidx];
352 for (nextchan = 0; nextchan < scanregion->nrcfp; nextchan++, chanidx++) {
353 struct chanscanparamset *chan = &scanchanlist[chanidx];
355 cfp = scanregion->CFP + nextchan;
357 if (scanregion->band == BAND_B || scanregion->band == BAND_G)
358 chan->radiotype = CMD_SCAN_RADIO_TYPE_BG;
360 if (scantype == CMD_SCAN_TYPE_PASSIVE) {
361 chan->maxscantime = cpu_to_le16(MRVDRV_PASSIVE_SCAN_CHAN_TIME);
362 chan->chanscanmode.passivescan = 1;
364 chan->maxscantime = cpu_to_le16(MRVDRV_ACTIVE_SCAN_CHAN_TIME);
365 chan->chanscanmode.passivescan = 0;
368 chan->channumber = cfp->channel;
375 * Add SSID TLV of the form:
379 * ssid 4d 4e 54 45 53 54
381 static int lbs_scan_add_ssid_tlv(struct lbs_private *priv, u8 *tlv)
383 struct mrvl_ie_ssid_param_set *ssid_tlv = (void *)tlv;
385 ssid_tlv->header.type = cpu_to_le16(TLV_TYPE_SSID);
386 ssid_tlv->header.len = cpu_to_le16(priv->scan_ssid_len);
387 memcpy(ssid_tlv->ssid, priv->scan_ssid, priv->scan_ssid_len);
388 return sizeof(ssid_tlv->header) + priv->scan_ssid_len;
392 * Add CHANLIST TLV of the form
394 * TLV-ID CHANLIST 01 01
396 * channel 1 00 01 00 00 00 64 00
400 * min scan time 00 00
401 * max scan time 64 00
402 * channel 2 00 02 00 00 00 64 00
403 * channel 3 00 03 00 00 00 64 00
404 * channel 4 00 04 00 00 00 64 00
405 * channel 5 00 05 00 00 00 64 00
406 * channel 6 00 06 00 00 00 64 00
407 * channel 7 00 07 00 00 00 64 00
408 * channel 8 00 08 00 00 00 64 00
409 * channel 9 00 09 00 00 00 64 00
410 * channel 10 00 0a 00 00 00 64 00
411 * channel 11 00 0b 00 00 00 64 00
412 * channel 12 00 0c 00 00 00 64 00
413 * channel 13 00 0d 00 00 00 64 00
416 static int lbs_scan_add_chanlist_tlv(uint8_t *tlv,
417 struct chanscanparamset *chan_list,
420 size_t size = sizeof(struct chanscanparamset) *chan_count;
421 struct mrvl_ie_chanlist_param_set *chan_tlv = (void *)tlv;
423 chan_tlv->header.type = cpu_to_le16(TLV_TYPE_CHANLIST);
424 memcpy(chan_tlv->chanscanparam, chan_list, size);
425 chan_tlv->header.len = cpu_to_le16(size);
426 return sizeof(chan_tlv->header) + size;
430 * Add RATES TLV of the form
434 * rates 82 84 8b 96 0c 12 18 24 30 48 60 6c
436 * The rates are in lbs_bg_rates[], but for the 802.11b
437 * rates the high bit isn't set.
439 static int lbs_scan_add_rates_tlv(uint8_t *tlv)
442 struct mrvl_ie_rates_param_set *rate_tlv = (void *)tlv;
444 rate_tlv->header.type = cpu_to_le16(TLV_TYPE_RATES);
445 tlv += sizeof(rate_tlv->header);
446 for (i = 0; i < MAX_RATES; i++) {
447 *tlv = lbs_bg_rates[i];
450 /* This code makes sure that the 802.11b rates (1 MBit/s, 2
451 MBit/s, 5.5 MBit/s and 11 MBit/s get's the high bit set.
452 Note that the values are MBit/s * 2, to mark them as
453 basic rates so that the firmware likes it better */
454 if (*tlv == 0x02 || *tlv == 0x04 ||
455 *tlv == 0x0b || *tlv == 0x16)
459 rate_tlv->header.len = cpu_to_le16(i);
460 return sizeof(rate_tlv->header) + i;
464 * Generate the CMD_802_11_SCAN command with the proper tlv
465 * for a bunch of channels.
467 static int lbs_do_scan(struct lbs_private *priv, uint8_t bsstype,
468 struct chanscanparamset *chan_list, int chan_count)
471 struct cmd_ds_802_11_scan *scan_cmd;
472 uint8_t *tlv; /* pointer into our current, growing TLV storage area */
474 lbs_deb_enter_args(LBS_DEB_SCAN, "bsstype %d, chanlist[].chan %d, chan_count %d",
475 bsstype, chan_list ? chan_list[0].channumber : -1,
478 /* create the fixed part for scan command */
479 scan_cmd = kzalloc(MAX_SCAN_CFG_ALLOC, GFP_KERNEL);
480 if (scan_cmd == NULL)
483 tlv = scan_cmd->tlvbuffer;
484 /* TODO: do we need to scan for a specific BSSID?
485 memcpy(scan_cmd->bssid, priv->scan_bssid, ETH_ALEN); */
486 scan_cmd->bsstype = bsstype;
489 if (priv->scan_ssid_len)
490 tlv += lbs_scan_add_ssid_tlv(priv, tlv);
491 if (chan_list && chan_count)
492 tlv += lbs_scan_add_chanlist_tlv(tlv, chan_list, chan_count);
493 tlv += lbs_scan_add_rates_tlv(tlv);
495 /* This is the final data we are about to send */
496 scan_cmd->hdr.size = cpu_to_le16(tlv - (uint8_t *)scan_cmd);
497 lbs_deb_hex(LBS_DEB_SCAN, "SCAN_CMD", (void *)scan_cmd,
499 lbs_deb_hex(LBS_DEB_SCAN, "SCAN_TLV", scan_cmd->tlvbuffer,
500 tlv - scan_cmd->tlvbuffer);
502 ret = __lbs_cmd(priv, CMD_802_11_SCAN, &scan_cmd->hdr,
503 le16_to_cpu(scan_cmd->hdr.size),
504 lbs_ret_80211_scan, 0);
508 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
513 * @brief Internal function used to start a scan based on an input config
515 * Use the input user scan configuration information when provided in
516 * order to send the appropriate scan commands to firmware to populate or
517 * update the internal driver scan table
519 * @param priv A pointer to struct lbs_private structure
520 * @param full_scan Do a full-scan (blocking)
522 * @return 0 or < 0 if error
524 int lbs_scan_networks(struct lbs_private *priv, int full_scan)
527 struct chanscanparamset *chan_list;
528 struct chanscanparamset *curr_chans;
530 uint8_t bsstype = CMD_BSS_TYPE_ANY;
531 int numchannels = MRVDRV_CHANNELS_PER_SCAN_CMD;
532 union iwreq_data wrqu;
533 #ifdef CONFIG_LIBERTAS_DEBUG
534 struct bss_descriptor *iter;
536 DECLARE_SSID_BUF(ssid);
539 lbs_deb_enter_args(LBS_DEB_SCAN, "full_scan %d", full_scan);
541 /* Cancel any partial outstanding partial scans if this scan
544 if (full_scan && delayed_work_pending(&priv->scan_work))
545 cancel_delayed_work(&priv->scan_work);
547 /* User-specified bsstype or channel list
548 TODO: this can be implemented if some user-space application
549 need the feature. Formerly, it was accessible from debugfs,
550 but then nowhere used.
552 if (user_cfg->bsstype)
553 bsstype = user_cfg->bsstype;
556 lbs_deb_scan("numchannels %d, bsstype %d\n", numchannels, bsstype);
558 /* Create list of channels to scan */
559 chan_list = kzalloc(sizeof(struct chanscanparamset) *
560 LBS_IOCTL_USER_SCAN_CHAN_MAX, GFP_KERNEL);
562 lbs_pr_alert("SCAN: chan_list empty\n");
566 /* We want to scan all channels */
567 chan_count = lbs_scan_create_channel_list(priv, chan_list);
569 netif_stop_queue(priv->dev);
570 netif_carrier_off(priv->dev);
571 if (priv->mesh_dev) {
572 netif_stop_queue(priv->mesh_dev);
573 netif_carrier_off(priv->mesh_dev);
576 /* Prepare to continue an interrupted scan */
577 lbs_deb_scan("chan_count %d, scan_channel %d\n",
578 chan_count, priv->scan_channel);
579 curr_chans = chan_list;
580 /* advance channel list by already-scanned-channels */
581 if (priv->scan_channel > 0) {
582 curr_chans += priv->scan_channel;
583 chan_count -= priv->scan_channel;
586 /* Send scan command(s)
587 * numchannels contains the number of channels we should maximally scan
588 * chan_count is the total number of channels to scan
592 int to_scan = min(numchannels, chan_count);
593 lbs_deb_scan("scanning %d of %d channels\n",
594 to_scan, chan_count);
595 ret = lbs_do_scan(priv, bsstype, curr_chans,
598 lbs_pr_err("SCAN_CMD failed\n");
601 curr_chans += to_scan;
602 chan_count -= to_scan;
604 /* somehow schedule the next part of the scan */
605 if (chan_count && !full_scan &&
606 !priv->surpriseremoved) {
607 /* -1 marks just that we're currently scanning */
608 if (priv->scan_channel < 0)
609 priv->scan_channel = to_scan;
611 priv->scan_channel += to_scan;
612 cancel_delayed_work(&priv->scan_work);
613 queue_delayed_work(priv->work_thread, &priv->scan_work,
614 msecs_to_jiffies(300));
615 /* skip over GIWSCAN event */
620 memset(&wrqu, 0, sizeof(union iwreq_data));
621 wireless_send_event(priv->dev, SIOCGIWSCAN, &wrqu, NULL);
623 #ifdef CONFIG_LIBERTAS_DEBUG
624 /* Dump the scan table */
625 mutex_lock(&priv->lock);
626 lbs_deb_scan("scan table:\n");
627 list_for_each_entry(iter, &priv->network_list, list)
628 lbs_deb_scan("%02d: BSSID %pM, RSSI %d, SSID '%s'\n",
629 i++, iter->bssid, iter->rssi,
630 print_ssid(ssid, iter->ssid, iter->ssid_len));
631 mutex_unlock(&priv->lock);
635 priv->scan_channel = 0;
638 if (priv->connect_status == LBS_CONNECTED) {
639 netif_carrier_on(priv->dev);
640 if (!priv->tx_pending_len)
641 netif_wake_queue(priv->dev);
643 if (priv->mesh_dev && lbs_mesh_connected(priv)) {
644 netif_carrier_on(priv->mesh_dev);
645 if (!priv->tx_pending_len)
646 netif_wake_queue(priv->mesh_dev);
650 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
654 void lbs_scan_worker(struct work_struct *work)
656 struct lbs_private *priv =
657 container_of(work, struct lbs_private, scan_work.work);
659 lbs_deb_enter(LBS_DEB_SCAN);
660 lbs_scan_networks(priv, 0);
661 lbs_deb_leave(LBS_DEB_SCAN);
665 /*********************************************************************/
667 /* Result interpretation */
669 /*********************************************************************/
672 * @brief Interpret a BSS scan response returned from the firmware
674 * Parse the various fixed fields and IEs passed back for a a BSS probe
675 * response or beacon from the scan command. Record information as needed
676 * in the scan table struct bss_descriptor for that entry.
678 * @param bss Output parameter: Pointer to the BSS Entry
682 static int lbs_process_bss(struct bss_descriptor *bss,
683 uint8_t **pbeaconinfo, int *bytesleft)
685 struct ieee_ie_fh_param_set *fh;
686 struct ieee_ie_ds_param_set *ds;
687 struct ieee_ie_cf_param_set *cf;
688 struct ieee_ie_ibss_param_set *ibss;
689 DECLARE_SSID_BUF(ssid);
690 uint8_t *pos, *end, *p;
691 uint8_t n_ex_rates = 0, got_basic_rates = 0, n_basic_rates = 0;
692 uint16_t beaconsize = 0;
695 lbs_deb_enter(LBS_DEB_SCAN);
697 if (*bytesleft >= sizeof(beaconsize)) {
698 /* Extract & convert beacon size from the command buffer */
699 beaconsize = get_unaligned_le16(*pbeaconinfo);
700 *bytesleft -= sizeof(beaconsize);
701 *pbeaconinfo += sizeof(beaconsize);
704 if (beaconsize == 0 || beaconsize > *bytesleft) {
705 *pbeaconinfo += *bytesleft;
711 /* Initialize the current working beacon pointer for this BSS iteration */
713 end = pos + beaconsize;
715 /* Advance the return beacon pointer past the current beacon */
716 *pbeaconinfo += beaconsize;
717 *bytesleft -= beaconsize;
719 memcpy(bss->bssid, pos, ETH_ALEN);
720 lbs_deb_scan("process_bss: BSSID %pM\n", bss->bssid);
723 if ((end - pos) < 12) {
724 lbs_deb_scan("process_bss: Not enough bytes left\n");
730 * next 4 fields are RSSI, time stamp, beacon interval,
731 * and capability information
734 /* RSSI is 1 byte long */
736 lbs_deb_scan("process_bss: RSSI %d\n", *pos);
739 /* time stamp is 8 bytes long */
742 /* beacon interval is 2 bytes long */
743 bss->beaconperiod = get_unaligned_le16(pos);
746 /* capability information is 2 bytes long */
747 bss->capability = get_unaligned_le16(pos);
748 lbs_deb_scan("process_bss: capabilities 0x%04x\n", bss->capability);
751 if (bss->capability & WLAN_CAPABILITY_PRIVACY)
752 lbs_deb_scan("process_bss: WEP enabled\n");
753 if (bss->capability & WLAN_CAPABILITY_IBSS)
754 bss->mode = IW_MODE_ADHOC;
756 bss->mode = IW_MODE_INFRA;
758 /* rest of the current buffer are IE's */
759 lbs_deb_scan("process_bss: IE len %zd\n", end - pos);
760 lbs_deb_hex(LBS_DEB_SCAN, "process_bss: IE info", pos, end - pos);
762 /* process variable IE */
763 while (pos <= end - 2) {
764 if (pos + pos[1] > end) {
765 lbs_deb_scan("process_bss: error in processing IE, "
766 "bytes left < IE length\n");
772 bss->ssid_len = min_t(int, IEEE80211_MAX_SSID_LEN, pos[1]);
773 memcpy(bss->ssid, pos + 2, bss->ssid_len);
774 lbs_deb_scan("got SSID IE: '%s', len %u\n",
775 print_ssid(ssid, bss->ssid, bss->ssid_len),
779 case WLAN_EID_SUPP_RATES:
780 n_basic_rates = min_t(uint8_t, MAX_RATES, pos[1]);
781 memcpy(bss->rates, pos + 2, n_basic_rates);
783 lbs_deb_scan("got RATES IE\n");
786 case WLAN_EID_FH_PARAMS:
787 fh = (struct ieee_ie_fh_param_set *) pos;
788 memcpy(&bss->phy.fh, fh, sizeof(*fh));
789 lbs_deb_scan("got FH IE\n");
792 case WLAN_EID_DS_PARAMS:
793 ds = (struct ieee_ie_ds_param_set *) pos;
794 bss->channel = ds->channel;
795 memcpy(&bss->phy.ds, ds, sizeof(*ds));
796 lbs_deb_scan("got DS IE, channel %d\n", bss->channel);
799 case WLAN_EID_CF_PARAMS:
800 cf = (struct ieee_ie_cf_param_set *) pos;
801 memcpy(&bss->ss.cf, cf, sizeof(*cf));
802 lbs_deb_scan("got CF IE\n");
805 case WLAN_EID_IBSS_PARAMS:
806 ibss = (struct ieee_ie_ibss_param_set *) pos;
807 bss->atimwindow = ibss->atimwindow;
808 memcpy(&bss->ss.ibss, ibss, sizeof(*ibss));
809 lbs_deb_scan("got IBSS IE\n");
812 case WLAN_EID_EXT_SUPP_RATES:
813 /* only process extended supported rate if data rate is
814 * already found. Data rate IE should come before
815 * extended supported rate IE
817 lbs_deb_scan("got RATESEX IE\n");
818 if (!got_basic_rates) {
819 lbs_deb_scan("... but ignoring it\n");
824 if (n_basic_rates + n_ex_rates > MAX_RATES)
825 n_ex_rates = MAX_RATES - n_basic_rates;
827 p = bss->rates + n_basic_rates;
828 memcpy(p, pos + 2, n_ex_rates);
831 case WLAN_EID_GENERIC:
833 pos[2] == 0x00 && pos[3] == 0x50 &&
834 pos[4] == 0xf2 && pos[5] == 0x01) {
835 bss->wpa_ie_len = min(pos[1] + 2, MAX_WPA_IE_LEN);
836 memcpy(bss->wpa_ie, pos, bss->wpa_ie_len);
837 lbs_deb_scan("got WPA IE\n");
838 lbs_deb_hex(LBS_DEB_SCAN, "WPA IE", bss->wpa_ie,
840 } else if (pos[1] >= MARVELL_MESH_IE_LENGTH &&
841 pos[2] == 0x00 && pos[3] == 0x50 &&
842 pos[4] == 0x43 && pos[5] == 0x04) {
843 lbs_deb_scan("got mesh IE\n");
846 lbs_deb_scan("got generic IE: %02x:%02x:%02x:%02x, len %d\n",
854 lbs_deb_scan("got RSN IE\n");
855 bss->rsn_ie_len = min(pos[1] + 2, MAX_WPA_IE_LEN);
856 memcpy(bss->rsn_ie, pos, bss->rsn_ie_len);
857 lbs_deb_hex(LBS_DEB_SCAN, "process_bss: RSN_IE",
858 bss->rsn_ie, bss->rsn_ie_len);
862 lbs_deb_scan("got IE 0x%04x, len %d\n",
871 bss->last_scanned = jiffies;
872 lbs_unset_basic_rate_flags(bss->rates, sizeof(bss->rates));
877 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
882 * @brief Send a scan command for all available channels filtered on a spec
884 * Used in association code and from debugfs
886 * @param priv A pointer to struct lbs_private structure
887 * @param ssid A pointer to the SSID to scan for
888 * @param ssid_len Length of the SSID
890 * @return 0-success, otherwise fail
892 int lbs_send_specific_ssid_scan(struct lbs_private *priv, uint8_t *ssid,
895 DECLARE_SSID_BUF(ssid_buf);
898 lbs_deb_enter_args(LBS_DEB_SCAN, "SSID '%s'\n",
899 print_ssid(ssid_buf, ssid, ssid_len));
904 memcpy(priv->scan_ssid, ssid, ssid_len);
905 priv->scan_ssid_len = ssid_len;
907 lbs_scan_networks(priv, 1);
908 if (priv->surpriseremoved) {
914 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);
921 /*********************************************************************/
923 /* Support for Wireless Extensions */
925 /*********************************************************************/
928 #define MAX_CUSTOM_LEN 64
930 static inline char *lbs_translate_scan(struct lbs_private *priv,
931 struct iw_request_info *info,
932 char *start, char *stop,
933 struct bss_descriptor *bss)
935 struct chan_freq_power *cfp;
936 char *current_val; /* For rates */
937 struct iw_event iwe; /* Temporary buffer */
939 #define PERFECT_RSSI ((uint8_t)50)
940 #define WORST_RSSI ((uint8_t)0)
941 #define RSSI_DIFF ((uint8_t)(PERFECT_RSSI - WORST_RSSI))
944 lbs_deb_enter(LBS_DEB_SCAN);
946 cfp = lbs_find_cfp_by_band_and_channel(priv, 0, bss->channel);
948 lbs_deb_scan("Invalid channel number %d\n", bss->channel);
953 /* First entry *MUST* be the BSSID */
955 iwe.u.ap_addr.sa_family = ARPHRD_ETHER;
956 memcpy(iwe.u.ap_addr.sa_data, &bss->bssid, ETH_ALEN);
957 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_ADDR_LEN);
960 iwe.cmd = SIOCGIWESSID;
961 iwe.u.data.flags = 1;
962 iwe.u.data.length = min((uint32_t) bss->ssid_len, (uint32_t) IEEE80211_MAX_SSID_LEN);
963 start = iwe_stream_add_point(info, start, stop, &iwe, bss->ssid);
966 iwe.cmd = SIOCGIWMODE;
967 iwe.u.mode = bss->mode;
968 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_UINT_LEN);
971 iwe.cmd = SIOCGIWFREQ;
972 iwe.u.freq.m = (long)cfp->freq * 100000;
974 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_FREQ_LEN);
976 /* Add quality statistics */
978 iwe.u.qual.updated = IW_QUAL_ALL_UPDATED;
979 iwe.u.qual.level = SCAN_RSSI(bss->rssi);
981 rssi = iwe.u.qual.level - MRVDRV_NF_DEFAULT_SCAN_VALUE;
983 (100 * RSSI_DIFF * RSSI_DIFF - (PERFECT_RSSI - rssi) *
984 (15 * (RSSI_DIFF) + 62 * (PERFECT_RSSI - rssi))) /
985 (RSSI_DIFF * RSSI_DIFF);
986 if (iwe.u.qual.qual > 100)
987 iwe.u.qual.qual = 100;
989 if (priv->NF[TYPE_BEACON][TYPE_NOAVG] == 0) {
990 iwe.u.qual.noise = MRVDRV_NF_DEFAULT_SCAN_VALUE;
992 iwe.u.qual.noise = CAL_NF(priv->NF[TYPE_BEACON][TYPE_NOAVG]);
995 /* Locally created ad-hoc BSSs won't have beacons if this is the
996 * only station in the adhoc network; so get signal strength
997 * from receive statistics.
999 if ((priv->mode == IW_MODE_ADHOC) && priv->adhoccreate
1000 && !lbs_ssid_cmp(priv->curbssparams.ssid,
1001 priv->curbssparams.ssid_len,
1002 bss->ssid, bss->ssid_len)) {
1004 snr = priv->SNR[TYPE_RXPD][TYPE_AVG] / AVG_SCALE;
1005 nf = priv->NF[TYPE_RXPD][TYPE_AVG] / AVG_SCALE;
1006 iwe.u.qual.level = CAL_RSSI(snr, nf);
1008 start = iwe_stream_add_event(info, start, stop, &iwe, IW_EV_QUAL_LEN);
1010 /* Add encryption capability */
1011 iwe.cmd = SIOCGIWENCODE;
1012 if (bss->capability & WLAN_CAPABILITY_PRIVACY) {
1013 iwe.u.data.flags = IW_ENCODE_ENABLED | IW_ENCODE_NOKEY;
1015 iwe.u.data.flags = IW_ENCODE_DISABLED;
1017 iwe.u.data.length = 0;
1018 start = iwe_stream_add_point(info, start, stop, &iwe, bss->ssid);
1020 current_val = start + iwe_stream_lcp_len(info);
1022 iwe.cmd = SIOCGIWRATE;
1023 iwe.u.bitrate.fixed = 0;
1024 iwe.u.bitrate.disabled = 0;
1025 iwe.u.bitrate.value = 0;
1027 for (j = 0; j < ARRAY_SIZE(bss->rates) && bss->rates[j]; j++) {
1028 /* Bit rate given in 500 kb/s units */
1029 iwe.u.bitrate.value = bss->rates[j] * 500000;
1030 current_val = iwe_stream_add_value(info, start, current_val,
1031 stop, &iwe, IW_EV_PARAM_LEN);
1033 if ((bss->mode == IW_MODE_ADHOC) && priv->adhoccreate
1034 && !lbs_ssid_cmp(priv->curbssparams.ssid,
1035 priv->curbssparams.ssid_len,
1036 bss->ssid, bss->ssid_len)) {
1037 iwe.u.bitrate.value = 22 * 500000;
1038 current_val = iwe_stream_add_value(info, start, current_val,
1039 stop, &iwe, IW_EV_PARAM_LEN);
1041 /* Check if we added any event */
1042 if ((current_val - start) > iwe_stream_lcp_len(info))
1043 start = current_val;
1045 memset(&iwe, 0, sizeof(iwe));
1046 if (bss->wpa_ie_len) {
1047 char buf[MAX_WPA_IE_LEN];
1048 memcpy(buf, bss->wpa_ie, bss->wpa_ie_len);
1049 iwe.cmd = IWEVGENIE;
1050 iwe.u.data.length = bss->wpa_ie_len;
1051 start = iwe_stream_add_point(info, start, stop, &iwe, buf);
1054 memset(&iwe, 0, sizeof(iwe));
1055 if (bss->rsn_ie_len) {
1056 char buf[MAX_WPA_IE_LEN];
1057 memcpy(buf, bss->rsn_ie, bss->rsn_ie_len);
1058 iwe.cmd = IWEVGENIE;
1059 iwe.u.data.length = bss->rsn_ie_len;
1060 start = iwe_stream_add_point(info, start, stop, &iwe, buf);
1064 char custom[MAX_CUSTOM_LEN];
1067 iwe.cmd = IWEVCUSTOM;
1068 p += snprintf(p, MAX_CUSTOM_LEN, "mesh-type: olpc");
1069 iwe.u.data.length = p - custom;
1070 if (iwe.u.data.length)
1071 start = iwe_stream_add_point(info, start, stop,
1076 lbs_deb_leave_args(LBS_DEB_SCAN, "start %p", start);
1082 * @brief Handle Scan Network ioctl
1084 * @param dev A pointer to net_device structure
1085 * @param info A pointer to iw_request_info structure
1086 * @param vwrq A pointer to iw_param structure
1087 * @param extra A pointer to extra data buf
1089 * @return 0 --success, otherwise fail
1091 int lbs_set_scan(struct net_device *dev, struct iw_request_info *info,
1092 union iwreq_data *wrqu, char *extra)
1094 DECLARE_SSID_BUF(ssid);
1095 struct lbs_private *priv = dev->ml_priv;
1098 lbs_deb_enter(LBS_DEB_WEXT);
1100 if (!priv->radio_on) {
1105 if (!netif_running(dev)) {
1110 /* mac80211 does this:
1111 struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
1112 if (sdata->type != IEEE80211_IF_TYPE_xxx) {
1118 if (wrqu->data.length == sizeof(struct iw_scan_req) &&
1119 wrqu->data.flags & IW_SCAN_THIS_ESSID) {
1120 struct iw_scan_req *req = (struct iw_scan_req *)extra;
1121 priv->scan_ssid_len = req->essid_len;
1122 memcpy(priv->scan_ssid, req->essid, priv->scan_ssid_len);
1123 lbs_deb_wext("set_scan, essid '%s'\n",
1124 print_ssid(ssid, priv->scan_ssid, priv->scan_ssid_len));
1126 priv->scan_ssid_len = 0;
1129 if (!delayed_work_pending(&priv->scan_work))
1130 queue_delayed_work(priv->work_thread, &priv->scan_work,
1131 msecs_to_jiffies(50));
1132 /* set marker that currently a scan is taking place */
1133 priv->scan_channel = -1;
1135 if (priv->surpriseremoved)
1139 lbs_deb_leave_args(LBS_DEB_WEXT, "ret %d", ret);
1145 * @brief Handle Retrieve scan table ioctl
1147 * @param dev A pointer to net_device structure
1148 * @param info A pointer to iw_request_info structure
1149 * @param dwrq A pointer to iw_point structure
1150 * @param extra A pointer to extra data buf
1152 * @return 0 --success, otherwise fail
1154 int lbs_get_scan(struct net_device *dev, struct iw_request_info *info,
1155 struct iw_point *dwrq, char *extra)
1157 #define SCAN_ITEM_SIZE 128
1158 struct lbs_private *priv = dev->ml_priv;
1161 char *stop = ev + dwrq->length;
1162 struct bss_descriptor *iter_bss;
1163 struct bss_descriptor *safe;
1165 lbs_deb_enter(LBS_DEB_WEXT);
1167 /* iwlist should wait until the current scan is finished */
1168 if (priv->scan_channel)
1171 /* Update RSSI if current BSS is a locally created ad-hoc BSS */
1172 if ((priv->mode == IW_MODE_ADHOC) && priv->adhoccreate) {
1173 err = lbs_prepare_and_send_command(priv, CMD_802_11_RSSI, 0,
1174 CMD_OPTION_WAITFORRSP, 0, NULL);
1179 mutex_lock(&priv->lock);
1180 list_for_each_entry_safe (iter_bss, safe, &priv->network_list, list) {
1182 unsigned long stale_time;
1184 if (stop - ev < SCAN_ITEM_SIZE) {
1189 /* For mesh device, list only mesh networks */
1190 if (dev == priv->mesh_dev && !iter_bss->mesh)
1193 /* Prune old an old scan result */
1194 stale_time = iter_bss->last_scanned + DEFAULT_MAX_SCAN_AGE;
1195 if (time_after(jiffies, stale_time)) {
1196 list_move_tail(&iter_bss->list, &priv->network_free_list);
1197 clear_bss_descriptor(iter_bss);
1201 /* Translate to WE format this entry */
1202 next_ev = lbs_translate_scan(priv, info, ev, stop, iter_bss);
1203 if (next_ev == NULL)
1207 mutex_unlock(&priv->lock);
1209 dwrq->length = (ev - extra);
1212 lbs_deb_leave_args(LBS_DEB_WEXT, "ret %d", err);
1219 /*********************************************************************/
1221 /* Command execution */
1223 /*********************************************************************/
1227 * @brief This function handles the command response of scan
1229 * Called from handle_cmd_response() in cmdrespc.
1231 * The response buffer for the scan command has the following
1234 * .-----------------------------------------------------------.
1235 * | header (4 * sizeof(u16)): Standard command response hdr |
1236 * .-----------------------------------------------------------.
1237 * | bufsize (u16) : sizeof the BSS Description data |
1238 * .-----------------------------------------------------------.
1239 * | NumOfSet (u8) : Number of BSS Descs returned |
1240 * .-----------------------------------------------------------.
1241 * | BSSDescription data (variable, size given in bufsize) |
1242 * .-----------------------------------------------------------.
1243 * | TLV data (variable, size calculated using header->size, |
1244 * | bufsize and sizeof the fixed fields above) |
1245 * .-----------------------------------------------------------.
1247 * @param priv A pointer to struct lbs_private structure
1248 * @param resp A pointer to cmd_ds_command
1252 static int lbs_ret_80211_scan(struct lbs_private *priv, unsigned long dummy,
1253 struct cmd_header *resp)
1255 struct cmd_ds_802_11_scan_rsp *scanresp = (void *)resp;
1256 struct bss_descriptor *iter_bss;
1257 struct bss_descriptor *safe;
1259 uint16_t scanrespsize;
1265 lbs_deb_enter(LBS_DEB_SCAN);
1267 /* Prune old entries from scan table */
1268 list_for_each_entry_safe (iter_bss, safe, &priv->network_list, list) {
1269 unsigned long stale_time = iter_bss->last_scanned + DEFAULT_MAX_SCAN_AGE;
1270 if (time_before(jiffies, stale_time))
1272 list_move_tail (&iter_bss->list, &priv->network_free_list);
1273 clear_bss_descriptor(iter_bss);
1276 if (scanresp->nr_sets > MAX_NETWORK_COUNT) {
1277 lbs_deb_scan("SCAN_RESP: too many scan results (%d, max %d)\n",
1278 scanresp->nr_sets, MAX_NETWORK_COUNT);
1283 bytesleft = get_unaligned_le16(&scanresp->bssdescriptsize);
1284 lbs_deb_scan("SCAN_RESP: bssdescriptsize %d\n", bytesleft);
1286 scanrespsize = le16_to_cpu(resp->size);
1287 lbs_deb_scan("SCAN_RESP: scan results %d\n", scanresp->nr_sets);
1289 bssinfo = scanresp->bssdesc_and_tlvbuffer;
1291 /* The size of the TLV buffer is equal to the entire command response
1292 * size (scanrespsize) minus the fixed fields (sizeof()'s), the
1293 * BSS Descriptions (bssdescriptsize as bytesLef) and the command
1294 * response header (sizeof(struct cmd_header))
1296 tlvbufsize = scanrespsize - (bytesleft + sizeof(scanresp->bssdescriptsize)
1297 + sizeof(scanresp->nr_sets)
1298 + sizeof(struct cmd_header));
1301 * Process each scan response returned (scanresp->nr_sets). Save
1302 * the information in the newbssentry and then insert into the
1303 * driver scan table either as an update to an existing entry
1304 * or as an addition at the end of the table
1306 for (idx = 0; idx < scanresp->nr_sets && bytesleft; idx++) {
1307 struct bss_descriptor new;
1308 struct bss_descriptor *found = NULL;
1309 struct bss_descriptor *oldest = NULL;
1311 /* Process the data fields and IEs returned for this BSS */
1312 memset(&new, 0, sizeof (struct bss_descriptor));
1313 if (lbs_process_bss(&new, &bssinfo, &bytesleft) != 0) {
1314 /* error parsing the scan response, skipped */
1315 lbs_deb_scan("SCAN_RESP: process_bss returned ERROR\n");
1319 /* Try to find this bss in the scan table */
1320 list_for_each_entry (iter_bss, &priv->network_list, list) {
1321 if (is_same_network(iter_bss, &new)) {
1326 if ((oldest == NULL) ||
1327 (iter_bss->last_scanned < oldest->last_scanned))
1332 /* found, clear it */
1333 clear_bss_descriptor(found);
1334 } else if (!list_empty(&priv->network_free_list)) {
1335 /* Pull one from the free list */
1336 found = list_entry(priv->network_free_list.next,
1337 struct bss_descriptor, list);
1338 list_move_tail(&found->list, &priv->network_list);
1339 } else if (oldest) {
1340 /* If there are no more slots, expire the oldest */
1342 clear_bss_descriptor(found);
1343 list_move_tail(&found->list, &priv->network_list);
1348 lbs_deb_scan("SCAN_RESP: BSSID %pM\n", new.bssid);
1350 /* Copy the locally created newbssentry to the scan table */
1351 memcpy(found, &new, offsetof(struct bss_descriptor, list));
1357 lbs_deb_leave_args(LBS_DEB_SCAN, "ret %d", ret);