]>
Commit | Line | Data |
---|---|---|
b22128ef JM |
1 | /* |
2 | * Wi-Fi Direct - P2P module | |
3 | * Copyright (c) 2009-2010, Atheros Communications | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License version 2 as | |
7 | * published by the Free Software Foundation. | |
8 | * | |
9 | * Alternatively, this software may be distributed under the terms of BSD | |
10 | * license. | |
11 | * | |
12 | * See README and COPYING for more details. | |
13 | */ | |
14 | ||
15 | #ifndef P2P_H | |
16 | #define P2P_H | |
17 | ||
18 | /** | |
19 | * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes | |
20 | */ | |
21 | #define P2P_MAX_REG_CLASSES 10 | |
22 | ||
23 | /** | |
24 | * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class | |
25 | */ | |
26 | #define P2P_MAX_REG_CLASS_CHANNELS 20 | |
27 | ||
28 | /** | |
29 | * struct p2p_channels - List of supported channels | |
30 | */ | |
31 | struct p2p_channels { | |
32 | /** | |
33 | * struct p2p_reg_class - Supported regulatory class | |
34 | */ | |
35 | struct p2p_reg_class { | |
36 | /** | |
37 | * reg_class - Regulatory class (IEEE 802.11-2007, Annex J) | |
38 | */ | |
39 | u8 reg_class; | |
40 | ||
41 | /** | |
42 | * channel - Supported channels | |
43 | */ | |
44 | u8 channel[P2P_MAX_REG_CLASS_CHANNELS]; | |
45 | ||
46 | /** | |
47 | * channels - Number of channel entries in use | |
48 | */ | |
49 | size_t channels; | |
50 | } reg_class[P2P_MAX_REG_CLASSES]; | |
51 | ||
52 | /** | |
53 | * reg_classes - Number of reg_class entries in use | |
54 | */ | |
55 | size_t reg_classes; | |
56 | }; | |
57 | ||
58 | enum p2p_wps_method { | |
59 | WPS_NOT_READY, WPS_PIN_LABEL, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC | |
60 | }; | |
61 | ||
62 | /** | |
63 | * struct p2p_go_neg_results - P2P Group Owner Negotiation results | |
64 | */ | |
65 | struct p2p_go_neg_results { | |
66 | /** | |
67 | * status - Negotiation result (Status Code) | |
68 | * | |
69 | * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate | |
70 | * failed negotiation. | |
71 | */ | |
72 | int status; | |
73 | ||
74 | /** | |
75 | * role_go - Whether local end is Group Owner | |
76 | */ | |
77 | int role_go; | |
78 | ||
79 | /** | |
80 | * freq - Frequency of the group operational channel in MHz | |
81 | */ | |
82 | int freq; | |
83 | ||
84 | /** | |
85 | * ssid - SSID of the group | |
86 | */ | |
87 | u8 ssid[32]; | |
88 | ||
89 | /** | |
90 | * ssid_len - Length of SSID in octets | |
91 | */ | |
92 | size_t ssid_len; | |
93 | ||
94 | /** | |
95 | * passphrase - WPA2-Personal passphrase for the group (GO only) | |
96 | */ | |
97 | char passphrase[64]; | |
98 | ||
99 | /** | |
100 | * peer_device_addr - P2P Device Address of the peer | |
101 | */ | |
102 | u8 peer_device_addr[ETH_ALEN]; | |
103 | ||
104 | /** | |
105 | * peer_interface_addr - P2P Interface Address of the peer | |
106 | */ | |
107 | u8 peer_interface_addr[ETH_ALEN]; | |
108 | ||
109 | /** | |
110 | * wps_method - WPS method to be used during provisioning | |
111 | */ | |
112 | enum p2p_wps_method wps_method; | |
113 | ||
114 | #define P2P_MAX_CHANNELS 50 | |
115 | ||
116 | /** | |
117 | * freq_list - Zero-terminated list of possible operational channels | |
118 | */ | |
119 | int freq_list[P2P_MAX_CHANNELS]; | |
120 | ||
121 | /** | |
122 | * persistent_group - Whether the group should be made persistent | |
123 | */ | |
124 | int persistent_group; | |
ae3e3421 JM |
125 | |
126 | /** | |
127 | * peer_config_timeout - Peer configuration timeout (in 10 msec units) | |
128 | */ | |
129 | unsigned int peer_config_timeout; | |
b22128ef JM |
130 | }; |
131 | ||
132 | struct p2p_data; | |
133 | ||
134 | enum p2p_scan_type { | |
135 | P2P_SCAN_SOCIAL, | |
136 | P2P_SCAN_FULL, | |
137 | P2P_SCAN_SPECIFIC, | |
138 | P2P_SCAN_SOCIAL_PLUS_ONE | |
139 | }; | |
140 | ||
10c5d2a5 JM |
141 | #define P2P_MAX_WPS_VENDOR_EXT 10 |
142 | ||
c5db8e51 KRK |
143 | /** |
144 | * struct p2p_peer_info - P2P peer information | |
c5db8e51 KRK |
145 | */ |
146 | struct p2p_peer_info { | |
147 | /** | |
148 | * p2p_device_addr - P2P Device Address of the peer | |
149 | */ | |
150 | u8 p2p_device_addr[ETH_ALEN]; | |
151 | ||
152 | /** | |
153 | * pri_dev_type - Primary Device Type | |
154 | */ | |
155 | u8 pri_dev_type[8]; | |
156 | ||
157 | /** | |
b67d0d9e | 158 | * device_name - Device Name (0..32 octets encoded in UTF-8) |
c5db8e51 KRK |
159 | */ |
160 | char device_name[33]; | |
161 | ||
b67d0d9e JM |
162 | /** |
163 | * manufacturer - Manufacturer (0..64 octets encoded in UTF-8) | |
164 | */ | |
165 | char manufacturer[65]; | |
166 | ||
167 | /** | |
168 | * model_name - Model Name (0..32 octets encoded in UTF-8) | |
169 | */ | |
170 | char model_name[33]; | |
171 | ||
172 | /** | |
173 | * model_number - Model Number (0..32 octets encoded in UTF-8) | |
174 | */ | |
175 | char model_number[33]; | |
176 | ||
177 | /** | |
178 | * serial_number - Serial Number (0..32 octets encoded in UTF-8) | |
179 | */ | |
180 | char serial_number[33]; | |
181 | ||
6402fc43 JS |
182 | /** |
183 | * level - Signal level | |
184 | */ | |
185 | int level; | |
186 | ||
c5db8e51 KRK |
187 | /** |
188 | * config_methods - WPS Configuration Methods | |
189 | */ | |
190 | u16 config_methods; | |
191 | ||
192 | /** | |
193 | * dev_capab - Device Capabilities | |
194 | */ | |
195 | u8 dev_capab; | |
196 | ||
197 | /** | |
198 | * group_capab - Group Capabilities | |
199 | */ | |
200 | u8 group_capab; | |
e57ae6e1 JMB |
201 | |
202 | /** | |
203 | * wps_sec_dev_type_list - WPS secondary device type list | |
204 | * | |
205 | * This list includes from 0 to 16 Secondary Device Types as indicated | |
206 | * by wps_sec_dev_type_list_len (8 * number of types). | |
207 | */ | |
208 | u8 wps_sec_dev_type_list[128]; | |
209 | ||
210 | /** | |
211 | * wps_sec_dev_type_list_len - Length of secondary device type list | |
212 | */ | |
213 | size_t wps_sec_dev_type_list_len; | |
214 | ||
10c5d2a5 | 215 | struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT]; |
c5db8e51 KRK |
216 | }; |
217 | ||
349b213c JS |
218 | enum p2p_prov_disc_status { |
219 | P2P_PROV_DISC_SUCCESS, | |
220 | P2P_PROV_DISC_TIMEOUT, | |
221 | P2P_PROV_DISC_REJECTED, | |
222 | }; | |
223 | ||
b22128ef JM |
224 | /** |
225 | * struct p2p_config - P2P configuration | |
226 | * | |
227 | * This configuration is provided to the P2P module during initialization with | |
228 | * p2p_init(). | |
229 | */ | |
230 | struct p2p_config { | |
231 | /** | |
232 | * country - Country code to use in P2P operations | |
233 | */ | |
234 | char country[3]; | |
235 | ||
236 | /** | |
237 | * reg_class - Regulatory class for own listen channel | |
238 | */ | |
239 | u8 reg_class; | |
240 | ||
241 | /** | |
242 | * channel - Own listen channel | |
243 | */ | |
244 | u8 channel; | |
245 | ||
246 | /** | |
247 | * Regulatory class for own operational channel | |
248 | */ | |
249 | u8 op_reg_class; | |
250 | ||
251 | /** | |
252 | * op_channel - Own operational channel | |
253 | */ | |
254 | u8 op_channel; | |
255 | ||
7cfc4ac3 AGS |
256 | /** |
257 | * cfg_op_channel - Whether op_channel is hardcoded in configuration | |
258 | */ | |
259 | u8 cfg_op_channel; | |
260 | ||
b22128ef JM |
261 | /** |
262 | * channels - Own supported regulatory classes and channels | |
263 | * | |
264 | * List of supposerted channels per regulatory class. The regulatory | |
265 | * classes are defined in IEEE Std 802.11-2007 Annex J and the | |
266 | * numbering of the clases depends on the configured country code. | |
267 | */ | |
268 | struct p2p_channels channels; | |
269 | ||
270 | /** | |
271 | * pri_dev_type - Primary Device Type (see WPS) | |
272 | */ | |
273 | u8 pri_dev_type[8]; | |
274 | ||
275 | /** | |
276 | * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types | |
277 | */ | |
278 | #define P2P_SEC_DEVICE_TYPES 5 | |
279 | ||
280 | /** | |
281 | * sec_dev_type - Optional secondary device types | |
282 | */ | |
283 | u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8]; | |
284 | ||
b6e01800 JM |
285 | /** |
286 | * num_sec_dev_types - Number of sec_dev_type entries | |
287 | */ | |
288 | size_t num_sec_dev_types; | |
289 | ||
b22128ef JM |
290 | /** |
291 | * dev_addr - P2P Device Address | |
292 | */ | |
293 | u8 dev_addr[ETH_ALEN]; | |
294 | ||
295 | /** | |
296 | * dev_name - Device Name | |
297 | */ | |
298 | char *dev_name; | |
299 | ||
b6e01800 JM |
300 | char *manufacturer; |
301 | char *model_name; | |
302 | char *model_number; | |
303 | char *serial_number; | |
304 | ||
305 | u8 uuid[16]; | |
306 | u16 config_methods; | |
b22128ef JM |
307 | |
308 | /** | |
309 | * concurrent_operations - Whether concurrent operations are supported | |
310 | */ | |
311 | int concurrent_operations; | |
312 | ||
313 | /** | |
314 | * max_peers - Maximum number of discovered peers to remember | |
315 | * | |
316 | * If more peers are discovered, older entries will be removed to make | |
317 | * room for the new ones. | |
318 | */ | |
319 | size_t max_peers; | |
320 | ||
0f66abd2 SS |
321 | /** |
322 | * p2p_intra_bss - Intra BSS communication is supported | |
323 | */ | |
324 | int p2p_intra_bss; | |
325 | ||
b22128ef JM |
326 | /** |
327 | * ssid_postfix - Postfix data to add to the SSID | |
328 | * | |
329 | * This data will be added to the end of the SSID after the | |
330 | * DIRECT-<random two octets> prefix. | |
331 | */ | |
332 | u8 ssid_postfix[32 - 9]; | |
333 | ||
334 | /** | |
335 | * ssid_postfix_len - Length of the ssid_postfix data | |
336 | */ | |
337 | size_t ssid_postfix_len; | |
338 | ||
339 | /** | |
340 | * msg_ctx - Context to use with wpa_msg() calls | |
341 | */ | |
342 | void *msg_ctx; | |
343 | ||
344 | /** | |
345 | * cb_ctx - Context to use with callback functions | |
346 | */ | |
347 | void *cb_ctx; | |
348 | ||
349 | ||
350 | /* Callbacks to request lower layer driver operations */ | |
351 | ||
352 | /** | |
353 | * p2p_scan - Request a P2P scan/search | |
354 | * @ctx: Callback context from cb_ctx | |
355 | * @type: Scan type | |
356 | * @freq: Specific frequency (MHz) to scan or 0 for no restriction | |
046ef4aa JMB |
357 | * @num_req_dev_types: Number of requested device types |
358 | * @req_dev_types: Array containing requested device types | |
b22128ef JM |
359 | * Returns: 0 on success, -1 on failure |
360 | * | |
361 | * This callback function is used to request a P2P scan or search | |
362 | * operation to be completed. Type type argument specifies which type | |
363 | * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the | |
364 | * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL | |
365 | * indicates that all channels are to be scanned. @P2P_SCAN_SPECIFIC | |
366 | * request a scan of a single channel specified by freq. | |
367 | * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels | |
368 | * plus one extra channel specified by freq. | |
369 | * | |
370 | * The full scan is used for the initial scan to find group owners from | |
371 | * all. The other types are used during search phase scan of the social | |
372 | * channels (with potential variation if the Listen channel of the | |
373 | * target peer is known or if other channels are scanned in steps). | |
374 | * | |
375 | * The scan results are returned after this call by calling | |
376 | * p2p_scan_res_handler() for each scan result that has a P2P IE and | |
377 | * then calling p2p_scan_res_handled() to indicate that all scan | |
378 | * results have been indicated. | |
379 | */ | |
046ef4aa JMB |
380 | int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq, |
381 | unsigned int num_req_dev_types, | |
382 | const u8 *req_dev_types); | |
b22128ef JM |
383 | |
384 | /** | |
385 | * send_probe_resp - Transmit a Probe Response frame | |
386 | * @ctx: Callback context from cb_ctx | |
387 | * @buf: Probe Response frame (including the header and body) | |
388 | * Returns: 0 on success, -1 on failure | |
389 | * | |
390 | * This function is used to reply to Probe Request frames that were | |
391 | * indicated with a call to p2p_probe_req_rx(). The response is to be | |
392 | * sent on the same channel or to be dropped if the driver is not | |
393 | * anymore listening to Probe Request frames. | |
394 | * | |
395 | * Alternatively, the responsibility for building the Probe Response | |
396 | * frames in Listen state may be in another system component in which | |
397 | * case this function need to be implemented (i.e., the function | |
398 | * pointer can be %NULL). The WPS and P2P IEs to be added for Probe | |
399 | * Response frames in such a case are available from the | |
400 | * start_listen() callback. It should be noted that the received Probe | |
401 | * Request frames must be indicated by calling p2p_probe_req_rx() even | |
402 | * if this send_probe_resp() is not used. | |
403 | */ | |
404 | int (*send_probe_resp)(void *ctx, const struct wpabuf *buf); | |
405 | ||
406 | /** | |
407 | * send_action - Transmit an Action frame | |
408 | * @ctx: Callback context from cb_ctx | |
409 | * @freq: Frequency in MHz for the channel on which to transmit | |
410 | * @dst: Destination MAC address (Address 1) | |
411 | * @src: Source MAC address (Address 2) | |
412 | * @bssid: BSSID (Address 3) | |
413 | * @buf: Frame body (starting from Category field) | |
414 | * @len: Length of buf in octets | |
415 | * @wait_time: How many msec to wait for a response frame | |
416 | * Returns: 0 on success, -1 on failure | |
417 | * | |
418 | * The Action frame may not be transmitted immediately and the status | |
419 | * of the transmission must be reported by calling | |
420 | * p2p_send_action_cb() once the frame has either been transmitted or | |
421 | * it has been dropped due to excessive retries or other failure to | |
422 | * transmit. | |
423 | */ | |
424 | int (*send_action)(void *ctx, unsigned int freq, const u8 *dst, | |
425 | const u8 *src, const u8 *bssid, const u8 *buf, | |
426 | size_t len, unsigned int wait_time); | |
427 | ||
428 | /** | |
429 | * send_action_done - Notify that Action frame sequence was completed | |
430 | * @ctx: Callback context from cb_ctx | |
431 | * | |
432 | * This function is called when the Action frame sequence that was | |
433 | * started with send_action() has been completed, i.e., when there is | |
434 | * no need to wait for a response from the destination peer anymore. | |
435 | */ | |
436 | void (*send_action_done)(void *ctx); | |
437 | ||
438 | /** | |
439 | * start_listen - Start Listen state | |
440 | * @ctx: Callback context from cb_ctx | |
441 | * @freq: Frequency of the listen channel in MHz | |
442 | * @duration: Duration for the Listen state in milliseconds | |
443 | * @probe_resp_ie: IE(s) to be added to Probe Response frames | |
444 | * Returns: 0 on success, -1 on failure | |
445 | * | |
446 | * This Listen state may not start immediately since the driver may | |
447 | * have other pending operations to complete first. Once the Listen | |
448 | * state has started, p2p_listen_cb() must be called to notify the P2P | |
449 | * module. Once the Listen state is stopped, p2p_listen_end() must be | |
450 | * called to notify the P2P module that the driver is not in the Listen | |
451 | * state anymore. | |
452 | * | |
453 | * If the send_probe_resp() is not used for generating the response, | |
454 | * the IEs from probe_resp_ie need to be added to the end of the Probe | |
455 | * Response frame body. If send_probe_resp() is used, the probe_resp_ie | |
456 | * information can be ignored. | |
457 | */ | |
458 | int (*start_listen)(void *ctx, unsigned int freq, | |
459 | unsigned int duration, | |
460 | const struct wpabuf *probe_resp_ie); | |
461 | /** | |
462 | * stop_listen - Stop Listen state | |
463 | * @ctx: Callback context from cb_ctx | |
464 | * | |
465 | * This callback can be used to stop a Listen state operation that was | |
466 | * previously requested with start_listen(). | |
467 | */ | |
468 | void (*stop_listen)(void *ctx); | |
469 | ||
470 | /** | |
471 | * get_noa - Get current Notice of Absence attribute payload | |
472 | * @ctx: Callback context from cb_ctx | |
473 | * @interface_addr: P2P Interface Address of the GO | |
474 | * @buf: Buffer for returning NoA | |
475 | * @buf_len: Buffer length in octets | |
476 | * Returns: Number of octets used in buf, 0 to indicate no NoA is being | |
477 | * advertized, or -1 on failure | |
478 | * | |
479 | * This function is used to fetch the current Notice of Absence | |
480 | * attribute value from GO. | |
481 | */ | |
482 | int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf, | |
483 | size_t buf_len); | |
484 | ||
485 | /* Callbacks to notify events to upper layer management entity */ | |
486 | ||
487 | /** | |
488 | * dev_found - Notification of a found P2P Device | |
489 | * @ctx: Callback context from cb_ctx | |
490 | * @addr: Source address of the message triggering this notification | |
c5db8e51 | 491 | * @info: P2P peer information |
8fd7dc1b | 492 | * @new_device: Inform if the peer is newly found |
b22128ef JM |
493 | * |
494 | * This callback is used to notify that a new P2P Device has been | |
495 | * found. This may happen, e.g., during Search state based on scan | |
496 | * results or during Listen state based on receive Probe Request and | |
497 | * Group Owner Negotiation Request. | |
498 | */ | |
c5db8e51 | 499 | void (*dev_found)(void *ctx, const u8 *addr, |
8fd7dc1b JB |
500 | const struct p2p_peer_info *info, |
501 | int new_device); | |
b22128ef | 502 | |
56eeb8f2 JB |
503 | /** |
504 | * dev_lost - Notification of a lost P2P Device | |
505 | * @ctx: Callback context from cb_ctx | |
506 | * @dev_addr: P2P Device Address of the lost P2P Device | |
507 | * | |
508 | * This callback is used to notify that a P2P Device has been deleted. | |
509 | */ | |
510 | void (*dev_lost)(void *ctx, const u8 *dev_addr); | |
511 | ||
b22128ef JM |
512 | /** |
513 | * go_neg_req_rx - Notification of a receive GO Negotiation Request | |
514 | * @ctx: Callback context from cb_ctx | |
515 | * @src: Source address of the message triggering this notification | |
3dfda83d | 516 | * @dev_passwd_id: WPS Device Password ID |
b22128ef JM |
517 | * |
518 | * This callback is used to notify that a P2P Device is requesting | |
519 | * group owner negotiation with us, but we do not have all the | |
520 | * necessary information to start GO Negotiation. This indicates that | |
521 | * the local user has not authorized the connection yet by providing a | |
522 | * PIN or PBC button press. This information can be provided with a | |
523 | * call to p2p_connect(). | |
524 | */ | |
3dfda83d | 525 | void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id); |
b22128ef JM |
526 | |
527 | /** | |
528 | * go_neg_completed - Notification of GO Negotiation results | |
529 | * @ctx: Callback context from cb_ctx | |
530 | * @res: GO Negotiation results | |
531 | * | |
532 | * This callback is used to notify that Group Owner Negotiation has | |
533 | * been completed. Non-zero struct p2p_go_neg_results::status indicates | |
534 | * failed negotiation. In case of success, this function is responsible | |
535 | * for creating a new group interface (or using the existing interface | |
536 | * depending on driver features), setting up the group interface in | |
537 | * proper mode based on struct p2p_go_neg_results::role_go and | |
538 | * initializing WPS provisioning either as a Registrar (if GO) or as an | |
539 | * Enrollee. Successful WPS provisioning must be indicated by calling | |
540 | * p2p_wps_success_cb(). The callee is responsible for timing out group | |
541 | * formation if WPS provisioning cannot be completed successfully | |
542 | * within 15 seconds. | |
543 | */ | |
544 | void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res); | |
545 | ||
546 | /** | |
547 | * sd_request - Callback on Service Discovery Request | |
548 | * @ctx: Callback context from cb_ctx | |
549 | * @freq: Frequency (in MHz) of the channel | |
550 | * @sa: Source address of the request | |
551 | * @dialog_token: Dialog token | |
552 | * @update_indic: Service Update Indicator from the source of request | |
553 | * @tlvs: P2P Service Request TLV(s) | |
554 | * @tlvs_len: Length of tlvs buffer in octets | |
555 | * | |
556 | * This callback is used to indicate reception of a service discovery | |
557 | * request. Response to the query must be indicated by calling | |
558 | * p2p_sd_response() with the context information from the arguments to | |
559 | * this callback function. | |
560 | * | |
561 | * This callback handler can be set to %NULL to indicate that service | |
562 | * discovery is not supported. | |
563 | */ | |
564 | void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token, | |
565 | u16 update_indic, const u8 *tlvs, size_t tlvs_len); | |
566 | ||
567 | /** | |
568 | * sd_response - Callback on Service Discovery Response | |
569 | * @ctx: Callback context from cb_ctx | |
570 | * @sa: Source address of the request | |
571 | * @update_indic: Service Update Indicator from the source of response | |
572 | * @tlvs: P2P Service Response TLV(s) | |
573 | * @tlvs_len: Length of tlvs buffer in octets | |
574 | * | |
575 | * This callback is used to indicate reception of a service discovery | |
576 | * response. This callback handler can be set to %NULL if no service | |
577 | * discovery requests are used. The information provided with this call | |
578 | * is replies to the queries scheduled with p2p_sd_request(). | |
579 | */ | |
580 | void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic, | |
581 | const u8 *tlvs, size_t tlvs_len); | |
582 | ||
583 | /** | |
584 | * prov_disc_req - Callback on Provisiong Discovery Request | |
585 | * @ctx: Callback context from cb_ctx | |
586 | * @peer: Source address of the request | |
587 | * @config_methods: Requested WPS Config Method | |
588 | * @dev_addr: P2P Device Address of the found P2P Device | |
589 | * @pri_dev_type: Primary Device Type | |
590 | * @dev_name: Device Name | |
591 | * @supp_config_methods: Supported configuration Methods | |
592 | * @dev_capab: Device Capabilities | |
593 | * @group_capab: Group Capabilities | |
594 | * | |
595 | * This callback is used to indicate reception of a Provision Discovery | |
596 | * Request frame that the P2P module accepted. | |
597 | */ | |
598 | void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods, | |
599 | const u8 *dev_addr, const u8 *pri_dev_type, | |
600 | const char *dev_name, u16 supp_config_methods, | |
601 | u8 dev_capab, u8 group_capab); | |
602 | ||
603 | /** | |
604 | * prov_disc_resp - Callback on Provisiong Discovery Response | |
605 | * @ctx: Callback context from cb_ctx | |
606 | * @peer: Source address of the response | |
607 | * @config_methods: Value from p2p_prov_disc_req() or 0 on failure | |
608 | * | |
609 | * This callback is used to indicate reception of a Provision Discovery | |
610 | * Response frame for a pending request scheduled with | |
611 | * p2p_prov_disc_req(). This callback handler can be set to %NULL if | |
612 | * provision discovery is not used. | |
613 | */ | |
614 | void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods); | |
615 | ||
349b213c JS |
616 | /** |
617 | * prov_disc_fail - Callback on Provision Discovery failure | |
618 | * @ctx: Callback context from cb_ctx | |
619 | * @peer: Source address of the response | |
620 | * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS | |
621 | * | |
622 | * This callback is used to indicate either a failure or no response | |
623 | * to an earlier provision discovery request. | |
624 | * | |
625 | * This callback handler can be set to %NULL if provision discovery | |
626 | * is not used or failures do not need to be indicated. | |
627 | */ | |
628 | void (*prov_disc_fail)(void *ctx, const u8 *peer, | |
629 | enum p2p_prov_disc_status status); | |
630 | ||
b22128ef JM |
631 | /** |
632 | * invitation_process - Optional callback for processing Invitations | |
633 | * @ctx: Callback context from cb_ctx | |
634 | * @sa: Source address of the Invitation Request | |
635 | * @bssid: P2P Group BSSID from the request or %NULL if not included | |
636 | * @go_dev_addr: GO Device Address from P2P Group ID | |
637 | * @ssid: SSID from P2P Group ID | |
638 | * @ssid_len: Length of ssid buffer in octets | |
639 | * @go: Variable for returning whether the local end is GO in the group | |
640 | * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO) | |
641 | * @force_freq: Variable for returning forced frequency for the group | |
642 | * @persistent_group: Whether this is an invitation to reinvoke a | |
643 | * persistent group (instead of invitation to join an active | |
644 | * group) | |
645 | * Returns: Status code (P2P_SC_*) | |
646 | * | |
647 | * This optional callback can be used to implement persistent reconnect | |
648 | * by allowing automatic restarting of persistent groups without user | |
649 | * interaction. If this callback is not implemented (i.e., is %NULL), | |
650 | * the received Invitation Request frames are replied with | |
651 | * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the | |
652 | * invitation_result() callback. | |
653 | * | |
654 | * If the requested parameters are acceptable and the group is known, | |
655 | * %P2P_SC_SUCCESS may be returned. If the requested group is unknown, | |
656 | * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED | |
657 | * can be returned if there is not enough data to provide immediate | |
658 | * response, i.e., if some sort of user interaction is needed. The | |
659 | * invitation_received() callback will be called in that case | |
660 | * immediately after this call. | |
661 | */ | |
662 | u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid, | |
663 | const u8 *go_dev_addr, const u8 *ssid, | |
664 | size_t ssid_len, int *go, u8 *group_bssid, | |
665 | int *force_freq, int persistent_group); | |
666 | ||
667 | /** | |
668 | * invitation_received - Callback on Invitation Request RX | |
669 | * @ctx: Callback context from cb_ctx | |
670 | * @sa: Source address of the Invitation Request | |
671 | * @bssid: P2P Group BSSID or %NULL if not received | |
672 | * @ssid: SSID of the group | |
673 | * @ssid_len: Length of ssid in octets | |
674 | * @go_dev_addr: GO Device Address | |
675 | * @status: Response Status | |
676 | * @op_freq: Operational frequency for the group | |
677 | * | |
678 | * This callback is used to indicate sending of an Invitation Response | |
679 | * for a received Invitation Request. If status == 0 (success), the | |
680 | * upper layer code is responsible for starting the group. status == 1 | |
681 | * indicates need to get user authorization for the group. Other status | |
682 | * values indicate that the invitation request was rejected. | |
683 | */ | |
684 | void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid, | |
685 | const u8 *ssid, size_t ssid_len, | |
686 | const u8 *go_dev_addr, u8 status, | |
687 | int op_freq); | |
688 | ||
689 | /** | |
690 | * invitation_result - Callback on Invitation result | |
691 | * @ctx: Callback context from cb_ctx | |
692 | * @status: Negotiation result (Status Code) | |
693 | * @bssid: P2P Group BSSID or %NULL if not received | |
694 | * | |
695 | * This callback is used to indicate result of an Invitation procedure | |
696 | * started with a call to p2p_invite(). The indicated status code is | |
697 | * the value received from the peer in Invitation Response with 0 | |
698 | * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a | |
699 | * local failure in transmitting the Invitation Request. | |
700 | */ | |
701 | void (*invitation_result)(void *ctx, int status, const u8 *bssid); | |
702 | }; | |
703 | ||
704 | ||
705 | /* P2P module initialization/deinitialization */ | |
706 | ||
707 | /** | |
708 | * p2p_init - Initialize P2P module | |
709 | * @cfg: P2P module configuration | |
710 | * Returns: Pointer to private data or %NULL on failure | |
711 | * | |
712 | * This function is used to initialize global P2P module context (one per | |
713 | * device). The P2P module will keep a copy of the configuration data, so the | |
714 | * caller does not need to maintain this structure. However, the callback | |
715 | * functions and the context parameters to them must be kept available until | |
716 | * the P2P module is deinitialized with p2p_deinit(). | |
717 | */ | |
718 | struct p2p_data * p2p_init(const struct p2p_config *cfg); | |
719 | ||
720 | /** | |
721 | * p2p_deinit - Deinitialize P2P module | |
722 | * @p2p: P2P module context from p2p_init() | |
723 | */ | |
724 | void p2p_deinit(struct p2p_data *p2p); | |
725 | ||
726 | /** | |
727 | * p2p_flush - Flush P2P module state | |
728 | * @p2p: P2P module context from p2p_init() | |
729 | * | |
730 | * This command removes the P2P module state like peer device entries. | |
731 | */ | |
732 | void p2p_flush(struct p2p_data *p2p); | |
733 | ||
9d562b79 SS |
734 | /** |
735 | * p2p_unauthorize - Unauthorize the specified peer device | |
736 | * @p2p: P2P module context from p2p_init() | |
737 | * @addr: P2P peer entry to be unauthorized | |
738 | * Returns: 0 on success, -1 on failure | |
739 | * | |
740 | * This command removes any connection authorization from the specified P2P | |
741 | * peer device address. This can be used, e.g., to cancel effect of a previous | |
742 | * p2p_authorize() or p2p_connect() call that has not yet resulted in completed | |
743 | * GO Negotiation. | |
744 | */ | |
745 | int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr); | |
746 | ||
b22128ef JM |
747 | /** |
748 | * p2p_set_dev_name - Set device name | |
749 | * @p2p: P2P module context from p2p_init() | |
750 | * Returns: 0 on success, -1 on failure | |
751 | * | |
752 | * This function can be used to update the P2P module configuration with | |
753 | * information that was not available at the time of the p2p_init() call. | |
754 | */ | |
755 | int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name); | |
756 | ||
b6e01800 JM |
757 | int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer); |
758 | int p2p_set_model_name(struct p2p_data *p2p, const char *model_name); | |
759 | int p2p_set_model_number(struct p2p_data *p2p, const char *model_number); | |
760 | int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number); | |
761 | ||
762 | void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods); | |
763 | void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid); | |
764 | ||
b22128ef JM |
765 | /** |
766 | * p2p_set_pri_dev_type - Set primary device type | |
767 | * @p2p: P2P module context from p2p_init() | |
768 | * Returns: 0 on success, -1 on failure | |
769 | * | |
770 | * This function can be used to update the P2P module configuration with | |
771 | * information that was not available at the time of the p2p_init() call. | |
772 | */ | |
773 | int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type); | |
774 | ||
775 | /** | |
776 | * p2p_set_sec_dev_types - Set secondary device types | |
777 | * @p2p: P2P module context from p2p_init() | |
778 | * Returns: 0 on success, -1 on failure | |
779 | * | |
780 | * This function can be used to update the P2P module configuration with | |
781 | * information that was not available at the time of the p2p_init() call. | |
782 | */ | |
783 | int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8], | |
784 | size_t num_dev_types); | |
785 | ||
786 | int p2p_set_country(struct p2p_data *p2p, const char *country); | |
787 | ||
788 | ||
789 | /* Commands from upper layer management entity */ | |
790 | ||
791 | enum p2p_discovery_type { | |
792 | P2P_FIND_START_WITH_FULL, | |
793 | P2P_FIND_ONLY_SOCIAL, | |
794 | P2P_FIND_PROGRESSIVE | |
795 | }; | |
796 | ||
797 | /** | |
798 | * p2p_find - Start P2P Find (Device Discovery) | |
799 | * @p2p: P2P module context from p2p_init() | |
800 | * @timeout: Timeout for find operation in seconds or 0 for no timeout | |
801 | * @type: Device Discovery type | |
046ef4aa JMB |
802 | * @num_req_dev_types: Number of requested device types |
803 | * @req_dev_types: Requested device types array, must be an array | |
804 | * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no | |
805 | * requested device types. | |
b22128ef JM |
806 | * Returns: 0 on success, -1 on failure |
807 | */ | |
808 | int p2p_find(struct p2p_data *p2p, unsigned int timeout, | |
046ef4aa JMB |
809 | enum p2p_discovery_type type, |
810 | unsigned int num_req_dev_types, const u8 *req_dev_types); | |
b22128ef JM |
811 | |
812 | /** | |
813 | * p2p_stop_find - Stop P2P Find (Device Discovery) | |
814 | * @p2p: P2P module context from p2p_init() | |
815 | */ | |
816 | void p2p_stop_find(struct p2p_data *p2p); | |
817 | ||
0b8889d8 JM |
818 | /** |
819 | * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq | |
820 | * @p2p: P2P module context from p2p_init() | |
821 | * @freq: Frequency in MHz for next operation | |
822 | * | |
823 | * This is like p2p_stop_find(), but Listen state is not stopped if we are | |
824 | * already on the same frequency. | |
825 | */ | |
826 | void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq); | |
827 | ||
b22128ef JM |
828 | /** |
829 | * p2p_listen - Start P2P Listen state for specified duration | |
830 | * @p2p: P2P module context from p2p_init() | |
831 | * @timeout: Listen state duration in milliseconds | |
832 | * Returns: 0 on success, -1 on failure | |
833 | * | |
834 | * This function can be used to request the P2P module to keep the device | |
835 | * discoverable on the listen channel for an extended set of time. At least in | |
836 | * its current form, this is mainly used for testing purposes and may not be of | |
837 | * much use for normal P2P operations. | |
838 | */ | |
839 | int p2p_listen(struct p2p_data *p2p, unsigned int timeout); | |
840 | ||
841 | /** | |
842 | * p2p_connect - Start P2P group formation (GO negotiation) | |
843 | * @p2p: P2P module context from p2p_init() | |
844 | * @peer_addr: MAC address of the peer P2P client | |
845 | * @wps_method: WPS method to be used in provisioning | |
846 | * @go_intent: Local GO intent value (1..15) | |
847 | * @own_interface_addr: Intended interface address to use with the group | |
848 | * @force_freq: The only allowed channel frequency in MHz or 0 | |
849 | * @persistent_group: Whether to create a persistent group | |
850 | * Returns: 0 on success, -1 on failure | |
851 | */ | |
852 | int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr, | |
853 | enum p2p_wps_method wps_method, | |
854 | int go_intent, const u8 *own_interface_addr, | |
855 | unsigned int force_freq, int persistent_group); | |
856 | ||
857 | /** | |
858 | * p2p_authorize - Authorize P2P group formation (GO negotiation) | |
859 | * @p2p: P2P module context from p2p_init() | |
860 | * @peer_addr: MAC address of the peer P2P client | |
861 | * @wps_method: WPS method to be used in provisioning | |
862 | * @go_intent: Local GO intent value (1..15) | |
863 | * @own_interface_addr: Intended interface address to use with the group | |
864 | * @force_freq: The only allowed channel frequency in MHz or 0 | |
865 | * @persistent_group: Whether to create a persistent group | |
866 | * Returns: 0 on success, -1 on failure | |
867 | * | |
868 | * This is like p2p_connect(), but the actual group negotiation is not | |
869 | * initiated automatically, i.e., the other end is expected to do that. | |
870 | */ | |
871 | int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr, | |
872 | enum p2p_wps_method wps_method, | |
873 | int go_intent, const u8 *own_interface_addr, | |
874 | unsigned int force_freq, int persistent_group); | |
875 | ||
876 | /** | |
877 | * p2p_reject - Reject peer device (explicitly block connection attempts) | |
878 | * @p2p: P2P module context from p2p_init() | |
879 | * @peer_addr: MAC address of the peer P2P client | |
880 | * Returns: 0 on success, -1 on failure | |
881 | */ | |
882 | int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr); | |
883 | ||
884 | /** | |
885 | * p2p_prov_disc_req - Send Provision Discovery Request | |
886 | * @p2p: P2P module context from p2p_init() | |
887 | * @peer_addr: MAC address of the peer P2P client | |
888 | * @config_methods: WPS Config Methods value (only one bit set) | |
889 | * @join: Whether this is used by a client joining an active group | |
890 | * Returns: 0 on success, -1 on failure | |
891 | * | |
892 | * This function can be used to request a discovered P2P peer to display a PIN | |
893 | * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us | |
894 | * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame | |
895 | * is transmitted once immediately and if no response is received, the frame | |
896 | * will be sent again whenever the target device is discovered during device | |
897 | * dsicovery (start with a p2p_find() call). Response from the peer is | |
898 | * indicated with the p2p_config::prov_disc_resp() callback. | |
899 | */ | |
900 | int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr, | |
901 | u16 config_methods, int join); | |
902 | ||
903 | /** | |
904 | * p2p_sd_request - Schedule a service discovery query | |
905 | * @p2p: P2P module context from p2p_init() | |
906 | * @dst: Destination peer or %NULL to apply for all peers | |
907 | * @tlvs: P2P Service Query TLV(s) | |
908 | * Returns: Reference to the query or %NULL on failure | |
909 | * | |
910 | * Response to the query is indicated with the p2p_config::sd_response() | |
911 | * callback. | |
912 | */ | |
913 | void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst, | |
914 | const struct wpabuf *tlvs); | |
915 | ||
916 | /** | |
917 | * p2p_sd_cancel_request - Cancel a pending service discovery query | |
918 | * @p2p: P2P module context from p2p_init() | |
919 | * @req: Query reference from p2p_sd_request() | |
920 | * Returns: 0 if request for cancelled; -1 if not found | |
921 | */ | |
922 | int p2p_sd_cancel_request(struct p2p_data *p2p, void *req); | |
923 | ||
924 | /** | |
925 | * p2p_sd_response - Send response to a service discovery query | |
926 | * @p2p: P2P module context from p2p_init() | |
927 | * @freq: Frequency from p2p_config::sd_request() callback | |
928 | * @dst: Destination address from p2p_config::sd_request() callback | |
929 | * @dialog_token: Dialog token from p2p_config::sd_request() callback | |
930 | * @resp_tlvs: P2P Service Response TLV(s) | |
931 | * | |
932 | * This function is called as a response to the request indicated with | |
933 | * p2p_config::sd_request() callback. | |
934 | */ | |
935 | void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst, | |
936 | u8 dialog_token, const struct wpabuf *resp_tlvs); | |
937 | ||
938 | /** | |
939 | * p2p_sd_service_update - Indicate a change in local services | |
940 | * @p2p: P2P module context from p2p_init() | |
941 | * | |
942 | * This function needs to be called whenever there is a change in availability | |
943 | * of the local services. This will increment the Service Update Indicator | |
944 | * value which will be used in SD Request and Response frames. | |
945 | */ | |
946 | void p2p_sd_service_update(struct p2p_data *p2p); | |
947 | ||
948 | ||
949 | enum p2p_invite_role { | |
950 | P2P_INVITE_ROLE_GO, | |
951 | P2P_INVITE_ROLE_ACTIVE_GO, | |
952 | P2P_INVITE_ROLE_CLIENT | |
953 | }; | |
954 | ||
955 | /** | |
956 | * p2p_invite - Invite a P2P Device into a group | |
957 | * @p2p: P2P module context from p2p_init() | |
958 | * @peer: Device Address of the peer P2P Device | |
959 | * @role: Local role in the group | |
960 | * @bssid: Group BSSID or %NULL if not known | |
961 | * @ssid: Group SSID | |
962 | * @ssid_len: Length of ssid in octets | |
963 | * @force_freq: The only allowed channel frequency in MHz or 0 | |
964 | * @go_dev_addr: Forced GO Device Address or %NULL if none | |
965 | * @persistent_group: Whether this is to reinvoke a persistent group | |
966 | * Returns: 0 on success, -1 on failure | |
967 | */ | |
968 | int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role, | |
969 | const u8 *bssid, const u8 *ssid, size_t ssid_len, | |
970 | unsigned int force_freq, const u8 *go_dev_addr, | |
971 | int persistent_group); | |
972 | ||
973 | /** | |
974 | * p2p_presence_req - Request GO presence | |
975 | * @p2p: P2P module context from p2p_init() | |
976 | * @go_interface_addr: GO P2P Interface Address | |
977 | * @own_interface_addr: Own P2P Interface Address for this group | |
978 | * @freq: Group operating frequence (in MHz) | |
979 | * @duration1: Preferred presence duration in microseconds | |
980 | * @interval1: Preferred presence interval in microseconds | |
981 | * @duration2: Acceptable presence duration in microseconds | |
982 | * @interval2: Acceptable presence interval in microseconds | |
983 | * Returns: 0 on success, -1 on failure | |
984 | * | |
985 | * If both duration and interval values are zero, the parameter pair is not | |
986 | * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0). | |
987 | */ | |
988 | int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr, | |
989 | const u8 *own_interface_addr, unsigned int freq, | |
990 | u32 duration1, u32 interval1, u32 duration2, | |
991 | u32 interval2); | |
992 | ||
993 | /** | |
994 | * p2p_ext_listen - Set Extended Listen Timing | |
995 | * @p2p: P2P module context from p2p_init() | |
996 | * @freq: Group operating frequence (in MHz) | |
997 | * @period: Availability period in milliseconds (1-65535; 0 to disable) | |
998 | * @interval: Availability interval in milliseconds (1-65535; 0 to disable) | |
999 | * Returns: 0 on success, -1 on failure | |
1000 | * | |
1001 | * This function can be used to enable or disable (period = interval = 0) | |
1002 | * Extended Listen Timing. When enabled, the P2P Device will become | |
1003 | * discoverable (go into Listen State) every @interval milliseconds for at | |
1004 | * least @period milliseconds. | |
1005 | */ | |
1006 | int p2p_ext_listen(struct p2p_data *p2p, unsigned int period, | |
1007 | unsigned int interval); | |
1008 | ||
1009 | /* Event notifications from upper layer management operations */ | |
1010 | ||
1011 | /** | |
1012 | * p2p_wps_success_cb - Report successfully completed WPS provisioning | |
1013 | * @p2p: P2P module context from p2p_init() | |
1014 | * @mac_addr: Peer address | |
1015 | * | |
1016 | * This function is used to report successfully completed WPS provisioning | |
1017 | * during group formation in both GO/Registrar and client/Enrollee roles. | |
1018 | */ | |
1019 | void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr); | |
1020 | ||
1021 | /** | |
1022 | * p2p_group_formation_failed - Report failed WPS provisioning | |
1023 | * @p2p: P2P module context from p2p_init() | |
1024 | * | |
1025 | * This function is used to report failed group formation. This can happen | |
1026 | * either due to failed WPS provisioning or due to 15 second timeout during | |
1027 | * the provisioning phase. | |
1028 | */ | |
1029 | void p2p_group_formation_failed(struct p2p_data *p2p); | |
1030 | ||
1031 | ||
1032 | /* Event notifications from lower layer driver operations */ | |
1033 | ||
1034 | /** | |
1035 | * p2p_probe_req_rx - Report reception of a Probe Request frame | |
1036 | * @p2p: P2P module context from p2p_init() | |
1037 | * @addr: Source MAC address | |
04a85e44 JM |
1038 | * @dst: Destination MAC address if available or %NULL |
1039 | * @bssid: BSSID if available or %NULL | |
b22128ef JM |
1040 | * @ie: Information elements from the Probe Request frame body |
1041 | * @ie_len: Length of ie buffer in octets | |
1042 | * Returns: 0 to indicate the frame was not processed or 1 if it was | |
1043 | */ | |
04a85e44 JM |
1044 | int p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst, |
1045 | const u8 *bssid, const u8 *ie, size_t ie_len); | |
b22128ef JM |
1046 | |
1047 | /** | |
1048 | * p2p_rx_action - Report received Action frame | |
1049 | * @p2p: P2P module context from p2p_init() | |
1050 | * @da: Destination address of the received Action frame | |
1051 | * @sa: Source address of the received Action frame | |
1052 | * @bssid: Address 3 of the received Action frame | |
1053 | * @category: Category of the received Action frame | |
1054 | * @data: Action frame body after the Category field | |
1055 | * @len: Length of the data buffer in octets | |
1056 | * @freq: Frequency (in MHz) on which the frame was received | |
1057 | */ | |
1058 | void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa, | |
1059 | const u8 *bssid, u8 category, | |
1060 | const u8 *data, size_t len, int freq); | |
1061 | ||
1062 | /** | |
1063 | * p2p_scan_res_handler - Indicate a P2P scan results | |
1064 | * @p2p: P2P module context from p2p_init() | |
1065 | * @bssid: BSSID of the scan result | |
1066 | * @freq: Frequency of the channel on which the device was found in MHz | |
1067 | * @level: Signal level (signal strength of the received Beacon/Probe Response | |
1068 | * frame) | |
1069 | * @ies: Pointer to IEs from the scan result | |
1070 | * @ies_len: Length of the ies buffer | |
1071 | * Returns: 0 to continue or 1 to stop scan result indication | |
1072 | * | |
1073 | * This function is called to indicate a scan result entry with P2P IE from a | |
1074 | * scan requested with struct p2p_config::p2p_scan(). This can be called during | |
1075 | * the actual scan process (i.e., whenever a new device is found) or as a | |
1076 | * sequence of calls after the full scan has been completed. The former option | |
1077 | * can result in optimized operations, but may not be supported by all | |
1078 | * driver/firmware designs. The ies buffer need to include at least the P2P IE, | |
1079 | * but it is recommended to include all IEs received from the device. The | |
1080 | * caller does not need to check that the IEs contain a P2P IE before calling | |
1081 | * this function since frames will be filtered internally if needed. | |
1082 | * | |
1083 | * This function will return 1 if it wants to stop scan result iteration (and | |
1084 | * scan in general if it is still in progress). This is used to allow faster | |
1085 | * start of a pending operation, e.g., to start a pending GO negotiation. | |
1086 | */ | |
1087 | int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq, | |
1088 | int level, const u8 *ies, size_t ies_len); | |
1089 | ||
1090 | /** | |
1091 | * p2p_scan_res_handled - Indicate end of scan results | |
1092 | * @p2p: P2P module context from p2p_init() | |
1093 | * | |
1094 | * This function is called to indicate that all P2P scan results from a scan | |
1095 | * have been reported with zero or more calls to p2p_scan_res_handler(). This | |
1096 | * function must be called as a response to successful | |
1097 | * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler() | |
1098 | * calls stopped iteration. | |
1099 | */ | |
1100 | void p2p_scan_res_handled(struct p2p_data *p2p); | |
1101 | ||
93b7ddd0 JM |
1102 | enum p2p_send_action_result { |
1103 | P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */, | |
1104 | P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */, | |
1105 | P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */ | |
1106 | }; | |
1107 | ||
b22128ef JM |
1108 | /** |
1109 | * p2p_send_action_cb - Notify TX status of an Action frame | |
1110 | * @p2p: P2P module context from p2p_init() | |
1111 | * @freq: Channel frequency in MHz | |
1112 | * @dst: Destination MAC address (Address 1) | |
1113 | * @src: Source MAC address (Address 2) | |
1114 | * @bssid: BSSID (Address 3) | |
93b7ddd0 | 1115 | * @result: Result of the transmission attempt |
b22128ef JM |
1116 | * |
1117 | * This function is used to indicate the result of an Action frame transmission | |
1118 | * that was requested with struct p2p_config::send_action() callback. | |
1119 | */ | |
1120 | void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst, | |
93b7ddd0 JM |
1121 | const u8 *src, const u8 *bssid, |
1122 | enum p2p_send_action_result result); | |
b22128ef JM |
1123 | |
1124 | /** | |
1125 | * p2p_listen_cb - Indicate the start of a requested Listen state | |
1126 | * @p2p: P2P module context from p2p_init() | |
1127 | * @freq: Listen channel frequency in MHz | |
1128 | * @duration: Duration for the Listen state in milliseconds | |
1129 | * | |
1130 | * This function is used to indicate that a Listen state requested with | |
1131 | * struct p2p_config::start_listen() callback has started. | |
1132 | */ | |
1133 | void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq, | |
1134 | unsigned int duration); | |
1135 | ||
1136 | /** | |
1137 | * p2p_listen_end - Indicate the end of a requested Listen state | |
1138 | * @p2p: P2P module context from p2p_init() | |
1139 | * @freq: Listen channel frequency in MHz | |
1140 | * Returns: 0 if no operations were started, 1 if an operation was started | |
1141 | * | |
1142 | * This function is used to indicate that a Listen state requested with | |
1143 | * struct p2p_config::start_listen() callback has ended. | |
1144 | */ | |
1145 | int p2p_listen_end(struct p2p_data *p2p, unsigned int freq); | |
1146 | ||
1147 | void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code, | |
1148 | const u8 *ie, size_t ie_len); | |
1149 | ||
1150 | void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code, | |
1151 | const u8 *ie, size_t ie_len); | |
1152 | ||
1153 | ||
1154 | /* Per-group P2P state for GO */ | |
1155 | ||
1156 | struct p2p_group; | |
1157 | ||
1158 | /** | |
1159 | * struct p2p_group_config - P2P group configuration | |
1160 | * | |
1161 | * This configuration is provided to the P2P module during initialization of | |
1162 | * the per-group information with p2p_group_init(). | |
1163 | */ | |
1164 | struct p2p_group_config { | |
1165 | /** | |
1166 | * persistent_group - Whether the group is persistent | |
1167 | */ | |
1168 | int persistent_group; | |
1169 | ||
1170 | /** | |
1171 | * interface_addr - P2P Interface Address of the group | |
1172 | */ | |
1173 | u8 interface_addr[ETH_ALEN]; | |
1174 | ||
3f4ce13f JM |
1175 | /** |
1176 | * max_clients - Maximum number of clients in the group | |
1177 | */ | |
1178 | unsigned int max_clients; | |
1179 | ||
b22128ef JM |
1180 | /** |
1181 | * cb_ctx - Context to use with callback functions | |
1182 | */ | |
1183 | void *cb_ctx; | |
1184 | ||
1185 | /** | |
1186 | * ie_update - Notification of IE update | |
1187 | * @ctx: Callback context from cb_ctx | |
1188 | * @beacon_ies: P2P IE for Beacon frames or %NULL if no change | |
1189 | * @proberesp_ies: P2P Ie for Probe Response frames | |
1190 | * | |
1191 | * P2P module uses this callback function to notify whenever the P2P IE | |
1192 | * in Beacon or Probe Response frames should be updated based on group | |
1193 | * events. | |
1194 | * | |
1195 | * The callee is responsible for freeing the returned buffer(s) with | |
1196 | * wpabuf_free(). | |
1197 | */ | |
1198 | void (*ie_update)(void *ctx, struct wpabuf *beacon_ies, | |
1199 | struct wpabuf *proberesp_ies); | |
3071e181 JM |
1200 | |
1201 | /** | |
1202 | * idle_update - Notification of changes in group idle state | |
1203 | * @ctx: Callback context from cb_ctx | |
1204 | * @idle: Whether the group is idle (no associated stations) | |
1205 | */ | |
1206 | void (*idle_update)(void *ctx, int idle); | |
b22128ef JM |
1207 | }; |
1208 | ||
1209 | /** | |
1210 | * p2p_group_init - Initialize P2P group | |
1211 | * @p2p: P2P module context from p2p_init() | |
1212 | * @config: P2P group configuration (will be freed by p2p_group_deinit()) | |
1213 | * Returns: Pointer to private data or %NULL on failure | |
1214 | * | |
1215 | * This function is used to initialize per-group P2P module context. Currently, | |
1216 | * this is only used to manage GO functionality and P2P clients do not need to | |
1217 | * create an instance of this per-group information. | |
1218 | */ | |
1219 | struct p2p_group * p2p_group_init(struct p2p_data *p2p, | |
1220 | struct p2p_group_config *config); | |
1221 | ||
1222 | /** | |
1223 | * p2p_group_deinit - Deinitialize P2P group | |
1224 | * @group: P2P group context from p2p_group_init() | |
1225 | */ | |
1226 | void p2p_group_deinit(struct p2p_group *group); | |
1227 | ||
1228 | /** | |
1229 | * p2p_group_notif_assoc - Notification of P2P client association with GO | |
1230 | * @group: P2P group context from p2p_group_init() | |
1231 | * @addr: Interface address of the P2P client | |
1232 | * @ie: IEs from the (Re)association Request frame | |
1233 | * @len: Length of the ie buffer in octets | |
1234 | * Returns: 0 on success, -1 on failure | |
1235 | */ | |
1236 | int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr, | |
1237 | const u8 *ie, size_t len); | |
1238 | ||
1239 | /** | |
1240 | * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response | |
1241 | * @group: P2P group context from p2p_group_init() | |
1242 | * @status: Status value (P2P_SC_SUCCESS if association succeeded) | |
1243 | * Returns: P2P IE for (Re)association Response or %NULL on failure | |
1244 | * | |
1245 | * The caller is responsible for freeing the returned buffer with | |
1246 | * wpabuf_free(). | |
1247 | */ | |
1248 | struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status); | |
1249 | ||
1250 | /** | |
1251 | * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO | |
1252 | * @group: P2P group context from p2p_group_init() | |
1253 | * @addr: Interface address of the P2P client | |
1254 | */ | |
1255 | void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr); | |
1256 | ||
1257 | /** | |
1258 | * p2p_group_notif_formation_done - Notification of completed group formation | |
1259 | * @group: P2P group context from p2p_group_init() | |
1260 | */ | |
1261 | void p2p_group_notif_formation_done(struct p2p_group *group); | |
1262 | ||
1263 | /** | |
1264 | * p2p_group_notif_noa - Notification of NoA change | |
1265 | * @group: P2P group context from p2p_group_init() | |
1266 | * @noa: Notice of Absence attribute payload, %NULL if none | |
1267 | * @noa_len: Length of noa buffer in octets | |
1268 | * Returns: 0 on success, -1 on failure | |
1269 | * | |
1270 | * Notify the P2P group management about a new NoA contents. This will be | |
1271 | * inserted into the P2P IEs in Beacon and Probe Response frames with rest of | |
1272 | * the group information. | |
1273 | */ | |
1274 | int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa, | |
1275 | size_t noa_len); | |
1276 | ||
1277 | /** | |
1278 | * p2p_group_match_dev_type - Match device types in group with requested type | |
1279 | * @group: P2P group context from p2p_group_init() | |
1280 | * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs) | |
1281 | * Returns: 1 on match, 0 on mismatch | |
1282 | * | |
1283 | * This function can be used to match the Requested Device Type attribute in | |
1284 | * WPS IE with the device types of a group member for deciding whether a GO | |
1285 | * should reply to a Probe Request frame. Match will be reported if the WPS IE | |
1286 | * is not requested any specific device type. | |
1287 | */ | |
1288 | int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps); | |
1289 | ||
1290 | /** | |
1291 | * p2p_group_go_discover - Send GO Discoverability Request to a group client | |
1292 | * @group: P2P group context from p2p_group_init() | |
1293 | * Returns: 0 on success (frame scheduled); -1 if client was not found | |
1294 | */ | |
1295 | int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id, | |
1296 | const u8 *searching_dev, int rx_freq); | |
1297 | ||
1298 | ||
1299 | /* Generic helper functions */ | |
1300 | ||
1301 | /** | |
1302 | * p2p_ie_text - Build text format description of P2P IE | |
1303 | * @p2p_ie: P2P IE | |
1304 | * @buf: Buffer for returning text | |
1305 | * @end: Pointer to the end of the buf area | |
1306 | * Returns: Number of octets written to the buffer or -1 on failure | |
1307 | * | |
1308 | * This function can be used to parse P2P IE contents into text format | |
1309 | * field=value lines. | |
1310 | */ | |
1311 | int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end); | |
1312 | ||
1313 | /** | |
1314 | * p2p_scan_result_text - Build text format description of P2P IE | |
1315 | * @ies: Information elements from scan results | |
1316 | * @ies_len: ies buffer length in octets | |
1317 | * @buf: Buffer for returning text | |
1318 | * @end: Pointer to the end of the buf area | |
1319 | * Returns: Number of octets written to the buffer or -1 on failure | |
1320 | * | |
1321 | * This function can be used to parse P2P IE contents into text format | |
1322 | * field=value lines. | |
1323 | */ | |
1324 | int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end); | |
1325 | ||
1326 | /** | |
1327 | * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame | |
1328 | * @p2p: P2P module context from p2p_init() | |
1329 | * @bssid: BSSID | |
1330 | * @buf: Buffer for writing the P2P IE | |
1331 | * @len: Maximum buf length in octets | |
1332 | * @p2p_group: Whether this is for association with a P2P GO | |
4c08c0bd | 1333 | * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none |
b22128ef JM |
1334 | * Returns: Number of octets written into buf or -1 on failure |
1335 | */ | |
1336 | int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf, | |
4c08c0bd | 1337 | size_t len, int p2p_group, struct wpabuf *p2p_ie); |
b22128ef JM |
1338 | |
1339 | /** | |
1340 | * p2p_scan_ie - Build P2P IE for Probe Request | |
1341 | * @p2p: P2P module context from p2p_init() | |
1342 | * @ies: Buffer for writing P2P IE | |
1343 | */ | |
1344 | void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies); | |
1345 | ||
1346 | /** | |
1347 | * p2p_go_params - Generate random P2P group parameters | |
1348 | * @p2p: P2P module context from p2p_init() | |
1349 | * @params: Buffer for parameters | |
1350 | * Returns: 0 on success, -1 on failure | |
1351 | */ | |
1352 | int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params); | |
1353 | ||
1354 | /** | |
1355 | * p2p_get_group_capab - Get Group Capability from P2P IE data | |
1356 | * @p2p_ie: P2P IE(s) contents | |
1357 | * Returns: Group Capability | |
1358 | */ | |
1359 | u8 p2p_get_group_capab(const struct wpabuf *p2p_ie); | |
1360 | ||
72044390 JM |
1361 | /** |
1362 | * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection | |
1363 | * @p2p_ie: P2P IE(s) contents | |
1364 | * Returns: 0 if cross connection is allow, 1 if not | |
1365 | */ | |
1366 | int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie); | |
1367 | ||
b22128ef JM |
1368 | /** |
1369 | * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data | |
1370 | * @p2p_ie: P2P IE(s) contents | |
1371 | * Returns: Pointer to P2P Device Address or %NULL if not included | |
1372 | */ | |
1373 | const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie); | |
1374 | ||
1375 | /** | |
1376 | * p2p_get_peer_info - Get P2P peer information in text format | |
1377 | * @p2p: P2P module context from p2p_init() | |
1378 | * @addr: P2P Device Address of the peer or %NULL to indicate the first peer | |
1379 | * @next: Whether to select the peer entry following the one indicated by addr | |
1380 | * @buf: Buffer for returning text | |
1381 | * @buflen: Maximum buffer length | |
1382 | * Returns: Number of octets written to the buffer or -1 on failure | |
1383 | */ | |
1384 | int p2p_get_peer_info(struct p2p_data *p2p, const u8 *addr, int next, | |
1385 | char *buf, size_t buflen); | |
1386 | ||
1387 | /** | |
1388 | * p2p_set_client_discoverability - Set client discoverability capability | |
1389 | * @p2p: P2P module context from p2p_init() | |
1390 | * @enabled: Whether client discoverability will be enabled | |
1391 | * | |
1392 | * This function can be used to disable (and re-enable) client discoverability. | |
1393 | * This capability is enabled by default and should not be disabled in normal | |
1394 | * use cases, i.e., this is mainly for testing purposes. | |
1395 | */ | |
1396 | void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled); | |
1397 | ||
1398 | /** | |
1399 | * p2p_set_manageD_oper - Set managed P2P Device operations capability | |
1400 | * @p2p: P2P module context from p2p_init() | |
1401 | * @enabled: Whether managed P2P Device operations will be enabled | |
1402 | */ | |
1403 | void p2p_set_managed_oper(struct p2p_data *p2p, int enabled); | |
1404 | ||
1405 | int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel); | |
1406 | ||
1407 | int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len); | |
1408 | ||
1409 | int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr, | |
1410 | u8 *iface_addr); | |
4147a2cc JM |
1411 | int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr, |
1412 | u8 *dev_addr); | |
b22128ef | 1413 | |
80c9582a JM |
1414 | void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr); |
1415 | ||
72044390 JM |
1416 | /** |
1417 | * p2p_set_cross_connect - Set cross connection capability | |
1418 | * @p2p: P2P module context from p2p_init() | |
1419 | * @enabled: Whether cross connection will be enabled | |
1420 | */ | |
1421 | void p2p_set_cross_connect(struct p2p_data *p2p, int enabled); | |
1422 | ||
f8d0131a JM |
1423 | int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr); |
1424 | ||
17bef1e9 AC |
1425 | int p2p_add_device(struct p2p_data *p2p, const u8 *addr, int freq, int level, |
1426 | const u8 *ies, size_t ies_len); | |
1427 | ||
0f66abd2 SS |
1428 | /** |
1429 | * p2p_set_intra_bss_dist - Set intra BSS distribution | |
1430 | * @p2p: P2P module context from p2p_init() | |
1431 | * @enabled: Whether intra BSS distribution will be enabled | |
1432 | */ | |
1433 | void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled); | |
1434 | ||
d054a462 JM |
1435 | /** |
1436 | * p2p_supported_freq - Check whether channel is supported for P2P | |
1437 | * @p2p: P2P module context from p2p_init() | |
1438 | * @freq: Channel frequency in MHz | |
1439 | * Returns: 0 if channel not usable for P2P, 1 if usable for P2P | |
1440 | */ | |
1441 | int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq); | |
1442 | ||
b5c9da8d JM |
1443 | void p2p_update_channel_list(struct p2p_data *p2p, struct p2p_channels *chan); |
1444 | ||
7cfc4ac3 AGS |
1445 | /** |
1446 | * p2p_set_best_channels - Update best channel information | |
1447 | * @p2p: P2P module context from p2p_init() | |
1448 | * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band | |
1449 | * @freq_5: Frequency (MHz) of best channel in 5 GHz band | |
1450 | * @freq_overall: Frequency (MHz) of best channel overall | |
1451 | */ | |
1452 | void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5, | |
1453 | int freq_overall); | |
1454 | ||
231bbd03 SS |
1455 | const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p); |
1456 | ||
5efa9e2a JB |
1457 | /** |
1458 | * p2p_get_group_num_members - Get number of members in group | |
1459 | * @group: P2P group context from p2p_group_init() | |
1460 | * Returns: Number of members in the group | |
1461 | */ | |
1462 | unsigned int p2p_get_group_num_members(struct p2p_group *group); | |
1463 | ||
1464 | /** | |
1465 | * p2p_iterate_group_members - Iterate group members | |
1466 | * @group: P2P group context from p2p_group_init() | |
1467 | * @next: iteration pointer, must be a pointer to a void * that is set to %NULL | |
1468 | * on the first call and not modified later | |
1469 | * Returns: A P2P Interface Address for each call and %NULL for no more members | |
1470 | */ | |
1471 | const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next); | |
1472 | ||
c165d81e JB |
1473 | /** |
1474 | * p2p_get_peer_found - Get P2P peer info structure of a found peer | |
1475 | * @p2p: P2P module context from p2p_init() | |
1476 | * @addr: P2P Device Address of the peer or %NULL to indicate the first peer | |
1477 | * @next: Whether to select the peer entry following the one indicated by addr | |
1478 | * Returns: The first P2P peer info available or %NULL if no such peer exists | |
1479 | */ | |
1480 | const struct p2p_peer_info * | |
1481 | p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next); | |
1482 | ||
f95cac27 JMB |
1483 | /** |
1484 | * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions | |
1485 | * @p2p: P2P module context from p2p_init() | |
1486 | */ | |
1487 | void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p); | |
1488 | ||
1489 | /** | |
1490 | * p2p_add_wps_vendor_extension - Add a WPS vendor extension | |
1491 | * @p2p: P2P module context from p2p_init() | |
1492 | * @vendor_ext: The vendor extensions to add | |
1493 | * Returns: 0 on success, -1 on failure | |
1494 | * | |
1495 | * The wpabuf structures in the array are owned by the P2P | |
1496 | * module after this call. | |
1497 | */ | |
1498 | int p2p_add_wps_vendor_extension(struct p2p_data *p2p, | |
1499 | const struct wpabuf *vendor_ext); | |
1500 | ||
2463ba70 JS |
1501 | /** |
1502 | * p2p_set_oper_channel - Set the P2P operating channel | |
1503 | * @p2p: P2P module context from p2p_init() | |
1504 | * @op_reg_class: Operating regulatory class to set | |
1505 | * @op_channel: operating channel to set | |
1506 | * @cfg_op_channel : Whether op_channel is hardcoded in configuration | |
1507 | * Returns: 0 on success, -1 on failure | |
1508 | */ | |
1509 | int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel, | |
1510 | int cfg_op_channel); | |
1511 | ||
b22128ef | 1512 | #endif /* P2P_H */ |