Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 756ad991 authored by Roshan Pius's avatar Roshan Pius
Browse files

supplicant(interface): Support P2P operations 

Add methods for all the P2P related operations. This is a subset of P2P
functionalities exposed by wpa_supplicant used in the Android codebase
currently.

While there,
Add missing |FAILURE_ARGS_INVALID| status code in the setter methods in
ISupplicantStaNetwork.hal

Bug: 31497295
Test: ./hardware/interfaces/update-makefiles.sh
Change-Id: I657ef6deaa6203bcf890c43f98a32f6230962d04
parent 22373cb4

wifi/supplicant/1.0/ISupplicant.hal

+15 −0
Original line number Diff line number Diff line
@@ -141,4 +141,19 @@ interface ISupplicant { 
   * @return enabled true if set, false otherwise.

   */

  isDebugShowKeysEnabled() generates (bool enabled);



  /**

   * Set concurrency priority.

   *

   * When both P2P and STA mode ifaces are active, this must be used

   * to prioritize either STA or P2P connection to resolve conflicts

   * arising during single channel concurrency.

   *

   * @param type The type of iface to prioritize.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|

   */

  setConcurrencyPriority(IfaceType type) generates (SupplicantStatus status);

};

wifi/supplicant/1.0/ISupplicantP2pIface.hal

+445 −0
Original line number Diff line number Diff line
@@ -24,6 +24,36 @@ import ISupplicantP2pIfaceCallback; 
 * interface (e.g p2p0) it controls.

 */

interface ISupplicantP2pIface extends ISupplicantIface {

  enum WpsProvisionMethod : uint32_t {

    /**

     * Push button method.

     */

    PBC,

    /**

     * Display pin method configuration - pin is generated and displayed on

     * device.

     */

    DISPLAY,

    /**

     * Keypad pin method configuration - pin is entered on device.

     */

    KEYPAD,

    /**

     * Label pin method configuration - pin is labelled on device.

     */

    LABEL

  };



  enum GroupCapabilityMask : uint32_t {

    GROUP_OWNER = 1 << 0,

    PERSISTENT_GROUP = 1 << 1,

    GROUP_LIMIT = 1 << 2,

    INTRA_BSS_DIST = 1 << 3,

    CROSS_CONN = 1 << 4,

    PERSISTENT_RECONN = 1 << 5,

    GROUP_FORMATION = 1 << 6

  };



  /**

   * Register for callbacks from this interface.

   *
@@ -42,4 +72,419 @@ interface ISupplicantP2pIface extends ISupplicantIface { 
   */

  registerCallback(ISupplicantP2pIfaceCallback callback)

      generates (SupplicantStatus status);



  /**

   * Gets the MAC address of the device.

   *

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   * @return deviceAddress MAC address of the device.

   */

  getDeviceAddress()

      generates (SupplicantStatus status, MacAddress deviceAddress);



  /**

   * Set the postfix to be used for P2P SSID's.

   *

   * @param postfix String to be appended to SSID.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_ARGS_INVALID|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  setSsidPostfix(string postfix) generates (SupplicantStatus status);



  /**

   * Set the Maximum idle time in seconds for P2P groups.

   * This value controls how long a P2P group is maintained after there

   * is no other members in the group. As a group owner, this means no

   * associated stations in the group. As a P2P client, this means no

   * group owner seen in scan results.

   *

   * @param timeoutInSec Timeout value in seconds.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  setGroupIdle(uint32_t timeoutInSec) generates (SupplicantStatus status);



  /**

   * Turn on/off power save mode for the interface.

   *

   * @param enable Indicate if power save is to be turned on/off.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|,

   *         |SupplicantStatusCode.FAILURE_IFACE_DISABLED|

   */

  setPowerSave(bool enable) generates (SupplicantStatus status);



