Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

zcpy_data.h

Go to the documentation of this file.
00001 /** ============================================================================
00002  *  @file   zcpy_data.h
00003  *
00004  *  @path   $(DSPLINK)/dsp/inc/
00005  *
00006  *  @brief  Defines the interface of DSPLINK Main Interface Module. It provides
00007  *          the standard minidriver function interface for DSPLINK.
00008  *
00009  *  @ver    1.65.00.03
00010  *  ============================================================================
00011  *  @copyright Copyright (C) 2002-2009, Texas Instruments Incorporated -
00012  *  http://www.ti.com/
00013  *
00014  *  Redistribution and use in source and binary forms, with or without
00015  *  modification, are permitted provided that the following conditions
00016  *  are met:
00017  *  
00018  *  *  Redistributions of source code must retain the above copyright
00019  *     notice, this list of conditions and the following disclaimer.
00020  *  
00021  *  *  Redistributions in binary form must reproduce the above copyright
00022  *     notice, this list of conditions and the following disclaimer in the
00023  *     documentation and/or other materials provided with the distribution.
00024  *  
00025  *  *  Neither the name of Texas Instruments Incorporated nor the names of
00026  *     its contributors may be used to endorse or promote products derived
00027  *     from this software without specific prior written permission.
00028  *  
00029  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00030  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00031  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00032  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00033  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00034  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00035  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
00036  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00037  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
00038  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00039  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00040  *  ============================================================================
00041  */
00042 
00043 
00044 #if !defined (ZCPY_DATA_H)
00045 #define ZCPY_DATA_H
00046 
00047 
00048 #if defined (__cplusplus)
00049 extern "C" {
00050 #endif /* defined (__cplusplus) */
00051 
00052 
00053 /** ============================================================================
00054  *  @name   DSPLINK_ChnlParams
00055  *
00056  *  @brief  Channel parameters to be passed while creating channels.
00057  *
00058  *  @param  maxBufferSize
00059  *              Maximum size of buffer that this channel will handle.
00060  *              - A value of -1 indicates buffer size is maximum allowed by the
00061  *                data driver or pool size.
00062  *  @param  maxPendingIOs
00063  *              Maximum buffers that can pend on this channel.
00064  *              - A value of -1 indicates buffer queueing is maximum allowed by
00065  *                the data driver.
00066  *  ============================================================================
00067  */
00068 typedef struct DSPLINK_ChnlParams_tag {
00069     Int maxBufferSize ;
00070     Int maxPendingIOs ;
00071 } DSPLINK_ChnlParams ;
00072 
00073 
00074 /** ============================================================================
00075  *  @func   ZCPYDATA_init
00076  *
00077  *  @brief  Initializes DSPLINK data driver structures before bind function.
00078  *
00079  *  @param None
00080  *
00081  *  @return None
00082  *
00083  *  @pre    None
00084  *
00085  *  @post   None
00086  *
00087  *  @see    None
00088  *  ============================================================================
00089  */
00090 extern Void ZCPYDATA_init (Void) ;
00091 
00092 
00093 #if defined (__cplusplus)
00094 }
00095 #endif /* defined (__cplusplus) */
00096 
00097 
00098 #endif /* !defined (ZCPY_DATA_H) */

Generated on Fri Jul 16 14:34:03 2010 for DSP/BIOSLink by  doxygen 1.4.4