Fedora kernel-2.6.17-1.2142_FC4 patched with stable patch-2.6.17.4-vs2.0.2-rc26.diff
[linux-2.6.git] / drivers / net / wireless / hermes.h
index 126923f..7644f72 100644 (file)
@@ -12,7 +12,8 @@
  * project, the Linux wvlan_cs driver, Lucent's HCF-Light
  * (wvlan_hcf.c) library, and the NetBSD wireless driver.
  *
- * Copyright (C) 2000, David Gibson, Linuxcare Australia <hermes@gibson.dropbear.id.au>
+ * Copyright (C) 2000, David Gibson, Linuxcare Australia.
+ * (C) Copyright David Gibson, IBM Corp. 2001-2003.
  *
  * Portions taken from hfa384x.h, Copyright (C) 1999 AbsoluteValue Systems, Inc. All Rights Reserved.
  *
@@ -29,9 +30,8 @@
  * access to the hermes_t structure, and to the hardware
 */
 
-#include <linux/delay.h>
 #include <linux/if_ether.h>
-#include <asm/byteorder.h>
+#include <asm/io.h>
 
 /*
  * Limits and constants
 /*
  * Command codes
  */
-/*--- Controller Commands --------------------------*/
+/*--- Controller Commands ----------------------------*/
 #define                HERMES_CMD_INIT                 (0x0000)
 #define                HERMES_CMD_ENABLE               (0x0001)
 #define                HERMES_CMD_DISABLE              (0x0002)
 #define                HERMES_CMD_DIAG                 (0x0003)
 
-/*--- Buffer Mgmt Commands --------------------------*/
+/*--- Buffer Mgmt Commands ---------------------------*/
 #define                HERMES_CMD_ALLOC                (0x000A)
 #define                HERMES_CMD_TX                   (0x000B)
-#define                HERMES_CMD_CLRPRST              (0x0012)
 
-/*--- Regulate Commands --------------------------*/
+/*--- Regulate Commands ------------------------------*/
 #define                HERMES_CMD_NOTIFY               (0x0010)
 #define                HERMES_CMD_INQUIRE              (0x0011)
 
-/*--- Configure Commands --------------------------*/
+/*--- Configure Commands -----------------------------*/
 #define                HERMES_CMD_ACCESS               (0x0021)
 #define                HERMES_CMD_DOWNLD               (0x0022)
 
+/*--- Serial I/O Commands ----------------------------*/
+#define                HERMES_CMD_READMIF              (0x0030)
+#define                HERMES_CMD_WRITEMIF             (0x0031)
+
 /*--- Debugging Commands -----------------------------*/
-#define        HERMES_CMD_MONITOR              (0x0038)
-#define                HERMES_MONITOR_ENABLE           (0x000b)
-#define                HERMES_MONITOR_DISABLE          (0x000f)
+#define        HERMES_CMD_TEST                 (0x0038)
+
+
+/* Test command arguments */
+#define                HERMES_TEST_SET_CHANNEL         0x0800
+#define                HERMES_TEST_MONITOR             0x0b00
+#define                HERMES_TEST_STOP                0x0f00
+
+/* Authentication algorithms */
+#define                HERMES_AUTH_OPEN                1
+#define                HERMES_AUTH_SHARED_KEY          2
+
+/* WEP settings */
+#define                HERMES_WEP_PRIVACY_INVOKED      0x0001
+#define                HERMES_WEP_EXCL_UNENCRYPTED     0x0002
+#define                HERMES_WEP_HOST_ENCRYPT         0x0010
+#define                HERMES_WEP_HOST_DECRYPT         0x0080
+
+/* Symbol hostscan options */
+#define                HERMES_HOSTSCAN_SYMBOL_5SEC     0x0001
+#define                HERMES_HOSTSCAN_SYMBOL_ONCE     0x0002
+#define                HERMES_HOSTSCAN_SYMBOL_PASSIVE  0x0040
+#define                HERMES_HOSTSCAN_SYMBOL_BCAST    0x0080
 
 /*
  * Frame structures and constants
 #define HERMES_802_3_OFFSET            (14+32)
 #define HERMES_802_2_OFFSET            (14+32+14)
 
-struct hermes_rx_descriptor {
-       u16 status;
-       u32 time;
-       u8 silence;
-       u8 signal;
-       u8 rate;
-       u8 rxflow;
-       u32 reserved;
-} __attribute__ ((packed));
-
 #define HERMES_RXSTAT_ERR              (0x0003)
 #define        HERMES_RXSTAT_BADCRC            (0x0001)
 #define        HERMES_RXSTAT_UNDECRYPTABLE     (0x0002)
@@ -178,13 +191,13 @@ struct hermes_rx_descriptor {
 #define        HERMES_RXSTAT_WMP               (0x6000)        /* Wavelan-II Management Protocol frame */
 
 struct hermes_tx_descriptor {
-       u16 status;
-       u16 reserved1;
-       u16 reserved2;
-       u32 sw_support;
+       __le16 status;
+       __le16 reserved1;
+       __le16 reserved2;
+       __le32 sw_support;
        u8 retry_count;
        u8 tx_rate;
-       u16 tx_control; 
+       __le16 tx_control;      
 } __attribute__ ((packed));
 
 #define HERMES_TXSTAT_RETRYERR         (0x0001)
