]> begriffs open source - cmsis-driver-validation/blob - Config/DV_WiFi_Config.h
Update GitHub Actions runner to ubuntu-22.04 (#18)
[cmsis-driver-validation] / Config / DV_WiFi_Config.h
1 /*
2  * Copyright (c) 2015-2020 Arm Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  *
6  * Licensed under the Apache License, Version 2.0 (the License); you may
7  * not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
14  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  * -----------------------------------------------------------------------------
19  *
20  * $Revision:   V1.1.0
21  *
22  * Project:     CMSIS-Driver Validation
23  * Title:       WiFi driver validation configuration file
24  *
25  * -----------------------------------------------------------------------------
26  */
27
28 #ifndef DV_WIFI_CONFIG_H_
29 #define DV_WIFI_CONFIG_H_
30
31 //-------- <<< Use Configuration Wizard in Context Menu >>> --------------------
32
33 // <h> WiFi
34 // <i> WiFi driver validation configuration
35 // <o> Driver_WiFi# <0-255>
36 // <i> Choose the Driver_WiFi# instance to test.
37 // <i> For example to test Driver_WiFi0 select 0.
38 #define DRV_WIFI                        0
39 // <h> Configuration
40 // <i> Configuration of valid settings for driver functionality testing
41 // <h> Station
42 // <i> Settings relevant for Station
43 // <s.32> SSID
44 // <i> SSID of network that Station will connect to
45 #define WIFI_STA_SSID                   "SSID"
46 // <s.32> Password
47 // <i> Password of network that Station will connect to
48 #define WIFI_STA_PASS                   "Password"
49 // <o> Security Type
50 // <0=> Open <1=> WEP <2=> WPA <3=> WPA2
51 // <i> Security type of network that Station will connect to
52 #define WIFI_STA_SECURITY               3
53 // <o> Channel
54 // <i> WiFi channel of network that Station will connect to
55 // <i> Value 0 means Autodetect
56 #define WIFI_STA_CH                     0
57 // <s.8> WPS PIN
58 // <i> WiFi Protected Setup Personal Identification Number
59 #define WIFI_STA_WPS_PIN                "12345678"
60 // </h>
61 // <h> Access Point
62 // <i> Settings relevant for Access Point
63 // <s.32> SSID
64 // <i> SSID of created network
65 #define WIFI_AP_SSID                    "CMSIS_DV"
66 // <s.32> Password
67 // <i> Password of created network
68 #define WIFI_AP_PASS                    "Password"
69 // <o> Security Type
70 // <0=> Open <1=> WEP <2=> WPA <3=> WPA2
71 // <i> Security type of created network
72 #define WIFI_AP_SECURITY                3
73 // <o> Channel
74 // <i> WiFi channel of created network
75 // <i> Value 0 means Autoselect
76 #define WIFI_AP_CH                      0
77 // <s.8> WPS PIN
78 // <i> WiFi Protected Setup Personal Identification Number
79 #define WIFI_AP_WPS_PIN                 "12345678"
80 // </h>
81 // <h> Socket
82 // <i> Settings relevant for Socket testing
83 // <s.15>SockServer IP
84 // <i>Static IPv4 Address of SockServer
85 #define WIFI_SOCKET_SERVER_IP           "192.168.1.10"
86 // <o> Number of sockets
87 // <i> Number of sockets that driver supports
88 // <i> Default: 4
89 #define WIFI_SOCKET_MAX_NUM             4
90 // </h>
91 // </h>
92 // <h> Tests
93 // <i> Enable / disable tests.
94 // <e> Control
95 // <i> Control functions tests
96 #define WIFI_CONTROL_EN                 1
97 // <q> WIFI_GetVersion
98 #define WIFI_GETVERSION_EN              1
99 // <q> WIFI_GetCapabilities
100 #define WIFI_GETCAPABILITIES_EN         1
101 // <q> WIFI_Initialization/Uninitialization
102 #define WIFI_INIT_UNINIT_EN             1
103 // <q> WIFI_PowerControl
104 #define WIFI_POWERCONTROL_EN            1
105 // <q> WIFI_GetModuleInfo
106 #define WIFI_GETMODULEINFO_EN           1
107 // </e>
108 // <e> Management
109 // <i> Management functions tests
110 #define WIFI_MANAGEMENT_EN              1
111 // <e> WIFI_SetOption/GetOption
112 #define WIFI_SETGETOPTION_EN            1
113 // <o0> ARM_WIFI_BSSID <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
114 // <i> Default test value is set in defines WIFI_BSSID_STA/WIFI_BSSID_AP (1E-30-6C-A2-45-5E)
115 #define WIFI_SETGETOPTION_BSSID_EN      3
116 // <o0> ARM_WIFI_TX_POWER <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
117 // <i> Default test value is set in defines WIFI_TX_POWER_STA/WIFI_TX_POWER_AP (16)
118 #define WIFI_SETGETOPTION_TX_POWER_EN   3
119 // <o0> ARM_WIFI_LP_TIMER <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
120 // <i> Default test value is set in defines WIFI_LP_TIMER_STA (10)
121 #define WIFI_SETGETOPTION_LP_TIMER_EN   3
122 // <o0> ARM_WIFI_DTIM <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
123 // <i> Default test value is set in defines WIFI_DTIM_STA/WIFI_DTIM_AP (3)
124 #define WIFI_SETGETOPTION_DTIM_EN       3
125 // <o0> ARM_WIFI_BEACON <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
126 // <i> Default test value is set in defines WIFI_BEACON_AP (2000)
127 #define WIFI_SETGETOPTION_BEACON_EN     3
128 // <o0> ARM_WIFI_MAC <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
129 // <i> Default test value is set in defines WIFI_MAC_STA/WIFI_MAC_AP (1E-30-6C-A2-45-5E)
130 #define WIFI_SETGETOPTION_MAC_EN        3
131 // <o0> ARM_WIFI_IP <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
132 // <i> Default test value is set in defines WIFI_IP_STA/WIFI_IP_AP (192.168.0.100)
133 #define WIFI_SETGETOPTION_IP_EN         3
134 // <o0> ARM_WIFI_IP_SUBNET_MASK <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
135 // <i> Default test value is set in defines WIFI_IP_SUBNET_MASK_STA/WIFI_IP_SUBNET_MASK_AP (255.255.255.0)
136 #define WIFI_SETGETOPTION_IP_SUBNET_MASK_EN 3
137 // <o0> ARM_WIFI_IP_GATEWAY <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
138 // <i> Default test value is set in defines WIFI_IP_GATEWAY_STA/WIFI_IP_GATEWAY_AP (192.168.0.254)
139 #define WIFI_SETGETOPTION_IP_GATEWAY_EN 3
140 // <o0> ARM_WIFI_IP_DNS1 <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
141 // <i> Default test value is set in defines WIFI_IP_DNS1_STA/WIFI_IP_DNS1_AP (8.8.8.8)
142 #define WIFI_SETGETOPTION_IP_DNS1_EN    3
143 // <o0> ARM_WIFI_IP_DNS2 <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
144 // <i> Default test value is set in defines WIFI_IP_DNS2_STA/WIFI_IP_DNS2_AP (8.8.4.4)
145 #define WIFI_SETGETOPTION_IP_DNS2_EN    3
146 // <o0> ARM_WIFI_IP_DHCP <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
147 #define WIFI_SETGETOPTION_IP_DHCP_EN    3
148 // <o0> ARM_WIFI_IP_DHCP_POOL_BEGIN <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
149 // <i> Default test value is set in defines WIFI_IP_DHCP_POOL_BEGIN_AP (192.168.0.100)
150 #define WIFI_SETGETOPTION_IP_DHCP_POOL_BEGIN_EN 3
151 // <o0> ARM_WIFI_IP_DHCP_POOL_END <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
152 // <i> Default test value is set in defines WIFI_IP_DHCP_POOL_END_AP (192.168.0.200)
153 #define WIFI_SETGETOPTION_IP_DHCP_POOL_END_EN   3
154 // <o0> ARM_WIFI_IP_DHCP_LEASE_TIME <0=>Disabled <1=>Set <2=>Get <3=>Set/Get
155 // <i> Default test value is set in defines WIFI_IP_DHCP_LEASE_TIME_AP (3600)
156 #define WIFI_SETGETOPTION_IP_DHCP_LEASE_TIME_EN 3
157 // </e>
158 // <q> WIFI_Scan
159 #define WIFI_SCAN_EN                    1
160 #define WIFI_SCAN_MAX_NUM               10
161 // <q> WIFI_Activate/Deactivate
162 #define WIFI_ACT_DEACT_EN               1
163 // <q> WIFI_IsConnected
164 #define WIFI_ISCONNECTED_EN             1
165 // <q> WIFI_GetNetInfo
166 #define WIFI_GETNETINFO_EN              1
167 // </e>
168 // <e> Management (requires user interaction)
169 // <i> Management functions tests that require user interaction
170 #define WIFI_MANAGEMENT_USER_EN         0
171 // <q> WIFI_Activate_AP
172 // <i> For this test please connect a WiFi client (for example mobile phone) to AP
173 // <i> and check if connection has succeeded
174 #define WIFI_ACT_AP                     1
175 // <e> WPS
176 #define WIFI_WPS_USER_EN                1
177 // <q> WIFI_Activate_Station_WPS_PBC
178 // <i> For this test please start WPS Push-button method on WiFi AP (router) manually
179 #define WIFI_ACT_STA_WPS_PBC            1
180 // <q> WIFI_Activate_Station_WPS_PIN
181 // <i> For this test please configure WPS PIN method on WiFi AP (router) manually
182 #define WIFI_ACT_STA_WPS_PIN            1
183 // <q> WIFI_Activate_AP_WPS_PBC
184 // <i> For this test please connect a WiFi client (for example mobile phone) to AP with WPS Push-button method
185 // <i> and check if connection has succeeded
186 #define WIFI_ACT_AP_WPS_PBC             1
187 // <q> WIFI_Activate_AP_WPS_PIN
188 // <i> For this test please connect a WiFi client (for example mobile phone) to AP with WPS PIN method
189 // <i> and check if connection has succeeded
190 #define WIFI_ACT_AP_WPS_PIN             1
191 // </e>
192 // </e>
193 // <e> Socket API (requires SockServer)
194 // <i> Socket functions tests
195 #define WIFI_SOCKET_EN                  1
196 // <q> WIFI_SocketCreate
197 #define WIFI_SOCKETCREATE_EN            1
198 // <q> WIFI_SocketBind
199 #define WIFI_SOCKETBIND_EN              1
200 // <q> WIFI_SocketListen
201 #define WIFI_SOCKETLISTEN_EN            1
202 // <q> WIFI_SocketAccept
203 #define WIFI_SOCKETACCEPT_EN            1
204 // <q> WIFI_SocketAccept_nbio
205 #define WIFI_SOCKETACCEPT_NBIO_EN       1
206 // <q> WIFI_SocketConnect
207 #define WIFI_SOCKETCONNECT_EN           1
208 // <q> WIFI_SocketConnect_nbio
209 #define WIFI_SOCKETCONNECT_NBIO_EN      1
210 // <q> WIFI_SocketRecv
211 #define WIFI_SOCKETRECV_EN              1
212 // <q> WIFI_SocketRecv_nbio
213 #define WIFI_SOCKETRECV_NBIO_EN         1
214 // <q> WIFI_SocketRecvFrom
215 #define WIFI_SOCKETRECVFROM_EN          1
216 // <q> WIFI_SocketRecvFrom_nbio
217 #define WIFI_SOCKETRECVFROM_NBIO_EN     1
218 // <q> WIFI_SocketSend
219 #define WIFI_SOCKETSEND_EN              1
220 // <q> WIFI_SocketSendTo
221 #define WIFI_SOCKETSENDTO_EN            1
222 // <q> WIFI_SocketGetSockName
223 #define WIFI_SOCKETGETSOCKNAME_EN       1
224 // <q> WIFI_SocketGetPeerName
225 #define WIFI_SOCKETGETPEERNAME_EN       1
226 // <q> WIFI_SocketGetOpt
227 #define WIFI_SOCKETGETOPT_EN            1
228 // <q> WIFI_SocketSetOpt
229 #define WIFI_SOCKETSETOPT_EN            1
230 // <q> WIFI_SocketClose
231 #define WIFI_SOCKETCLOSE_EN             1
232 // <q> WIFI_SocketGetHostByName
233 #define WIFI_SOCKETGETHOSTBYNAME_EN     1
234 // <q> WIFI_Ping
235 #define WIFI_PING_EN                    1
236 // </e>
237 // <e> Socket Operation (requires SockServer)
238 // <i> Socket operation tests
239 #define WIFI_SOCKET_OP_EN               1
240 // <q> WIFI_Transfer_Fixed
241 // <i> Sends and receives in fixed size blocks
242 #define WIFI_TRANSFER_FIXED_EN          1
243 // <q> WIFI_Transfer_Incremental
244 // <i> Sends and receives in ascending size blocks
245 #define WIFI_TRANSFER_INCREMENTAL_EN    1
246 // <q> WIFI_Send_Fragmented
247 // <i> Sends several smaller blocks, receives one large block
248 #define WIFI_SEND_FRAGMENTED_EN         1
249 // <q> WIFI_Recv_Fragmented
250 // <i> Sends one large block, receives several smaller blocks
251 #define WIFI_RECV_FRAGMENTED_EN         1
252 // <q> WIFI_Test_Speed
253 // <i> Transmits data and measures transfer speed
254 #define WIFI_TEST_SPEED_EN              1
255 // <q> WIFI_Concurrent_Socket
256 // <i> Transmits data in two sockets simultaneously
257 #define WIFI_CONCURRENT_SOCKET_EN       1
258 // <q> WIFI_Downstream_Rate
259 // <i> Measures the downstream bandwidth
260 #define WIFI_DOWNSTREAM_RATE_EN         1
261 // <q> WIFI_Upstream_Rate
262 // <i> Measures the upstream bandwidth
263 #define WIFI_UPSTREAM_RATE_EN           1
264 // </e>
265 // </h>
266 // </h>
267
268 // Configuration settings of test values for Set/GetOptions
269 // BSSID
270 #define WIFI_BSSID_STA                  "1E-30-6C-A2-45-5E"
271 #define WIFI_BSSID_AP                   "1E-30-6C-A2-45-5E"
272 // Radio transmitting power in dBm
273 #define WIFI_TX_POWER_STA               16
274 #define WIFI_TX_POWER_AP                16
275 // Low-power deep-sleep time value in seconds
276 #define WIFI_LP_TIMER_STA               10
277 // Delivery Traffic Indication Message interval value in beacons
278 #define WIFI_DTIM_STA                   3
279 #define WIFI_DTIM_AP                    3
280 // Beacon interval value in milliseconds
281 #define WIFI_BEACON_AP                  2000
282 // Ethernet MAC Address in text representation
283 #define WIFI_MAC_STA                    "1E-30-6C-A2-45-5E"
284 #define WIFI_MAC_AP                     "1E-30-6C-A2-45-5E"
285 // Static IPv4 Address in text representation
286 #define WIFI_IP_STA                     "192.168.0.100"
287 #define WIFI_IP_AP                      "192.168.0.100"
288 // Local Subnet mask in text representation
289 #define WIFI_IP_SUBNET_MASK_STA         "255.255.255.0"
290 #define WIFI_IP_SUBNET_MASK_AP          "255.255.255.0"
291 // IP Address of Default Gateway in text representation
292 #define WIFI_IP_GATEWAY_STA             "192.168.0.254"
293 #define WIFI_IP_GATEWAY_AP              "192.168.0.254"
294 // IP Address of Primary DNS Server in text representation
295 #define WIFI_IP_DNS1_STA                "8.8.8.8"
296 #define WIFI_IP_DNS1_AP                 "8.8.8.8"
297 // IP Address of Secondary DNS Server in text representation
298 #define WIFI_IP_DNS2_STA                "8.8.4.4"
299 #define WIFI_IP_DNS2_AP                 "8.8.4.4"
300 // IP Address of DHCP server pool beginning in text representation
301 #define WIFI_IP_DHCP_POOL_BEGIN_AP      "192.168.0.100"
302 // IP Address of DHCP server pool end in text representation
303 #define WIFI_IP_DHCP_POOL_END_AP        "192.168.0.200"
304 // DHCP lease time value in seconds
305 #define WIFI_IP_DHCP_LEASE_TIME_AP      3600
306
307 // Timeout configuration that can be used for adjusting tests to limitations of the WiFi Module (in ms)
308 #define WIFI_SOCKET_TIMEOUT             2000
309 #define WIFI_SOCKET_TIMEOUT_LONG        35000
310
311 // Time that Access Point will wait for Client to connect to it (in ms)
312 #define WIFI_AP_CLIENT_CON_TIMEOUT      120000
313
314 #endif /* DV_WIFI_CONFIG_H_ */