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