Loading...
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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 | /* * Copyright (c) 2018 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #include <zephyr/kernel.h> #include <zephyr/device.h> #include <zephyr/init.h> #include <zephyr/ztest.h> #include <zephyr/sys/printk.h> #include <zephyr/linker/sections.h> #include "abstract_driver.h" #define DUMMY_PORT_1 "dummy" #define DUMMY_PORT_2 "dummy_driver" #define DUMMY_NOINIT "dummy_noinit" #define BAD_DRIVER "bad_driver" #define MY_DRIVER_A "my_driver_A" #define MY_DRIVER_B "my_driver_B" /* A device without init call */ DEVICE_DEFINE(dummy_noinit, DUMMY_NOINIT, NULL, NULL, NULL, NULL, POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, NULL); /** * @brief Test cases to verify device objects * * Verify zephyr device driver apis with different device types * * @defgroup kernel_device_tests Device * * @ingroup all_tests * * @{ */ /** * @brief Test device object binding * * Validates device binding for an existing and a non-existing device object. * It creates a dummy_driver device object with basic init and configuration * information and validates its binding. * * Validates three kinds situations of driver object: * 1. A non-existing device object. * 2. An existing device object with basic init and configuration information. * 3. A failed init device object. * * @ingroup kernel_device_tests * * @see device_get_binding(), DEVICE_DEFINE() */ ZTEST(device, test_dummy_device) { const struct device *dev; /* Validates device binding for a non-existing device object */ dev = device_get_binding(DUMMY_PORT_1); zassert_is_null(dev); /* Validates device binding for an existing device object */ dev = device_get_binding(DUMMY_PORT_2); zassert_not_null(dev); /* Validates device binding for an existing device object */ dev = device_get_binding(DUMMY_NOINIT); zassert_not_null(dev); /* device_get_binding() returns false for device object * with failed init. */ dev = device_get_binding(BAD_DRIVER); zassert_is_null(dev); } /** * @brief Test device binding for existing device * * Validates device binding for an existing device object. * * @see device_get_binding(), DEVICE_DEFINE() */ ZTEST_USER(device, test_dynamic_name) { const struct device *mux; char name[sizeof(DUMMY_PORT_2)]; snprintk(name, sizeof(name), "%s", DUMMY_PORT_2); mux = device_get_binding(name); zassert_true(mux != NULL); } /** * @brief Test device binding for non-existing device * * Validates binding of a random device driver(non-defined driver) named * "ANOTHER_BOGUS_NAME". * * @see device_get_binding(), DEVICE_DEFINE() */ ZTEST_USER(device, test_bogus_dynamic_name) { const struct device *mux; char name[64]; snprintk(name, sizeof(name), "ANOTHER_BOGUS_NAME"); mux = device_get_binding(name); zassert_true(mux == NULL); } /** * @brief Test device binding for passing null name * * Validates device binding for device object when given dynamic name is null. * * @see device_get_binding(), DEVICE_DEFINE() */ ZTEST_USER(device, test_null_dynamic_name) { /* Supplying a NULL dynamic name may trigger a SecureFault and * lead to system crash in TrustZone enabled Non-Secure builds. */ #if defined(CONFIG_USERSPACE) && !defined(CONFIG_TRUSTED_EXECUTION_NONSECURE) const struct device *mux; char *drv_name = NULL; mux = device_get_binding(drv_name); zassert_equal(mux, 0); #else ztest_test_skip(); #endif } __pinned_bss static struct init_record { bool pre_kernel; bool is_in_isr; bool is_pre_kernel; bool could_yield; } init_records[4]; __pinned_data static struct init_record *rp = init_records; __pinned_func static int add_init_record(bool pre_kernel) { rp->pre_kernel = pre_kernel; rp->is_pre_kernel = k_is_pre_kernel(); rp->is_in_isr = k_is_in_isr(); rp->could_yield = k_can_yield(); ++rp; return 0; } __pinned_func static int pre1_fn(void) { return add_init_record(true); } __pinned_func static int pre2_fn(void) { return add_init_record(true); } static int post_fn(void) { return add_init_record(false); } static int app_fn(void) { return add_init_record(false); } SYS_INIT(pre1_fn, PRE_KERNEL_1, 0); SYS_INIT(pre2_fn, PRE_KERNEL_2, 0); SYS_INIT(post_fn, POST_KERNEL, 0); SYS_INIT(app_fn, APPLICATION, 0); /* This is an error case which driver initializes failed in SYS_INIT .*/ static int null_driver_init(void) { return -EINVAL; } SYS_INIT(null_driver_init, POST_KERNEL, 0); /** * @brief Test detection of initialization before kernel services available. * * Confirms check is correct. * * @see k_is_pre_kernel() */ ZTEST(device, test_pre_kernel_detection) { struct init_record *rpe = rp; zassert_equal(rp - init_records, 4U, "bad record count"); rp = init_records; while ((rp < rpe) && rp->pre_kernel) { zassert_equal(rp->is_in_isr, false, "rec %zu isr", rp - init_records); zassert_equal(rp->is_pre_kernel, true, "rec %zu pre-kernel", rp - init_records); zassert_equal(rp->could_yield, false, "rec %zu could-yield", rp - init_records); ++rp; } zassert_equal(rp - init_records, 2U, "bad pre-kernel count"); while (rp < rpe) { zassert_equal(rp->is_in_isr, false, "rec %zu isr", rp - init_records); zassert_equal(rp->is_pre_kernel, false, "rec %zu post-kernel", rp - init_records); zassert_equal(rp->could_yield, true, "rec %zu could-yield", rp - init_records); ++rp; } } /** * @brief Test system device list query API. * * It queries the list of devices in the system, used to suspend or * resume the devices in PM applications. * * @see z_device_get_all_static() */ ZTEST(device, test_device_list) { struct device const *devices; size_t devcount = z_device_get_all_static(&devices); zassert_false((devcount == 0)); } static int sys_init_counter; static int init_fn(void) { sys_init_counter++; return 0; } SYS_INIT(init_fn, APPLICATION, 0); SYS_INIT_NAMED(init1, init_fn, APPLICATION, 1); SYS_INIT_NAMED(init2, init_fn, APPLICATION, 2); SYS_INIT_NAMED(init3, init_fn, APPLICATION, 2); ZTEST(device, test_sys_init_multiple) { zassert_equal(sys_init_counter, 4, ""); } /* this is for storing sequence during initialization */ extern int init_level_sequence[4]; extern int init_priority_sequence[4]; extern unsigned int seq_level_cnt; extern unsigned int seq_priority_cnt; /** * @brief Test initialization level for device driver instances * * @details After the defined device instances have initialized, we check the * sequence number that each driver stored during initialization. If the * sequence of initial level stored is corresponding with our expectation, it * means assigning the level for driver instance works. * * @ingroup kernel_device_tests */ ZTEST(device, test_device_init_level) { bool seq_correct = true; /* we check if the stored executing sequence for different level is * correct, and it should be 1, 2, 3, 4 */ for (int i = 0; i < 4; i++) { if (init_level_sequence[i] != (i + 1)) { seq_correct = false; } } zassert_true((seq_correct == true), "init sequence is not correct"); } /** * @brief Test initialization priorities for device driver instances * * details After the defined device instances have initialized, we check the * sequence number that each driver stored during initialization. If the * sequence of initial priority stored is corresponding with our expectation, it * means assigning the priority for driver instance works. * * @ingroup kernel_device_tests */ ZTEST(device, test_device_init_priority) { bool sequence_correct = true; /* we check if the stored pexecuting sequence for priority is correct, * and it should be 1, 2, 3, 4 */ for (int i = 0; i < 4; i++) { if (init_priority_sequence[i] != (i + 1)) { sequence_correct = false; } } zassert_true((sequence_correct == true), "init sequence is not correct"); } /** * @brief Test abstraction of device drivers with common functionalities * * @details Abstraction of device drivers with common functionalities * shall be provided as an intermediate interface between applications * and device drivers, where such interface is implemented by individual * device drivers. We verify this by following step: * 1. Define a subsystem api for drivers. * 2. Define and create two driver instances. * 3. Two drivers call the same subsystem API, and we verify that each * driver instance will call their own implementations. * * @ingroup kernel_device_tests */ ZTEST(device, test_abstraction_driver_common) { const struct device *dev; int ret; int foo = 2; int bar = 1; unsigned int baz = 0; /* verify driver A API has called */ dev = device_get_binding(MY_DRIVER_A); zassert_false((dev == NULL)); ret = subsystem_do_this(dev, foo, bar); zassert_true(ret == (foo + bar), "common API do_this fail"); subsystem_do_that(dev, &baz); zassert_true(baz == 1, "common API do_that fail"); /* verify driver B API has called */ dev = device_get_binding(MY_DRIVER_B); zassert_false((dev == NULL)); ret = subsystem_do_this(dev, foo, bar); zassert_true(ret == (foo - bar), "common API do_this fail"); subsystem_do_that(dev, &baz); zassert_true(baz == 2, "common API do_that fail"); } /** * @} */ ZTEST_SUITE(device, NULL, NULL, NULL, NULL, NULL); |