1 /* 2 * context.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 35 36 /** \file context.h 37 * \brief context module header file. 38 * 39 * \see context.c 40 */ 41 42 #ifndef _CONTEXT_H_ 43 #define _CONTEXT_H_ 44 45 46 47 /* The callback function type for context clients */ 48 typedef void (*TContextCbFunc)(TI_HANDLE hCbHndl); 49 50 /* The context init parameters */ 51 typedef struct 52 { 53 /* Indicate if the driver should switch to its own context or not before handling events */ 54 TI_BOOL bContextSwitchRequired; 55 } TContextInitParams; 56 57 58 59 /* External Functions Prototypes */ 60 /* ============================= */ 61 TI_HANDLE context_Create (TI_HANDLE hOs); 62 TI_STATUS context_Destroy (TI_HANDLE hContext); 63 void context_Init (TI_HANDLE hContext, TI_HANDLE hOs, TI_HANDLE hReport); 64 TI_STATUS context_SetDefaults (TI_HANDLE hContext, TContextInitParams *pContextInitParams); 65 66 TI_UINT32 context_RegisterClient (TI_HANDLE hContext, 67 TContextCbFunc fCbFunc, 68 TI_HANDLE hCbHndl, 69 TI_BOOL bEnable, 70 char *sName, 71 TI_UINT32 uNameSize); 72 73 void context_RequestSchedule (TI_HANDLE hContext, TI_UINT32 uClientId); 74 void context_DriverTask (TI_HANDLE hContext); 75 void context_EnableClient (TI_HANDLE hContext, TI_UINT32 uClientId); 76 void context_DisableClient (TI_HANDLE hContext, TI_UINT32 uClientId); 77 78 void context_EnterCriticalSection (TI_HANDLE hContext); 79 void context_LeaveCriticalSection (TI_HANDLE hContext); 80 void context_DisableClient (TI_HANDLE hContext, TI_UINT32 uClientId); 81 void context_EnableClient (TI_HANDLE hContext, TI_UINT32 uClientId); 82 #ifdef TI_DBG 83 void context_Print (TI_HANDLE hContext); 84 #endif /* TI_DBG */ 85 86 87 88 #endif /* _CONTEXT_H_ */ 89 90 91
