€•®      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ&/translations/zh_CN/locking/hwspinlock”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/zh_TW/locking/hwspinlock”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/it_IT/locking/hwspinlock”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/ja_JP/locking/hwspinlock”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/ko_KR/locking/hwspinlock”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ&/translations/sp_SP/locking/hwspinlock”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒHardware Spinlock Framework”h]”hŒHardware Spinlock Framework”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒ@/var/lib/git/docbuild/linux/Documentation/locking/hwspinlock.rst”h Kubh¢)”}”(hhh]”(h§)”}”(hŒIntroduction”h]”hŒIntroduction”…””}”(hhºhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh·hžhhŸh¶h KubhŒ	paragraph”“”)”}”(hŒÀHardware spinlock modules provide hardware assistance for synchronization
and mutual exclusion between heterogeneous processors and those not operating
under a single, shared operating system.”h]”hŒÀHardware spinlock modules provide hardware assistance for synchronization
and mutual exclusion between heterogeneous processors and those not operating
under a single, shared operating system.”…””}”(hhÊhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hŒöFor example, OMAP4 has dual Cortex-A9, dual Cortex-M3 and a C64x+ DSP,
each of which is running a different Operating System (the master, A9,
is usually running Linux and the slave processors, the M3 and the DSP,
are running some flavor of RTOS).”h]”hŒöFor example, OMAP4 has dual Cortex-A9, dual Cortex-M3 and a C64x+ DSP,
each of which is running a different Operating System (the master, A9,
is usually running Linux and the slave processors, the M3 and the DSP,
are running some flavor of RTOS).”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hX  A generic hwspinlock framework allows platform-independent drivers to use
the hwspinlock device in order to access data structures that are shared
between remote processors, that otherwise have no alternative mechanism
to accomplish synchronization and mutual exclusion operations.”h]”hX  A generic hwspinlock framework allows platform-independent drivers to use
the hwspinlock device in order to access data structures that are shared
between remote processors, that otherwise have no alternative mechanism
to accomplish synchronization and mutual exclusion operations.”…””}”(hhæhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hŒÛThis is necessary, for example, for Inter-processor communications:
on OMAP4, cpu-intensive multimedia tasks are offloaded by the host to the
remote M3 and/or C64x+ slave processors (by an IPC subsystem called Syslink).”h]”hŒÛThis is necessary, for example, for Inter-processor communications:
on OMAP4, cpu-intensive multimedia tasks are offloaded by the host to the
remote M3 and/or C64x+ slave processors (by an IPC subsystem called Syslink).”…””}”(hhôhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hŒ¦To achieve fast message-based communications, a minimal kernel support
is needed to deliver messages arriving from a remote processor to the
appropriate user process.”h]”hŒ¦To achieve fast message-based communications, a minimal kernel support
is needed to deliver messages arriving from a remote processor to the
appropriate user process.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hŒïThis communication is based on simple data structures that is shared between
the remote processors, and access to it is synchronized using the hwspinlock
module (remote processor directly places new messages in this shared data
structure).”h]”hŒïThis communication is based on simple data structures that is shared between
the remote processors, and access to it is synchronized using the hwspinlock
module (remote processor directly places new messages in this shared data
structure).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hŒ`A common hwspinlock interface makes it possible to have generic, platform-
independent, drivers.”h]”hŒ`A common hwspinlock interface makes it possible to have generic, platform-
independent, drivers.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K#hh·hžhubeh}”(h]”Œintroduction”ah ]”h"]”Œintroduction”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒUser API”h]”hŒUser API”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj4  hžhhŸh¶h K'ubhŒliteral_block”“”)”}”(hŒAstruct hwspinlock *hwspin_lock_request_specific(unsigned int id);”h]”hŒAstruct hwspinlock *hwspin_lock_request_specific(unsigned int id);”…””}”hjG  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1jE  hŸh¶h K+hj4  hžhubhÉ)”}”(hŒÛAssign a specific hwspinlock id and return its address, or NULL
if that hwspinlock is already in use. Usually board code will
be calling this function in order to reserve specific hwspinlock
ids for predefined purposes.”h]”hŒÛAssign a specific hwspinlock id and return its address, or NULL
if that hwspinlock is already in use. Usually board code will
be calling this function in order to reserve specific hwspinlock
ids for predefined purposes.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K-hj4  hžhubhÉ)”}”(hŒ6Should be called from a process context (might sleep).”h]”hŒ6Should be called from a process context (might sleep).”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K2hj4  hžhubjF  )”}”(hŒ=int of_hwspin_lock_get_id(struct device_node *np, int index);”h]”hŒ=int of_hwspin_lock_get_id(struct device_node *np, int index);”…””}”hjs  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h K6hj4  hžhubhÉ)”}”(hX
  Retrieve the global lock id for an OF phandle-based specific lock.
This function provides a means for DT users of a hwspinlock module
to get the global lock id of a specific hwspinlock, so that it can
be requested using the normal hwspin_lock_request_specific() API.”h]”hX
  Retrieve the global lock id for an OF phandle-based specific lock.
