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