Shad Ansari | 2f7f9be | 2017-06-07 13:34:53 -0700 | [diff] [blame^] | 1 | /* |
| 2 | <:copyright-BRCM:2016:DUAL/GPL:standard |
| 3 | |
| 4 | Broadcom Proprietary and Confidential.(c) 2016 Broadcom |
| 5 | All Rights Reserved |
| 6 | |
| 7 | Unless you and Broadcom execute a separate written software license |
| 8 | agreement governing use of this software, this software is licensed |
| 9 | to you under the terms of the GNU General Public License version 2 |
| 10 | (the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php, |
| 11 | with the following added to such license: |
| 12 | |
| 13 | As a special exception, the copyright holders of this software give |
| 14 | you permission to link this software with independent modules, and |
| 15 | to copy and distribute the resulting executable under terms of your |
| 16 | choice, provided that you also meet, for each linked independent |
| 17 | module, the terms and conditions of the license of that module. |
| 18 | An independent module is a module which is not derived from this |
| 19 | software. The special exception does not apply to any modifications |
| 20 | of the software. |
| 21 | |
| 22 | Not withstanding the above, under no circumstances may you combine |
| 23 | this software in any way with any other Broadcom software provided |
| 24 | under a license other than the GPL, without Broadcom's express prior |
| 25 | written consent. |
| 26 | |
| 27 | :> |
| 28 | */ |
| 29 | |
| 30 | /** A write-biased readers-writer lock |
| 31 | * NOTE: DO NOT attempt to obtain a write lock on a thread that is already holding a read lock or vice versa - this |
| 32 | * will result in a deadlock. Multiple read locks from the same thread are safe, multiple write locks are NOT. |
| 33 | */ |
| 34 | #ifndef BCMOS_RW_LOCK_H_ |
| 35 | #define BCMOS_RW_LOCK_H_ |
| 36 | #include "bcmos_system.h" |
| 37 | |
| 38 | typedef struct bcmos_rw_lock bcmos_rw_lock; |
| 39 | |
| 40 | /** Initialize a lock |
| 41 | * \param[out] lock the newly created lock |
| 42 | * \return error code |
| 43 | */ |
| 44 | bcmos_errno bcmos_rw_lock_create(bcmos_rw_lock **lock); |
| 45 | |
| 46 | /** Obtain a write lock |
| 47 | * \param[in] lock the lock to operate on |
| 48 | */ |
| 49 | void bcmos_rw_write_lock(bcmos_rw_lock* lock); |
| 50 | |
| 51 | /** Release a write lock |
| 52 | * \param[in] lock the lock to operate on |
| 53 | */ |
| 54 | void bcmos_rw_write_release(bcmos_rw_lock* lock); |
| 55 | |
| 56 | /** Obtain a read lock |
| 57 | * \param[in] lock the lock to operate on |
| 58 | */ |
| 59 | void bcmos_rw_read_lock(bcmos_rw_lock* lock); |
| 60 | |
| 61 | /** Release a read lock |
| 62 | * \param[in] lock the lock to operate on |
| 63 | */ |
| 64 | void bcmos_rw_read_release(bcmos_rw_lock* lock); |
| 65 | |
| 66 | #endif |