hwspinlock_driver_api Struct Reference

Driver Operations Hardware Spinlock driver operations More...

#include <zephyr/drivers/hwspinlock.h>

Data Fields
hwspinlock_api_trylock	trylock
	OPT Try to lock HW spinlock.
hwspinlock_api_lock	lock
	REQ Lock HW spinlock.
hwspinlock_api_unlock	unlock
	REQ Unlock HW spinlock.
hwspinlock_api_get_max_id	get_max_id
	REQ Get HW spinlock max ID.

Detailed Description

Driver Operations Hardware Spinlock driver operations

This is the driver API structure any Hardware Spinlock driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also

DEVICE_DT_INST_DEFINE()

DEVICE_DT_DEFINE()

DEVICE_API()

Field Documentation

get_max_id

hwspinlock_api_get_max_id hwspinlock_driver_api::get_max_id

REQ Get HW spinlock max ID.

lock

hwspinlock_api_lock hwspinlock_driver_api::lock

REQ Lock HW spinlock.

trylock

hwspinlock_api_trylock hwspinlock_driver_api::trylock

OPT Try to lock HW spinlock.

unlock

hwspinlock_api_unlock hwspinlock_driver_api::unlock

REQ Unlock HW spinlock.

---

The documentation for this struct was generated from the following file:

• zephyr/drivers/hwspinlock.h