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