1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258 |
- /*
- * 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.
- */
- #ifndef P2P_H
- #define P2P_H
- /**
- * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
- */
- #define P2P_MAX_REG_CLASSES 10
- /**
- * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
- */
- #define P2P_MAX_REG_CLASS_CHANNELS 20
- /**
- * struct p2p_channels - List of supported channels
- */
- struct p2p_channels {
- /**
- * struct p2p_reg_class - Supported regulatory class
- */
- struct p2p_reg_class {
- /**
- * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
- */
- u8 reg_class;
- /**
- * channel - Supported channels
- */
- u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
- /**
- * channels - Number of channel entries in use
- */
- size_t channels;
- } reg_class[P2P_MAX_REG_CLASSES];
- /**
- * reg_classes - Number of reg_class entries in use
- */
- size_t reg_classes;
- };
- enum p2p_wps_method {
- WPS_NOT_READY, WPS_PIN_LABEL, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
- };
- /**
- * struct p2p_go_neg_results - P2P Group Owner Negotiation results
- */
- struct p2p_go_neg_results {
- /**
- * status - Negotiation result (Status Code)
- *
- * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
- * failed negotiation.
- */
- int status;
- /**
- * role_go - Whether local end is Group Owner
- */
- int role_go;
- /**
- * freq - Frequency of the group operational channel in MHz
- */
- int freq;
- /**
- * ssid - SSID of the group
- */
- u8 ssid[32];
- /**
- * ssid_len - Length of SSID in octets
- */
- size_t ssid_len;
- /**
- * passphrase - WPA2-Personal passphrase for the group (GO only)
- */
- char passphrase[64];
- /**
- * peer_device_addr - P2P Device Address of the peer
- */
- u8 peer_device_addr[ETH_ALEN];
- /**
- * peer_interface_addr - P2P Interface Address of the peer
- */
- u8 peer_interface_addr[ETH_ALEN];
- /**
- * wps_method - WPS method to be used during provisioning
- */
- enum p2p_wps_method wps_method;
- #define P2P_MAX_CHANNELS 50
- /**
- * freq_list - Zero-terminated list of possible operational channels
- */
- int freq_list[P2P_MAX_CHANNELS];
- /**
- * persistent_group - Whether the group should be made persistent
- */
- int persistent_group;
- /**
- * peer_config_timeout - Peer configuration timeout (in 10 msec units)
- */
- unsigned int peer_config_timeout;
- };
- struct p2p_data;
- enum p2p_scan_type {
- P2P_SCAN_SOCIAL,
- P2P_SCAN_FULL,
- P2P_SCAN_SPECIFIC,
- P2P_SCAN_SOCIAL_PLUS_ONE
- };
- /**
- * struct p2p_config - P2P configuration
- *
- * This configuration is provided to the P2P module during initialization with
- * p2p_init().
- */
- struct p2p_config {
- /**
- * country - Country code to use in P2P operations
- */
- char country[3];
- /**
- * reg_class - Regulatory class for own listen channel
- */
- u8 reg_class;
- /**
- * channel - Own listen channel
- */
- u8 channel;
- /**
- * Regulatory class for own operational channel
- */
- u8 op_reg_class;
- /**
- * op_channel - Own operational channel
- */
- u8 op_channel;
- /**
- * channels - Own supported regulatory classes and channels
- *
- * List of supposerted channels per regulatory class. The regulatory
- * classes are defined in IEEE Std 802.11-2007 Annex J and the
- * numbering of the clases depends on the configured country code.
- */
- struct p2p_channels channels;
- /**
- * pri_dev_type - Primary Device Type (see WPS)
- */
- u8 pri_dev_type[8];
- /**
- * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
- */
- #define P2P_SEC_DEVICE_TYPES 5
- /**
- * sec_dev_type - Optional secondary device types
- */
- u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
- /**
- * dev_addr - P2P Device Address
- */
- u8 dev_addr[ETH_ALEN];
- /**
- * dev_name - Device Name
- */
- char *dev_name;
- /**
- * num_sec_dev_types - Number of sec_dev_type entries
- */
- size_t num_sec_dev_types;
- /**
- * concurrent_operations - Whether concurrent operations are supported
- */
- int concurrent_operations;
- /**
- * max_peers - Maximum number of discovered peers to remember
- *
- * If more peers are discovered, older entries will be removed to make
- * room for the new ones.
- */
- size_t max_peers;
- /**
- * p2p_intra_bss - Intra BSS communication is supported
- */
- int p2p_intra_bss;
- /**
- * ssid_postfix - Postfix data to add to the SSID
- *
- * This data will be added to the end of the SSID after the
- * DIRECT-<random two octets> prefix.
- */
- u8 ssid_postfix[32 - 9];
- /**
- * ssid_postfix_len - Length of the ssid_postfix data
- */
- size_t ssid_postfix_len;
- /**
- * msg_ctx - Context to use with wpa_msg() calls
- */
- void *msg_ctx;
- /**
- * cb_ctx - Context to use with callback functions
- */
- void *cb_ctx;
- /* Callbacks to request lower layer driver operations */
- /**
- * p2p_scan - Request a P2P scan/search
- * @ctx: Callback context from cb_ctx
- * @type: Scan type
- * @freq: Specific frequency (MHz) to scan or 0 for no restriction
- * Returns: 0 on success, -1 on failure
- *
- * This callback function is used to request a P2P scan or search
- * operation to be completed. Type type argument specifies which type
- * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
- * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
- * indicates that all channels are to be scanned. @P2P_SCAN_SPECIFIC
- * request a scan of a single channel specified by freq.
- * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
- * plus one extra channel specified by freq.
- *
- * The full scan is used for the initial scan to find group owners from
- * all. The other types are used during search phase scan of the social
- * channels (with potential variation if the Listen channel of the
- * target peer is known or if other channels are scanned in steps).
- *
- * The scan results are returned after this call by calling
- * p2p_scan_res_handler() for each scan result that has a P2P IE and
- * then calling p2p_scan_res_handled() to indicate that all scan
- * results have been indicated.
- */
- int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq);
- /**
- * send_probe_resp - Transmit a Probe Response frame
- * @ctx: Callback context from cb_ctx
- * @buf: Probe Response frame (including the header and body)
- * Returns: 0 on success, -1 on failure
- *
- * This function is used to reply to Probe Request frames that were
- * indicated with a call to p2p_probe_req_rx(). The response is to be
- * sent on the same channel or to be dropped if the driver is not
- * anymore listening to Probe Request frames.
- *
- * Alternatively, the responsibility for building the Probe Response
- * frames in Listen state may be in another system component in which
- * case this function need to be implemented (i.e., the function
- * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
- * Response frames in such a case are available from the
- * start_listen() callback. It should be noted that the received Probe
- * Request frames must be indicated by calling p2p_probe_req_rx() even
- * if this send_probe_resp() is not used.
- */
- int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
- /**
- * send_action - Transmit an Action frame
- * @ctx: Callback context from cb_ctx
- * @freq: Frequency in MHz for the channel on which to transmit
- * @dst: Destination MAC address (Address 1)
- * @src: Source MAC address (Address 2)
- * @bssid: BSSID (Address 3)
- * @buf: Frame body (starting from Category field)
- * @len: Length of buf in octets
- * @wait_time: How many msec to wait for a response frame
- * Returns: 0 on success, -1 on failure
- *
- * The Action frame may not be transmitted immediately and the status
- * of the transmission must be reported by calling
- * p2p_send_action_cb() once the frame has either been transmitted or
- * it has been dropped due to excessive retries or other failure to
- * transmit.
- */
- int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
- const u8 *src, const u8 *bssid, const u8 *buf,
- size_t len, unsigned int wait_time);
- /**
- * send_action_done - Notify that Action frame sequence was completed
- * @ctx: Callback context from cb_ctx
- *
- * This function is called when the Action frame sequence that was
- * started with send_action() has been completed, i.e., when there is
- * no need to wait for a response from the destination peer anymore.
- */
- void (*send_action_done)(void *ctx);
- /**
- * start_listen - Start Listen state
- * @ctx: Callback context from cb_ctx
- * @freq: Frequency of the listen channel in MHz
- * @duration: Duration for the Listen state in milliseconds
- * @probe_resp_ie: IE(s) to be added to Probe Response frames
- * Returns: 0 on success, -1 on failure
- *
- * This Listen state may not start immediately since the driver may
- * have other pending operations to complete first. Once the Listen
- * state has started, p2p_listen_cb() must be called to notify the P2P
- * module. Once the Listen state is stopped, p2p_listen_end() must be
- * called to notify the P2P module that the driver is not in the Listen
- * state anymore.
- *
- * If the send_probe_resp() is not used for generating the response,
- * the IEs from probe_resp_ie need to be added to the end of the Probe
- * Response frame body. If send_probe_resp() is used, the probe_resp_ie
- * information can be ignored.
- */
- int (*start_listen)(void *ctx, unsigned int freq,
- unsigned int duration,
- const struct wpabuf *probe_resp_ie);
- /**
- * stop_listen - Stop Listen state
- * @ctx: Callback context from cb_ctx
- *
- * This callback can be used to stop a Listen state operation that was
- * previously requested with start_listen().
- */
- void (*stop_listen)(void *ctx);
- /**
- * get_noa - Get current Notice of Absence attribute payload
- * @ctx: Callback context from cb_ctx
- * @interface_addr: P2P Interface Address of the GO
- * @buf: Buffer for returning NoA
- * @buf_len: Buffer length in octets
- * Returns: Number of octets used in buf, 0 to indicate no NoA is being
- * advertized, or -1 on failure
- *
- * This function is used to fetch the current Notice of Absence
- * attribute value from GO.
- */
- int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
- size_t buf_len);
- /* Callbacks to notify events to upper layer management entity */
- /**
- * dev_found - Notification of a found P2P Device
- * @ctx: Callback context from cb_ctx
- * @addr: Source address of the message triggering this notification
- * @dev_addr: P2P Device Address of the found P2P Device
- * @pri_dev_type: Primary Device Type
- * @dev_name: Device Name
- * @config_methods: Configuration Methods
- * @dev_capab: Device Capabilities
- * @group_capab: Group Capabilities
- *
- * This callback is used to notify that a new P2P Device has been
- * found. This may happen, e.g., during Search state based on scan
- * results or during Listen state based on receive Probe Request and
- * Group Owner Negotiation Request.
- */
- void (*dev_found)(void *ctx, const u8 *addr, const u8 *dev_addr,
- const u8 *pri_dev_type, const char *dev_name,
- u16 config_methods, u8 dev_capab, u8 group_capab);
- /**
- * go_neg_req_rx - Notification of a receive GO Negotiation Request
- * @ctx: Callback context from cb_ctx
- * @src: Source address of the message triggering this notification
- * @dev_passwd_id: WPS Device Password ID
- *
- * This callback is used to notify that a P2P Device is requesting
- * group owner negotiation with us, but we do not have all the
- * necessary information to start GO Negotiation. This indicates that
- * the local user has not authorized the connection yet by providing a
- * PIN or PBC button press. This information can be provided with a
- * call to p2p_connect().
- */
- void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
- /**
- * go_neg_completed - Notification of GO Negotiation results
- * @ctx: Callback context from cb_ctx
- * @res: GO Negotiation results
- *
- * This callback is used to notify that Group Owner Negotiation has
- * been completed. Non-zero struct p2p_go_neg_results::status indicates
- * failed negotiation. In case of success, this function is responsible
- * for creating a new group interface (or using the existing interface
- * depending on driver features), setting up the group interface in
- * proper mode based on struct p2p_go_neg_results::role_go and
- * initializing WPS provisioning either as a Registrar (if GO) or as an
- * Enrollee. Successful WPS provisioning must be indicated by calling
- * p2p_wps_success_cb(). The callee is responsible for timing out group
- * formation if WPS provisioning cannot be completed successfully
- * within 15 seconds.
- */
- void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
- /**
- * sd_request - Callback on Service Discovery Request
- * @ctx: Callback context from cb_ctx
- * @freq: Frequency (in MHz) of the channel
- * @sa: Source address of the request
- * @dialog_token: Dialog token
- * @update_indic: Service Update Indicator from the source of request
- * @tlvs: P2P Service Request TLV(s)
- * @tlvs_len: Length of tlvs buffer in octets
- *
- * This callback is used to indicate reception of a service discovery
- * request. Response to the query must be indicated by calling
- * p2p_sd_response() with the context information from the arguments to
- * this callback function.
- *
- * This callback handler can be set to %NULL to indicate that service
- * discovery is not supported.
- */
- void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
- u16 update_indic, const u8 *tlvs, size_t tlvs_len);
- /**
- * sd_response - Callback on Service Discovery Response
- * @ctx: Callback context from cb_ctx
- * @sa: Source address of the request
- * @update_indic: Service Update Indicator from the source of response
- * @tlvs: P2P Service Response TLV(s)
- * @tlvs_len: Length of tlvs buffer in octets
- *
- * This callback is used to indicate reception of a service discovery
- * response. This callback handler can be set to %NULL if no service
- * discovery requests are used. The information provided with this call
- * is replies to the queries scheduled with p2p_sd_request().
- */
- void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
- const u8 *tlvs, size_t tlvs_len);
- /**
- * prov_disc_req - Callback on Provisiong Discovery Request
- * @ctx: Callback context from cb_ctx
- * @peer: Source address of the request
- * @config_methods: Requested WPS Config Method
- * @dev_addr: P2P Device Address of the found P2P Device
- * @pri_dev_type: Primary Device Type
- * @dev_name: Device Name
- * @supp_config_methods: Supported configuration Methods
- * @dev_capab: Device Capabilities
- * @group_capab: Group Capabilities
- *
- * This callback is used to indicate reception of a Provision Discovery
- * Request frame that the P2P module accepted.
- */
- 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);
- /**
- * prov_disc_resp - Callback on Provisiong Discovery Response
- * @ctx: Callback context from cb_ctx
- * @peer: Source address of the response
- * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
- *
- * This callback is used to indicate reception of a Provision Discovery
- * Response frame for a pending request scheduled with
- * p2p_prov_disc_req(). This callback handler can be set to %NULL if
- * provision discovery is not used.
- */
- void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
- /**
- * invitation_process - Optional callback for processing Invitations
- * @ctx: Callback context from cb_ctx
- * @sa: Source address of the Invitation Request
- * @bssid: P2P Group BSSID from the request or %NULL if not included
- * @go_dev_addr: GO Device Address from P2P Group ID
- * @ssid: SSID from P2P Group ID
- * @ssid_len: Length of ssid buffer in octets
- * @go: Variable for returning whether the local end is GO in the group
- * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
- * @force_freq: Variable for returning forced frequency for the group
- * @persistent_group: Whether this is an invitation to reinvoke a
- * persistent group (instead of invitation to join an active
- * group)
- * Returns: Status code (P2P_SC_*)
- *
- * This optional callback can be used to implement persistent reconnect
- * by allowing automatic restarting of persistent groups without user
- * interaction. If this callback is not implemented (i.e., is %NULL),
- * the received Invitation Request frames are replied with
- * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
- * invitation_result() callback.
- *
- * If the requested parameters are acceptable and the group is known,
- * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
- * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
- * can be returned if there is not enough data to provide immediate
- * response, i.e., if some sort of user interaction is needed. The
- * invitation_received() callback will be called in that case
- * immediately after this call.
- */
- u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
- const u8 *go_dev_addr, const u8 *ssid,
- size_t ssid_len, int *go, u8 *group_bssid,
- int *force_freq, int persistent_group);
- /**
- * invitation_received - Callback on Invitation Request RX
- * @ctx: Callback context from cb_ctx
- * @sa: Source address of the Invitation Request
- * @bssid: P2P Group BSSID or %NULL if not received
- * @ssid: SSID of the group
- * @ssid_len: Length of ssid in octets
- * @go_dev_addr: GO Device Address
- * @status: Response Status
- * @op_freq: Operational frequency for the group
- *
- * This callback is used to indicate sending of an Invitation Response
- * for a received Invitation Request. If status == 0 (success), the
- * upper layer code is responsible for starting the group. status == 1
- * indicates need to get user authorization for the group. Other status
- * values indicate that the invitation request was rejected.
- */
- void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
- const u8 *ssid, size_t ssid_len,
- const u8 *go_dev_addr, u8 status,
- int op_freq);
- /**
- * invitation_result - Callback on Invitation result
- * @ctx: Callback context from cb_ctx
- * @status: Negotiation result (Status Code)
- * @bssid: P2P Group BSSID or %NULL if not received
- *
- * This callback is used to indicate result of an Invitation procedure
- * started with a call to p2p_invite(). The indicated status code is
- * the value received from the peer in Invitation Response with 0
- * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
- * local failure in transmitting the Invitation Request.
- */
- void (*invitation_result)(void *ctx, int status, const u8 *bssid);
- };
- /* P2P module initialization/deinitialization */
- /**
- * p2p_init - Initialize P2P module
- * @cfg: P2P module configuration
- * Returns: Pointer to private data or %NULL on failure
- *
- * This function is used to initialize global P2P module context (one per
- * device). The P2P module will keep a copy of the configuration data, so the
- * caller does not need to maintain this structure. However, the callback
- * functions and the context parameters to them must be kept available until
- * the P2P module is deinitialized with p2p_deinit().
- */
- struct p2p_data * p2p_init(const struct p2p_config *cfg);
- /**
- * p2p_deinit - Deinitialize P2P module
- * @p2p: P2P module context from p2p_init()
- */
- void p2p_deinit(struct p2p_data *p2p);
- /**
- * p2p_flush - Flush P2P module state
- * @p2p: P2P module context from p2p_init()
- *
- * This command removes the P2P module state like peer device entries.
- */
- void p2p_flush(struct p2p_data *p2p);
- /**
- * p2p_set_dev_name - Set device name
- * @p2p: P2P module context from p2p_init()
- * Returns: 0 on success, -1 on failure
- *
- * This function can be used to update the P2P module configuration with
- * information that was not available at the time of the p2p_init() call.
- */
- int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
- /**
- * p2p_set_pri_dev_type - Set primary device type
- * @p2p: P2P module context from p2p_init()
- * Returns: 0 on success, -1 on failure
- *
- * This function can be used to update the P2P module configuration with
- * information that was not available at the time of the p2p_init() call.
- */
- int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
- /**
- * p2p_set_sec_dev_types - Set secondary device types
- * @p2p: P2P module context from p2p_init()
- * Returns: 0 on success, -1 on failure
- *
- * This function can be used to update the P2P module configuration with
- * information that was not available at the time of the p2p_init() call.
- */
- int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
- size_t num_dev_types);
- int p2p_set_country(struct p2p_data *p2p, const char *country);
- /* Commands from upper layer management entity */
- enum p2p_discovery_type {
- P2P_FIND_START_WITH_FULL,
- P2P_FIND_ONLY_SOCIAL,
- P2P_FIND_PROGRESSIVE
- };
- /**
- * p2p_find - Start P2P Find (Device Discovery)
- * @p2p: P2P module context from p2p_init()
- * @timeout: Timeout for find operation in seconds or 0 for no timeout
- * @type: Device Discovery type
- * Returns: 0 on success, -1 on failure
- */
- int p2p_find(struct p2p_data *p2p, unsigned int timeout,
- enum p2p_discovery_type type);
- /**
- * p2p_stop_find - Stop P2P Find (Device Discovery)
- * @p2p: P2P module context from p2p_init()
- */
- void p2p_stop_find(struct p2p_data *p2p);
- /**
- * p2p_listen - Start P2P Listen state for specified duration
- * @p2p: P2P module context from p2p_init()
- * @timeout: Listen state duration in milliseconds
- * Returns: 0 on success, -1 on failure
- *
- * This function can be used to request the P2P module to keep the device
- * discoverable on the listen channel for an extended set of time. At least in
- * its current form, this is mainly used for testing purposes and may not be of
- * much use for normal P2P operations.
- */
- int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
- /**
- * p2p_connect - Start P2P group formation (GO negotiation)
- * @p2p: P2P module context from p2p_init()
- * @peer_addr: MAC address of the peer P2P client
- * @wps_method: WPS method to be used in provisioning
- * @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
- * 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);
- /**
- * p2p_authorize - Authorize P2P group formation (GO negotiation)
- * @p2p: P2P module context from p2p_init()
- * @peer_addr: MAC address of the peer P2P client
- * @wps_method: WPS method to be used in provisioning
- * @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
- * Returns: 0 on success, -1 on failure
- *
- * This is like p2p_connect(), but the actual group negotiation is not
- * initiated automatically, i.e., the other end is expected to do that.
- */
- 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);
- /**
- * p2p_reject - Reject peer device (explicitly block connection attempts)
- * @p2p: P2P module context from p2p_init()
- * @peer_addr: MAC address of the peer P2P client
- * Returns: 0 on success, -1 on failure
- */
- int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
- /**
- * p2p_prov_disc_req - Send Provision Discovery Request
- * @p2p: P2P module context from p2p_init()
- * @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
- * Returns: 0 on success, -1 on failure
- *
- * This function can be used to request a discovered P2P peer to display a PIN
- * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
- * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
- * is transmitted once immediately and if no response is received, the frame
- * will be sent again whenever the target device is discovered during device
- * dsicovery (start with a p2p_find() call). Response from the peer is
- * 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);
- /**
- * p2p_sd_request - Schedule a service discovery query
- * @p2p: P2P module context from p2p_init()
- * @dst: Destination peer or %NULL to apply for all peers
- * @tlvs: P2P Service Query TLV(s)
- * Returns: Reference to the query or %NULL on failure
- *
- * Response to the query is indicated with the p2p_config::sd_response()
- * callback.
- */
- void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
- const struct wpabuf *tlvs);
- /**
- * p2p_sd_cancel_request - Cancel a pending service discovery query
- * @p2p: P2P module context from p2p_init()
- * @req: Query reference from p2p_sd_request()
- * Returns: 0 if request for cancelled; -1 if not found
- */
- int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
- /**
- * p2p_sd_response - Send response to a service discovery query
- * @p2p: P2P module context from p2p_init()
- * @freq: Frequency from p2p_config::sd_request() callback
- * @dst: Destination address from p2p_config::sd_request() callback
- * @dialog_token: Dialog token from p2p_config::sd_request() callback
- * @resp_tlvs: P2P Service Response TLV(s)
- *
- * This function is called as a response to the request indicated with
- * p2p_config::sd_request() callback.
- */
- void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
- u8 dialog_token, const struct wpabuf *resp_tlvs);
- /**
- * p2p_sd_service_update - Indicate a change in local services
- * @p2p: P2P module context from p2p_init()
- *
- * This function needs to be called whenever there is a change in availability
- * of the local services. This will increment the Service Update Indicator
- * value which will be used in SD Request and Response frames.
- */
- void p2p_sd_service_update(struct p2p_data *p2p);
- enum p2p_invite_role {
- P2P_INVITE_ROLE_GO,
- P2P_INVITE_ROLE_ACTIVE_GO,
- P2P_INVITE_ROLE_CLIENT
- };
- /**
- * p2p_invite - Invite a P2P Device into a group
- * @p2p: P2P module context from p2p_init()
- * @peer: Device Address of the peer P2P Device
- * @role: Local role in the group
- * @bssid: Group BSSID or %NULL if not known
- * @ssid: Group SSID
- * @ssid_len: Length of ssid in octets
- * @force_freq: The only allowed channel frequency in MHz or 0
- * @go_dev_addr: Forced GO Device Address or %NULL if none
- * @persistent_group: Whether this is to reinvoke a persistent group
- * Returns: 0 on success, -1 on failure
- */
- int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
- const u8 *bssid, const u8 *ssid, size_t ssid_len,
- unsigned int force_freq, const u8 *go_dev_addr,
- int persistent_group);
- /**
- * p2p_presence_req - Request GO presence
- * @p2p: P2P module context from p2p_init()
- * @go_interface_addr: GO P2P Interface Address
- * @own_interface_addr: Own P2P Interface Address for this group
- * @freq: Group operating frequence (in MHz)
- * @duration1: Preferred presence duration in microseconds
- * @interval1: Preferred presence interval in microseconds
- * @duration2: Acceptable presence duration in microseconds
- * @interval2: Acceptable presence interval in microseconds
- * Returns: 0 on success, -1 on failure
- *
- * If both duration and interval values are zero, the parameter pair is not
- * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
- */
- int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
- const u8 *own_interface_addr, unsigned int freq,
- u32 duration1, u32 interval1, u32 duration2,
- u32 interval2);
- /**
- * p2p_ext_listen - Set Extended Listen Timing
- * @p2p: P2P module context from p2p_init()
- * @freq: Group operating frequence (in MHz)
- * @period: Availability period in milliseconds (1-65535; 0 to disable)
- * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
- * Returns: 0 on success, -1 on failure
- *
- * This function can be used to enable or disable (period = interval = 0)
- * Extended Listen Timing. When enabled, the P2P Device will become
- * discoverable (go into Listen State) every @interval milliseconds for at
- * least @period milliseconds.
- */
- int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
- unsigned int interval);
- /* Event notifications from upper layer management operations */
- /**
- * p2p_wps_success_cb - Report successfully completed WPS provisioning
- * @p2p: P2P module context from p2p_init()
- * @mac_addr: Peer address
- *
- * This function is used to report successfully completed WPS provisioning
- * during group formation in both GO/Registrar and client/Enrollee roles.
- */
- void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
- /**
- * p2p_group_formation_failed - Report failed WPS provisioning
- * @p2p: P2P module context from p2p_init()
- *
- * This function is used to report failed group formation. This can happen
- * either due to failed WPS provisioning or due to 15 second timeout during
- * the provisioning phase.
- */
- void p2p_group_formation_failed(struct p2p_data *p2p);
- /* Event notifications from lower layer driver operations */
- /**
- * p2p_probe_req_rx - Report reception of a Probe Request frame
- * @p2p: P2P module context from p2p_init()
- * @addr: Source MAC address
- * @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
- */
- int p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *ie,
- size_t ie_len);
- /**
- * p2p_rx_action - Report received Action frame
- * @p2p: P2P module context from p2p_init()
- * @da: Destination address of the received Action frame
- * @sa: Source address of the received Action frame
- * @bssid: Address 3 of the received Action frame
- * @category: Category of the received Action frame
- * @data: Action frame body after the Category field
- * @len: Length of the data buffer in octets
- * @freq: Frequency (in MHz) on which the frame was received
- */
- void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
- const u8 *bssid, u8 category,
- const u8 *data, size_t len, int freq);
- /**
- * p2p_scan_res_handler - Indicate a P2P scan results
- * @p2p: P2P module context from p2p_init()
- * @bssid: BSSID of the scan result
- * @freq: Frequency of the channel on which the device was found in MHz
- * @level: Signal level (signal strength of the received Beacon/Probe Response
- * frame)
- * @ies: Pointer to IEs from the scan result
- * @ies_len: Length of the ies buffer
- * Returns: 0 to continue or 1 to stop scan result indication
- *
- * This function is called to indicate a scan result entry with P2P IE from a
- * scan requested with struct p2p_config::p2p_scan(). This can be called during
- * the actual scan process (i.e., whenever a new device is found) or as a
- * sequence of calls after the full scan has been completed. The former option
- * can result in optimized operations, but may not be supported by all
- * driver/firmware designs. The ies buffer need to include at least the P2P IE,
- * but it is recommended to include all IEs received from the device. The
- * caller does not need to check that the IEs contain a P2P IE before calling
- * this function since frames will be filtered internally if needed.
- *
- * This function will return 1 if it wants to stop scan result iteration (and
- * scan in general if it is still in progress). This is used to allow faster
- * start of a pending operation, e.g., to start a pending GO negotiation.
- */
- int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
- int level, const u8 *ies, size_t ies_len);
- /**
- * p2p_scan_res_handled - Indicate end of scan results
- * @p2p: P2P module context from p2p_init()
- *
- * This function is called to indicate that all P2P scan results from a scan
- * have been reported with zero or more calls to p2p_scan_res_handler(). This
- * function must be called as a response to successful
- * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
- * calls stopped iteration.
- */
- void p2p_scan_res_handled(struct p2p_data *p2p);
- /**
- * p2p_send_action_cb - Notify TX status of an Action frame
- * @p2p: P2P module context from p2p_init()
- * @freq: Channel frequency in MHz
- * @dst: Destination MAC address (Address 1)
- * @src: Source MAC address (Address 2)
- * @bssid: BSSID (Address 3)
- * @success: Whether the transmission succeeded
- *
- * This function is used to indicate the result of an Action frame transmission
- * that was requested with struct p2p_config::send_action() callback.
- */
- void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
- const u8 *src, const u8 *bssid, int success);
- /**
- * p2p_listen_cb - Indicate the start of a requested Listen state
- * @p2p: P2P module context from p2p_init()
- * @freq: Listen channel frequency in MHz
- * @duration: Duration for the Listen state in milliseconds
- *
- * This function is used to indicate that a Listen state requested with
- * struct p2p_config::start_listen() callback has started.
- */
- void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
- unsigned int duration);
- /**
- * p2p_listen_end - Indicate the end of a requested Listen state
- * @p2p: P2P module context from p2p_init()
- * @freq: Listen channel frequency in MHz
- * Returns: 0 if no operations were started, 1 if an operation was started
- *
- * This function is used to indicate that a Listen state requested with
- * struct p2p_config::start_listen() callback has ended.
- */
- int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
- void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
- const u8 *ie, size_t ie_len);
- void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
- const u8 *ie, size_t ie_len);
- /* Per-group P2P state for GO */
- struct p2p_group;
- /**
- * struct p2p_group_config - P2P group configuration
- *
- * This configuration is provided to the P2P module during initialization of
- * the per-group information with p2p_group_init().
- */
- struct p2p_group_config {
- /**
- * persistent_group - Whether the group is persistent
- */
- int persistent_group;
- /**
- * interface_addr - P2P Interface Address of the group
- */
- u8 interface_addr[ETH_ALEN];
- /**
- * cb_ctx - Context to use with callback functions
- */
- void *cb_ctx;
- /**
- * ie_update - Notification of IE update
- * @ctx: Callback context from cb_ctx
- * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
- * @proberesp_ies: P2P Ie for Probe Response frames
- *
- * P2P module uses this callback function to notify whenever the P2P IE
- * in Beacon or Probe Response frames should be updated based on group
- * events.
- *
- * The callee is responsible for freeing the returned buffer(s) with
- * wpabuf_free().
- */
- void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
- struct wpabuf *proberesp_ies);
- };
- /**
- * p2p_group_init - Initialize P2P group
- * @p2p: P2P module context from p2p_init()
- * @config: P2P group configuration (will be freed by p2p_group_deinit())
- * Returns: Pointer to private data or %NULL on failure
- *
- * This function is used to initialize per-group P2P module context. Currently,
- * this is only used to manage GO functionality and P2P clients do not need to
- * create an instance of this per-group information.
- */
- struct p2p_group * p2p_group_init(struct p2p_data *p2p,
- struct p2p_group_config *config);
- /**
- * p2p_group_deinit - Deinitialize P2P group
- * @group: P2P group context from p2p_group_init()
- */
- void p2p_group_deinit(struct p2p_group *group);
- /**
- * p2p_group_notif_assoc - Notification of P2P client association with GO
- * @group: P2P group context from p2p_group_init()
- * @addr: Interface address of the P2P client
- * @ie: IEs from the (Re)association Request frame
- * @len: Length of the ie buffer in octets
- * Returns: 0 on success, -1 on failure
- */
- int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
- const u8 *ie, size_t len);
- /**
- * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
- * @group: P2P group context from p2p_group_init()
- * @status: Status value (P2P_SC_SUCCESS if association succeeded)
- * Returns: P2P IE for (Re)association Response or %NULL on failure
- *
- * The caller is responsible for freeing the returned buffer with
- * wpabuf_free().
- */
- struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
- /**
- * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
- * @group: P2P group context from p2p_group_init()
- * @addr: Interface address of the P2P client
- */
- void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
- /**
- * p2p_group_notif_formation_done - Notification of completed group formation
- * @group: P2P group context from p2p_group_init()
- */
- void p2p_group_notif_formation_done(struct p2p_group *group);
- /**
- * p2p_group_notif_noa - Notification of NoA change
- * @group: P2P group context from p2p_group_init()
- * @noa: Notice of Absence attribute payload, %NULL if none
- * @noa_len: Length of noa buffer in octets
- * Returns: 0 on success, -1 on failure
- *
- * Notify the P2P group management about a new NoA contents. This will be
- * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
- * the group information.
- */
- int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
- size_t noa_len);
- /**
- * p2p_group_match_dev_type - Match device types in group with requested type
- * @group: P2P group context from p2p_group_init()
- * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
- * Returns: 1 on match, 0 on mismatch
- *
- * This function can be used to match the Requested Device Type attribute in
- * WPS IE with the device types of a group member for deciding whether a GO
- * should reply to a Probe Request frame. Match will be reported if the WPS IE
- * is not requested any specific device type.
- */
- int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
- /**
- * 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
- */
- int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
- const u8 *searching_dev, int rx_freq);
- /* Generic helper functions */
- /**
- * p2p_ie_text - Build text format description of P2P IE
- * @p2p_ie: P2P IE
- * @buf: Buffer for returning text
- * @end: Pointer to the end of the buf area
- * Returns: Number of octets written to the buffer or -1 on failure
- *
- * This function can be used to parse P2P IE contents into text format
- * field=value lines.
- */
- int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
- /**
- * p2p_scan_result_text - Build text format description of P2P IE
- * @ies: Information elements from scan results
- * @ies_len: ies buffer length in octets
- * @buf: Buffer for returning text
- * @end: Pointer to the end of the buf area
- * Returns: Number of octets written to the buffer or -1 on failure
- *
- * This function can be used to parse P2P IE contents into text format
- * field=value lines.
- */
- int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
- /**
- * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
- * @p2p: P2P module context from p2p_init()
- * @bssid: BSSID
- * @buf: Buffer for writing the P2P IE
- * @len: Maximum buf length in octets
- * @p2p_group: Whether this is for association with a P2P GO
- * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
- * Returns: Number of octets written into buf or -1 on failure
- */
- int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
- size_t len, int p2p_group, struct wpabuf *p2p_ie);
- /**
- * p2p_scan_ie - Build P2P IE for Probe Request
- * @p2p: P2P module context from p2p_init()
- * @ies: Buffer for writing P2P IE
- */
- void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies);
- /**
- * p2p_go_params - Generate random P2P group parameters
- * @p2p: P2P module context from p2p_init()
- * @params: Buffer for parameters
- * Returns: 0 on success, -1 on failure
- */
- int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
- /**
- * p2p_get_group_capab - Get Group Capability from P2P IE data
- * @p2p_ie: P2P IE(s) contents
- * Returns: Group Capability
- */
- u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
- /**
- * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
- * @p2p_ie: P2P IE(s) contents
- * Returns: 0 if cross connection is allow, 1 if not
- */
- int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
- /**
- * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
- * @p2p_ie: P2P IE(s) contents
- * Returns: Pointer to P2P Device Address or %NULL if not included
- */
- const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
- /**
- * p2p_get_peer_info - Get P2P peer information in text format
- * @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
- * @buf: Buffer for returning text
- * @buflen: Maximum buffer length
- * Returns: Number of octets written to the buffer or -1 on failure
- */
- int p2p_get_peer_info(struct p2p_data *p2p, const u8 *addr, int next,
- char *buf, size_t buflen);
- /**
- * p2p_set_client_discoverability - Set client discoverability capability
- * @p2p: P2P module context from p2p_init()
- * @enabled: Whether client discoverability will be enabled
- *
- * This function can be used to disable (and re-enable) client discoverability.
- * This capability is enabled by default and should not be disabled in normal
- * use cases, i.e., this is mainly for testing purposes.
- */
- void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
- /**
- * 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
- */
- void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
- int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
- int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
- int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
- u8 *iface_addr);
- int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
- u8 *dev_addr);
- void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
- /**
- * p2p_set_cross_connect - Set cross connection capability
- * @p2p: P2P module context from p2p_init()
- * @enabled: Whether cross connection will be enabled
- */
- 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()
- * @enabled: Whether intra BSS distribution will be enabled
- */
- void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
- #endif /* P2P_H */
|