  /**

   * Initiate a P2P service discovery with an optional timeout.

   *

   * @param timeoutInSec Max time to be spent is peforming discovery.

   *        Set to 0 to indefinely continue discovery untill and explicit

   *        |stopFind| is sent.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  find(uint32_t timeoutInSec) generates (SupplicantStatus status);



  /**

   * Stop an ongoing P2P service discovery.

   *

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  stopFind() generates (SupplicantStatus status);



  /**

   * Flush P2P peer table and state.

   *

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  flush() generates (SupplicantStatus status);



  /**

   * Start P2P group formation with a discovered P2P peer. This includes

   * optional group owner negotiation, group interface setup, provisioning,

   * and establishing data connection.

   *

   * @param peerAddress MAC address of the device to connect to.

   * @method provisionMethod Provisioning method to use.

   * @param preSelectedPin Pin to be used, if |provisionMethod| uses one of the

   *        preselected |PIN*| methods.

   * @param joinExistingGroup Indicates that this is a command to join an

   *        existing group as a client. It skips the group owner negotiation

   *        part. This must send a Provision Discovery Request message to the

   *        target group owner before associating for WPS provisioning.

   * @param persistent Used to request a persistent group to be formed.

   * @param goIntent Used to override the default Intent for this group owner

   *        negotiation (Values from 1-15). Refer to section 4.1.6 in

   *        Wi-Fi Peer-to-Peer (P2P) Technical Specification Version 1.7.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_ARGS_INVALID|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   * @return generatedPin Pin generated, if |provisionMethod| uses one of the

   *         generated |PIN*| methods.

   */

  connect(MacAddress peerAddress,

          WpsProvisionMethod provisionMethod,

          vec<uint8_t> preSelectedPin,

          bool joinExistingGroup,

          bool persistent,

          uint32_t goIntent)

      generates (SupplicantStatus status, vec<uint8_t> generatedPin);



  /**

   * Cancel an ongoing P2P group formation and joining-a-group related

   * operation. This operation unauthorizes the specific peer device (if any

   * had been authorized to start group formation), stops P2P find (if in

   * progress), stops pending operations for join-a-group, and removes the

   * P2P group interface (if one was used) that is in the WPS provisioning

   * step. If the WPS provisioning step has been completed, the group is not

   * terminated.

   *

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_NOT_STARTED|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  cancelConnect() generates (SupplicantStatus status);



  /**

   * Send P2P provision discovery request to the specified peer. The

   * parameters for this command are the P2P device address of the peer and the

   * desired configuration method.

   *

   * @param peerAddress MAC address of the device to send discovery.

   * @method provisionMethod Provisioning method to use.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  provisionDiscovery(MacAddress peerAddress,

                     WpsProvisionMethod provisionMethod)

      generates (SupplicantStatus status);



  /**

   * Set up a P2P group owner manually (i.e., without group owner

   * negotiation with a specific peer). This is also known as autonomous

   * group owner. Optional |persistent| may be used to specify restart of a

   * persistent group.

   *

   * @param persistent Used to request a persistent group to be formed.

   * @param persistentNetworkId Used to specify the restart of a persistent

   *        group.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  addGroup(bool persistent, SupplicantNetworkId persistentNetworkId)

      generates (SupplicantStatus status);



  /**

   * Terminate a P2P group. If a new virtual network interface was used for

   * the group, it must also be removed. The network interface name of the

   * group interface is used as a parameter for this command.

   *

   * @param groupIfName Group interface name to use.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  removeGroup(string groupIfName) generates (SupplicantStatus status);



  /**

   * Reject connection attempt from a peer (specified with a device

   * address). This is a mechanism to reject a pending group owner negotiation

   * with a peer and request to automatically block any further connection or

   * discovery of the peer.

   *

   * @param peerAddress MAC address of the device to reject.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  reject(MacAddress peerAddress) generates (SupplicantStatus status);



  /**

   * Invite a device to a persistent group.

   * If the peer device is the group owner of the persistent group, the peer

   * parameter is not needed. Otherwise it is used to specify which

   * device to invite. |goDeviceAddress| parameter may be used to override

   * the group owner device address for Invitation Request should it not be

   * known for some reason (this should not be needed in most cases).

   *

   * @param groupIfName Group interface name to use.

   * @param goDeviceAddress MAC address of the group owner device.

   * @param peerAddress MAC address of the device to invite.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  invite(string groupIfName, MacAddress goDeviceAddress, MacAddress peerAddress)

      generates (SupplicantStatus status);



  /**

   * Reinvoke a device from a persistent group.

   *

   * @param persistentNetworkId Used to specify the persistent group.

   * @param peerAddress MAC address of the device to reinvoke.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  reinvoke(SupplicantNetworkId persistentNetworkId, MacAddress peerAddress)

      generates (SupplicantStatus status);



  /**

   * Configure Extended Listen Timing.

   *

   * If enabled, listen state must be entered every |intervalInMillis| for at

   * least |periodInMillis|. Both values have acceptable range of 1-65535

   * (with interval obviously having to be larger than or equal to duration).

   * If the P2P module is not idle at the time the Extended Listen Timing

   * timeout occurs, the Listen State operation must be skipped.

   *

   * @param periodInMillis Period in milliseconds.

   * @param intervalInMillis Interval in milliseconds.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_ARGS_INVALID|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  configureExtListen(bool enable,

                     uint32_t periodInMillis,

                     uint32_t intervalInMillis)

      generates (SupplicantStatus status);



  /**

   * Set P2P Listen channel.

   *

   * When specifying a social channel on the 2.4 GHz band (1/6/11) there is no

   * need to specify the operating class since it defaults to 81. When

   * specifying a social channel on the 60 GHz band (2), specify the 60 GHz

   * operating class (180).

   *

   * @param channel Wifi channel. eg, 1, 6, 11.

   * @param operatingClass Operating Class indicates the channel set of the AP

   *        indicated by this BSSID

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  setListenChannel(uint32_t channel, uint32_t operatingClass)

      generates (SupplicantStatus status);



  /**

   * Gets the operational SSID of the device.

   *

   * @param peerAddress MAC address of the peer.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   * @return ssid SSID of the device

   */

