Mistake on this page?
Report an issue in GitHub or email us
pal_led.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief LED driver definition.
6  *
7  * Copyright (c) 2019-2020 Packetcraft, Inc.
8  *
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  */
21 /*************************************************************************************************/
22 
23 #ifndef PAL_LED_H
24 #define PAL_LED_H
25 
26 #include "pal_types.h"
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /*! \addtogroup PAL_LED
33  * \{ */
34 
35 /**************************************************************************************************
36  Data Types
37 **************************************************************************************************/
38 
39 /*! \brief Reserved LED IDs. */
40 enum
41 {
42  /* System signals. */
43  PAL_LED_ID_CPU_ACTIVE = 0x30, /*!< CPU active LED ID. */
44  PAL_LED_ID_ERROR = 0x31, /*!< Error LED ID. */
45 };
46 
47 /**************************************************************************************************
48  Function Declarations
49 **************************************************************************************************/
50 
51 /* Initialization */
52 void PalLedInit(void);
53 void PalLedDeInit(void);
54 
55 /* Control and Status */
56 void PalLedOn(uint8_t id);
57 void PalLedOff(uint8_t id);
58 
59 /*! \} */ /* PAL_LED */
60 
61 #ifdef __cplusplus
62 };
63 #endif
64 
65 #endif /* PAL_LED_H */
Platform-independent data types.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.