1/*
2 * EvHandler.h
3 *
4 * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 *  * Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 *  * Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in
15 *    the documentation and/or other materials provided with the
16 *    distribution.
17 *  * Neither the name Texas Instruments nor the names of its
18 *    contributors may be used to endorse or promote products derived
19 *    from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34#ifndef _EVHANDLER_H_
35#define _EVHANDLER_H_
36
37
38#include "TI_IPC_Api.h"
39
40
41typedef struct
42{
43    IPC_EV_DATA Array[MAX_SEND_EVENTS];
44    TI_UINT32       TailIndex; /* Points to the next free node*/
45    TI_UINT32       HeadIndex; /* Points to the first occupied node*/
46    TI_UINT32       Counter;
47}EV_CYCL_ARRAY, *PEV_CYCL_ARRAY;
48
49typedef struct
50{
51    TI_HANDLE		   hOs;
52    IPC_EVENT_PARAMS   RegistrationArray[IPC_EVENT_MAX][MAX_REGISTERED_MODULES];
53    EV_CYCL_ARRAY      SendEventArray;
54    TI_UINT32          LastUMEventType;
55
56}TEvHandlerObj;
57
58/* Upper Interface*/
59TI_HANDLE EvHandler_Create         (TI_HANDLE hOs);
60
61TI_UINT32 EvHandlerUnload          (TI_HANDLE hEvHandler);
62
63TI_UINT32 EvHandlerRegisterEvent   (TI_HANDLE hEvHandler, TI_UINT8* pData,   TI_UINT32 Length);
64
65TI_UINT32 EvHandlerUnRegisterEvent (TI_HANDLE hEvHandler, TI_HANDLE uEventID);
66
67TI_UINT32 EvHandlerMaskEvent       (TI_HANDLE hEvHandler, TI_UINT32 uEventID);
68
69TI_UINT32 EvHandlerUnMaskEvent     (TI_HANDLE hEvHandler, TI_UINT32 uEventID);
70
71TI_UINT32 EvHandlerGetEventData    (TI_HANDLE hEvHandler, TI_UINT8* pData, TI_UINT32* pLength);
72/* Bottom Interface*/
73
74TI_UINT32 EvHandlerSendEvent       (TI_HANDLE hEvHandler, TI_UINT32 EvType, TI_UINT8* pData, TI_UINT32 Length);
75
76
77#endif
78