P2P: Add p2p_client_list support for FullMAC Persistent GO
[mech_eap.git] / src / p2p / p2p.h
index eb70dcf..98ba5cd 100644 (file)
@@ -2,14 +2,8 @@
  * Wi-Fi Direct - P2P module
  * Copyright (c) 2009-2010, Atheros Communications
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation.
- *
- * Alternatively, this software may be distributed under the terms of BSD
- * license.
- *
- * See README and COPYING for more details.
+ * This software may be distributed under the terms of the BSD license.
+ * See README for more details.
  */
 
 #ifndef P2P_H
@@ -56,7 +50,7 @@ struct p2p_channels {
 };
 
 enum p2p_wps_method {
-       WPS_NOT_READY, WPS_PIN_LABEL, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
+       WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
 };
 
 /**
@@ -120,6 +114,9 @@ struct p2p_go_neg_results {
 
        /**
         * persistent_group - Whether the group should be made persistent
+        * 0 = not persistent
+        * 1 = persistent group without persistent reconnect
+        * 2 = persistent group with persistent reconnect
         */
        int persistent_group;
 
@@ -155,11 +152,36 @@ struct p2p_peer_info {
        u8 pri_dev_type[8];
 
        /**
-        * device_name - Device Name
+        * device_name - Device Name (0..32 octets encoded in UTF-8)
         */
        char device_name[33];
 
        /**
+        * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
+        */
+       char manufacturer[65];
+
+       /**
+        * model_name - Model Name (0..32 octets encoded in UTF-8)
+        */
+       char model_name[33];
+
+       /**
+        * model_number - Model Number (0..32 octets encoded in UTF-8)
+        */
+       char model_number[33];
+
+       /**
+        * serial_number - Serial Number (0..32 octets encoded in UTF-8)
+        */
+       char serial_number[33];
+
+       /**
+        * level - Signal level
+        */
+       int level;
+
+       /**
         * config_methods - WPS Configuration Methods
         */
        u16 config_methods;
@@ -190,6 +212,17 @@ struct p2p_peer_info {
        struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
 };
 
+enum p2p_prov_disc_status {
+       P2P_PROV_DISC_SUCCESS,
+       P2P_PROV_DISC_TIMEOUT,
+       P2P_PROV_DISC_REJECTED,
+};
+
+struct p2p_channel {
+       u8 op_class;
+       u8 chan;
+};
+
 /**
  * struct p2p_config - P2P configuration
  *
@@ -237,6 +270,16 @@ struct p2p_config {
        struct p2p_channels channels;
 
        /**
+        * num_pref_chan - Number of pref_chan entries
+        */
+       unsigned int num_pref_chan;
+
+       /**
+        * pref_chan - Preferred channels for GO Negotiation
+        */
+       struct p2p_channel *pref_chan;
+
+       /**
         * pri_dev_type - Primary Device Type (see WPS)
         */
        u8 pri_dev_type[8];
@@ -252,6 +295,11 @@ struct p2p_config {
        u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
 
        /**
+        * num_sec_dev_types - Number of sec_dev_type entries
+        */
+       size_t num_sec_dev_types;
+
+       /**
         * dev_addr - P2P Device Address
         */
        u8 dev_addr[ETH_ALEN];
@@ -261,10 +309,13 @@ struct p2p_config {
         */
        char *dev_name;
 
-       /**
-        * num_sec_dev_types - Number of sec_dev_type entries
-        */
-       size_t num_sec_dev_types;
+       char *manufacturer;
+       char *model_name;
+       char *model_number;
+       char *serial_number;
+
+       u8 uuid[16];
+       u16 config_methods;
 
        /**
         * concurrent_operations - Whether concurrent operations are supported
@@ -317,6 +368,8 @@ struct p2p_config {
         * @freq: Specific frequency (MHz) to scan or 0 for no restriction
         * @num_req_dev_types: Number of requested device types
         * @req_dev_types: Array containing requested device types
+        * @dev_id: Device ID to search for or %NULL to find all devices
+        * @pw_id: Device Password ID
         * Returns: 0 on success, -1 on failure
         *
         * This callback function is used to request a P2P scan or search
@@ -340,7 +393,7 @@ struct p2p_config {
         */
        int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
                        unsigned int num_req_dev_types,
-                       const u8 *req_dev_types);
+                       const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
 
        /**
         * send_probe_resp - Transmit a Probe Response frame
@@ -552,6 +605,8 @@ struct p2p_config {
         * @supp_config_methods: Supported configuration Methods
         * @dev_capab: Device Capabilities
         * @group_capab: Group Capabilities
+        * @group_id: P2P Group ID (or %NULL if not included)
+        * @group_id_len: Length of P2P Group ID
         *
         * This callback is used to indicate reception of a Provision Discovery
         * Request frame that the P2P module accepted.
@@ -559,7 +614,8 @@ struct p2p_config {
        void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
                              const u8 *dev_addr, const u8 *pri_dev_type,
                              const char *dev_name, u16 supp_config_methods,
-                             u8 dev_capab, u8 group_capab);
+                             u8 dev_capab, u8 group_capab,
+                             const u8 *group_id, size_t group_id_len);
 
        /**
         * prov_disc_resp - Callback on Provisiong Discovery Response
@@ -575,6 +631,21 @@ struct p2p_config {
        void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
 
        /**
+        * prov_disc_fail - Callback on Provision Discovery failure
+        * @ctx: Callback context from cb_ctx
+        * @peer: Source address of the response
+        * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
+        *
+        * This callback is used to indicate either a failure or no response
+        * to an earlier provision discovery request.
+        *
+        * This callback handler can be set to %NULL if provision discovery
+        * is not used or failures do not need to be indicated.
+        */
+       void (*prov_disc_fail)(void *ctx, const u8 *peer,
+                              enum p2p_prov_disc_status status);
+
+       /**
         * invitation_process - Optional callback for processing Invitations
         * @ctx: Callback context from cb_ctx
         * @sa: Source address of the Invitation Request
@@ -645,6 +716,15 @@ struct p2p_config {
         * local failure in transmitting the Invitation Request.
         */
        void (*invitation_result)(void *ctx, int status, const u8 *bssid);
+
+       /**
+        * go_connected - Check whether we are connected to a GO
+        * @ctx: Callback context from cb_ctx
+        * @dev_addr: P2P Device Address of a GO
+        * Returns: 1 if we are connected as a P2P client to the specified GO
+        * or 0 if not.
+        */
+       int (*go_connected)(void *ctx, const u8 *dev_addr);
 };
 
 
@@ -700,6 +780,14 @@ int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
  */
 int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
 
+int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
+int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
+int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
+int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
+
+void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
+void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
+
 /**
  * p2p_set_pri_dev_type - Set primary device type
  * @p2p: P2P module context from p2p_init()
@@ -741,11 +829,13 @@ enum p2p_discovery_type {
  * @req_dev_types: Requested device types array, must be an array
  *     containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
  *     requested device types.
+ * @dev_id: Device ID to search for or %NULL to find all devices
  * Returns: 0 on success, -1 on failure
  */
 int p2p_find(struct p2p_data *p2p, unsigned int timeout,
             enum p2p_discovery_type type,
-            unsigned int num_req_dev_types, const u8 *req_dev_types);
+            unsigned int num_req_dev_types, const u8 *req_dev_types,
+            const u8 *dev_id);
 
 /**
  * p2p_stop_find - Stop P2P Find (Device Discovery)
@@ -784,13 +874,23 @@ int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
  * @go_intent: Local GO intent value (1..15)
  * @own_interface_addr: Intended interface address to use with the group
  * @force_freq: The only allowed channel frequency in MHz or 0
- * @persistent_group: Whether to create a persistent group
+ * @persistent_group: Whether to create a persistent group (0 = no, 1 =
+ * persistent group without persistent reconnect, 2 = persistent group with
+ * persistent reconnect)
+ * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
+ *     a new SSID
+ * @force_ssid_len: Length of $force_ssid buffer
+ * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
+ *     Negotiation as an interoperability workaround when initiating group
+ *     formation
  * Returns: 0 on success, -1 on failure
  */
 int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
                enum p2p_wps_method wps_method,
                int go_intent, const u8 *own_interface_addr,
