esp_pm_lock_create() function

Initialize a lock handle for certain power management parameter When lock is created, initially it is not taken. Call esp_pm_lock_acquire to take the lock. This function must not be called from an ISR.

Syntax

Show:

Summary

Declaration

Definition

from esp_pm.h:113

esp_err_t esp_pm_lock_create(esp_pm_lock_type_t lock_type, int arg, const char* name, esp_pm_lock_handle_t* out_handle);

Implemented in pm_locks.c:49

Arguments

Argument

Description

lock_type

Power management constraint which the lock should control

arg

argument, value depends on lock_type, see esp_pm_lock_type_t

name

arbitrary string identifying the lock (e.g. "wifi" or "spi"). Used by the esp_pm_dump_locks function to list existing locks. May be set to NULL. If not set to NULL, must point to a string which is valid for the lifetime of the lock.

out_handle

handle returned from this function. Use this handle when calling esp_pm_lock_delete, esp_pm_lock_acquire, esp_pm_lock_release. Must not be NULL.

Return value

- ESP_OK on success - ESP_ERR_NO_MEM if the lock structure can not be allocated - ESP_ERR_INVALID_ARG if out_handle is NULL - ESP_ERR_NOT_SUPPORTED if CONFIG_PM_ENABLE is not enabled in sdkconfig

Notes

If the lock_type argument is not valid, it will cause an abort.

Examples

esp_pm_lock_create() is referenced by 1 libraries and example projects:

References

from examples

esp_pm_lock_create() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle