xref: /btstack/port/renesas-tb-s1ja-cc256x/template/btstack_example/synergy/ssp/src/bsp/mcu/all/bsp_delay.h (revision 3b5c872a8c45689e8cc17891f01530f5aa5e911c)
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 * File Name    : bsp_delay.h
21 * Description  : Include file for the software delay implemented by the BSP.
22 ***********************************************************************************************************************/
23 
24 /*******************************************************************************************************************//**
25  * @ingroup BSP_MCU_COMMON
26  * @defgroup BSP_MCU_DELAY Software Delay
27  * @brief Common function to implement a software delay
28  *
29  * Implements a software delay function for all BSPs.
30  *
31  * @{
32 ***********************************************************************************************************************/
33 
34 
35 /** @} (end defgroup BSP_MCU_DELAY) */
36 
37 #ifndef BSP_DELAY_H_
38 #define BSP_DELAY_H_
39 
40 /***********************************************************************************************************************
41 Includes   <System Includes> , "Project Includes"
42 ***********************************************************************************************************************/
43 
44 /* Common macro for SSP header files. There is also a corresponding SSP_FOOTER macro at the end of this file. */
45 SSP_HEADER
46 
47 /***********************************************************************************************************************
48 Macro definitions
49 ***********************************************************************************************************************/
50 
51 /** Available delay units for R_BSP_SoftwareDelay(). These are ultimately used to calculate a total # of microseconds */
52 typedef enum
53 {
54     BSP_DELAY_UNITS_SECONDS =      1000000,  ///< Requested delay amount is in seconds
55     BSP_DELAY_UNITS_MILLISECONDS = 1000,     ///< Requested delay amount is in milliseconds
56     BSP_DELAY_UNITS_MICROSECONDS = 1         ///< Requested delay amount is in microseconds
57 } bsp_delay_units_t;
58 
59 /***********************************************************************************************************************
60 Exported global variables
61 ***********************************************************************************************************************/
62 
63 /***********************************************************************************************************************
64 Exported global functions (to be accessed by other files)
65 ***********************************************************************************************************************/
66 
67 /* Common macro for SSP header files. There is also a corresponding SSP_HEADER macro at the top of this file. */
68 SSP_FOOTER
69 
70 #endif /* BSP_DELAY_H_ */
71