vsync_pl.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer
00021 * Copyright (C) 2012 - 2014 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 /**
00024 * @file  vsync_pl.h
00025 * @brief   $Module: CLibCommon $ $PublicVersion: 1.00 $ (=CLIB_VERSION)
00026 * $Rev: 38 $
00027 * $Date:: 2014-03-18 16:14:45 +0900#$
00028 * - Description: V-Sync porting layer
00029 */
00030 
00031 #ifndef  WINDOW_SURFACES_PL_H
00032 #define  WINDOW_SURFACES_PL_H
00033 
00034 /******************************************************************************
00035 Includes   <System Includes> , "Project Includes"
00036 ******************************************************************************/
00037 #include  "r_ospl_typedef.h"
00038 #include  "vsync_typedef.h "
00039 
00040 #ifdef __cplusplus
00041 extern "C"
00042 {
00043 #endif /* __cplusplus */
00044 
00045 
00046     /******************************************************************************
00047     Typedef definitions
00048     ******************************************************************************/
00049 
00050     /******************************************************************************
00051     Macro definitions
00052     ******************************************************************************/
00053 
00054     /******************************************************************************
00055     Variable Externs
00056     ******************************************************************************/
00057 
00058     /******************************************************************************
00059     Functions Prototypes
00060     ******************************************************************************/
00061 
00062 
00063     /**
00064     * @brief   Set default <r_ospl_async_t>
00065     *
00066     * @param   in_out_Async Async parameters
00067     * @param   AsyncType r_ospl_async_type_t
00068     * @return  None
00069     */
00070     void  R_V_SYNC_SetDefaultAsync( r_ospl_async_t *const  in_out_Async,  r_ospl_async_type_t AsyncType );
00071 
00072 
00073     /**
00074     * @brief   Called from <R_V_SYNC_Initialize>
00075     *
00076     * @param   ChannelNum ChannelNum parameters
00077     * @return  Error Code. 0=No Error.
00078     */
00079     errnum_t  R_V_SYNC_OnInitialize( int_fast32_t const  ChannelNum );
00080 
00081 
00082     /**
00083     * @brief   Called from <R_V_SYNC_Finalize>
00084     *
00085     * @param   ChannelNum ChannelNum parameters
00086     * @return  Error Code. 0=No Error.
00087     */
00088     errnum_t  R_V_SYNC_OnFinalize( int_fast32_t const  ChannelNum,  errnum_t e );
00089 
00090 
00091     /**
00092     * @brief   Send <r_ospl_caller_t> to porting layer
00093     *
00094     * @param   ChannelNum ChannelNum parameters
00095     * @param   Caller r_ospl_caller_t
00096     * @return  Error Code. 0=No Error.
00097     */
00098     errnum_t  R_V_SYNC_SetInterruptCallbackCaller( int_fast32_t const  ChannelNum,
00099             const r_ospl_caller_t *const  Caller );
00100 
00101 
00102     /**
00103     * @brief   Enable interrupt lines
00104     *
00105     * @param   ChannelNum ChannelNum parameters
00106     * @param   Enables <r_v_sync_interrupt_lines_t>. 1=Enable, 0=NotChange
00107     * @return  Error Code. 0=No Error.
00108     */
00109     void   R_V_SYNC_OnEnableInterrupt( int_fast32_t const  ChannelNum,
00110                                        r_v_sync_interrupt_lines_t const  Enables );
00111 
00112 
00113     /**
00114     * @brief   Disable interrupt lines
00115     *
00116     * @param   ChannelNum ChannelNum parameters
00117     * @param   Disables <r_v_sync_interrupt_lines_t>. 1=Disable, 0=NotChange
00118     * @return  Error Code. 0=No Error.
00119     */
00120     void      R_V_SYNC_OnDisableInterrupt( int_fast32_t const  ChannelNum,
00121                                            r_v_sync_interrupt_lines_t const  Disables );
00122 
00123 
00124     /**
00125     * @brief   Default interrupt callback function
00126     *
00127     * @param   InterruptSource r_ospl_interrupt_t
00128     * @param   Caller r_ospl_caller_t
00129     * @return  Error Code. 0=No Error.
00130     */
00131     errnum_t  R_V_SYNC_OnInterruptDefault( const r_ospl_interrupt_t *const  InterruptSource,
00132                                            const r_ospl_caller_t *const  Caller );
00133 
00134 
00135 #ifdef __cplusplus
00136 }  /* extern "C" */
00137 #endif /* __cplusplus */
00138 
00139 #endif