xref: /titanic_41/usr/src/lib/libdladm/common/libdlwlan.h (revision 0f1702c5201310f0529cd5abb77652e5e9b241b6)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _LIBDLWLAN_H
27 #define	_LIBDLWLAN_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 /*
32  * This file includes structures, macros and routines used by WLAN link
33  * administration.
34  */
35 
36 #include <sys/types.h>
37 #include <libdladm.h>
38 
39 /*
40  * General libdlwlan definitions and functions.
41  *
42  * These interfaces are ON consolidation-private.
43  * For documentation, refer to PSARC/2006/623.
44  */
45 
46 #ifdef	__cplusplus
47 extern "C" {
48 #endif
49 
50 #define	DLADM_WLAN_MAX_ESSID_LEN    (32 + 1)	/* per 802.11 spec */
51 						/* max essid length is 32 */
52 						/* one more for '\0' */
53 #define	DLADM_WLAN_BSSID_LEN		6	/* per 802.11 spec */
54 #define	DLADM_WLAN_WPA_KEY_LEN		32	/* per 802.11i spec */
55 #define	DLADM_WLAN_MAX_WPA_IE_LEN	40	/* per 802.11i spec */
56 
57 #define	DLADM_WLAN_CONNECT_TIMEOUT_DEFAULT	10
58 #define	DLADM_WLAN_CONNECT_CREATEIBSS		0x00000001
59 #define	DLADM_WLAN_CONNECT_NOSCAN		0x00000002
60 
61 typedef struct dladm_wlan_essid {
62 	char	we_bytes[DLADM_WLAN_MAX_ESSID_LEN];
63 } dladm_wlan_essid_t;
64 
65 typedef struct dladm_wlan_bssid {
66 	uint8_t	wb_bytes[DLADM_WLAN_BSSID_LEN];
67 } dladm_wlan_bssid_t;
68 
69 typedef struct dladm_wlan_ess {
70 	dladm_wlan_bssid_t	we_bssid;
71 	dladm_wlan_essid_t	we_ssid;
72 	uint_t			we_ssid_len;
73 	uint8_t			we_wpa_ie[DLADM_WLAN_MAX_WPA_IE_LEN];
74 	uint_t			we_wpa_ie_len;
75 	int			we_freq;
76 } dladm_wlan_ess_t;
77 
78 typedef enum {
79 	DLADM_WLAN_CIPHER_WEP		= 0,
80 	DLADM_WLAN_CIPHER_TKIP,
81 	DLADM_WLAN_CIPHER_AES_OCB,
82 	DLADM_WLAN_CIPHER_AES_CCM,
83 	DLADM_WLAN_CIPHER_CKIP,
84 	DLADM_WLAN_CIPHER_NONE
85 } dladm_wlan_cipher_t;
86 
87 typedef enum {
88 	DLADM_WLAN_MLME_ASSOC		= 1,	/* associate station */
89 	DLADM_WLAN_MLME_DISASSOC	= 2	/* disassociate station */
90 } dladm_wlan_mlme_op_t;
91 
92 typedef enum {
93 	DLADM_WLAN_REASON_UNSPECIFIED	= 1,
94 	DLADM_WLAN_REASON_DISASSOC_LEAVING	= 5
95 } dladm_wlan_reason_t;
96 
97 typedef enum {
98 	DLADM_WLAN_SECMODE_NONE = 1,
99 	DLADM_WLAN_SECMODE_WEP,
100 	DLADM_WLAN_SECMODE_WPA
101 } dladm_wlan_secmode_t;
102 
103 typedef enum {
104 	DLADM_WLAN_STRENGTH_VERY_WEAK = 1,
105 	DLADM_WLAN_STRENGTH_WEAK,
106 	DLADM_WLAN_STRENGTH_GOOD,
107 	DLADM_WLAN_STRENGTH_VERY_GOOD,
108 	DLADM_WLAN_STRENGTH_EXCELLENT
109 } dladm_wlan_strength_t;
110 
111 typedef enum {
112 	DLADM_WLAN_MODE_NONE = 0,
113 	DLADM_WLAN_MODE_80211A,
114 	DLADM_WLAN_MODE_80211B,
115 	DLADM_WLAN_MODE_80211G
116 } dladm_wlan_mode_t;
117 
118 typedef enum {
119 	DLADM_WLAN_AUTH_OPEN = 1,
120 	DLADM_WLAN_AUTH_SHARED
121 } dladm_wlan_auth_t;
122 
123 typedef enum {
124 	DLADM_WLAN_BSSTYPE_BSS = 1,
125 	DLADM_WLAN_BSSTYPE_IBSS,
126 	DLADM_WLAN_BSSTYPE_ANY
127 } dladm_wlan_bsstype_t;
128 
129 typedef enum {
130 	DLADM_WLAN_LINK_DISCONNECTED = 1,
131 	DLADM_WLAN_LINK_CONNECTED
132 } dladm_wlan_linkstatus_t;
133 
134 typedef uint32_t dladm_wlan_speed_t;
135 typedef	uint32_t dladm_wlan_channel_t;
136 
137 enum {
138 	DLADM_WLAN_ATTR_ESSID	= 0x00000001,
139 	DLADM_WLAN_ATTR_BSSID	= 0x00000002,
140 	DLADM_WLAN_ATTR_SECMODE	= 0x00000004,
141 	DLADM_WLAN_ATTR_STRENGTH = 0x00000008,
142 	DLADM_WLAN_ATTR_MODE	= 0x00000010,
143 	DLADM_WLAN_ATTR_SPEED	= 0x00000020,
144 	DLADM_WLAN_ATTR_AUTH	= 0x00000040,
145 	DLADM_WLAN_ATTR_BSSTYPE	= 0x00000080,
146 	DLADM_WLAN_ATTR_CHANNEL	= 0x00000100
147 };
148 typedef struct dladm_wlan_attr {
149 	uint_t			wa_valid;
150 	dladm_wlan_essid_t	wa_essid;
151 	dladm_wlan_bssid_t	wa_bssid;
152 	dladm_wlan_secmode_t	wa_secmode;
153 	dladm_wlan_strength_t	wa_strength;
154 	dladm_wlan_mode_t	wa_mode;
155 	dladm_wlan_speed_t	wa_speed;
156 	dladm_wlan_auth_t	wa_auth;
157 	dladm_wlan_bsstype_t	wa_bsstype;
158 	dladm_wlan_channel_t	wa_channel;
159 } dladm_wlan_attr_t;
160 
161 enum {
162 	DLADM_WLAN_LINKATTR_STATUS	= 0x00000001,
163 	DLADM_WLAN_LINKATTR_WLAN	= 0x00000002
164 };
165 typedef struct dladm_wlan_linkattr {
166 	uint_t			la_valid;
167 	dladm_wlan_linkstatus_t	la_status;
168 	dladm_wlan_attr_t	la_wlan_attr;
169 } dladm_wlan_linkattr_t;
170 
171 #define	DLADM_WLAN_WEPKEY64_LEN		5 	/* per WEP spec */
172 #define	DLADM_WLAN_WEPKEY128_LEN	13 	/* per WEP spec */
173 #define	DLADM_WLAN_MAX_KEY_LEN		64	/* per WEP/WPA spec */
174 #define	DLADM_WLAN_MAX_WEPKEYS		4 	/* MAX_NWEPKEYS */
175 #define	DLADM_WLAN_MAX_KEYNAME_LEN	64
176 typedef struct dladm_wlan_key {
177 	uint_t		wk_idx;
178 	uint_t		wk_len;
179 	uint8_t		wk_val[DLADM_WLAN_MAX_KEY_LEN];
180 	char		wk_name[DLADM_WLAN_MAX_KEYNAME_LEN];
181 	uint_t		wk_class;
182 } dladm_wlan_key_t;
183 
184 extern dladm_status_t	dladm_wlan_scan(datalink_id_t, void *,
185 			    boolean_t (*)(void *, dladm_wlan_attr_t *));
186 extern dladm_status_t	dladm_wlan_connect(datalink_id_t, dladm_wlan_attr_t *,
187 			    int, void *, uint_t, uint_t);
188 extern dladm_status_t	dladm_wlan_disconnect(datalink_id_t);
189 extern dladm_status_t	dladm_wlan_get_linkattr(datalink_id_t,
190 			    dladm_wlan_linkattr_t *);
191 /* WPA support routines */
192 extern dladm_status_t	dladm_wlan_wpa_get_sr(datalink_id_t, dladm_wlan_ess_t *,
193 			    uint_t, uint_t *);
194 extern dladm_status_t	dladm_wlan_wpa_set_ie(datalink_id_t, uint8_t *, uint_t);
195 extern dladm_status_t	dladm_wlan_wpa_set_wpa(datalink_id_t, boolean_t);
196 extern dladm_status_t	dladm_wlan_wpa_del_key(datalink_id_t, uint_t,
197 			    const dladm_wlan_bssid_t *);
198 extern dladm_status_t	dladm_wlan_wpa_set_key(datalink_id_t,
199 			    dladm_wlan_cipher_t, const dladm_wlan_bssid_t *,
200 			    boolean_t, uint64_t, uint_t, uint8_t *, uint_t);
201 extern dladm_status_t	dladm_wlan_wpa_set_mlme(datalink_id_t,
202 			    dladm_wlan_mlme_op_t,
203 			    dladm_wlan_reason_t, dladm_wlan_bssid_t *);
204 
205 extern const char	*dladm_wlan_essid2str(dladm_wlan_essid_t *, char *);
206 extern const char	*dladm_wlan_bssid2str(dladm_wlan_bssid_t *, char *);
207 extern const char	*dladm_wlan_secmode2str(dladm_wlan_secmode_t *, char *);
208 extern const char	*dladm_wlan_strength2str(dladm_wlan_strength_t *,
209 			    char *);
210 extern const char	*dladm_wlan_mode2str(dladm_wlan_mode_t *, char *);
211 extern const char	*dladm_wlan_speed2str(dladm_wlan_speed_t *, char *);
212 extern const char	*dladm_wlan_auth2str(dladm_wlan_auth_t *, char *);
213 extern const char	*dladm_wlan_bsstype2str(dladm_wlan_bsstype_t *, char *);
214 extern const char	*dladm_wlan_linkstatus2str(dladm_wlan_linkstatus_t *,
215 			    char *);
216 
217 extern dladm_status_t	dladm_wlan_str2essid(const char *,
218 			    dladm_wlan_essid_t *);
219 extern dladm_status_t	dladm_wlan_str2bssid(const char *,
220 			    dladm_wlan_bssid_t *);
221 extern dladm_status_t	dladm_wlan_str2secmode(const char *,
222 			    dladm_wlan_secmode_t *);
223 extern dladm_status_t	dladm_wlan_str2strength(const char *,
224 			    dladm_wlan_strength_t *);
225 extern dladm_status_t	dladm_wlan_str2mode(const char *,
226 			    dladm_wlan_mode_t *);
227 extern dladm_status_t	dladm_wlan_str2speed(const char *,
228 			    dladm_wlan_speed_t *);
229 extern dladm_status_t	dladm_wlan_str2auth(const char *,
230 			    dladm_wlan_auth_t *);
231 extern dladm_status_t	dladm_wlan_str2bsstype(const char *,
232 			    dladm_wlan_bsstype_t *);
233 extern dladm_status_t	dladm_wlan_str2linkstatus(const char *,
234 			    dladm_wlan_linkstatus_t *);
235 
236 #ifdef	__cplusplus
237 }
238 #endif
239 
240 #endif	/* _LIBDLWLAN_H */
241