xref: /btstack/port/renesas-tb-s1ja-cc256x/template/btstack_example/synergy/ssp/src/bsp/mcu/all/bsp_common_leds.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    : bsp_common_leds.h
22  * Description  : Support for LEDs on a board.
23  **********************************************************************************************************************/
24 
25 /*******************************************************************************************************************//**
26  * @ingroup BSP_MCU_COMMON
27  * @defgroup BSP_COMMON_LEDS Common BSP LED Code and Types
28  * @brief Common support for board LEDs
29  *
30  * Contains types and functions that allow for common use of LEDs on boards
31  *
32  * @{
33  **********************************************************************************************************************/
34 
35 #ifndef BSP_COMMON_LEDS_H
36 #define BSP_COMMON_LEDS_H
37 
38 /* Common macro for SSP header files. There is also a corresponding SSP_FOOTER macro at the end of this file. */
39 SSP_HEADER
40 
41 /***********************************************************************************************************************
42  * Includes
43  **********************************************************************************************************************/
44 
45 /**********************************************************************************************************************
46  * Macro definitions
47  *********************************************************************************************************************/
48 
49 /*********************************************************************************************************************
50  * Typedef definitions
51  *********************************************************************************************************************/
52 /** Information on how many LEDs and what pins they are on. */
53 typedef struct st_bsp_leds
54 {
55     uint16_t                   led_count;        ///< The number of LEDs on this board
56     ioport_port_pin_t const  * p_leds;           ///< Pointer to an array of IOPORT pins for controlling LEDs
57 } bsp_leds_t;
58 
59 /******************************************************************************************************************//**
60  * @} (end of defgroup BSP_COMMON_LEDS)
61  *********************************************************************************************************************/
62 
63 /* Common macro for SSP header files. There is also a corresponding SSP_HEADER macro at the top of this file. */
64 SSP_FOOTER
65 
66 #endif /* BSP_COMMON_LEDS_H */
67