xref: /titanic_41/usr/src/lib/libdladm/common/libdlwlan.h (revision 7800901e60d340b6af88e94a2149805dcfcaaf56)
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 2007 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	/* per 802.11 spec */
51 #define	DLADM_WLAN_BSSID_LEN		6	/* per 802.11 spec */
52 #define	DLADM_WLAN_WPA_KEY_LEN		32	/* per 802.11i spec */
53 #define	DLADM_WLAN_MAX_WPA_IE_LEN	40	/* per 802.11i spec */
54 
55 #define	DLADM_WLAN_CONNECT_TIMEOUT_DEFAULT	10
56 #define	DLADM_WLAN_CONNECT_CREATEIBSS		0x00000001
57 #define	DLADM_WLAN_CONNECT_NOSCAN		0x00000002
58 
59 typedef struct dladm_wlan_essid {
60 	char	we_bytes[DLADM_WLAN_MAX_ESSID_LEN];
61 } dladm_wlan_essid_t;
62 
63 typedef struct dladm_wlan_bssid {
64 	uint8_t	wb_bytes[DLADM_WLAN_BSSID_LEN];
65 } dladm_wlan_bssid_t;
66 
67 typedef struct dladm_wlan_ess {
68 	dladm_wlan_bssid_t	we_bssid;
69 	dladm_wlan_essid_t	we_ssid;
70 	uint_t			we_ssid_len;
71 	uint8_t			we_wpa_ie[DLADM_WLAN_MAX_WPA_IE_LEN];
72 	uint_t			we_wpa_ie_len;
73 	int			we_freq;
74 } dladm_wlan_ess_t;
75 
76 typedef enum {
77 	DLADM_WLAN_CIPHER_WEP		= 0,
78 	DLADM_WLAN_CIPHER_TKIP,
79 	DLADM_WLAN_CIPHER_AES_OCB,
80 	DLADM_WLAN_CIPHER_AES_CCM,
81 	DLADM_WLAN_CIPHER_CKIP,
82 	DLADM_WLAN_CIPHER_NONE
83 } dladm_wlan_cipher_t;
84 
85 typedef enum {
86 	DLADM_WLAN_MLME_ASSOC		= 1,	/* associate station */
87 	DLADM_WLAN_MLME_DISASSOC	= 2	/* disassociate station */
88 } dladm_wlan_mlme_op_t;
89 
90 typedef enum {
91 	DLADM_WLAN_REASON_UNSPECIFIED	= 1,
92 	DLADM_WLAN_REASON_DISASSOC_LEAVING	= 5
93 } dladm_wlan_reason_t;
94 
95 typedef enum {
96 	DLADM_WLAN_SECMODE_NONE = 1,
97 	DLADM_WLAN_SECMODE_WEP,
98 	DLADM_WLAN_SECMODE_WPA
99 } dladm_wlan_secmode_t;
100 
101 typedef enum {
102 	DLADM_WLAN_STRENGTH_VERY_WEAK = 1,
103 	DLADM_WLAN_STRENGTH_WEAK,
104 	DLADM_WLAN_STRENGTH_GOOD,
105 	DLADM_WLAN_STRENGTH_VERY_GOOD,
106 	DLADM_WLAN_STRENGTH_EXCELLENT
107 } dladm_wlan_strength_t;
108 
109 typedef enum {
110 	DLADM_WLAN_MODE_NONE = 0,
111 	DLADM_WLAN_MODE_80211A,
112 	DLADM_WLAN_MODE_80211B,
113 	DLADM_WLAN_MODE_80211G
114 } dladm_wlan_mode_t;
115 
116 typedef enum {
117 	DLADM_WLAN_AUTH_OPEN = 1,
118 	DLADM_WLAN_AUTH_SHARED
119 } dladm_wlan_auth_t;
120 
121 typedef enum {
122 	DLADM_WLAN_BSSTYPE_BSS = 1,
123 	DLADM_WLAN_BSSTYPE_IBSS,
124 	DLADM_WLAN_BSSTYPE_ANY
125 } dladm_wlan_bsstype_t;
126 
127 typedef enum {
128 	DLADM_WLAN_LINKSTATUS_DISCONNECTED = 1,
129 	DLADM_WLAN_LINKSTATUS_CONNECTED
130 } dladm_wlan_linkstatus_t;
131 
132 typedef uint32_t dladm_wlan_speed_t;
133 typedef	uint32_t dladm_wlan_channel_t;
134 
135 typedef enum {
136 	DLADM_WLAN_SVC_SUCCESS,
137 	DLADM_WLAN_SVC_FAILURE,
138 	DLADM_WLAN_SVC_APP_FAILURE,
139 	DLADM_WLAN_SVC_INSTANCE_EXISTS
140 } dladm_wlan_svc_status_t;
141 
142 enum {
143 	DLADM_WLAN_ATTR_ESSID	= 0x00000001,
144 	DLADM_WLAN_ATTR_BSSID	= 0x00000002,
145 	DLADM_WLAN_ATTR_SECMODE	= 0x00000004,
146 	DLADM_WLAN_ATTR_STRENGTH = 0x00000008,
147 	DLADM_WLAN_ATTR_MODE	= 0x00000010,
148 	DLADM_WLAN_ATTR_SPEED	= 0x00000020,
149 	DLADM_WLAN_ATTR_AUTH	= 0x00000040,
150 	DLADM_WLAN_ATTR_BSSTYPE	= 0x00000080,
151 	DLADM_WLAN_ATTR_CHANNEL	= 0x00000100
152 };
153 typedef struct dladm_wlan_attr {
154 	uint_t			wa_valid;
155 	dladm_wlan_essid_t	wa_essid;
156 	dladm_wlan_bssid_t	wa_bssid;
157 	dladm_wlan_secmode_t	wa_secmode;
158 	dladm_wlan_strength_t	wa_strength;
159 	dladm_wlan_mode_t	wa_mode;
160 	dladm_wlan_speed_t	wa_speed;
161 	dladm_wlan_auth_t	wa_auth;
162 	dladm_wlan_bsstype_t	wa_bsstype;
163 	dladm_wlan_channel_t	wa_channel;
164 } dladm_wlan_attr_t;
165 
166 enum {
167 	DLADM_WLAN_LINKATTR_STATUS	= 0x00000001,
168 	DLADM_WLAN_LINKATTR_WLAN	= 0x00000002
169 };
170 typedef struct dladm_wlan_linkattr {
171 	uint_t			la_valid;
172 	dladm_wlan_linkstatus_t	la_status;
173 	dladm_wlan_attr_t	la_wlan_attr;
174 } dladm_wlan_linkattr_t;
175 
176 #define	DLADM_WLAN_WEPKEY64_LEN		5 	/* per WEP spec */
177 #define	DLADM_WLAN_WEPKEY128_LEN	13 	/* per WEP spec */
178 #define	DLADM_WLAN_MAX_KEY_LEN		64	/* per WEP/WPA spec */
179 #define	DLADM_WLAN_MAX_WEPKEYS		4 	/* MAX_NWEPKEYS */
180 #define	DLADM_WLAN_MAX_KEYNAME_LEN	64
181 typedef struct dladm_wlan_key {
182 	uint_t		wk_idx;
183 	uint_t		wk_len;
184 	uint8_t		wk_val[DLADM_WLAN_MAX_KEY_LEN];
185 	char		wk_name[DLADM_WLAN_MAX_KEYNAME_LEN];
186 	uint_t		wk_class;
187 } dladm_wlan_key_t;
188 
189 extern dladm_status_t	dladm_wlan_scan(const char *, void *,
190 			    boolean_t (*)(void *, dladm_wlan_attr_t *));
191 extern dladm_status_t	dladm_wlan_connect(const char *, dladm_wlan_attr_t *,
192 			    int, void *, uint_t, uint_t);
193 extern dladm_status_t	dladm_wlan_disconnect(const char *);
194 extern dladm_status_t	dladm_wlan_get_linkattr(const char *,
195 			    dladm_wlan_linkattr_t *);
196 extern dladm_status_t	dladm_wlan_walk(void *,
197 			    boolean_t (*)(void *, const char *));
198 extern boolean_t	dladm_wlan_is_valid(const char *);
199 extern dladm_status_t	dladm_wlan_set_prop(const char *, const char *,
200 			    char **, uint_t, char **);
201 extern dladm_status_t	dladm_wlan_walk_prop(const char *, void *,
202 			    boolean_t (*)(void *, const char *));
203 extern dladm_status_t	dladm_wlan_get_prop(const char *, dladm_prop_type_t,
204 			    const char *, char **, uint_t *);
205 /* WPA support routines */
206 extern dladm_status_t	dladm_wlan_wpa_get_sr(const char *,
207 			    dladm_wlan_ess_t *, uint_t, uint_t *);
208 extern dladm_status_t	dladm_wlan_wpa_set_ie(const char *, uint8_t *, uint_t);
209 extern dladm_status_t	dladm_wlan_wpa_set_wpa(const char *, boolean_t);
210 extern dladm_status_t	dladm_wlan_wpa_del_key(const char *,
211 			    uint_t, const dladm_wlan_bssid_t *);
212 extern dladm_status_t	dladm_wlan_wpa_set_key(const char *,
213 			    dladm_wlan_cipher_t, const dladm_wlan_bssid_t *,
214 			    boolean_t, uint64_t, uint_t, uint8_t *, uint_t);
215 extern dladm_status_t	dladm_wlan_wpa_set_mlme(const char *,
216 			    dladm_wlan_mlme_op_t,
217 			    dladm_wlan_reason_t, dladm_wlan_bssid_t *);
218 
219 extern const char	*dladm_wlan_essid2str(dladm_wlan_essid_t *, char *);
220 extern const char	*dladm_wlan_bssid2str(dladm_wlan_bssid_t *, char *);
221 extern const char	*dladm_wlan_secmode2str(dladm_wlan_secmode_t *, char *);
222 extern const char	*dladm_wlan_strength2str(dladm_wlan_strength_t *,
223 			    char *);
224 extern const char	*dladm_wlan_mode2str(dladm_wlan_mode_t *, char *);
225 extern const char	*dladm_wlan_speed2str(dladm_wlan_speed_t *, char *);
226 extern const char	*dladm_wlan_auth2str(dladm_wlan_auth_t *, char *);
227 extern const char	*dladm_wlan_bsstype2str(dladm_wlan_bsstype_t *, char *);
228 extern const char	*dladm_wlan_linkstatus2str(dladm_wlan_linkstatus_t *,
229 			    char *);
230 
231 extern dladm_status_t	dladm_wlan_str2essid(const char *,
232 			    dladm_wlan_essid_t *);
233 extern dladm_status_t	dladm_wlan_str2bssid(const char *,
234 			    dladm_wlan_bssid_t *);
235 extern dladm_status_t	dladm_wlan_str2secmode(const char *,
236 			    dladm_wlan_secmode_t *);
237 extern dladm_status_t	dladm_wlan_str2strength(const char *,
238 			    dladm_wlan_strength_t *);
239 extern dladm_status_t	dladm_wlan_str2mode(const char *,
240 			    dladm_wlan_mode_t *);
241 extern dladm_status_t	dladm_wlan_str2speed(const char *,
242 			    dladm_wlan_speed_t *);
243 extern dladm_status_t	dladm_wlan_str2auth(const char *,
244 			    dladm_wlan_auth_t *);
245 extern dladm_status_t	dladm_wlan_str2bsstype(const char *,
246 			    dladm_wlan_bsstype_t *);
247 extern dladm_status_t	dladm_wlan_str2linkstatus(const char *,
248 			    dladm_wlan_linkstatus_t *);
249 
250 #ifdef	__cplusplus
251 }
252 #endif
253 
254 #endif	/* _LIBDLWLAN_H */
255