-               unsigned int force_freq, int persistent_group);
+               unsigned int force_freq, int persistent_group,
+               const u8 *force_ssid, size_t force_ssid_len,
+               int pd_before_go_neg);
 
 /**
  * p2p_authorize - Authorize P2P group formation (GO negotiation)
@@ -800,7 +900,12 @@ int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
  * @go_intent: Local GO intent value (1..15)
  * @own_interface_addr: Intended interface address to use with the group
  * @force_freq: The only allowed channel frequency in MHz or 0
- * @persistent_group: Whether to create a persistent group
+ * @persistent_group: Whether to create a persistent group (0 = no, 1 =
+ * persistent group without persistent reconnect, 2 = persistent group with
+ * persistent reconnect)
+ * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
+ *     a new SSID
+ * @force_ssid_len: Length of $force_ssid buffer
  * Returns: 0 on success, -1 on failure
  *
  * This is like p2p_connect(), but the actual group negotiation is not
@@ -809,7 +914,8 @@ int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
 int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
                  enum p2p_wps_method wps_method,
                  int go_intent, const u8 *own_interface_addr,
-                 unsigned int force_freq, int persistent_group);
+                 unsigned int force_freq, int persistent_group,
+                 const u8 *force_ssid, size_t force_ssid_len);
 
 /**
  * p2p_reject - Reject peer device (explicitly block connection attempts)
@@ -825,6 +931,7 @@ int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
  * @peer_addr: MAC address of the peer P2P client
  * @config_methods: WPS Config Methods value (only one bit set)
  * @join: Whether this is used by a client joining an active group
+ * @force_freq: Forced TX frequency for the frame (mainly for the join case)
  * Returns: 0 on success, -1 on failure
  *
  * This function can be used to request a discovered P2P peer to display a PIN
@@ -836,7 +943,7 @@ int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
  * indicated with the p2p_config::prov_disc_resp() callback.
  */
 int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
