blob: be95b9262801880f7a835f7954f14c1f0c1e2397 [file] [log] [blame]
John W. Linville7e272fc2008-09-24 18:13:14 -04001/*
2 * lib80211.h -- common bits for IEEE802.11 wireless drivers
3 *
4 * Copyright (c) 2008, John W. Linville <linville@tuxdriver.com>
5 *
John W. Linville274bfb82008-10-29 11:35:05 -04006 * Some bits copied from old ieee80211 component, w/ original copyright
7 * notices below:
8 *
9 * Original code based on Host AP (software wireless LAN access point) driver
10 * for Intersil Prism2/2.5/3.
11 *
12 * Copyright (c) 2001-2002, SSH Communications Security Corp and Jouni Malinen
13 * <j@w1.fi>
14 * Copyright (c) 2002-2003, Jouni Malinen <j@w1.fi>
15 *
16 * Adaption to a generic IEEE 802.11 stack by James Ketrenos
17 * <jketreno@linux.intel.com>
18 *
19 * Copyright (c) 2004, Intel Corporation
20 *
John W. Linville7e272fc2008-09-24 18:13:14 -040021 */
22
23#ifndef LIB80211_H
24#define LIB80211_H
25
John W. Linville274bfb82008-10-29 11:35:05 -040026#include <linux/types.h>
27#include <linux/list.h>
Arun Sharma600634972011-07-26 16:09:06 -070028#include <linux/atomic.h>
John W. Linville274bfb82008-10-29 11:35:05 -040029#include <linux/if.h>
30#include <linux/skbuff.h>
John W. Linville72118012008-09-30 21:43:03 -040031#include <linux/ieee80211.h>
Rami Rosena1eb5fe2008-11-19 09:37:43 +020032#include <linux/timer.h>
David Howells6bbefe82013-04-10 21:13:23 +010033#include <linux/seq_file.h>
34
John W. Linville9387b7c2008-09-30 20:59:05 -040035/* print_ssid() is intended to be used in debug (and possibly error)
John W. Linville7e272fc2008-09-24 18:13:14 -040036 * messages. It should never be used for passing ssid to user space. */
John W. Linville9387b7c2008-09-30 20:59:05 -040037const char *print_ssid(char *buf, const char *ssid, u8 ssid_len);
John W. Linville72118012008-09-30 21:43:03 -040038#define DECLARE_SSID_BUF(var) char var[IEEE80211_MAX_SSID_LEN * 4 + 1] __maybe_unused
John W. Linville7e272fc2008-09-24 18:13:14 -040039
John W. Linville274bfb82008-10-29 11:35:05 -040040#define NUM_WEP_KEYS 4
41
42enum {
43 IEEE80211_CRYPTO_TKIP_COUNTERMEASURES = (1 << 0),
44};
45
Paul Gortmakerde477252011-05-26 13:46:22 -040046struct module;
47
John W. Linville274bfb82008-10-29 11:35:05 -040048struct lib80211_crypto_ops {
49 const char *name;
50 struct list_head list;
51
52 /* init new crypto context (e.g., allocate private data space,
53 * select IV, etc.); returns NULL on failure or pointer to allocated
54 * private data on success */
55 void *(*init) (int keyidx);
56
57 /* deinitialize crypto context and free allocated private data */
58 void (*deinit) (void *priv);
59
John W. Linville274bfb82008-10-29 11:35:05 -040060 /* encrypt/decrypt return < 0 on error or >= 0 on success. The return
61 * value from decrypt_mpdu is passed as the keyidx value for
62 * decrypt_msdu. skb must have enough head and tail room for the
63 * encryption; if not, error will be returned; these functions are
64 * called for all MPDUs (i.e., fragments).
65 */
66 int (*encrypt_mpdu) (struct sk_buff * skb, int hdr_len, void *priv);
67 int (*decrypt_mpdu) (struct sk_buff * skb, int hdr_len, void *priv);
68
69 /* These functions are called for full MSDUs, i.e. full frames.
70 * These can be NULL if full MSDU operations are not needed. */
71 int (*encrypt_msdu) (struct sk_buff * skb, int hdr_len, void *priv);
72 int (*decrypt_msdu) (struct sk_buff * skb, int keyidx, int hdr_len,
73 void *priv);
74
75 int (*set_key) (void *key, int len, u8 * seq, void *priv);
76 int (*get_key) (void *key, int len, u8 * seq, void *priv);
77
78 /* procfs handler for printing out key information and possible
79 * statistics */
David Howells6bbefe82013-04-10 21:13:23 +010080 void (*print_stats) (struct seq_file *m, void *priv);
John W. Linville274bfb82008-10-29 11:35:05 -040081
82 /* Crypto specific flag get/set for configuration settings */
83 unsigned long (*get_flags) (void *priv);
84 unsigned long (*set_flags) (unsigned long flags, void *priv);
85
86 /* maximum number of bytes added by encryption; encrypt buf is
87 * allocated with extra_prefix_len bytes, copy of in_buf, and
88 * extra_postfix_len; encrypt need not use all this space, but
89 * the result must start at the beginning of the buffer and correct
90 * length must be returned */
91 int extra_mpdu_prefix_len, extra_mpdu_postfix_len;
92 int extra_msdu_prefix_len, extra_msdu_postfix_len;
93
94 struct module *owner;
95};
96
97struct lib80211_crypt_data {
98 struct list_head list; /* delayed deletion list */
99 struct lib80211_crypto_ops *ops;
100 void *priv;
101 atomic_t refcnt;
102};
103
104struct lib80211_crypt_info {
105 char *name;
106 /* Most clients will already have a lock,
107 so just point to that. */
108 spinlock_t *lock;
109
110 struct lib80211_crypt_data *crypt[NUM_WEP_KEYS];
111 int tx_keyidx; /* default TX key index (crypt[tx_keyidx]) */
112 struct list_head crypt_deinit_list;
113 struct timer_list crypt_deinit_timer;
114 int crypt_quiesced;
115};
116
John W. Linville2ba4b322008-11-11 16:00:06 -0500117int lib80211_crypt_info_init(struct lib80211_crypt_info *info, char *name,
118 spinlock_t *lock);
119void lib80211_crypt_info_free(struct lib80211_crypt_info *info);
John W. Linville274bfb82008-10-29 11:35:05 -0400120int lib80211_register_crypto_ops(struct lib80211_crypto_ops *ops);
121int lib80211_unregister_crypto_ops(struct lib80211_crypto_ops *ops);
122struct lib80211_crypto_ops *lib80211_get_crypto_ops(const char *name);
John W. Linville274bfb82008-10-29 11:35:05 -0400123void lib80211_crypt_delayed_deinit(struct lib80211_crypt_info *info,
124 struct lib80211_crypt_data **crypt);
John W. Linville274bfb82008-10-29 11:35:05 -0400125
John W. Linville7e272fc2008-09-24 18:13:14 -0400126#endif /* LIB80211_H */