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