summaryrefslogtreecommitdiff
path: root/wifi/supplicant/1.4/types.hal
blob: b72eb425b0b0e637f9196eeca99c7e9327d75331 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.hardware.wifi.supplicant@1.4;

import @1.0::SupplicantStatusCode;
import @1.3::ConnectionCapabilities;
import @1.3::DppFailureCode;
import @1.3::WpaDriverCapabilitiesMask;

/**
 * Detailed network mode for legacy network
 */
enum LegacyMode : uint32_t {
    UNKNOWN = 0,
    /**
     * For 802.11a
     */
    A_MODE = 1,
    /**
     * For 802.11b
     */
    B_MODE = 2,
    /**
     * For 802.11g
     */
    G_MODE = 3,
};

/**
 * DppFailureCode: Error codes for DPP (Easy Connect)
 */
enum DppFailureCode : @1.3::DppFailureCode {
    /**
     * Failure to generate a DPP URI.
     */
    URI_GENERATION,
};

/**
 * DppCurve: Elliptic curve cryptography type used to generate DPP
 * public/private key pair.
 */
enum DppCurve : uint32_t {
    PRIME256V1,
    SECP384R1,
    SECP521R1,
    BRAINPOOLP256R1,
    BRAINPOOLP384R1,
    BRAINPOOLP512R1,
};

/**
 * Connection Capabilities supported by current network and device
 */
struct ConnectionCapabilities {
    /**
     * Baseline information as defined in HAL 1.3.
     */
    @1.3::ConnectionCapabilities V1_3;

    /**
     * detailed network mode for legacy network
     */
    LegacyMode legacyMode;
};

/**
 * Enum values indicating the status of any supplicant operation.
 */
enum SupplicantStatusCode : @1.0::SupplicantStatusCode {
    FAILURE_UNSUPPORTED,
};

/**
 * Generic structure to return the status of any supplicant operation.
 */
struct SupplicantStatus {
    SupplicantStatusCode code;

    /**
     * A vendor specific error message to provide more information beyond the
     * status code.
     * This will be used for debbuging purposes only.
     */
    string debugMessage;
};

/**
 * WPA Driver capability.
 */
enum WpaDriverCapabilitiesMask : @1.3::WpaDriverCapabilitiesMask {
    /**
     * WPA3 SAE Public-Key.
     */
    SAE_PK = 1 << 2,
    /**
     * Wi-Fi Display R2
     */
    WFD_R2 = 1 << 3,
};

/**
 * DPP bootstrap info generated for responder mode operation
 */
struct DppResponderBootstrapInfo {
    /**
     * Generated bootstrap identifier
     */
    uint32_t bootstrapId;

    /**
     * The Wi-Fi channel that the DPP responder is listening on.
     */
    uint32_t listenChannel;

    /**
     * Bootstrapping URI per DPP specification, "section 5.2 Bootstrapping
     * information", may contain listen channel, MAC address, public key, or other information.
     */
    string uri;
};