Commit 342e7c6e authored by Hans de Goede's avatar Hans de Goede Committed by Greg Kroah-Hartman
Browse files

staging: rtl8723bs: Improve the comment explaining the locking rules 



rtw_mlme.h has a comment which briefly describes the locking rules for
the rtl8723bs driver, improve this to also mention the locking order
of xmit_priv.lock vs the lock(s) embedded in the various queues.

Cc: Fabio Aiuto <fabioaiuto83@gmail.com>
Signed-off-by: default avatarHans de Goede <hdegoede@redhat.com>
Link: https://lore.kernel.org/r/20220302101637.26542-2-hdegoede@redhat.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 8f434708

drivers/staging/rtl8723bs/include/rtw_mlme.h

+6 −2
Original line number Diff line number Diff line
@@ -102,13 +102,17 @@ there are several "locks" in mlme_priv, 
since mlme_priv is a shared resource between many threads,

like ISR/Call-Back functions, the OID handlers, and even timer functions.





Each struct __queue has its own locks, already.

Other items are protected by mlme_priv.lock.

Other items in mlme_priv are protected by mlme_priv.lock, while items in

xmit_priv are protected by xmit_priv.lock.



To avoid possible dead lock, any thread trying to modifiying mlme_priv

SHALL not lock up more than one locks at a time!



The only exception is that queue functions which take the __queue.lock

may be called with the xmit_priv.lock held. In this case the order

MUST always be first lock xmit_priv.lock and then call any queue functions

which take __queue.lock.

*/