1 /*
2  * SPDX-FileCopyrightText: 2015-2019 Cadence Design Systems, Inc.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * SPDX-FileContributor: 2016-2022 Espressif Systems (Shanghai) CO LTD
7  */
8 
9 /*
10  * Copyright (c) 2015-2019 Cadence Design Systems, Inc.
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining
13  * a copy of this software and associated documentation files (the
14  * "Software"), to deal in the Software without restriction, including
15  * without limitation the rights to use, copy, modify, merge, publish,
16  * distribute, sublicense, and/or sell copies of the Software, and to
17  * permit persons to whom the Software is furnished to do so, subject to
18  * the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included
21  * in all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
26  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
27  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
28  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
29  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30  */
31 
32 /* xtensa_overlay_os_hook.c -- Overlay manager OS hooks for FreeRTOS. */
33 
34 #include "FreeRTOS.h"
35 #include "semphr.h"
36 
37 #if configUSE_MUTEX
38 
39 /* Mutex object that controls access to the overlay. Currently only one
40  * overlay region is supported so one mutex suffices.
41  */
42     static SemaphoreHandle_t xt_overlay_mutex;
43 
44 
45 /* This function should be overridden to provide OS specific init such
46  * as the creation of a mutex lock that can be used for overlay locking.
47  * Typically this mutex would be set up with priority inheritance. See
48  * overlay manager documentation for more details.
49  */
xt_overlay_init_os(void)50     void xt_overlay_init_os( void )
51     {
52         /* Create the mutex for overlay access. Priority inheritance is
53          * required.
54          */
55         xt_overlay_mutex = xSemaphoreCreateMutex();
56     }
57 
58 
59 /* This function locks access to shared overlay resources, typically
60  * by acquiring a mutex.
61  */
xt_overlay_lock(void)62     void xt_overlay_lock( void )
63     {
64         xSemaphoreTake( xt_overlay_mutex, 0 );
65     }
66 
67 
68 /* This function releases access to shared overlay resources, typically
69  * by unlocking a mutex.
70  */
xt_overlay_unlock(void)71     void xt_overlay_unlock( void )
72     {
73         xSemaphoreGive( xt_overlay_mutex );
74     }
75 
76 #endif /* if configUSE_MUTEX */
77