OSDN Git Service

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