2 * Wi-Fi Direct - P2P module
3 * Copyright (c) 2009-2010, Atheros Communications
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
13 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
15 #define P2P_MAX_REG_CLASSES 10
18 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
20 #define P2P_MAX_REG_CLASS_CHANNELS 20
23 * struct p2p_channels - List of supported channels
27 * struct p2p_reg_class - Supported regulatory class
29 struct p2p_reg_class {
31 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
36 * channel - Supported channels
38 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
41 * channels - Number of channel entries in use
44 } reg_class[P2P_MAX_REG_CLASSES];
47 * reg_classes - Number of reg_class entries in use
53 WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
57 SRV_UPDATE, SRV_ADD, SRV_DEL, SRV_FLUSH
61 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
63 struct p2p_go_neg_results {
65 * status - Negotiation result (Status Code)
67 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
73 * role_go - Whether local end is Group Owner
78 * freq - Frequency of the group operational channel in MHz
85 * ssid - SSID of the group
90 * ssid_len - Length of SSID in octets
95 * psk - WPA pre-shared key (256 bits) (GO only)
100 * psk_set - Whether PSK field is configured (GO only)
105 * passphrase - WPA2-Personal passphrase for the group (GO only)
110 * peer_device_addr - P2P Device Address of the peer
112 u8 peer_device_addr[ETH_ALEN];
115 * peer_interface_addr - P2P Interface Address of the peer
117 u8 peer_interface_addr[ETH_ALEN];
120 * wps_method - WPS method to be used during provisioning
122 enum p2p_wps_method wps_method;
124 #define P2P_MAX_CHANNELS 50
127 * freq_list - Zero-terminated list of possible operational channels
129 int freq_list[P2P_MAX_CHANNELS];
132 * persistent_group - Whether the group should be made persistent
134 * 1 = persistent group without persistent reconnect
135 * 2 = persistent group with persistent reconnect
137 int persistent_group;
140 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
142 unsigned int peer_config_timeout;
151 P2P_SCAN_SOCIAL_PLUS_ONE
154 #define P2P_MAX_WPS_VENDOR_EXT 10
157 * struct p2p_peer_info - P2P peer information
159 struct p2p_peer_info {
161 * p2p_device_addr - P2P Device Address of the peer
163 u8 p2p_device_addr[ETH_ALEN];
166 * pri_dev_type - Primary Device Type
171 * device_name - Device Name (0..32 octets encoded in UTF-8)
173 char device_name[33];
176 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
178 char manufacturer[65];
181 * model_name - Model Name (0..32 octets encoded in UTF-8)
186 * model_number - Model Number (0..32 octets encoded in UTF-8)
188 char model_number[33];
191 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
193 char serial_number[33];
196 * level - Signal level
201 * config_methods - WPS Configuration Methods
206 * dev_capab - Device Capabilities
211 * group_capab - Group Capabilities
216 * wps_sec_dev_type_list - WPS secondary device type list
218 * This list includes from 0 to 16 Secondary Device Types as indicated
219 * by wps_sec_dev_type_list_len (8 * number of types).
221 u8 wps_sec_dev_type_list[128];
224 * wps_sec_dev_type_list_len - Length of secondary device type list
226 size_t wps_sec_dev_type_list_len;
228 struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
231 * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
233 struct wpabuf *wfd_subelems;
236 enum p2p_prov_disc_status {
237 P2P_PROV_DISC_SUCCESS,
238 P2P_PROV_DISC_TIMEOUT,
239 P2P_PROV_DISC_REJECTED,
240 P2P_PROV_DISC_TIMEOUT_JOIN,
249 * struct p2p_config - P2P configuration
251 * This configuration is provided to the P2P module during initialization with
256 * country - Country code to use in P2P operations
261 * reg_class - Regulatory class for own listen channel
266 * channel - Own listen channel
271 * Regulatory class for own operational channel
276 * op_channel - Own operational channel
281 * cfg_op_channel - Whether op_channel is hardcoded in configuration
286 * channels - Own supported regulatory classes and channels
288 * List of supposerted channels per regulatory class. The regulatory
289 * classes are defined in IEEE Std 802.11-2007 Annex J and the
290 * numbering of the clases depends on the configured country code.
292 struct p2p_channels channels;
295 * num_pref_chan - Number of pref_chan entries
297 unsigned int num_pref_chan;
300 * pref_chan - Preferred channels for GO Negotiation
302 struct p2p_channel *pref_chan;
305 * pri_dev_type - Primary Device Type (see WPS)
310 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
312 #define P2P_SEC_DEVICE_TYPES 5
315 * sec_dev_type - Optional secondary device types
317 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
320 * num_sec_dev_types - Number of sec_dev_type entries
322 size_t num_sec_dev_types;
325 * dev_addr - P2P Device Address
327 u8 dev_addr[ETH_ALEN];
330 * dev_name - Device Name
343 * concurrent_operations - Whether concurrent operations are supported
345 int concurrent_operations;
348 * max_peers - Maximum number of discovered peers to remember
350 * If more peers are discovered, older entries will be removed to make
351 * room for the new ones.
356 * p2p_intra_bss - Intra BSS communication is supported
361 * ssid_postfix - Postfix data to add to the SSID
363 * This data will be added to the end of the SSID after the
364 * DIRECT-<random two octets> prefix.
366 u8 ssid_postfix[32 - 9];
369 * ssid_postfix_len - Length of the ssid_postfix data
371 size_t ssid_postfix_len;
374 * max_listen - Maximum listen duration in ms
376 unsigned int max_listen;
379 enum p2p_concurrency_type {
381 P2P_SINGLE_CHANNEL_CONCURRENT,
382 P2P_MULTI_CHANNEL_CONCURRENT,
387 * cb_ctx - Context to use with callback functions
392 * debug_print - Debug print
393 * @ctx: Callback context from cb_ctx
394 * @level: Debug verbosity level (MSG_*)
395 * @msg: Debug message
397 void (*debug_print)(void *ctx, int level, const char *msg);
400 /* Callbacks to request lower layer driver operations */
403 * p2p_scan - Request a P2P scan/search
404 * @ctx: Callback context from cb_ctx
406 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
407 * @num_req_dev_types: Number of requested device types
408 * @req_dev_types: Array containing requested device types
409 * @dev_id: Device ID to search for or %NULL to find all devices
410 * @pw_id: Device Password ID
411 * Returns: 0 on success, -1 on failure
413 * This callback function is used to request a P2P scan or search
414 * operation to be completed. Type type argument specifies which type
415 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
416 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
417 * indicates that all channels are to be scanned.
418 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
419 * plus one extra channel specified by freq.
421 * The full scan is used for the initial scan to find group owners from
422 * all. The other types are used during search phase scan of the social
423 * channels (with potential variation if the Listen channel of the
424 * target peer is known or if other channels are scanned in steps).
426 * The scan results are returned after this call by calling
427 * p2p_scan_res_handler() for each scan result that has a P2P IE and
428 * then calling p2p_scan_res_handled() to indicate that all scan
429 * results have been indicated.
431 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
432 unsigned int num_req_dev_types,
433 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
436 * send_probe_resp - Transmit a Probe Response frame
437 * @ctx: Callback context from cb_ctx
438 * @buf: Probe Response frame (including the header and body)
439 * Returns: 0 on success, -1 on failure
441 * This function is used to reply to Probe Request frames that were
442 * indicated with a call to p2p_probe_req_rx(). The response is to be
443 * sent on the same channel or to be dropped if the driver is not
444 * anymore listening to Probe Request frames.
446 * Alternatively, the responsibility for building the Probe Response
447 * frames in Listen state may be in another system component in which
448 * case this function need to be implemented (i.e., the function
449 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
450 * Response frames in such a case are available from the
451 * start_listen() callback. It should be noted that the received Probe
452 * Request frames must be indicated by calling p2p_probe_req_rx() even
453 * if this send_probe_resp() is not used.
455 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
458 * send_action - Transmit an Action frame
459 * @ctx: Callback context from cb_ctx
460 * @freq: Frequency in MHz for the channel on which to transmit
461 * @dst: Destination MAC address (Address 1)
462 * @src: Source MAC address (Address 2)
463 * @bssid: BSSID (Address 3)
464 * @buf: Frame body (starting from Category field)
465 * @len: Length of buf in octets
466 * @wait_time: How many msec to wait for a response frame
467 * Returns: 0 on success, -1 on failure
469 * The Action frame may not be transmitted immediately and the status
470 * of the transmission must be reported by calling
471 * p2p_send_action_cb() once the frame has either been transmitted or
472 * it has been dropped due to excessive retries or other failure to
475 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
476 const u8 *src, const u8 *bssid, const u8 *buf,
477 size_t len, unsigned int wait_time);
480 * send_action_done - Notify that Action frame sequence was completed
481 * @ctx: Callback context from cb_ctx
483 * This function is called when the Action frame sequence that was
484 * started with send_action() has been completed, i.e., when there is
485 * no need to wait for a response from the destination peer anymore.
487 void (*send_action_done)(void *ctx);
490 * start_listen - Start Listen state
491 * @ctx: Callback context from cb_ctx
492 * @freq: Frequency of the listen channel in MHz
493 * @duration: Duration for the Listen state in milliseconds
494 * @probe_resp_ie: IE(s) to be added to Probe Response frames
495 * Returns: 0 on success, -1 on failure
497 * This Listen state may not start immediately since the driver may
498 * have other pending operations to complete first. Once the Listen
499 * state has started, p2p_listen_cb() must be called to notify the P2P
500 * module. Once the Listen state is stopped, p2p_listen_end() must be
501 * called to notify the P2P module that the driver is not in the Listen
504 * If the send_probe_resp() is not used for generating the response,
505 * the IEs from probe_resp_ie need to be added to the end of the Probe
506 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
507 * information can be ignored.
509 int (*start_listen)(void *ctx, unsigned int freq,
510 unsigned int duration,
511 const struct wpabuf *probe_resp_ie);
513 * stop_listen - Stop Listen state
514 * @ctx: Callback context from cb_ctx
516 * This callback can be used to stop a Listen state operation that was
517 * previously requested with start_listen().
519 void (*stop_listen)(void *ctx);
522 * get_noa - Get current Notice of Absence attribute payload
523 * @ctx: Callback context from cb_ctx
524 * @interface_addr: P2P Interface Address of the GO
525 * @buf: Buffer for returning NoA
526 * @buf_len: Buffer length in octets
527 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
528 * advertized, or -1 on failure
530 * This function is used to fetch the current Notice of Absence
531 * attribute value from GO.
533 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
536 /* Callbacks to notify events to upper layer management entity */
539 * dev_found - Notification of a found P2P Device
540 * @ctx: Callback context from cb_ctx
541 * @addr: Source address of the message triggering this notification
542 * @info: P2P peer information
543 * @new_device: Inform if the peer is newly found
545 * This callback is used to notify that a new P2P Device has been
546 * found. This may happen, e.g., during Search state based on scan
547 * results or during Listen state based on receive Probe Request and
548 * Group Owner Negotiation Request.
550 void (*dev_found)(void *ctx, const u8 *addr,
551 const struct p2p_peer_info *info,
555 * dev_lost - Notification of a lost P2P Device
556 * @ctx: Callback context from cb_ctx
557 * @dev_addr: P2P Device Address of the lost P2P Device
559 * This callback is used to notify that a P2P Device has been deleted.
561 void (*dev_lost)(void *ctx, const u8 *dev_addr);
564 * find_stopped - Notification of a p2p_find operation stopping
565 * @ctx: Callback context from cb_ctx
567 void (*find_stopped)(void *ctx);
570 * go_neg_req_rx - Notification of a receive GO Negotiation Request
571 * @ctx: Callback context from cb_ctx
572 * @src: Source address of the message triggering this notification
573 * @dev_passwd_id: WPS Device Password ID
575 * This callback is used to notify that a P2P Device is requesting
576 * group owner negotiation with us, but we do not have all the
577 * necessary information to start GO Negotiation. This indicates that
578 * the local user has not authorized the connection yet by providing a
579 * PIN or PBC button press. This information can be provided with a
580 * call to p2p_connect().
582 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
585 * go_neg_completed - Notification of GO Negotiation results
586 * @ctx: Callback context from cb_ctx
587 * @res: GO Negotiation results
589 * This callback is used to notify that Group Owner Negotiation has
590 * been completed. Non-zero struct p2p_go_neg_results::status indicates
591 * failed negotiation. In case of success, this function is responsible
592 * for creating a new group interface (or using the existing interface
593 * depending on driver features), setting up the group interface in
594 * proper mode based on struct p2p_go_neg_results::role_go and
595 * initializing WPS provisioning either as a Registrar (if GO) or as an
596 * Enrollee. Successful WPS provisioning must be indicated by calling
597 * p2p_wps_success_cb(). The callee is responsible for timing out group
598 * formation if WPS provisioning cannot be completed successfully
601 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
604 * sd_request - Callback on Service Discovery Request
605 * @ctx: Callback context from cb_ctx
606 * @freq: Frequency (in MHz) of the channel
607 * @sa: Source address of the request
608 * @dialog_token: Dialog token
609 * @update_indic: Service Update Indicator from the source of request
610 * @tlvs: P2P Service Request TLV(s)
611 * @tlvs_len: Length of tlvs buffer in octets
613 * This callback is used to indicate reception of a service discovery
614 * request. Response to the query must be indicated by calling
615 * p2p_sd_response() with the context information from the arguments to
616 * this callback function.
618 * This callback handler can be set to %NULL to indicate that service
619 * discovery is not supported.
621 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
622 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
625 * sd_response - Callback on Service Discovery Response
626 * @ctx: Callback context from cb_ctx
627 * @sa: Source address of the request
628 * @update_indic: Service Update Indicator from the source of response
629 * @tlvs: P2P Service Response TLV(s)
630 * @tlvs_len: Length of tlvs buffer in octets
632 * This callback is used to indicate reception of a service discovery
633 * response. This callback handler can be set to %NULL if no service
634 * discovery requests are used. The information provided with this call
635 * is replies to the queries scheduled with p2p_sd_request().
637 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
638 const u8 *tlvs, size_t tlvs_len);
641 * prov_disc_req - Callback on Provisiong Discovery Request
642 * @ctx: Callback context from cb_ctx
643 * @peer: Source address of the request
644 * @config_methods: Requested WPS Config Method
645 * @dev_addr: P2P Device Address of the found P2P Device
646 * @pri_dev_type: Primary Device Type
647 * @dev_name: Device Name
648 * @supp_config_methods: Supported configuration Methods
649 * @dev_capab: Device Capabilities
650 * @group_capab: Group Capabilities
651 * @group_id: P2P Group ID (or %NULL if not included)
652 * @group_id_len: Length of P2P Group ID
654 * This callback is used to indicate reception of a Provision Discovery
655 * Request frame that the P2P module accepted.
657 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
658 const u8 *dev_addr, const u8 *pri_dev_type,
659 const char *dev_name, u16 supp_config_methods,
660 u8 dev_capab, u8 group_capab,
661 const u8 *group_id, size_t group_id_len);
664 * prov_disc_resp - Callback on Provisiong Discovery Response
665 * @ctx: Callback context from cb_ctx
666 * @peer: Source address of the response
667 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
669 * This callback is used to indicate reception of a Provision Discovery
670 * Response frame for a pending request scheduled with
671 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
672 * provision discovery is not used.
674 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
677 * prov_disc_fail - Callback on Provision Discovery failure
678 * @ctx: Callback context from cb_ctx
679 * @peer: Source address of the response
680 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
682 * This callback is used to indicate either a failure or no response
683 * to an earlier provision discovery request.
685 * This callback handler can be set to %NULL if provision discovery
686 * is not used or failures do not need to be indicated.
688 void (*prov_disc_fail)(void *ctx, const u8 *peer,
689 enum p2p_prov_disc_status status);
692 * invitation_process - Optional callback for processing Invitations
693 * @ctx: Callback context from cb_ctx
694 * @sa: Source address of the Invitation Request
695 * @bssid: P2P Group BSSID from the request or %NULL if not included
696 * @go_dev_addr: GO Device Address from P2P Group ID
697 * @ssid: SSID from P2P Group ID
698 * @ssid_len: Length of ssid buffer in octets
699 * @go: Variable for returning whether the local end is GO in the group
700 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
701 * @force_freq: Variable for returning forced frequency for the group
702 * @persistent_group: Whether this is an invitation to reinvoke a
703 * persistent group (instead of invitation to join an active
705 * @channels: Available operating channels for the group
706 * Returns: Status code (P2P_SC_*)
708 * This optional callback can be used to implement persistent reconnect
709 * by allowing automatic restarting of persistent groups without user
710 * interaction. If this callback is not implemented (i.e., is %NULL),
711 * the received Invitation Request frames are replied with
712 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
713 * invitation_result() callback.
715 * If the requested parameters are acceptable and the group is known,
716 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
717 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
718 * can be returned if there is not enough data to provide immediate
719 * response, i.e., if some sort of user interaction is needed. The
720 * invitation_received() callback will be called in that case
721 * immediately after this call.
723 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
724 const u8 *go_dev_addr, const u8 *ssid,
725 size_t ssid_len, int *go, u8 *group_bssid,
726 int *force_freq, int persistent_group,
727 const struct p2p_channels *channels);
730 * invitation_received - Callback on Invitation Request RX
731 * @ctx: Callback context from cb_ctx
732 * @sa: Source address of the Invitation Request
733 * @bssid: P2P Group BSSID or %NULL if not received
734 * @ssid: SSID of the group
735 * @ssid_len: Length of ssid in octets
736 * @go_dev_addr: GO Device Address
737 * @status: Response Status
738 * @op_freq: Operational frequency for the group
740 * This callback is used to indicate sending of an Invitation Response
741 * for a received Invitation Request. If status == 0 (success), the
742 * upper layer code is responsible for starting the group. status == 1
743 * indicates need to get user authorization for the group. Other status
744 * values indicate that the invitation request was rejected.
746 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
747 const u8 *ssid, size_t ssid_len,
748 const u8 *go_dev_addr, u8 status,
752 * invitation_result - Callback on Invitation result
753 * @ctx: Callback context from cb_ctx
754 * @status: Negotiation result (Status Code)
755 * @bssid: P2P Group BSSID or %NULL if not received
756 * @channels: Available operating channels for the group
757 * @addr: Peer address
759 * This callback is used to indicate result of an Invitation procedure
760 * started with a call to p2p_invite(). The indicated status code is
761 * the value received from the peer in Invitation Response with 0
762 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
763 * local failure in transmitting the Invitation Request.
765 void (*invitation_result)(void *ctx, int status, const u8 *bssid,
766 const struct p2p_channels *channels,
770 * go_connected - Check whether we are connected to a GO
771 * @ctx: Callback context from cb_ctx
772 * @dev_addr: P2P Device Address of a GO
773 * Returns: 1 if we are connected as a P2P client to the specified GO
776 int (*go_connected)(void *ctx, const u8 *dev_addr);
780 /* P2P module initialization/deinitialization */
783 * p2p_init - Initialize P2P module
784 * @cfg: P2P module configuration
785 * Returns: Pointer to private data or %NULL on failure
787 * This function is used to initialize global P2P module context (one per
788 * device). The P2P module will keep a copy of the configuration data, so the
789 * caller does not need to maintain this structure. However, the callback
790 * functions and the context parameters to them must be kept available until
791 * the P2P module is deinitialized with p2p_deinit().
793 struct p2p_data * p2p_init(const struct p2p_config *cfg);
796 * p2p_deinit - Deinitialize P2P module
797 * @p2p: P2P module context from p2p_init()
799 void p2p_deinit(struct p2p_data *p2p);
802 * p2p_flush - Flush P2P module state
803 * @p2p: P2P module context from p2p_init()
805 * This command removes the P2P module state like peer device entries.
807 void p2p_flush(struct p2p_data *p2p);
810 * p2p_unauthorize - Unauthorize the specified peer device
811 * @p2p: P2P module context from p2p_init()
812 * @addr: P2P peer entry to be unauthorized
813 * Returns: 0 on success, -1 on failure
815 * This command removes any connection authorization from the specified P2P
816 * peer device address. This can be used, e.g., to cancel effect of a previous
817 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
820 int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
823 * p2p_set_dev_name - Set device name
824 * @p2p: P2P module context from p2p_init()
825 * Returns: 0 on success, -1 on failure
827 * This function can be used to update the P2P module configuration with
828 * information that was not available at the time of the p2p_init() call.
830 int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
832 int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
833 int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
834 int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
835 int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
837 void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
838 void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
841 * p2p_set_pri_dev_type - Set primary device type
842 * @p2p: P2P module context from p2p_init()
843 * Returns: 0 on success, -1 on failure
845 * This function can be used to update the P2P module configuration with
846 * information that was not available at the time of the p2p_init() call.
848 int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
851 * p2p_set_sec_dev_types - Set secondary device types
852 * @p2p: P2P module context from p2p_init()
853 * Returns: 0 on success, -1 on failure
855 * This function can be used to update the P2P module configuration with
856 * information that was not available at the time of the p2p_init() call.
858 int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
859 size_t num_dev_types);
861 int p2p_set_country(struct p2p_data *p2p, const char *country);
864 /* Commands from upper layer management entity */
866 enum p2p_discovery_type {
867 P2P_FIND_START_WITH_FULL,
868 P2P_FIND_ONLY_SOCIAL,
873 * p2p_find - Start P2P Find (Device Discovery)
874 * @p2p: P2P module context from p2p_init()
875 * @timeout: Timeout for find operation in seconds or 0 for no timeout
876 * @type: Device Discovery type
877 * @num_req_dev_types: Number of requested device types
878 * @req_dev_types: Requested device types array, must be an array
879 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
880 * requested device types.
881 * @dev_id: Device ID to search for or %NULL to find all devices
882 * @search_delay: Extra delay in milliseconds between search iterations
883 * Returns: 0 on success, -1 on failure
885 int p2p_find(struct p2p_data *p2p, unsigned int timeout,
886 enum p2p_discovery_type type,
887 unsigned int num_req_dev_types, const u8 *req_dev_types,
888 const u8 *dev_id, unsigned int search_delay);
891 * p2p_stop_find - Stop P2P Find (Device Discovery)
892 * @p2p: P2P module context from p2p_init()
894 void p2p_stop_find(struct p2p_data *p2p);
897 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
898 * @p2p: P2P module context from p2p_init()
899 * @freq: Frequency in MHz for next operation
901 * This is like p2p_stop_find(), but Listen state is not stopped if we are
902 * already on the same frequency.
904 void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
907 * p2p_listen - Start P2P Listen state for specified duration
908 * @p2p: P2P module context from p2p_init()
909 * @timeout: Listen state duration in milliseconds
910 * Returns: 0 on success, -1 on failure
912 * This function can be used to request the P2P module to keep the device
913 * discoverable on the listen channel for an extended set of time. At least in
914 * its current form, this is mainly used for testing purposes and may not be of
915 * much use for normal P2P operations.
917 int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
920 * p2p_connect - Start P2P group formation (GO negotiation)
921 * @p2p: P2P module context from p2p_init()
922 * @peer_addr: MAC address of the peer P2P client
923 * @wps_method: WPS method to be used in provisioning
924 * @go_intent: Local GO intent value (1..15)
925 * @own_interface_addr: Intended interface address to use with the group
926 * @force_freq: The only allowed channel frequency in MHz or 0
927 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
928 * persistent group without persistent reconnect, 2 = persistent group with
929 * persistent reconnect)
930 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
932 * @force_ssid_len: Length of $force_ssid buffer
933 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
934 * Negotiation as an interoperability workaround when initiating group
936 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
938 * Returns: 0 on success, -1 on failure
940 int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
941 enum p2p_wps_method wps_method,
942 int go_intent, const u8 *own_interface_addr,
943 unsigned int force_freq, int persistent_group,
944 const u8 *force_ssid, size_t force_ssid_len,
945 int pd_before_go_neg, unsigned int pref_freq);
948 * p2p_authorize - Authorize P2P group formation (GO negotiation)
949 * @p2p: P2P module context from p2p_init()
950 * @peer_addr: MAC address of the peer P2P client
951 * @wps_method: WPS method to be used in provisioning
952 * @go_intent: Local GO intent value (1..15)
953 * @own_interface_addr: Intended interface address to use with the group
954 * @force_freq: The only allowed channel frequency in MHz or 0
955 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
956 * persistent group without persistent reconnect, 2 = persistent group with
957 * persistent reconnect)
958 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
960 * @force_ssid_len: Length of $force_ssid buffer
961 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
963 * Returns: 0 on success, -1 on failure
965 * This is like p2p_connect(), but the actual group negotiation is not
966 * initiated automatically, i.e., the other end is expected to do that.
968 int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
969 enum p2p_wps_method wps_method,
970 int go_intent, const u8 *own_interface_addr,
971 unsigned int force_freq, int persistent_group,
972 const u8 *force_ssid, size_t force_ssid_len,
973 unsigned int pref_freq);
976 * p2p_reject - Reject peer device (explicitly block connection attempts)
977 * @p2p: P2P module context from p2p_init()
978 * @peer_addr: MAC address of the peer P2P client
979 * Returns: 0 on success, -1 on failure
981 int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
984 * p2p_prov_disc_req - Send Provision Discovery Request
985 * @p2p: P2P module context from p2p_init()
986 * @peer_addr: MAC address of the peer P2P client
987 * @config_methods: WPS Config Methods value (only one bit set)
988 * @join: Whether this is used by a client joining an active group
989 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
990 * @user_initiated_pd: Flag to indicate if initiated by user or not
991 * Returns: 0 on success, -1 on failure
993 * This function can be used to request a discovered P2P peer to display a PIN
994 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
995 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
996 * is transmitted once immediately and if no response is received, the frame
997 * will be sent again whenever the target device is discovered during device
998 * dsicovery (start with a p2p_find() call). Response from the peer is
999 * indicated with the p2p_config::prov_disc_resp() callback.
1001 int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
1002 u16 config_methods, int join, int force_freq,
1003 int user_initiated_pd);
1006 * p2p_sd_request - Schedule a service discovery query
1007 * @p2p: P2P module context from p2p_init()
1008 * @dst: Destination peer or %NULL to apply for all peers
1009 * @tlvs: P2P Service Query TLV(s)
1010 * Returns: Reference to the query or %NULL on failure
1012 * Response to the query is indicated with the p2p_config::sd_response()
1015 void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1016 const struct wpabuf *tlvs);
1018 #ifdef CONFIG_WIFI_DISPLAY
1019 void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1020 const struct wpabuf *tlvs);
1021 #endif /* CONFIG_WIFI_DISPLAY */
1024 * p2p_sd_cancel_request - Cancel a pending service discovery query
1025 * @p2p: P2P module context from p2p_init()
1026 * @req: Query reference from p2p_sd_request()
1027 * Returns: 0 if request for cancelled; -1 if not found
1029 int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1032 * p2p_sd_response - Send response to a service discovery query
1033 * @p2p: P2P module context from p2p_init()
1034 * @freq: Frequency from p2p_config::sd_request() callback
1035 * @dst: Destination address from p2p_config::sd_request() callback
1036 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1037 * @resp_tlvs: P2P Service Response TLV(s)
1039 * This function is called as a response to the request indicated with
1040 * p2p_config::sd_request() callback.
1042 void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1043 u8 dialog_token, const struct wpabuf *resp_tlvs);
1046 * p2p_sd_service_update - Indicate a change in local services
1047 * @p2p: P2P module context from p2p_init()
1049 * This function needs to be called whenever there is a change in availability
1050 * of the local services. This will increment the Service Update Indicator
1051 * value which will be used in SD Request and Response frames.
1054 void p2p_sd_service_update(struct p2p_data *p2p, int action);
1056 void p2p_sd_service_update(struct p2p_data *p2p);
1060 enum p2p_invite_role {
1062 P2P_INVITE_ROLE_ACTIVE_GO,
1063 P2P_INVITE_ROLE_CLIENT
1067 * p2p_invite - Invite a P2P Device into a group
1068 * @p2p: P2P module context from p2p_init()
1069 * @peer: Device Address of the peer P2P Device
1070 * @role: Local role in the group
1071 * @bssid: Group BSSID or %NULL if not known
1073 * @ssid_len: Length of ssid in octets
1074 * @force_freq: The only allowed channel frequency in MHz or 0
1075 * @go_dev_addr: Forced GO Device Address or %NULL if none
1076 * @persistent_group: Whether this is to reinvoke a persistent group
1077 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1079 * Returns: 0 on success, -1 on failure
1081 int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1082 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1083 unsigned int force_freq, const u8 *go_dev_addr,
1084 int persistent_group, unsigned int pref_freq);
1087 * p2p_presence_req - Request GO presence
1088 * @p2p: P2P module context from p2p_init()
1089 * @go_interface_addr: GO P2P Interface Address
1090 * @own_interface_addr: Own P2P Interface Address for this group
1091 * @freq: Group operating frequence (in MHz)
1092 * @duration1: Preferred presence duration in microseconds
1093 * @interval1: Preferred presence interval in microseconds
1094 * @duration2: Acceptable presence duration in microseconds
1095 * @interval2: Acceptable presence interval in microseconds
1096 * Returns: 0 on success, -1 on failure
1098 * If both duration and interval values are zero, the parameter pair is not
1099 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1101 int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1102 const u8 *own_interface_addr, unsigned int freq,
1103 u32 duration1, u32 interval1, u32 duration2,
1107 * p2p_ext_listen - Set Extended Listen Timing
1108 * @p2p: P2P module context from p2p_init()
1109 * @freq: Group operating frequence (in MHz)
1110 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1111 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1112 * Returns: 0 on success, -1 on failure
1114 * This function can be used to enable or disable (period = interval = 0)
1115 * Extended Listen Timing. When enabled, the P2P Device will become
1116 * discoverable (go into Listen State) every @interval milliseconds for at
1117 * least @period milliseconds.
1119 int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1120 unsigned int interval);
1122 /* Event notifications from upper layer management operations */
1125 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1126 * @p2p: P2P module context from p2p_init()
1127 * @mac_addr: Peer address
1129 * This function is used to report successfully completed WPS provisioning
1130 * during group formation in both GO/Registrar and client/Enrollee roles.
1132 void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1135 * p2p_group_formation_failed - Report failed WPS provisioning
1136 * @p2p: P2P module context from p2p_init()
1138 * This function is used to report failed group formation. This can happen
1139 * either due to failed WPS provisioning or due to 15 second timeout during
1140 * the provisioning phase.
1142 void p2p_group_formation_failed(struct p2p_data *p2p);
1145 * p2p_get_provisioning_info - Get any stored provisioning info
1146 * @p2p: P2P module context from p2p_init()
1147 * @addr: Peer P2P Device Address
1148 * Returns: WPS provisioning information (WPS config method) or 0 if no
1149 * information is available
1151 * This function is used to retrieve stored WPS provisioning info for the given
1154 u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1157 * p2p_clear_provisioning_info - Clear any stored provisioning info
1158 * @p2p: P2P module context from p2p_init()
1159 * @iface_addr: Peer P2P Device Address
1161 * This function is used to clear stored WPS provisioning info for the given
1164 void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1167 /* Event notifications from lower layer driver operations */
1170 * enum p2p_probe_req_status
1172 * @P2P_PREQ_MALFORMED: frame was not well-formed
1173 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1174 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1175 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1176 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1178 enum p2p_probe_req_status {
1180 P2P_PREQ_NOT_LISTEN,
1182 P2P_PREQ_NOT_PROCESSED,
1187 * p2p_probe_req_rx - Report reception of a Probe Request frame
1188 * @p2p: P2P module context from p2p_init()
1189 * @addr: Source MAC address
1190 * @dst: Destination MAC address if available or %NULL
1191 * @bssid: BSSID if available or %NULL
1192 * @ie: Information elements from the Probe Request frame body
1193 * @ie_len: Length of ie buffer in octets
1194 * Returns: value indicating the type and status of the probe request
1196 enum p2p_probe_req_status
1197 p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1198 const u8 *bssid, const u8 *ie, size_t ie_len);
1201 * p2p_rx_action - Report received Action frame
1202 * @p2p: P2P module context from p2p_init()
1203 * @da: Destination address of the received Action frame
1204 * @sa: Source address of the received Action frame
1205 * @bssid: Address 3 of the received Action frame
1206 * @category: Category of the received Action frame
1207 * @data: Action frame body after the Category field
1208 * @len: Length of the data buffer in octets
1209 * @freq: Frequency (in MHz) on which the frame was received
1211 void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1212 const u8 *bssid, u8 category,
1213 const u8 *data, size_t len, int freq);
1216 * p2p_scan_res_handler - Indicate a P2P scan results
1217 * @p2p: P2P module context from p2p_init()
1218 * @bssid: BSSID of the scan result
1219 * @freq: Frequency of the channel on which the device was found in MHz
1220 * @rx_time: Time when the result was received
1221 * @level: Signal level (signal strength of the received Beacon/Probe Response
1223 * @ies: Pointer to IEs from the scan result
1224 * @ies_len: Length of the ies buffer
1225 * Returns: 0 to continue or 1 to stop scan result indication
1227 * This function is called to indicate a scan result entry with P2P IE from a
1228 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1229 * the actual scan process (i.e., whenever a new device is found) or as a
1230 * sequence of calls after the full scan has been completed. The former option
1231 * can result in optimized operations, but may not be supported by all
1232 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1233 * but it is recommended to include all IEs received from the device. The
1234 * caller does not need to check that the IEs contain a P2P IE before calling
1235 * this function since frames will be filtered internally if needed.
1237 * This function will return 1 if it wants to stop scan result iteration (and
1238 * scan in general if it is still in progress). This is used to allow faster
1239 * start of a pending operation, e.g., to start a pending GO negotiation.
1241 int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1242 struct os_time *rx_time, int level, const u8 *ies,
1246 * p2p_scan_res_handled - Indicate end of scan results
1247 * @p2p: P2P module context from p2p_init()
1249 * This function is called to indicate that all P2P scan results from a scan
1250 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1251 * function must be called as a response to successful
1252 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1253 * calls stopped iteration.
1255 void p2p_scan_res_handled(struct p2p_data *p2p);
1257 enum p2p_send_action_result {
1258 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1259 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1260 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1264 * p2p_send_action_cb - Notify TX status of an Action frame
1265 * @p2p: P2P module context from p2p_init()
1266 * @freq: Channel frequency in MHz
1267 * @dst: Destination MAC address (Address 1)
1268 * @src: Source MAC address (Address 2)
1269 * @bssid: BSSID (Address 3)
1270 * @result: Result of the transmission attempt
1272 * This function is used to indicate the result of an Action frame transmission
1273 * that was requested with struct p2p_config::send_action() callback.
1275 void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1276 const u8 *src, const u8 *bssid,
1277 enum p2p_send_action_result result);
1280 * p2p_listen_cb - Indicate the start of a requested Listen state
1281 * @p2p: P2P module context from p2p_init()
1282 * @freq: Listen channel frequency in MHz
1283 * @duration: Duration for the Listen state in milliseconds
1285 * This function is used to indicate that a Listen state requested with
1286 * struct p2p_config::start_listen() callback has started.
1288 void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1289 unsigned int duration);
1292 * p2p_listen_end - Indicate the end of a requested Listen state
1293 * @p2p: P2P module context from p2p_init()
1294 * @freq: Listen channel frequency in MHz
1295 * Returns: 0 if no operations were started, 1 if an operation was started
1297 * This function is used to indicate that a Listen state requested with
1298 * struct p2p_config::start_listen() callback has ended.
1300 int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1302 void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1303 const u8 *ie, size_t ie_len);
1305 void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1306 const u8 *ie, size_t ie_len);
1309 /* Per-group P2P state for GO */
1314 * struct p2p_group_config - P2P group configuration
1316 * This configuration is provided to the P2P module during initialization of
1317 * the per-group information with p2p_group_init().
1319 struct p2p_group_config {
1321 * persistent_group - Whether the group is persistent
1322 * 0 = not a persistent group
1323 * 1 = persistent group without persistent reconnect
1324 * 2 = persistent group with persistent reconnect
1326 int persistent_group;
1329 * interface_addr - P2P Interface Address of the group
1331 u8 interface_addr[ETH_ALEN];
1334 * max_clients - Maximum number of clients in the group
1336 unsigned int max_clients;
1344 * ssid_len - Length of SSID
1349 * cb_ctx - Context to use with callback functions
1354 * ie_update - Notification of IE update
1355 * @ctx: Callback context from cb_ctx
1356 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1357 * @proberesp_ies: P2P Ie for Probe Response frames
1359 * P2P module uses this callback function to notify whenever the P2P IE
1360 * in Beacon or Probe Response frames should be updated based on group
1363 * The callee is responsible for freeing the returned buffer(s) with
1366 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1367 struct wpabuf *proberesp_ies);
1370 * idle_update - Notification of changes in group idle state
1371 * @ctx: Callback context from cb_ctx
1372 * @idle: Whether the group is idle (no associated stations)
1374 void (*idle_update)(void *ctx, int idle);
1378 * p2p_group_init - Initialize P2P group
1379 * @p2p: P2P module context from p2p_init()
1380 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1381 * Returns: Pointer to private data or %NULL on failure
1383 * This function is used to initialize per-group P2P module context. Currently,
1384 * this is only used to manage GO functionality and P2P clients do not need to
1385 * create an instance of this per-group information.
1387 struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1388 struct p2p_group_config *config);
1391 * p2p_group_deinit - Deinitialize P2P group
1392 * @group: P2P group context from p2p_group_init()
1394 void p2p_group_deinit(struct p2p_group *group);
1397 * p2p_group_notif_assoc - Notification of P2P client association with GO
1398 * @group: P2P group context from p2p_group_init()
1399 * @addr: Interface address of the P2P client
1400 * @ie: IEs from the (Re)association Request frame
1401 * @len: Length of the ie buffer in octets
1402 * Returns: 0 on success, -1 on failure
1404 int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1405 const u8 *ie, size_t len);
1408 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1409 * @group: P2P group context from p2p_group_init()
1410 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1411 * Returns: P2P IE for (Re)association Response or %NULL on failure
1413 * The caller is responsible for freeing the returned buffer with
1416 struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1419 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1420 * @group: P2P group context from p2p_group_init()
1421 * @addr: Interface address of the P2P client
1423 void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1426 * p2p_group_notif_formation_done - Notification of completed group formation
1427 * @group: P2P group context from p2p_group_init()
1429 void p2p_group_notif_formation_done(struct p2p_group *group);
1432 * p2p_group_notif_noa - Notification of NoA change
1433 * @group: P2P group context from p2p_group_init()
1434 * @noa: Notice of Absence attribute payload, %NULL if none
1435 * @noa_len: Length of noa buffer in octets
1436 * Returns: 0 on success, -1 on failure
1438 * Notify the P2P group management about a new NoA contents. This will be
1439 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1440 * the group information.
1442 int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1446 * p2p_group_match_dev_type - Match device types in group with requested type
1447 * @group: P2P group context from p2p_group_init()
1448 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1449 * Returns: 1 on match, 0 on mismatch
1451 * This function can be used to match the Requested Device Type attribute in
1452 * WPS IE with the device types of a group member for deciding whether a GO
1453 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1454 * is not requested any specific device type.
1456 int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1459 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1461 int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1464 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1465 * @group: P2P group context from p2p_group_init()
1466 * Returns: 0 on success (frame scheduled); -1 if client was not found
1468 int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1469 const u8 *searching_dev, int rx_freq);
1472 /* Generic helper functions */
1475 * p2p_ie_text - Build text format description of P2P IE
1477 * @buf: Buffer for returning text
1478 * @end: Pointer to the end of the buf area
1479 * Returns: Number of octets written to the buffer or -1 on failure
1481 * This function can be used to parse P2P IE contents into text format
1482 * field=value lines.
1484 int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1487 * p2p_scan_result_text - Build text format description of P2P IE
1488 * @ies: Information elements from scan results
1489 * @ies_len: ies buffer length in octets
1490 * @buf: Buffer for returning text
1491 * @end: Pointer to the end of the buf area
1492 * Returns: Number of octets written to the buffer or -1 on failure
1494 * This function can be used to parse P2P IE contents into text format
1495 * field=value lines.
1497 int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1500 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1503 * @dev_addr: Buffer for returning P2P Device Address
1504 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1506 int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1509 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1510 * @ies: Information elements from scan results
1511 * @ies_len: ies buffer length in octets
1512 * @dev_addr: Buffer for returning P2P Device Address
1513 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1515 int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1518 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1519 * @p2p: P2P module context from p2p_init()
1521 * @buf: Buffer for writing the P2P IE
1522 * @len: Maximum buf length in octets
1523 * @p2p_group: Whether this is for association with a P2P GO
1524 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1525 * Returns: Number of octets written into buf or -1 on failure
1527 int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1528 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1531 * p2p_scan_ie - Build P2P IE for Probe Request
1532 * @p2p: P2P module context from p2p_init()
1533 * @ies: Buffer for writing P2P IE
1534 * @dev_id: Device ID to search for or %NULL for any
1536 void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
1539 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1540 * @p2p: P2P module context from p2p_init()
1541 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1543 size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1546 * p2p_go_params - Generate random P2P group parameters
1547 * @p2p: P2P module context from p2p_init()
1548 * @params: Buffer for parameters
1549 * Returns: 0 on success, -1 on failure
1551 int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1554 * p2p_get_group_capab - Get Group Capability from P2P IE data
1555 * @p2p_ie: P2P IE(s) contents
1556 * Returns: Group Capability
1558 u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1561 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1562 * @p2p_ie: P2P IE(s) contents
1563 * Returns: 0 if cross connection is allow, 1 if not
1565 int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1568 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1569 * @p2p_ie: P2P IE(s) contents
1570 * Returns: Pointer to P2P Device Address or %NULL if not included
1572 const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1575 * p2p_get_peer_info - Get P2P peer information
1576 * @p2p: P2P module context from p2p_init()
1577 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1578 * @next: Whether to select the peer entry following the one indicated by addr
1579 * Returns: Pointer to peer info or %NULL if not found
1581 const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1582 const u8 *addr, int next);
1585 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1586 * @info: Pointer to P2P peer info from p2p_get_peer_info()
1587 * @buf: Buffer for returning text
1588 * @buflen: Maximum buffer length
1589 * Returns: Number of octets written to the buffer or -1 on failure
1591 * Note: This information is internal to the P2P module and subject to change.
1592 * As such, this should not really be used by external programs for purposes
1593 * other than debugging.
1595 int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1596 char *buf, size_t buflen);
1599 * p2p_peer_known - Check whether P2P peer is known
1600 * @p2p: P2P module context from p2p_init()
1601 * @addr: P2P Device Address of the peer
1602 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1604 int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1607 * p2p_set_client_discoverability - Set client discoverability capability
1608 * @p2p: P2P module context from p2p_init()
1609 * @enabled: Whether client discoverability will be enabled
1611 * This function can be used to disable (and re-enable) client discoverability.
1612 * This capability is enabled by default and should not be disabled in normal
1613 * use cases, i.e., this is mainly for testing purposes.
1615 void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1618 * p2p_set_managed_oper - Set managed P2P Device operations capability
1619 * @p2p: P2P module context from p2p_init()
1620 * @enabled: Whether managed P2P Device operations will be enabled
1622 void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1624 int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
1626 int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1628 int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1630 int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1633 void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1636 * p2p_set_cross_connect - Set cross connection capability
1637 * @p2p: P2P module context from p2p_init()
1638 * @enabled: Whether cross connection will be enabled
1640 void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1642 int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1645 * p2p_set_intra_bss_dist - Set intra BSS distribution
1646 * @p2p: P2P module context from p2p_init()
1647 * @enabled: Whether intra BSS distribution will be enabled
1649 void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1651 int p2p_channels_includes_freq(const struct p2p_channels *channels,
1655 * p2p_supported_freq - Check whether channel is supported for P2P
1656 * @p2p: P2P module context from p2p_init()
1657 * @freq: Channel frequency in MHz
1658 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1660 int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1663 * p2p_get_pref_freq - Get channel from preferred channel list
1664 * @p2p: P2P module context from p2p_init()
1665 * @channels: List of channels
1666 * Returns: Preferred channel
1668 unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
1669 const struct p2p_channels *channels);
1671 void p2p_update_channel_list(struct p2p_data *p2p, struct p2p_channels *chan);
1674 * p2p_set_best_channels - Update best channel information
1675 * @p2p: P2P module context from p2p_init()
1676 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1677 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1678 * @freq_overall: Frequency (MHz) of best channel overall
1680 void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1684 * p2p_set_own_freq_preference - Set own preference for channel
1685 * @p2p: P2P module context from p2p_init()
1686 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
1688 * This function can be used to set a preference on the operating channel based
1689 * on frequencies used on the other virtual interfaces that share the same
1690 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
1692 void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
1694 const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1697 * p2p_get_group_num_members - Get number of members in group
1698 * @group: P2P group context from p2p_group_init()
1699 * Returns: Number of members in the group
1701 unsigned int p2p_get_group_num_members(struct p2p_group *group);
1704 * p2p_iterate_group_members - Iterate group members
1705 * @group: P2P group context from p2p_group_init()
1706 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1707 * on the first call and not modified later
1708 * Returns: A P2P Interface Address for each call and %NULL for no more members
1710 const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1713 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1714 * @group: P2P group context from p2p_group_init()
1715 * @addr: P2P Interface Address of the client
1716 * Returns: P2P Device Address of the client if found or %NULL if no match
1719 const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1722 * p2p_group_is_client_connected - Check whether a specific client is connected
1723 * @group: P2P group context from p2p_group_init()
1724 * @addr: P2P Device Address of the client
1725 * Returns: 1 if client is connected or 0 if not
1727 int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1730 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1731 * @p2p: P2P module context from p2p_init()
1732 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1733 * @next: Whether to select the peer entry following the one indicated by addr
1734 * Returns: The first P2P peer info available or %NULL if no such peer exists
1736 const struct p2p_peer_info *
1737 p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1740 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1741 * @p2p: P2P module context from p2p_init()
1743 void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1746 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1747 * @p2p: P2P module context from p2p_init()
1748 * @vendor_ext: The vendor extensions to add
1749 * Returns: 0 on success, -1 on failure
1751 * The wpabuf structures in the array are owned by the P2P
1752 * module after this call.
1754 int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1755 const struct wpabuf *vendor_ext);
1758 * p2p_set_oper_channel - Set the P2P operating channel
1759 * @p2p: P2P module context from p2p_init()
1760 * @op_reg_class: Operating regulatory class to set
1761 * @op_channel: operating channel to set
1762 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1763 * Returns: 0 on success, -1 on failure
1765 int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1766 int cfg_op_channel);
1769 * p2p_set_pref_chan - Set P2P preferred channel list
1770 * @p2p: P2P module context from p2p_init()
1771 * @num_pref_chan: Number of entries in pref_chan list
1772 * @pref_chan: Preferred channels or %NULL to remove preferences
1773 * Returns: 0 on success, -1 on failure
1775 int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1776 const struct p2p_channel *pref_chan);
1779 * p2p_in_progress - Check whether a P2P operation is progress
1780 * @p2p: P2P module context from p2p_init()
1781 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1783 int p2p_in_progress(struct p2p_data *p2p);
1787 * p2p_search_in_progress - Check whether a P2P SEARCH is in progress
1788 * @p2p: P2P module context from p2p_init()
1789 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1791 int p2p_search_in_progress(struct p2p_data *p2p);
1794 * p2p_search_pending - Check whether there is a deferred P2P SEARCH
1795 * @p2p: P2P module context from p2p_init()
1796 * Returns: 0 if there is no deferred P2P search or 1 if there is one
1798 int p2p_search_pending(struct p2p_data *p2p);
1802 * p2p_other_scan_completed - Notify completion of non-P2P scan
1803 * @p2p: P2P module context from p2p_init()
1804 * Returns: 0 if P2P module is idle or 1 if an operation was started
1806 int p2p_other_scan_completed(struct p2p_data *p2p);
1808 const char * p2p_wps_method_text(enum p2p_wps_method method);
1811 * p2p_set_config_timeout - Set local config timeouts
1812 * @p2p: P2P module context from p2p_init()
1813 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1814 * @client_timeout: Time in 10 ms units it takes to start the client mode
1816 void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1819 void p2p_increase_search_delay(struct p2p_data *p2p, unsigned int delay);
1821 int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1822 int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1823 int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1824 int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1825 int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
1826 int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
1827 int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
1828 int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
1829 int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
1830 int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
1831 int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
1832 const struct wpabuf *elem);
1833 struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
1836 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
1837 * @p2p: P2P module context from p2p_init()
1838 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
1839 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
1840 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
1842 * Returns: 0 on success, or -1 on failure
1844 * This function can be used to configure minDiscoverableInterval and
1845 * maxDiscoverableInterval parameters for the Listen state during device
1846 * discovery (p2p_find). A random number of 100 TU units is picked for each
1847 * Listen state iteration from [min_disc_int,max_disc_int] range.
1849 * max_disc_tu can be used to futher limit the discoverable duration. However,
1850 * it should be noted that use of this parameter is not recommended since it
1851 * would not be compliant with the P2P specification.
1853 int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,