xref: /aosp_15_r20/external/flashrom/big_lock.h (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1 /* Copyright 2012, Google Inc.
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *    * Redistributions of source code must retain the above copyright
9  *      notice, this list of conditions and the following disclaimer.
10  *    * Redistributions in binary form must reproduce the above
11  *      copyright notice, this list of conditions and the following
12  *      disclaimer in the documentation and/or other materials provided
13  *      with the distribution.
14  *    * Neither the name of Google Inc. nor the names of its
15  *      contributors may be used to endorse or promote products derived
16  *      from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef BIG_LOCK_H__
32 #define BIG_LOCK_H__
33 
34 /*
35  * acquire_big_lock  -  acquire global lock
36  *
37  * returns 0 to indicate lock acquired
38  * returns >0 to indicate lock was already held
39  * returns <0 to indicate failed to acquire lock
40  */
41 extern int acquire_big_lock(int timeout_secs);
42 
43 /*
44  * release_big_lock  -  release global lock
45  *
46  * returns 0 if lock was released successfully
47  * returns -1 if lock had not been held before the call
48  */
49 extern int release_big_lock(void);
50 
51 #endif /* BIG_LOCK_H__ */
52