DDR controller Pre-code review updates/comments, cleaned up c66xinit.c
[keystone-rtos/ibl.git] / src / driver / stream / stream.h
1 /** 
2  *   @file  stream.h
3  *
4  *   @brief   
5  *      The file has data structures and API definitions for the
6  *      STREAM Module 
7  *
8  *  \par
9  *  NOTE:
10  *      (C) Copyright 2008, Texas Instruments, Inc.
11  * 
12  *  Redistribution and use in source and binary forms, with or without 
13  *  modification, are permitted provided that the following conditions 
14  *  are met:
15  *
16  *    Redistributions of source code must retain the above copyright 
17  *    notice, this list of conditions and the following disclaimer.
18  *
19  *    Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the 
21  *    documentation and/or other materials provided with the   
22  *    distribution.
23  *
24  *    Neither the name of Texas Instruments Incorporated nor the names of
25  *    its contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
29  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
30  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
32  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
33  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
34  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
37  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
38  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  *
40  *  \par
41 */
42 #ifndef __STREAM_H__
43 #define __STREAM_H__
45 /**********************************************************************
46  **************************** Exported Functions **********************
47  **********************************************************************/
49 extern void  stream_init   (void);
50 extern Int32 stream_open   (Uint32 chunk_size);
51 extern void  stream_close  (void);
52 extern Int32 stream_read   (Uint8* ptr_data, Int32 num_bytes);
53 extern Int32 stream_peek   (Uint8* ptr_data, Int32 num_bytes);
54 extern Int32 stream_write  (Uint8* ptr_data, Int32 num_bytes);
55 extern Bool  stream_isempty(void);
56 extern Int32 stream_level  (void);
58 #endif /* __STREAM_H__ */