xref: /btstack/port/renesas-tb-s1ja-cc256x/template/btstack_example/synergy/ssp/inc/driver/instances/r_ioport.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 /**********************************************************************************************************************
21  * File Name    : r_ioport.h
22  * Description  : IOPORT HAL layer APIs.
23  **********************************************************************************************************************/
24 
25 
26 /*******************************************************************************************************************//**
27  * @ingroup HAL_Library
28  * @defgroup IOPORT IOPORT
29  * @brief Driver for the I/O Ports.
30  *
31  * The IOPort HAL drivers provide the ability to access the I/O Ports of a device at both bit and port level.
32  * Port and pin direction can be changed. In addition a number of configuration APIs are provided to change the
33  * functionality of individual pins.
34  *
35  * @{
36  **********************************************************************************************************************/
37 
38 
39 #ifndef R_IOPORT_H
40 #define R_IOPORT_H
41 
42 /***********************************************************************************************************************
43  * Includes
44  **********************************************************************************************************************/
45 #include "bsp_api.h"
46 
47 /* Common macro for SSP header files. There is also a corresponding SSP_FOOTER macro at the end of this file. */
48 SSP_HEADER
49 
50 #include "r_ioport_api.h"
51 #include "r_ioport_cfg.h"
52 
53 /***********************************************************************************************************************
54  * Macro definitions
55  **********************************************************************************************************************/
56 #define IOPORT_CODE_VERSION_MAJOR (1U)
57 #define IOPORT_CODE_VERSION_MINOR (7U)
58 
59 /***********************************************************************************************************************
60  * Typedef definitions
61  **********************************************************************************************************************/
62 
63 /**********************************************************************************************************************
64  * Exported global variables
65  **********************************************************************************************************************/
66 /** @cond INC_HEADER_DEFS_SEC */
67 /** Filled in Interface API structure for this Instance. */
68 extern const ioport_api_t g_ioport_on_ioport;
69 /** @endcond */
70 
71 /* Common macro for SSP header files. There is also a corresponding SSP_HEADER macro at the top of this file. */
72 SSP_FOOTER
73 
74 #endif // R_IOPORT_H
75 
76 /*******************************************************************************************************************//**
77  * @} (end addtogroup IOPORT)
78  **********************************************************************************************************************/
79