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 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 | /* * Copyright (c) 2015 Intel Corporation. * * SPDX-License-Identifier: Apache-2.0 */ #ifndef ZEPHYR_INCLUDE_DEVICE_H_ #define ZEPHYR_INCLUDE_DEVICE_H_ /** * @brief Device Driver APIs * @defgroup io_interfaces Device Driver APIs * @{ * @} */ /** * @brief Device Model APIs * @defgroup device_model Device Model APIs * @{ */ #include <init.h> #include <sys/device_mmio.h> #ifdef __cplusplus extern "C" { #endif #define Z_DEVICE_MAX_NAME_LEN 48 /** * @def DEVICE_NAME_GET * * @brief Expands to the full name of a global device object * * @details Return the full name of a device object symbol created by * DEVICE_DEFINE(), using the dev_name provided to DEVICE_DEFINE(). * * It is meant to be used for declaring extern symbols pointing on device * objects before using the DEVICE_GET macro to get the device object. * * @param name The same as dev_name provided to DEVICE_DEFINE() * * @return The expanded name of the device object created by DEVICE_DEFINE() */ #define DEVICE_NAME_GET(name) (_CONCAT(__device_, name)) /** * @def SYS_DEVICE_DEFINE * * @brief Run an initialization function at boot at specified priority, * and define device PM control function. * * @details Invokes DEVICE_DEFINE() with no power management support * (@p pm_control_fn), no API (@p api_ptr), and a device name derived from * the @p init_fn name (@p dev_name). */ #define SYS_DEVICE_DEFINE(drv_name, init_fn, pm_control_fn, level, prio) \ DEVICE_DEFINE(Z_SYS_NAME(init_fn), drv_name, init_fn, \ pm_control_fn, \ NULL, NULL, level, prio, NULL) /** * @def DEVICE_INIT * * @brief Invoke DEVICE_DEFINE() with no power management support (@p * pm_control_fn) and no API (@p api_ptr). */ #define DEVICE_INIT(dev_name, drv_name, init_fn, \ data_ptr, cfg_ptr, level, prio) \ DEVICE_DEFINE(dev_name, drv_name, init_fn, \ device_pm_control_nop, \ data_ptr, cfg_ptr, level, prio, NULL) /** * @def DEVICE_AND_API_INIT * * @brief Invoke DEVICE_DEFINE() with no power management support (@p * pm_control_fn). */ #define DEVICE_AND_API_INIT(dev_name, drv_name, init_fn, \ data_ptr, cfg_ptr, level, prio, api_ptr) \ DEVICE_DEFINE(dev_name, drv_name, init_fn, \ device_pm_control_nop, \ data_ptr, cfg_ptr, level, prio, api_ptr) /** * @def DEVICE_DEFINE * * @brief Create device object and set it up for boot time initialization, * with the option to device_pm_control. In case of Device Idle Power * Management is enabled, make sure the device is in suspended state after * initialization. * * @details This macro defines a device object that is automatically * configured by the kernel during system initialization. Note that * devices set up with this macro will not be accessible from user mode * since the API is not specified; whenever possible, use DEVICE_AND_API_INIT * instead. * * @param dev_name Device name. This must be less than Z_DEVICE_MAX_NAME_LEN * characters in order to be looked up from user mode with device_get_binding(). * * @param drv_name The name this instance of the driver exposes to * the system. * * @param init_fn Address to the init function of the driver. * * @param pm_control_fn Pointer to device_pm_control function. * Can be empty function (device_pm_control_nop) if not implemented. * * @param data_ptr Pointer to the device's private data. * * @param cfg_ptr The address to the structure containing the * configuration information for this instance of the driver. * * @param level The initialization level. See SYS_INIT() for * details. * * @param prio Priority within the selected initialization level. See * SYS_INIT() for details. * * @param api_ptr Provides an initial pointer to the API function struct * used by the driver. Can be NULL. */ #define DEVICE_DEFINE(dev_name, drv_name, init_fn, pm_control_fn, \ data_ptr, cfg_ptr, level, prio, api_ptr) \ Z_DEVICE_DEFINE_PM(dev_name) \ static const Z_DECL_ALIGN(struct device) \ DEVICE_NAME_GET(dev_name) __used \ __attribute__((__section__(".device_" #level STRINGIFY(prio)))) = { \ .name = drv_name, \ .config = (cfg_ptr), \ .api = (api_ptr), \ .data = (data_ptr), \ Z_DEVICE_DEFINE_PM_INIT(dev_name, pm_control_fn) \ }; \ Z_INIT_ENTRY_DEFINE(_CONCAT(__device_, dev_name), init_fn, \ (&_CONCAT(__device_, dev_name)), level, prio) /** * @def DEVICE_GET * * @brief Obtain a pointer to a device object by name * * @details Return the address of a device object created by * DEVICE_INIT(), using the dev_name provided to DEVICE_INIT(). * * @param name The same as dev_name provided to DEVICE_INIT() * * @return A pointer to the device object created by DEVICE_INIT() */ #define DEVICE_GET(name) (&DEVICE_NAME_GET(name)) /** @def DEVICE_DECLARE * * @brief Declare a static device object * * This macro can be used at the top-level to declare a device, such * that DEVICE_GET() may be used before the full declaration in * DEVICE_INIT(). * * This is often useful when configuring interrupts statically in a * device's init or per-instance config function, as the init function * itself is required by DEVICE_INIT() and use of DEVICE_GET() * inside it creates a circular dependency. * * @param name Device name */ #define DEVICE_DECLARE(name) static const struct device DEVICE_NAME_GET(name) typedef void (*device_pm_cb)(const struct device *dev, int status, void *context, void *arg); /** * @brief Device PM info */ struct device_pm { /** Pointer to the device */ const struct device *dev; /** Lock to synchronize the get/put operations */ struct k_sem lock; /** Device pm enable flag */ bool enable; /** Device usage count */ atomic_t usage; /** Device idle internal power state */ atomic_t fsm_state; /** Work object for asynchronous calls */ struct k_work work; /** Event object to listen to the sync request events */ struct k_poll_event event; /** Signal to notify the Async API callers */ struct k_poll_signal signal; }; /** * @brief Runtime device structure (in memory) per driver instance */ struct device { /** Name of the device instance */ const char *name; /** Address of device instance config information */ const void *config; /** Address of the API structure exposed by the device instance */ const void *api; /** Address of the device instance private data */ void * const data; #ifdef CONFIG_DEVICE_POWER_MANAGEMENT /** Power Management function */ int (*device_pm_control)(const struct device *dev, uint32_t command, void *context, device_pm_cb cb, void *arg); /** Pointer to device instance power management data */ struct device_pm * const pm; #endif }; /** * @brief Retrieve the device structure for a driver by name * * @details Device objects are created via the DEVICE_INIT() macro and * placed in memory by the linker. If a driver needs to bind to another driver * it can use this function to retrieve the device structure of the lower level * driver by the name the driver exposes to the system. * * @param name device name to search for. * * @return pointer to device structure; NULL if not found or cannot be used. */ __syscall const struct device *device_get_binding(const char *name); /** @brief Get access to the static array of static devices. * * @param devices where to store the pointer to the array of * statically allocated devices. The array must not be mutated * through this pointer. * * @return the number of statically allocated devices. */ size_t z_device_get_all_static(const struct device * *devices); /** @brief Determine whether a device has been successfully initialized. * * @param dev pointer to the device in question. * * @return true if and only if the device is available for use. */ bool z_device_ready(const struct device *dev); /** * @} */ /** * @brief Device Power Management APIs * @defgroup device_power_management_api Device Power Management APIs * @ingroup power_management_api * @{ */ #ifdef CONFIG_DEVICE_POWER_MANAGEMENT /** @def DEVICE_PM_ACTIVE_STATE * * @brief device is in ACTIVE power state * * @details Normal operation of the device. All device context is retained. */ #define DEVICE_PM_ACTIVE_STATE 1 /** @def DEVICE_PM_LOW_POWER_STATE * * @brief device is in LOW power state * * @details Device context is preserved by the HW and need not be * restored by the driver. */ #define DEVICE_PM_LOW_POWER_STATE 2 /** @def DEVICE_PM_SUSPEND_STATE * * @brief device is in SUSPEND power state * * @details Most device context is lost by the hardware. * Device drivers must save and restore or reinitialize any context * lost by the hardware */ #define DEVICE_PM_SUSPEND_STATE 3 /** @def DEVICE_PM_FORCE_SUSPEND_STATE * * @brief device is in force SUSPEND power state * * @details Driver puts the device in suspended state after * completing the ongoing transactions and will not process any * queued work or will not take any new requests for processing. * Most device context is lost by the hardware. Device drivers must * save and restore or reinitialize any context lost by the hardware. */ #define DEVICE_PM_FORCE_SUSPEND_STATE 4 /** @def DEVICE_PM_OFF_STATE * * @brief device is in OFF power state * * @details - Power has been fully removed from the device. * The device context is lost when this state is entered, so the OS * software will reinitialize the device when powering it back on */ #define DEVICE_PM_OFF_STATE 5 /* Constants defining support device power commands */ #define DEVICE_PM_SET_POWER_STATE 1 #define DEVICE_PM_GET_POWER_STATE 2 #endif /* CONFIG_DEVICE_POWER_MANAGEMENT */ /** * @brief Get name of device PM state * * @param state State id which name should be returned */ const char *device_pm_state_str(uint32_t state); /** * @brief Indicate that the device is in the middle of a transaction * * Called by a device driver to indicate that it is in the middle of a * transaction. * * @param busy_dev Pointer to device structure of the driver instance. */ void device_busy_set(const struct device *busy_dev); /** * @brief Indicate that the device has completed its transaction * * Called by a device driver to indicate the end of a transaction. * * @param busy_dev Pointer to device structure of the driver instance. */ void device_busy_clear(const struct device *busy_dev); #ifdef CONFIG_DEVICE_POWER_MANAGEMENT /* * Device PM functions */ /** * @brief No-op function to initialize unimplemented hook * * This function should be used to initialize device hook * for which a device has no PM operations. * * @param unused_device Unused * @param unused_ctrl_command Unused * @param unused_context Unused * @param cb Unused * @param unused_arg Unused * * @retval -ENOTSUP for all operations. */ int device_pm_control_nop(const struct device *unused_device, uint32_t unused_ctrl_command, void *unused_context, device_pm_cb cb, void *unused_arg); /** * @brief Call the set power state function of a device * * Called by the application or power management service to let the device do * required operations when moving to the required power state * Note that devices may support just some of the device power states * @param dev Pointer to device structure of the driver instance. * @param device_power_state Device power state to be set * @param cb Callback function to notify device power status * @param arg Caller passed argument to callback function * * @retval 0 If successful in queuing the request or changing the state. * @retval Errno Negative errno code if failure. Callback will not be called. */ static inline int device_set_power_state(const struct device *dev, uint32_t device_power_state, device_pm_cb cb, void *arg) { return dev->device_pm_control(dev, DEVICE_PM_SET_POWER_STATE, &device_power_state, cb, arg); } /** * @brief Call the get power state function of a device * * This function lets the caller know the current device * power state at any time. This state will be one of the defined * power states allowed for the devices in that system * * @param dev pointer to device structure of the driver instance. * @param device_power_state Device power state to be filled by the device * * @retval 0 If successful. * @retval Errno Negative errno code if failure. */ static inline int device_get_power_state(const struct device *dev, uint32_t *device_power_state) { return dev->device_pm_control(dev, DEVICE_PM_GET_POWER_STATE, device_power_state, NULL, NULL); } /** * @brief Gets the device structure list array and device count * * Called by the Power Manager application to get the list of * device structures associated with the devices in the system. * The PM app would use this list to create its own sorted list * based on the order it wishes to suspend or resume the devices. * * @param device_list Pointer to receive the device list array * @param device_count Pointer to receive the device count * * @deprecated in 2.4 release, replace with z_device_get_all_static() */ __deprecated static inline void device_list_get(const struct device * *device_list, int *device_count) { *device_count = z_device_get_all_static(device_list); } /** * @brief Check if any device is in the middle of a transaction * * Called by an application to see if any device is in the middle * of a critical transaction that cannot be interrupted. * * @retval 0 if no device is busy * @retval -EBUSY if any device is busy */ int device_any_busy_check(void); /** * @brief Check if a specific device is in the middle of a transaction * * Called by an application to see if a particular device is in the * middle of a critical transaction that cannot be interrupted. * * @param chk_dev Pointer to device structure of the specific device driver * the caller is interested in. * @retval 0 if the device is not busy * @retval -EBUSY if the device is busy */ int device_busy_check(const struct device *chk_dev); #ifdef CONFIG_DEVICE_IDLE_PM /* Device PM FSM states */ enum device_pm_fsm_state { DEVICE_PM_FSM_STATE_ACTIVE = 1, DEVICE_PM_FSM_STATE_SUSPENDED, DEVICE_PM_FSM_STATE_SUSPENDING, DEVICE_PM_FSM_STATE_RESUMING, }; /** * @brief Enable device idle PM * * Called by a device driver to enable device idle power management. * The device might be asynchronously suspended if Idle PM is enabled * when the device is not use. * * @param dev Pointer to device structure of the specific device driver * the caller is interested in. */ void device_pm_enable(const struct device *dev); /** * @brief Disable device idle PM * * Called by a device driver to disable device idle power management. * The device might be asynchronously resumed if Idle PM is disabled * * @param dev Pointer to device structure of the specific device driver * the caller is interested in. */ void device_pm_disable(const struct device *dev); /** * @brief Call device resume asynchronously based on usage count * * Called by a device driver to mark the device as being used. * This API will asynchronously bring the device to resume state * if it not already in active state. * * @param dev Pointer to device structure of the specific device driver * the caller is interested in. * @retval 0 If successfully queued the Async request. If queued, * the caller need to wait on the poll event linked to device * pm signal mechanism to know the completion of resume operation. * @retval Errno Negative errno code if failure. */ int device_pm_get(const struct device *dev); /** * @brief Call device resume synchronously based on usage count * * Called by a device driver to mark the device as being used. It * will bring up or resume the device if it is in suspended state * based on the device usage count. This call is blocked until the * device PM state is changed to resume. * * @param dev Pointer to device structure of the specific device driver * the caller is interested in. * @retval 0 If successful. * @retval Errno Negative errno code if failure. */ int device_pm_get_sync(const struct device *dev); /** * @brief Call device suspend asynchronously based on usage count * * Called by a device driver to mark the device as being released. * This API asynchronously put the device to suspend state if * it not already in suspended state. * * @param dev Pointer to device structure of the specific device driver * the caller is interested in. * @retval 0 If successfully queued the Async request. If queued, * the caller need to wait on the poll event linked to device pm * signal mechanism to know the completion of suspend operation. * @retval Errno Negative errno code if failure. */ int device_pm_put(const struct device *dev); /** * @brief Call device suspend synchronously based on usage count * * Called by a device driver to mark the device as being released. It * will put the device to suspended state if is is in active state * based on the device usage count. This call is blocked until the * device PM state is changed to resume. * * @param dev Pointer to device structure of the specific device driver * the caller is interested in. * @retval 0 If successful. * @retval Errno Negative errno code if failure. */ int device_pm_put_sync(const struct device *dev); #else static inline void device_pm_enable(const struct device *dev) { } static inline void device_pm_disable(const struct device *dev) { } static inline int device_pm_get(const struct device *dev) { return -ENOTSUP; } static inline int device_pm_get_sync(const struct device *dev) { return -ENOTSUP; } static inline int device_pm_put(const struct device *dev) { return -ENOTSUP; } static inline int device_pm_put_sync(const struct device *dev) { return -ENOTSUP; } #endif #else #define device_pm_control_nop(...) NULL #endif /** * @} */ #ifdef CONFIG_DEVICE_POWER_MANAGEMENT #define Z_DEVICE_DEFINE_PM(dev_name) \ static struct device_pm _CONCAT(__pm_, dev_name) __used = { \ .usage = ATOMIC_INIT(0), \ .lock = Z_SEM_INITIALIZER( \ _CONCAT(__pm_, dev_name).lock, 1, 1), \ .signal = K_POLL_SIGNAL_INITIALIZER( \ _CONCAT(__pm_, dev_name).signal), \ .event = K_POLL_EVENT_INITIALIZER( \ K_POLL_TYPE_SIGNAL, \ K_POLL_MODE_NOTIFY_ONLY, \ &_CONCAT(__pm_, dev_name).signal), \ }; #define Z_DEVICE_DEFINE_PM_INIT(dev_name, pm_control_fn) \ .device_pm_control = (pm_control_fn), \ .pm = &_CONCAT(__pm_, dev_name), #else #define Z_DEVICE_DEFINE_PM(dev_name) #define Z_DEVICE_DEFINE_PM_INIT(dev_name, pm_control_fn) #endif #ifdef __cplusplus } #endif #include <syscalls/device.h> #endif /* ZEPHYR_INCLUDE_DEVICE_H_ */ |