[iwmgmt] Add functions for common user-level wireless tasks
authorJoshua Oreman <oremanj@xenon.get-linux.org>
Fri, 19 Jun 2009 09:26:23 +0000 (02:26 -0700)
committerJoshua Oreman <oremanj@xenon.get-linux.org>
Fri, 19 Jun 2009 09:26:23 +0000 (02:26 -0700)
iwstat: print ifstat plus 802.11-specific information for wireless devices
iwlist: scan for all accessible wireless networks, print a nicely formatted list
iwassoc: start 802.11 association again without changing the SSID

iwstat is invaluable for users' debugging, iwlist is very useful for
setup, and iwassoc was included because it's an occasionally useful one-liner.

Total code size: about 1.2k uncompressed.

src/include/gpxe/errfile.h
src/include/usr/iwmgmt.h [new file with mode: 0644]
src/usr/iwmgmt.c [new file with mode: 0644]

index 888b859..23c8b1a 100644 (file)
@@ -177,6 +177,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #define ERRFILE_pxemenu                      ( ERRFILE_OTHER | 0x00150000 )
 #define ERRFILE_x509                 ( ERRFILE_OTHER | 0x00160000 )
 #define ERRFILE_login_ui             ( ERRFILE_OTHER | 0x00170000 )
+#define ERRFILE_iwmgmt               ( ERRFILE_OTHER | 0x00180000 )
 
 /** @} */
 
