P2P: Allow all channels with multi-channel concurrency
[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 /**
13  * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
14  */
15 #define P2P_MAX_REG_CLASSES 10
16
17 /**
18  * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
19  */
20 #define P2P_MAX_REG_CLASS_CHANNELS 20
21
22 /**
23  * struct p2p_channels - List of supported channels
24  */
25 struct p2p_channels {
26         /**
27          * struct p2p_reg_class - Supported regulatory class
28          */
29         struct p2p_reg_class {
30                 /**
31                  * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
32                  */
33                 u8 reg_class;
34
35                 /**
36                  * channel - Supported channels
37                  */
38                 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
39
40                 /**
41                  * channels - Number of channel entries in use
42                  */
43                 size_t channels;
44         } reg_class[P2P_MAX_REG_CLASSES];
45
46         /**
47          * reg_classes - Number of reg_class entries in use
48          */
49         size_t reg_classes;
50 };
51
52 enum p2p_wps_method {
53         WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
54 };
55
56 /**
57  * struct p2p_go_neg_results - P2P Group Owner Negotiation results
58  */
59 struct p2p_go_neg_results {
60         /**
61          * status - Negotiation result (Status Code)
62          *
63          * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
64          * failed negotiation.
65          */
66         int status;
67
68         /**
69          * role_go - Whether local end is Group Owner
70          */
71         int role_go;
72
73         /**
74          * freq - Frequency of the group operational channel in MHz
75          */
76         int freq;
77
78         int ht40;
79
80         /**
81          * ssid - SSID of the group
82          */
83         u8 ssid[32];
84
85         /**
86          * ssid_len - Length of SSID in octets
87          */
88         size_t ssid_len;
89
90         /**
91          * passphrase - WPA2-Personal passphrase for the group (GO only)
92          */
93         char passphrase[64];
94
95         /**
96          * peer_device_addr - P2P Device Address of the peer
97          */
98         u8 peer_device_addr[ETH_ALEN];
99
100         /**
101          * peer_interface_addr - P2P Interface Address of the peer
102          */
103         u8 peer_interface_addr[ETH_ALEN];
104
105         /**
106          * wps_method - WPS method to be used during provisioning
107          */
108         enum p2p_wps_method wps_method;
109
110 #define P2P_MAX_CHANNELS 50
111
112         /**
113          * freq_list - Zero-terminated list of possible operational channels
114          */
115         int freq_list[P2P_MAX_CHANNELS];
116
117         /**
118          * persistent_group - Whether the group should be made persistent
119          * 0 = not persistent
120          * 1 = persistent group without persistent reconnect
121          * 2 = persistent group with persistent reconnect
122          */
123         int persistent_group;
124
125         /**
126          * peer_config_timeout - Peer configuration timeout (in 10 msec units)
127          */
128         unsigned int peer_config_timeout;
129 };
130
131 struct p2p_data;
132
133 enum p2p_scan_type {
134         P2P_SCAN_SOCIAL,
135         P2P_SCAN_FULL,
136         P2P_SCAN_SOCIAL_PLUS_ONE
137 };
138
139 #define P2P_MAX_WPS_VENDOR_EXT 10
140
141 /**
142  * struct p2p_peer_info - P2P peer information
143  */
144 struct p2p_peer_info {
145         /**
146          * p2p_device_addr - P2P Device Address of the peer
147          */
148         u8 p2p_device_addr[ETH_ALEN];
149
150         /**
151          * pri_dev_type - Primary Device Type
152          */
153         u8 pri_dev_type[8];
154
155         /**
156          * device_name - Device Name (0..32 octets encoded in UTF-8)
157          */
158         char device_name[33];
159
160         /**
161          * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
162          */
163         char manufacturer[65];
164
165         /**
166          * model_name - Model Name (0..32 octets encoded in UTF-8)
167          */
168         char model_name[33];
169
170         /**
171          * model_number - Model Number (0..32 octets encoded in UTF-8)
172          */
173         char model_number[33];
174
175         /**
176          * serial_number - Serial Number (0..32 octets encoded in UTF-8)
177          */
178         char serial_number[33];
179
180         /**
181          * level - Signal level
182          */
183         int level;
184
185         /**
186          * config_methods - WPS Configuration Methods
187          */
188         u16 config_methods;
189
190         /**
191          * dev_capab - Device Capabilities
192          */
193         u8 dev_capab;
194
195         /**
196          * group_capab - Group Capabilities
197          */
198         u8 group_capab;
199
200         /**
201          * wps_sec_dev_type_list - WPS secondary device type list
202          *
203          * This list includes from 0 to 16 Secondary Device Types as indicated
204          * by wps_sec_dev_type_list_len (8 * number of types).
205          */
206         u8 wps_sec_dev_type_list[128];
207
208         /**
209          * wps_sec_dev_type_list_len - Length of secondary device type list
210          */
211         size_t wps_sec_dev_type_list_len;
212
213         struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
214
215         /**
216          * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
217          */
218         struct wpabuf *wfd_subelems;
219 };
220
221 enum p2p_prov_disc_status {
222         P2P_PROV_DISC_SUCCESS,
223         P2P_PROV_DISC_TIMEOUT,
224         P2P_PROV_DISC_REJECTED,
225 };
226
227 struct p2p_channel {
228         u8 op_class;
229         u8 chan;
230 };
231
232 /**
233  * struct p2p_config - P2P configuration
234  *
235  * This configuration is provided to the P2P module during initialization with
236  * p2p_init().
237  */
238 struct p2p_config {
239         /**
240          * country - Country code to use in P2P operations
241          */
242         char country[3];
243
244         /**
245          * reg_class - Regulatory class for own listen channel
246          */
247         u8 reg_class;
248
249         /**
250          * channel - Own listen channel
251          */
252         u8 channel;
253
254         /**
255          * Regulatory class for own operational channel
256          */
257         u8 op_reg_class;
258
259         /**
260          * op_channel - Own operational channel
261          */
262         u8 op_channel;
263
264         /**
265          * cfg_op_channel - Whether op_channel is hardcoded in configuration
266          */
267         u8 cfg_op_channel;
268
269         /**
270          * channels - Own supported regulatory classes and channels
271          *
272          * List of supposerted channels per regulatory class. The regulatory
273          * classes are defined in IEEE Std 802.11-2007 Annex J and the
274          * numbering of the clases depends on the configured country code.
275          */
276         struct p2p_channels channels;
277
278         /**
279          * num_pref_chan - Number of pref_chan entries
280          */
281         unsigned int num_pref_chan;
282
283         /**
284          * pref_chan - Preferred channels for GO Negotiation
285          */
286         struct p2p_channel *pref_chan;
287
288         /**
289          * pri_dev_type - Primary Device Type (see WPS)
290          */
291         u8 pri_dev_type[8];
292
293         /**
294          * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
295          */
296 #define P2P_SEC_DEVICE_TYPES 5
297
298         /**
299          * sec_dev_type - Optional secondary device types
300          */
301         u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
302
303         /**
304          * num_sec_dev_types - Number of sec_dev_type entries
305          */
306         size_t num_sec_dev_types;
307
308         /**
309          * dev_addr - P2P Device Address
310          */
311         u8 dev_addr[ETH_ALEN];
312
313         /**
314          * dev_name - Device Name
315          */
316         char *dev_name;
317
318         char *manufacturer;
319         char *model_name;
320         char *model_number;
321         char *serial_number;
322
323         u8 uuid[16];
324         u16 config_methods;
325
326         /**
327          * concurrent_operations - Whether concurrent operations are supported
328          */
329         int concurrent_operations;
330
331         /**
332          * max_peers - Maximum number of discovered peers to remember
333          *
334          * If more peers are discovered, older entries will be removed to make
335          * room for the new ones.
336          */
337         size_t max_peers;
338
339         /**
340          * p2p_intra_bss - Intra BSS communication is supported
341          */
342         int p2p_intra_bss;
343
344         /**
345          * ssid_postfix - Postfix data to add to the SSID
346          *
347          * This data will be added to the end of the SSID after the
348          * DIRECT-<random two octets> prefix.
349          */
350         u8 ssid_postfix[32 - 9];
351
352         /**
353          * ssid_postfix_len - Length of the ssid_postfix data
354          */
355         size_t ssid_postfix_len;
356
357         /**
358          * msg_ctx - Context to use with wpa_msg() calls
359          */
360         void *msg_ctx;
361
362         /**
363          * cb_ctx - Context to use with callback functions
364          */
365         void *cb_ctx;
366
367
368         /* Callbacks to request lower layer driver operations */
369
370         /**
371          * p2p_scan - Request a P2P scan/search
372          * @ctx: Callback context from cb_ctx
373          * @type: Scan type
374          * @freq: Specific frequency (MHz) to scan or 0 for no restriction
375          * @num_req_dev_types: Number of requested device types
376          * @req_dev_types: Array containing requested device types
377          * @dev_id: Device ID to search for or %NULL to find all devices
378          * @pw_id: Device Password ID
379          * Returns: 0 on success, -1 on failure
380          *
381          * This callback function is used to request a P2P scan or search
382          * operation to be completed. Type type argument specifies which type
383          * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
384          * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
385          * indicates that all channels are to be scanned.
386          * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
387          * plus one extra channel specified by freq.
388          *
389          * The full scan is used for the initial scan to find group owners from
390          * all. The other types are used during search phase scan of the social
391          * channels (with potential variation if the Listen channel of the
392          * target peer is known or if other channels are scanned in steps).
393          *
394          * The scan results are returned after this call by calling
395          * p2p_scan_res_handler() for each scan result that has a P2P IE and
396          * then calling p2p_scan_res_handled() to indicate that all scan
397          * results have been indicated.
398          */
399         int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
400                         unsigned int num_req_dev_types,
401                         const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
402
403         /**
404          * send_probe_resp - Transmit a Probe Response frame
405          * @ctx: Callback context from cb_ctx
406          * @buf: Probe Response frame (including the header and body)
407          * Returns: 0 on success, -1 on failure
408          *
409          * This function is used to reply to Probe Request frames that were
410          * indicated with a call to p2p_probe_req_rx(). The response is to be
411          * sent on the same channel or to be dropped if the driver is not
412          * anymore listening to Probe Request frames.
413          *
414          * Alternatively, the responsibility for building the Probe Response
415          * frames in Listen state may be in another system component in which
416          * case this function need to be implemented (i.e., the function
417          * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
418          * Response frames in such a case are available from the
419          * start_listen() callback. It should be noted that the received Probe
420          * Request frames must be indicated by calling p2p_probe_req_rx() even
421          * if this send_probe_resp() is not used.
422          */
423         int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
424
425         /**
426          * send_action - Transmit an Action frame
427          * @ctx: Callback context from cb_ctx
428          * @freq: Frequency in MHz for the channel on which to transmit
429          * @dst: Destination MAC address (Address 1)
430          * @src: Source MAC address (Address 2)
431          * @bssid: BSSID (Address 3)
432          * @buf: Frame body (starting from Category field)
433          * @len: Length of buf in octets
434          * @wait_time: How many msec to wait for a response frame
435          * Returns: 0 on success, -1 on failure
436          *
437          * The Action frame may not be transmitted immediately and the status
438          * of the transmission must be reported by calling
439          * p2p_send_action_cb() once the frame has either been transmitted or
440          * it has been dropped due to excessive retries or other failure to
441          * transmit.
442          */
443         int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
444                            const u8 *src, const u8 *bssid, const u8 *buf,
445                            size_t len, unsigned int wait_time);
446
447         /**
448          * send_action_done - Notify that Action frame sequence was completed
449          * @ctx: Callback context from cb_ctx
450          *
451          * This function is called when the Action frame sequence that was
452          * started with send_action() has been completed, i.e., when there is
453          * no need to wait for a response from the destination peer anymore.
454          */
455         void (*send_action_done)(void *ctx);
456
457         /**
458          * start_listen - Start Listen state
459          * @ctx: Callback context from cb_ctx
460          * @freq: Frequency of the listen channel in MHz
461          * @duration: Duration for the Listen state in milliseconds
462          * @probe_resp_ie: IE(s) to be added to Probe Response frames
463          * Returns: 0 on success, -1 on failure
464          *
465          * This Listen state may not start immediately since the driver may
466          * have other pending operations to complete first. Once the Listen
467          * state has started, p2p_listen_cb() must be called to notify the P2P
468          * module. Once the Listen state is stopped, p2p_listen_end() must be
469          * called to notify the P2P module that the driver is not in the Listen
470          * state anymore.
471          *
472          * If the send_probe_resp() is not used for generating the response,
473          * the IEs from probe_resp_ie need to be added to the end of the Probe
474          * Response frame body. If send_probe_resp() is used, the probe_resp_ie
475          * information can be ignored.
476          */
477         int (*start_listen)(void *ctx, unsigned int freq,
478                             unsigned int duration,
479                             const struct wpabuf *probe_resp_ie);
480         /**
481          * stop_listen - Stop Listen state
482          * @ctx: Callback context from cb_ctx
483          *
484          * This callback can be used to stop a Listen state operation that was
485          * previously requested with start_listen().
486          */
487         void (*stop_listen)(void *ctx);
488
489         /**
490          * get_noa - Get current Notice of Absence attribute payload
491          * @ctx: Callback context from cb_ctx
492          * @interface_addr: P2P Interface Address of the GO
493          * @buf: Buffer for returning NoA
494          * @buf_len: Buffer length in octets
495          * Returns: Number of octets used in buf, 0 to indicate no NoA is being
496          * advertized, or -1 on failure
497          *
498          * This function is used to fetch the current Notice of Absence
499          * attribute value from GO.
500          */
501         int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
502                        size_t buf_len);
503
504         /* Callbacks to notify events to upper layer management entity */
505
506         /**
507          * dev_found - Notification of a found P2P Device
508          * @ctx: Callback context from cb_ctx
509          * @addr: Source address of the message triggering this notification
510          * @info: P2P peer information
511          * @new_device: Inform if the peer is newly found
512          *
513          * This callback is used to notify that a new P2P Device has been
514          * found. This may happen, e.g., during Search state based on scan
515          * results or during Listen state based on receive Probe Request and
516          * Group Owner Negotiation Request.
517          */
518         void (*dev_found)(void *ctx, const u8 *addr,
519                           const struct p2p_peer_info *info,
520                           int new_device);
521
522         /**
523          * dev_lost - Notification of a lost P2P Device
524          * @ctx: Callback context from cb_ctx
525          * @dev_addr: P2P Device Address of the lost P2P Device
526          *
527          * This callback is used to notify that a P2P Device has been deleted.
528          */
529         void (*dev_lost)(void *ctx, const u8 *dev_addr);
530
531         /**
532          * go_neg_req_rx - Notification of a receive GO Negotiation Request
533          * @ctx: Callback context from cb_ctx
534          * @src: Source address of the message triggering this notification
535          * @dev_passwd_id: WPS Device Password ID
536          *
537          * This callback is used to notify that a P2P Device is requesting
538          * group owner negotiation with us, but we do not have all the
539          * necessary information to start GO Negotiation. This indicates that
540          * the local user has not authorized the connection yet by providing a
541          * PIN or PBC button press. This information can be provided with a
542          * call to p2p_connect().
543          */
544         void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
545
546         /**
547          * go_neg_completed - Notification of GO Negotiation results
548          * @ctx: Callback context from cb_ctx
549          * @res: GO Negotiation results
550          *
551          * This callback is used to notify that Group Owner Negotiation has
552          * been completed. Non-zero struct p2p_go_neg_results::status indicates
553          * failed negotiation. In case of success, this function is responsible
554          * for creating a new group interface (or using the existing interface
555          * depending on driver features), setting up the group interface in
556          * proper mode based on struct p2p_go_neg_results::role_go and
557          * initializing WPS provisioning either as a Registrar (if GO) or as an
558          * Enrollee. Successful WPS provisioning must be indicated by calling
559          * p2p_wps_success_cb(). The callee is responsible for timing out group
560          * formation if WPS provisioning cannot be completed successfully
561          * within 15 seconds.
562          */
563         void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
564
565         /**
566          * sd_request - Callback on Service Discovery Request
567          * @ctx: Callback context from cb_ctx
568          * @freq: Frequency (in MHz) of the channel
569          * @sa: Source address of the request
570          * @dialog_token: Dialog token
571          * @update_indic: Service Update Indicator from the source of request
572          * @tlvs: P2P Service Request TLV(s)
573          * @tlvs_len: Length of tlvs buffer in octets
574          *
575          * This callback is used to indicate reception of a service discovery
576          * request. Response to the query must be indicated by calling
577          * p2p_sd_response() with the context information from the arguments to
578          * this callback function.
579          *
580          * This callback handler can be set to %NULL to indicate that service
581          * discovery is not supported.
582          */
583         void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
584                            u16 update_indic, const u8 *tlvs, size_t tlvs_len);
585
586         /**
587          * sd_response - Callback on Service Discovery Response
588          * @ctx: Callback context from cb_ctx
589          * @sa: Source address of the request
590          * @update_indic: Service Update Indicator from the source of response
591          * @tlvs: P2P Service Response TLV(s)
592          * @tlvs_len: Length of tlvs buffer in octets
593          *
594          * This callback is used to indicate reception of a service discovery
595          * response. This callback handler can be set to %NULL if no service
596          * discovery requests are used. The information provided with this call
597          * is replies to the queries scheduled with p2p_sd_request().
598          */
599         void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
600                             const u8 *tlvs, size_t tlvs_len);
601
602         /**
603          * prov_disc_req - Callback on Provisiong Discovery Request
604          * @ctx: Callback context from cb_ctx
605          * @peer: Source address of the request
606          * @config_methods: Requested WPS Config Method
607          * @dev_addr: P2P Device Address of the found P2P Device
608          * @pri_dev_type: Primary Device Type
609          * @dev_name: Device Name
610          * @supp_config_methods: Supported configuration Methods
611          * @dev_capab: Device Capabilities
612          * @group_capab: Group Capabilities
613          * @group_id: P2P Group ID (or %NULL if not included)
614          * @group_id_len: Length of P2P Group ID
615          *
616          * This callback is used to indicate reception of a Provision Discovery
617          * Request frame that the P2P module accepted.
618          */
619         void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
620                               const u8 *dev_addr, const u8 *pri_dev_type,
621                               const char *dev_name, u16 supp_config_methods,
622                               u8 dev_capab, u8 group_capab,
623                               const u8 *group_id, size_t group_id_len);
624
625         /**
626          * prov_disc_resp - Callback on Provisiong Discovery Response
627          * @ctx: Callback context from cb_ctx
628          * @peer: Source address of the response
629          * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
630          *
631          * This callback is used to indicate reception of a Provision Discovery
632          * Response frame for a pending request scheduled with
633          * p2p_prov_disc_req(). This callback handler can be set to %NULL if
634          * provision discovery is not used.
635          */
636         void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
637
638         /**
639          * prov_disc_fail - Callback on Provision Discovery failure
640          * @ctx: Callback context from cb_ctx
641          * @peer: Source address of the response
642          * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
643          *
644          * This callback is used to indicate either a failure or no response
645          * to an earlier provision discovery request.
646          *
647          * This callback handler can be set to %NULL if provision discovery
648          * is not used or failures do not need to be indicated.
649          */
650         void (*prov_disc_fail)(void *ctx, const u8 *peer,
651                                enum p2p_prov_disc_status status);
652
653         /**
654          * invitation_process - Optional callback for processing Invitations
655          * @ctx: Callback context from cb_ctx
656          * @sa: Source address of the Invitation Request
657          * @bssid: P2P Group BSSID from the request or %NULL if not included
658          * @go_dev_addr: GO Device Address from P2P Group ID
659          * @ssid: SSID from P2P Group ID
660          * @ssid_len: Length of ssid buffer in octets
661          * @go: Variable for returning whether the local end is GO in the group
662          * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
663          * @force_freq: Variable for returning forced frequency for the group
664          * @persistent_group: Whether this is an invitation to reinvoke a
665          *      persistent group (instead of invitation to join an active
666          *      group)
667          * Returns: Status code (P2P_SC_*)
668          *
669          * This optional callback can be used to implement persistent reconnect
670          * by allowing automatic restarting of persistent groups without user
671          * interaction. If this callback is not implemented (i.e., is %NULL),
672          * the received Invitation Request frames are replied with
673          * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
674          * invitation_result() callback.
675          *
676          * If the requested parameters are acceptable and the group is known,
677          * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
678          * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
679          * can be returned if there is not enough data to provide immediate
680          * response, i.e., if some sort of user interaction is needed. The
681          * invitation_received() callback will be called in that case
682          * immediately after this call.
683          */
684         u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
685                                  const u8 *go_dev_addr, const u8 *ssid,
686                                  size_t ssid_len, int *go, u8 *group_bssid,
687                                  int *force_freq, int persistent_group);
688
689         /**
690          * invitation_received - Callback on Invitation Request RX
691          * @ctx: Callback context from cb_ctx
692          * @sa: Source address of the Invitation Request
693          * @bssid: P2P Group BSSID or %NULL if not received
694          * @ssid: SSID of the group
695          * @ssid_len: Length of ssid in octets
696          * @go_dev_addr: GO Device Address
697          * @status: Response Status
698          * @op_freq: Operational frequency for the group
699          *
700          * This callback is used to indicate sending of an Invitation Response
701          * for a received Invitation Request. If status == 0 (success), the
702          * upper layer code is responsible for starting the group. status == 1
703          * indicates need to get user authorization for the group. Other status
704          * values indicate that the invitation request was rejected.
705          */
706         void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
707                                     const u8 *ssid, size_t ssid_len,
708                                     const u8 *go_dev_addr, u8 status,
709                                     int op_freq);
710
711         /**
712          * invitation_result - Callback on Invitation result
713          * @ctx: Callback context from cb_ctx
714          * @status: Negotiation result (Status Code)
715          * @bssid: P2P Group BSSID or %NULL if not received
716          *
717          * This callback is used to indicate result of an Invitation procedure
718          * started with a call to p2p_invite(). The indicated status code is
719          * the value received from the peer in Invitation Response with 0
720          * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
721          * local failure in transmitting the Invitation Request.
722          */
723         void (*invitation_result)(void *ctx, int status, const u8 *bssid);
724
725         /**
726          * go_connected - Check whether we are connected to a GO
727          * @ctx: Callback context from cb_ctx
728          * @dev_addr: P2P Device Address of a GO
729          * Returns: 1 if we are connected as a P2P client to the specified GO
730          * or 0 if not.
731          */
732         int (*go_connected)(void *ctx, const u8 *dev_addr);
733 };
734
735
736 /* P2P module initialization/deinitialization */
737
738 /**
739  * p2p_init - Initialize P2P module
740  * @cfg: P2P module configuration
741  * Returns: Pointer to private data or %NULL on failure
742  *
743  * This function is used to initialize global P2P module context (one per
744  * device). The P2P module will keep a copy of the configuration data, so the
745  * caller does not need to maintain this structure. However, the callback
746  * functions and the context parameters to them must be kept available until
747  * the P2P module is deinitialized with p2p_deinit().
748  */
749 struct p2p_data * p2p_init(const struct p2p_config *cfg);
750
751 /**
752  * p2p_deinit - Deinitialize P2P module
753  * @p2p: P2P module context from p2p_init()
754  */
755 void p2p_deinit(struct p2p_data *p2p);
756
757 /**
758  * p2p_flush - Flush P2P module state
759  * @p2p: P2P module context from p2p_init()
760  *
761  * This command removes the P2P module state like peer device entries.
762  */
763 void p2p_flush(struct p2p_data *p2p);
764
765 /**
766  * p2p_unauthorize - Unauthorize the specified peer device
767  * @p2p: P2P module context from p2p_init()
768  * @addr: P2P peer entry to be unauthorized
769  * Returns: 0 on success, -1 on failure
770  *
771  * This command removes any connection authorization from the specified P2P
772  * peer device address. This can be used, e.g., to cancel effect of a previous
773  * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
774  * GO Negotiation.
775  */
776 int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
777
778 /**
779  * p2p_set_dev_name - Set device name
780  * @p2p: P2P module context from p2p_init()
781  * Returns: 0 on success, -1 on failure
782  *
783  * This function can be used to update the P2P module configuration with
784  * information that was not available at the time of the p2p_init() call.
785  */
786 int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
787
788 int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
789 int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
790 int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
791 int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
792
793 void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
794 void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
795
796 /**
797  * p2p_set_pri_dev_type - Set primary device type
798  * @p2p: P2P module context from p2p_init()
799  * Returns: 0 on success, -1 on failure
800  *
801  * This function can be used to update the P2P module configuration with
802  * information that was not available at the time of the p2p_init() call.
803  */
804 int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
805
806 /**
807  * p2p_set_sec_dev_types - Set secondary device types
808  * @p2p: P2P module context from p2p_init()
809  * Returns: 0 on success, -1 on failure
810  *
811  * This function can be used to update the P2P module configuration with
812  * information that was not available at the time of the p2p_init() call.
813  */
814 int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
815                           size_t num_dev_types);
816
817 int p2p_set_country(struct p2p_data *p2p, const char *country);
818
819
820 /* Commands from upper layer management entity */
821
822 enum p2p_discovery_type {
823         P2P_FIND_START_WITH_FULL,
824         P2P_FIND_ONLY_SOCIAL,
825         P2P_FIND_PROGRESSIVE
826 };
827
828 /**
829  * p2p_find - Start P2P Find (Device Discovery)
830  * @p2p: P2P module context from p2p_init()
831  * @timeout: Timeout for find operation in seconds or 0 for no timeout
832  * @type: Device Discovery type
833  * @num_req_dev_types: Number of requested device types
834  * @req_dev_types: Requested device types array, must be an array
835  *      containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
836  *      requested device types.
837  * @dev_id: Device ID to search for or %NULL to find all devices
838  * @search_delay: Extra delay in milliseconds between search iterations
839  * Returns: 0 on success, -1 on failure
840  */
841 int p2p_find(struct p2p_data *p2p, unsigned int timeout,
842              enum p2p_discovery_type type,
843              unsigned int num_req_dev_types, const u8 *req_dev_types,
844              const u8 *dev_id, unsigned int search_delay);
845
846 /**
847  * p2p_stop_find - Stop P2P Find (Device Discovery)
848  * @p2p: P2P module context from p2p_init()
849  */
850 void p2p_stop_find(struct p2p_data *p2p);
851
852 /**
853  * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
854  * @p2p: P2P module context from p2p_init()
855  * @freq: Frequency in MHz for next operation
856  *
857  * This is like p2p_stop_find(), but Listen state is not stopped if we are
858  * already on the same frequency.
859  */
860 void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
861
862 /**
863  * p2p_listen - Start P2P Listen state for specified duration
864  * @p2p: P2P module context from p2p_init()
865  * @timeout: Listen state duration in milliseconds
866  * Returns: 0 on success, -1 on failure
867  *
868  * This function can be used to request the P2P module to keep the device
869  * discoverable on the listen channel for an extended set of time. At least in
870  * its current form, this is mainly used for testing purposes and may not be of
871  * much use for normal P2P operations.
872  */
873 int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
874
875 /**
876  * p2p_connect - Start P2P group formation (GO negotiation)
877  * @p2p: P2P module context from p2p_init()
878  * @peer_addr: MAC address of the peer P2P client
879  * @wps_method: WPS method to be used in provisioning
880  * @go_intent: Local GO intent value (1..15)
881  * @own_interface_addr: Intended interface address to use with the group
882  * @force_freq: The only allowed channel frequency in MHz or 0
883  * @persistent_group: Whether to create a persistent group (0 = no, 1 =
884  * persistent group without persistent reconnect, 2 = persistent group with
885  * persistent reconnect)
886  * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
887  *      a new SSID
888  * @force_ssid_len: Length of $force_ssid buffer
889  * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
890  *      Negotiation as an interoperability workaround when initiating group
891  *      formation
892  * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
893  *      force_freq == 0)
894  * Returns: 0 on success, -1 on failure
895  */
896 int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
897                 enum p2p_wps_method wps_method,
898                 int go_intent, const u8 *own_interface_addr,
899                 unsigned int force_freq, int persistent_group,
900                 const u8 *force_ssid, size_t force_ssid_len,
901                 int pd_before_go_neg, unsigned int pref_freq);
902
903 /**
904  * p2p_authorize - Authorize P2P group formation (GO negotiation)
905  * @p2p: P2P module context from p2p_init()
906  * @peer_addr: MAC address of the peer P2P client
907  * @wps_method: WPS method to be used in provisioning
908  * @go_intent: Local GO intent value (1..15)
909  * @own_interface_addr: Intended interface address to use with the group
910  * @force_freq: The only allowed channel frequency in MHz or 0
911  * @persistent_group: Whether to create a persistent group (0 = no, 1 =
912  * persistent group without persistent reconnect, 2 = persistent group with
913  * persistent reconnect)
914  * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
915  *      a new SSID
916  * @force_ssid_len: Length of $force_ssid buffer
917  * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
918  *      force_freq == 0)
919  * Returns: 0 on success, -1 on failure
920  *
921  * This is like p2p_connect(), but the actual group negotiation is not
922  * initiated automatically, i.e., the other end is expected to do that.
923  */
924 int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
925                   enum p2p_wps_method wps_method,
926                   int go_intent, const u8 *own_interface_addr,
927                   unsigned int force_freq, int persistent_group,
928                   const u8 *force_ssid, size_t force_ssid_len,
929                   unsigned int pref_freq);
930
931 /**
932  * p2p_reject - Reject peer device (explicitly block connection attempts)
933  * @p2p: P2P module context from p2p_init()
934  * @peer_addr: MAC address of the peer P2P client
935  * Returns: 0 on success, -1 on failure
936  */
937 int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
938
939 /**
940  * p2p_prov_disc_req - Send Provision Discovery Request
941  * @p2p: P2P module context from p2p_init()
942  * @peer_addr: MAC address of the peer P2P client
943  * @config_methods: WPS Config Methods value (only one bit set)
944  * @join: Whether this is used by a client joining an active group
945  * @force_freq: Forced TX frequency for the frame (mainly for the join case)
946  * Returns: 0 on success, -1 on failure
947  *
948  * This function can be used to request a discovered P2P peer to display a PIN
949  * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
950  * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
951  * is transmitted once immediately and if no response is received, the frame
952  * will be sent again whenever the target device is discovered during device
953  * dsicovery (start with a p2p_find() call). Response from the peer is
954  * indicated with the p2p_config::prov_disc_resp() callback.
955  */
956 int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
957                       u16 config_methods, int join, int force_freq);
958
959 /**
960  * p2p_sd_request - Schedule a service discovery query
961  * @p2p: P2P module context from p2p_init()
962  * @dst: Destination peer or %NULL to apply for all peers
963  * @tlvs: P2P Service Query TLV(s)
964  * Returns: Reference to the query or %NULL on failure
965  *
966  * Response to the query is indicated with the p2p_config::sd_response()
967  * callback.
968  */
969 void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
970                       const struct wpabuf *tlvs);
971
972 #ifdef CONFIG_WIFI_DISPLAY
973 void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
974                           const struct wpabuf *tlvs);
975 #endif /* CONFIG_WIFI_DISPLAY */
976
977 /**
978  * p2p_sd_cancel_request - Cancel a pending service discovery query
979  * @p2p: P2P module context from p2p_init()
980  * @req: Query reference from p2p_sd_request()
981  * Returns: 0 if request for cancelled; -1 if not found
982  */
983 int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
984
985 /**
986  * p2p_sd_response - Send response to a service discovery query
987  * @p2p: P2P module context from p2p_init()
988  * @freq: Frequency from p2p_config::sd_request() callback
989  * @dst: Destination address from p2p_config::sd_request() callback
990  * @dialog_token: Dialog token from p2p_config::sd_request() callback
991  * @resp_tlvs: P2P Service Response TLV(s)
992  *
993  * This function is called as a response to the request indicated with
994  * p2p_config::sd_request() callback.
995  */
996 void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
997                      u8 dialog_token, const struct wpabuf *resp_tlvs);
998
999 /**
1000  * p2p_sd_service_update - Indicate a change in local services
1001  * @p2p: P2P module context from p2p_init()
1002  *
1003  * This function needs to be called whenever there is a change in availability
1004  * of the local services. This will increment the Service Update Indicator
1005  * value which will be used in SD Request and Response frames.
1006  */
1007 void p2p_sd_service_update(struct p2p_data *p2p);
1008
1009
1010 enum p2p_invite_role {
1011         P2P_INVITE_ROLE_GO,
1012         P2P_INVITE_ROLE_ACTIVE_GO,
1013         P2P_INVITE_ROLE_CLIENT
1014 };
1015
1016 /**
1017  * p2p_invite - Invite a P2P Device into a group
1018  * @p2p: P2P module context from p2p_init()
1019  * @peer: Device Address of the peer P2P Device
1020  * @role: Local role in the group
1021  * @bssid: Group BSSID or %NULL if not known
1022  * @ssid: Group SSID
1023  * @ssid_len: Length of ssid in octets
1024  * @force_freq: The only allowed channel frequency in MHz or 0
1025  * @go_dev_addr: Forced GO Device Address or %NULL if none
1026  * @persistent_group: Whether this is to reinvoke a persistent group
1027  * Returns: 0 on success, -1 on failure
1028  */
1029 int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1030                const u8 *bssid, const u8 *ssid, size_t ssid_len,
1031                unsigned int force_freq, const u8 *go_dev_addr,
1032                int persistent_group);
1033
1034 /**
1035  * p2p_presence_req - Request GO presence
1036  * @p2p: P2P module context from p2p_init()
1037  * @go_interface_addr: GO P2P Interface Address
1038  * @own_interface_addr: Own P2P Interface Address for this group
1039  * @freq: Group operating frequence (in MHz)
1040  * @duration1: Preferred presence duration in microseconds
1041  * @interval1: Preferred presence interval in microseconds
1042  * @duration2: Acceptable presence duration in microseconds
1043  * @interval2: Acceptable presence interval in microseconds
1044  * Returns: 0 on success, -1 on failure
1045  *
1046  * If both duration and interval values are zero, the parameter pair is not
1047  * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1048  */
1049 int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1050                      const u8 *own_interface_addr, unsigned int freq,
1051                      u32 duration1, u32 interval1, u32 duration2,
1052                      u32 interval2);
1053
1054 /**
1055  * p2p_ext_listen - Set Extended Listen Timing
1056  * @p2p: P2P module context from p2p_init()
1057  * @freq: Group operating frequence (in MHz)
1058  * @period: Availability period in milliseconds (1-65535; 0 to disable)
1059  * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1060  * Returns: 0 on success, -1 on failure
1061  *
1062  * This function can be used to enable or disable (period = interval = 0)
1063  * Extended Listen Timing. When enabled, the P2P Device will become
1064  * discoverable (go into Listen State) every @interval milliseconds for at
1065  * least @period milliseconds.
1066  */
1067 int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1068                    unsigned int interval);
1069
1070 /* Event notifications from upper layer management operations */
1071
1072 /**
1073  * p2p_wps_success_cb - Report successfully completed WPS provisioning
1074  * @p2p: P2P module context from p2p_init()
1075  * @mac_addr: Peer address
1076  *
1077  * This function is used to report successfully completed WPS provisioning
1078  * during group formation in both GO/Registrar and client/Enrollee roles.
1079  */
1080 void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1081
1082 /**
1083  * p2p_group_formation_failed - Report failed WPS provisioning
1084  * @p2p: P2P module context from p2p_init()
1085  *
1086  * This function is used to report failed group formation. This can happen
1087  * either due to failed WPS provisioning or due to 15 second timeout during
1088  * the provisioning phase.
1089  */
1090 void p2p_group_formation_failed(struct p2p_data *p2p);
1091
1092 /**
1093  * p2p_get_provisioning_info - Get any stored provisioning info
1094  * @p2p: P2P module context from p2p_init()
1095  * @addr: Peer P2P Device Address
1096  * Returns: WPS provisioning information (WPS config method) or 0 if no
1097  * information is available
1098  *
1099  * This function is used to retrieve stored WPS provisioning info for the given
1100  * peer.
1101  */
1102 u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1103
1104 /**
1105  * p2p_clear_provisioning_info - Clear any stored provisioning info
1106  * @p2p: P2P module context from p2p_init()
1107  * @iface_addr: Peer P2P Device Address
1108  *
1109  * This function is used to clear stored WPS provisioning info for the given
1110  * peer.
1111  */
1112 void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1113
1114
1115 /* Event notifications from lower layer driver operations */
1116
1117 /**
1118  * enum p2p_probe_req_status
1119  *
1120  * @P2P_PREQ_MALFORMED: frame was not well-formed
1121  * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1122  * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1123  * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1124  * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1125  */
1126 enum p2p_probe_req_status {
1127         P2P_PREQ_MALFORMED,
1128         P2P_PREQ_NOT_LISTEN,
1129         P2P_PREQ_NOT_P2P,
1130         P2P_PREQ_NOT_PROCESSED,
1131         P2P_PREQ_PROCESSED
1132 };
1133
1134 /**
1135  * p2p_probe_req_rx - Report reception of a Probe Request frame
1136  * @p2p: P2P module context from p2p_init()
1137  * @addr: Source MAC address
1138  * @dst: Destination MAC address if available or %NULL
1139  * @bssid: BSSID if available or %NULL
1140  * @ie: Information elements from the Probe Request frame body
1141  * @ie_len: Length of ie buffer in octets
1142  * Returns: value indicating the type and status of the probe request
1143  */
1144 enum p2p_probe_req_status
1145 p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1146                  const u8 *bssid, const u8 *ie, size_t ie_len);
1147
1148 /**
1149  * p2p_rx_action - Report received Action frame
1150  * @p2p: P2P module context from p2p_init()
1151  * @da: Destination address of the received Action frame
1152  * @sa: Source address of the received Action frame
1153  * @bssid: Address 3 of the received Action frame
1154  * @category: Category of the received Action frame
1155  * @data: Action frame body after the Category field
1156  * @len: Length of the data buffer in octets
1157  * @freq: Frequency (in MHz) on which the frame was received
1158  */
1159 void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1160                    const u8 *bssid, u8 category,
1161                    const u8 *data, size_t len, int freq);
1162
1163 /**
1164  * p2p_scan_res_handler - Indicate a P2P scan results
1165  * @p2p: P2P module context from p2p_init()
1166  * @bssid: BSSID of the scan result
1167  * @freq: Frequency of the channel on which the device was found in MHz
1168  * @level: Signal level (signal strength of the received Beacon/Probe Response
1169  *      frame)
1170  * @ies: Pointer to IEs from the scan result
1171  * @ies_len: Length of the ies buffer
1172  * Returns: 0 to continue or 1 to stop scan result indication
1173  *
1174  * This function is called to indicate a scan result entry with P2P IE from a
1175  * scan requested with struct p2p_config::p2p_scan(). This can be called during
1176  * the actual scan process (i.e., whenever a new device is found) or as a
1177  * sequence of calls after the full scan has been completed. The former option
1178  * can result in optimized operations, but may not be supported by all
1179  * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1180  * but it is recommended to include all IEs received from the device. The
1181  * caller does not need to check that the IEs contain a P2P IE before calling
1182  * this function since frames will be filtered internally if needed.
1183  *
1184  * This function will return 1 if it wants to stop scan result iteration (and
1185  * scan in general if it is still in progress). This is used to allow faster
1186  * start of a pending operation, e.g., to start a pending GO negotiation.
1187  */
1188 int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1189                          int level, const u8 *ies, size_t ies_len);
1190
1191 /**
1192  * p2p_scan_res_handled - Indicate end of scan results
1193  * @p2p: P2P module context from p2p_init()
1194  *
1195  * This function is called to indicate that all P2P scan results from a scan
1196  * have been reported with zero or more calls to p2p_scan_res_handler(). This
1197  * function must be called as a response to successful
1198  * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1199  * calls stopped iteration.
1200  */
1201 void p2p_scan_res_handled(struct p2p_data *p2p);
1202
1203 enum p2p_send_action_result {
1204         P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1205         P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1206         P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1207 };
1208
1209 /**
1210  * p2p_send_action_cb - Notify TX status of an Action frame
1211  * @p2p: P2P module context from p2p_init()
1212  * @freq: Channel frequency in MHz
1213  * @dst: Destination MAC address (Address 1)
1214  * @src: Source MAC address (Address 2)
1215  * @bssid: BSSID (Address 3)
1216  * @result: Result of the transmission attempt
1217  *
1218  * This function is used to indicate the result of an Action frame transmission
1219  * that was requested with struct p2p_config::send_action() callback.
1220  */
1221 void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1222                         const u8 *src, const u8 *bssid,
1223                         enum p2p_send_action_result result);
1224
1225 /**
1226  * p2p_listen_cb - Indicate the start of a requested Listen state
1227  * @p2p: P2P module context from p2p_init()
1228  * @freq: Listen channel frequency in MHz
1229  * @duration: Duration for the Listen state in milliseconds
1230  *
1231  * This function is used to indicate that a Listen state requested with
1232  * struct p2p_config::start_listen() callback has started.
1233  */
1234 void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1235                    unsigned int duration);
1236
1237 /**
1238  * p2p_listen_end - Indicate the end of a requested Listen state
1239  * @p2p: P2P module context from p2p_init()
1240  * @freq: Listen channel frequency in MHz
1241  * Returns: 0 if no operations were started, 1 if an operation was started
1242  *
1243  * This function is used to indicate that a Listen state requested with
1244  * struct p2p_config::start_listen() callback has ended.
1245  */
1246 int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1247
1248 void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1249                       const u8 *ie, size_t ie_len);
1250
1251 void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1252                         const u8 *ie, size_t ie_len);
1253
1254
1255 /* Per-group P2P state for GO */
1256
1257 struct p2p_group;
1258
1259 /**
1260  * struct p2p_group_config - P2P group configuration
1261  *
1262  * This configuration is provided to the P2P module during initialization of
1263  * the per-group information with p2p_group_init().
1264  */
1265 struct p2p_group_config {
1266         /**
1267          * persistent_group - Whether the group is persistent
1268          * 0 = not a persistent group
1269          * 1 = persistent group without persistent reconnect
1270          * 2 = persistent group with persistent reconnect
1271          */
1272         int persistent_group;
1273
1274         /**
1275          * interface_addr - P2P Interface Address of the group
1276          */
1277         u8 interface_addr[ETH_ALEN];
1278
1279         /**
1280          * max_clients - Maximum number of clients in the group
1281          */
1282         unsigned int max_clients;
1283
1284         /**
1285          * ssid - Group SSID
1286          */
1287         u8 ssid[32];
1288
1289         /**
1290          * ssid_len - Length of SSID
1291          */
1292         size_t ssid_len;
1293
1294         /**
1295          * cb_ctx - Context to use with callback functions
1296          */
1297         void *cb_ctx;
1298
1299         /**
1300          * ie_update - Notification of IE update
1301          * @ctx: Callback context from cb_ctx
1302          * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1303          * @proberesp_ies: P2P Ie for Probe Response frames
1304          *
1305          * P2P module uses this callback function to notify whenever the P2P IE
1306          * in Beacon or Probe Response frames should be updated based on group
1307          * events.
1308          *
1309          * The callee is responsible for freeing the returned buffer(s) with
1310          * wpabuf_free().
1311          */
1312         void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1313                           struct wpabuf *proberesp_ies);
1314
1315         /**
1316          * idle_update - Notification of changes in group idle state
1317          * @ctx: Callback context from cb_ctx
1318          * @idle: Whether the group is idle (no associated stations)
1319          */
1320         void (*idle_update)(void *ctx, int idle);
1321 };
1322
1323 /**
1324  * p2p_group_init - Initialize P2P group
1325  * @p2p: P2P module context from p2p_init()
1326  * @config: P2P group configuration (will be freed by p2p_group_deinit())
1327  * Returns: Pointer to private data or %NULL on failure
1328  *
1329  * This function is used to initialize per-group P2P module context. Currently,
1330  * this is only used to manage GO functionality and P2P clients do not need to
1331  * create an instance of this per-group information.
1332  */
1333 struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1334                                   struct p2p_group_config *config);
1335
1336 /**
1337  * p2p_group_deinit - Deinitialize P2P group
1338  * @group: P2P group context from p2p_group_init()
1339  */
1340 void p2p_group_deinit(struct p2p_group *group);
1341
1342 /**
1343  * p2p_group_notif_assoc - Notification of P2P client association with GO
1344  * @group: P2P group context from p2p_group_init()
1345  * @addr: Interface address of the P2P client
1346  * @ie: IEs from the (Re)association Request frame
1347  * @len: Length of the ie buffer in octets
1348  * Returns: 0 on success, -1 on failure
1349  */
1350 int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1351                           const u8 *ie, size_t len);
1352
1353 /**
1354  * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1355  * @group: P2P group context from p2p_group_init()
1356  * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1357  * Returns: P2P IE for (Re)association Response or %NULL on failure
1358  *
1359  * The caller is responsible for freeing the returned buffer with
1360  * wpabuf_free().
1361  */
1362 struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1363
1364 /**
1365  * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1366  * @group: P2P group context from p2p_group_init()
1367  * @addr: Interface address of the P2P client
1368  */
1369 void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1370
1371 /**
1372  * p2p_group_notif_formation_done - Notification of completed group formation
1373  * @group: P2P group context from p2p_group_init()
1374  */
1375 void p2p_group_notif_formation_done(struct p2p_group *group);
1376
1377 /**
1378  * p2p_group_notif_noa - Notification of NoA change
1379  * @group: P2P group context from p2p_group_init()
1380  * @noa: Notice of Absence attribute payload, %NULL if none
1381  * @noa_len: Length of noa buffer in octets
1382  * Returns: 0 on success, -1 on failure
1383  *
1384  * Notify the P2P group management about a new NoA contents. This will be
1385  * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1386  * the group information.
1387  */
1388 int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1389                         size_t noa_len);
1390
1391 /**
1392  * p2p_group_match_dev_type - Match device types in group with requested type
1393  * @group: P2P group context from p2p_group_init()
1394  * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1395  * Returns: 1 on match, 0 on mismatch
1396  *
1397  * This function can be used to match the Requested Device Type attribute in
1398  * WPS IE with the device types of a group member for deciding whether a GO
1399  * should reply to a Probe Request frame. Match will be reported if the WPS IE
1400  * is not requested any specific device type.
1401  */
1402 int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1403
1404 /**
1405  * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1406  */
1407 int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1408
1409 /**
1410  * p2p_group_go_discover - Send GO Discoverability Request to a group client
1411  * @group: P2P group context from p2p_group_init()
1412  * Returns: 0 on success (frame scheduled); -1 if client was not found
1413  */
1414 int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1415                           const u8 *searching_dev, int rx_freq);
1416
1417
1418 /* Generic helper functions */
1419
1420 /**
1421  * p2p_ie_text - Build text format description of P2P IE
1422  * @p2p_ie: P2P IE
1423  * @buf: Buffer for returning text
1424  * @end: Pointer to the end of the buf area
1425  * Returns: Number of octets written to the buffer or -1 on failure
1426  *
1427  * This function can be used to parse P2P IE contents into text format
1428  * field=value lines.
1429  */
1430 int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1431
1432 /**
1433  * p2p_scan_result_text - Build text format description of P2P IE
1434  * @ies: Information elements from scan results
1435  * @ies_len: ies buffer length in octets
1436  * @buf: Buffer for returning text
1437  * @end: Pointer to the end of the buf area
1438  * Returns: Number of octets written to the buffer or -1 on failure
1439  *
1440  * This function can be used to parse P2P IE contents into text format
1441  * field=value lines.
1442  */
1443 int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1444
1445 /**
1446  * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1447  * P2P IE
1448  * @p2p_ie: P2P IE
1449  * @dev_addr: Buffer for returning P2P Device Address
1450  * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1451  */
1452 int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1453
1454 /**
1455  * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1456  * @ies: Information elements from scan results
1457  * @ies_len: ies buffer length in octets
1458  * @dev_addr: Buffer for returning P2P Device Address
1459  * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1460  */
1461 int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1462
1463 /**
1464  * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1465  * @p2p: P2P module context from p2p_init()
1466  * @bssid: BSSID
1467  * @buf: Buffer for writing the P2P IE
1468  * @len: Maximum buf length in octets
1469  * @p2p_group: Whether this is for association with a P2P GO
1470  * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1471  * Returns: Number of octets written into buf or -1 on failure
1472  */
1473 int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1474                      size_t len, int p2p_group, struct wpabuf *p2p_ie);
1475
1476 /**
1477  * p2p_scan_ie - Build P2P IE for Probe Request
1478  * @p2p: P2P module context from p2p_init()
1479  * @ies: Buffer for writing P2P IE
1480  * @dev_id: Device ID to search for or %NULL for any
1481  */
1482 void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
1483
1484 /**
1485  * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1486  * @p2p: P2P module context from p2p_init()
1487  * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1488  */
1489 size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1490
1491 /**
1492  * p2p_go_params - Generate random P2P group parameters
1493  * @p2p: P2P module context from p2p_init()
1494  * @params: Buffer for parameters
1495  * Returns: 0 on success, -1 on failure
1496  */
1497 int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1498
1499 /**
1500  * p2p_get_group_capab - Get Group Capability from P2P IE data
1501  * @p2p_ie: P2P IE(s) contents
1502  * Returns: Group Capability
1503  */
1504 u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1505
1506 /**
1507  * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1508  * @p2p_ie: P2P IE(s) contents
1509  * Returns: 0 if cross connection is allow, 1 if not
1510  */
1511 int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1512
1513 /**
1514  * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1515  * @p2p_ie: P2P IE(s) contents
1516  * Returns: Pointer to P2P Device Address or %NULL if not included
1517  */
1518 const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1519
1520 /**
1521  * p2p_get_peer_info - Get P2P peer information
1522  * @p2p: P2P module context from p2p_init()
1523  * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1524  * @next: Whether to select the peer entry following the one indicated by addr
1525  * Returns: Pointer to peer info or %NULL if not found
1526  */
1527 const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1528                                                const u8 *addr, int next);
1529
1530 /**
1531  * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1532  * @info: Pointer to P2P peer info from p2p_get_peer_info()
1533  * @buf: Buffer for returning text
1534  * @buflen: Maximum buffer length
1535  * Returns: Number of octets written to the buffer or -1 on failure
1536  *
1537  * Note: This information is internal to the P2P module and subject to change.
1538  * As such, this should not really be used by external programs for purposes
1539  * other than debugging.
1540  */
1541 int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1542                           char *buf, size_t buflen);
1543
1544 /**
1545  * p2p_peer_known - Check whether P2P peer is known
1546  * @p2p: P2P module context from p2p_init()
1547  * @addr: P2P Device Address of the peer
1548  * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1549  */
1550 int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1551
1552 /**
1553  * p2p_set_client_discoverability - Set client discoverability capability
1554  * @p2p: P2P module context from p2p_init()
1555  * @enabled: Whether client discoverability will be enabled
1556  *
1557  * This function can be used to disable (and re-enable) client discoverability.
1558  * This capability is enabled by default and should not be disabled in normal
1559  * use cases, i.e., this is mainly for testing purposes.
1560  */
1561 void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1562
1563 /**
1564  * p2p_set_managed_oper - Set managed P2P Device operations capability
1565  * @p2p: P2P module context from p2p_init()
1566  * @enabled: Whether managed P2P Device operations will be enabled
1567  */
1568 void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1569
1570 int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
1571
1572 int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1573
1574 int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1575                            u8 *iface_addr);
1576 int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1577                            u8 *dev_addr);
1578
1579 void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1580
1581 /**
1582  * p2p_set_cross_connect - Set cross connection capability
1583  * @p2p: P2P module context from p2p_init()
1584  * @enabled: Whether cross connection will be enabled
1585  */
1586 void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1587
1588 int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1589
1590 /**
1591  * p2p_set_intra_bss_dist - Set intra BSS distribution
1592  * @p2p: P2P module context from p2p_init()
1593  * @enabled: Whether intra BSS distribution will be enabled
1594  */
1595 void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1596
1597 /**
1598  * p2p_supported_freq - Check whether channel is supported for P2P
1599  * @p2p: P2P module context from p2p_init()
1600  * @freq: Channel frequency in MHz
1601  * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1602  */
1603 int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1604
1605 void p2p_update_channel_list(struct p2p_data *p2p, struct p2p_channels *chan);
1606
1607 /**
1608  * p2p_set_best_channels - Update best channel information
1609  * @p2p: P2P module context from p2p_init()
1610  * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1611  * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1612  * @freq_overall: Frequency (MHz) of best channel overall
1613  */
1614 void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1615                            int freq_overall);
1616
1617 const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1618
1619 /**
1620  * p2p_get_group_num_members - Get number of members in group
1621  * @group: P2P group context from p2p_group_init()
1622  * Returns: Number of members in the group
1623  */
1624 unsigned int p2p_get_group_num_members(struct p2p_group *group);
1625
1626 /**
1627  * p2p_iterate_group_members - Iterate group members
1628  * @group: P2P group context from p2p_group_init()
1629  * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1630  *      on the first call and not modified later
1631  * Returns: A P2P Interface Address for each call and %NULL for no more members
1632  */
1633 const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1634
1635 /**
1636  * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1637  * @group: P2P group context from p2p_group_init()
1638  * @addr: P2P Interface Address of the client
1639  * Returns: P2P Device Address of the client if found or %NULL if no match
1640  * found
1641  */
1642 const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1643
1644 /**
1645  * p2p_group_is_client_connected - Check whether a specific client is connected
1646  * @group: P2P group context from p2p_group_init()
1647  * @addr: P2P Device Address of the client
1648  * Returns: 1 if client is connected or 0 if not
1649  */
1650 int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1651
1652 /**
1653  * p2p_get_peer_found - Get P2P peer info structure of a found peer
1654  * @p2p: P2P module context from p2p_init()
1655  * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1656  * @next: Whether to select the peer entry following the one indicated by addr
1657  * Returns: The first P2P peer info available or %NULL if no such peer exists
1658  */
1659 const struct p2p_peer_info *
1660 p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1661
1662 /**
1663  * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1664  * @p2p: P2P module context from p2p_init()
1665  */
1666 void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1667
1668 /**
1669  * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1670  * @p2p: P2P module context from p2p_init()
1671  * @vendor_ext: The vendor extensions to add
1672  * Returns: 0 on success, -1 on failure
1673  *
1674  * The wpabuf structures in the array are owned by the P2P
1675  * module after this call.
1676  */
1677 int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1678                                  const struct wpabuf *vendor_ext);
1679
1680 /**
1681  * p2p_set_oper_channel - Set the P2P operating channel
1682  * @p2p: P2P module context from p2p_init()
1683  * @op_reg_class: Operating regulatory class to set
1684  * @op_channel: operating channel to set
1685  * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1686  * Returns: 0 on success, -1 on failure
1687  */
1688 int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1689                          int cfg_op_channel);
1690
1691 /**
1692  * p2p_set_pref_chan - Set P2P preferred channel list
1693  * @p2p: P2P module context from p2p_init()
1694  * @num_pref_chan: Number of entries in pref_chan list
1695  * @pref_chan: Preferred channels or %NULL to remove preferences
1696  * Returns: 0 on success, -1 on failure
1697  */
1698 int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1699                       const struct p2p_channel *pref_chan);
1700
1701 /**
1702  * p2p_in_progress - Check whether a P2P operation is progress
1703  * @p2p: P2P module context from p2p_init()
1704  * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1705  */
1706 int p2p_in_progress(struct p2p_data *p2p);
1707
1708 /**
1709  * p2p_other_scan_completed - Notify completion of non-P2P scan
1710  * @p2p: P2P module context from p2p_init()
1711  * Returns: 0 if P2P module is idle or 1 if an operation was started
1712  */
1713 int p2p_other_scan_completed(struct p2p_data *p2p);
1714
1715 const char * p2p_wps_method_text(enum p2p_wps_method method);
1716
1717 /**
1718  * p2p_set_config_timeout - Set local config timeouts
1719  * @p2p: P2P module context from p2p_init()
1720  * @go_timeout: Time in 10 ms units it takes to start the GO mode
1721  * @client_timeout: Time in 10 ms units it takes to start the client mode
1722  */
1723 void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1724                             u8 client_timeout);
1725
1726 void p2p_increase_search_delay(struct p2p_data *p2p, unsigned int delay);
1727
1728 int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1729 int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1730 int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1731 int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1732 int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
1733 int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
1734 int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
1735 int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
1736 int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
1737 int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
1738 int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
1739                                   const struct wpabuf *elem);
1740 struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
1741
1742 #endif /* P2P_H */