1 /***********************************************************************************************************************
2  * Copyright [2015-2017] Renesas Electronics Corporation and/or its licensors. All Rights Reserved.
3  *
4  * This file is part of Renesas SynergyTM Software Package (SSP)
5  *
6  * The contents of this file (the "contents") are proprietary and confidential to Renesas Electronics Corporation
7  * and/or its licensors ("Renesas") and subject to statutory and contractual protections.
8  *
9  * This file is subject to a Renesas SSP license agreement. Unless otherwise agreed in an SSP license agreement with
10  * Renesas: 1) you may not use, copy, modify, distribute, display, or perform the contents; 2) you may not use any name
11  * or mark of Renesas for advertising or publicity purposes or in connection with your use of the contents; 3) RENESAS
12  * MAKES NO WARRANTY OR REPRESENTATIONS ABOUT THE SUITABILITY OF THE CONTENTS FOR ANY PURPOSE; THE CONTENTS ARE PROVIDED
13  * "AS IS" WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
14  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT; AND 4) RENESAS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, OR
15  * CONSEQUENTIAL DAMAGES, INCLUDING DAMAGES RESULTING FROM LOSS OF USE, DATA, OR PROJECTS, WHETHER IN AN ACTION OF
16  * CONTRACT OR TORT, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE CONTENTS. Third-party contents
17  * included in this file may be subject to different terms.
18  **********************************************************************************************************************/
19 
20 #ifndef R_GPT_PRIVATE_API_H
21 #define R_GPT_PRIVATE_API_H
22 
23 /* Common macro for SSP header files. There is also a corresponding SSP_FOOTER macro at the end of this file. */
24 SSP_HEADER
25 
26 /***********************************************************************************************************************
27  * Private Instance API Functions. DO NOT USE! Use functions through Interface API structure instead.
28  **********************************************************************************************************************/
29 ssp_err_t R_GPT_TimerOpen (timer_ctrl_t      * const p_ctrl,
30                            timer_cfg_t const * const p_cfg);
31 ssp_err_t R_GPT_Stop (timer_ctrl_t  * const p_ctrl);
32 ssp_err_t R_GPT_Start (timer_ctrl_t * const p_ctrl);
33 ssp_err_t R_GPT_Reset (timer_ctrl_t * const p_ctrl);
34 ssp_err_t R_GPT_PeriodSet (timer_ctrl_t * const p_ctrl,
35                            timer_size_t   const period,
36                            timer_unit_t   const unit);
37 ssp_err_t R_GPT_DutyCycleSet (timer_ctrl_t   * const p_ctrl,
38                               timer_size_t     const duty_cycle,
39                               timer_pwm_unit_t const unit,
40                               uint8_t          const pin);
41 ssp_err_t R_GPT_CounterGet (timer_ctrl_t * const p_ctrl,
42                             timer_size_t * const p_value);
43 ssp_err_t R_GPT_InfoGet (timer_ctrl_t   * const p_ctrl,
44                            timer_info_t * const p_info);
45 ssp_err_t R_GPT_Close (timer_ctrl_t     * const p_ctrl);
46 ssp_err_t R_GPT_VersionGet (ssp_version_t * const p_version);
47 
48 /* Common macro for SSP header files. There is also a corresponding SSP_HEADER macro at the top of this file. */
49 SSP_FOOTER
50 
51 #endif /* R_GPT_PRIVATE_API_H */
52