diff --git a/src/include/usr/iwmgmt.h b/src/include/usr/iwmgmt.h
new file mode 100644 (file)
index 0000000..f7becff
--- /dev/null
@@ -0,0 +1,18 @@
+#ifndef _USR_IWMGMT_H
+#define _USR_IWMGMT_H
+
+/** @file
+ *
+ * Wireless network interface management
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+struct net80211_device;
+
+extern void iwstat ( struct net80211_device *dev );
+extern int iwlist ( struct net80211_device *dev, int active );
+extern void iwassoc ( struct net80211_device *dev );
+
+#endif /* _USR_IWMGMT_H */
diff --git a/src/usr/iwmgmt.c b/src/usr/iwmgmt.c
new file mode 100644 (file)
index 0000000..a603fbb
--- /dev/null
@@ -0,0 +1,226 @@
+/*
+ * Copyright (C) 2009 Joshua Oreman <oremanj@rwcr.net>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+#include <stdio.h>
+#include <console.h>
+#include <string.h>
+#include <errno.h>
+#include <gpxe/net80211.h>
+#include <gpxe/ethernet.h>
+#include <usr/ifmgmt.h>
+#include <usr/iwmgmt.h>
+
+/** @file
+ *
+ * Wireless network interface management
+ *
+ */
+
+/**
+ * Print status of 802.11 device
+ *
+ * @v dev      802.11 device
+ */
+void iwstat ( struct net80211_device *dev ) {
+
+       ifstat ( dev->netdev );
+
+       printf ( "  [802.11 ");
+       if ( dev->state & NET80211_ASSOCIATED ) {
+               printf ( "SSID '%s', ", dev->essid );
+       } else {
+               printf ( "not associated, " );
+       }
+       if ( dev->channel < dev->nr_channels && dev->rate < dev->nr_rates ) {
+               printf ( "Ch:%d Sig:%d", dev->channels[dev->channel].channel_nr,
+                        dev->last_signal );
+               switch ( dev->hw->signal_type ) {
+               case NET80211_SIGNAL_NONE:
+                       printf ( "?" );
+                       break;
+               case NET80211_SIGNAL_ARBITRARY:
+                       printf ( "/%d", dev->hw->signal_max );
+                       break;
+               case NET80211_SIGNAL_DB:
+                       printf ( "/%d dB", dev->hw->signal_max );
+                       break;
+               case NET80211_SIGNAL_DBM:
+                       printf ( " dBm" );
+                       break;
+               }
+               printf ( ", Rate:%d Mbps]\n",
+                        NET80211_RATE_VALUE ( dev->rates[dev->rate] ) / 10 );
+       } else {
+               printf ( "antenna off]\n" );
+       }
+
+       if ( dev->state & NET80211_WORKING ) {
+               printf ( "  [associating" );
+               if ( dev->associating )
+                       printf ( " to '%s'", dev->associating->essid );
+               printf ( "...]\n" );
+       } else if ( dev->assoc_rc ) {
+               printf ( "  [association error: %s]\n",
+                        strerror ( dev->assoc_rc ) );
+       }
+}
+
+
+static const char *crypto_types[] = {
+       [NET80211_CRYPT_NONE] = "Open",
+       [NET80211_CRYPT_WEP] = "WEP",
+       [NET80211_CRYPT_TKIP] = "WPA",
+       [NET80211_CRYPT_CCMP] = "WPA2",
+};
+
+#define NR_CRYPTO_TYPES ( sizeof ( crypto_types ) / sizeof ( crypto_types[0] ) )
+
+static const char *auth_types[] = {
+       [NET80211_SECPROT_NONE] = "",
+       [NET80211_SECPROT_PSK] = "PSK",
+       [NET80211_SECPROT_EAP] = "802.1X",
+};
+
+#define NR_AUTH_TYPES ( sizeof ( auth_types ) / sizeof ( auth_types[0] ) )
+
+/**
+ * Scan for wireless networks using 802.11 device
+ *
+ * @v dev      802.11 device
+ * @v active   Whether to use active scanning
+ */
+int iwlist ( struct net80211_device *dev, int active ) {
+       struct net80211_probe_ctx *ctx;
+       struct list_head *networks;
+       struct net80211_wlan *wlan;
+       char ssid_buf[22];
+       int rc;
+       unsigned i;
+       int was_opened = dev->netdev->state & NETDEV_OPEN;
+       int bands = dev->hw->bands;
+
+       if ( active )
+               bands &= NET80211_BAND_2GHZ;
+
+       if ( ! was_opened ) {
+               dev->state |= NET80211_NO_ASSOC;
+               rc = netdev_open ( dev->netdev );
+               if ( rc < 0 )
+                       goto err;
+       }
+
+       if ( dev->state & NET80211_WORKING ) {
+               rc = -EINVAL;
+               goto err_close_netdev;
+       }
+
+       rc = net80211_prepare_probe ( dev, dev->hw->bands, active );
+       if ( rc < 0 )
+               goto err_close_netdev;
+
+       ctx = net80211_probe_start ( dev, "", active );
+       if ( ! ctx ) {
+               rc = -ENOMEM;
+               goto err_close_netdev;
+       }
+
+       while ( ! ( rc = net80211_probe_step ( ctx ) ) ) {
+               step();
+       }
+
+       networks = net80211_probe_finish_all ( ctx );
+
+       if ( list_empty ( networks ) ) {
+               goto err_free_networks;
+       }
+
+       printf ( "Networks on %s:\n\n", dev->netdev->name );
+
+       /* Output format:
+        * 0         1         2         3         4         5         6
+        * 0123456789012345678901234567890123456789012345678901234567890
+        * [Sig] SSID                  BSSID              Ch  Crypt/Auth
+        * -------------------------------------------------------------
+        * [ 15] abcdefghijklmnopqrst> 00:00:00:00:00:00  11  Open
+        *                                             ... or WPA   PSK etc.
+        */
+
+       /* Quoting the dashes and spaces verbatim uses less code space
+          than generating them programmatically. */
+       printf ( "[Sig] SSID                  BSSID              Ch  Crypt/Auth\n"
+                "-------------------------------------------------------------\n" );
+
+       list_for_each_entry ( wlan, networks, list ) {
+
+               /* Format SSID into 22-character string, space-padded,
+                  with '>' indicating truncation */
+
+               snprintf ( ssid_buf, sizeof ( ssid_buf ), "%s", wlan->essid );
+               for ( i = strlen ( ssid_buf ); i < sizeof ( ssid_buf ) - 1;
+                     i++ )
+                       ssid_buf[i] = ' ';
+               if ( ssid_buf[sizeof ( ssid_buf ) - 2] != ' ' )
+                       ssid_buf[sizeof ( ssid_buf ) - 2] = '>';
+               ssid_buf[sizeof ( ssid_buf ) - 1] = 0;
+
+               /* Sanity check */
+               if ( wlan->crypto >= NR_CRYPTO_TYPES ||
+                    wlan->handshaking >= NR_AUTH_TYPES )
+                       continue;
+
+               printf ( "[%3d] %s %s  %2d  %s%s  %s\n",
+                        wlan->signal < 0 ? 100 + wlan->signal : wlan->signal,
+                        ssid_buf, eth_ntoa ( wlan->bssid ), wlan->channel,
+                        crypto_types[wlan->crypto],
+                        wlan->crypto == NET80211_CRYPT_TKIP? " " : "",
+                        auth_types[wlan->handshaking] );
+       }
+       printf ( "\n" );
+
+       net80211_free_wlanlist ( networks );
+
+       if ( ! was_opened ) {
+               dev->state &= ~NET80211_NO_ASSOC;
+               netdev_close ( dev->netdev );
+       }
+
+       return 0;
+
+ err_free_networks:
+       net80211_free_wlanlist ( networks );
+ err_close_netdev:
+       if ( ! was_opened ) {
+               dev->state &= ~NET80211_NO_ASSOC;
+               netdev_close ( dev->netdev );
+       }
+ err:
+       printf ( "Scanning for networks on %s: %s\n",
+                dev->netdev->name, strerror ( rc ) );
+       return rc;
+}
+
+/**
+ * Cause reassociation of 802.11 device
+ *
+ * @v dev      802.11 device
+ */
+void iwassoc ( struct net80211_device *dev ) {
+       net80211_autoassociate ( dev );
+}