2 * Wi-Fi Direct - P2P module
3 * Copyright (c) 2009-2010, Atheros Communications
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.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
19 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
21 #define P2P_MAX_REG_CLASSES 10
24 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
26 #define P2P_MAX_REG_CLASS_CHANNELS 20
29 * struct p2p_channels - List of supported channels
33 * struct p2p_reg_class - Supported regulatory class
35 struct p2p_reg_class {
37 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
42 * channel - Supported channels
44 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
47 * channels - Number of channel entries in use
50 } reg_class[P2P_MAX_REG_CLASSES];
53 * reg_classes - Number of reg_class entries in use
59 WPS_NOT_READY, WPS_PIN_LABEL, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
63 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
65 struct p2p_go_neg_results {
67 * status - Negotiation result (Status Code)
69 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
75 * role_go - Whether local end is Group Owner
80 * freq - Frequency of the group operational channel in MHz
85 * ssid - SSID of the group
90 * ssid_len - Length of SSID in octets
95 * passphrase - WPA2-Personal passphrase for the group (GO only)
100 * peer_device_addr - P2P Device Address of the peer
102 u8 peer_device_addr[ETH_ALEN];
105 * peer_interface_addr - P2P Interface Address of the peer
107 u8 peer_interface_addr[ETH_ALEN];
110 * wps_method - WPS method to be used during provisioning
112 enum p2p_wps_method wps_method;
114 #define P2P_MAX_CHANNELS 50
117 * freq_list - Zero-terminated list of possible operational channels
119 int freq_list[P2P_MAX_CHANNELS];
122 * persistent_group - Whether the group should be made persistent
124 int persistent_group;
127 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
129 unsigned int peer_config_timeout;
138 P2P_SCAN_SOCIAL_PLUS_ONE
142 * struct p2p_peer_info - P2P peer information
145 struct p2p_peer_info {
147 * p2p_device_addr - P2P Device Address of the peer
149 u8 p2p_device_addr[ETH_ALEN];
152 * pri_dev_type - Primary Device Type
157 * device_name - Device Name
159 char device_name[33];
162 * config_methods - WPS Configuration Methods
167 * dev_capab - Device Capabilities
172 * group_capab - Group Capabilities
178 * struct p2p_config - P2P configuration
180 * This configuration is provided to the P2P module during initialization with
185 * country - Country code to use in P2P operations
190 * reg_class - Regulatory class for own listen channel
195 * channel - Own listen channel
200 * Regulatory class for own operational channel
205 * op_channel - Own operational channel
210 * cfg_op_channel - Whether op_channel is hardcoded in configuration
215 * channels - Own supported regulatory classes and channels
217 * List of supposerted channels per regulatory class. The regulatory
218 * classes are defined in IEEE Std 802.11-2007 Annex J and the
219 * numbering of the clases depends on the configured country code.
221 struct p2p_channels channels;
224 * pri_dev_type - Primary Device Type (see WPS)
229 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
231 #define P2P_SEC_DEVICE_TYPES 5
234 * sec_dev_type - Optional secondary device types
236 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
239 * dev_addr - P2P Device Address
241 u8 dev_addr[ETH_ALEN];
244 * dev_name - Device Name
249 * num_sec_dev_types - Number of sec_dev_type entries
251 size_t num_sec_dev_types;
254 * concurrent_operations - Whether concurrent operations are supported
256 int concurrent_operations;
259 * max_peers - Maximum number of discovered peers to remember
261 * If more peers are discovered, older entries will be removed to make
262 * room for the new ones.
267 * p2p_intra_bss - Intra BSS communication is supported
272 * ssid_postfix - Postfix data to add to the SSID
274 * This data will be added to the end of the SSID after the
275 * DIRECT-<random two octets> prefix.
277 u8 ssid_postfix[32 - 9];
280 * ssid_postfix_len - Length of the ssid_postfix data
282 size_t ssid_postfix_len;
285 * msg_ctx - Context to use with wpa_msg() calls
290 * cb_ctx - Context to use with callback functions
295 /* Callbacks to request lower layer driver operations */
298 * p2p_scan - Request a P2P scan/search
299 * @ctx: Callback context from cb_ctx
301 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
302 * Returns: 0 on success, -1 on failure
304 * This callback function is used to request a P2P scan or search
305 * operation to be completed. Type type argument specifies which type
306 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
307 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
308 * indicates that all channels are to be scanned. @P2P_SCAN_SPECIFIC
309 * request a scan of a single channel specified by freq.
310 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
311 * plus one extra channel specified by freq.
313 * The full scan is used for the initial scan to find group owners from
314 * all. The other types are used during search phase scan of the social
315 * channels (with potential variation if the Listen channel of the
316 * target peer is known or if other channels are scanned in steps).
318 * The scan results are returned after this call by calling
319 * p2p_scan_res_handler() for each scan result that has a P2P IE and
320 * then calling p2p_scan_res_handled() to indicate that all scan
321 * results have been indicated.
323 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq);
326 * send_probe_resp - Transmit a Probe Response frame
327 * @ctx: Callback context from cb_ctx
328 * @buf: Probe Response frame (including the header and body)
329 * Returns: 0 on success, -1 on failure
331 * This function is used to reply to Probe Request frames that were
332 * indicated with a call to p2p_probe_req_rx(). The response is to be
333 * sent on the same channel or to be dropped if the driver is not
334 * anymore listening to Probe Request frames.
336 * Alternatively, the responsibility for building the Probe Response
337 * frames in Listen state may be in another system component in which
338 * case this function need to be implemented (i.e., the function
339 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
340 * Response frames in such a case are available from the
341 * start_listen() callback. It should be noted that the received Probe
342 * Request frames must be indicated by calling p2p_probe_req_rx() even
343 * if this send_probe_resp() is not used.
345 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
348 * send_action - Transmit an Action frame
349 * @ctx: Callback context from cb_ctx
350 * @freq: Frequency in MHz for the channel on which to transmit
351 * @dst: Destination MAC address (Address 1)
352 * @src: Source MAC address (Address 2)
353 * @bssid: BSSID (Address 3)
354 * @buf: Frame body (starting from Category field)
355 * @len: Length of buf in octets
356 * @wait_time: How many msec to wait for a response frame
357 * Returns: 0 on success, -1 on failure
359 * The Action frame may not be transmitted immediately and the status
360 * of the transmission must be reported by calling
361 * p2p_send_action_cb() once the frame has either been transmitted or
362 * it has been dropped due to excessive retries or other failure to
365 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
366 const u8 *src, const u8 *bssid, const u8 *buf,
367 size_t len, unsigned int wait_time);
370 * send_action_done - Notify that Action frame sequence was completed
371 * @ctx: Callback context from cb_ctx
373 * This function is called when the Action frame sequence that was
374 * started with send_action() has been completed, i.e., when there is
375 * no need to wait for a response from the destination peer anymore.
377 void (*send_action_done)(void *ctx);
380 * start_listen - Start Listen state
381 * @ctx: Callback context from cb_ctx
382 * @freq: Frequency of the listen channel in MHz
383 * @duration: Duration for the Listen state in milliseconds
384 * @probe_resp_ie: IE(s) to be added to Probe Response frames
385 * Returns: 0 on success, -1 on failure
387 * This Listen state may not start immediately since the driver may
388 * have other pending operations to complete first. Once the Listen
389 * state has started, p2p_listen_cb() must be called to notify the P2P
390 * module. Once the Listen state is stopped, p2p_listen_end() must be
391 * called to notify the P2P module that the driver is not in the Listen
394 * If the send_probe_resp() is not used for generating the response,
395 * the IEs from probe_resp_ie need to be added to the end of the Probe
396 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
397 * information can be ignored.
399 int (*start_listen)(void *ctx, unsigned int freq,
400 unsigned int duration,
401 const struct wpabuf *probe_resp_ie);
403 * stop_listen - Stop Listen state
404 * @ctx: Callback context from cb_ctx
406 * This callback can be used to stop a Listen state operation that was
407 * previously requested with start_listen().
409 void (*stop_listen)(void *ctx);
412 * get_noa - Get current Notice of Absence attribute payload
413 * @ctx: Callback context from cb_ctx
414 * @interface_addr: P2P Interface Address of the GO
415 * @buf: Buffer for returning NoA
416 * @buf_len: Buffer length in octets
417 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
418 * advertized, or -1 on failure
420 * This function is used to fetch the current Notice of Absence
421 * attribute value from GO.
423 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
426 /* Callbacks to notify events to upper layer management entity */
429 * dev_found - Notification of a found P2P Device
430 * @ctx: Callback context from cb_ctx
431 * @addr: Source address of the message triggering this notification
432 * @info: P2P peer information
433 * @new_device: Inform if the peer is newly found
435 * This callback is used to notify that a new P2P Device has been
436 * found. This may happen, e.g., during Search state based on scan
437 * results or during Listen state based on receive Probe Request and
438 * Group Owner Negotiation Request.
440 void (*dev_found)(void *ctx, const u8 *addr,
441 const struct p2p_peer_info *info,
445 * go_neg_req_rx - Notification of a receive GO Negotiation Request
446 * @ctx: Callback context from cb_ctx
447 * @src: Source address of the message triggering this notification
448 * @dev_passwd_id: WPS Device Password ID
450 * This callback is used to notify that a P2P Device is requesting
451 * group owner negotiation with us, but we do not have all the
452 * necessary information to start GO Negotiation. This indicates that
453 * the local user has not authorized the connection yet by providing a
454 * PIN or PBC button press. This information can be provided with a
455 * call to p2p_connect().
457 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
460 * go_neg_completed - Notification of GO Negotiation results
461 * @ctx: Callback context from cb_ctx
462 * @res: GO Negotiation results
464 * This callback is used to notify that Group Owner Negotiation has
465 * been completed. Non-zero struct p2p_go_neg_results::status indicates
466 * failed negotiation. In case of success, this function is responsible
467 * for creating a new group interface (or using the existing interface
468 * depending on driver features), setting up the group interface in
469 * proper mode based on struct p2p_go_neg_results::role_go and
470 * initializing WPS provisioning either as a Registrar (if GO) or as an
471 * Enrollee. Successful WPS provisioning must be indicated by calling
472 * p2p_wps_success_cb(). The callee is responsible for timing out group
473 * formation if WPS provisioning cannot be completed successfully
476 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
479 * sd_request - Callback on Service Discovery Request
480 * @ctx: Callback context from cb_ctx
481 * @freq: Frequency (in MHz) of the channel
482 * @sa: Source address of the request
483 * @dialog_token: Dialog token
484 * @update_indic: Service Update Indicator from the source of request
485 * @tlvs: P2P Service Request TLV(s)
486 * @tlvs_len: Length of tlvs buffer in octets
488 * This callback is used to indicate reception of a service discovery
489 * request. Response to the query must be indicated by calling
490 * p2p_sd_response() with the context information from the arguments to
491 * this callback function.
493 * This callback handler can be set to %NULL to indicate that service
494 * discovery is not supported.
496 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
497 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
500 * sd_response - Callback on Service Discovery Response
501 * @ctx: Callback context from cb_ctx
502 * @sa: Source address of the request
503 * @update_indic: Service Update Indicator from the source of response
504 * @tlvs: P2P Service Response TLV(s)
505 * @tlvs_len: Length of tlvs buffer in octets
507 * This callback is used to indicate reception of a service discovery
508 * response. This callback handler can be set to %NULL if no service
509 * discovery requests are used. The information provided with this call
510 * is replies to the queries scheduled with p2p_sd_request().
512 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
513 const u8 *tlvs, size_t tlvs_len);
516 * prov_disc_req - Callback on Provisiong Discovery Request
517 * @ctx: Callback context from cb_ctx
518 * @peer: Source address of the request
519 * @config_methods: Requested WPS Config Method
520 * @dev_addr: P2P Device Address of the found P2P Device
521 * @pri_dev_type: Primary Device Type
522 * @dev_name: Device Name
523 * @supp_config_methods: Supported configuration Methods
524 * @dev_capab: Device Capabilities
525 * @group_capab: Group Capabilities
527 * This callback is used to indicate reception of a Provision Discovery
528 * Request frame that the P2P module accepted.
530 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
531 const u8 *dev_addr, const u8 *pri_dev_type,
532 const char *dev_name, u16 supp_config_methods,
533 u8 dev_capab, u8 group_capab);
536 * prov_disc_resp - Callback on Provisiong Discovery Response
537 * @ctx: Callback context from cb_ctx
538 * @peer: Source address of the response
539 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
541 * This callback is used to indicate reception of a Provision Discovery
542 * Response frame for a pending request scheduled with
543 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
544 * provision discovery is not used.
546 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
549 * invitation_process - Optional callback for processing Invitations
550 * @ctx: Callback context from cb_ctx
551 * @sa: Source address of the Invitation Request
552 * @bssid: P2P Group BSSID from the request or %NULL if not included
553 * @go_dev_addr: GO Device Address from P2P Group ID
554 * @ssid: SSID from P2P Group ID
555 * @ssid_len: Length of ssid buffer in octets
556 * @go: Variable for returning whether the local end is GO in the group
557 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
558 * @force_freq: Variable for returning forced frequency for the group
559 * @persistent_group: Whether this is an invitation to reinvoke a
560 * persistent group (instead of invitation to join an active
562 * Returns: Status code (P2P_SC_*)
564 * This optional callback can be used to implement persistent reconnect
565 * by allowing automatic restarting of persistent groups without user
566 * interaction. If this callback is not implemented (i.e., is %NULL),
567 * the received Invitation Request frames are replied with
568 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
569 * invitation_result() callback.
571 * If the requested parameters are acceptable and the group is known,
572 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
573 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
574 * can be returned if there is not enough data to provide immediate
575 * response, i.e., if some sort of user interaction is needed. The
576 * invitation_received() callback will be called in that case
577 * immediately after this call.
579 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
580 const u8 *go_dev_addr, const u8 *ssid,
581 size_t ssid_len, int *go, u8 *group_bssid,
582 int *force_freq, int persistent_group);
585 * invitation_received - Callback on Invitation Request RX
586 * @ctx: Callback context from cb_ctx
587 * @sa: Source address of the Invitation Request
588 * @bssid: P2P Group BSSID or %NULL if not received
589 * @ssid: SSID of the group
590 * @ssid_len: Length of ssid in octets
591 * @go_dev_addr: GO Device Address
592 * @status: Response Status
593 * @op_freq: Operational frequency for the group
595 * This callback is used to indicate sending of an Invitation Response
596 * for a received Invitation Request. If status == 0 (success), the
597 * upper layer code is responsible for starting the group. status == 1
598 * indicates need to get user authorization for the group. Other status
599 * values indicate that the invitation request was rejected.
601 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
602 const u8 *ssid, size_t ssid_len,
603 const u8 *go_dev_addr, u8 status,
607 * invitation_result - Callback on Invitation result
608 * @ctx: Callback context from cb_ctx
609 * @status: Negotiation result (Status Code)
610 * @bssid: P2P Group BSSID or %NULL if not received
612 * This callback is used to indicate result of an Invitation procedure
613 * started with a call to p2p_invite(). The indicated status code is
614 * the value received from the peer in Invitation Response with 0
615 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
616 * local failure in transmitting the Invitation Request.
618 void (*invitation_result)(void *ctx, int status, const u8 *bssid);
622 /* P2P module initialization/deinitialization */
625 * p2p_init - Initialize P2P module
626 * @cfg: P2P module configuration
627 * Returns: Pointer to private data or %NULL on failure
629 * This function is used to initialize global P2P module context (one per
630 * device). The P2P module will keep a copy of the configuration data, so the
631 * caller does not need to maintain this structure. However, the callback
632 * functions and the context parameters to them must be kept available until
633 * the P2P module is deinitialized with p2p_deinit().
635 struct p2p_data * p2p_init(const struct p2p_config *cfg);
638 * p2p_deinit - Deinitialize P2P module
639 * @p2p: P2P module context from p2p_init()
641 void p2p_deinit(struct p2p_data *p2p);
644 * p2p_flush - Flush P2P module state
645 * @p2p: P2P module context from p2p_init()
647 * This command removes the P2P module state like peer device entries.
649 void p2p_flush(struct p2p_data *p2p);
652 * p2p_unauthorize - Unauthorize the specified peer device
653 * @p2p: P2P module context from p2p_init()
654 * @addr: P2P peer entry to be unauthorized
655 * Returns: 0 on success, -1 on failure
657 * This command removes any connection authorization from the specified P2P
658 * peer device address. This can be used, e.g., to cancel effect of a previous
659 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
662 int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
665 * p2p_set_dev_name - Set device name
666 * @p2p: P2P module context from p2p_init()
667 * Returns: 0 on success, -1 on failure
669 * This function can be used to update the P2P module configuration with
670 * information that was not available at the time of the p2p_init() call.
672 int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
675 * p2p_set_pri_dev_type - Set primary device type
676 * @p2p: P2P module context from p2p_init()
677 * Returns: 0 on success, -1 on failure
679 * This function can be used to update the P2P module configuration with
680 * information that was not available at the time of the p2p_init() call.
682 int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
685 * p2p_set_sec_dev_types - Set secondary device types
686 * @p2p: P2P module context from p2p_init()
687 * Returns: 0 on success, -1 on failure
689 * This function can be used to update the P2P module configuration with
690 * information that was not available at the time of the p2p_init() call.
692 int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
693 size_t num_dev_types);
695 int p2p_set_country(struct p2p_data *p2p, const char *country);
698 /* Commands from upper layer management entity */
700 enum p2p_discovery_type {
701 P2P_FIND_START_WITH_FULL,
702 P2P_FIND_ONLY_SOCIAL,
707 * p2p_find - Start P2P Find (Device Discovery)
708 * @p2p: P2P module context from p2p_init()
709 * @timeout: Timeout for find operation in seconds or 0 for no timeout
710 * @type: Device Discovery type
711 * Returns: 0 on success, -1 on failure
713 int p2p_find(struct p2p_data *p2p, unsigned int timeout,
714 enum p2p_discovery_type type);
717 * p2p_stop_find - Stop P2P Find (Device Discovery)
718 * @p2p: P2P module context from p2p_init()
720 void p2p_stop_find(struct p2p_data *p2p);
723 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
724 * @p2p: P2P module context from p2p_init()
725 * @freq: Frequency in MHz for next operation
727 * This is like p2p_stop_find(), but Listen state is not stopped if we are
728 * already on the same frequency.
730 void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
733 * p2p_listen - Start P2P Listen state for specified duration
734 * @p2p: P2P module context from p2p_init()
735 * @timeout: Listen state duration in milliseconds
736 * Returns: 0 on success, -1 on failure
738 * This function can be used to request the P2P module to keep the device
739 * discoverable on the listen channel for an extended set of time. At least in
740 * its current form, this is mainly used for testing purposes and may not be of
741 * much use for normal P2P operations.
743 int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
746 * p2p_connect - Start P2P group formation (GO negotiation)
747 * @p2p: P2P module context from p2p_init()
748 * @peer_addr: MAC address of the peer P2P client
749 * @wps_method: WPS method to be used in provisioning
750 * @go_intent: Local GO intent value (1..15)
751 * @own_interface_addr: Intended interface address to use with the group
752 * @force_freq: The only allowed channel frequency in MHz or 0
753 * @persistent_group: Whether to create a persistent group
754 * Returns: 0 on success, -1 on failure
756 int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
757 enum p2p_wps_method wps_method,
758 int go_intent, const u8 *own_interface_addr,
759 unsigned int force_freq, int persistent_group);
762 * p2p_authorize - Authorize P2P group formation (GO negotiation)
763 * @p2p: P2P module context from p2p_init()
764 * @peer_addr: MAC address of the peer P2P client
765 * @wps_method: WPS method to be used in provisioning
766 * @go_intent: Local GO intent value (1..15)
767 * @own_interface_addr: Intended interface address to use with the group
768 * @force_freq: The only allowed channel frequency in MHz or 0
769 * @persistent_group: Whether to create a persistent group
770 * Returns: 0 on success, -1 on failure
772 * This is like p2p_connect(), but the actual group negotiation is not
773 * initiated automatically, i.e., the other end is expected to do that.
775 int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
776 enum p2p_wps_method wps_method,
777 int go_intent, const u8 *own_interface_addr,
778 unsigned int force_freq, int persistent_group);
781 * p2p_reject - Reject peer device (explicitly block connection attempts)
782 * @p2p: P2P module context from p2p_init()
783 * @peer_addr: MAC address of the peer P2P client
784 * Returns: 0 on success, -1 on failure
786 int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
789 * p2p_prov_disc_req - Send Provision Discovery Request
790 * @p2p: P2P module context from p2p_init()
791 * @peer_addr: MAC address of the peer P2P client
792 * @config_methods: WPS Config Methods value (only one bit set)
793 * @join: Whether this is used by a client joining an active group
794 * Returns: 0 on success, -1 on failure
796 * This function can be used to request a discovered P2P peer to display a PIN
797 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
798 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
799 * is transmitted once immediately and if no response is received, the frame
800 * will be sent again whenever the target device is discovered during device
801 * dsicovery (start with a p2p_find() call). Response from the peer is
802 * indicated with the p2p_config::prov_disc_resp() callback.
804 int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
805 u16 config_methods, int join);
808 * p2p_sd_request - Schedule a service discovery query
809 * @p2p: P2P module context from p2p_init()
810 * @dst: Destination peer or %NULL to apply for all peers
811 * @tlvs: P2P Service Query TLV(s)
812 * Returns: Reference to the query or %NULL on failure
814 * Response to the query is indicated with the p2p_config::sd_response()
817 void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
818 const struct wpabuf *tlvs);
821 * p2p_sd_cancel_request - Cancel a pending service discovery query
822 * @p2p: P2P module context from p2p_init()
823 * @req: Query reference from p2p_sd_request()
824 * Returns: 0 if request for cancelled; -1 if not found
826 int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
829 * p2p_sd_response - Send response to a service discovery query
830 * @p2p: P2P module context from p2p_init()
831 * @freq: Frequency from p2p_config::sd_request() callback
832 * @dst: Destination address from p2p_config::sd_request() callback
833 * @dialog_token: Dialog token from p2p_config::sd_request() callback
834 * @resp_tlvs: P2P Service Response TLV(s)
836 * This function is called as a response to the request indicated with
837 * p2p_config::sd_request() callback.
839 void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
840 u8 dialog_token, const struct wpabuf *resp_tlvs);
843 * p2p_sd_service_update - Indicate a change in local services
844 * @p2p: P2P module context from p2p_init()
846 * This function needs to be called whenever there is a change in availability
847 * of the local services. This will increment the Service Update Indicator
848 * value which will be used in SD Request and Response frames.
850 void p2p_sd_service_update(struct p2p_data *p2p);
853 enum p2p_invite_role {
855 P2P_INVITE_ROLE_ACTIVE_GO,
856 P2P_INVITE_ROLE_CLIENT
860 * p2p_invite - Invite a P2P Device into a group
861 * @p2p: P2P module context from p2p_init()
862 * @peer: Device Address of the peer P2P Device
863 * @role: Local role in the group
864 * @bssid: Group BSSID or %NULL if not known
866 * @ssid_len: Length of ssid in octets
867 * @force_freq: The only allowed channel frequency in MHz or 0
868 * @go_dev_addr: Forced GO Device Address or %NULL if none
869 * @persistent_group: Whether this is to reinvoke a persistent group
870 * Returns: 0 on success, -1 on failure
872 int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
873 const u8 *bssid, const u8 *ssid, size_t ssid_len,
874 unsigned int force_freq, const u8 *go_dev_addr,
875 int persistent_group);
878 * p2p_presence_req - Request GO presence
879 * @p2p: P2P module context from p2p_init()
880 * @go_interface_addr: GO P2P Interface Address
881 * @own_interface_addr: Own P2P Interface Address for this group
882 * @freq: Group operating frequence (in MHz)
883 * @duration1: Preferred presence duration in microseconds
884 * @interval1: Preferred presence interval in microseconds
885 * @duration2: Acceptable presence duration in microseconds
886 * @interval2: Acceptable presence interval in microseconds
887 * Returns: 0 on success, -1 on failure
889 * If both duration and interval values are zero, the parameter pair is not
890 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
892 int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
893 const u8 *own_interface_addr, unsigned int freq,
894 u32 duration1, u32 interval1, u32 duration2,
898 * p2p_ext_listen - Set Extended Listen Timing
899 * @p2p: P2P module context from p2p_init()
900 * @freq: Group operating frequence (in MHz)
901 * @period: Availability period in milliseconds (1-65535; 0 to disable)
902 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
903 * Returns: 0 on success, -1 on failure
905 * This function can be used to enable or disable (period = interval = 0)
906 * Extended Listen Timing. When enabled, the P2P Device will become
907 * discoverable (go into Listen State) every @interval milliseconds for at
908 * least @period milliseconds.
910 int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
911 unsigned int interval);
913 /* Event notifications from upper layer management operations */
916 * p2p_wps_success_cb - Report successfully completed WPS provisioning
917 * @p2p: P2P module context from p2p_init()
918 * @mac_addr: Peer address
920 * This function is used to report successfully completed WPS provisioning
921 * during group formation in both GO/Registrar and client/Enrollee roles.
923 void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
926 * p2p_group_formation_failed - Report failed WPS provisioning
927 * @p2p: P2P module context from p2p_init()
929 * This function is used to report failed group formation. This can happen
930 * either due to failed WPS provisioning or due to 15 second timeout during
931 * the provisioning phase.
933 void p2p_group_formation_failed(struct p2p_data *p2p);
936 /* Event notifications from lower layer driver operations */
939 * p2p_probe_req_rx - Report reception of a Probe Request frame
940 * @p2p: P2P module context from p2p_init()
941 * @addr: Source MAC address
942 * @ie: Information elements from the Probe Request frame body
943 * @ie_len: Length of ie buffer in octets
944 * Returns: 0 to indicate the frame was not processed or 1 if it was
946 int p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *ie,
950 * p2p_rx_action - Report received Action frame
951 * @p2p: P2P module context from p2p_init()
952 * @da: Destination address of the received Action frame
953 * @sa: Source address of the received Action frame
954 * @bssid: Address 3 of the received Action frame
955 * @category: Category of the received Action frame
956 * @data: Action frame body after the Category field
957 * @len: Length of the data buffer in octets
958 * @freq: Frequency (in MHz) on which the frame was received
960 void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
961 const u8 *bssid, u8 category,
962 const u8 *data, size_t len, int freq);
965 * p2p_scan_res_handler - Indicate a P2P scan results
966 * @p2p: P2P module context from p2p_init()
967 * @bssid: BSSID of the scan result
968 * @freq: Frequency of the channel on which the device was found in MHz
969 * @level: Signal level (signal strength of the received Beacon/Probe Response
971 * @ies: Pointer to IEs from the scan result
972 * @ies_len: Length of the ies buffer
973 * Returns: 0 to continue or 1 to stop scan result indication
975 * This function is called to indicate a scan result entry with P2P IE from a
976 * scan requested with struct p2p_config::p2p_scan(). This can be called during
977 * the actual scan process (i.e., whenever a new device is found) or as a
978 * sequence of calls after the full scan has been completed. The former option
979 * can result in optimized operations, but may not be supported by all
980 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
981 * but it is recommended to include all IEs received from the device. The
982 * caller does not need to check that the IEs contain a P2P IE before calling
983 * this function since frames will be filtered internally if needed.
985 * This function will return 1 if it wants to stop scan result iteration (and
986 * scan in general if it is still in progress). This is used to allow faster
987 * start of a pending operation, e.g., to start a pending GO negotiation.
989 int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
990 int level, const u8 *ies, size_t ies_len);
993 * p2p_scan_res_handled - Indicate end of scan results
994 * @p2p: P2P module context from p2p_init()
996 * This function is called to indicate that all P2P scan results from a scan
997 * have been reported with zero or more calls to p2p_scan_res_handler(). This
998 * function must be called as a response to successful
999 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1000 * calls stopped iteration.
1002 void p2p_scan_res_handled(struct p2p_data *p2p);
1004 enum p2p_send_action_result {
1005 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1006 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1007 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1011 * p2p_send_action_cb - Notify TX status of an Action frame
1012 * @p2p: P2P module context from p2p_init()
1013 * @freq: Channel frequency in MHz
1014 * @dst: Destination MAC address (Address 1)
1015 * @src: Source MAC address (Address 2)
1016 * @bssid: BSSID (Address 3)
1017 * @result: Result of the transmission attempt
1019 * This function is used to indicate the result of an Action frame transmission
1020 * that was requested with struct p2p_config::send_action() callback.
1022 void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1023 const u8 *src, const u8 *bssid,
1024 enum p2p_send_action_result result);
1027 * p2p_listen_cb - Indicate the start of a requested Listen state
1028 * @p2p: P2P module context from p2p_init()
1029 * @freq: Listen channel frequency in MHz
1030 * @duration: Duration for the Listen state in milliseconds
1032 * This function is used to indicate that a Listen state requested with
1033 * struct p2p_config::start_listen() callback has started.
1035 void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1036 unsigned int duration);
1039 * p2p_listen_end - Indicate the end of a requested Listen state
1040 * @p2p: P2P module context from p2p_init()
1041 * @freq: Listen channel frequency in MHz
1042 * Returns: 0 if no operations were started, 1 if an operation was started
1044 * This function is used to indicate that a Listen state requested with
1045 * struct p2p_config::start_listen() callback has ended.
1047 int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1049 void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1050 const u8 *ie, size_t ie_len);
1052 void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1053 const u8 *ie, size_t ie_len);
1056 /* Per-group P2P state for GO */
1061 * struct p2p_group_config - P2P group configuration
1063 * This configuration is provided to the P2P module during initialization of
1064 * the per-group information with p2p_group_init().
1066 struct p2p_group_config {
1068 * persistent_group - Whether the group is persistent
1070 int persistent_group;
1073 * interface_addr - P2P Interface Address of the group
1075 u8 interface_addr[ETH_ALEN];
1078 * max_clients - Maximum number of clients in the group
1080 unsigned int max_clients;
1083 * cb_ctx - Context to use with callback functions
1088 * ie_update - Notification of IE update
1089 * @ctx: Callback context from cb_ctx
1090 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1091 * @proberesp_ies: P2P Ie for Probe Response frames
1093 * P2P module uses this callback function to notify whenever the P2P IE
1094 * in Beacon or Probe Response frames should be updated based on group
1097 * The callee is responsible for freeing the returned buffer(s) with
1100 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1101 struct wpabuf *proberesp_ies);
1104 * idle_update - Notification of changes in group idle state
1105 * @ctx: Callback context from cb_ctx
1106 * @idle: Whether the group is idle (no associated stations)
1108 void (*idle_update)(void *ctx, int idle);
1112 * p2p_group_init - Initialize P2P group
1113 * @p2p: P2P module context from p2p_init()
1114 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1115 * Returns: Pointer to private data or %NULL on failure
1117 * This function is used to initialize per-group P2P module context. Currently,
1118 * this is only used to manage GO functionality and P2P clients do not need to
1119 * create an instance of this per-group information.
1121 struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1122 struct p2p_group_config *config);
1125 * p2p_group_deinit - Deinitialize P2P group
1126 * @group: P2P group context from p2p_group_init()
1128 void p2p_group_deinit(struct p2p_group *group);
1131 * p2p_group_notif_assoc - Notification of P2P client association with GO
1132 * @group: P2P group context from p2p_group_init()
1133 * @addr: Interface address of the P2P client
1134 * @ie: IEs from the (Re)association Request frame
1135 * @len: Length of the ie buffer in octets
1136 * Returns: 0 on success, -1 on failure
1138 int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1139 const u8 *ie, size_t len);
1142 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1143 * @group: P2P group context from p2p_group_init()
1144 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1145 * Returns: P2P IE for (Re)association Response or %NULL on failure
1147 * The caller is responsible for freeing the returned buffer with
1150 struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1153 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1154 * @group: P2P group context from p2p_group_init()
1155 * @addr: Interface address of the P2P client
1157 void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1160 * p2p_group_notif_formation_done - Notification of completed group formation
1161 * @group: P2P group context from p2p_group_init()
1163 void p2p_group_notif_formation_done(struct p2p_group *group);
1166 * p2p_group_notif_noa - Notification of NoA change
1167 * @group: P2P group context from p2p_group_init()
1168 * @noa: Notice of Absence attribute payload, %NULL if none
1169 * @noa_len: Length of noa buffer in octets
1170 * Returns: 0 on success, -1 on failure
1172 * Notify the P2P group management about a new NoA contents. This will be
1173 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1174 * the group information.
1176 int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1180 * p2p_group_match_dev_type - Match device types in group with requested type
1181 * @group: P2P group context from p2p_group_init()
1182 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1183 * Returns: 1 on match, 0 on mismatch
1185 * This function can be used to match the Requested Device Type attribute in
1186 * WPS IE with the device types of a group member for deciding whether a GO
1187 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1188 * is not requested any specific device type.
1190 int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1193 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1194 * @group: P2P group context from p2p_group_init()
1195 * Returns: 0 on success (frame scheduled); -1 if client was not found
1197 int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1198 const u8 *searching_dev, int rx_freq);
1201 /* Generic helper functions */
1204 * p2p_ie_text - Build text format description of P2P IE
1206 * @buf: Buffer for returning text
1207 * @end: Pointer to the end of the buf area
1208 * Returns: Number of octets written to the buffer or -1 on failure
1210 * This function can be used to parse P2P IE contents into text format
1211 * field=value lines.
1213 int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1216 * p2p_scan_result_text - Build text format description of P2P IE
1217 * @ies: Information elements from scan results
1218 * @ies_len: ies buffer length in octets
1219 * @buf: Buffer for returning text
1220 * @end: Pointer to the end of the buf area
1221 * Returns: Number of octets written to the buffer or -1 on failure
1223 * This function can be used to parse P2P IE contents into text format
1224 * field=value lines.
1226 int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1229 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1230 * @p2p: P2P module context from p2p_init()
1232 * @buf: Buffer for writing the P2P IE
1233 * @len: Maximum buf length in octets
1234 * @p2p_group: Whether this is for association with a P2P GO
1235 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1236 * Returns: Number of octets written into buf or -1 on failure
1238 int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1239 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1242 * p2p_scan_ie - Build P2P IE for Probe Request
1243 * @p2p: P2P module context from p2p_init()
1244 * @ies: Buffer for writing P2P IE
1246 void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies);
1249 * p2p_go_params - Generate random P2P group parameters
1250 * @p2p: P2P module context from p2p_init()
1251 * @params: Buffer for parameters
1252 * Returns: 0 on success, -1 on failure
1254 int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1257 * p2p_get_group_capab - Get Group Capability from P2P IE data
1258 * @p2p_ie: P2P IE(s) contents
1259 * Returns: Group Capability
1261 u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1264 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1265 * @p2p_ie: P2P IE(s) contents
1266 * Returns: 0 if cross connection is allow, 1 if not
1268 int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1271 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1272 * @p2p_ie: P2P IE(s) contents
1273 * Returns: Pointer to P2P Device Address or %NULL if not included
1275 const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1278 * p2p_get_peer_info - Get P2P peer information in text format
1279 * @p2p: P2P module context from p2p_init()
1280 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1281 * @next: Whether to select the peer entry following the one indicated by addr
1282 * @buf: Buffer for returning text
1283 * @buflen: Maximum buffer length
1284 * Returns: Number of octets written to the buffer or -1 on failure
1286 int p2p_get_peer_info(struct p2p_data *p2p, const u8 *addr, int next,
1287 char *buf, size_t buflen);
1290 * p2p_set_client_discoverability - Set client discoverability capability
1291 * @p2p: P2P module context from p2p_init()
1292 * @enabled: Whether client discoverability will be enabled
1294 * This function can be used to disable (and re-enable) client discoverability.
1295 * This capability is enabled by default and should not be disabled in normal
1296 * use cases, i.e., this is mainly for testing purposes.
1298 void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1301 * p2p_set_manageD_oper - Set managed P2P Device operations capability
1302 * @p2p: P2P module context from p2p_init()
1303 * @enabled: Whether managed P2P Device operations will be enabled
1305 void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1307 int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
1309 int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1311 int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1313 int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1316 void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1319 * p2p_set_cross_connect - Set cross connection capability
1320 * @p2p: P2P module context from p2p_init()
1321 * @enabled: Whether cross connection will be enabled
1323 void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1325 int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1327 int p2p_add_device(struct p2p_data *p2p, const u8 *addr, int freq, int level,
1328 const u8 *ies, size_t ies_len);
1331 * p2p_set_intra_bss_dist - Set intra BSS distribution
1332 * @p2p: P2P module context from p2p_init()
1333 * @enabled: Whether intra BSS distribution will be enabled
1335 void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1338 * p2p_supported_freq - Check whether channel is supported for P2P
1339 * @p2p: P2P module context from p2p_init()
1340 * @freq: Channel frequency in MHz
1341 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1343 int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1345 void p2p_update_channel_list(struct p2p_data *p2p, struct p2p_channels *chan);
1348 * p2p_set_best_channels - Update best channel information
1349 * @p2p: P2P module context from p2p_init()
1350 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1351 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1352 * @freq_overall: Frequency (MHz) of best channel overall
1354 void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1357 const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1360 * p2p_get_group_num_members - Get number of members in group
1361 * @group: P2P group context from p2p_group_init()
1362 * Returns: Number of members in the group
1364 unsigned int p2p_get_group_num_members(struct p2p_group *group);
1367 * p2p_iterate_group_members - Iterate group members
1368 * @group: P2P group context from p2p_group_init()
1369 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1370 * on the first call and not modified later
1371 * Returns: A P2P Interface Address for each call and %NULL for no more members
1373 const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);