  getSsid(MacAddress peerAddress)

      generates (SupplicantStatus status, Ssid ssid);



  /**

   * Gets the capability of the group which the device is a

   * member of.

   *

   * @param peerAddress MAC address of the peer.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   * @return capabilityMask Combination of |GroupCapabilityMask| values.

   */

  getGroupCapability(MacAddress peerAddress)

      generates (SupplicantStatus status, uint32_t capabilities);



  /**

   * This command can be used to add a bonjour service.

   *

   * @param query Hex dump of the query data.

   * @param return Hex dump of the response data.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  addBonjourService(vec<uint8_t> query, vec<uint8_t> response)

      generates (SupplicantStatus status);



  /**

   * This command can be used to remove a bonjour service.

   *

   * @param query Hex dump of the query data.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_NOT_STARTED|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  removeBonjourService(vec<uint8_t> query) generates (SupplicantStatus status);



  /**

   * This command can be used to add a UPNP service.

   *

   * @param version Version to be used.

   * @package serviceName Service name to be used.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  addUpnpService(uint32_t version, string serviceName)

      generates (SupplicantStatus status);



  /**

   * This command can be used to remove a UPNP service.

   *

   * @param version Version to be used.

   * @package serviceName Service name to be used.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_NOT_STARTED|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  removeUpnpService(uint32_t version, string serviceName)

      generates (SupplicantStatus status);



  /**

   * This command can be used to flush all services from the

   * device.

   *

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  flushServices(uint32_t version, string serviceName)

      generates (SupplicantStatus status);



  /**

   * Schedule a P2P service discovery request. The parameters for this command

   * are the device address of the peer device (or 00:00:00:00:00:00 for

   * wildcard query that is sent to every discovered P2P peer that supports

   * service discovery) and P2P Service Query TLV(s) as hexdump.

   *

   * @param peerAddress MAC address of the device to discover.

   * @param query Hex dump of the query data.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   * @return identifier Identifier for the request. Can be used to cancel the

   *         request.

   */

  requestServiceDiscovery(MacAddress peerAddress, vec<uint8_t> query)

      generates (SupplicantStatus status, uint64_t identifier);



  /**

   * Cancel a previous service discovery request.

   *

   * @return identifier Identifier for the request to cancel.

   * @return status Status of the operation.

   *         Possible status codes:

   *         |SupplicantStatusCode.SUCCESS|,

   *         |SupplicantStatusCode.FAILURE_NOT_STARTED|,

   *         |SupplicantStatusCode.FAILURE_UNKNOWN|,

   *         |SupplicantStatusCode.FAILURE_IFACE_INVALID|

   */

  cancelServiceDiscovery(uint64_t identifier)

      generates (SupplicantStatus status);

};

wifi/supplicant/1.0/ISupplicantStaNetwork.hal

+23 −0

File changed.

Preview size limit exceeded, changes collapsed.