@@ -201,55 +214,94 @@ struct hermes_tx_descriptor {
 
 #define HERMES_INQ_TALLIES             (0xF100)
 #define HERMES_INQ_SCAN                        (0xF101)
+#define HERMES_INQ_CHANNELINFO         (0xF102)
+#define HERMES_INQ_HOSTSCAN            (0xF103)
+#define HERMES_INQ_HOSTSCAN_SYMBOL     (0xF104)
 #define HERMES_INQ_LINKSTATUS          (0xF200)
+#define HERMES_INQ_SEC_STAT_AGERE      (0xF202)
 
 struct hermes_tallies_frame {
-       u16 TxUnicastFrames;
-       u16 TxMulticastFrames;
-       u16 TxFragments;
-       u16 TxUnicastOctets;
-       u16 TxMulticastOctets;
-       u16 TxDeferredTransmissions;
-       u16 TxSingleRetryFrames;
-       u16 TxMultipleRetryFrames;
-       u16 TxRetryLimitExceeded;
-       u16 TxDiscards;
-       u16 RxUnicastFrames;
-       u16 RxMulticastFrames;
-       u16 RxFragments;
-       u16 RxUnicastOctets;
-       u16 RxMulticastOctets;
-       u16 RxFCSErrors;
-       u16 RxDiscards_NoBuffer;
-       u16 TxDiscardsWrongSA;
-       u16 RxWEPUndecryptable;
-       u16 RxMsgInMsgFragments;
-       u16 RxMsgInBadMsgFragments;
+       __le16 TxUnicastFrames;
+       __le16 TxMulticastFrames;
+       __le16 TxFragments;
+       __le16 TxUnicastOctets;
+       __le16 TxMulticastOctets;
+       __le16 TxDeferredTransmissions;
+       __le16 TxSingleRetryFrames;
+       __le16 TxMultipleRetryFrames;
+       __le16 TxRetryLimitExceeded;
+       __le16 TxDiscards;
+       __le16 RxUnicastFrames;
+       __le16 RxMulticastFrames;
+       __le16 RxFragments;
+       __le16 RxUnicastOctets;
+       __le16 RxMulticastOctets;
+       __le16 RxFCSErrors;
+       __le16 RxDiscards_NoBuffer;
+       __le16 TxDiscardsWrongSA;
+       __le16 RxWEPUndecryptable;
+       __le16 RxMsgInMsgFragments;
+       __le16 RxMsgInBadMsgFragments;
        /* Those last are probably not available in very old firmwares */
-       u16 RxDiscards_WEPICVError;
-       u16 RxDiscards_WEPExcluded;
+       __le16 RxDiscards_WEPICVError;
+       __le16 RxDiscards_WEPExcluded;
 } __attribute__ ((packed));
 
 /* Grabbed from wlan-ng - Thanks Mark... - Jean II
  * This is the result of a scan inquiry command */
 /* Structure describing info about an Access Point */
-struct hermes_scan_apinfo {
-       u16 channel;            /* Channel where the AP sits */
-       u16 noise;              /* Noise level */
-       u16 level;              /* Signal level */
+struct prism2_scan_apinfo {
+       __le16 channel;         /* Channel where the AP sits */
+       __le16 noise;           /* Noise level */
+       __le16 level;           /* Signal level */
        u8 bssid[ETH_ALEN];     /* MAC address of the Access Point */
-       u16 beacon_interv;      /* Beacon interval ? */
-       u16 capabilities;       /* Capabilities ? */
+       __le16 beacon_interv;   /* Beacon interval */
+       __le16 capabilities;    /* Capabilities */
+       __le16 essid_len;       /* ESSID length */
        u8 essid[32];           /* ESSID of the network */
        u8 rates[10];           /* Bit rate supported */
-       u16 proberesp_rate;     /* ???? */
+       __le16 proberesp_rate;  /* Data rate of the response frame */
+       __le16 atim;            /* ATIM window time, Kus (hostscan only) */
 } __attribute__ ((packed));
-/* Container */
-struct hermes_scan_frame {
-       u16 rsvd;                   /* ??? */
-       u16 scanreason;             /* ??? */
-       struct hermes_scan_apinfo aps[35];        /* Scan result */
+
+/* Same stuff for the Lucent/Agere card.
+ * Thanks to h1kari <h1kari AT dachb0den.com> - Jean II */
+struct agere_scan_apinfo {
+       __le16 channel;         /* Channel where the AP sits */
+       __le16 noise;           /* Noise level */
+       __le16 level;           /* Signal level */
+       u8 bssid[ETH_ALEN];     /* MAC address of the Access Point */
+       __le16 beacon_interv;   /* Beacon interval */
+       __le16 capabilities;    /* Capabilities */
+       /* bits: 0-ess, 1-ibss, 4-privacy [wep] */
+       __le16 essid_len;       /* ESSID length */
+       u8 essid[32];           /* ESSID of the network */
+} __attribute__ ((packed));
+
+/* Moustafa: Scan structure for Symbol cards */
+struct symbol_scan_apinfo {
+       u8 channel;             /* Channel where the AP sits */
+       u8 unknown1;            /* 8 in 2.9x and 3.9x f/w, 0 otherwise */
+       __le16 noise;           /* Noise level */
+       __le16 level;           /* Signal level */
+       u8 bssid[ETH_ALEN];     /* MAC address of the Access Point */
+       __le16 beacon_interv;   /* Beacon interval */
+       __le16 capabilities;    /* Capabilities */
+       /* bits: 0-ess, 1-ibss, 4-privacy [wep] */
+       __le16 essid_len;       /* ESSID length */
+       u8 essid[32];           /* ESSID of the network */
+       __le16 rates[5];        /* Bit rate supported */
+       __le16 basic_rates;     /* Basic rates bitmask */
+       u8 unknown2[6];         /* Always FF:FF:FF:FF:00:00 */
+       u8 unknown3[8];         /* Always 0, appeared in f/w 3.91-68 */
 } __attribute__ ((packed));
+
+union hermes_scan_info {
+       struct agere_scan_apinfo        a;
+       struct prism2_scan_apinfo       p;
+       struct symbol_scan_apinfo       s;
+};
+
 #define HERMES_LINKSTATUS_NOT_CONNECTED   (0x0000)  
 #define HERMES_LINKSTATUS_CONNECTED       (0x0001)
 #define HERMES_LINKSTATUS_DISCONNECTED    (0x0002)
@@ -259,7 +311,21 @@ struct hermes_scan_frame {
 #define HERMES_LINKSTATUS_ASSOC_FAILED    (0x0006)
   
 struct hermes_linkstatus {
-       u16 linkstatus;         /* Link status */
+       __le16 linkstatus;         /* Link status */
+} __attribute__ ((packed));
+
+struct hermes_response {
+       u16 status, resp0, resp1, resp2;
+};
+
+/* "ID" structure - used for ESSID and station nickname */
+struct hermes_idstring {
+       __le16 len;
+       __le16 val[16];
+} __attribute__ ((packed));
+
+struct hermes_multicast {
+       u8 addr[HERMES_MAX_MULTICAST][ETH_ALEN];
 } __attribute__ ((packed));
 
 // #define HERMES_DEBUG_BUFFER 1
@@ -273,14 +339,11 @@ struct hermes_debug_entry {
 #ifdef __KERNEL__
 
 /* Timeouts */
-#define HERMES_BAP_BUSY_TIMEOUT (500) /* In iterations of ~1us */
+#define HERMES_BAP_BUSY_TIMEOUT (10000) /* In iterations of ~1us */
 
 /* Basic control structure */
 typedef struct hermes {
-       unsigned long iobase;
-       int io_space; /* 1 if we IO-mapped IO, 0 for memory-mapped IO? */
-#define HERMES_IO      1
-#define HERMES_MEM     0
+       void __iomem *iobase;
        int reg_spacing;
 #define HERMES_16BIT_REGSPACING        0
 #define HERMES_32BIT_REGSPACING        1
@@ -294,33 +357,27 @@ typedef struct hermes {
 #endif
 } hermes_t;
 
-typedef struct hermes_response {
-       u16 status, resp0, resp1, resp2;
-} hermes_response_t;
-
 /* Register access convenience macros */
-#define hermes_read_reg(hw, off) ((hw)->io_space ? \
-       inw((hw)->iobase + ( (off) << (hw)->reg_spacing )) : \
-       readw((hw)->iobase + ( (off) << (hw)->reg_spacing )))
-#define hermes_write_reg(hw, off, val) do { \
-       if ((hw)->io_space) \
-               outw_p((val), (hw)->iobase + ((off) << (hw)->reg_spacing)); \
-       else \
-               writew((val), (hw)->iobase + ((off) << (hw)->reg_spacing)); \
-       } while (0)
+#define hermes_read_reg(hw, off) \
+       (ioread16((hw)->iobase + ( (off) << (hw)->reg_spacing )))
+#define hermes_write_reg(hw, off, val) \
+       (iowrite16((val), (hw)->iobase + ((off) << (hw)->reg_spacing)))
 #define hermes_read_regn(hw, name) hermes_read_reg((hw), HERMES_##name)
 #define hermes_write_regn(hw, name, val) hermes_write_reg((hw), HERMES_##name, (val))
 
 /* Function prototypes */
-void hermes_struct_init(hermes_t *hw, ulong address, int io_space, int reg_spacing);
+void hermes_struct_init(hermes_t *hw, void __iomem *address, int reg_spacing);
 int hermes_init(hermes_t *hw);
-int hermes_docmd_wait(hermes_t *hw, u16 cmd, u16 parm0, hermes_response_t *resp);
+int hermes_docmd_wait(hermes_t *hw, u16 cmd, u16 parm0,
+                     struct hermes_response *resp);
 int hermes_allocate(hermes_t *hw, u16 size, u16 *fid);
 
-int hermes_bap_pread(hermes_t *hw, int bap, void *buf, unsigned len,
+int hermes_bap_pread(hermes_t *hw, int bap, void *buf, int len,
                       u16 id, u16 offset);
-int hermes_bap_pwrite(hermes_t *hw, int bap, const void *buf, unsigned len,
+int hermes_bap_pwrite(hermes_t *hw, int bap, const void *buf, int len,
                        u16 id, u16 offset);
+int hermes_bap_pwrite_pad(hermes_t *hw, int bap, const void *buf,
+                       unsigned data_len, int len, u16 id, u16 offset);
 int hermes_read_ltv(hermes_t *hw, int bap, u16 rid, unsigned buflen,
                    u16 *length, void *buf);
 int hermes_write_ltv(hermes_t *hw, int bap, u16 rid,
@@ -365,41 +422,13 @@ static inline int hermes_inquire(hermes_t *hw, u16 rid)
 static inline void hermes_read_words(struct hermes *hw, int off, void *buf, unsigned count)
 {
        off = off << hw->reg_spacing;
-
-       if (hw->io_space) {
-               insw(hw->iobase + off, buf, count);
-       } else {
-               unsigned i;
-               u16 *p;
-
-               /* This needs to *not* byteswap (like insw()) but
-                * readw() does byteswap hence the conversion.  I hope
-                * gcc is smart enough to fold away the two swaps on
-                * big-endian platforms. */
-               for (i = 0, p = buf; i < count; i++) {
-                       *p++ = cpu_to_le16(readw(hw->iobase + off));
-               }
-       }
+       ioread16_rep(hw->iobase + off, buf, count);
 }
 
 static inline void hermes_write_words(struct hermes *hw, int off, const void *buf, unsigned count)
 {
        off = off << hw->reg_spacing;
-
-       if (hw->io_space) {
-               outsw(hw->iobase + off, buf, count);
-       } else {
-               unsigned i;
-               const u16 *p;
-
-               /* This needs to *not* byteswap (like outsw()) but
-                * writew() does byteswap hence the conversion.  I
-                * hope gcc is smart enough to fold away the two swaps
-                * on big-endian platforms. */
-               for (i = 0, p = buf; i < count; i++) {
-                       writew(le16_to_cpu(*p++), hw->iobase + off);
-               }
-       }
+       iowrite16_rep(hw->iobase + off, buf, count);
 }
 
 static inline void hermes_clear_words(struct hermes *hw, int off, unsigned count)
@@ -408,13 +437,8 @@ static inline void hermes_clear_words(struct hermes *hw, int off, unsigned count
 
        off = off << hw->reg_spacing;
 
-       if (hw->io_space) {
-               for (i = 0; i < count; i++)
-                       outw(0, hw->iobase + off);
-       } else {
-               for (i = 0; i < count; i++)
-                       writew(0, hw->iobase + off);
-       }
+       for (i = 0; i < count; i++)
+               iowrite16(0, hw->iobase + off);
 }
 
 #define HERMES_READ_RECORD(hw, bap, rid, buf) \
@@ -424,7 +448,7 @@ static inline void hermes_clear_words(struct hermes *hw, int off, unsigned count
 
 static inline int hermes_read_wordrec(hermes_t *hw, int bap, u16 rid, u16 *word)
 {
-       u16 rec;
+       __le16 rec;
        int err;
 
        err = HERMES_READ_RECORD(hw, bap, rid, &rec);
@@ -434,7 +458,7 @@ static inline int hermes_read_wordrec(hermes_t *hw, int bap, u16 rid, u16 *word)
 
 static inline int hermes_write_wordrec(hermes_t *hw, int bap, u16 rid, u16 word)
 {
-       u16 rec = cpu_to_le16(word);
+       __le16 rec = cpu_to_le16(word);
        return HERMES_WRITE_RECORD(hw, bap, rid, &rec);
 }