No need to check WMM IE OUI or type here
[wpasupplicant] / hostapd / wme.c
1 /*
2  * hostapd / WMM (Wi-Fi Multimedia)
3  * Copyright 2002-2003, Instant802 Networks, Inc.
4  * Copyright 2005-2006, Devicescape Software, Inc.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * Alternatively, this software may be distributed under the terms of BSD
11  * license.
12  *
13  * See README and COPYING for more details.
14  */
15
16 #include "includes.h"
17
18 #include "hostapd.h"
19 #include "ieee802_11.h"
20 #include "wme.h"
21 #include "sta_info.h"
22 #include "driver_i.h"
23
24
25 /* TODO: maintain separate sequence and fragment numbers for each AC
26  * TODO: IGMP snooping to track which multicasts to forward - and use QOS-DATA
27  * if only WMM stations are receiving a certain group */
28
29
30 static inline u8 wmm_aci_aifsn(int aifsn, int acm, int aci)
31 {
32         u8 ret;
33         ret = (aifsn << WMM_AC_AIFNS_SHIFT) & WMM_AC_AIFSN_MASK;
34         if (acm)
35                 ret |= WMM_AC_ACM;
36         ret |= (aci << WMM_AC_ACI_SHIFT) & WMM_AC_ACI_MASK;
37         return ret;
38 }
39
40
41 static inline u8 wmm_ecw(int ecwmin, int ecwmax)
42 {
43         return ((ecwmin << WMM_AC_ECWMIN_SHIFT) & WMM_AC_ECWMIN_MASK) |
44                 ((ecwmax << WMM_AC_ECWMAX_SHIFT) & WMM_AC_ECWMAX_MASK);
45 }
46
47
48 /*
49  * Add WMM Parameter Element to Beacon, Probe Response, and (Re)Association
50  * Response frames.
51  */
52 u8 * hostapd_eid_wmm(struct hostapd_data *hapd, u8 *eid)
53 {
54         u8 *pos = eid;
55         struct wmm_parameter_element *wmm =
56                 (struct wmm_parameter_element *) (pos + 2);
57         int e;
58
59         if (!hapd->conf->wmm_enabled)
60                 return eid;
61         eid[0] = WLAN_EID_VENDOR_SPECIFIC;
62         wmm->oui[0] = 0x00;
63         wmm->oui[1] = 0x50;
64         wmm->oui[2] = 0xf2;
65         wmm->oui_type = WMM_OUI_TYPE;
66         wmm->oui_subtype = WMM_OUI_SUBTYPE_PARAMETER_ELEMENT;
67         wmm->version = WMM_VERSION;
68         wmm->qos_info = hapd->parameter_set_count & 0xf;
69
70         /* fill in a parameter set record for each AC */
71         for (e = 0; e < 4; e++) {
72                 struct wmm_ac_parameter *ac = &wmm->ac[e];
73                 struct hostapd_wmm_ac_params *acp =
74                         &hapd->iconf->wmm_ac_params[e];
75
76                 ac->aci_aifsn = wmm_aci_aifsn(acp->aifs,
77                                               acp->admission_control_mandatory,
78                                               e);
79                 ac->cw = wmm_ecw(acp->cwmin, acp->cwmax);
80                 ac->txop_limit = host_to_le16(acp->txop_limit);
81         }
82
83         pos = (u8 *) (wmm + 1);
84         eid[1] = pos - eid - 2; /* element length */
85
86         return pos;
87 }
88
89
90 /* This function is called when a station sends an association request with
91  * WMM info element. The function returns zero on success or non-zero on any
92  * error in WMM element. eid does not include Element ID and Length octets. */
93 int hostapd_eid_wmm_valid(struct hostapd_data *hapd, u8 *eid, size_t len)
94 {
95         struct wmm_information_element *wmm;
96
97         wpa_hexdump(MSG_MSGDUMP, "WMM IE", eid, len);
98
99         if (len < sizeof(struct wmm_information_element)) {
100                 wpa_printf(MSG_DEBUG, "Too short WMM IE (len=%lu)",
101                            (unsigned long) len);
102                 return -1;
103         }
104
105         wmm = (struct wmm_information_element *) eid;
106         wpa_printf(MSG_DEBUG, "Validating WMM IE: OUI %02x:%02x:%02x  "
107                    "OUI type %d  OUI sub-type %d  version %d  QoS info 0x%x",
108                    wmm->oui[0], wmm->oui[1], wmm->oui[2], wmm->oui_type,
109                    wmm->oui_subtype, wmm->version, wmm->qos_info);
110         if (wmm->oui_subtype != WMM_OUI_SUBTYPE_INFORMATION_ELEMENT ||
111             wmm->version != WMM_VERSION) {
112                 wpa_printf(MSG_DEBUG, "Unsupported WMM IE Subtype/Version");
113                 return -1;
114         }
115
116         return 0;
117 }
118
119
120 /* This function is called when a station sends an ACK frame for an AssocResp
121  * frame (status=success) and the matching AssocReq contained a WMM element.
122  */
123 int hostapd_wmm_sta_config(struct hostapd_data *hapd, struct sta_info *sta)
124 {
125         /* update kernel STA data for WMM related items (WLAN_STA_WPA flag) */
126         if (sta->flags & WLAN_STA_WMM)
127                 hostapd_sta_set_flags(hapd, sta->addr, sta->flags,
128                                       WLAN_STA_WMM, ~0);
129         else
130                 hostapd_sta_set_flags(hapd, sta->addr, sta->flags,
131                                       0, ~WLAN_STA_WMM);
132
133         return 0;
134 }
135
136
137 static void wmm_send_action(struct hostapd_data *hapd, const u8 *addr,
138                             const struct wmm_tspec_element *tspec,
139                             u8 action_code, u8 dialogue_token, u8 status_code)
140 {
141         u8 buf[256];
142         struct ieee80211_mgmt *m = (struct ieee80211_mgmt *) buf;
143         struct wmm_tspec_element *t = (struct wmm_tspec_element *)
144                 m->u.action.u.wmm_action.variable;
145         int len;
146
147         hostapd_logger(hapd, addr, HOSTAPD_MODULE_IEEE80211,
148                        HOSTAPD_LEVEL_DEBUG,
149                        "action response - reason %d", status_code);
150         os_memset(buf, 0, sizeof(buf));
151         m->frame_control = IEEE80211_FC(WLAN_FC_TYPE_MGMT,
152                                         WLAN_FC_STYPE_ACTION);
153         os_memcpy(m->da, addr, ETH_ALEN);
154         os_memcpy(m->sa, hapd->own_addr, ETH_ALEN);
155         os_memcpy(m->bssid, hapd->own_addr, ETH_ALEN);
156         m->u.action.category = WLAN_ACTION_WMM;
157         m->u.action.u.wmm_action.action_code = action_code;
158         m->u.action.u.wmm_action.dialog_token = dialogue_token;
159         m->u.action.u.wmm_action.status_code = status_code;
160         os_memcpy(t, tspec, sizeof(struct wmm_tspec_element));
161         len = ((u8 *) (t + 1)) - buf;
162
163         if (hostapd_send_mgmt_frame(hapd, m, len, 0) < 0)
164                 perror("wmm_send_action: send");
165 }
166
167
168 /* given frame data payload size in bytes, and data_rate in bits per second
169  * returns time to complete frame exchange */
170 /* FIX: should not use floating point types */
171 static double wmm_frame_exchange_time(int bytes, int data_rate, int encryption,
172                                       int cts_protection)
173 {
174         /* TODO: account for MAC/PHY headers correctly */
175         /* TODO: account for encryption headers */
176         /* TODO: account for WDS headers */
177         /* TODO: account for CTS protection */
178         /* TODO: account for SIFS + ACK at minimum PHY rate */
179         return (bytes + 400) * 8.0 / data_rate;
180 }
181
182
183 static void wmm_addts_req(struct hostapd_data *hapd,
184                           struct ieee80211_mgmt *mgmt,
185                           struct wmm_tspec_element *tspec, size_t len)
186 {
187         /* FIX: should not use floating point types */
188         double medium_time, pps;
189
190         /* TODO: account for airtime and answer no to tspec setup requests
191          * when none left!! */
192
193         pps = (le_to_host32(tspec->mean_data_rate) / 8.0) /
194                 le_to_host16(tspec->nominal_msdu_size);
195         medium_time = (le_to_host16(tspec->surplus_bandwidth_allowance) / 8) *
196                 pps *
197                 wmm_frame_exchange_time(le_to_host16(tspec->nominal_msdu_size),
198                                         le_to_host32(tspec->minimum_phy_rate),
199                                         0, 0);
200         tspec->medium_time = host_to_le16(medium_time * 1000000.0 / 32.0);
201
202         wmm_send_action(hapd, mgmt->sa, tspec, WMM_ACTION_CODE_ADDTS_RESP,
203                         mgmt->u.action.u.wmm_action.dialog_token,
204                         WMM_ADDTS_STATUS_ADMISSION_ACCEPTED);
205 }
206
207
208 void hostapd_wmm_action(struct hostapd_data *hapd, struct ieee80211_mgmt *mgmt,
209                         size_t len)
210 {
211         int action_code;
212         int left = len - IEEE80211_HDRLEN - 4;
213         u8 *pos = ((u8 *) mgmt) + IEEE80211_HDRLEN + 4;
214         struct ieee802_11_elems elems;
215         struct sta_info *sta = ap_get_sta(hapd, mgmt->sa);
216
217         /* check that the request comes from a valid station */
218         if (!sta ||
219             (sta->flags & (WLAN_STA_ASSOC | WLAN_STA_WMM)) !=
220             (WLAN_STA_ASSOC | WLAN_STA_WMM)) {
221                 hostapd_logger(hapd, mgmt->sa, HOSTAPD_MODULE_IEEE80211,
222                                HOSTAPD_LEVEL_DEBUG,
223                                "wmm action received is not from associated wmm"
224                                " station");
225                 /* TODO: respond with action frame refused status code */
226                 return;
227         }
228
229         /* extract the tspec info element */
230         if (ieee802_11_parse_elems(pos, left, &elems, 1) == ParseFailed) {
231                 hostapd_logger(hapd, mgmt->sa, HOSTAPD_MODULE_IEEE80211,
232                                HOSTAPD_LEVEL_DEBUG,
233                                "hostapd_wmm_action - could not parse wmm "
234                                "action");
235                 /* TODO: respond with action frame invalid parameters status
236                  * code */
237                 return;
238         }
239
240         if (!elems.wmm_tspec ||
241             elems.wmm_tspec_len != (sizeof(struct wmm_tspec_element) - 2)) {
242                 hostapd_logger(hapd, mgmt->sa, HOSTAPD_MODULE_IEEE80211,
243                                HOSTAPD_LEVEL_DEBUG,
244                                "hostapd_wmm_action - missing or wrong length "
245                                "tspec");
246                 /* TODO: respond with action frame invalid parameters status
247                  * code */
248                 return;
249         }
250
251         /* TODO: check the request is for an AC with ACM set, if not, refuse
252          * request */
253
254         action_code = mgmt->u.action.u.wmm_action.action_code;
255         switch (action_code) {
256         case WMM_ACTION_CODE_ADDTS_REQ:
257                 wmm_addts_req(hapd, mgmt, (struct wmm_tspec_element *)
258                               (elems.wmm_tspec - 2), len);
259                 return;
260 #if 0
261         /* TODO: needed for client implementation */
262         case WMM_ACTION_CODE_ADDTS_RESP:
263                 wmm_setup_request(hapd, mgmt, len);
264                 return;
265         /* TODO: handle station teardown requests */
266         case WMM_ACTION_CODE_DELTS:
267                 wmm_teardown(hapd, mgmt, len);
268                 return;
269 #endif
270         }
271
272         hostapd_logger(hapd, mgmt->sa, HOSTAPD_MODULE_IEEE80211,
273                        HOSTAPD_LEVEL_DEBUG,
274                        "hostapd_wmm_action - unknown action code %d",
275                        action_code);
276 }