-                     u16 config_methods, int join);
+                     u16 config_methods, int join, int force_freq);
 
 /**
  * p2p_sd_request - Schedule a service discovery query
@@ -966,19 +1073,61 @@ void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
  */
 void p2p_group_formation_failed(struct p2p_data *p2p);
 
+/**
+ * p2p_get_provisioning_info - Get any stored provisioning info
+ * @p2p: P2P module context from p2p_init()
+ * @addr: Peer P2P Device Address
+ * Returns: WPS provisioning information (WPS config method) or 0 if no
+ * information is available
+ *
+ * This function is used to retrieve stored WPS provisioning info for the given
+ * peer.
+ */
+u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
+
+/**
+ * p2p_clear_provisioning_info - Clear any stored provisioning info
+ * @p2p: P2P module context from p2p_init()
+ * @iface_addr: Peer P2P Device Address
+ *
+ * This function is used to clear stored WPS provisioning info for the given
+ * peer.
+ */
+void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
+
 
 /* Event notifications from lower layer driver operations */
 
 /**
+ * enum p2p_probe_req_status
+ *
+ * @P2P_PREQ_MALFORMED: frame was not well-formed
+ * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
+ * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
+ * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
+ * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
+ */
+enum p2p_probe_req_status {
+       P2P_PREQ_MALFORMED,
+       P2P_PREQ_NOT_LISTEN,
+       P2P_PREQ_NOT_P2P,
+       P2P_PREQ_NOT_PROCESSED,
+       P2P_PREQ_PROCESSED
+};
+
+/**
  * p2p_probe_req_rx - Report reception of a Probe Request frame
  * @p2p: P2P module context from p2p_init()
  * @addr: Source MAC address
+ * @dst: Destination MAC address if available or %NULL
+ * @bssid: BSSID if available or %NULL
  * @ie: Information elements from the Probe Request frame body
  * @ie_len: Length of ie buffer in octets
- * Returns: 0 to indicate the frame was not processed or 1 if it was
+ * Returns: value indicating the type and status of the probe request
  */
