[MAC80211]: rework hardware crypto flags
[cascardo/linux.git] / include / net / mac80211.h
index a7f122b..9137579 100644 (file)
@@ -1,7 +1,9 @@
 /*
- * Low-level hardware driver -- IEEE 802.11 driver (80211.o) interface
+ * mac80211 <-> driver interface
+ *
  * Copyright 2002-2005, Devicescape Software, Inc.
  * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
+ * Copyright 2007      Johannes Berg <johannes@sipsolutions.net>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as
@@ -71,14 +73,13 @@ struct ieee80211_channel {
 #define IEEE80211_RATE_SUPPORTED 0x00000010
 #define IEEE80211_RATE_OFDM 0x00000020
 #define IEEE80211_RATE_CCK 0x00000040
-#define IEEE80211_RATE_TURBO 0x00000080
 #define IEEE80211_RATE_MANDATORY 0x00000100
 
 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
 #define IEEE80211_RATE_MODULATION(f) \
        (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
 
-/* Low-level driver should set PREAMBLE2, OFDM, CCK, and TURBO flags.
+/* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
  * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
  * configuration. */
 struct ieee80211_rate {
@@ -99,12 +100,10 @@ struct ieee80211_rate {
 
 /* 802.11g is backwards-compatible with 802.11b, so a wlan card can
  * actually be both in 11b and 11g modes at the same time. */
-enum {
+enum ieee80211_phymode {
        MODE_IEEE80211A, /* IEEE 802.11a */
        MODE_IEEE80211B, /* IEEE 802.11b only */
-       MODE_ATHEROS_TURBO, /* Atheros Turbo mode (2x.11a at 5 GHz) */
        MODE_IEEE80211G, /* IEEE 802.11g (and 802.11b compatibility) */
-       MODE_ATHEROS_TURBOG, /* Atheros Turbo mode (2x.11g at 2.4 GHz) */
 
        /* keep last */
        NUM_IEEE80211_MODES
@@ -192,13 +191,19 @@ struct ieee80211_tx_control {
 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
                                                * the frame */
 #define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9)
+#define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
+                                                 * using the through
+                                                 * set_retry_limit configured
+                                                 * long retry value */
        u32 flags;                             /* tx control flags defined
                                                * above */
-       u8 retry_limit;         /* 1 = only first attempt, 2 = one retry, .. */
+       u8 retry_limit;         /* 1 = only first attempt, 2 = one retry, ..
+                                * This could be used when set_retry_limit
+                                * is not implemented by the driver */
        u8 power_level;         /* per-packet transmit power level, in dBm */
        u8 antenna_sel_tx;      /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
-       s8 key_idx;             /* -1 = do not encrypt, >= 0 keyidx from
-                                * hw->set_key() */
+       s8 key_idx;             /* HW_KEY_IDX_INVALID = do not encrypt,
+                                * other values: keyidx from hw->set_key() */
        u8 icv_len;             /* length of the ICV/MIC field in octets */
        u8 iv_len;              /* length of the IV field in octets */
        u8 tkip_key[16];        /* generated phase2/phase1 key for hw TKIP */
@@ -235,6 +240,8 @@ struct ieee80211_rx_status {
 #define RX_FLAG_MMIC_ERROR     (1<<0)
 #define RX_FLAG_DECRYPTED      (1<<1)
 #define RX_FLAG_RADIOTAP       (1<<2)
+#define RX_FLAG_MMIC_STRIPPED  (1<<3)
+#define RX_FLAG_IV_STRIPPED    (1<<4)
        int flag;
 };
 
@@ -288,28 +295,10 @@ struct ieee80211_conf {
        u8 power_level;                 /* transmit power limit for current
                                         * regulatory domain; in dBm */
        u8 antenna_max;                 /* maximum antenna gain */
-       short tx_power_reduction; /* in 0.1 dBm */
 
        /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
        u8 antenna_sel_tx;
        u8 antenna_sel_rx;
-
-       int antenna_def;
-       int antenna_mode;
-
-       /* Following five fields are used for IEEE 802.11H */
-       unsigned int radar_detect;
-       unsigned int spect_mgmt;
-       /* All following fields are currently unused. */
-       unsigned int quiet_duration; /* duration of quiet period */
-       unsigned int quiet_offset; /* how far into the beacon is the quiet
-                                   * period */
-       unsigned int quiet_period;
-       u8 radar_firpwr_threshold;
-       u8 radar_rssi_threshold;
-       u8 pulse_height_threshold;
-       u8 pulse_rssi_threshold;
-       u8 pulse_inband_threshold;
 };
 
 /**
@@ -347,9 +336,16 @@ enum ieee80211_if_types {
  * @mac_addr: pointer to MAC address of the interface. This pointer is valid
  *     until the interface is removed (i.e. it cannot be used after
  *     remove_interface() callback was called for this interface).
+ *     This pointer will be %NULL for monitor interfaces, be careful.
  *
  * This structure is used in add_interface() and remove_interface()
  * callbacks of &struct ieee80211_hw.
+ *
+ * When you allow multiple interfaces to be added to your PHY, take care
+ * that the hardware can actually handle multiple MAC addresses. However,
+ * also take care that when there's no interface left with mac_addr != %NULL
+ * you remove the MAC address from the device to avoid acknowledging packets
+ * in pure monitor mode.
  */
 struct ieee80211_if_init_conf {
        int if_id;
@@ -395,29 +391,51 @@ struct ieee80211_if_conf {
        struct ieee80211_tx_control *beacon_control;
 };
 
-typedef enum { ALG_NONE, ALG_WEP, ALG_TKIP, ALG_CCMP, ALG_NULL }
-ieee80211_key_alg;
+typedef enum {
+       ALG_NONE,
+       ALG_WEP,
+       ALG_TKIP,
+       ALG_CCMP,
+} ieee80211_key_alg;
 
+/*
+ * This flag indiciates that the station this key is being
+ * configured for may use QoS. If your hardware cannot handle
+ * that situation it should reject that key.
+ */
+#define IEEE80211_KEY_FLAG_WMM_STA     (1<<0)
+/*
+ * This flag should be set by the driver if it requires
+ * IV generation in software for this key.
+ */
+#define IEEE80211_KEY_FLAG_GENERATE_IV (1<<1)
+/*
+ * This flag should be set by the driver if it requires
+ * MMIC generation in software for this key.
+ */
+#define IEEE80211_KEY_FLAG_GENERATE_MMIC (1<<2)
 
 struct ieee80211_key_conf {
+       /*
+        * To be set by the driver to the key index it would like to
+        * get in the ieee80211_tx_control.key_idx which defaults
+        * to HW_KEY_IDX_INVALID so that shouldn't be used.
+        */
+       int hw_key_idx;
 
-       int hw_key_idx;                 /* filled + used by low-level driver */
+       /* key algorithm, ALG_NONE should never be seen by the driver */
        ieee80211_key_alg alg;
-       int keylen;
-
-#define IEEE80211_KEY_FORCE_SW_ENCRYPT (1<<0) /* to be cleared by low-level
-                                                driver */
-#define IEEE80211_KEY_DEFAULT_TX_KEY   (1<<1) /* This key is the new default TX
-                                                key (used only for broadcast
-                                                keys). */
-#define IEEE80211_KEY_DEFAULT_WEP_ONLY (1<<2) /* static WEP is the only
-                                                configured security policy;
-                                                this allows some low-level
-                                                drivers to determine when
-                                                hwaccel can be used */
-       u32 flags; /* key configuration flags defined above */
-
-       s8 keyidx;                      /* WEP key index */
+
+       /* key flags, see above */
+       u8 flags;
+
+       /* key index: 0-3 */
+       s8 keyidx;
+
+       /* length of key material */
+       u8 keylen;
+
+       /* the key material */
        u8 key[0];
 };
 
@@ -425,7 +443,7 @@ struct ieee80211_key_conf {
 #define IEEE80211_SEQ_COUNTER_TX       1
 
 typedef enum {
-       SET_KEY, DISABLE_KEY, REMOVE_ALL_KEYS,
+       SET_KEY, DISABLE_KEY,
 } set_key_cmd;
 
 /* This is driver-visible part of the per-hw state the stack keeps. */
@@ -450,21 +468,16 @@ struct ieee80211_hw {
 
        /* TODO: frame_type 802.11/802.3, sw_encryption requirements */
 
-       /* Some wireless LAN chipsets generate beacons in the hardware/firmware
-        * and others rely on host generated beacons. This option is used to
-        * configure the upper layer IEEE 802.11 module to generate beacons.
-        * The low-level driver can use ieee80211_beacon_get() to fetch the
-        * next beacon frame. */
-#define IEEE80211_HW_HOST_GEN_BEACON (1<<0)
+/* hole at 0 */
 
-       /* The device needs to be supplied with a beacon template only. */
+       /*
+        * The device only needs to be supplied with a beacon template.
+        * If you need the host to generate each beacon then don't use
+        * this flag and use ieee80211_beacon_get().
+        */
 #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1)
 
-       /* Some devices handle decryption internally and do not
-        * indicate whether the frame was encrypted (unencrypted frames
-        * will be dropped by the hardware, unless specifically allowed
-        * through) */
-#define IEEE80211_HW_DEVICE_HIDES_WEP (1<<2)
+/* hole at 2 */
 
        /* Whether RX frames passed to ieee80211_rx() include FCS in the end */
 #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3)
@@ -477,21 +490,13 @@ struct ieee80211_hw {
         * can fetch them with ieee80211_get_buffered_bc(). */
 #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4)
 
-#define IEEE80211_HW_WEP_INCLUDE_IV (1<<5)
+/* hole at 5 */
 
-       /* will data nullfunc frames get proper TX status callback */
-#define IEEE80211_HW_DATA_NULLFUNC_ACK (1<<6)
+/* hole at 6 */
 
-       /* Force software encryption for TKIP packets if WMM is enabled. */
-#define IEEE80211_HW_NO_TKIP_WMM_HWACCEL (1<<7)
+/* hole at 7 */
 
-       /* Some devices handle Michael MIC internally and do not include MIC in
-        * the received packets passed up. device_strips_mic must be set
-        * for such devices. The 'encryption' frame control bit is expected to
-        * be still set in the IEEE 802.11 header with this option unlike with
-        * the device_hides_wep configuration option.
-        */
-#define IEEE80211_HW_DEVICE_STRIPS_MIC (1<<8)
+/* hole at 8 */
 
        /* Device is capable of performing full monitor mode even during
         * normal operation. */
@@ -505,8 +510,6 @@ struct ieee80211_hw {
         * specified in the device's EEPROM */
 #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11)
 
-       /* calculate Michael MIC for an MSDU when doing hwcrypto */
-#define IEEE80211_HW_TKIP_INCLUDE_MMIC (1<<12)
        /* Do TKIP phase1 key mixing in stack to support cards only do
         * phase2 key mixing when doing hwcrypto */
 #define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13)
@@ -555,9 +558,6 @@ struct ieee80211_ops {
        int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
                  struct ieee80211_tx_control *control);
 
-       /* Handler for performing hardware reset. */
-       int (*reset)(struct ieee80211_hw *hw);
-
        /* Handler that is called when any netdevice attached to the hardware
         * device is set UP for the first time. This can be used, e.g., to
         * enable interrupts and beacon sending. */
@@ -574,10 +574,11 @@ struct ieee80211_ops {
         * to returning zero. By returning non-zero addition of the interface
         * is inhibited. Unless monitor_during_oper is set, it is guaranteed
         * that monitor interfaces and normal interfaces are mutually
-        * exclusive. The open() handler is called after add_interface()
-        * if this is the first device added. At least one of the open()
-        * open() and add_interface() callbacks has to be assigned. If
-        * add_interface() is NULL, one STA interface is permitted only. */
+        * exclusive. If assigned, the open() handler is called after
+        * add_interface() if this is the first device added. The
+        * add_interface() callback has to be assigned because it is the only
+        * way to obtain the requested MAC address for any interface.
+        */
        int (*add_interface)(struct ieee80211_hw *hw,
                             struct ieee80211_if_init_conf *conf);
 
@@ -613,21 +614,48 @@ struct ieee80211_ops {
         * Must be atomic. */
        int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
 
-       /* Set encryption key. IEEE 802.11 module calls this function to set
-        * encryption keys. addr is ff:ff:ff:ff:ff:ff for default keys and
-        * station hwaddr for individual keys. aid of the station is given
-        * to help low-level driver in selecting which key->hw_key_idx to use
-        * for this key. TX control data will use the hw_key_idx selected by
-        * the low-level driver.
-        * Must be atomic. */
+       /*
+        * Set encryption key.
+        *
+        * This is called to enable hardware acceleration of encryption and
+        * decryption. The address will be the broadcast address for default
+        * keys, the other station's hardware address for individual keys or
+        * the zero address for keys that will be used only for transmission.
+        *
+        * The local_address parameter will always be set to our own address,
+        * this is only relevant if you support multiple local addresses.
+        *
+        * When transmitting, the TX control data will use the hw_key_idx
+        * selected by the low-level driver.
+        *
+        * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it
+        * couldn't be added; if you return 0 then hw_key_idx must be
+        * assigned to something other than HW_KEY_IDX_INVALID. When the cmd
+        * is DISABLE_KEY then it must succeed.
+        *
+        * This callback can sleep, and is only called between add_interface
+        * and remove_interface calls, i.e. while the interface with the
+        * given local_address is enabled.
+        *
+        * The ieee80211_key_conf structure pointed to by the key parameter
+        * is guaranteed to be valid until another call to set_key removes
+        * it, but it can only be used as a cookie to differentiate keys.
+        */
        int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd,
-                      u8 *addr, struct ieee80211_key_conf *key, int aid);
+                      const u8 *local_address, const u8 *address,
+                      struct ieee80211_key_conf *key);
 
-       /* Set TX key index for default/broadcast keys. This is needed in cases
+       /*
+        * Set TX key index for default/broadcast keys. This is needed in cases
         * where wlan card is doing full WEP/TKIP encapsulation (wep_include_iv
         * is not set), in other cases, this function pointer can be set to
-        * NULL since the IEEE 802. 11 module takes care of selecting the key
-        * index for each TX frame. */
+        * NULL since the IEEE 802.11 module takes care of selecting the key
+        * index for each TX frame.
+        *
+        * TODO: If you use this callback in your driver tell us if you need
+        *       any other information from it to make it easier, like the
+        *       key_conf instead.
+        */
        int (*set_key_idx)(struct ieee80211_hw *hw, int idx);
 
        /* Enable/disable IEEE 802.1X. This item requests wlan card to pass
@@ -684,6 +712,14 @@ struct ieee80211_ops {
        void (*sta_table_notification)(struct ieee80211_hw *hw,
                                       int num_sta);
 
+       /* Handle ERP IE change notifications. Must be atomic. */
+       void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
+                              int cts_protection, int preamble);
+
+       /* Flags for the erp_ie_changed changes parameter */
+#define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
+#define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
+
        /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
         * bursting) for a hardware TX queue.
         * queue = IEEE80211_TX_QUEUE_*.
@@ -822,6 +858,7 @@ struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
 /**
  * ieee80211_rts_get - RTS frame generation function
  * @hw: pointer obtained from ieee80211_alloc_hw().
+ * @if_id: interface ID from &struct ieee80211_if_init_conf.
  * @frame: pointer to the frame that is going to be protected by the RTS.
  * @frame_len: the frame length (in octets).
  * @frame_txctl: &struct ieee80211_tx_control of the frame.
@@ -832,7 +869,7 @@ struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
  * the next RTS frame from the 802.11 code. The low-level is responsible
  * for calling this function before and RTS frame is needed.
  */
-void ieee80211_rts_get(struct ieee80211_hw *hw,
+void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
                       const void *frame, size_t frame_len,
                       const struct ieee80211_tx_control *frame_txctl,
                       struct ieee80211_rts *rts);
@@ -840,6 +877,7 @@ void ieee80211_rts_get(struct ieee80211_hw *hw,
 /**
  * ieee80211_rts_duration - Get the duration field for an RTS frame
  * @hw: pointer obtained from ieee80211_alloc_hw().
+ * @if_id: interface ID from &struct ieee80211_if_init_conf.
  * @frame_len: the length of the frame that is going to be protected by the RTS.
  * @frame_txctl: &struct ieee80211_tx_control of the frame.
  *
@@ -847,13 +885,14 @@ void ieee80211_rts_get(struct ieee80211_hw *hw,
  * the duration field, the low-level driver uses this function to receive
  * the duration field value in little-endian byteorder.
  */
-__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
+__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
                              size_t frame_len,
                              const struct ieee80211_tx_control *frame_txctl);
 
 /**
  * ieee80211_ctstoself_get - CTS-to-self frame generation function
  * @hw: pointer obtained from ieee80211_alloc_hw().
+ * @if_id: interface ID from &struct ieee80211_if_init_conf.
  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
  * @frame_len: the frame length (in octets).
  * @frame_txctl: &struct ieee80211_tx_control of the frame.
@@ -864,7 +903,7 @@ __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
  * for calling this function before and CTS-to-self frame is needed.
  */
-void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
+void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
                             const void *frame, size_t frame_len,
                             const struct ieee80211_tx_control *frame_txctl,
                             struct ieee80211_cts *cts);
@@ -872,6 +911,7 @@ void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
 /**
  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
  * @hw: pointer obtained from ieee80211_alloc_hw().
+ * @if_id: interface ID from &struct ieee80211_if_init_conf.
  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
  * @frame_txctl: &struct ieee80211_tx_control of the frame.
  *
@@ -879,20 +919,21 @@ void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
  * the duration field, the low-level driver uses this function to receive
  * the duration field value in little-endian byteorder.
  */
-__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
+__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
                                    size_t frame_len,
                                    const struct ieee80211_tx_control *frame_txctl);
 
 /**
  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
  * @hw: pointer obtained from ieee80211_alloc_hw().
+ * @if_id: interface ID from &struct ieee80211_if_init_conf.
  * @frame_len: the length of the frame.
  * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
  *
  * Calculate the duration field of some generic frame, given its
  * length and transmission rate (in 100kbps).
  */
-__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
+__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
                                        size_t frame_len,
                                        int rate);
 
@@ -921,12 +962,6 @@ struct sk_buff *
 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
                          struct ieee80211_tx_control *control);
 
-/* Low level drivers that have their own MLME and MAC indicate
- * the aid for an associating station with this call */
-int ieee80211_set_aid_for_sta(struct ieee80211_hw *hw,
-                             u8 *peer_address, u16 aid);
-
-
 /* Given an sk_buff with a raw 802.11 header at the data pointer this function
  * returns the 802.11 header length in bytes (not including encryption
  * headers). If the data in the sk_buff is too short to contain a valid 802.11
@@ -1000,12 +1035,6 @@ ieee80211_get_mc_list_item(struct ieee80211_hw *hw,
 /* called by driver to notify scan status completed */
 void ieee80211_scan_completed(struct ieee80211_hw *hw);
 
-/* Function to indicate Radar Detection. The low level driver must call this
- * function to indicate the presence of radar in the current channel.
- * Additionally the radar type also could be sent */
-int  ieee80211_radar_status(struct ieee80211_hw *hw, int channel,
-                           int radar, int radar_type);
-
 /* return a pointer to the source address (SA) */
 static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr)
 {