summaryrefslogtreecommitdiffstats
blob: 5557f98515612b83fe53d63471896951431623b2 (plain) (blame)
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * Copyright (c) 2017-present, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


/**
 *  \ingroup DRV_OSAL_MODULE
 *  \defgroup DRV_OSAL_EventCombinerP EventCombinerP
 *            EventCombinerP interface
 *
 *  @{
 */ 
  
 
/** ============================================================================
 *  @file       EventCombinerP.h
 *
 *  @brief      Event Combiner routines for the RTOS Porting Interface
 *
 *
 *  ============================================================================
 */

#ifndef ti_osal_EventCombinerP__include
#define ti_osal_EventCombinerP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <ti/osal/HwiP.h>
typedef void (*EventCombinerP_FuncPtr)(uint32_t arg);

/*!
 *  @brief  Function to disable an event inside event combiner
 *
 *  @param  eventId  event ID to be disabled in the event combiner
 *
 */
int32_t EventCombinerP_disableEvent(uint32_t eventId);

/*!
 *  @brief  Function to enable an event inside event combiner
 *
 *  @param  eventId  event ID to be disabled in the event combiner
 *
 */
int32_t EventCombinerP_enableEvent(uint32_t eventId);

/*!
 *  @brief  Function to plug an ISR handler to an event inside event combiner
 *
 *  @param  eventId  The event id (4-127)
 *
 *  @param  eventIsrRoutine  The ISR routine for servicing the event
 *
 *  @param  arg  The argument to the ISR routine
 *
 *  @param  unmask Unmask the event
 */
int32_t EventCombinerP_dispatchPlug(uint32_t eventId, EventCombinerP_FuncPtr eventIsrRoutine,uintptr_t arg,bool unmask );

/*!
 *  @brief  Function to return the Hwi Handle corresponding to an event combiner group number
 *
 *  @param  groupNum  The event combiner group id (0-3)
 *
 */
HwiP_Handle EventCombinerP_getHwi(uint32_t groupNum);


/*!
 *  @brief  Function to return the interrupt vector number corresponding to
 *  a group number (0-3)
 *
 *  @param  groupNum  The event combiner group id (0-3)
 *
 */
int32_t EventCombinerP_getIntNum(int32_t groupNum);

/*!
 *  @brief  Function to register single event combiner group to a vector number
 *
 *  @param  groupNum  The event combiner group id (0-3)
 *
 *  @param  intNum    The interrupt vector id (4-15)
 *
 */
int32_t EventCombinerP_SingleRegisterInt(int32_t groupNum, int32_t intNum);

/*!
 *  @brief  Function to register single event combiner group to a vector number
 *
 *  @param  intNum []   List of interrupt vector ids (4-15) per ECM group(0-3)
 *
 */
int32_t EventCombinerP_GroupRegisterInt(int32_t intNum[]);

#define OSAL_EVTCOMBINE_GROUPREG_SUCCESS (0)
#define OSAL_EVTCOMBINE_ERR_GROUPREG_REGISTER_ERR (-1)
#define OSAL_EVTCOMBINE_ERR_GROUPREG_INVALID_INTNUM (-2)

/* These are the system default interrupt numbers if the Event Combiner has already not been registered
 * If applications register Event Combiners during startup, these values may not be used (in SYSBIOS case)
 * If not, these are the interrupts reserved for Event Combiner group events (0-3).
 * These defaults are stored in Osal_HwAttrs.ECM_intNum[] and can be obtained by the 
 * application at run time through the OSAL API Osal_getHwAttrs(). These values also can be modified 
 * using Osal_setHwAttrs(Osal_HwAttrs,OSAL_HWATTR_SET_ECM_INT)
 */
#define OSAL_ECM_GROUP0_INT 4
#define OSAL_ECM_GROUP1_INT 5
#define OSAL_ECM_GROUP2_INT 6
#define OSAL_ECM_GROUP3_INT 7

#ifdef __cplusplus
}
#endif

#endif /* ti_osalEventCombinerP__include */
/* @} */