-int p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *ie,
-                    size_t ie_len);
+enum p2p_probe_req_status
+p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
+                const u8 *bssid, const u8 *ie, size_t ie_len);
 
 /**
  * p2p_rx_action - Report received Action frame
@@ -1100,6 +1249,9 @@ struct p2p_group;
 struct p2p_group_config {
        /**
         * persistent_group - Whether the group is persistent
+        * 0 = not a persistent group
+        * 1 = persistent group without persistent reconnect
+        * 2 = persistent group with persistent reconnect
         */
        int persistent_group;
 
@@ -1114,6 +1266,16 @@ struct p2p_group_config {
        unsigned int max_clients;
 
        /**
+        * ssid - Group SSID
+        */
+       u8 ssid[32];
+
+       /**
+        * ssid_len - Length of SSID
+        */
+       size_t ssid_len;
+
+       /**
         * cb_ctx - Context to use with callback functions
         */
        void *cb_ctx;
@@ -1224,6 +1386,11 @@ int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
 int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
 
 /**
+ * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
+ */
+int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
+
+/**
  * p2p_group_go_discover - Send GO Discoverability Request to a group client
  * @group: P2P group context from p2p_group_init()
  * Returns: 0 on success (frame scheduled); -1 if client was not found
@@ -1260,6 +1427,24 @@ int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
 int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
 
 /**
+ * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
+ * P2P IE
+ * @p2p_ie: P2P IE
+ * @dev_addr: Buffer for returning P2P Device Address
+ * Returns: 0 on success or -1 if P2P Device Address could not be parsed
+ */
+int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
+
+/**
+ * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
+ * @ies: Information elements from scan results
+ * @ies_len: ies buffer length in octets
+ * @dev_addr: Buffer for returning P2P Device Address
+ * Returns: 0 on success or -1 if P2P Device Address could not be parsed
+ */
+int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
+
+/**
  * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
  * @p2p: P2P module context from p2p_init()
  * @bssid: BSSID
@@ -1276,8 +1461,16 @@ int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
  * p2p_scan_ie - Build P2P IE for Probe Request
  * @p2p: P2P module context from p2p_init()
  * @ies: Buffer for writing P2P IE
+ * @dev_id: Device ID to search for or %NULL for any
  */
-void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies);
+void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
+
+/**
+ * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
+ * @p2p: P2P module context from p2p_init()
+ * Returns: Number of octets that p2p_scan_ie() may add to the buffer
+ */
+size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
 
 /**
  * p2p_go_params - Generate random P2P group parameters
@@ -1309,16 +1502,36 @@ int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
 const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
 
 /**
- * p2p_get_peer_info - Get P2P peer information in text format
+ * p2p_get_peer_info - Get P2P peer information
  * @p2p: P2P module context from p2p_init()
  * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
  * @next: Whether to select the peer entry following the one indicated by addr
+ * Returns: Pointer to peer info or %NULL if not found
+ */
+const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
+                                              const u8 *addr, int next);
+
+/**
+ * p2p_get_peer_info_txt - Get internal P2P peer information in text format
+ * @info: Pointer to P2P peer info from p2p_get_peer_info()
  * @buf: Buffer for returning text
  * @buflen: Maximum buffer length
  * Returns: Number of octets written to the buffer or -1 on failure
+ *
+ * Note: This information is internal to the P2P module and subject to change.
+ * As such, this should not really be used by external programs for purposes
+ * other than debugging.
+ */
+int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
+                         char *buf, size_t buflen);
+
+/**
+ * p2p_peer_known - Check whether P2P peer is known
+ * @p2p: P2P module context from p2p_init()
+ * @addr: P2P Device Address of the peer
+ * Returns: 1 if the specified device is in the P2P peer table or 0 if not
  */
