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_DTC_R_DTC_PRIVATE_API_H_
21 #define R_DTC_R_DTC_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_DTC_Open (transfer_ctrl_t        * const p_ctrl,
30                       transfer_cfg_t const * const   p_cfg);
31 ssp_err_t R_DTC_Reset (transfer_ctrl_t        * const    p_ctrl,
32                        void const * volatile             p_src,
33                        void                   * volatile p_dest,
34                        uint16_t const                    num_transfers);
35 ssp_err_t R_DTC_Start     (transfer_ctrl_t        * const p_ctrl,
36                            transfer_start_mode_t          mode);
37 ssp_err_t R_DTC_Stop      (transfer_ctrl_t        * const p_ctrl);
38 ssp_err_t R_DTC_Enable    (transfer_ctrl_t        * const p_ctrl);
39 ssp_err_t R_DTC_Disable   (transfer_ctrl_t        * const p_ctrl);
40 ssp_err_t R_DTC_InfoGet   (transfer_ctrl_t        * const p_ctrl,
41                            transfer_properties_t  * const p_info);
42 ssp_err_t R_DTC_Close (transfer_ctrl_t        * const p_ctrl);
43 ssp_err_t R_DTC_VersionGet (ssp_version_t     * const p_version);
44 ssp_err_t R_DTC_BlockReset (transfer_ctrl_t   * const p_ctrl,
45                             void     const * volatile p_src,
46                             void           * volatile p_dest,
47                             uint16_t            const length,
48                             transfer_size_t           size,
49                             uint16_t            const num_transfers);
50 
51 /* Common macro for SSP header files. There is also a corresponding SSP_HEADER macro at the top of this file. */
52 SSP_FOOTER
53 
54 #endif /* R_DTC_R_DTC_PRIVATE_API_H_ */
55