This function provides a means for DT users of a hwspinlock module
to get the global lock id of a specific hwspinlock, so that it can
be requested using the normal hwspin_lock_request_specific() API.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K8hj4  hžhubhÉ)”}”(hŒ”The function returns a lock id number on success, -EPROBE_DEFER if
the hwspinlock device is not yet registered with the core, or other
error values.”h]”hŒ”The function returns a lock id number on success, -EPROBE_DEFER if
the hwspinlock device is not yet registered with the core, or other
error values.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K=hj4  hžhubhÉ)”}”(hŒ6Should be called from a process context (might sleep).”h]”hŒ6Should be called from a process context (might sleep).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KAhj4  hžhubjF  )”}”(hŒ0int hwspin_lock_free(struct hwspinlock *hwlock);”h]”hŒ0int hwspin_lock_free(struct hwspinlock *hwlock);”…””}”hj«  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h KEhj4  hžhubhÉ)”}”(hŒ–Free a previously-assigned hwspinlock; returns 0 on success, or an
appropriate error code on failure (e.g. -EINVAL if the hwspinlock
is already free).”h]”hŒ–Free a previously-assigned hwspinlock; returns 0 on success, or an
appropriate error code on failure (e.g. -EINVAL if the hwspinlock
is already free).”…””}”(hj¹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KGhj4  hžhubhÉ)”}”(hŒ6Should be called from a process context (might sleep).”h]”hŒ6Should be called from a process context (might sleep).”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KKhj4  hžhubjF  )”}”(hŒAint hwspin_lock_bust(struct hwspinlock *hwlock, unsigned int id);”h]”hŒAint hwspin_lock_bust(struct hwspinlock *hwlock, unsigned int id);”…””}”hjÕ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h KOhj4  hžhubhÉ)”}”(hŒéAfter verifying the owner of the hwspinlock, release a previously acquired
hwspinlock; returns 0 on success, or an appropriate error code on failure
(e.g. -EOPNOTSUPP if the bust operation is not defined for the specific
hwspinlock).”h]”hŒéAfter verifying the owner of the hwspinlock, release a previously acquired
hwspinlock; returns 0 on success, or an appropriate error code on failure
(e.g. -EOPNOTSUPP if the bust operation is not defined for the specific
hwspinlock).”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KQhj4  hžhubhÉ)”}”(hŒ6Should be called from a process context (might sleep).”h]”hŒ6Should be called from a process context (might sleep).”…””}”(hjñ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KVhj4  hžhubjF  )”}”(hŒIint hwspin_lock_timeout(struct hwspinlock *hwlock, unsigned int timeout);”h]”hŒIint hwspin_lock_timeout(struct hwspinlock *hwlock, unsigned int timeout);”…””}”hjÿ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h KZhj4  hžhubhÉ)”}”(hX½  Lock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.
Upon a successful return from this function, preemption is disabled so
the caller must not sleep, and is advised to release the hwspinlock as
soon as possible, in order to minimize remote cores polling on the
hardware interconnect.”h]”hX½  Lock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.
Upon a successful return from this function, preemption is disabled so
the caller must not sleep, and is advised to release the hwspinlock as
soon as possible, in order to minimize remote cores polling on the
hardware interconnect.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K\hj4  hžhubhÉ)”}”(hŒ¯Returns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
The function will never sleep.”h]”hŒ¯Returns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
The function will never sleep.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kdhj4  hžhubjF  )”}”(hŒMint hwspin_lock_timeout_irq(struct hwspinlock *hwlock, unsigned int timeout);”h]”hŒMint hwspin_lock_timeout_irq(struct hwspinlock *hwlock, unsigned int timeout);”…””}”hj)  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Kjhj4  hžhubhÉ)”}”(hX  Lock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.
Upon a successful return from this function, preemption and the local
interrupts are disabled, so the caller must not sleep, and is advised to
release the hwspinlock as soon as possible.”h]”hX  Lock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.
Upon a successful return from this function, preemption and the local
interrupts are disabled, so the caller must not sleep, and is advised to
release the hwspinlock as soon as possible.”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Klhj4  hžhubhÉ)”}”(hŒ¯Returns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
The function will never sleep.”h]”hŒ¯Returns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
The function will never sleep.”…””}”(hjE  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kshj4  hžhubjF  )”}”(hŒ‚int hwspin_lock_timeout_irqsave(struct hwspinlock *hwlock, unsigned int to,
                                unsigned long *flags);”h]”hŒ‚int hwspin_lock_timeout_irqsave(struct hwspinlock *hwlock, unsigned int to,
                                unsigned long *flags);”…””}”hjS  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Kyhj4  hžhubhÉ)”}”(hXÓ  Lock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.
Upon a successful return from this function, preemption is disabled,
local interrupts are disabled and their previous state is saved at the
given flags placeholder. The caller must not sleep, and is advised to
release the hwspinlock as soon as possible.”h]”hXÓ  Lock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.
Upon a successful return from this function, preemption is disabled,
local interrupts are disabled and their previous state is saved at the
given flags placeholder. The caller must not sleep, and is advised to
release the hwspinlock as soon as possible.”…””}”(hja  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K|hj4  hžhubhÉ)”}”(hŒReturns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).”h]”hŒReturns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).”…””}”(hjo  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K„hj4  hžhubhÉ)”}”(hŒThe function will never sleep.”h]”hŒThe function will never sleep.”…””}”(hj}  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K‡hj4  hžhubjF  )”}”(hŒMint hwspin_lock_timeout_raw(struct hwspinlock *hwlock, unsigned int timeout);”h]”hŒMint hwspin_lock_timeout_raw(struct hwspinlock *hwlock, unsigned int timeout);”…””}”hj‹  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h K‹hj4  hžhubhÉ)”}”(hŒÕLock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.”h]”hŒÕLock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khj4  hžhubhÉ)”}”(hŒÉCaution: User must protect the routine of getting hardware lock with mutex
or spinlock to avoid dead-lock, that will let user can do some time-consuming
or sleepable operations under the hardware lock.”h]”hŒÉCaution: User must protect the routine of getting hardware lock with mutex
or spinlock to avoid dead-lock, that will let user can do some time-consuming
or sleepable operations under the hardware lock.”…””}”(hj§  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K‘hj4  hžhubhÉ)”}”(hŒReturns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).”h]”hŒReturns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).”…””}”(hjµ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K•hj4  hžhubhÉ)”}”(hŒThe function will never sleep.”h]”hŒThe function will never sleep.”…””}”(hjÃ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K˜hj4  hžhubjF  )”}”(hŒNint hwspin_lock_timeout_in_atomic(struct hwspinlock *hwlock, unsigned int to);”h]”hŒNint hwspin_lock_timeout_in_atomic(struct hwspinlock *hwlock, unsigned int to);”…””}”hjÑ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Kœhj4  hžhubhÉ)”}”(hŒÕLock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.”h]”hŒÕLock a previously-assigned hwspinlock with a timeout limit (specified in
msecs). If the hwspinlock is already taken, the function will busy loop
waiting for it to be released, but give up when the timeout elapses.”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kžhj4  hžhubhÉ)”}”(hŒmThis function shall be called only from an atomic context and the timeout
value shall not exceed a few msecs.”h]”hŒmThis function shall be called only from an atomic context and the timeout
value shall not exceed a few msecs.”…””}”(hjí  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K¢hj4  hžhubhÉ)”}”(hŒReturns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).”h]”hŒReturns 0 when successful and an appropriate error code otherwise (most
notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).”…””}”(hjû  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K¥hj4  hžhubhÉ)”}”(hŒThe function will never sleep.”h]”hŒThe function will never sleep.”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K¨hj4  hžhubjF  )”}”(hŒ.int hwspin_trylock(struct hwspinlock *hwlock);”h]”hŒ.int hwspin_trylock(struct hwspinlock *hwlock);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h K¬hj4  hžhubhÉ)”}”(hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”h]”hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”…””}”(hj%  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K¯hj4  hžhubhÉ)”}”(hŒãUpon a successful return from this function, preemption is disabled so
caller must not sleep, and is advised to release the hwspinlock as soon as
possible, in order to minimize remote cores polling on the hardware
interconnect.”h]”hŒãUpon a successful return from this function, preemption is disabled so
caller must not sleep, and is advised to release the hwspinlock as soon as
possible, in order to minimize remote cores polling on the hardware
interconnect.”…””}”(hj3  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K²hj4  hžhubhÉ)”}”(hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”h]”hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”…””}”(hjA  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K·hj4  hžhubjF  )”}”(hŒ2int hwspin_trylock_irq(struct hwspinlock *hwlock);”h]”hŒ2int hwspin_trylock_irq(struct hwspinlock *hwlock);”…””}”hjO  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h K½hj4  hžhubhÉ)”}”(hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”h]”hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”…””}”(hj]  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KÀhj4  hžhubhÉ)”}”(hŒµUpon a successful return from this function, preemption and the local
interrupts are disabled so caller must not sleep, and is advised to
release the hwspinlock as soon as possible.”h]”hŒµUpon a successful return from this function, preemption and the local
interrupts are disabled so caller must not sleep, and is advised to
release the hwspinlock as soon as possible.”…””}”(hjk  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KÃhj4  hžhubhÉ)”}”(hŒwReturns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).”h]”hŒwReturns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).”…””}”(hjy  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KÇhj4  hžhubhÉ)”}”(hŒThe function will never sleep.”h]”hŒThe function will never sleep.”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KÊhj4  hžhubjF  )”}”(hŒLint hwspin_trylock_irqsave(struct hwspinlock *hwlock, unsigned long *flags);”h]”hŒLint hwspin_trylock_irqsave(struct hwspinlock *hwlock, unsigned long *flags);”…””}”hj•  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h KÎhj4  hžhubhÉ)”}”(hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”h]”hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”…””}”(hj£  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KÐhj4  hžhubhÉ)”}”(hX  Upon a successful return from this function, preemption is disabled,
the local interrupts are disabled and their previous state is saved
at the given flags placeholder. The caller must not sleep, and is advised
to release the hwspinlock as soon as possible.”h]”hX  Upon a successful return from this function, preemption is disabled,
the local interrupts are disabled and their previous state is saved
at the given flags placeholder. The caller must not sleep, and is advised
to release the hwspinlock as soon as possible.”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KÓhj4  hžhubhÉ)”}”(hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”h]”hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KØhj4  hžhubjF  )”}”(hŒ2int hwspin_trylock_raw(struct hwspinlock *hwlock);”h]”hŒ2int hwspin_trylock_raw(struct hwspinlock *hwlock);”…””}”hjÍ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h KÞhj4  hžhubhÉ)”}”(hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”h]”hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”…””}”(hjÛ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kàhj4  hžhubhÉ)”}”(hŒÉCaution: User must protect the routine of getting hardware lock with mutex
or spinlock to avoid dead-lock, that will let user can do some time-consuming
or sleepable operations under the hardware lock.”h]”hŒÉCaution: User must protect the routine of getting hardware lock with mutex
or spinlock to avoid dead-lock, that will let user can do some time-consuming
or sleepable operations under the hardware lock.”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kãhj4  hžhubhÉ)”}”(hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”h]”hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kçhj4  hžhubjF  )”}”(hŒ8int hwspin_trylock_in_atomic(struct hwspinlock *hwlock);”h]”hŒ8int hwspin_trylock_in_atomic(struct hwspinlock *hwlock);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Kíhj4  hžhubhÉ)”}”(hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”h]”hŒ^Attempt to lock a previously-assigned hwspinlock, but immediately fail if
it is already taken.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kïhj4  hžhubhÉ)”}”(hŒ:This function shall be called only from an atomic context.”h]”hŒ:This function shall be called only from an atomic context.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kòhj4  hžhubhÉ)”}”(hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”h]”hŒ–Returns 0 on success and an appropriate error code otherwise (most
notably -EBUSY if the hwspinlock was already taken).
The function will never sleep.”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kôhj4  hžhubjF  )”}”(hŒ.void hwspin_unlock(struct hwspinlock *hwlock);”h]”hŒ.void hwspin_unlock(struct hwspinlock *hwlock);”…””}”hj=  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Kúhj4  hžhubhÉ)”}”(hŒvUnlock a previously-locked hwspinlock. Always succeed, and can be called
from any context (the function never sleeps).”h]”hŒvUnlock a previously-locked hwspinlock. Always succeed, and can be called
from any context (the function never sleeps).”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kühj4  hžhubhŒnote”“”)”}”(hŒkcode should **never** unlock an hwspinlock which is already unlocked
(there is no protection against this).”h]”hÉ)”}”(hŒkcode should **never** unlock an hwspinlock which is already unlocked
(there is no protection against this).”h]”(hŒcode should ”…””}”(hj_  hžhhŸNh NubhŒstrong”“”)”}”(hŒ	**never**”h]”hŒnever”…””}”(hji  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hj_  ubhŒV unlock an hwspinlock which is already unlocked
(there is no protection against this).”…””}”(hj_  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mhj[  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jY  hj4  hžhhŸh¶h NubjF  )”}”(hŒ2void hwspin_unlock_irq(struct hwspinlock *hwlock);”h]”hŒ2void hwspin_unlock_irq(struct hwspinlock *hwlock);”…””}”hj‡  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Mhj4  hžhubhÉ)”}”(hŒŽUnlock a previously-locked hwspinlock and enable local interrupts.
The caller should **never** unlock an hwspinlock which is already unlocked.”h]”(hŒUUnlock a previously-locked hwspinlock and enable local interrupts.
The caller should ”…””}”(hj•  hžhhŸNh Nubjh  )”}”(hŒ	**never**”h]”hŒnever”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hj•  ubhŒ0 unlock an hwspinlock which is already unlocked.”…””}”(hj•  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mhj4  hžhubhÉ)”}”(hŒ½Doing so is considered a bug (there is no protection against this).
Upon a successful return from this function, preemption and local
interrupts are enabled. This function will never sleep.”h]”hŒ½Doing so is considered a bug (there is no protection against this).
Upon a successful return from this function, preemption and local
interrupts are enabled. This function will never sleep.”…””}”(hjµ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mhj4  hžhubjF  )”}”(hŒOvoid
hwspin_unlock_irqrestore(struct hwspinlock *hwlock, unsigned long *flags);”h]”hŒOvoid
hwspin_unlock_irqrestore(struct hwspinlock *hwlock, unsigned long *flags);”…””}”hjÃ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Mhj4  hžhubhÉ)”}”(hŒ&Unlock a previously-locked hwspinlock.”h]”hŒ&Unlock a previously-locked hwspinlock.”…””}”(hjÑ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mhj4  hžhubhÉ)”}”(hXN  The caller should **never** unlock an hwspinlock which is already unlocked.
Doing so is considered a bug (there is no protection against this).
Upon a successful return from this function, preemption is reenabled,
and the state of the local interrupts is restored to the state saved at
the given flags. This function will never sleep.”h]”(hŒThe caller should ”…””}”(hjß  hžhhŸNh Nubjh  )”}”(hŒ	**never**”h]”hŒnever”…””}”(hjç  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hjß  ubhX3   unlock an hwspinlock which is already unlocked.
Doing so is considered a bug (there is no protection against this).
Upon a successful return from this function, preemption is reenabled,
and the state of the local interrupts is restored to the state saved at
the given flags. This function will never sleep.”…””}”(hjß  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mhj4  hžhubjF  )”}”(hŒ2void hwspin_unlock_raw(struct hwspinlock *hwlock);”h]”hŒ2void hwspin_unlock_raw(struct hwspinlock *hwlock);”…””}”hjÿ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Mhj4  hžhubhÉ)”}”(hŒ&Unlock a previously-locked hwspinlock.”h]”hŒ&Unlock a previously-locked hwspinlock.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M hj4  hžhubhÉ)”}”(hŒ¯The caller should **never** unlock an hwspinlock which is already unlocked.
Doing so is considered a bug (there is no protection against this).
This function will never sleep.”h]”(hŒThe caller should ”…””}”(hj  hžhhŸNh Nubjh  )”}”(hŒ	**never**”h]”hŒnever”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hj  ubhŒ” unlock an hwspinlock which is already unlocked.
Doing so is considered a bug (there is no protection against this).
This function will never sleep.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M"hj4  hžhubjF  )”}”(hŒ8void hwspin_unlock_in_atomic(struct hwspinlock *hwlock);”h]”hŒ8void hwspin_unlock_in_atomic(struct hwspinlock *hwlock);”…””}”hj;  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h M(hj4  hžhubhÉ)”}”(hŒ&Unlock a previously-locked hwspinlock.”h]”hŒ&Unlock a previously-locked hwspinlock.”…””}”(hjI  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M*hj4  hžhubhÉ)”}”(hŒ¯The caller should **never** unlock an hwspinlock which is already unlocked.
Doing so is considered a bug (there is no protection against this).
This function will never sleep.”h]”(hŒThe caller should ”…””}”(hjW  hžhhŸNh Nubjh  )”}”(hŒ	**never**”h]”hŒnever”…””}”(hj_  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hjW  ubhŒ” unlock an hwspinlock which is already unlocked.
Doing so is considered a bug (there is no protection against this).
This function will never sleep.”…””}”(hjW  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M,hj4  hžhubeh}”(h]”Œuser-api”ah ]”h"]”Œuser api”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K'ubh¢)”}”(hhh]”(h§)”}”(hŒTypical usage”h]”hŒTypical usage”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h M1ubjF  )”}”(hXR  #include <linux/hwspinlock.h>
#include <linux/err.h>