-int p2p_get_peer_info(struct p2p_data *p2p, const u8 *addr, int next,
-                     char *buf, size_t buflen);
+int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
 
 /**
  * p2p_set_client_discoverability - Set client discoverability capability
@@ -1332,7 +1545,7 @@ int p2p_get_peer_info(struct p2p_data *p2p, const u8 *addr, int next,
 void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
 
 /**
- * p2p_set_manageD_oper - Set managed P2P Device operations capability
+ * p2p_set_managed_oper - Set managed P2P Device operations capability
  * @p2p: P2P module context from p2p_init()
  * @enabled: Whether managed P2P Device operations will be enabled
  */
@@ -1358,9 +1571,6 @@ void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
 
 int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
 
-int p2p_add_device(struct p2p_data *p2p, const u8 *addr, int freq, int level,
-                  const u8 *ies, size_t ies_len);
-
 /**
  * p2p_set_intra_bss_dist - Set intra BSS distribution
  * @p2p: P2P module context from p2p_init()
@@ -1407,6 +1617,23 @@ unsigned int p2p_get_group_num_members(struct p2p_group *group);
 const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
 
 /**
+ * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
+ * @group: P2P group context from p2p_group_init()
+ * @addr: P2P Interface Address of the client
+ * Returns: P2P Device Address of the client if found or %NULL if no match
+ * found
+ */
+const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
+
+/**
+ * p2p_group_is_client_connected - Check whether a specific client is connected
+ * @group: P2P group context from p2p_group_init()
+ * @addr: P2P Device Address of the client
+ * Returns: 1 if client is connected or 0 if not
+ */
+int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
+
+/**
  * p2p_get_peer_found - Get P2P peer info structure of a found peer
  * @p2p: P2P module context from p2p_init()
  * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
@@ -1434,4 +1661,41 @@ void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
 int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
                                 const struct wpabuf *vendor_ext);
 
+/**
+ * p2p_set_oper_channel - Set the P2P operating channel
+ * @p2p: P2P module context from p2p_init()
+ * @op_reg_class: Operating regulatory class to set
+ * @op_channel: operating channel to set
+ * @cfg_op_channel : Whether op_channel is hardcoded in configuration
+ * Returns: 0 on success, -1 on failure
+ */
+int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
+                        int cfg_op_channel);
+
+/**
+ * p2p_set_pref_chan - Set P2P preferred channel list
+ * @p2p: P2P module context from p2p_init()
+ * @num_pref_chan: Number of entries in pref_chan list
+ * @pref_chan: Preferred channels or %NULL to remove preferences
+ * Returns: 0 on success, -1 on failure
+ */
+int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
+                     const struct p2p_channel *pref_chan);
+
+/**
+ * p2p_in_progress - Check whether a P2P operation is progress
+ * @p2p: P2P module context from p2p_init()
+ * Returns: 0 if P2P module is idle or 1 if an operation is in progress
+ */
+int p2p_in_progress(struct p2p_data *p2p);
+
+/**
+ * p2p_other_scan_completed - Notify completion of non-P2P scan
+ * @p2p: P2P module context from p2p_init()
+ * Returns: 0 if P2P module is idle or 1 if an operation was started
+ */
+int p2p_other_scan_completed(struct p2p_data *p2p);
+
+const char * p2p_wps_method_text(enum p2p_wps_method method);
+
 #endif /* P2P_H */