1/*
2 * Copyright (c) 2010, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * *  Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 *
12 * *  Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * *  Neither the name of Texas Instruments Incorporated nor the names of
17 *    its contributors may be used to endorse or promote products derived
18 *    from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34*  @file timm_osal_defines.h
35*  The osal header file defines
36*  @path
37*
38*/
39/* -------------------------------------------------------------------------- */
40/* =========================================================================
41 *!
42 *! Revision History
43 *! ===================================
44 *! 0.1: Created the first draft version, ksrini@ti.com
45 * ========================================================================= */
46
47#ifndef _TIMM_OSAL_PIPES_H_
48#define _TIMM_OSAL_PIPES_H_
49
50#ifdef __cplusplus
51extern "C"
52{
53#endif				/* __cplusplus */
54
55#include "timm_osal_types.h"
56
57/*
58* Defined for Pipe timeout value
59*/
60	TIMM_OSAL_ERRORTYPE TIMM_OSAL_CreatePipe(TIMM_OSAL_PTR * pPipe,
61	    TIMM_OSAL_U32 pipeSize,
62	    TIMM_OSAL_U32 messageSize, TIMM_OSAL_U8 isFixedMessage);
63
64	TIMM_OSAL_ERRORTYPE TIMM_OSAL_DeletePipe(TIMM_OSAL_PTR pPipe);
65
66	TIMM_OSAL_ERRORTYPE TIMM_OSAL_WriteToPipe(TIMM_OSAL_PTR pPipe,
67	    void *pMessage, TIMM_OSAL_U32 size, TIMM_OSAL_S32 timeout);
68
69	TIMM_OSAL_ERRORTYPE TIMM_OSAL_WriteToFrontOfPipe(TIMM_OSAL_PTR pPipe,
70	    void *pMessage, TIMM_OSAL_U32 size, TIMM_OSAL_S32 timeout);
71
72	TIMM_OSAL_ERRORTYPE TIMM_OSAL_ReadFromPipe(TIMM_OSAL_PTR pPipe,
73	    void *pMessage,
74	    TIMM_OSAL_U32 size,
75	    TIMM_OSAL_U32 * actualSize, TIMM_OSAL_S32 timeout);
76
77	TIMM_OSAL_ERRORTYPE TIMM_OSAL_ClearPipe(TIMM_OSAL_PTR pPipe);
78
79	TIMM_OSAL_ERRORTYPE TIMM_OSAL_IsPipeReady(TIMM_OSAL_PTR pPipe);
80
81	TIMM_OSAL_ERRORTYPE TIMM_OSAL_GetPipeReadyMessageCount(TIMM_OSAL_PTR
82	    pPipe, TIMM_OSAL_U32 * count);
83
84
85#ifdef __cplusplus
86}
87#endif				/* __cplusplus */
88
89#endif				/* _TIMM_OSAL_PIPES_H_ */
90