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
;
133 P2P_SCAN_SOCIAL_PLUS_ONE
137 * struct p2p_config - P2P configuration
139 * This configuration is provided to the P2P module during initialization with
144 * country - Country code to use in P2P operations
149 * reg_class - Regulatory class for own listen channel
154 * channel - Own listen channel
159 * Regulatory class for own operational channel
164 * op_channel - Own operational channel
169 * channels - Own supported regulatory classes and channels
171 * List of supposerted channels per regulatory class. The regulatory
172 * classes are defined in IEEE Std 802.11-2007 Annex J and the
173 * numbering of the clases depends on the configured country code.
175 struct p2p_channels channels
;
178 * pri_dev_type - Primary Device Type (see WPS)
183 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
185 #define P2P_SEC_DEVICE_TYPES 5
188 * sec_dev_type - Optional secondary device types
190 u8 sec_dev_type
[P2P_SEC_DEVICE_TYPES
][8];
193 * dev_addr - P2P Device Address
195 u8 dev_addr
[ETH_ALEN
];
198 * dev_name - Device Name
203 * num_sec_dev_types - Number of sec_dev_type entries
205 size_t num_sec_dev_types
;
208 * concurrent_operations - Whether concurrent operations are supported
210 int concurrent_operations
;
213 * max_peers - Maximum number of discovered peers to remember
215 * If more peers are discovered, older entries will be removed to make
216 * room for the new ones.
221 * ssid_postfix - Postfix data to add to the SSID
223 * This data will be added to the end of the SSID after the
224 * DIRECT-<random two octets> prefix.
226 u8 ssid_postfix
[32 - 9];
229 * ssid_postfix_len - Length of the ssid_postfix data
231 size_t ssid_postfix_len
;
234 * msg_ctx - Context to use with wpa_msg() calls
239 * cb_ctx - Context to use with callback functions
244 /* Callbacks to request lower layer driver operations */
247 * p2p_scan - Request a P2P scan/search
248 * @ctx: Callback context from cb_ctx
250 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
251 * Returns: 0 on success, -1 on failure
253 * This callback function is used to request a P2P scan or search
254 * operation to be completed. Type type argument specifies which type
255 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
256 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
257 * indicates that all channels are to be scanned. @P2P_SCAN_SPECIFIC
258 * request a scan of a single channel specified by freq.
259 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
260 * plus one extra channel specified by freq.
262 * The full scan is used for the initial scan to find group owners from
263 * all. The other types are used during search phase scan of the social
264 * channels (with potential variation if the Listen channel of the
265 * target peer is known or if other channels are scanned in steps).
267 * The scan results are returned after this call by calling
268 * p2p_scan_res_handler() for each scan result that has a P2P IE and
269 * then calling p2p_scan_res_handled() to indicate that all scan
270 * results have been indicated.
272 int (*p2p_scan
)(void *ctx
, enum p2p_scan_type type
, int freq
);
275 * send_probe_resp - Transmit a Probe Response frame
276 * @ctx: Callback context from cb_ctx
277 * @buf: Probe Response frame (including the header and body)
278 * Returns: 0 on success, -1 on failure
280 * This function is used to reply to Probe Request frames that were
281 * indicated with a call to p2p_probe_req_rx(). The response is to be
282 * sent on the same channel or to be dropped if the driver is not
283 * anymore listening to Probe Request frames.
285 * Alternatively, the responsibility for building the Probe Response
286 * frames in Listen state may be in another system component in which
287 * case this function need to be implemented (i.e., the function
288 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
289 * Response frames in such a case are available from the
290 * start_listen() callback. It should be noted that the received Probe
291 * Request frames must be indicated by calling p2p_probe_req_rx() even
292 * if this send_probe_resp() is not used.
294 int (*send_probe_resp
)(void *ctx
, const struct wpabuf
*buf
);
297 * send_action - Transmit an Action frame
298 * @ctx: Callback context from cb_ctx
299 * @freq: Frequency in MHz for the channel on which to transmit
300 * @dst: Destination MAC address (Address 1)
301 * @src: Source MAC address (Address 2)
302 * @bssid: BSSID (Address 3)
303 * @buf: Frame body (starting from Category field)
304 * @len: Length of buf in octets
305 * @wait_time: How many msec to wait for a response frame
306 * Returns: 0 on success, -1 on failure
308 * The Action frame may not be transmitted immediately and the status
309 * of the transmission must be reported by calling
310 * p2p_send_action_cb() once the frame has either been transmitted or
311 * it has been dropped due to excessive retries or other failure to
314 int (*send_action
)(void *ctx
, unsigned int freq
, const u8
*dst
,
315 const u8
*src
, const u8
*bssid
, const u8
*buf
,
316 size_t len
, unsigned int wait_time
);
319 * send_action_done - Notify that Action frame sequence was completed
320 * @ctx: Callback context from cb_ctx
322 * This function is called when the Action frame sequence that was
323 * started with send_action() has been completed, i.e., when there is
324 * no need to wait for a response from the destination peer anymore.
326 void (*send_action_done
)(void *ctx
);
329 * start_listen - Start Listen state
330 * @ctx: Callback context from cb_ctx
331 * @freq: Frequency of the listen channel in MHz
332 * @duration: Duration for the Listen state in milliseconds
333 * @probe_resp_ie: IE(s) to be added to Probe Response frames
334 * Returns: 0 on success, -1 on failure
336 * This Listen state may not start immediately since the driver may
337 * have other pending operations to complete first. Once the Listen
338 * state has started, p2p_listen_cb() must be called to notify the P2P
339 * module. Once the Listen state is stopped, p2p_listen_end() must be
340 * called to notify the P2P module that the driver is not in the Listen
343 * If the send_probe_resp() is not used for generating the response,
344 * the IEs from probe_resp_ie need to be added to the end of the Probe
345 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
346 * information can be ignored.
348 int (*start_listen
)(void *ctx
, unsigned int freq
,
349 unsigned int duration
,
350 const struct wpabuf
*probe_resp_ie
);
352 * stop_listen - Stop Listen state
353 * @ctx: Callback context from cb_ctx
355 * This callback can be used to stop a Listen state operation that was
356 * previously requested with start_listen().
358 void (*stop_listen
)(void *ctx
);
361 * get_noa - Get current Notice of Absence attribute payload
362 * @ctx: Callback context from cb_ctx
363 * @interface_addr: P2P Interface Address of the GO
364 * @buf: Buffer for returning NoA
365 * @buf_len: Buffer length in octets
366 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
367 * advertized, or -1 on failure
369 * This function is used to fetch the current Notice of Absence
370 * attribute value from GO.
372 int (*get_noa
)(void *ctx
, const u8
*interface_addr
, u8
*buf
,
375 /* Callbacks to notify events to upper layer management entity */
378 * dev_found - Notification of a found P2P Device
379 * @ctx: Callback context from cb_ctx
380 * @addr: Source address of the message triggering this notification
381 * @dev_addr: P2P Device Address of the found P2P Device
382 * @pri_dev_type: Primary Device Type
383 * @dev_name: Device Name
384 * @config_methods: Configuration Methods
385 * @dev_capab: Device Capabilities
386 * @group_capab: Group Capabilities
388 * This callback is used to notify that a new P2P Device has been
389 * found. This may happen, e.g., during Search state based on scan
390 * results or during Listen state based on receive Probe Request and
391 * Group Owner Negotiation Request.
393 void (*dev_found
)(void *ctx
, const u8
*addr
, const u8
*dev_addr
,
394 const u8
*pri_dev_type
, const char *dev_name
,
395 u16 config_methods
, u8 dev_capab
, u8 group_capab
);
398 * go_neg_req_rx - Notification of a receive GO Negotiation Request
399 * @ctx: Callback context from cb_ctx
400 * @src: Source address of the message triggering this notification
402 * This callback is used to notify that a P2P Device is requesting
403 * group owner negotiation with us, but we do not have all the
404 * necessary information to start GO Negotiation. This indicates that
405 * the local user has not authorized the connection yet by providing a
406 * PIN or PBC button press. This information can be provided with a
407 * call to p2p_connect().
409 void (*go_neg_req_rx
)(void *ctx
, const u8
*src
);
412 * go_neg_completed - Notification of GO Negotiation results
413 * @ctx: Callback context from cb_ctx
414 * @res: GO Negotiation results
416 * This callback is used to notify that Group Owner Negotiation has
417 * been completed. Non-zero struct p2p_go_neg_results::status indicates
418 * failed negotiation. In case of success, this function is responsible
419 * for creating a new group interface (or using the existing interface
420 * depending on driver features), setting up the group interface in
421 * proper mode based on struct p2p_go_neg_results::role_go and
422 * initializing WPS provisioning either as a Registrar (if GO) or as an
423 * Enrollee. Successful WPS provisioning must be indicated by calling
424 * p2p_wps_success_cb(). The callee is responsible for timing out group
425 * formation if WPS provisioning cannot be completed successfully
428 void (*go_neg_completed
)(void *ctx
, struct p2p_go_neg_results
*res
);
431 * sd_request - Callback on Service Discovery Request
432 * @ctx: Callback context from cb_ctx
433 * @freq: Frequency (in MHz) of the channel
434 * @sa: Source address of the request
435 * @dialog_token: Dialog token
436 * @update_indic: Service Update Indicator from the source of request
437 * @tlvs: P2P Service Request TLV(s)
438 * @tlvs_len: Length of tlvs buffer in octets
440 * This callback is used to indicate reception of a service discovery
441 * request. Response to the query must be indicated by calling
442 * p2p_sd_response() with the context information from the arguments to
443 * this callback function.
445 * This callback handler can be set to %NULL to indicate that service
446 * discovery is not supported.
448 void (*sd_request
)(void *ctx
, int freq
, const u8
*sa
, u8 dialog_token
,
449 u16 update_indic
, const u8
*tlvs
, size_t tlvs_len
);
452 * sd_response - Callback on Service Discovery Response
453 * @ctx: Callback context from cb_ctx
454 * @sa: Source address of the request
455 * @update_indic: Service Update Indicator from the source of response
456 * @tlvs: P2P Service Response TLV(s)
457 * @tlvs_len: Length of tlvs buffer in octets
459 * This callback is used to indicate reception of a service discovery
460 * response. This callback handler can be set to %NULL if no service
461 * discovery requests are used. The information provided with this call
462 * is replies to the queries scheduled with p2p_sd_request().
464 void (*sd_response
)(void *ctx
, const u8
*sa
, u16 update_indic
,
465 const u8
*tlvs
, size_t tlvs_len
);
468 * prov_disc_req - Callback on Provisiong Discovery Request
469 * @ctx: Callback context from cb_ctx
470 * @peer: Source address of the request
471 * @config_methods: Requested WPS Config Method
472 * @dev_addr: P2P Device Address of the found P2P Device
473 * @pri_dev_type: Primary Device Type
474 * @dev_name: Device Name
475 * @supp_config_methods: Supported configuration Methods
476 * @dev_capab: Device Capabilities
477 * @group_capab: Group Capabilities
479 * This callback is used to indicate reception of a Provision Discovery
480 * Request frame that the P2P module accepted.
482 void (*prov_disc_req
)(void *ctx
, const u8
*peer
, u16 config_methods
,
483 const u8
*dev_addr
, const u8
*pri_dev_type
,
484 const char *dev_name
, u16 supp_config_methods
,
485 u8 dev_capab
, u8 group_capab
);
488 * prov_disc_resp - Callback on Provisiong Discovery Response
489 * @ctx: Callback context from cb_ctx
490 * @peer: Source address of the response
491 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
493 * This callback is used to indicate reception of a Provision Discovery
494 * Response frame for a pending request scheduled with
495 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
496 * provision discovery is not used.
498 void (*prov_disc_resp
)(void *ctx
, const u8
*peer
, u16 config_methods
);
501 * invitation_process - Optional callback for processing Invitations
502 * @ctx: Callback context from cb_ctx
503 * @sa: Source address of the Invitation Request
504 * @bssid: P2P Group BSSID from the request or %NULL if not included
505 * @go_dev_addr: GO Device Address from P2P Group ID
506 * @ssid: SSID from P2P Group ID
507 * @ssid_len: Length of ssid buffer in octets
508 * @go: Variable for returning whether the local end is GO in the group
509 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
510 * @force_freq: Variable for returning forced frequency for the group
511 * @persistent_group: Whether this is an invitation to reinvoke a
512 * persistent group (instead of invitation to join an active
514 * Returns: Status code (P2P_SC_*)
516 * This optional callback can be used to implement persistent reconnect
517 * by allowing automatic restarting of persistent groups without user
518 * interaction. If this callback is not implemented (i.e., is %NULL),
519 * the received Invitation Request frames are replied with
520 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
521 * invitation_result() callback.
523 * If the requested parameters are acceptable and the group is known,
524 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
525 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
526 * can be returned if there is not enough data to provide immediate
527 * response, i.e., if some sort of user interaction is needed. The
528 * invitation_received() callback will be called in that case
529 * immediately after this call.
531 u8 (*invitation_process
)(void *ctx
, const u8
*sa
, const u8
*bssid
,
532 const u8
*go_dev_addr
, const u8
*ssid
,
533 size_t ssid_len
, int *go
, u8
*group_bssid
,
534 int *force_freq
, int persistent_group
);
537 * invitation_received - Callback on Invitation Request RX
538 * @ctx: Callback context from cb_ctx
539 * @sa: Source address of the Invitation Request
540 * @bssid: P2P Group BSSID or %NULL if not received
541 * @ssid: SSID of the group
542 * @ssid_len: Length of ssid in octets
543 * @go_dev_addr: GO Device Address
544 * @status: Response Status
545 * @op_freq: Operational frequency for the group
547 * This callback is used to indicate sending of an Invitation Response
548 * for a received Invitation Request. If status == 0 (success), the
549 * upper layer code is responsible for starting the group. status == 1
550 * indicates need to get user authorization for the group. Other status
551 * values indicate that the invitation request was rejected.
553 void (*invitation_received
)(void *ctx
, const u8
*sa
, const u8
*bssid
,
554 const u8
*ssid
, size_t ssid_len
,
555 const u8
*go_dev_addr
, u8 status
,
559 * invitation_result - Callback on Invitation result
560 * @ctx: Callback context from cb_ctx
561 * @status: Negotiation result (Status Code)
562 * @bssid: P2P Group BSSID or %NULL if not received
564 * This callback is used to indicate result of an Invitation procedure
565 * started with a call to p2p_invite(). The indicated status code is
566 * the value received from the peer in Invitation Response with 0
567 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
568 * local failure in transmitting the Invitation Request.
570 void (*invitation_result
)(void *ctx
, int status
, const u8
*bssid
);
574 /* P2P module initialization/deinitialization */
577 * p2p_init - Initialize P2P module
578 * @cfg: P2P module configuration
579 * Returns: Pointer to private data or %NULL on failure
581 * This function is used to initialize global P2P module context (one per
582 * device). The P2P module will keep a copy of the configuration data, so the
583 * caller does not need to maintain this structure. However, the callback
584 * functions and the context parameters to them must be kept available until
585 * the P2P module is deinitialized with p2p_deinit().
587 struct p2p_data
* p2p_init(const struct p2p_config
*cfg
);
590 * p2p_deinit - Deinitialize P2P module
591 * @p2p: P2P module context from p2p_init()
593 void p2p_deinit(struct p2p_data
*p2p
);
596 * p2p_flush - Flush P2P module state
597 * @p2p: P2P module context from p2p_init()
599 * This command removes the P2P module state like peer device entries.
601 void p2p_flush(struct p2p_data
*p2p
);
604 * p2p_set_dev_name - Set device name
605 * @p2p: P2P module context from p2p_init()
606 * Returns: 0 on success, -1 on failure
608 * This function can be used to update the P2P module configuration with
609 * information that was not available at the time of the p2p_init() call.
611 int p2p_set_dev_name(struct p2p_data
*p2p
, const char *dev_name
);
614 * p2p_set_pri_dev_type - Set primary device type
615 * @p2p: P2P module context from p2p_init()
616 * Returns: 0 on success, -1 on failure
618 * This function can be used to update the P2P module configuration with
619 * information that was not available at the time of the p2p_init() call.
621 int p2p_set_pri_dev_type(struct p2p_data
*p2p
, const u8
*pri_dev_type
);
624 * p2p_set_sec_dev_types - Set secondary device types
625 * @p2p: P2P module context from p2p_init()
626 * Returns: 0 on success, -1 on failure
628 * This function can be used to update the P2P module configuration with
629 * information that was not available at the time of the p2p_init() call.
631 int p2p_set_sec_dev_types(struct p2p_data
*p2p
, const u8 dev_types
[][8],
632 size_t num_dev_types
);
634 int p2p_set_country(struct p2p_data
*p2p
, const char *country
);
637 /* Commands from upper layer management entity */
639 enum p2p_discovery_type
{
640 P2P_FIND_START_WITH_FULL
,
641 P2P_FIND_ONLY_SOCIAL
,
646 * p2p_find - Start P2P Find (Device Discovery)
647 * @p2p: P2P module context from p2p_init()
648 * @timeout: Timeout for find operation in seconds or 0 for no timeout
649 * @type: Device Discovery type
650 * Returns: 0 on success, -1 on failure
652 int p2p_find(struct p2p_data
*p2p
, unsigned int timeout
,
653 enum p2p_discovery_type type
);
656 * p2p_stop_find - Stop P2P Find (Device Discovery)
657 * @p2p: P2P module context from p2p_init()
659 void p2p_stop_find(struct p2p_data
*p2p
);
662 * p2p_listen - Start P2P Listen state for specified duration
663 * @p2p: P2P module context from p2p_init()
664 * @timeout: Listen state duration in milliseconds
665 * Returns: 0 on success, -1 on failure
667 * This function can be used to request the P2P module to keep the device
668 * discoverable on the listen channel for an extended set of time. At least in
669 * its current form, this is mainly used for testing purposes and may not be of
670 * much use for normal P2P operations.
672 int p2p_listen(struct p2p_data
*p2p
, unsigned int timeout
);
675 * p2p_connect - Start P2P group formation (GO negotiation)
676 * @p2p: P2P module context from p2p_init()
677 * @peer_addr: MAC address of the peer P2P client
678 * @wps_method: WPS method to be used in provisioning
679 * @go_intent: Local GO intent value (1..15)
680 * @own_interface_addr: Intended interface address to use with the group
681 * @force_freq: The only allowed channel frequency in MHz or 0
682 * @persistent_group: Whether to create a persistent group
683 * Returns: 0 on success, -1 on failure
685 int p2p_connect(struct p2p_data
*p2p
, const u8
*peer_addr
,
686 enum p2p_wps_method wps_method
,
687 int go_intent
, const u8
*own_interface_addr
,
688 unsigned int force_freq
, int persistent_group
);
691 * p2p_authorize - Authorize P2P group formation (GO negotiation)
692 * @p2p: P2P module context from p2p_init()
693 * @peer_addr: MAC address of the peer P2P client
694 * @wps_method: WPS method to be used in provisioning
695 * @go_intent: Local GO intent value (1..15)
696 * @own_interface_addr: Intended interface address to use with the group
697 * @force_freq: The only allowed channel frequency in MHz or 0
698 * @persistent_group: Whether to create a persistent group
699 * Returns: 0 on success, -1 on failure
701 * This is like p2p_connect(), but the actual group negotiation is not
702 * initiated automatically, i.e., the other end is expected to do that.
704 int p2p_authorize(struct p2p_data
*p2p
, const u8
*peer_addr
,
705 enum p2p_wps_method wps_method
,
706 int go_intent
, const u8
*own_interface_addr
,
707 unsigned int force_freq
, int persistent_group
);
710 * p2p_reject - Reject peer device (explicitly block connection attempts)
711 * @p2p: P2P module context from p2p_init()
712 * @peer_addr: MAC address of the peer P2P client
713 * Returns: 0 on success, -1 on failure
715 int p2p_reject(struct p2p_data
*p2p
, const u8
*peer_addr
);
718 * p2p_prov_disc_req - Send Provision Discovery Request
719 * @p2p: P2P module context from p2p_init()
720 * @peer_addr: MAC address of the peer P2P client
721 * @config_methods: WPS Config Methods value (only one bit set)
722 * @join: Whether this is used by a client joining an active group
723 * Returns: 0 on success, -1 on failure
725 * This function can be used to request a discovered P2P peer to display a PIN
726 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
727 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
728 * is transmitted once immediately and if no response is received, the frame
729 * will be sent again whenever the target device is discovered during device
730 * dsicovery (start with a p2p_find() call). Response from the peer is
731 * indicated with the p2p_config::prov_disc_resp() callback.
733 int p2p_prov_disc_req(struct p2p_data
*p2p
, const u8
*peer_addr
,
734 u16 config_methods
, int join
);
737 * p2p_sd_request - Schedule a service discovery query
738 * @p2p: P2P module context from p2p_init()
739 * @dst: Destination peer or %NULL to apply for all peers
740 * @tlvs: P2P Service Query TLV(s)
741 * Returns: Reference to the query or %NULL on failure
743 * Response to the query is indicated with the p2p_config::sd_response()
746 void * p2p_sd_request(struct p2p_data
*p2p
, const u8
*dst
,
747 const struct wpabuf
*tlvs
);
750 * p2p_sd_cancel_request - Cancel a pending service discovery query
751 * @p2p: P2P module context from p2p_init()
752 * @req: Query reference from p2p_sd_request()
753 * Returns: 0 if request for cancelled; -1 if not found
755 int p2p_sd_cancel_request(struct p2p_data
*p2p
, void *req
);
758 * p2p_sd_response - Send response to a service discovery query
759 * @p2p: P2P module context from p2p_init()
760 * @freq: Frequency from p2p_config::sd_request() callback
761 * @dst: Destination address from p2p_config::sd_request() callback
762 * @dialog_token: Dialog token from p2p_config::sd_request() callback
763 * @resp_tlvs: P2P Service Response TLV(s)
765 * This function is called as a response to the request indicated with
766 * p2p_config::sd_request() callback.
768 void p2p_sd_response(struct p2p_data
*p2p
, int freq
, const u8
*dst
,
769 u8 dialog_token
, const struct wpabuf
*resp_tlvs
);
772 * p2p_sd_service_update - Indicate a change in local services
773 * @p2p: P2P module context from p2p_init()
775 * This function needs to be called whenever there is a change in availability
776 * of the local services. This will increment the Service Update Indicator
777 * value which will be used in SD Request and Response frames.
779 void p2p_sd_service_update(struct p2p_data
*p2p
);
782 enum p2p_invite_role
{
784 P2P_INVITE_ROLE_ACTIVE_GO
,
785 P2P_INVITE_ROLE_CLIENT
789 * p2p_invite - Invite a P2P Device into a group
790 * @p2p: P2P module context from p2p_init()
791 * @peer: Device Address of the peer P2P Device
792 * @role: Local role in the group
793 * @bssid: Group BSSID or %NULL if not known
795 * @ssid_len: Length of ssid in octets
796 * @force_freq: The only allowed channel frequency in MHz or 0
797 * @go_dev_addr: Forced GO Device Address or %NULL if none
798 * @persistent_group: Whether this is to reinvoke a persistent group
799 * Returns: 0 on success, -1 on failure
801 int p2p_invite(struct p2p_data
*p2p
, const u8
*peer
, enum p2p_invite_role role
,
802 const u8
*bssid
, const u8
*ssid
, size_t ssid_len
,
803 unsigned int force_freq
, const u8
*go_dev_addr
,
804 int persistent_group
);
807 * p2p_presence_req - Request GO presence
808 * @p2p: P2P module context from p2p_init()
809 * @go_interface_addr: GO P2P Interface Address
810 * @own_interface_addr: Own P2P Interface Address for this group
811 * @freq: Group operating frequence (in MHz)
812 * @duration1: Preferred presence duration in microseconds
813 * @interval1: Preferred presence interval in microseconds
814 * @duration2: Acceptable presence duration in microseconds
815 * @interval2: Acceptable presence interval in microseconds
816 * Returns: 0 on success, -1 on failure
818 * If both duration and interval values are zero, the parameter pair is not
819 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
821 int p2p_presence_req(struct p2p_data
*p2p
, const u8
*go_interface_addr
,
822 const u8
*own_interface_addr
, unsigned int freq
,
823 u32 duration1
, u32 interval1
, u32 duration2
,
827 * p2p_ext_listen - Set Extended Listen Timing
828 * @p2p: P2P module context from p2p_init()
829 * @freq: Group operating frequence (in MHz)
830 * @period: Availability period in milliseconds (1-65535; 0 to disable)
831 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
832 * Returns: 0 on success, -1 on failure
834 * This function can be used to enable or disable (period = interval = 0)
835 * Extended Listen Timing. When enabled, the P2P Device will become
836 * discoverable (go into Listen State) every @interval milliseconds for at
837 * least @period milliseconds.
839 int p2p_ext_listen(struct p2p_data
*p2p
, unsigned int period
,
840 unsigned int interval
);
842 /* Event notifications from upper layer management operations */
845 * p2p_wps_success_cb - Report successfully completed WPS provisioning
846 * @p2p: P2P module context from p2p_init()
847 * @mac_addr: Peer address
849 * This function is used to report successfully completed WPS provisioning
850 * during group formation in both GO/Registrar and client/Enrollee roles.
852 void p2p_wps_success_cb(struct p2p_data
*p2p
, const u8
*mac_addr
);
855 * p2p_group_formation_failed - Report failed WPS provisioning
856 * @p2p: P2P module context from p2p_init()
858 * This function is used to report failed group formation. This can happen
859 * either due to failed WPS provisioning or due to 15 second timeout during
860 * the provisioning phase.
862 void p2p_group_formation_failed(struct p2p_data
*p2p
);
865 /* Event notifications from lower layer driver operations */
868 * p2p_probe_req_rx - Report reception of a Probe Request frame
869 * @p2p: P2P module context from p2p_init()
870 * @addr: Source MAC address
871 * @ie: Information elements from the Probe Request frame body
872 * @ie_len: Length of ie buffer in octets
873 * Returns: 0 to indicate the frame was not processed or 1 if it was
875 int p2p_probe_req_rx(struct p2p_data
*p2p
, const u8
*addr
, const u8
*ie
,
879 * p2p_rx_action - Report received Action frame
880 * @p2p: P2P module context from p2p_init()
881 * @da: Destination address of the received Action frame
882 * @sa: Source address of the received Action frame
883 * @bssid: Address 3 of the received Action frame
884 * @category: Category of the received Action frame
885 * @data: Action frame body after the Category field
886 * @len: Length of the data buffer in octets
887 * @freq: Frequency (in MHz) on which the frame was received
889 void p2p_rx_action(struct p2p_data
*p2p
, const u8
*da
, const u8
*sa
,
890 const u8
*bssid
, u8 category
,
891 const u8
*data
, size_t len
, int freq
);
894 * p2p_scan_res_handler - Indicate a P2P scan results
895 * @p2p: P2P module context from p2p_init()
896 * @bssid: BSSID of the scan result
897 * @freq: Frequency of the channel on which the device was found in MHz
898 * @level: Signal level (signal strength of the received Beacon/Probe Response
900 * @ies: Pointer to IEs from the scan result
901 * @ies_len: Length of the ies buffer
902 * Returns: 0 to continue or 1 to stop scan result indication
904 * This function is called to indicate a scan result entry with P2P IE from a
905 * scan requested with struct p2p_config::p2p_scan(). This can be called during
906 * the actual scan process (i.e., whenever a new device is found) or as a
907 * sequence of calls after the full scan has been completed. The former option
908 * can result in optimized operations, but may not be supported by all
909 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
910 * but it is recommended to include all IEs received from the device. The
911 * caller does not need to check that the IEs contain a P2P IE before calling
912 * this function since frames will be filtered internally if needed.
914 * This function will return 1 if it wants to stop scan result iteration (and
915 * scan in general if it is still in progress). This is used to allow faster
916 * start of a pending operation, e.g., to start a pending GO negotiation.
918 int p2p_scan_res_handler(struct p2p_data
*p2p
, const u8
*bssid
, int freq
,
919 int level
, const u8
*ies
, size_t ies_len
);
922 * p2p_scan_res_handled - Indicate end of scan results
923 * @p2p: P2P module context from p2p_init()
925 * This function is called to indicate that all P2P scan results from a scan
926 * have been reported with zero or more calls to p2p_scan_res_handler(). This
927 * function must be called as a response to successful
928 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
929 * calls stopped iteration.
931 void p2p_scan_res_handled(struct p2p_data
*p2p
);
934 * p2p_send_action_cb - Notify TX status of an Action frame
935 * @p2p: P2P module context from p2p_init()
936 * @freq: Channel frequency in MHz
937 * @dst: Destination MAC address (Address 1)
938 * @src: Source MAC address (Address 2)
939 * @bssid: BSSID (Address 3)
940 * @success: Whether the transmission succeeded
942 * This function is used to indicate the result of an Action frame transmission
943 * that was requested with struct p2p_config::send_action() callback.
945 void p2p_send_action_cb(struct p2p_data
*p2p
, unsigned int freq
, const u8
*dst
,
946 const u8
*src
, const u8
*bssid
, int success
);
949 * p2p_listen_cb - Indicate the start of a requested Listen state
950 * @p2p: P2P module context from p2p_init()
951 * @freq: Listen channel frequency in MHz
952 * @duration: Duration for the Listen state in milliseconds
954 * This function is used to indicate that a Listen state requested with
955 * struct p2p_config::start_listen() callback has started.
957 void p2p_listen_cb(struct p2p_data
*p2p
, unsigned int freq
,
958 unsigned int duration
);
961 * p2p_listen_end - Indicate the end of a requested Listen state
962 * @p2p: P2P module context from p2p_init()
963 * @freq: Listen channel frequency in MHz
964 * Returns: 0 if no operations were started, 1 if an operation was started
966 * This function is used to indicate that a Listen state requested with
967 * struct p2p_config::start_listen() callback has ended.
969 int p2p_listen_end(struct p2p_data
*p2p
, unsigned int freq
);
971 void p2p_deauth_notif(struct p2p_data
*p2p
, const u8
*bssid
, u16 reason_code
,
972 const u8
*ie
, size_t ie_len
);
974 void p2p_disassoc_notif(struct p2p_data
*p2p
, const u8
*bssid
, u16 reason_code
,
975 const u8
*ie
, size_t ie_len
);
978 /* Per-group P2P state for GO */
983 * struct p2p_group_config - P2P group configuration
985 * This configuration is provided to the P2P module during initialization of
986 * the per-group information with p2p_group_init().
988 struct p2p_group_config
{
990 * persistent_group - Whether the group is persistent
992 int persistent_group
;
995 * interface_addr - P2P Interface Address of the group
997 u8 interface_addr
[ETH_ALEN
];
1000 * cb_ctx - Context to use with callback functions
1005 * ie_update - Notification of IE update
1006 * @ctx: Callback context from cb_ctx
1007 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1008 * @proberesp_ies: P2P Ie for Probe Response frames
1010 * P2P module uses this callback function to notify whenever the P2P IE
1011 * in Beacon or Probe Response frames should be updated based on group
1014 * The callee is responsible for freeing the returned buffer(s) with
1017 void (*ie_update
)(void *ctx
, struct wpabuf
*beacon_ies
,
1018 struct wpabuf
*proberesp_ies
);
1022 * p2p_group_init - Initialize P2P group
1023 * @p2p: P2P module context from p2p_init()
1024 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1025 * Returns: Pointer to private data or %NULL on failure
1027 * This function is used to initialize per-group P2P module context. Currently,
1028 * this is only used to manage GO functionality and P2P clients do not need to
1029 * create an instance of this per-group information.
1031 struct p2p_group
* p2p_group_init(struct p2p_data
*p2p
,
1032 struct p2p_group_config
*config
);
1035 * p2p_group_deinit - Deinitialize P2P group
1036 * @group: P2P group context from p2p_group_init()
1038 void p2p_group_deinit(struct p2p_group
*group
);
1041 * p2p_group_notif_assoc - Notification of P2P client association with GO
1042 * @group: P2P group context from p2p_group_init()
1043 * @addr: Interface address of the P2P client
1044 * @ie: IEs from the (Re)association Request frame
1045 * @len: Length of the ie buffer in octets
1046 * Returns: 0 on success, -1 on failure
1048 int p2p_group_notif_assoc(struct p2p_group
*group
, const u8
*addr
,
1049 const u8
*ie
, size_t len
);
1052 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1053 * @group: P2P group context from p2p_group_init()
1054 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1055 * Returns: P2P IE for (Re)association Response or %NULL on failure
1057 * The caller is responsible for freeing the returned buffer with
1060 struct wpabuf
* p2p_group_assoc_resp_ie(struct p2p_group
*group
, u8 status
);
1063 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1064 * @group: P2P group context from p2p_group_init()
1065 * @addr: Interface address of the P2P client
1067 void p2p_group_notif_disassoc(struct p2p_group
*group
, const u8
*addr
);
1070 * p2p_group_notif_formation_done - Notification of completed group formation
1071 * @group: P2P group context from p2p_group_init()
1073 void p2p_group_notif_formation_done(struct p2p_group
*group
);
1076 * p2p_group_notif_noa - Notification of NoA change
1077 * @group: P2P group context from p2p_group_init()
1078 * @noa: Notice of Absence attribute payload, %NULL if none
1079 * @noa_len: Length of noa buffer in octets
1080 * Returns: 0 on success, -1 on failure
1082 * Notify the P2P group management about a new NoA contents. This will be
1083 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1084 * the group information.
1086 int p2p_group_notif_noa(struct p2p_group
*group
, const u8
*noa
,
1090 * p2p_group_match_dev_type - Match device types in group with requested type
1091 * @group: P2P group context from p2p_group_init()
1092 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1093 * Returns: 1 on match, 0 on mismatch
1095 * This function can be used to match the Requested Device Type attribute in
1096 * WPS IE with the device types of a group member for deciding whether a GO
1097 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1098 * is not requested any specific device type.
1100 int p2p_group_match_dev_type(struct p2p_group
*group
, struct wpabuf
*wps
);
1103 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1104 * @group: P2P group context from p2p_group_init()
1105 * Returns: 0 on success (frame scheduled); -1 if client was not found
1107 int p2p_group_go_discover(struct p2p_group
*group
, const u8
*dev_id
,
1108 const u8
*searching_dev
, int rx_freq
);
1111 /* Generic helper functions */
1114 * p2p_ie_text - Build text format description of P2P IE
1116 * @buf: Buffer for returning text
1117 * @end: Pointer to the end of the buf area
1118 * Returns: Number of octets written to the buffer or -1 on failure
1120 * This function can be used to parse P2P IE contents into text format
1121 * field=value lines.
1123 int p2p_ie_text(struct wpabuf
*p2p_ie
, char *buf
, char *end
);
1126 * p2p_scan_result_text - Build text format description of P2P IE
1127 * @ies: Information elements from scan results
1128 * @ies_len: ies buffer length in octets
1129 * @buf: Buffer for returning text
1130 * @end: Pointer to the end of the buf area
1131 * Returns: Number of octets written to the buffer or -1 on failure
1133 * This function can be used to parse P2P IE contents into text format
1134 * field=value lines.
1136 int p2p_scan_result_text(const u8
*ies
, size_t ies_len
, char *buf
, char *end
);
1139 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1140 * @p2p: P2P module context from p2p_init()
1142 * @buf: Buffer for writing the P2P IE
1143 * @len: Maximum buf length in octets
1144 * @p2p_group: Whether this is for association with a P2P GO
1145 * Returns: Number of octets written into buf or -1 on failure
1147 int p2p_assoc_req_ie(struct p2p_data
*p2p
, const u8
*bssid
, u8
*buf
,
1148 size_t len
, int p2p_group
);
1151 * p2p_scan_ie - Build P2P IE for Probe Request
1152 * @p2p: P2P module context from p2p_init()
1153 * @ies: Buffer for writing P2P IE
1155 void p2p_scan_ie(struct p2p_data
*p2p
, struct wpabuf
*ies
);
1158 * p2p_go_params - Generate random P2P group parameters
1159 * @p2p: P2P module context from p2p_init()
1160 * @params: Buffer for parameters
1161 * Returns: 0 on success, -1 on failure
1163 int p2p_go_params(struct p2p_data
*p2p
, struct p2p_go_neg_results
*params
);
1166 * p2p_get_group_capab - Get Group Capability from P2P IE data
1167 * @p2p_ie: P2P IE(s) contents
1168 * Returns: Group Capability
1170 u8
p2p_get_group_capab(const struct wpabuf
*p2p_ie
);
1173 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1174 * @p2p_ie: P2P IE(s) contents
1175 * Returns: Pointer to P2P Device Address or %NULL if not included
1177 const u8
* p2p_get_go_dev_addr(const struct wpabuf
*p2p_ie
);
1180 * p2p_get_peer_info - Get P2P peer information in text format
1181 * @p2p: P2P module context from p2p_init()
1182 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1183 * @next: Whether to select the peer entry following the one indicated by addr
1184 * @buf: Buffer for returning text
1185 * @buflen: Maximum buffer length
1186 * Returns: Number of octets written to the buffer or -1 on failure
1188 int p2p_get_peer_info(struct p2p_data
*p2p
, const u8
*addr
, int next
,
1189 char *buf
, size_t buflen
);
1192 * p2p_set_client_discoverability - Set client discoverability capability
1193 * @p2p: P2P module context from p2p_init()
1194 * @enabled: Whether client discoverability will be enabled
1196 * This function can be used to disable (and re-enable) client discoverability.
1197 * This capability is enabled by default and should not be disabled in normal
1198 * use cases, i.e., this is mainly for testing purposes.
1200 void p2p_set_client_discoverability(struct p2p_data
*p2p
, int enabled
);
1203 * p2p_set_manageD_oper - Set managed P2P Device operations capability
1204 * @p2p: P2P module context from p2p_init()
1205 * @enabled: Whether managed P2P Device operations will be enabled
1207 void p2p_set_managed_oper(struct p2p_data
*p2p
, int enabled
);
1209 int p2p_set_listen_channel(struct p2p_data
*p2p
, u8 reg_class
, u8 channel
);
1211 int p2p_set_ssid_postfix(struct p2p_data
*p2p
, const u8
*postfix
, size_t len
);
1213 int p2p_get_interface_addr(struct p2p_data
*p2p
, const u8
*dev_addr
,