wireless/airo: minimal WPA awareness
Subsystems (3)
PATCH 1/1 wireless/airo: minimal WPA awareness
airo cards with firmware versions of 5.30.17 and higher support WPA. This patch recognizes WPA-capable firmware versions and adds support for retrieving the WPA and RSN information elements from the card's scan results. The JOB and FLAG fields are now independent, since there was no space left in the FLAG field for FLAG_WPA_CAPABLE.
drivers/net/wireless/airo.c +194 -77
@@ -47,6 +47,7 @@#include <linux/ioport.h> #include <linux/pci.h> #include <asm/uaccess.h> +#include <net/ieee80211.h> #include "airo.h"
@@ -467,6 +468,8 @@#define RID_ECHOTEST_RESULTS 0xFF71#define RID_BSSLISTFIRST 0xFF72#define RID_BSSLISTNEXT 0xFF73 +#define RID_WPA_BSSLISTFIRST 0xFF74 +#define RID_WPA_BSSLISTNEXT 0xFF75 typedef struct { u16 cmd;
@@ -739,6 +742,14 @@u16 extSoftCap; } CapabilityRid; + +/* Only present on firmware >= 5.30.17 */ +typedef struct { +u16 unknown[4 ]; +u8 fixed[12 ];/* WLAN management frame */ +u8 iep[624 ]; +}BSSListRidExtra ; + typedef struct { u16 len; u16 index; /* First is 0 and 0xffff means end of list */
@@ -767,6 +778,9 @@ } fh;u16 dsChannel;u16 atimWindow; + +/* Only present on firmware >= 5.30.17 */ +BSSListRidExtra extra; } BSSListRid; typedef struct {
@@ -1140,8 +1154,6 @@char defindex;// Used with auto wep struct proc_dir_entry *proc_entry;spinlock_t aux_lock; -unsigned long flags; -#define FLAG_PROMISC 8/* IFF_PROMISC 0x100 - include/linux/if.h */ #define FLAG_RADIO_OFF 0/* User disabling of MAC */ #define FLAG_RADIO_DOWN 1/* ifup/ifdown disabling of MAC */ #define FLAG_RADIO_MASK 0x03
@@ -1151,6 +1163,7 @@#define FLAG_UPDATE_MULTI 5#define FLAG_UPDATE_UNI 6#define FLAG_802_11 7 +#define FLAG_PROMISC 8/* IFF_PROMISC 0x100 - include/linux/if.h */ #define FLAG_PENDING_XMIT 9#define FLAG_PENDING_XMIT11 10#define FLAG_MPI 11
@@ -1158,17 +1171,19 @@#define FLAG_COMMIT 13#define FLAG_RESET 14#define FLAG_FLASHING 15 -#define JOB_MASK 0x2ff0000 -#define JOB_DIE 16 -#define JOB_XMIT 17 -#define JOB_XMIT11 18 -#define JOB_STATS 19 -#define JOB_PROMISC 20 -#define JOB_MIC 21 -#define JOB_EVENT 22 -#define JOB_AUTOWEP 23 -#define JOB_WSTATS 24 -#define JOB_SCAN_RESULTS 25 +#define FLAG_WPA_CAPABLE 16 +unsigned long flags; +#define JOB_DIE 0 +#define JOB_XMIT 1 +#define JOB_XMIT11 2 +#define JOB_STATS 3 +#define JOB_PROMISC 4 +#define JOB_MIC 5 +#define JOB_EVENT 6 +#define JOB_AUTOWEP 7 +#define JOB_WSTATS 8 +#define JOB_SCAN_RESULTS 9 +unsigned long jobs;int (*bap_read)(struct airo_info *,u16 *pu16Dst,int bytelen,int whichbap);unsigned short *flash;
@@ -1208,6 +1223,11 @@#define PCI_SHARED_LEN 2*MPI_MAX_FIDS*PKTSIZE+RIDSIZEchar proc_name[IFNAMSIZ ]; +/* WPA-related stuff */ +unsigned int bssListFirst; +unsigned int bssListNext; +unsigned int bssListRidLen; +struct list_head network_list;struct list_head network_free_list;BSSListElement *networks;
@@ -1264,7 +1284,7 @@ {MICRid mic_rid; -clear_bit (JOB_MIC , &ai->flags); +clear_bit (JOB_MIC , &ai->jobs);PC4500_readrid (ai,RID_MIC , &mic_rid,sizeof (mic_rid),0 );up (&ai->sem);
@@ -1705,24 +1725,24 @@static int readBSSListRid (struct airo_info *ai,int first,BSSListRid *list) {int rc; -Cmd cmd; -Resp rsp; +Cmd cmd; +Resp rsp;if (first ==1 ) { -if (ai->flags &FLAG_RADIO_MASK )return -ENETDOWN ; -memset (&cmd,0 ,sizeof (cmd)); - cmd.cmd=CMD_LISTBSS ; -if (down_interruptible (&ai->sem)) -return -ERESTARTSYS ; -issuecommand (ai, &cmd, &rsp); -up (&ai->sem); -/* Let the command take effect */ - ai->task = current; -ssleep (3 ); - ai->task =NULL ; - } - rc =PC4500_readrid (ai, first ?RID_BSSLISTFIRST :RID_BSSLISTNEXT , - list,sizeof (*list),1 ); +if (ai->flags &FLAG_RADIO_MASK )return -ENETDOWN ; +memset (&cmd,0 ,sizeof (cmd)); + cmd.cmd=CMD_LISTBSS ; +if (down_interruptible (&ai->sem)) +return -ERESTARTSYS ; +issuecommand (ai, &cmd, &rsp); +up (&ai->sem); +/* Let the command take effect */ + ai->task = current; +ssleep (3 ); + ai->task =NULL ; + } + rc =PC4500_readrid (ai, first ? ai->bssListFirst : ai->bssListNext, + list, ai->bssListRidLen,1 ); list->len =le16_to_cpu (list->len); list->index =le16_to_cpu (list->index);
@@ -2112,7 +2132,7 @@int fid = priv->xmit.fid;u32 *fids = priv->fids; -clear_bit (JOB_XMIT , &priv->flags); +clear_bit (JOB_XMIT , &priv->jobs);clear_bit (FLAG_PENDING_XMIT , &priv->flags); status =transmit_802_3_packet (priv, fids[fid], skb->data);up (&priv->sem);
@@ -2162,7 +2182,7 @@if (down_trylock (&priv->sem) !=0 ) {set_bit (FLAG_PENDING_XMIT , &priv->flags);netif_stop_queue (dev); -set_bit (JOB_XMIT , &priv->flags); +set_bit (JOB_XMIT , &priv->jobs);wake_up_interruptible (&priv->thr_wait); }else airo_end_xmit (dev);
@@ -2177,7 +2197,7 @@int fid = priv->xmit11.fid;u32 *fids = priv->fids; -clear_bit (JOB_XMIT11 , &priv->flags); +clear_bit (JOB_XMIT11 , &priv->jobs);clear_bit (FLAG_PENDING_XMIT11 , &priv->flags); status =transmit_802_11_packet (priv, fids[fid], skb->data);up (&priv->sem);
@@ -2233,7 +2253,7 @@if (down_trylock (&priv->sem) !=0 ) {set_bit (FLAG_PENDING_XMIT11 , &priv->flags);netif_stop_queue (dev); -set_bit (JOB_XMIT11 , &priv->flags); +set_bit (JOB_XMIT11 , &priv->jobs);wake_up_interruptible (&priv->thr_wait); }else airo_end_xmit11 (dev);
@@ -2244,7 +2264,7 @@StatsRid stats_rid;u32 *vals = stats_rid.vals; -clear_bit (JOB_STATS , &ai->flags); +clear_bit (JOB_STATS , &ai->jobs);if (ai->power.event) {up (&ai->sem);return ;
@@ -2272,10 +2292,10 @@ {struct airo_info *local = dev->priv; -if (!test_bit (JOB_STATS , &local->flags)) { +if (!test_bit (JOB_STATS , &local->jobs)) {/* Get stats out of the card if available */ if (down_trylock (&local->sem) !=0 ) { -set_bit (JOB_STATS , &local->flags); +set_bit (JOB_STATS , &local->jobs);wake_up_interruptible (&local->thr_wait); }else airo_read_stats (local);
@@ -2290,7 +2310,7 @@memset (&cmd,0 ,sizeof (cmd)); cmd.cmd=CMD_SETMODE ; -clear_bit (JOB_PROMISC , &ai->flags); +clear_bit (JOB_PROMISC , &ai->jobs); cmd.parm0=(ai->flags&IFF_PROMISC ) ?PROMISC :NOPROMISC ;issuecommand (ai, &cmd, &rsp);up (&ai->sem);
@@ -2302,7 +2322,7 @@if ((dev->flags ^ ai->flags) &IFF_PROMISC ) {change_bit (FLAG_PROMISC , &ai->flags);if (down_trylock (&ai->sem) !=0 ) { -set_bit (JOB_PROMISC , &ai->flags); +set_bit (JOB_PROMISC , &ai->jobs);wake_up_interruptible (&ai->thr_wait); }else airo_set_promisc (ai);
@@ -2380,7 +2400,7 @@ }clear_bit (FLAG_REGISTERED , &ai->flags); } -set_bit (JOB_DIE , &ai->flags); +set_bit (JOB_DIE , &ai->jobs);kill_proc (ai->thr_pid,SIGTERM ,1 );wait_for_completion (&ai->thr_exited);
@@ -2701,14 +2721,14 @@return 0 ; } -#define MAX_NETWORK_COUNT 64 +#define AIRO_MAX_NETWORK_COUNT 64static int airo_networks_allocate (struct airo_info *ai) {if (ai->networks)return 0 ; ai->networks = -kzalloc (MAX_NETWORK_COUNT *sizeof (BSSListElement), +kzalloc (AIRO_MAX_NETWORK_COUNT *sizeof (BSSListElement),GFP_KERNEL );if (!ai->networks) {airo_print_warn (ai->dev->name,"Out of memory allocating beacons" );
@@ -2732,11 +2752,33 @@INIT_LIST_HEAD (&ai->network_free_list);INIT_LIST_HEAD (&ai->network_list); -for (i =0 ; i <MAX_NETWORK_COUNT ; i++) +for (i =0 ; i <AIRO_MAX_NETWORK_COUNT ; i++)list_add_tail (&ai->networks[i].list, &ai->network_free_list); } +static int airo_test_wpa_capable (struct airo_info *ai) +{ +int status; +CapabilityRid cap_rid; +const char *name = ai->dev->name; + + status =readCapabilityRid (ai, &cap_rid,1 ); +if (status !=SUCCESS )return 0 ; + +/* Only firmware versions 5.30.17 or better can do WPA */ +if ((cap_rid.softVer >0x530 ) + || ((cap_rid.softVer ==0x530 ) && (cap_rid.softSubVer >=0x17 ))) { +airo_print_info (name,"WPA is supported." ); +return 1 ; + } + +/* No WPA support */ +airo_print_info (name,"WPA unsupported (only firmware versions 5.30.17" +" and greater support WPA. Detected %s)" , cap_rid.prodVer); +return 0 ; +} +static struct net_device *_init_airo_card (unsigned short irq,int port,int is_pcmcia,struct pci_dev *pci,struct device *dmdev )
@@ -2759,6 +2801,7 @@ ai = dev->priv; ai->wifidev =NULL ; ai->flags =0 ; + ai->jobs =0 ; ai->dev = dev;if (pci && (pci->device ==0x5000 || pci->device ==0xa504 )) {airo_print_dbg (dev->name,"Found an MPI350 card" );
@@ -2838,6 +2881,18 @@set_bit (FLAG_FLASHING , &ai->flags); } +/* Test for WPA support */ +if (airo_test_wpa_capable (ai)) { +set_bit (FLAG_WPA_CAPABLE , &ai->flags); + ai->bssListFirst =RID_WPA_BSSLISTFIRST ; + ai->bssListNext =RID_WPA_BSSLISTNEXT ; + ai->bssListRidLen =sizeof (BSSListRid); + }else { + ai->bssListFirst =RID_BSSLISTFIRST ; + ai->bssListNext =RID_BSSLISTNEXT ; + ai->bssListRidLen =sizeof (BSSListRid) -sizeof (BSSListRidExtra); + } + rc =register_netdev (dev);if (rc) {airo_print_err (dev->name,"Couldn't register_netdev" );
@@ -2875,7 +2930,7 @@ err_out_unlink:del_airo_dev (dev); err_out_thr: -set_bit (JOB_DIE , &ai->flags); +set_bit (JOB_DIE , &ai->jobs);kill_proc (ai->thr_pid,SIGTERM ,1 );wait_for_completion (&ai->thr_exited); err_out_free:
@@ -2933,7 +2988,7 @@union iwreq_data wrqu;StatusRid status_rid; -clear_bit (JOB_EVENT , &ai->flags); +clear_bit (JOB_EVENT , &ai->jobs);PC4500_readrid (ai,RID_STATUS , &status_rid,sizeof (status_rid),0 );up (&ai->sem); wrqu.data.length =0 ;
@@ -2947,7 +3002,7 @@static void airo_process_scan_results (struct airo_info *ai) {union iwreq_data wrqu; -BSSListRid BSSList; +BSSListRid bss;int rc;BSSListElement * loop_net;BSSListElement * tmp_net;
@@ -2960,15 +3015,15 @@ }/* Try to read the first entry of the scan result */ - rc =PC4500_readrid (ai,RID_BSSLISTFIRST , &BSSList,sizeof (BSSList),0 ); -if ((rc) || (BSSList.index ==0xffff )) { + rc =PC4500_readrid (ai, ai->bssListFirst, &bss, ai->bssListRidLen,0 ); +if ((rc) || (bss.index ==0xffff )) {/* No scan results */ goto out; }/* Read and parse all entries */ tmp_net =NULL ; -while ((!rc) && (BSSList.index !=0xffff )) { +while ((!rc) && (bss.index !=0xffff )) {/* Grab a network off the free list */ if (!list_empty (&ai->network_free_list)) { tmp_net = list_entry(ai->network_free_list.next,
@@ -2977,19 +3032,19 @@ }if (tmp_net !=NULL ) { -memcpy (tmp_net, &BSSList,sizeof (tmp_net->bss)); +memcpy (tmp_net, &bss,sizeof (tmp_net->bss));list_add_tail (&tmp_net->list, &ai->network_list); tmp_net =NULL ; }/* Read next entry */ - rc =PC4500_readrid (ai,RID_BSSLISTNEXT , - &BSSList,sizeof (BSSList),0 ); + rc =PC4500_readrid (ai, ai->bssListNext, + &bss, ai->bssListRidLen,0 ); } out: ai->scan_timeout =0 ; -clear_bit (JOB_SCAN_RESULTS , &ai->flags); +clear_bit (JOB_SCAN_RESULTS , &ai->jobs);up (&ai->sem);/* Send an empty event to user space.
@@ -3019,10 +3074,10 @@/* make swsusp happy with our thread */ try_to_freeze (); -if (test_bit (JOB_DIE , &ai->flags)) +if (test_bit (JOB_DIE , &ai->jobs))break ; -if (ai->flags &JOB_MASK ) { +if (ai->jobs) { locked =down_interruptible (&ai->sem); }else {wait_queue_t wait;
@@ -3031,16 +3086,16 @@add_wait_queue (&ai->thr_wait, &wait);for (;;) {set_current_state (TASK_INTERRUPTIBLE ); -if (ai->flags &JOB_MASK ) +if (ai->jobs)break ;if (ai->expires || ai->scan_timeout) {if (ai->scan_timeout &&time_after_eq (jiffies,ai->scan_timeout)){ -set_bit (JOB_SCAN_RESULTS ,&ai->flags); +set_bit (JOB_SCAN_RESULTS , &ai->jobs);break ; }else if (ai->expires &&time_after_eq (jiffies,ai->expires)){ -set_bit (JOB_AUTOWEP ,&ai->flags); +set_bit (JOB_AUTOWEP , &ai->jobs);break ; }if (!signal_pending (current)) {
@@ -3069,7 +3124,7 @@if (locked)continue ; -if (test_bit (JOB_DIE , &ai->flags)) { +if (test_bit (JOB_DIE , &ai->jobs)) {up (&ai->sem);break ; }
@@ -3079,23 +3134,23 @@continue ; } -if (test_bit (JOB_XMIT , &ai->flags)) +if (test_bit (JOB_XMIT , &ai->jobs))airo_end_xmit (dev); -else if (test_bit (JOB_XMIT11 , &ai->flags)) +else if (test_bit (JOB_XMIT11 , &ai->jobs))airo_end_xmit11 (dev); -else if (test_bit (JOB_STATS , &ai->flags)) +else if (test_bit (JOB_STATS , &ai->jobs))airo_read_stats (ai); -else if (test_bit (JOB_WSTATS , &ai->flags)) +else if (test_bit (JOB_WSTATS , &ai->jobs))airo_read_wireless_stats (ai); -else if (test_bit (JOB_PROMISC , &ai->flags)) +else if (test_bit (JOB_PROMISC , &ai->jobs))airo_set_promisc (ai); -else if (test_bit (JOB_MIC , &ai->flags)) +else if (test_bit (JOB_MIC , &ai->jobs))micinit (ai); -else if (test_bit (JOB_EVENT , &ai->flags)) +else if (test_bit (JOB_EVENT , &ai->jobs))airo_send_event (dev); -else if (test_bit (JOB_AUTOWEP , &ai->flags)) +else if (test_bit (JOB_AUTOWEP , &ai->jobs))timer_func (dev); -else if (test_bit (JOB_SCAN_RESULTS , &ai->flags)) +else if (test_bit (JOB_SCAN_RESULTS , &ai->jobs))airo_process_scan_results (ai);else /* Shouldn't get here, but we make sure to unlock */ up (&ai->sem);
@@ -3133,7 +3188,7 @@if ( status &EV_MIC ) {OUT4500 ( apriv,EVACK ,EV_MIC );if (test_bit (FLAG_MIC_CAPABLE , &apriv->flags)) { -set_bit (JOB_MIC , &apriv->flags); +set_bit (JOB_MIC , &apriv->jobs);wake_up_interruptible (&apriv->thr_wait); } }
@@ -3187,7 +3242,7 @@set_bit (FLAG_UPDATE_MULTI , &apriv->flags);if (down_trylock (&apriv->sem) !=0 ) { -set_bit (JOB_EVENT , &apriv->flags); +set_bit (JOB_EVENT , &apriv->jobs);wake_up_interruptible (&apriv->thr_wait); }else airo_send_event (dev);
@@ -5485,7 +5540,7 @@up (&apriv->sem);/* Schedule check to see if the change worked */ -clear_bit (JOB_AUTOWEP , &apriv->flags); +clear_bit (JOB_AUTOWEP , &apriv->jobs); apriv->expires =RUN_AT (HZ *3 ); }
@@ -6876,7 +6931,7 @@ } range->num_txpower = i; range->txpower_capa =IW_TXPOW_MWATT ; - range->we_version_source =12 ; + range->we_version_source =19 ; range->we_version_compiled =WIRELESS_EXT ; range->retry_capa =IW_RETRY_LIMIT |IW_RETRY_LIFETIME ; range->retry_flags =IW_RETRY_LIMIT ;
@@ -7152,6 +7207,7 @@u16 capabilities;char * current_val;/* For rates */ int i; +char * buf;/* First entry *MUST* be the AP MAC address */ iwe.cmd =SIOCGIWAP ;
@@ -7238,8 +7294,69 @@if ((current_val - current_ev) >IW_EV_LCP_LEN ) current_ev = current_val; -/* The other data in the scan result are not really -* interesting, so for now drop it - Jean II */ +/* Beacon interval */ + buf =kmalloc (30 ,GFP_KERNEL ); +if (buf) { + iwe.cmd =IWEVCUSTOM ; +sprintf (buf,"bcn_int=%d" , bss->beaconInterval); + iwe.u.data.length =strlen (buf); + current_ev =iwe_stream_add_point (current_ev, end_buf, &iwe, buf); +kfree (buf); + } + +/* Put WPA/RSN Information Elements into the event stream */ +if (test_bit (FLAG_WPA_CAPABLE , &ai->flags)) { +unsigned int num_null_ies =0 ; +u16 length =sizeof (bss->extra.iep); +struct ieee80211_info_element *info_element = + (struct ieee80211_info_element *) &bss->extra.iep; + +while ((length >=sizeof (*info_element)) && (num_null_ies <2 )) { +if (sizeof (*info_element) + info_element->len > length) { +/* Invalid element, don't continue parsing IE */ +break ; + } + +switch (info_element->id) { +case MFIE_TYPE_SSID : +/* Two zero-length SSID elements +* mean we're done parsing elements */ +if (!info_element->len) + num_null_ies++; +break ; + +case MFIE_TYPE_GENERIC : +if (info_element->len >=4 && + info_element->data[0 ] ==0x00 && + info_element->data[1 ] ==0x50 && + info_element->data[2 ] ==0xf2 && + info_element->data[3 ] ==0x01 ) { + iwe.cmd =IWEVGENIE ; + iwe.u.data.length =min (info_element->len +2 , +MAX_WPA_IE_LEN ); + current_ev =iwe_stream_add_point (current_ev, end_buf, + &iwe, (char *) info_element); + } +break ; + +case MFIE_TYPE_RSN : + iwe.cmd =IWEVGENIE ; + iwe.u.data.length =min (info_element->len +2 , +MAX_WPA_IE_LEN ); + current_ev =iwe_stream_add_point (current_ev, end_buf, + &iwe, (char *) info_element); +break ; + +default : +break ; + } + + length -=sizeof (*info_element) + info_element->len; + info_element = + (struct ieee80211_info_element *)&info_element-> + data[info_element->len]; + } + }return current_ev; }
@@ -7521,7 +7638,7 @@u32 *vals = stats_rid.vals;/* Get stats out of the card */ -clear_bit (JOB_WSTATS , &local->flags); +clear_bit (JOB_WSTATS , &local->jobs);if (local->power.event) {up (&local->sem);return ;
@@ -7565,10 +7682,10 @@ {struct airo_info *local = dev->priv; -if (!test_bit (JOB_WSTATS , &local->flags)) { +if (!test_bit (JOB_WSTATS , &local->jobs)) {/* Get stats out of the card if available */ if (down_trylock (&local->sem) !=0 ) { -set_bit (JOB_WSTATS , &local->flags); +set_bit (JOB_WSTATS , &local->jobs);wake_up_interruptible (&local->thr_wait); }else airo_read_wireless_stats (local);
Quoted 8 lines · Dan Williams
airo cards with firmware versions of 5.30.17 and higher support WPA. This patch recognizes WPA-capable firmware versions and adds support for retrieving the WPA and RSN information elements from the card's scan results. The JOB and FLAG fields are now independent, since there was no space left in the FLAG field for
FLAG_WPA_CAPABLE.Signed-off-by matthieu castet <[email protected]>Signed-off-by Dan Williams <[email protected]>
Running Linux 2.6.17-rc3-mm1 which has this patch included I get this interesting message:
airo(eth0): WPA unsupported (only firmware versions 5.30.17 and greater support WPA. Detected 5.30.17)
airo_test_wpa_capable assumes that the softSubVer part of the firmware version number is coded in BCD. Apparently, that's not true. I have firmware version 5.30.17 and cap_rid.softSubVer is 0x11==17.
drivers/net/wireless/airo.c +1 -1
@@ -2768,7 +2768,7 @@ static int airo_test_wpa_capable(struct/* Only firmware versions 5.30.17 or better can do WPA */ if ((cap_rid.softVer >0x530 ) - || ((cap_rid.softVer ==0x530 ) && (cap_rid.softSubVer >=0x17 ))) { + || ((cap_rid.softVer ==0x530 ) && (cap_rid.softSubVer >=17 ))) {airo_print_info (name,"WPA is supported." );return 1 ; }
VJ Channel API - driver level (README)
The following "soaks" on our side for a couple months now... Noticed [1][2] and thought it'd make sense to add it to the mix.
Contents
======
* README (inlined below)
* netdevice.h patch with the preliminary/draft driver-level API (next message).
Introduction
========
Van Jacobson's Net Channels presentation at LCA2006 is available at [3] and further discussed, for instance, at [4].
Within this context we defined the following goals for our implementation:
1) There are separate transport-neutral hardware supported channels for transmit and receive traffic.
2) We are interested in a proof-of-concept, as well as an initial pass at a concrete API.
The API introduces the concept of a unidirectional "flow" that can be "bound" to a specific hardware supported channel. Within this framework TCP flow is simply a special case where the transmit traffic flow is all the traffic from a local TCP endpoint to a remote TCP endpoint and the receive traffic flow is the exact opposite.
The API introduces - and is structured around - the following objects:
* hardware channel - hw_channelh
* kernel channel - kernel_channelh
* receive flow - netdev_rx_flow
Note:
More exactly, hw_channelh and kernel_channelh are opaque (void*) handles to the corresponding stateful and implementation-dependent objects. The rest of this text talks about channels and denotes handles - for shortness sake we'll now assume that the difference is clear enough.
Channels & Channel Handles
===================
Both the hardware and kernel channels (hw_channelh and kernel_channelh, respectively) are strictly unidirectional. When a channel is opened it is specified as a transmit or a receive channel. In order to create a bi-directional send/receive channel there must be an additional API which provides a higher level abstraction by using a pair
of uni-directional channels.
Hardware channel handle and kernel channel handle are opaque handles designated to reference the corresponding stateful objects when used in an appropriate context, i.e., driver and kernel, respectively.
Hardware channel handle (hw_channelh) is an opaque handles used to reference the corresponding device driver-specific channel object. It is up to the device driver developers to define the actual channel structures which work best to their specific hardware. The API knows nothing about these except as opaque pointers.
Similarly, kernel channel handle (kernel_channelh) is opaque, as far as network drivers are concerned. There is a 1-to-1 correspondence between a kernel channel and a hardware channel. This assists in separating domain knowledge between the device driver and the kernel proper. It is assumed that kernel developers will be able to make use of kernel_channelh by casting it to the appropriate structure when, for instance, processing frames received on a corresponding hardware channel (hw_channelh).
Receive Flow
=========
Receive flow (netdev_rx_flow) contains a criteria that allows to steer a certain type of incoming packets (L2 frames, IP or UDP datagrams, TCP segments, etc.) to a receive channel. For instance, a single channel can be used to only receive traffic for a given MAC, or all traffic to TCP port 80. Furthermore, several flows can be added (or more exactly, can be "bound" via the corresponding bind_rx_hwchannel() API call) to the same channel. This means, one can create a channel that accepts traffic for destination MAC A and MAC B, or a channel used to transfer TCP packets with destination port 80 and 8080, or a channel to for a number of TCP connections defined by their respective 4-tuples.
For more discussion see Section "Neterion XFrame-II Specific Notes" below.
One can also assign a custom receive function to each separate receive channel. If a callback function is specified, this function will be used to pass up traffic instead of the netif_* API. This allows for a direct data path for applications should they wish to use it. This callback function is entirely optional and must be set per channel. If the function pointer is NULL the standard netif_* API is used.
With respect to receive flow binding sequence, the last channel that is bound to a specific flow is the one that "wins", i.e., gets the traffic. In general, sharing of channels in a consistent fashion and tracking of receive flows is currently considered outside of the scope of this API.
System Scalability ("The Big Picture")
========================
The API has its place in the entire picture that, as per Van Jacobson, includes "channelized" application, "channelized" socket, and "channelized" driver. It is meant to provide a mechanism, which, if used correctly, will ultimately allow to achieve system-level per-CPU scalability.
It is outside the scope of this API to provide an interface to automatically place a transmit channel and the user-space application using it onto a given CPU. But if the transmitting application is in fact bound to a CPU, and if the kernel socket is "channel-aware", and if this particular channel is always used with the same CPU - if all of the above is true, then the ultimate goal of scalability can be reached.
Similarly, on the inbound, the API can be used to:
(1) channelize received traffic based on a number of available receive flow classification mechanisms
(see netdev_hwchannel_rx_flow_e),
(2) process the per-channel MSI/MSI-X on a given CPU specified at channel open time (see open_rx_hwchannel()).
It's outside of scope of this particular API what happens with the packets received on a given channel after netif_rx*() callback hands the over to the stack.
Neterion XFrame-II Specific Note
=====================
The API is (an attempt of) a generalized kernel <=> driver interface. This section talks about Xframe-specific restrictions. We are assuming that other multi-channel capable network adapters might have adapter-specific restrictions; the idea however is not to propagate those restrictions on the level of API, if possible.
The XFrame-II adapter supports multiple receive traffic flow types. However, it is not possible to mix the receive flow types (netdev_hwchannel_rx_flow_e) with the current Xframe hardware. In other words, one cannot use a single hardware channel to receive, for instance, all TCP traffic for destination port 80 and all L2 traffic for destination MAC A.
References
=======
[1] http://www.spinics.net/lists/netdev/msg03584.html
[2] http://www.spinics.net/lists/netdev/msg03583.html
[3] http://www.lemis.com/grog/Documentation/vj/lca06vj.pdf
[4] http://vger.kernel.org/~davem/cgi-bin/blog.cgi/2006/01/27
Thanks!
Neterion Team.
David S. Miller
maintainerRe: VJ Channel API - driver level (README)
BTW another thing to keep in mind, besides the fact that we should be designing driver APIs at this point at all, is that no implementation should do MMIOs to the card to insert or delete netchannel lookup entries.
Rather, it should be communicated to the card in a lazy fashion using DMA.
Otherwise, net channels will have the same connection rate performance problems that TOE has.