summaryrefslogtreecommitdiff
path: root/ports/xtensa/xcc/src/xtensa_overlay_os_hook.c
blob: 4a63479c2123ce105c03584c983c24e885823984 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**************************************************************************/
/*   Copyright (c) Cadence Design Systems, Inc.                           */
/*                                                                        */
/* Permission is hereby granted, free of charge, to any person obtaining  */
/* a copy of this software and associated documentation files (the        */
/* "Software"), to deal in the Software without restriction, including    */
/* without limitation the rights to use, copy, modify, merge, publish,    */
/* distribute, sublicense, and/or sell copies of the Software, and to     */
/* permit persons to whom the Software is furnished to do so, subject to  */
/* the following conditions:                                              */
/*                                                                        */
/* The above copyright notice and this permission notice shall be         */
/* included in all copies or substantial portions of the Software.        */
/*                                                                        */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
/**************************************************************************/

/**************************************************************************/
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*  Xtensa overlay manager OS hooks for ThreadX. XEA2 only.               */
/*                                                                        */
/**************************************************************************/


#ifdef XT_USE_OVLY

#include <xtensa/overlay.h>
#include "tx_api.h"


/* Required to work around a bug in the overlay header. */
#ifdef XT_DISABLE_OVERLAYS
#undef  xt_overlay_fatal_error
#define xt_overlay_fatal_error(id)
#endif


/* Mutex object that controls access to the overlay. Currently only one
 * overlay region is supported so one mutex suffices.
 */
static TX_MUTEX xt_overlay_mutex;


/**************************************************************************/
/*  This function should be overridden to provide OS specific init such   */
/*  as the creation of a mutex lock that can be used for overlay locking. */
/*  Typically this mutex would be set up with priority inheritance. See   */
/* overlay manager documentation for more details.                        */
/**************************************************************************/
void
xt_overlay_init_os(void)
{
    /* Create the mutex for overlay access. Priority inheritance is
     * required.
     */
    UINT status =
        tx_mutex_create (&xt_overlay_mutex, "xt_overlay_lock", TX_INHERIT);

    if (status != TX_SUCCESS) {
        xt_overlay_fatal_error (-1);
    }
}


/**************************************************************************/
/* This function locks access to shared overlay resources, typically      */
/* by acquiring a mutex.                                                  */
/**************************************************************************/
void
xt_overlay_lock(void)
{
    UINT status = tx_mutex_get (&xt_overlay_mutex, TX_WAIT_FOREVER);

    if (status != TX_SUCCESS) {
        xt_overlay_fatal_error (-1);
    }
}


/**************************************************************************/
/* This function releases access to shared overlay resources, typically   */
/* by unlocking a mutex.                                                  */
/**************************************************************************/
void
xt_overlay_unlock(void)
{
    UINT status = tx_mutex_put (&xt_overlay_mutex);

    if (status != TX_SUCCESS) {
        xt_overlay_fatal_error (-1);
    }
}

#endif /* XT_USE_OVLY */