RDK Documentation (Open Sourced RDK Components)
iarmcec.h
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2018 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 /**
21 * @file ircec.h
22 *
23 * @brief Handles the IR CEC Local operations.
24 *
25 * This API defines the operations for key management.
26 *
27 * @par Document
28 * Document reference.
29 *
30 * @par Open Issues (in no particular order)
31 * -# None
32 *
33 * @par Assumptions
34 * -# None
35 *
36 * @par Implementation Notes
37 * -# None
38 *
39 *
40 */
41 
42 
43 
44 /**
45 * @defgroup iarmmgrs
46 * @{
47 * @defgroup iarmutil
48 * @{
49 **/
50 
51 
52 #ifndef _IARM_IRCEC_
53 #define _IARM_IRCEC_
54 
55 #ifdef RDK_LOGGER_ENABLED
56 #include "rdk_debug.h"
57 #include "iarmUtil.h"
58 extern int b_rdk_logger_enabled;
59 
60 #define LOG(...) INT_LOG(__VA_ARGS__, "")
61 #define INT_LOG(FORMAT, ...) if(b_rdk_logger_enabled) {\
62 RDK_LOG(RDK_LOG_DEBUG, "LOG.RDK.IRMGR", FORMAT , __VA_ARGS__);\
63 }\
64 else\
65 {\
66 printf(FORMAT, __VA_ARGS__);\
67 }
68 
69 #else
70 #define LOG(...) printf(__VA_ARGS__)
71 #endif
72 
73 /** @addtogroup IARM_IR_CEC_API IR CEC API.
74 * @ingroup IARM_BUS
75 *
76 * Described here in are functions to IR CEC local logic.
77 *
78 * @{
79 */
80 
81 /**
82  * @brief Utility function to send ActiveSource CEC event to TV.
83  * @return if return 1 caller should not broadcast IARM key event.
84  */
85 bool IARMCEC_SendCECActiveSource(bool bCecLocalLogic,int keyType, int keyCode);
86 
87 /**
88  * @brief Utility function to send ImageViewOn CEC event to TV.
89  * @return if return 1 caller should not broadcast IARM key event.
90  */
91 bool IARMCEC_SendCECImageViewOn(bool bCecLocalLogic);
92 
93 #endif
94 /* End of IARM_IR_CEC_API doxygen group */
95 /**
96  * @}
97  */
98 
99 /** @} */
100 /** @} */
rdk_debug.h
IARMCEC_SendCECActiveSource
bool IARMCEC_SendCECActiveSource(bool bCecLocalLogic, int keyType, int keyCode)
Utility function to send ActiveSource CEC event to TV.
Definition: iarmcec.c:29
IARMCEC_SendCECImageViewOn
bool IARMCEC_SendCECImageViewOn(bool bCecLocalLogic)
Utility function to send ImageViewOn CEC event to TV.
Definition: iarmcec.c:91
keyType
Definition: reset.c:85