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