1 /*
2  *  Copyright (C) 2016 Texas Instruments Incorporated - http://www.ti.com/
3  *
4  *  Redistribution and use in source and binary forms, with or without
5  *  modification, are permitted provided that the following conditions
6  *  are met:
7  *
8  *    Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  *    Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the
14  *    distribution.
15  *
16  *    Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 //*****************************************************************************
34 //
35 //  hwspinlock.h
36 //
37 //  Prototypes for the Apps-NWP spinlock.
38 //
39 //*****************************************************************************
40 
41 #ifndef __HWSPINLOCK_H__
42 #define __HWSPINLOCK_H__
43 
44 //*****************************************************************************
45 //
46 // If building with a C++ compiler, make all of the definitions in this header
47 // have a C binding.
48 //
49 //*****************************************************************************
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif
54 
55 //*****************************************************************************
56 // values that can be passed to API as ui32LockID parameter
57 //*****************************************************************************
58 #define HWSPINLOCK_SSPI        0x02000000
59 
60 //*****************************************************************************
61 // Values that are returned from HwSpinLockTest()
62 //*****************************************************************************
63 #define HWSPINLOCK_OWNER_APPS  0x00000001
64 #define HWSPINLOCK_OWNER_NWP   0x00000002
65 #define HWSPINLOCK_OWNER_NONE  0x00000000
66 
67 //*****************************************************************************
68 //
69 // API Function prototypes
70 //
71 //*****************************************************************************
72 extern void HwSpinLockAcquire(uint32_t ui32LockID);
73 extern int32_t HwSpinLockTryAcquire(uint32_t ui32LockID, uint32_t ui32Retry);
74 extern void HwSpinLockRelease(uint32_t ui32LockID);
75 extern uint32_t HwSpinLockTest(uint32_t ui32LockID, bool bCurrentStatus);
76 
77 //*****************************************************************************
78 //
79 // Mark the end of the C bindings section for C++ compilers.
80 //
81 //*****************************************************************************
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif // __HWSPINLOCK_H__
87