]>
Commit | Line | Data |
---|---|---|
b22128ef JM |
1 | /* |
2 | * Wi-Fi Direct - P2P module | |
3 | * Copyright (c) 2009-2010, Atheros Communications | |
4 | * | |
e22d4d95 JM |
5 | * This software may be distributed under the terms of the BSD license. |
6 | * See README for more details. | |
b22128ef JM |
7 | */ |
8 | ||
9 | #ifndef P2P_H | |
10 | #define P2P_H | |
11 | ||
12 | /** | |
13 | * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes | |
14 | */ | |
15 | #define P2P_MAX_REG_CLASSES 10 | |
16 | ||
17 | /** | |
18 | * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class | |
19 | */ | |
20 | #define P2P_MAX_REG_CLASS_CHANNELS 20 | |
21 | ||
22 | /** | |
23 | * struct p2p_channels - List of supported channels | |
24 | */ | |
25 | struct p2p_channels { | |
26 | /** | |
27 | * struct p2p_reg_class - Supported regulatory class | |
28 | */ | |
29 | struct p2p_reg_class { | |
30 | /** | |
31 | * reg_class - Regulatory class (IEEE 802.11-2007, Annex J) | |
32 | */ | |
33 | u8 reg_class; | |
34 | ||
35 | /** | |
36 | * channel - Supported channels | |
37 | */ | |
38 | u8 channel[P2P_MAX_REG_CLASS_CHANNELS]; | |
39 | ||
40 | /** | |
41 | * channels - Number of channel entries in use | |
42 | */ | |
43 | size_t channels; | |
44 | } reg_class[P2P_MAX_REG_CLASSES]; | |
45 | ||
46 | /** | |
47 | * reg_classes - Number of reg_class entries in use | |
48 | */ | |
49 | size_t reg_classes; | |
50 | }; | |
51 | ||
52 | enum p2p_wps_method { | |
07fecd39 | 53 | WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC |
b22128ef JM |
54 | }; |
55 | ||
56 | /** | |
57 | * struct p2p_go_neg_results - P2P Group Owner Negotiation results | |
58 | */ | |
59 | struct p2p_go_neg_results { | |
60 | /** | |
61 | * status - Negotiation result (Status Code) | |
62 | * | |
63 | * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate | |
64 | * failed negotiation. | |
65 | */ | |
66 | int status; | |
67 | ||
68 | /** | |
69 | * role_go - Whether local end is Group Owner | |
70 | */ | |
71 | int role_go; | |
72 | ||
73 | /** | |
74 | * freq - Frequency of the group operational channel in MHz | |
75 | */ | |
76 | int freq; | |
77 | ||
7aeac985 RM |
78 | int ht40; |
79 | ||
20ea1ca4 EP |
80 | int vht; |
81 | ||
b22128ef JM |
82 | /** |
83 | * ssid - SSID of the group | |
84 | */ | |
85 | u8 ssid[32]; | |
86 | ||
87 | /** | |
88 | * ssid_len - Length of SSID in octets | |
89 | */ | |
90 | size_t ssid_len; | |
91 | ||
30c371e8 MH |
92 | /** |
93 | * psk - WPA pre-shared key (256 bits) (GO only) | |
94 | */ | |
95 | u8 psk[32]; | |
96 | ||
97 | /** | |
98 | * psk_set - Whether PSK field is configured (GO only) | |
99 | */ | |
100 | int psk_set; | |
101 | ||
b22128ef JM |
102 | /** |
103 | * passphrase - WPA2-Personal passphrase for the group (GO only) | |
104 | */ | |
105 | char passphrase[64]; | |
106 | ||
107 | /** | |
108 | * peer_device_addr - P2P Device Address of the peer | |
109 | */ | |
110 | u8 peer_device_addr[ETH_ALEN]; | |
111 | ||
112 | /** | |
113 | * peer_interface_addr - P2P Interface Address of the peer | |
114 | */ | |
115 | u8 peer_interface_addr[ETH_ALEN]; | |
116 | ||
117 | /** | |
118 | * wps_method - WPS method to be used during provisioning | |
119 | */ | |
120 | enum p2p_wps_method wps_method; | |
121 | ||
122 | #define P2P_MAX_CHANNELS 50 | |
123 | ||
124 | /** | |
125 | * freq_list - Zero-terminated list of possible operational channels | |
126 | */ | |
127 | int freq_list[P2P_MAX_CHANNELS]; | |
128 | ||
129 | /** | |
130 | * persistent_group - Whether the group should be made persistent | |
acc247b2 JM |
131 | * 0 = not persistent |
132 | * 1 = persistent group without persistent reconnect | |
133 | * 2 = persistent group with persistent reconnect | |
b22128ef JM |
134 | */ |
135 | int persistent_group; | |
ae3e3421 JM |
136 | |
137 | /** | |
138 | * peer_config_timeout - Peer configuration timeout (in 10 msec units) | |
139 | */ | |
140 | unsigned int peer_config_timeout; | |
b22128ef JM |
141 | }; |
142 | ||
143 | struct p2p_data; | |
144 | ||
145 | enum p2p_scan_type { | |
146 | P2P_SCAN_SOCIAL, | |
147 | P2P_SCAN_FULL, | |
b22128ef JM |
148 | P2P_SCAN_SOCIAL_PLUS_ONE |
149 | }; | |
150 | ||
10c5d2a5 JM |
151 | #define P2P_MAX_WPS_VENDOR_EXT 10 |
152 | ||
c5db8e51 KRK |
153 | /** |
154 | * struct p2p_peer_info - P2P peer information | |
c5db8e51 KRK |
155 | */ |
156 | struct p2p_peer_info { | |
157 | /** | |
158 | * p2p_device_addr - P2P Device Address of the peer | |
159 | */ | |
160 | u8 p2p_device_addr[ETH_ALEN]; | |
161 | ||
162 | /** | |
163 | * pri_dev_type - Primary Device Type | |
164 | */ | |
165 | u8 pri_dev_type[8]; | |
166 | ||
167 | /** | |
b67d0d9e | 168 | * device_name - Device Name (0..32 octets encoded in UTF-8) |
c5db8e51 KRK |
169 | */ |
170 | char device_name[33]; | |
171 | ||
b67d0d9e JM |
172 | /** |
173 | * manufacturer - Manufacturer (0..64 octets encoded in UTF-8) | |
174 | */ | |
175 | char manufacturer[65]; | |
176 | ||
177 | /** | |
178 | * model_name - Model Name (0..32 octets encoded in UTF-8) | |
179 | */ | |
180 | char model_name[33]; | |
181 | ||
182 | /** | |
183 | * model_number - Model Number (0..32 octets encoded in UTF-8) | |
184 | */ | |
185 | char model_number[33]; | |
186 | ||
187 | /** | |
188 | * serial_number - Serial Number (0..32 octets encoded in UTF-8) | |
189 | */ | |
190 | char serial_number[33]; | |
191 | ||
6402fc43 JS |
192 | /** |
193 | * level - Signal level | |
194 | */ | |
195 | int level; | |
196 | ||
c5db8e51 KRK |
197 | /** |
198 | * config_methods - WPS Configuration Methods | |
199 | */ | |
200 | u16 config_methods; | |
201 | ||
202 | /** | |
203 | * dev_capab - Device Capabilities | |
204 | */ | |
205 | u8 dev_capab; | |
206 | ||
207 | /** | |
208 | * group_capab - Group Capabilities | |
209 | */ | |
210 | u8 group_capab; | |
e57ae6e1 JMB |
211 | |
212 | /** | |
213 | * wps_sec_dev_type_list - WPS secondary device type list | |
214 | * | |
215 | * This list includes from 0 to 16 Secondary Device Types as indicated | |
216 | * by wps_sec_dev_type_list_len (8 * number of types). | |
217 | */ | |
218 | u8 wps_sec_dev_type_list[128]; | |
219 | ||
220 | /** | |
221 | * wps_sec_dev_type_list_len - Length of secondary device type list | |
222 | */ | |
223 | size_t wps_sec_dev_type_list_len; | |
224 | ||
10c5d2a5 | 225 | struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT]; |
9675ce35 JM |
226 | |
227 | /** | |
228 | * wfd_subelems - Wi-Fi Display subelements from WFD IE(s) | |
229 | */ | |
230 | struct wpabuf *wfd_subelems; | |
c5db8e51 KRK |
231 | }; |
232 | ||
349b213c JS |
233 | enum p2p_prov_disc_status { |
234 | P2P_PROV_DISC_SUCCESS, | |
235 | P2P_PROV_DISC_TIMEOUT, | |
236 | P2P_PROV_DISC_REJECTED, | |
175171ac | 237 | P2P_PROV_DISC_TIMEOUT_JOIN, |
349b213c JS |
238 | }; |
239 | ||
21d996f7 JM |
240 | struct p2p_channel { |
241 | u8 op_class; | |
242 | u8 chan; | |
243 | }; | |
244 | ||
b22128ef JM |
245 | /** |
246 | * struct p2p_config - P2P configuration | |
247 | * | |
248 | * This configuration is provided to the P2P module during initialization with | |
249 | * p2p_init(). | |
250 | */ | |
251 | struct p2p_config { | |
252 | /** | |
253 | * country - Country code to use in P2P operations | |
254 | */ | |
255 | char country[3]; | |
256 | ||
257 | /** | |
258 | * reg_class - Regulatory class for own listen channel | |
259 | */ | |
260 | u8 reg_class; | |
261 | ||
262 | /** | |
263 | * channel - Own listen channel | |
264 | */ | |
265 | u8 channel; | |
266 | ||
267 | /** | |
268 | * Regulatory class for own operational channel | |
269 | */ | |
270 | u8 op_reg_class; | |
271 | ||
272 | /** | |
273 | * op_channel - Own operational channel | |
274 | */ | |
275 | u8 op_channel; | |
276 | ||
7cfc4ac3 AGS |
277 | /** |
278 | * cfg_op_channel - Whether op_channel is hardcoded in configuration | |
279 | */ | |
280 | u8 cfg_op_channel; | |
281 | ||
b22128ef JM |
282 | /** |
283 | * channels - Own supported regulatory classes and channels | |
284 | * | |
285 | * List of supposerted channels per regulatory class. The regulatory | |
286 | * classes are defined in IEEE Std 802.11-2007 Annex J and the | |
287 | * numbering of the clases depends on the configured country code. | |
288 | */ | |
289 | struct p2p_channels channels; | |
290 | ||
51e9f228 JM |
291 | /** |
292 | * cli_channels - Additional client channels | |
293 | * | |
294 | * This list of channels (if any) will be used when advertising local | |
295 | * channels during GO Negotiation or Invitation for the cases where the | |
296 | * local end may become the client. This may allow the peer to become a | |
297 | * GO on additional channels if it supports these options. The main use | |
298 | * case for this is to include passive-scan channels on devices that may | |
299 | * not know their current location and have configured most channels to | |
300 | * not allow initiation of radition (i.e., another device needs to take | |
301 | * master responsibilities). | |
302 | */ | |
303 | struct p2p_channels cli_channels; | |
304 | ||
21d996f7 JM |
305 | /** |
306 | * num_pref_chan - Number of pref_chan entries | |
307 | */ | |
308 | unsigned int num_pref_chan; | |
309 | ||
310 | /** | |
311 | * pref_chan - Preferred channels for GO Negotiation | |
312 | */ | |
313 | struct p2p_channel *pref_chan; | |
314 | ||
b22128ef JM |
315 | /** |
316 | * pri_dev_type - Primary Device Type (see WPS) | |
317 | */ | |
318 | u8 pri_dev_type[8]; | |
319 | ||
320 | /** | |
321 | * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types | |
322 | */ | |
323 | #define P2P_SEC_DEVICE_TYPES 5 | |
324 | ||
325 | /** | |
326 | * sec_dev_type - Optional secondary device types | |
327 | */ | |
328 | u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8]; | |
329 | ||
b6e01800 JM |
330 | /** |
331 | * num_sec_dev_types - Number of sec_dev_type entries | |
332 | */ | |
333 | size_t num_sec_dev_types; | |
334 | ||
b22128ef JM |
335 | /** |
336 | * dev_addr - P2P Device Address | |
337 | */ | |
338 | u8 dev_addr[ETH_ALEN]; | |
339 | ||
340 | /** | |
341 | * dev_name - Device Name | |
342 | */ | |
343 | char *dev_name; | |
344 | ||
b6e01800 JM |
345 | char *manufacturer; |
346 | char *model_name; | |
347 | char *model_number; | |
348 | char *serial_number; | |
349 | ||
350 | u8 uuid[16]; | |
351 | u16 config_methods; | |
b22128ef JM |
352 | |
353 | /** | |
354 | * concurrent_operations - Whether concurrent operations are supported | |
355 | */ | |
356 | int concurrent_operations; | |
357 | ||
358 | /** | |
359 | * max_peers - Maximum number of discovered peers to remember | |
360 | * | |
361 | * If more peers are discovered, older entries will be removed to make | |
362 | * room for the new ones. | |
363 | */ | |
364 | size_t max_peers; | |
365 | ||
0f66abd2 SS |
366 | /** |
367 | * p2p_intra_bss - Intra BSS communication is supported | |
368 | */ | |
369 | int p2p_intra_bss; | |
370 | ||
b22128ef JM |
371 | /** |
372 | * ssid_postfix - Postfix data to add to the SSID | |
373 | * | |
374 | * This data will be added to the end of the SSID after the | |
375 | * DIRECT-<random two octets> prefix. | |
376 | */ | |
377 | u8 ssid_postfix[32 - 9]; | |
378 | ||
379 | /** | |
380 | * ssid_postfix_len - Length of the ssid_postfix data | |
381 | */ | |
382 | size_t ssid_postfix_len; | |
383 | ||
96beff11 JM |
384 | /** |
385 | * max_listen - Maximum listen duration in ms | |
386 | */ | |
387 | unsigned int max_listen; | |
388 | ||
b22128ef | 389 | /** |
ed496f13 | 390 | * cb_ctx - Context to use with callback functions |
b22128ef | 391 | */ |
ed496f13 | 392 | void *cb_ctx; |
b22128ef JM |
393 | |
394 | /** | |
ed496f13 JM |
395 | * debug_print - Debug print |
396 | * @ctx: Callback context from cb_ctx | |
397 | * @level: Debug verbosity level (MSG_*) | |
398 | * @msg: Debug message | |
b22128ef | 399 | */ |
ed496f13 | 400 | void (*debug_print)(void *ctx, int level, const char *msg); |
b22128ef JM |
401 | |
402 | ||
403 | /* Callbacks to request lower layer driver operations */ | |
404 | ||
405 | /** | |
406 | * p2p_scan - Request a P2P scan/search | |
407 | * @ctx: Callback context from cb_ctx | |
408 | * @type: Scan type | |
409 | * @freq: Specific frequency (MHz) to scan or 0 for no restriction | |
046ef4aa JMB |
410 | * @num_req_dev_types: Number of requested device types |
411 | * @req_dev_types: Array containing requested device types | |
6d92fa6e | 412 | * @dev_id: Device ID to search for or %NULL to find all devices |
360182ed | 413 | * @pw_id: Device Password ID |
b22128ef JM |
414 | * Returns: 0 on success, -1 on failure |
415 | * | |
416 | * This callback function is used to request a P2P scan or search | |
417 | * operation to be completed. Type type argument specifies which type | |
418 | * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the | |
419 | * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL | |
3df2f4fe | 420 | * indicates that all channels are to be scanned. |
b22128ef JM |
421 | * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels |
422 | * plus one extra channel specified by freq. | |
423 | * | |
424 | * The full scan is used for the initial scan to find group owners from | |
425 | * all. The other types are used during search phase scan of the social | |
426 | * channels (with potential variation if the Listen channel of the | |
427 | * target peer is known or if other channels are scanned in steps). | |
428 | * | |
429 | * The scan results are returned after this call by calling | |
430 | * p2p_scan_res_handler() for each scan result that has a P2P IE and | |
431 | * then calling p2p_scan_res_handled() to indicate that all scan | |
432 | * results have been indicated. | |
433 | */ | |
046ef4aa JMB |
434 | int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq, |
435 | unsigned int num_req_dev_types, | |
360182ed | 436 | const u8 *req_dev_types, const u8 *dev_id, u16 pw_id); |
b22128ef JM |
437 | |
438 | /** | |
439 | * send_probe_resp - Transmit a Probe Response frame | |
440 | * @ctx: Callback context from cb_ctx | |
441 | * @buf: Probe Response frame (including the header and body) | |
442 | * Returns: 0 on success, -1 on failure | |
443 | * | |
444 | * This function is used to reply to Probe Request frames that were | |
445 | * indicated with a call to p2p_probe_req_rx(). The response is to be | |
446 | * sent on the same channel or to be dropped if the driver is not | |
447 | * anymore listening to Probe Request frames. | |
448 | * | |
449 | * Alternatively, the responsibility for building the Probe Response | |
450 | * frames in Listen state may be in another system component in which | |
451 | * case this function need to be implemented (i.e., the function | |
452 | * pointer can be %NULL). The WPS and P2P IEs to be added for Probe | |
453 | * Response frames in such a case are available from the | |
454 | * start_listen() callback. It should be noted that the received Probe | |
455 | * Request frames must be indicated by calling p2p_probe_req_rx() even | |
456 | * if this send_probe_resp() is not used. | |
457 | */ | |
458 | int (*send_probe_resp)(void *ctx, const struct wpabuf *buf); | |
459 | ||
460 | /** | |
461 | * send_action - Transmit an Action frame | |
462 | * @ctx: Callback context from cb_ctx | |
463 | * @freq: Frequency in MHz for the channel on which to transmit | |
464 | * @dst: Destination MAC address (Address 1) | |
465 | * @src: Source MAC address (Address 2) | |
466 | * @bssid: BSSID (Address 3) | |
467 | * @buf: Frame body (starting from Category field) | |
468 | * @len: Length of buf in octets | |
469 | * @wait_time: How many msec to wait for a response frame | |
470 | * Returns: 0 on success, -1 on failure | |
471 | * | |
472 | * The Action frame may not be transmitted immediately and the status | |
473 | * of the transmission must be reported by calling | |
474 | * p2p_send_action_cb() once the frame has either been transmitted or | |
475 | * it has been dropped due to excessive retries or other failure to | |
476 | * transmit. | |
477 | */ | |
478 | int (*send_action)(void *ctx, unsigned int freq, const u8 *dst, | |
479 | const u8 *src, const u8 *bssid, const u8 *buf, | |
480 | size_t len, unsigned int wait_time); | |
481 | ||
482 | /** | |
483 | * send_action_done - Notify that Action frame sequence was completed | |
484 | * @ctx: Callback context from cb_ctx | |
485 | * | |
486 | * This function is called when the Action frame sequence that was | |
487 | * started with send_action() has been completed, i.e., when there is | |
488 | * no need to wait for a response from the destination peer anymore. | |
489 | */ | |
490 | void (*send_action_done)(void *ctx); | |
491 | ||
492 | /** | |
493 | * start_listen - Start Listen state | |
494 | * @ctx: Callback context from cb_ctx | |
495 | * @freq: Frequency of the listen channel in MHz | |
496 | * @duration: Duration for the Listen state in milliseconds | |
497 | * @probe_resp_ie: IE(s) to be added to Probe Response frames | |
498 | * Returns: 0 on success, -1 on failure | |
499 | * | |
500 | * This Listen state may not start immediately since the driver may | |
501 | * have other pending operations to complete first. Once the Listen | |
502 | * state has started, p2p_listen_cb() must be called to notify the P2P | |
503 | * module. Once the Listen state is stopped, p2p_listen_end() must be | |
504 | * called to notify the P2P module that the driver is not in the Listen | |
505 | * state anymore. | |
506 | * | |
507 | * If the send_probe_resp() is not used for generating the response, | |
508 | * the IEs from probe_resp_ie need to be added to the end of the Probe | |
509 | * Response frame body. If send_probe_resp() is used, the probe_resp_ie | |
510 | * information can be ignored. | |
511 | */ | |
512 | int (*start_listen)(void *ctx, unsigned int freq, | |
513 | unsigned int duration, | |
514 | const struct wpabuf *probe_resp_ie); | |
515 | /** | |
516 | * stop_listen - Stop Listen state | |
517 | * @ctx: Callback context from cb_ctx | |
518 | * | |
519 | * This callback can be used to stop a Listen state operation that was | |
520 | * previously requested with start_listen(). | |
521 | */ | |
522 | void (*stop_listen)(void *ctx); | |
523 | ||
524 | /** | |
525 | * get_noa - Get current Notice of Absence attribute payload | |
526 | * @ctx: Callback context from cb_ctx | |
527 | * @interface_addr: P2P Interface Address of the GO | |
528 | * @buf: Buffer for returning NoA | |
529 | * @buf_len: Buffer length in octets | |
530 | * Returns: Number of octets used in buf, 0 to indicate no NoA is being | |
531 | * advertized, or -1 on failure | |
532 | * | |
533 | * This function is used to fetch the current Notice of Absence | |
534 | * attribute value from GO. | |
535 | */ | |
536 | int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf, | |
537 | size_t buf_len); | |
538 | ||
539 | /* Callbacks to notify events to upper layer management entity */ | |
540 | ||
541 | /** | |
542 | * dev_found - Notification of a found P2P Device | |
543 | * @ctx: Callback context from cb_ctx | |
544 | * @addr: Source address of the message triggering this notification | |
c5db8e51 | 545 | * @info: P2P peer information |
8fd7dc1b | 546 | * @new_device: Inform if the peer is newly found |
b22128ef JM |
547 | * |
548 | * This callback is used to notify that a new P2P Device has been | |
549 | * found. This may happen, e.g., during Search state based on scan | |
550 | * results or during Listen state based on receive Probe Request and | |
551 | * Group Owner Negotiation Request. | |
552 | */ | |
c5db8e51 | 553 | void (*dev_found)(void *ctx, const u8 *addr, |
8fd7dc1b JB |
554 | const struct p2p_peer_info *info, |
555 | int new_device); | |
b22128ef | 556 | |
56eeb8f2 JB |
557 | /** |
558 | * dev_lost - Notification of a lost P2P Device | |
559 | * @ctx: Callback context from cb_ctx | |
560 | * @dev_addr: P2P Device Address of the lost P2P Device | |
561 | * | |
562 | * This callback is used to notify that a P2P Device has been deleted. | |
563 | */ | |
564 | void (*dev_lost)(void *ctx, const u8 *dev_addr); | |
565 | ||
710ae9ac JM |
566 | /** |
567 | * find_stopped - Notification of a p2p_find operation stopping | |
568 | * @ctx: Callback context from cb_ctx | |
569 | */ | |
570 | void (*find_stopped)(void *ctx); | |
571 | ||
b22128ef JM |
572 | /** |
573 | * go_neg_req_rx - Notification of a receive GO Negotiation Request | |
574 | * @ctx: Callback context from cb_ctx | |
575 | * @src: Source address of the message triggering this notification | |
3dfda83d | 576 | * @dev_passwd_id: WPS Device Password ID |
b22128ef JM |
577 | * |
578 | * This callback is used to notify that a P2P Device is requesting | |
579 | * group owner negotiation with us, but we do not have all the | |
580 | * necessary information to start GO Negotiation. This indicates that | |
581 | * the local user has not authorized the connection yet by providing a | |
582 | * PIN or PBC button press. This information can be provided with a | |
583 | * call to p2p_connect(). | |
584 | */ | |
3dfda83d | 585 | void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id); |
b22128ef JM |
586 | |
587 | /** | |
588 | * go_neg_completed - Notification of GO Negotiation results | |
589 | * @ctx: Callback context from cb_ctx | |
590 | * @res: GO Negotiation results | |
591 | * | |
592 | * This callback is used to notify that Group Owner Negotiation has | |
593 | * been completed. Non-zero struct p2p_go_neg_results::status indicates | |
594 | * failed negotiation. In case of success, this function is responsible | |
595 | * for creating a new group interface (or using the existing interface | |
596 | * depending on driver features), setting up the group interface in | |
597 | * proper mode based on struct p2p_go_neg_results::role_go and | |
598 | * initializing WPS provisioning either as a Registrar (if GO) or as an | |
599 | * Enrollee. Successful WPS provisioning must be indicated by calling | |
600 | * p2p_wps_success_cb(). The callee is responsible for timing out group | |
601 | * formation if WPS provisioning cannot be completed successfully | |
602 | * within 15 seconds. | |
603 | */ | |
604 | void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res); | |
605 | ||
606 | /** | |
607 | * sd_request - Callback on Service Discovery Request | |
608 | * @ctx: Callback context from cb_ctx | |
609 | * @freq: Frequency (in MHz) of the channel | |
610 | * @sa: Source address of the request | |
611 | * @dialog_token: Dialog token | |
612 | * @update_indic: Service Update Indicator from the source of request | |
613 | * @tlvs: P2P Service Request TLV(s) | |
614 | * @tlvs_len: Length of tlvs buffer in octets | |
615 | * | |
616 | * This callback is used to indicate reception of a service discovery | |
617 | * request. Response to the query must be indicated by calling | |
618 | * p2p_sd_response() with the context information from the arguments to | |
619 | * this callback function. | |
620 | * | |
621 | * This callback handler can be set to %NULL to indicate that service | |
622 | * discovery is not supported. | |
623 | */ | |
624 | void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token, | |
625 | u16 update_indic, const u8 *tlvs, size_t tlvs_len); | |
626 | ||
627 | /** | |
628 | * sd_response - Callback on Service Discovery Response | |
629 | * @ctx: Callback context from cb_ctx | |
630 | * @sa: Source address of the request | |
631 | * @update_indic: Service Update Indicator from the source of response | |
632 | * @tlvs: P2P Service Response TLV(s) | |
633 | * @tlvs_len: Length of tlvs buffer in octets | |
634 | * | |
635 | * This callback is used to indicate reception of a service discovery | |
636 | * response. This callback handler can be set to %NULL if no service | |
637 | * discovery requests are used. The information provided with this call | |
638 | * is replies to the queries scheduled with p2p_sd_request(). | |
639 | */ | |
640 | void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic, | |
641 | const u8 *tlvs, size_t tlvs_len); | |
642 | ||
643 | /** | |
644 | * prov_disc_req - Callback on Provisiong Discovery Request | |
645 | * @ctx: Callback context from cb_ctx | |
646 | * @peer: Source address of the request | |
647 | * @config_methods: Requested WPS Config Method | |
648 | * @dev_addr: P2P Device Address of the found P2P Device | |
649 | * @pri_dev_type: Primary Device Type | |
650 | * @dev_name: Device Name | |
651 | * @supp_config_methods: Supported configuration Methods | |
652 | * @dev_capab: Device Capabilities | |
653 | * @group_capab: Group Capabilities | |
c3f42784 JM |
654 | * @group_id: P2P Group ID (or %NULL if not included) |
655 | * @group_id_len: Length of P2P Group ID | |
b22128ef JM |
656 | * |
657 | * This callback is used to indicate reception of a Provision Discovery | |
658 | * Request frame that the P2P module accepted. | |
659 | */ | |
660 | void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods, | |
661 | const u8 *dev_addr, const u8 *pri_dev_type, | |
662 | const char *dev_name, u16 supp_config_methods, | |
c3f42784 JM |
663 | u8 dev_capab, u8 group_capab, |
664 | const u8 *group_id, size_t group_id_len); | |
b22128ef JM |
665 | |
666 | /** | |
667 | * prov_disc_resp - Callback on Provisiong Discovery Response | |
668 | * @ctx: Callback context from cb_ctx | |
669 | * @peer: Source address of the response | |
670 | * @config_methods: Value from p2p_prov_disc_req() or 0 on failure | |
671 | * | |
672 | * This callback is used to indicate reception of a Provision Discovery | |
673 | * Response frame for a pending request scheduled with | |
674 | * p2p_prov_disc_req(). This callback handler can be set to %NULL if | |
675 | * provision discovery is not used. | |
676 | */ | |
677 | void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods); | |
678 | ||
349b213c JS |
679 | /** |
680 | * prov_disc_fail - Callback on Provision Discovery failure | |
681 | * @ctx: Callback context from cb_ctx | |
682 | * @peer: Source address of the response | |
683 | * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS | |
684 | * | |
685 | * This callback is used to indicate either a failure or no response | |
686 | * to an earlier provision discovery request. | |
687 | * | |
688 | * This callback handler can be set to %NULL if provision discovery | |
689 | * is not used or failures do not need to be indicated. | |
690 | */ | |
691 | void (*prov_disc_fail)(void *ctx, const u8 *peer, | |
692 | enum p2p_prov_disc_status status); | |
693 | ||
b22128ef JM |
694 | /** |
695 | * invitation_process - Optional callback for processing Invitations | |
696 | * @ctx: Callback context from cb_ctx | |
697 | * @sa: Source address of the Invitation Request | |
698 | * @bssid: P2P Group BSSID from the request or %NULL if not included | |
699 | * @go_dev_addr: GO Device Address from P2P Group ID | |
700 | * @ssid: SSID from P2P Group ID | |
701 | * @ssid_len: Length of ssid buffer in octets | |
702 | * @go: Variable for returning whether the local end is GO in the group | |
703 | * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO) | |
704 | * @force_freq: Variable for returning forced frequency for the group | |
705 | * @persistent_group: Whether this is an invitation to reinvoke a | |
706 | * persistent group (instead of invitation to join an active | |
707 | * group) | |
72728c6f | 708 | * @channels: Available operating channels for the group |
b22128ef JM |
709 | * Returns: Status code (P2P_SC_*) |
710 | * | |
711 | * This optional callback can be used to implement persistent reconnect | |
712 | * by allowing automatic restarting of persistent groups without user | |
713 | * interaction. If this callback is not implemented (i.e., is %NULL), | |
714 | * the received Invitation Request frames are replied with | |
715 | * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the | |
716 | * invitation_result() callback. | |
717 | * | |
718 | * If the requested parameters are acceptable and the group is known, | |
719 | * %P2P_SC_SUCCESS may be returned. If the requested group is unknown, | |
720 | * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED | |
721 | * can be returned if there is not enough data to provide immediate | |
722 | * response, i.e., if some sort of user interaction is needed. The | |
723 | * invitation_received() callback will be called in that case | |
724 | * immediately after this call. | |
725 | */ | |
726 | u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid, | |
727 | const u8 *go_dev_addr, const u8 *ssid, | |
728 | size_t ssid_len, int *go, u8 *group_bssid, | |
72728c6f SL |
729 | int *force_freq, int persistent_group, |
730 | const struct p2p_channels *channels); | |
b22128ef JM |
731 | |
732 | /** | |
733 | * invitation_received - Callback on Invitation Request RX | |
734 | * @ctx: Callback context from cb_ctx | |
735 | * @sa: Source address of the Invitation Request | |
736 | * @bssid: P2P Group BSSID or %NULL if not received | |
737 | * @ssid: SSID of the group | |
738 | * @ssid_len: Length of ssid in octets | |
739 | * @go_dev_addr: GO Device Address | |
740 | * @status: Response Status | |
741 | * @op_freq: Operational frequency for the group | |
742 | * | |
743 | * This callback is used to indicate sending of an Invitation Response | |
744 | * for a received Invitation Request. If status == 0 (success), the | |
745 | * upper layer code is responsible for starting the group. status == 1 | |
746 | * indicates need to get user authorization for the group. Other status | |
747 | * values indicate that the invitation request was rejected. | |
748 | */ | |
749 | void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid, | |
750 | const u8 *ssid, size_t ssid_len, | |
751 | const u8 *go_dev_addr, u8 status, | |
752 | int op_freq); | |
753 | ||
754 | /** | |
755 | * invitation_result - Callback on Invitation result | |
756 | * @ctx: Callback context from cb_ctx | |
757 | * @status: Negotiation result (Status Code) | |
758 | * @bssid: P2P Group BSSID or %NULL if not received | |
54733624 | 759 | * @channels: Available operating channels for the group |
dbca75f8 | 760 | * @addr: Peer address |
b22128ef JM |
761 | * |
762 | * This callback is used to indicate result of an Invitation procedure | |
763 | * started with a call to p2p_invite(). The indicated status code is | |
764 | * the value received from the peer in Invitation Response with 0 | |
765 | * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a | |
766 | * local failure in transmitting the Invitation Request. | |
767 | */ | |
54733624 | 768 | void (*invitation_result)(void *ctx, int status, const u8 *bssid, |
dbca75f8 JM |
769 | const struct p2p_channels *channels, |
770 | const u8 *addr); | |
b1aebbc4 JM |
771 | |
772 | /** | |
773 | * go_connected - Check whether we are connected to a GO | |
774 | * @ctx: Callback context from cb_ctx | |
775 | * @dev_addr: P2P Device Address of a GO | |
776 | * Returns: 1 if we are connected as a P2P client to the specified GO | |
777 | * or 0 if not. | |
778 | */ | |
779 | int (*go_connected)(void *ctx, const u8 *dev_addr); | |
b22128ef JM |
780 | }; |
781 | ||
782 | ||
783 | /* P2P module initialization/deinitialization */ | |
784 | ||
785 | /** | |
786 | * p2p_init - Initialize P2P module | |
787 | * @cfg: P2P module configuration | |
788 | * Returns: Pointer to private data or %NULL on failure | |
789 | * | |
790 | * This function is used to initialize global P2P module context (one per | |
791 | * device). The P2P module will keep a copy of the configuration data, so the | |
792 | * caller does not need to maintain this structure. However, the callback | |
793 | * functions and the context parameters to them must be kept available until | |
794 | * the P2P module is deinitialized with p2p_deinit(). | |
795 | */ | |
796 | struct p2p_data * p2p_init(const struct p2p_config *cfg); | |
797 | ||
798 | /** | |
799 | * p2p_deinit - Deinitialize P2P module | |
800 | * @p2p: P2P module context from p2p_init() | |
801 | */ | |
802 | void p2p_deinit(struct p2p_data *p2p); | |
803 | ||
804 | /** | |
805 | * p2p_flush - Flush P2P module state | |
806 | * @p2p: P2P module context from p2p_init() | |
807 | * | |
808 | * This command removes the P2P module state like peer device entries. | |
809 | */ | |
810 | void p2p_flush(struct p2p_data *p2p); | |
811 | ||
9d562b79 SS |
812 | /** |
813 | * p2p_unauthorize - Unauthorize the specified peer device | |
814 | * @p2p: P2P module context from p2p_init() | |
815 | * @addr: P2P peer entry to be unauthorized | |
816 | * Returns: 0 on success, -1 on failure | |
817 | * | |
818 | * This command removes any connection authorization from the specified P2P | |
819 | * peer device address. This can be used, e.g., to cancel effect of a previous | |
820 | * p2p_authorize() or p2p_connect() call that has not yet resulted in completed | |
821 | * GO Negotiation. | |
822 | */ | |
823 | int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr); | |
824 | ||
b22128ef JM |
825 | /** |
826 | * p2p_set_dev_name - Set device name | |
827 | * @p2p: P2P module context from p2p_init() | |
828 | * Returns: 0 on success, -1 on failure | |
829 | * | |
830 | * This function can be used to update the P2P module configuration with | |
831 | * information that was not available at the time of the p2p_init() call. | |
832 | */ | |
833 | int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name); | |
834 | ||
b6e01800 JM |
835 | int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer); |
836 | int p2p_set_model_name(struct p2p_data *p2p, const char *model_name); | |
837 | int p2p_set_model_number(struct p2p_data *p2p, const char *model_number); | |
838 | int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number); | |
839 | ||
840 | void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods); | |
841 | void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid); | |
842 | ||
b22128ef JM |
843 | /** |
844 | * p2p_set_pri_dev_type - Set primary device type | |
845 | * @p2p: P2P module context from p2p_init() | |
846 | * Returns: 0 on success, -1 on failure | |
847 | * | |
848 | * This function can be used to update the P2P module configuration with | |
849 | * information that was not available at the time of the p2p_init() call. | |
850 | */ | |
851 | int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type); | |
852 | ||
853 | /** | |
854 | * p2p_set_sec_dev_types - Set secondary device types | |
855 | * @p2p: P2P module context from p2p_init() | |
856 | * Returns: 0 on success, -1 on failure | |
857 | * | |
858 | * This function can be used to update the P2P module configuration with | |
859 | * information that was not available at the time of the p2p_init() call. | |
860 | */ | |
861 | int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8], | |
862 | size_t num_dev_types); | |
863 | ||
864 | int p2p_set_country(struct p2p_data *p2p, const char *country); | |
865 | ||
866 | ||
867 | /* Commands from upper layer management entity */ | |
868 | ||
869 | enum p2p_discovery_type { | |
870 | P2P_FIND_START_WITH_FULL, | |
871 | P2P_FIND_ONLY_SOCIAL, | |
872 | P2P_FIND_PROGRESSIVE | |
873 | }; | |
874 | ||
875 | /** | |
876 | * p2p_find - Start P2P Find (Device Discovery) | |
877 | * @p2p: P2P module context from p2p_init() | |
878 | * @timeout: Timeout for find operation in seconds or 0 for no timeout | |
879 | * @type: Device Discovery type | |
046ef4aa JMB |
880 | * @num_req_dev_types: Number of requested device types |
881 | * @req_dev_types: Requested device types array, must be an array | |
882 | * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no | |
883 | * requested device types. | |
6d92fa6e | 884 | * @dev_id: Device ID to search for or %NULL to find all devices |
37448ede | 885 | * @search_delay: Extra delay in milliseconds between search iterations |
b22128ef JM |
886 | * Returns: 0 on success, -1 on failure |
887 | */ | |
888 | int p2p_find(struct p2p_data *p2p, unsigned int timeout, | |
046ef4aa | 889 | enum p2p_discovery_type type, |
6d92fa6e | 890 | unsigned int num_req_dev_types, const u8 *req_dev_types, |
37448ede | 891 | const u8 *dev_id, unsigned int search_delay); |
b22128ef JM |
892 | |
893 | /** | |
894 | * p2p_stop_find - Stop P2P Find (Device Discovery) | |
895 | * @p2p: P2P module context from p2p_init() | |
896 | */ | |
897 | void p2p_stop_find(struct p2p_data *p2p); | |
898 | ||
0b8889d8 JM |
899 | /** |
900 | * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq | |
901 | * @p2p: P2P module context from p2p_init() | |
902 | * @freq: Frequency in MHz for next operation | |
903 | * | |
904 | * This is like p2p_stop_find(), but Listen state is not stopped if we are | |
905 | * already on the same frequency. | |
906 | */ | |
907 | void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq); | |
908 | ||
b22128ef JM |
909 | /** |
910 | * p2p_listen - Start P2P Listen state for specified duration | |
911 | * @p2p: P2P module context from p2p_init() | |
912 | * @timeout: Listen state duration in milliseconds | |
913 | * Returns: 0 on success, -1 on failure | |
914 | * | |
915 | * This function can be used to request the P2P module to keep the device | |
916 | * discoverable on the listen channel for an extended set of time. At least in | |
917 | * its current form, this is mainly used for testing purposes and may not be of | |
918 | * much use for normal P2P operations. | |
919 | */ | |
920 | int p2p_listen(struct p2p_data *p2p, unsigned int timeout); | |
921 | ||
0b5fb86a SADR |
922 | /** |
923 | * p2p_stop_listen - Stop P2P Listen | |
924 | * @p2p: P2P module context from p2p_init() | |
925 | */ | |
926 | void p2p_stop_listen(struct p2p_data *p2p); | |
927 | ||
b22128ef JM |
928 | /** |
929 | * p2p_connect - Start P2P group formation (GO negotiation) | |
930 | * @p2p: P2P module context from p2p_init() | |
931 | * @peer_addr: MAC address of the peer P2P client | |
932 | * @wps_method: WPS method to be used in provisioning | |
933 | * @go_intent: Local GO intent value (1..15) | |
934 | * @own_interface_addr: Intended interface address to use with the group | |
935 | * @force_freq: The only allowed channel frequency in MHz or 0 | |
acc247b2 JM |
936 | * @persistent_group: Whether to create a persistent group (0 = no, 1 = |
937 | * persistent group without persistent reconnect, 2 = persistent group with | |
938 | * persistent reconnect) | |
23c84252 JM |
939 | * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate |
940 | * a new SSID | |
941 | * @force_ssid_len: Length of $force_ssid buffer | |
3bc462cb JM |
942 | * @pd_before_go_neg: Whether to send Provision Discovery prior to GO |
943 | * Negotiation as an interoperability workaround when initiating group | |
944 | * formation | |
04a3e69d JM |
945 | * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if |
946 | * force_freq == 0) | |
b22128ef JM |
947 | * Returns: 0 on success, -1 on failure |
948 | */ | |
949 | int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr, | |
950 | enum p2p_wps_method wps_method, | |
951 | int go_intent, const u8 *own_interface_addr, | |
23c84252 | 952 | unsigned int force_freq, int persistent_group, |
3bc462cb | 953 | const u8 *force_ssid, size_t force_ssid_len, |
04a3e69d | 954 | int pd_before_go_neg, unsigned int pref_freq); |
b22128ef JM |
955 | |
956 | /** | |
957 | * p2p_authorize - Authorize P2P group formation (GO negotiation) | |
958 | * @p2p: P2P module context from p2p_init() | |
959 | * @peer_addr: MAC address of the peer P2P client | |
960 | * @wps_method: WPS method to be used in provisioning | |
961 | * @go_intent: Local GO intent value (1..15) | |
962 | * @own_interface_addr: Intended interface address to use with the group | |
963 | * @force_freq: The only allowed channel frequency in MHz or 0 | |
acc247b2 JM |
964 | * @persistent_group: Whether to create a persistent group (0 = no, 1 = |
965 | * persistent group without persistent reconnect, 2 = persistent group with | |
966 | * persistent reconnect) | |
23c84252 JM |
967 | * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate |
968 | * a new SSID | |
969 | * @force_ssid_len: Length of $force_ssid buffer | |
04a3e69d JM |
970 | * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if |
971 | * force_freq == 0) | |
b22128ef JM |
972 | * Returns: 0 on success, -1 on failure |
973 | * | |
974 | * This is like p2p_connect(), but the actual group negotiation is not | |
975 | * initiated automatically, i.e., the other end is expected to do that. | |
976 | */ | |
977 | int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr, | |
978 | enum p2p_wps_method wps_method, | |
979 | int go_intent, const u8 *own_interface_addr, | |
23c84252 | 980 | unsigned int force_freq, int persistent_group, |
04a3e69d JM |
981 | const u8 *force_ssid, size_t force_ssid_len, |
982 | unsigned int pref_freq); | |
b22128ef JM |
983 | |
984 | /** | |
985 | * p2p_reject - Reject peer device (explicitly block connection attempts) | |
986 | * @p2p: P2P module context from p2p_init() | |
987 | * @peer_addr: MAC address of the peer P2P client | |
988 | * Returns: 0 on success, -1 on failure | |
989 | */ | |
990 | int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr); | |
991 | ||
992 | /** | |
993 | * p2p_prov_disc_req - Send Provision Discovery Request | |
994 | * @p2p: P2P module context from p2p_init() | |
995 | * @peer_addr: MAC address of the peer P2P client | |
996 | * @config_methods: WPS Config Methods value (only one bit set) | |
997 | * @join: Whether this is used by a client joining an active group | |
1ef2f7ff | 998 | * @force_freq: Forced TX frequency for the frame (mainly for the join case) |
67527166 | 999 | * @user_initiated_pd: Flag to indicate if initiated by user or not |
b22128ef JM |
1000 | * Returns: 0 on success, -1 on failure |
1001 | * | |
1002 | * This function can be used to request a discovered P2P peer to display a PIN | |
1003 | * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us | |
1004 | * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame | |
1005 | * is transmitted once immediately and if no response is received, the frame | |
1006 | * will be sent again whenever the target device is discovered during device | |
1007 | * dsicovery (start with a p2p_find() call). Response from the peer is | |
1008 | * indicated with the p2p_config::prov_disc_resp() callback. | |
1009 | */ | |
1010 | int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr, | |
67527166 SD |
1011 | u16 config_methods, int join, int force_freq, |
1012 | int user_initiated_pd); | |
b22128ef JM |
1013 | |
1014 | /** | |
1015 | * p2p_sd_request - Schedule a service discovery query | |
1016 | * @p2p: P2P module context from p2p_init() | |
1017 | * @dst: Destination peer or %NULL to apply for all peers | |
1018 | * @tlvs: P2P Service Query TLV(s) | |
1019 | * Returns: Reference to the query or %NULL on failure | |
1020 | * | |
1021 | * Response to the query is indicated with the p2p_config::sd_response() | |
1022 | * callback. | |
1023 | */ | |
1024 | void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst, | |
1025 | const struct wpabuf *tlvs); | |
1026 | ||
347d6a5b JM |
1027 | #ifdef CONFIG_WIFI_DISPLAY |
1028 | void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst, | |
1029 | const struct wpabuf *tlvs); | |
1030 | #endif /* CONFIG_WIFI_DISPLAY */ | |
1031 | ||
b22128ef JM |
1032 | /** |
1033 | * p2p_sd_cancel_request - Cancel a pending service discovery query | |
1034 | * @p2p: P2P module context from p2p_init() | |
1035 | * @req: Query reference from p2p_sd_request() | |
1036 | * Returns: 0 if request for cancelled; -1 if not found | |
1037 | */ | |
1038 | int p2p_sd_cancel_request(struct p2p_data *p2p, void *req); | |
1039 | ||
1040 | /** | |
1041 | * p2p_sd_response - Send response to a service discovery query | |
1042 | * @p2p: P2P module context from p2p_init() | |
1043 | * @freq: Frequency from p2p_config::sd_request() callback | |
1044 | * @dst: Destination address from p2p_config::sd_request() callback | |
1045 | * @dialog_token: Dialog token from p2p_config::sd_request() callback | |
1046 | * @resp_tlvs: P2P Service Response TLV(s) | |
1047 | * | |
1048 | * This function is called as a response to the request indicated with | |
1049 | * p2p_config::sd_request() callback. | |
1050 | */ | |
1051 | void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst, | |
1052 | u8 dialog_token, const struct wpabuf *resp_tlvs); | |
1053 | ||
1054 | /** | |
1055 | * p2p_sd_service_update - Indicate a change in local services | |
1056 | * @p2p: P2P module context from p2p_init() | |
1057 | * | |
1058 | * This function needs to be called whenever there is a change in availability | |
1059 | * of the local services. This will increment the Service Update Indicator | |
1060 | * value which will be used in SD Request and Response frames. | |
1061 | */ | |
1062 | void p2p_sd_service_update(struct p2p_data *p2p); | |
1063 | ||
1064 | ||
1065 | enum p2p_invite_role { | |
1066 | P2P_INVITE_ROLE_GO, | |
1067 | P2P_INVITE_ROLE_ACTIVE_GO, | |
1068 | P2P_INVITE_ROLE_CLIENT | |
1069 | }; | |
1070 | ||
1071 | /** | |
1072 | * p2p_invite - Invite a P2P Device into a group | |
1073 | * @p2p: P2P module context from p2p_init() | |
1074 | * @peer: Device Address of the peer P2P Device | |
1075 | * @role: Local role in the group | |
1076 | * @bssid: Group BSSID or %NULL if not known | |
1077 | * @ssid: Group SSID | |
1078 | * @ssid_len: Length of ssid in octets | |
1079 | * @force_freq: The only allowed channel frequency in MHz or 0 | |
1080 | * @go_dev_addr: Forced GO Device Address or %NULL if none | |
1081 | * @persistent_group: Whether this is to reinvoke a persistent group | |
79879f4a DG |
1082 | * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if |
1083 | * force_freq == 0) | |
b22128ef JM |
1084 | * Returns: 0 on success, -1 on failure |
1085 | */ | |
1086 | int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role, | |
1087 | const u8 *bssid, const u8 *ssid, size_t ssid_len, | |
1088 | unsigned int force_freq, const u8 *go_dev_addr, | |
79879f4a | 1089 | int persistent_group, unsigned int pref_freq); |
b22128ef JM |
1090 | |
1091 | /** | |
1092 | * p2p_presence_req - Request GO presence | |
1093 | * @p2p: P2P module context from p2p_init() | |
1094 | * @go_interface_addr: GO P2P Interface Address | |
1095 | * @own_interface_addr: Own P2P Interface Address for this group | |
1096 | * @freq: Group operating frequence (in MHz) | |
1097 | * @duration1: Preferred presence duration in microseconds | |
1098 | * @interval1: Preferred presence interval in microseconds | |
1099 | * @duration2: Acceptable presence duration in microseconds | |
1100 | * @interval2: Acceptable presence interval in microseconds | |
1101 | * Returns: 0 on success, -1 on failure | |
1102 | * | |
1103 | * If both duration and interval values are zero, the parameter pair is not | |
1104 | * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0). | |
1105 | */ | |
1106 | int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr, | |
1107 | const u8 *own_interface_addr, unsigned int freq, | |
1108 | u32 duration1, u32 interval1, u32 duration2, | |
1109 | u32 interval2); | |
1110 | ||
1111 | /** | |
1112 | * p2p_ext_listen - Set Extended Listen Timing | |
1113 | * @p2p: P2P module context from p2p_init() | |
1114 | * @freq: Group operating frequence (in MHz) | |
1115 | * @period: Availability period in milliseconds (1-65535; 0 to disable) | |
1116 | * @interval: Availability interval in milliseconds (1-65535; 0 to disable) | |
1117 | * Returns: 0 on success, -1 on failure | |
1118 | * | |
1119 | * This function can be used to enable or disable (period = interval = 0) | |
1120 | * Extended Listen Timing. When enabled, the P2P Device will become | |
1121 | * discoverable (go into Listen State) every @interval milliseconds for at | |
1122 | * least @period milliseconds. | |
1123 | */ | |
1124 | int p2p_ext_listen(struct p2p_data *p2p, unsigned int period, | |
1125 | unsigned int interval); | |
1126 | ||
1127 | /* Event notifications from upper layer management operations */ | |
1128 | ||
1129 | /** | |
1130 | * p2p_wps_success_cb - Report successfully completed WPS provisioning | |
1131 | * @p2p: P2P module context from p2p_init() | |
1132 | * @mac_addr: Peer address | |
1133 | * | |
1134 | * This function is used to report successfully completed WPS provisioning | |
1135 | * during group formation in both GO/Registrar and client/Enrollee roles. | |
1136 | */ | |
1137 | void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr); | |
1138 | ||
1139 | /** | |
1140 | * p2p_group_formation_failed - Report failed WPS provisioning | |
1141 | * @p2p: P2P module context from p2p_init() | |
1142 | * | |
1143 | * This function is used to report failed group formation. This can happen | |
1144 | * either due to failed WPS provisioning or due to 15 second timeout during | |
1145 | * the provisioning phase. | |
1146 | */ | |
1147 | void p2p_group_formation_failed(struct p2p_data *p2p); | |
1148 | ||
ec437d9e JJ |
1149 | /** |
1150 | * p2p_get_provisioning_info - Get any stored provisioning info | |
1151 | * @p2p: P2P module context from p2p_init() | |
1152 | * @addr: Peer P2P Device Address | |
1153 | * Returns: WPS provisioning information (WPS config method) or 0 if no | |
1154 | * information is available | |
1155 | * | |
1156 | * This function is used to retrieve stored WPS provisioning info for the given | |
1157 | * peer. | |
1158 | */ | |
1159 | u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr); | |
1160 | ||
1161 | /** | |
1162 | * p2p_clear_provisioning_info - Clear any stored provisioning info | |
1163 | * @p2p: P2P module context from p2p_init() | |
10531d21 | 1164 | * @iface_addr: Peer P2P Device Address |
ec437d9e JJ |
1165 | * |
1166 | * This function is used to clear stored WPS provisioning info for the given | |
1167 | * peer. | |
1168 | */ | |
10531d21 | 1169 | void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr); |
ec437d9e | 1170 | |
b22128ef JM |
1171 | |
1172 | /* Event notifications from lower layer driver operations */ | |
1173 | ||
2d43d37f JB |
1174 | /** |
1175 | * enum p2p_probe_req_status | |
1176 | * | |
1177 | * @P2P_PREQ_MALFORMED: frame was not well-formed | |
1178 | * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored | |
1179 | * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request | |
1180 | * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed | |
1181 | * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P | |
1182 | */ | |
1183 | enum p2p_probe_req_status { | |
1184 | P2P_PREQ_MALFORMED, | |
1185 | P2P_PREQ_NOT_LISTEN, | |
1186 | P2P_PREQ_NOT_P2P, | |
1187 | P2P_PREQ_NOT_PROCESSED, | |
1188 | P2P_PREQ_PROCESSED | |
1189 | }; | |
1190 | ||
b22128ef JM |
1191 | /** |
1192 | * p2p_probe_req_rx - Report reception of a Probe Request frame | |
1193 | * @p2p: P2P module context from p2p_init() | |
1194 | * @addr: Source MAC address | |
04a85e44 JM |
1195 | * @dst: Destination MAC address if available or %NULL |
1196 | * @bssid: BSSID if available or %NULL | |
b22128ef JM |
1197 | * @ie: Information elements from the Probe Request frame body |
1198 | * @ie_len: Length of ie buffer in octets | |
2d43d37f | 1199 | * Returns: value indicating the type and status of the probe request |
b22128ef | 1200 | */ |
2d43d37f JB |
1201 | enum p2p_probe_req_status |
1202 | p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst, | |
1203 | const u8 *bssid, const u8 *ie, size_t ie_len); | |
b22128ef JM |
1204 | |
1205 | /** | |
1206 | * p2p_rx_action - Report received Action frame | |
1207 | * @p2p: P2P module context from p2p_init() | |
1208 | * @da: Destination address of the received Action frame | |
1209 | * @sa: Source address of the received Action frame | |
1210 | * @bssid: Address 3 of the received Action frame | |
1211 | * @category: Category of the received Action frame | |
1212 | * @data: Action frame body after the Category field | |
1213 | * @len: Length of the data buffer in octets | |
1214 | * @freq: Frequency (in MHz) on which the frame was received | |
1215 | */ | |
1216 | void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa, | |
1217 | const u8 *bssid, u8 category, | |
1218 | const u8 *data, size_t len, int freq); | |
1219 | ||
1220 | /** | |
1221 | * p2p_scan_res_handler - Indicate a P2P scan results | |
1222 | * @p2p: P2P module context from p2p_init() | |
1223 | * @bssid: BSSID of the scan result | |
1224 | * @freq: Frequency of the channel on which the device was found in MHz | |
c5f10e80 | 1225 | * @rx_time: Time when the result was received |
b22128ef JM |
1226 | * @level: Signal level (signal strength of the received Beacon/Probe Response |
1227 | * frame) | |
1228 | * @ies: Pointer to IEs from the scan result | |
1229 | * @ies_len: Length of the ies buffer | |
1230 | * Returns: 0 to continue or 1 to stop scan result indication | |
1231 | * | |
1232 | * This function is called to indicate a scan result entry with P2P IE from a | |
1233 | * scan requested with struct p2p_config::p2p_scan(). This can be called during | |
1234 | * the actual scan process (i.e., whenever a new device is found) or as a | |
1235 | * sequence of calls after the full scan has been completed. The former option | |
1236 | * can result in optimized operations, but may not be supported by all | |
1237 | * driver/firmware designs. The ies buffer need to include at least the P2P IE, | |
1238 | * but it is recommended to include all IEs received from the device. The | |
1239 | * caller does not need to check that the IEs contain a P2P IE before calling | |
1240 | * this function since frames will be filtered internally if needed. | |
1241 | * | |
1242 | * This function will return 1 if it wants to stop scan result iteration (and | |
1243 | * scan in general if it is still in progress). This is used to allow faster | |
1244 | * start of a pending operation, e.g., to start a pending GO negotiation. | |
1245 | */ | |
1246 | int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq, | |
c5f10e80 | 1247 | struct os_time *rx_time, int level, const u8 *ies, |
3dfd0484 | 1248 | size_t ies_len); |
b22128ef JM |
1249 | |
1250 | /** | |
1251 | * p2p_scan_res_handled - Indicate end of scan results | |
1252 | * @p2p: P2P module context from p2p_init() | |
1253 | * | |
1254 | * This function is called to indicate that all P2P scan results from a scan | |
1255 | * have been reported with zero or more calls to p2p_scan_res_handler(). This | |
1256 | * function must be called as a response to successful | |
1257 | * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler() | |
1258 | * calls stopped iteration. | |
1259 | */ | |
1260 | void p2p_scan_res_handled(struct p2p_data *p2p); | |
1261 | ||
93b7ddd0 JM |
1262 | enum p2p_send_action_result { |
1263 | P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */, | |
1264 | P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */, | |
1265 | P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */ | |
1266 | }; | |
1267 | ||
b22128ef JM |
1268 | /** |
1269 | * p2p_send_action_cb - Notify TX status of an Action frame | |
1270 | * @p2p: P2P module context from p2p_init() | |
1271 | * @freq: Channel frequency in MHz | |
1272 | * @dst: Destination MAC address (Address 1) | |
1273 | * @src: Source MAC address (Address 2) | |
1274 | * @bssid: BSSID (Address 3) | |
93b7ddd0 | 1275 | * @result: Result of the transmission attempt |
b22128ef JM |
1276 | * |
1277 | * This function is used to indicate the result of an Action frame transmission | |
1278 | * that was requested with struct p2p_config::send_action() callback. | |
1279 | */ | |
1280 | void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst, | |
93b7ddd0 JM |
1281 | const u8 *src, const u8 *bssid, |
1282 | enum p2p_send_action_result result); | |
b22128ef JM |
1283 | |
1284 | /** | |
1285 | * p2p_listen_cb - Indicate the start of a requested Listen state | |
1286 | * @p2p: P2P module context from p2p_init() | |
1287 | * @freq: Listen channel frequency in MHz | |
1288 | * @duration: Duration for the Listen state in milliseconds | |
1289 | * | |
1290 | * This function is used to indicate that a Listen state requested with | |
1291 | * struct p2p_config::start_listen() callback has started. | |
1292 | */ | |
1293 | void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq, | |
1294 | unsigned int duration); | |
1295 | ||
1296 | /** | |
1297 | * p2p_listen_end - Indicate the end of a requested Listen state | |
1298 | * @p2p: P2P module context from p2p_init() | |
1299 | * @freq: Listen channel frequency in MHz | |
1300 | * Returns: 0 if no operations were started, 1 if an operation was started | |
1301 | * | |
1302 | * This function is used to indicate that a Listen state requested with | |
1303 | * struct p2p_config::start_listen() callback has ended. | |
1304 | */ | |
1305 | int p2p_listen_end(struct p2p_data *p2p, unsigned int freq); | |
1306 | ||
1307 | void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code, | |
1308 | const u8 *ie, size_t ie_len); | |
1309 | ||
1310 | void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code, | |
1311 | const u8 *ie, size_t ie_len); | |
1312 | ||
1313 | ||
1314 | /* Per-group P2P state for GO */ | |
1315 | ||
1316 | struct p2p_group; | |
1317 | ||
1318 | /** | |
1319 | * struct p2p_group_config - P2P group configuration | |
1320 | * | |
1321 | * This configuration is provided to the P2P module during initialization of | |
1322 | * the per-group information with p2p_group_init(). | |
1323 | */ | |
1324 | struct p2p_group_config { | |
1325 | /** | |
1326 | * persistent_group - Whether the group is persistent | |
acc247b2 JM |
1327 | * 0 = not a persistent group |
1328 | * 1 = persistent group without persistent reconnect | |
1329 | * 2 = persistent group with persistent reconnect | |
b22128ef JM |
1330 | */ |
1331 | int persistent_group; | |
1332 | ||
1333 | /** | |
1334 | * interface_addr - P2P Interface Address of the group | |
1335 | */ | |
1336 | u8 interface_addr[ETH_ALEN]; | |
1337 | ||
3f4ce13f JM |
1338 | /** |
1339 | * max_clients - Maximum number of clients in the group | |
1340 | */ | |
1341 | unsigned int max_clients; | |
1342 | ||
6f251b6b JM |
1343 | /** |
1344 | * ssid - Group SSID | |
1345 | */ | |
1346 | u8 ssid[32]; | |
1347 | ||
1348 | /** | |
1349 | * ssid_len - Length of SSID | |
1350 | */ | |
1351 | size_t ssid_len; | |
1352 | ||
b22128ef JM |
1353 | /** |
1354 | * cb_ctx - Context to use with callback functions | |
1355 | */ | |
1356 | void *cb_ctx; | |
1357 | ||
1358 | /** | |
1359 | * ie_update - Notification of IE update | |
1360 | * @ctx: Callback context from cb_ctx | |
1361 | * @beacon_ies: P2P IE for Beacon frames or %NULL if no change | |
1362 | * @proberesp_ies: P2P Ie for Probe Response frames | |
1363 | * | |
1364 | * P2P module uses this callback function to notify whenever the P2P IE | |
1365 | * in Beacon or Probe Response frames should be updated based on group | |
1366 | * events. | |
1367 | * | |
1368 | * The callee is responsible for freeing the returned buffer(s) with | |
1369 | * wpabuf_free(). | |
1370 | */ | |
1371 | void (*ie_update)(void *ctx, struct wpabuf *beacon_ies, | |
1372 | struct wpabuf *proberesp_ies); | |
3071e181 JM |
1373 | |
1374 | /** | |
1375 | * idle_update - Notification of changes in group idle state | |
1376 | * @ctx: Callback context from cb_ctx | |
1377 | * @idle: Whether the group is idle (no associated stations) | |
1378 | */ | |
1379 | void (*idle_update)(void *ctx, int idle); | |
b22128ef JM |
1380 | }; |
1381 | ||
1382 | /** | |
1383 | * p2p_group_init - Initialize P2P group | |
1384 | * @p2p: P2P module context from p2p_init() | |
1385 | * @config: P2P group configuration (will be freed by p2p_group_deinit()) | |
1386 | * Returns: Pointer to private data or %NULL on failure | |
1387 | * | |
1388 | * This function is used to initialize per-group P2P module context. Currently, | |
1389 | * this is only used to manage GO functionality and P2P clients do not need to | |
1390 | * create an instance of this per-group information. | |
1391 | */ | |
1392 | struct p2p_group * p2p_group_init(struct p2p_data *p2p, | |
1393 | struct p2p_group_config *config); | |
1394 | ||
1395 | /** | |
1396 | * p2p_group_deinit - Deinitialize P2P group | |
1397 | * @group: P2P group context from p2p_group_init() | |
1398 | */ | |
1399 | void p2p_group_deinit(struct p2p_group *group); | |
1400 | ||
1401 | /** | |
1402 | * p2p_group_notif_assoc - Notification of P2P client association with GO | |
1403 | * @group: P2P group context from p2p_group_init() | |
1404 | * @addr: Interface address of the P2P client | |
1405 | * @ie: IEs from the (Re)association Request frame | |
1406 | * @len: Length of the ie buffer in octets | |
1407 | * Returns: 0 on success, -1 on failure | |
1408 | */ | |
1409 | int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr, | |
1410 | const u8 *ie, size_t len); | |
1411 | ||
1412 | /** | |
1413 | * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response | |
1414 | * @group: P2P group context from p2p_group_init() | |
1415 | * @status: Status value (P2P_SC_SUCCESS if association succeeded) | |
1416 | * Returns: P2P IE for (Re)association Response or %NULL on failure | |
1417 | * | |
1418 | * The caller is responsible for freeing the returned buffer with | |
1419 | * wpabuf_free(). | |
1420 | */ | |
1421 | struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status); | |
1422 | ||
1423 | /** | |
1424 | * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO | |
1425 | * @group: P2P group context from p2p_group_init() | |
1426 | * @addr: Interface address of the P2P client | |
1427 | */ | |
1428 | void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr); | |
1429 | ||
1430 | /** | |
1431 | * p2p_group_notif_formation_done - Notification of completed group formation | |
1432 | * @group: P2P group context from p2p_group_init() | |
1433 | */ | |
1434 | void p2p_group_notif_formation_done(struct p2p_group *group); | |
1435 | ||
1436 | /** | |
1437 | * p2p_group_notif_noa - Notification of NoA change | |
1438 | * @group: P2P group context from p2p_group_init() | |
1439 | * @noa: Notice of Absence attribute payload, %NULL if none | |
1440 | * @noa_len: Length of noa buffer in octets | |
1441 | * Returns: 0 on success, -1 on failure | |
1442 | * | |
1443 | * Notify the P2P group management about a new NoA contents. This will be | |
1444 | * inserted into the P2P IEs in Beacon and Probe Response frames with rest of | |
1445 | * the group information. | |
1446 | */ | |
1447 | int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa, | |
1448 | size_t noa_len); | |
1449 | ||
1450 | /** | |
1451 | * p2p_group_match_dev_type - Match device types in group with requested type | |
1452 | * @group: P2P group context from p2p_group_init() | |
1453 | * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs) | |
1454 | * Returns: 1 on match, 0 on mismatch | |
1455 | * | |
1456 | * This function can be used to match the Requested Device Type attribute in | |
1457 | * WPS IE with the device types of a group member for deciding whether a GO | |
1458 | * should reply to a Probe Request frame. Match will be reported if the WPS IE | |
1459 | * is not requested any specific device type. | |
1460 | */ | |
1461 | int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps); | |
1462 | ||
8017b538 JM |
1463 | /** |
1464 | * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id | |
1465 | */ | |
1466 | int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p); | |
1467 | ||
b22128ef JM |
1468 | /** |
1469 | * p2p_group_go_discover - Send GO Discoverability Request to a group client | |
1470 | * @group: P2P group context from p2p_group_init() | |
1471 | * Returns: 0 on success (frame scheduled); -1 if client was not found | |
1472 | */ | |
1473 | int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id, | |
1474 | const u8 *searching_dev, int rx_freq); | |
1475 | ||
1476 | ||
1477 | /* Generic helper functions */ | |
1478 | ||
1479 | /** | |
1480 | * p2p_ie_text - Build text format description of P2P IE | |
1481 | * @p2p_ie: P2P IE | |
1482 | * @buf: Buffer for returning text | |
1483 | * @end: Pointer to the end of the buf area | |
1484 | * Returns: Number of octets written to the buffer or -1 on failure | |
1485 | * | |
1486 | * This function can be used to parse P2P IE contents into text format | |
1487 | * field=value lines. | |
1488 | */ | |
1489 | int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end); | |
1490 | ||
1491 | /** | |
1492 | * p2p_scan_result_text - Build text format description of P2P IE | |
1493 | * @ies: Information elements from scan results | |
1494 | * @ies_len: ies buffer length in octets | |
1495 | * @buf: Buffer for returning text | |
1496 | * @end: Pointer to the end of the buf area | |
1497 | * Returns: Number of octets written to the buffer or -1 on failure | |
1498 | * | |
1499 | * This function can be used to parse P2P IE contents into text format | |
1500 | * field=value lines. | |
1501 | */ | |
1502 | int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end); | |
1503 | ||
c2d76aa6 MH |
1504 | /** |
1505 | * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated | |
1506 | * P2P IE | |
1507 | * @p2p_ie: P2P IE | |
1508 | * @dev_addr: Buffer for returning P2P Device Address | |
1509 | * Returns: 0 on success or -1 if P2P Device Address could not be parsed | |
1510 | */ | |
1511 | int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr); | |
1512 | ||
0a70f34f JM |
1513 | /** |
1514 | * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s) | |
1515 | * @ies: Information elements from scan results | |
1516 | * @ies_len: ies buffer length in octets | |
1517 | * @dev_addr: Buffer for returning P2P Device Address | |
1518 | * Returns: 0 on success or -1 if P2P Device Address could not be parsed | |
1519 | */ | |
1520 | int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr); | |
1521 | ||
b22128ef JM |
1522 | /** |
1523 | * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame | |
1524 | * @p2p: P2P module context from p2p_init() | |
1525 | * @bssid: BSSID | |
1526 | * @buf: Buffer for writing the P2P IE | |
1527 | * @len: Maximum buf length in octets | |
1528 | * @p2p_group: Whether this is for association with a P2P GO | |
4c08c0bd | 1529 | * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none |
b22128ef JM |
1530 | * Returns: Number of octets written into buf or -1 on failure |
1531 | */ | |
1532 | int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf, | |
4c08c0bd | 1533 | size_t len, int p2p_group, struct wpabuf *p2p_ie); |
b22128ef JM |
1534 | |
1535 | /** | |
1536 | * p2p_scan_ie - Build P2P IE for Probe Request | |
1537 | * @p2p: P2P module context from p2p_init() | |
1538 | * @ies: Buffer for writing P2P IE | |
6d92fa6e | 1539 | * @dev_id: Device ID to search for or %NULL for any |
b22128ef | 1540 | */ |
6d92fa6e | 1541 | void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id); |
b22128ef | 1542 | |
206e1f42 JM |
1543 | /** |
1544 | * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie | |
1545 | * @p2p: P2P module context from p2p_init() | |
1546 | * Returns: Number of octets that p2p_scan_ie() may add to the buffer | |
1547 | */ | |
1548 | size_t p2p_scan_ie_buf_len(struct p2p_data *p2p); | |
1549 | ||
b22128ef JM |
1550 | /** |
1551 | * p2p_go_params - Generate random P2P group parameters | |
1552 | * @p2p: P2P module context from p2p_init() | |
1553 | * @params: Buffer for parameters | |
1554 | * Returns: 0 on success, -1 on failure | |
1555 | */ | |
1556 | int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params); | |
1557 | ||
1558 | /** | |
1559 | * p2p_get_group_capab - Get Group Capability from P2P IE data | |
1560 | * @p2p_ie: P2P IE(s) contents | |
1561 | * Returns: Group Capability | |
1562 | */ | |
1563 | u8 p2p_get_group_capab(const struct wpabuf *p2p_ie); | |
1564 | ||
72044390 JM |
1565 | /** |
1566 | * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection | |
1567 | * @p2p_ie: P2P IE(s) contents | |
1568 | * Returns: 0 if cross connection is allow, 1 if not | |
1569 | */ | |
1570 | int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie); | |
1571 | ||
b22128ef JM |
1572 | /** |
1573 | * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data | |
1574 | * @p2p_ie: P2P IE(s) contents | |
1575 | * Returns: Pointer to P2P Device Address or %NULL if not included | |
1576 | */ | |
1577 | const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie); | |
1578 | ||
1579 | /** | |
b3ffc80b | 1580 | * p2p_get_peer_info - Get P2P peer information |
b22128ef JM |
1581 | * @p2p: P2P module context from p2p_init() |
1582 | * @addr: P2P Device Address of the peer or %NULL to indicate the first peer | |
1583 | * @next: Whether to select the peer entry following the one indicated by addr | |
b3ffc80b JM |
1584 | * Returns: Pointer to peer info or %NULL if not found |
1585 | */ | |
1586 | const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p, | |
1587 | const u8 *addr, int next); | |
1588 | ||
1589 | /** | |
1590 | * p2p_get_peer_info_txt - Get internal P2P peer information in text format | |
1591 | * @info: Pointer to P2P peer info from p2p_get_peer_info() | |
b22128ef JM |
1592 | * @buf: Buffer for returning text |
1593 | * @buflen: Maximum buffer length | |
1594 | * Returns: Number of octets written to the buffer or -1 on failure | |
b3ffc80b JM |
1595 | * |
1596 | * Note: This information is internal to the P2P module and subject to change. | |
1597 | * As such, this should not really be used by external programs for purposes | |
1598 | * other than debugging. | |
b22128ef | 1599 | */ |
b3ffc80b JM |
1600 | int p2p_get_peer_info_txt(const struct p2p_peer_info *info, |
1601 | char *buf, size_t buflen); | |
b22128ef | 1602 | |
b3bcc0f5 JM |
1603 | /** |
1604 | * p2p_peer_known - Check whether P2P peer is known | |
1605 | * @p2p: P2P module context from p2p_init() | |
1606 | * @addr: P2P Device Address of the peer | |
1607 | * Returns: 1 if the specified device is in the P2P peer table or 0 if not | |
1608 | */ | |
1609 | int p2p_peer_known(struct p2p_data *p2p, const u8 *addr); | |
1610 | ||
b22128ef JM |
1611 | /** |
1612 | * p2p_set_client_discoverability - Set client discoverability capability | |
1613 | * @p2p: P2P module context from p2p_init() | |
1614 | * @enabled: Whether client discoverability will be enabled | |
1615 | * | |
1616 | * This function can be used to disable (and re-enable) client discoverability. | |
1617 | * This capability is enabled by default and should not be disabled in normal | |
1618 | * use cases, i.e., this is mainly for testing purposes. | |
1619 | */ | |
1620 | void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled); | |
1621 | ||
1622 | /** | |
a601f71b | 1623 | * p2p_set_managed_oper - Set managed P2P Device operations capability |
b22128ef JM |
1624 | * @p2p: P2P module context from p2p_init() |
1625 | * @enabled: Whether managed P2P Device operations will be enabled | |
1626 | */ | |
1627 | void p2p_set_managed_oper(struct p2p_data *p2p, int enabled); | |
1628 | ||
1629 | int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel); | |
1630 | ||
1631 | int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len); | |
1632 | ||
1633 | int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr, | |
1634 | u8 *iface_addr); | |
4147a2cc JM |
1635 | int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr, |
1636 | u8 *dev_addr); | |
b22128ef | 1637 | |
80c9582a JM |
1638 | void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr); |
1639 | ||
72044390 JM |
1640 | /** |
1641 | * p2p_set_cross_connect - Set cross connection capability | |
1642 | * @p2p: P2P module context from p2p_init() | |
1643 | * @enabled: Whether cross connection will be enabled | |
1644 | */ | |
1645 | void p2p_set_cross_connect(struct p2p_data *p2p, int enabled); | |
1646 | ||
f8d0131a JM |
1647 | int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr); |
1648 | ||
0f66abd2 SS |
1649 | /** |
1650 | * p2p_set_intra_bss_dist - Set intra BSS distribution | |
1651 | * @p2p: P2P module context from p2p_init() | |
1652 | * @enabled: Whether intra BSS distribution will be enabled | |
1653 | */ | |
1654 | void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled); | |
1655 | ||
54733624 JM |
1656 | int p2p_channels_includes_freq(const struct p2p_channels *channels, |
1657 | unsigned int freq); | |
1658 | ||
d054a462 JM |
1659 | /** |
1660 | * p2p_supported_freq - Check whether channel is supported for P2P | |
1661 | * @p2p: P2P module context from p2p_init() | |
1662 | * @freq: Channel frequency in MHz | |
1663 | * Returns: 0 if channel not usable for P2P, 1 if usable for P2P | |
1664 | */ | |
1665 | int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq); | |
1666 | ||
556b30da JM |
1667 | /** |
1668 | * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation | |
1669 | * @p2p: P2P module context from p2p_init() | |
1670 | * @freq: Channel frequency in MHz | |
1671 | * Returns: 0 if channel not usable for P2P, 1 if usable for P2P | |
1672 | */ | |
1673 | int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq); | |
1674 | ||
51e9f228 JM |
1675 | /** |
1676 | * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation | |
1677 | * @p2p: P2P module context from p2p_init() | |
1678 | * @freq: Channel frequency in MHz | |
1679 | * Returns: 0 if channel not usable for P2P, 1 if usable for P2P | |
1680 | */ | |
1681 | int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq); | |
1682 | ||
c6ccf12d SS |
1683 | /** |
1684 | * p2p_get_pref_freq - Get channel from preferred channel list | |
1685 | * @p2p: P2P module context from p2p_init() | |
1686 | * @channels: List of channels | |
1687 | * Returns: Preferred channel | |
1688 | */ | |
1689 | unsigned int p2p_get_pref_freq(struct p2p_data *p2p, | |
1690 | const struct p2p_channels *channels); | |
1691 | ||
51e9f228 JM |
1692 | void p2p_update_channel_list(struct p2p_data *p2p, |
1693 | const struct p2p_channels *chan, | |
1694 | const struct p2p_channels *cli_chan); | |
b5c9da8d | 1695 | |
7cfc4ac3 AGS |
1696 | /** |
1697 | * p2p_set_best_channels - Update best channel information | |
1698 | * @p2p: P2P module context from p2p_init() | |
1699 | * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band | |
1700 | * @freq_5: Frequency (MHz) of best channel in 5 GHz band | |
1701 | * @freq_overall: Frequency (MHz) of best channel overall | |
1702 | */ | |
1703 | void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5, | |
1704 | int freq_overall); | |
1705 | ||
6cb27aa8 JM |
1706 | /** |
1707 | * p2p_set_own_freq_preference - Set own preference for channel | |
1708 | * @p2p: P2P module context from p2p_init() | |
1709 | * @freq: Frequency (MHz) of the preferred channel or 0 if no preference | |
1710 | * | |
1711 | * This function can be used to set a preference on the operating channel based | |
1712 | * on frequencies used on the other virtual interfaces that share the same | |
1713 | * radio. If non-zero, this is used to try to avoid multi-channel concurrency. | |
1714 | */ | |
1715 | void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq); | |
1716 | ||
231bbd03 SS |
1717 | const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p); |
1718 | ||
5efa9e2a JB |
1719 | /** |
1720 | * p2p_get_group_num_members - Get number of members in group | |
1721 | * @group: P2P group context from p2p_group_init() | |
1722 | * Returns: Number of members in the group | |
1723 | */ | |
1724 | unsigned int p2p_get_group_num_members(struct p2p_group *group); | |
1725 | ||
1726 | /** | |
1727 | * p2p_iterate_group_members - Iterate group members | |
1728 | * @group: P2P group context from p2p_group_init() | |
1729 | * @next: iteration pointer, must be a pointer to a void * that is set to %NULL | |
1730 | * on the first call and not modified later | |
1731 | * Returns: A P2P Interface Address for each call and %NULL for no more members | |
1732 | */ | |
1733 | const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next); | |
1734 | ||
c9aab274 JJ |
1735 | /** |
1736 | * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group | |
1737 | * @group: P2P group context from p2p_group_init() | |
1738 | * @addr: P2P Interface Address of the client | |
1739 | * Returns: P2P Device Address of the client if found or %NULL if no match | |
1740 | * found | |
1741 | */ | |
1742 | const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr); | |
1743 | ||
1d277f02 JM |
1744 | /** |
1745 | * p2p_group_is_client_connected - Check whether a specific client is connected | |
1746 | * @group: P2P group context from p2p_group_init() | |
1747 | * @addr: P2P Device Address of the client | |
1748 | * Returns: 1 if client is connected or 0 if not | |
1749 | */ | |
1750 | int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr); | |
1751 | ||
c165d81e JB |
1752 | /** |
1753 | * p2p_get_peer_found - Get P2P peer info structure of a found peer | |
1754 | * @p2p: P2P module context from p2p_init() | |
1755 | * @addr: P2P Device Address of the peer or %NULL to indicate the first peer | |
1756 | * @next: Whether to select the peer entry following the one indicated by addr | |
1757 | * Returns: The first P2P peer info available or %NULL if no such peer exists | |
1758 | */ | |
1759 | const struct p2p_peer_info * | |
1760 | p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next); | |
1761 | ||
f95cac27 JMB |
1762 | /** |
1763 | * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions | |
1764 | * @p2p: P2P module context from p2p_init() | |
1765 | */ | |
1766 | void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p); | |
1767 | ||
1768 | /** | |
1769 | * p2p_add_wps_vendor_extension - Add a WPS vendor extension | |
1770 | * @p2p: P2P module context from p2p_init() | |
1771 | * @vendor_ext: The vendor extensions to add | |
1772 | * Returns: 0 on success, -1 on failure | |
1773 | * | |
1774 | * The wpabuf structures in the array are owned by the P2P | |
1775 | * module after this call. | |
1776 | */ | |
1777 | int p2p_add_wps_vendor_extension(struct p2p_data *p2p, | |
1778 | const struct wpabuf *vendor_ext); | |
1779 | ||
2463ba70 JS |
1780 | /** |
1781 | * p2p_set_oper_channel - Set the P2P operating channel | |
1782 | * @p2p: P2P module context from p2p_init() | |
1783 | * @op_reg_class: Operating regulatory class to set | |
1784 | * @op_channel: operating channel to set | |
1785 | * @cfg_op_channel : Whether op_channel is hardcoded in configuration | |
1786 | * Returns: 0 on success, -1 on failure | |
1787 | */ | |
1788 | int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel, | |
1789 | int cfg_op_channel); | |
1790 | ||
21d996f7 JM |
1791 | /** |
1792 | * p2p_set_pref_chan - Set P2P preferred channel list | |
1793 | * @p2p: P2P module context from p2p_init() | |
1794 | * @num_pref_chan: Number of entries in pref_chan list | |
1795 | * @pref_chan: Preferred channels or %NULL to remove preferences | |
1796 | * Returns: 0 on success, -1 on failure | |
1797 | */ | |
1798 | int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan, | |
1799 | const struct p2p_channel *pref_chan); | |
1800 | ||
556b30da JM |
1801 | /** |
1802 | * p2p_set_no_go_freq - Set no GO channel ranges | |
1803 | * @p2p: P2P module context from p2p_init() | |
1804 | * @list: Channel ranges or %NULL to remove restriction | |
1805 | * Returns: 0 on success, -1 on failure | |
1806 | */ | |
1807 | int p2p_set_no_go_freq(struct p2p_data *p2p, | |
1808 | const struct wpa_freq_range_list *list); | |
1809 | ||
303f60d3 JM |
1810 | /** |
1811 | * p2p_in_progress - Check whether a P2P operation is progress | |
1812 | * @p2p: P2P module context from p2p_init() | |
1813 | * Returns: 0 if P2P module is idle or 1 if an operation is in progress | |
1814 | */ | |
1815 | int p2p_in_progress(struct p2p_data *p2p); | |
1816 | ||
39185dfa JM |
1817 | /** |
1818 | * p2p_other_scan_completed - Notify completion of non-P2P scan | |
1819 | * @p2p: P2P module context from p2p_init() | |
1820 | * Returns: 0 if P2P module is idle or 1 if an operation was started | |
1821 | */ | |
1822 | int p2p_other_scan_completed(struct p2p_data *p2p); | |
1823 | ||
e5a359cf RC |
1824 | const char * p2p_wps_method_text(enum p2p_wps_method method); |
1825 | ||
4f219667 JM |
1826 | /** |
1827 | * p2p_set_config_timeout - Set local config timeouts | |
1828 | * @p2p: P2P module context from p2p_init() | |
1829 | * @go_timeout: Time in 10 ms units it takes to start the GO mode | |
1830 | * @client_timeout: Time in 10 ms units it takes to start the client mode | |
1831 | */ | |
1832 | void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout, | |
1833 | u8 client_timeout); | |
1834 | ||
99fcd404 JM |
1835 | void p2p_increase_search_delay(struct p2p_data *p2p, unsigned int delay); |
1836 | ||
9675ce35 JM |
1837 | int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie); |
1838 | int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie); | |
1839 | int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie); | |
1840 | int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie); | |
1841 | int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie); | |
1842 | int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie); | |
1843 | int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie); | |
1844 | int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie); | |
1845 | int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem); | |
1846 | int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem); | |
1847 | int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p, | |
1848 | const struct wpabuf *elem); | |
1849 | struct wpabuf * wifi_display_encaps(struct wpabuf *subelems); | |
1850 | ||
96beff11 JM |
1851 | /** |
1852 | * p2p_set_disc_int - Set min/max discoverable interval for p2p_find | |
1853 | * @p2p: P2P module context from p2p_init() | |
1854 | * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1 | |
1855 | * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3 | |
1856 | * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or | |
1857 | * -1 not to limit | |
1858 | * Returns: 0 on success, or -1 on failure | |
1859 | * | |
1860 | * This function can be used to configure minDiscoverableInterval and | |
1861 | * maxDiscoverableInterval parameters for the Listen state during device | |
1862 | * discovery (p2p_find). A random number of 100 TU units is picked for each | |
1863 | * Listen state iteration from [min_disc_int,max_disc_int] range. | |
1864 | * | |
1865 | * max_disc_tu can be used to futher limit the discoverable duration. However, | |
1866 | * it should be noted that use of this parameter is not recommended since it | |
1867 | * would not be compliant with the P2P specification. | |
1868 | */ | |
1869 | int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int, | |
1870 | int max_disc_tu); | |
1871 | ||
4c559019 JM |
1872 | /** |
1873 | * p2p_get_state_txt - Get current P2P state for debug purposes | |
1874 | * @p2p: P2P module context from p2p_init() | |
1875 | * Returns: Name of the current P2P module state | |
1876 | * | |
1877 | * It should be noted that the P2P module state names are internal information | |
1878 | * and subject to change at any point, i.e., this information should be used | |
1879 | * mainly for debugging purposes. | |
1880 | */ | |
1881 | const char * p2p_get_state_txt(struct p2p_data *p2p); | |
1882 | ||
b22128ef | 1883 | #endif /* P2P_H */ |