AM261x MCU+ SDK: spinlock.h Source File

| AM261x MCU+ SDK 26.00.00 |

spinlock/v0/spinlock.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2021 Texas Instruments Incorporated
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
49 #ifndef SPINLOCK_V0_H_
50 #define SPINLOCK_V0_H_
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56 /* ========================================================================== */
57 /* Include Files */
58 /* ========================================================================== */
59
60 #include <stdint.h>
61 #include <kernel/dpl/SystemP.h>
62 #include <drivers/hw_include/cslr_spinlock.h>
63
64 /* ========================================================================== */
65 /* Macros & Typedefs */
66 /* ========================================================================== */
67
69 #define SPINLOCK_LOCK_STATUS_FREE (0U)
70
71 #define SPINLOCK_LOCK_STATUS_INUSE (1U)
72
73 /* ========================================================================== */
74 /* Structures and Enums */
75 /* ========================================================================== */
76
77 /* None */
78
79 /* ========================================================================== */
80 /* Global Variables Declarations */
81 /* ========================================================================== */
82
83 /* None */
84
85 /* ========================================================================== */
86 /* Function Declarations */
87 /* ========================================================================== */
88
96 uint32_t Spinlock_getNumLocks(uint32_t baseAddr);
97
115 int32_t Spinlock_lock(uint32_t baseAddr, uint32_t lockNumber);
116
129 void Spinlock_unlock(uint32_t baseAddr, uint32_t lockNumber);
130
131 /* ========================================================================== */
132 /* Static Function Definitions */
133 /* ========================================================================== */
134
135 /* None */
136
137 #ifdef __cplusplus
138 }
139 #endif /* #ifndef SPINLOCK_V0_H_ */
140
141 #endif
142
Spinlock_getNumLocks
uint32_t Spinlock_getNumLocks(uint32_t baseAddr)
This API provides returns the number of locks supported.
SystemP.h
Spinlock_lock
int32_t Spinlock_lock(uint32_t baseAddr, uint32_t lockNumber)
This API performs the Read operation for Lock status of the SPINLOCK_LOCK_REG, in order to acquire a ...
Spinlock_unlock
void Spinlock_unlock(uint32_t baseAddr, uint32_t lockNumber)
This API performs the write operation for Lock status of the SPINLOCK_LOCK_REG, in order to Free the ...