int hwspinlock_example(void)
{
        struct hwspinlock *hwlock;
        int ret;

        /*
        * assign a specific hwspinlock id - this should be called early
        * by board init code.
        */
        hwlock = hwspin_lock_request_specific(PREDEFINED_LOCK_ID);
        if (!hwlock)
                ...

        /* try to take it, but don't spin on it */
        ret = hwspin_trylock(hwlock);
        if (!ret) {
                pr_info("lock is already taken\n");
                return -EBUSY;
        }

        /*
        * we took the lock, do our thing now, but do NOT sleep
        */

        /* release the lock */
        hwspin_unlock(hwlock);

        /* free the lock */
        ret = hwspin_lock_free(hwlock);
        if (ret)
                ...

        return ret;
}”h]”hXR  #include <linux/hwspinlock.h>
#include <linux/err.h>

int hwspinlock_example(void)
{
        struct hwspinlock *hwlock;
        int ret;

        /*
        * assign a specific hwspinlock id - this should be called early
        * by board init code.
        */
        hwlock = hwspin_lock_request_specific(PREDEFINED_LOCK_ID);
        if (!hwlock)
                ...

        /* try to take it, but don't spin on it */
        ret = hwspin_trylock(hwlock);
        if (!ret) {
                pr_info("lock is already taken\n");
                return -EBUSY;
        }

        /*
        * we took the lock, do our thing now, but do NOT sleep
        */

        /* release the lock */
        hwspin_unlock(hwlock);

        /* free the lock */
        ret = hwspin_lock_free(hwlock);
        if (ret)
                ...

        return ret;
}”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h M5hj  hžhubeh}”(h]”Œtypical-usage”ah ]”h"]”Œtypical usage”ah$]”h&]”uh1h¡hh£hžhhŸh¶h M1ubh¢)”}”(hhh]”(h§)”}”(hŒAPI for implementors”h]”hŒAPI for implementors”…””}”(hj©  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj¦  hžhhŸh¶h M]ubjF  )”}”(hŒ™int hwspin_lock_register(struct hwspinlock_device *bank, struct device *dev,
              const struct hwspinlock_ops *ops, int base_id, int num_locks);”h]”hŒ™int hwspin_lock_register(struct hwspinlock_device *bank, struct device *dev,
              const struct hwspinlock_ops *ops, int base_id, int num_locks);”…””}”hj·  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Mahj¦  hžhubhÉ)”}”(hŒáTo be called from the underlying platform-specific implementation, in
order to register a new hwspinlock device (which is usually a bank of
numerous locks). Should be called from a process context (this function
might sleep).”h]”hŒáTo be called from the underlying platform-specific implementation, in
order to register a new hwspinlock device (which is usually a bank of
numerous locks). Should be called from a process context (this function
might sleep).”…””}”(hjÅ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mdhj¦  hžhubhÉ)”}”(hŒ;Returns 0 on success, or appropriate error code on failure.”h]”hŒ;Returns 0 on success, or appropriate error code on failure.”…””}”(hjÓ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mihj¦  hžhubjF  )”}”(hŒ;int hwspin_lock_unregister(struct hwspinlock_device *bank);”h]”hŒ;int hwspin_lock_unregister(struct hwspinlock_device *bank);”…””}”hjá  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Mmhj¦  hžhubhÉ)”}”(hŒ™To be called from the underlying vendor-specific implementation, in order
to unregister an hwspinlock device (which is usually a bank of numerous
locks).”h]”hŒ™To be called from the underlying vendor-specific implementation, in order
to unregister an hwspinlock device (which is usually a bank of numerous
locks).”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mohj¦  hžhubhÉ)”}”(hŒDShould be called from a process context (this function might sleep).”h]”hŒDShould be called from a process context (this function might sleep).”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Mshj¦  hžhubhÉ)”}”(hŒhReturns the address of hwspinlock on success, or NULL on error (e.g.
if the hwspinlock is still in use).”h]”hŒhReturns the address of hwspinlock on success, or NULL on error (e.g.
if the hwspinlock is still in use).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Muhj¦  hžhubeh}”(h]”Œapi-for-implementors”ah ]”h"]”Œapi for implementors”ah$]”h&]”uh1h¡hh£hžhhŸh¶h M]ubh¢)”}”(hhh]”(h§)”}”(hŒImportant structs”h]”hŒImportant structs”…””}”(hj$  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj!  hžhhŸh¶h MyubhÉ)”}”(hŒ¸struct hwspinlock_device is a device which usually contains a bank
of hardware locks. It is registered by the underlying hwspinlock
implementation using the hwspin_lock_register() API.”h]”hŒ¸struct hwspinlock_device is a device which usually contains a bank
of hardware locks. It is registered by the underlying hwspinlock
implementation using the hwspin_lock_register() API.”…””}”(hj2  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M{hj!  hžhubjF  )”}”(hX  /**
* struct hwspinlock_device - a device which usually spans numerous hwspinlocks
* @dev: underlying device, will be used to invoke runtime PM api
* @ops: platform-specific hwspinlock handlers
* @base_id: id index of the first lock in this device
* @num_locks: number of locks in this device
* @lock: dynamically allocated array of 'struct hwspinlock'
*/
struct hwspinlock_device {
        struct device *dev;
        const struct hwspinlock_ops *ops;
        int base_id;
        int num_locks;
        struct hwspinlock lock[0];
};”h]”hX  /**
* struct hwspinlock_device - a device which usually spans numerous hwspinlocks
* @dev: underlying device, will be used to invoke runtime PM api
* @ops: platform-specific hwspinlock handlers
* @base_id: id index of the first lock in this device
* @num_locks: number of locks in this device
* @lock: dynamically allocated array of 'struct hwspinlock'
*/
struct hwspinlock_device {
        struct device *dev;
        const struct hwspinlock_ops *ops;
        int base_id;
        int num_locks;
        struct hwspinlock lock[0];
};”…””}”hj@  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h Mhj!  hžhubhÉ)”}”(hŒsstruct hwspinlock_device contains an array of hwspinlock structs, each
of which represents a single hardware lock::”h]”hŒrstruct hwspinlock_device contains an array of hwspinlock structs, each
of which represents a single hardware lock:”…””}”(hjN  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M‘hj!  hžhubjF  )”}”(hX{  /**
* struct hwspinlock - this struct represents a single hwspinlock instance
* @bank: the hwspinlock_device structure which owns this lock
* @lock: initialized and used by hwspinlock core
* @priv: private data, owned by the underlying platform-specific hwspinlock drv
*/
struct hwspinlock {
        struct hwspinlock_device *bank;
        spinlock_t lock;
        void *priv;
};”h]”hX{  /**
* struct hwspinlock - this struct represents a single hwspinlock instance
* @bank: the hwspinlock_device structure which owns this lock
* @lock: initialized and used by hwspinlock core
* @priv: private data, owned by the underlying platform-specific hwspinlock drv
*/
struct hwspinlock {
        struct hwspinlock_device *bank;
        spinlock_t lock;
        void *priv;
};”…””}”hj\  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h M”hj!  hžhubhÉ)”}”(hŒ·When registering a bank of locks, the hwspinlock driver only needs to
set the priv members of the locks. The rest of the members are set and
initialized by the hwspinlock core itself.”h]”hŒ·When registering a bank of locks, the hwspinlock driver only needs to
set the priv members of the locks. The rest of the members are set and
initialized by the hwspinlock core itself.”…””}”(hjj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M hj!  hžhubeh}”(h]”Œimportant-structs”ah ]”h"]”Œimportant structs”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Myubh¢)”}”(hhh]”(h§)”}”(hŒImplementation callbacks”h]”hŒImplementation callbacks”…””}”(hjƒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj€  hžhhŸh¶h M¥ubhÉ)”}”(hŒGThere are three possible callbacks defined in 'struct hwspinlock_ops'::”h]”hŒJThere are three possible callbacks defined in â€˜struct hwspinlock_opsâ€™:”…””}”(hj‘  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M§hj€  hžhubjF  )”}”(hŒ¬struct hwspinlock_ops {
        int (*trylock)(struct hwspinlock *lock);
        void (*unlock)(struct hwspinlock *lock);
        void (*relax)(struct hwspinlock *lock);
};”h]”hŒ¬struct hwspinlock_ops {
        int (*trylock)(struct hwspinlock *lock);
        void (*unlock)(struct hwspinlock *lock);
        void (*relax)(struct hwspinlock *lock);
};”…””}”hjŸ  sbah}”(h]”h ]”h"]”h$]”h&]”jU  jV  uh1jE  hŸh¶h M©hj€  hžhubhÉ)”}”(hŒ&The first two callbacks are mandatory:”h]”hŒ&The first two callbacks are mandatory:”…””}”(hj­  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M¯hj€  hžhubhÉ)”}”(hŒ’The ->trylock() callback should make a single attempt to take the lock, and
return 0 on failure and 1 on success. This callback may **not** sleep.”h]”(hŒ„The ->trylock() callback should make a single attempt to take the lock, and
return 0 on failure and 1 on success. This callback may ”…””}”(hj»  hžhhŸNh Nubjh  )”}”(hŒ**not**”h]”hŒnot”…””}”(hjÃ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hj»  ubhŒ sleep.”…””}”(hj»  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M±hj€  hžhubhÉ)”}”(hŒ]The ->unlock() callback releases the lock. It always succeed, and it, too,
may **not** sleep.”h]”(hŒOThe ->unlock() callback releases the lock. It always succeed, and it, too,
may ”…””}”(hjÛ  hžhhŸNh Nubjh  )”}”(hŒ**not**”h]”hŒnot”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hjÛ  ubhŒ sleep.”…””}”(hjÛ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M´hj€  hžhubhÉ)”}”(hŒèThe ->relax() callback is optional. It is called by hwspinlock core while
spinning on a lock, and can be used by the underlying implementation to force
a delay between two successive invocations of ->trylock(). It may **not** sleep.”h]”(hŒÚThe ->relax() callback is optional. It is called by hwspinlock core while
spinning on a lock, and can be used by the underlying implementation to force
a delay between two successive invocations of ->trylock(). It may ”…””}”(hjû  hžhhŸNh Nubjh  )”}”(hŒ**not**”h]”hŒnot”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jg  hjû  ubhŒ sleep.”…””}”(hjû  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h M·hj€  hžhubeh}”(h]”Œimplementation-callbacks”ah ]”h"]”Œimplementation callbacks”ah$]”h&]”uh1h¡hh£hžhhŸh¶h M¥ubeh}”(h]”Œhardware-spinlock-framework”ah ]”h"]”Œhardware spinlock framework”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jN  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j(  j%  j1  j.  j|  jy  j£  j   j  j  j}  jz  j   j  uŒ	nametypes”}”(j(  ‰j1  ‰j|  ‰j£  ‰j  ‰j}  ‰j   ‰uh}”(j%  h£j.  h·jy  j4  j   j  j  j¦  jz  j!  j  j€  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.