OSDN Git Service

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