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