1 /* SPDX-License-Identifier: GPL-2.0-only */ 1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* 2 /*
3 * cec-notifier.h - notify CEC drivers of phys 3 * cec-notifier.h - notify CEC drivers of physical address changes
4 * 4 *
5 * Copyright 2016 Russell King. !! 5 * Copyright 2016 Russell King <rmk+kernel@arm.linux.org.uk>
6 * Copyright 2016-2017 Cisco Systems, Inc. and 6 * Copyright 2016-2017 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
7 */ 7 */
8 8
9 #ifndef LINUX_CEC_NOTIFIER_H 9 #ifndef LINUX_CEC_NOTIFIER_H
10 #define LINUX_CEC_NOTIFIER_H 10 #define LINUX_CEC_NOTIFIER_H
11 11
12 #include <linux/err.h> 12 #include <linux/err.h>
13 #include <media/cec.h> 13 #include <media/cec.h>
14 14
15 struct device; 15 struct device;
16 struct edid; 16 struct edid;
17 struct cec_adapter; 17 struct cec_adapter;
18 struct cec_notifier; 18 struct cec_notifier;
19 19
20 #if IS_REACHABLE(CONFIG_CEC_CORE) && IS_ENABLE 20 #if IS_REACHABLE(CONFIG_CEC_CORE) && IS_ENABLED(CONFIG_CEC_NOTIFIER)
21 21
22 /** 22 /**
>> 23 * cec_notifier_get_conn - find or create a new cec_notifier for the given
>> 24 * device and connector tuple.
>> 25 * @dev: device that sends the events.
>> 26 * @conn: the connector name from which the event occurs
>> 27 *
>> 28 * If a notifier for device @dev already exists, then increase the refcount
>> 29 * and return that notifier.
>> 30 *
>> 31 * If it doesn't exist, then allocate a new notifier struct and return a
>> 32 * pointer to that new struct.
>> 33 *
>> 34 * Return NULL if the memory could not be allocated.
>> 35 */
>> 36 struct cec_notifier *cec_notifier_get_conn(struct device *dev,
>> 37 const char *conn);
>> 38
>> 39 /**
>> 40 * cec_notifier_put - decrease refcount and delete when the refcount reaches 0.
>> 41 * @n: notifier
>> 42 */
>> 43 void cec_notifier_put(struct cec_notifier *n);
>> 44
>> 45 /**
23 * cec_notifier_conn_register - find or create 46 * cec_notifier_conn_register - find or create a new cec_notifier for the given
24 * HDMI device and connector tuple. 47 * HDMI device and connector tuple.
25 * @hdmi_dev: HDMI device that sends the event 48 * @hdmi_dev: HDMI device that sends the events.
26 * @port_name: the connector name from which t !! 49 * @conn_name: the connector name from which the event occurs. May be NULL
27 * if there is always only one HDMI connector 50 * if there is always only one HDMI connector created by the HDMI device.
28 * @conn_info: the connector info from which t 51 * @conn_info: the connector info from which the event occurs (may be NULL)
29 * 52 *
30 * If a notifier for device @dev and connector !! 53 * If a notifier for device @dev and connector @conn_name already exists, then
31 * increase the refcount and return that notif 54 * increase the refcount and return that notifier.
32 * 55 *
33 * If it doesn't exist, then allocate a new no 56 * If it doesn't exist, then allocate a new notifier struct and return a
34 * pointer to that new struct. 57 * pointer to that new struct.
35 * 58 *
36 * Return NULL if the memory could not be allo 59 * Return NULL if the memory could not be allocated.
37 */ 60 */
38 struct cec_notifier * 61 struct cec_notifier *
39 cec_notifier_conn_register(struct device *hdmi !! 62 cec_notifier_conn_register(struct device *hdmi_dev, const char *conn_name,
40 const struct cec_co 63 const struct cec_connector_info *conn_info);
41 64
42 /** 65 /**
43 * cec_notifier_conn_unregister - decrease ref 66 * cec_notifier_conn_unregister - decrease refcount and delete when the
44 * refcount reaches 0. 67 * refcount reaches 0.
45 * @n: notifier. If NULL, then this function d 68 * @n: notifier. If NULL, then this function does nothing.
46 */ 69 */
47 void cec_notifier_conn_unregister(struct cec_n 70 void cec_notifier_conn_unregister(struct cec_notifier *n);
48 71
49 /** 72 /**
50 * cec_notifier_cec_adap_register - find or cr 73 * cec_notifier_cec_adap_register - find or create a new cec_notifier for the
51 * given device. 74 * given device.
52 * @hdmi_dev: HDMI device that sends the event 75 * @hdmi_dev: HDMI device that sends the events.
53 * @port_name: the connector name from which t !! 76 * @conn_name: the connector name from which the event occurs. May be NULL
54 * if there is always only one HDMI connector 77 * if there is always only one HDMI connector created by the HDMI device.
55 * @adap: the cec adapter that registered this 78 * @adap: the cec adapter that registered this notifier.
56 * 79 *
57 * If a notifier for device @dev and connector !! 80 * If a notifier for device @dev and connector @conn_name already exists, then
58 * increase the refcount and return that notif 81 * increase the refcount and return that notifier.
59 * 82 *
60 * If it doesn't exist, then allocate a new no 83 * If it doesn't exist, then allocate a new notifier struct and return a
61 * pointer to that new struct. 84 * pointer to that new struct.
62 * 85 *
63 * Return NULL if the memory could not be allo 86 * Return NULL if the memory could not be allocated.
64 */ 87 */
65 struct cec_notifier * 88 struct cec_notifier *
66 cec_notifier_cec_adap_register(struct device * !! 89 cec_notifier_cec_adap_register(struct device *hdmi_dev, const char *conn_name,
67 struct cec_adap 90 struct cec_adapter *adap);
68 91
69 /** 92 /**
70 * cec_notifier_cec_adap_unregister - decrease 93 * cec_notifier_cec_adap_unregister - decrease refcount and delete when the
71 * refcount reaches 0. 94 * refcount reaches 0.
72 * @n: notifier. If NULL, then this function d 95 * @n: notifier. If NULL, then this function does nothing.
73 * @adap: the cec adapter that registered this <<
74 */ 96 */
75 void cec_notifier_cec_adap_unregister(struct c !! 97 void cec_notifier_cec_adap_unregister(struct cec_notifier *n);
76 struct c <<
77 98
78 /** 99 /**
79 * cec_notifier_set_phys_addr - set a new phys 100 * cec_notifier_set_phys_addr - set a new physical address.
80 * @n: the CEC notifier 101 * @n: the CEC notifier
81 * @pa: the CEC physical address 102 * @pa: the CEC physical address
82 * 103 *
83 * Set a new CEC physical address. 104 * Set a new CEC physical address.
84 * Does nothing if @n == NULL. 105 * Does nothing if @n == NULL.
85 */ 106 */
86 void cec_notifier_set_phys_addr(struct cec_not 107 void cec_notifier_set_phys_addr(struct cec_notifier *n, u16 pa);
87 108
88 /** 109 /**
89 * cec_notifier_set_phys_addr_from_edid - set 110 * cec_notifier_set_phys_addr_from_edid - set parse the PA from the EDID.
90 * @n: the CEC notifier 111 * @n: the CEC notifier
91 * @edid: the struct edid pointer 112 * @edid: the struct edid pointer
92 * 113 *
93 * Parses the EDID to obtain the new CEC physi 114 * Parses the EDID to obtain the new CEC physical address and set it.
94 * Does nothing if @n == NULL. 115 * Does nothing if @n == NULL.
95 */ 116 */
96 void cec_notifier_set_phys_addr_from_edid(stru 117 void cec_notifier_set_phys_addr_from_edid(struct cec_notifier *n,
97 cons 118 const struct edid *edid);
98 119
99 /** 120 /**
100 * cec_notifier_parse_hdmi_phandle - find the 121 * cec_notifier_parse_hdmi_phandle - find the hdmi device from "hdmi-phandle"
101 * @dev: the device with the "hdmi-phandle" de 122 * @dev: the device with the "hdmi-phandle" device tree property
102 * 123 *
103 * Returns the device pointer referenced by th 124 * Returns the device pointer referenced by the "hdmi-phandle" property.
104 * Note that the refcount of the returned devi 125 * Note that the refcount of the returned device is not incremented.
105 * This device pointer is only used as a key v 126 * This device pointer is only used as a key value in the notifier
106 * list, but it is never accessed by the CEC d 127 * list, but it is never accessed by the CEC driver.
107 */ 128 */
108 struct device *cec_notifier_parse_hdmi_phandle 129 struct device *cec_notifier_parse_hdmi_phandle(struct device *dev);
109 130
110 #else 131 #else
>> 132 static inline struct cec_notifier *cec_notifier_get_conn(struct device *dev,
>> 133 const char *conn)
>> 134 {
>> 135 /* A non-NULL pointer is expected on success */
>> 136 return (struct cec_notifier *)0xdeadfeed;
>> 137 }
>> 138
>> 139 static inline void cec_notifier_put(struct cec_notifier *n)
>> 140 {
>> 141 }
111 142
112 static inline struct cec_notifier * 143 static inline struct cec_notifier *
113 cec_notifier_conn_register(struct device *hdmi !! 144 cec_notifier_conn_register(struct device *hdmi_dev, const char *conn_name,
114 const struct cec_co 145 const struct cec_connector_info *conn_info)
115 { 146 {
116 /* A non-NULL pointer is expected on s 147 /* A non-NULL pointer is expected on success */
117 return (struct cec_notifier *)0xdeadfe 148 return (struct cec_notifier *)0xdeadfeed;
118 } 149 }
119 150
120 static inline void cec_notifier_conn_unregiste 151 static inline void cec_notifier_conn_unregister(struct cec_notifier *n)
121 { 152 {
122 } 153 }
123 154
124 static inline struct cec_notifier * 155 static inline struct cec_notifier *
125 cec_notifier_cec_adap_register(struct device * !! 156 cec_notifier_cec_adap_register(struct device *hdmi_dev, const char *conn_name,
126 struct cec_adap 157 struct cec_adapter *adap)
127 { 158 {
128 /* A non-NULL pointer is expected on s 159 /* A non-NULL pointer is expected on success */
129 return (struct cec_notifier *)0xdeadfe 160 return (struct cec_notifier *)0xdeadfeed;
130 } 161 }
131 162
132 static inline void cec_notifier_cec_adap_unreg !! 163 static inline void cec_notifier_cec_adap_unregister(struct cec_notifier *n)
133 <<
134 { 164 {
135 } 165 }
136 166
137 static inline void cec_notifier_set_phys_addr( 167 static inline void cec_notifier_set_phys_addr(struct cec_notifier *n, u16 pa)
138 { 168 {
139 } 169 }
140 170
141 static inline void cec_notifier_set_phys_addr_ 171 static inline void cec_notifier_set_phys_addr_from_edid(struct cec_notifier *n,
142 172 const struct edid *edid)
143 { 173 {
144 } 174 }
145 175
146 static inline struct device *cec_notifier_pars 176 static inline struct device *cec_notifier_parse_hdmi_phandle(struct device *dev)
147 { 177 {
148 return ERR_PTR(-ENODEV); 178 return ERR_PTR(-ENODEV);
149 } 179 }
150 180
151 #endif 181 #endif
>> 182
>> 183 /**
>> 184 * cec_notifier_get - find or create a new cec_notifier for the given device.
>> 185 * @dev: device that sends the events.
>> 186 *
>> 187 * If a notifier for device @dev already exists, then increase the refcount
>> 188 * and return that notifier.
>> 189 *
>> 190 * If it doesn't exist, then allocate a new notifier struct and return a
>> 191 * pointer to that new struct.
>> 192 *
>> 193 * Return NULL if the memory could not be allocated.
>> 194 */
>> 195 static inline struct cec_notifier *cec_notifier_get(struct device *dev)
>> 196 {
>> 197 return cec_notifier_get_conn(dev, NULL);
>> 198 }
152 199
153 /** 200 /**
154 * cec_notifier_phys_addr_invalidate() - set t 201 * cec_notifier_phys_addr_invalidate() - set the physical address to INVALID
155 * 202 *
156 * @n: the CEC notifier 203 * @n: the CEC notifier
157 * 204 *
158 * This is a simple helper function to invalid 205 * This is a simple helper function to invalidate the physical
159 * address. Does nothing if @n == NULL. 206 * address. Does nothing if @n == NULL.
160 */ 207 */
161 static inline void cec_notifier_phys_addr_inva 208 static inline void cec_notifier_phys_addr_invalidate(struct cec_notifier *n)
162 { 209 {
163 cec_notifier_set_phys_addr(n, CEC_PHYS 210 cec_notifier_set_phys_addr(n, CEC_PHYS_ADDR_INVALID);
164 } 211 }
165 212
166 #endif 213 #endif
167 214
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.