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