blob: 4351c3481aea19720c2c96130f3a642bb5bfb44d [file] [log] [blame]
Hans Verkuil31325832016-06-17 09:17:57 -03001/*
2 * cec - HDMI Consumer Electronics Control public header
3 *
4 * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
5 *
6 * This program is free software; you may redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
Hans Verkuil12655442016-06-30 07:01:41 -030010 * Alternatively you can redistribute this file under the terms of the
11 * BSD license as stated below:
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in
20 * the documentation and/or other materials provided with the
21 * distribution.
22 * 3. The names of its contributors may not be used to endorse or promote
23 * products derived from this software without specific prior written
24 * permission.
25 *
Hans Verkuil31325832016-06-17 09:17:57 -030026 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 * SOFTWARE.
34 */
35
Hans Verkuil31325832016-06-17 09:17:57 -030036#ifndef _CEC_UAPI_H
37#define _CEC_UAPI_H
38
39#include <linux/types.h>
Hans Verkuil3145c752016-11-04 08:23:27 -020040#include <linux/string.h>
Hans Verkuil31325832016-06-17 09:17:57 -030041
42#define CEC_MAX_MSG_SIZE 16
43
44/**
45 * struct cec_msg - CEC message structure.
Hans Verkuil980e0b362016-07-12 11:10:42 -030046 * @tx_ts: Timestamp in nanoseconds using CLOCK_MONOTONIC. Set by the
47 * driver when the message transmission has finished.
48 * @rx_ts: Timestamp in nanoseconds using CLOCK_MONOTONIC. Set by the
49 * driver when the message was received.
Hans Verkuil31325832016-06-17 09:17:57 -030050 * @len: Length in bytes of the message.
51 * @timeout: The timeout (in ms) that is used to timeout CEC_RECEIVE.
52 * Set to 0 if you want to wait forever. This timeout can also be
53 * used with CEC_TRANSMIT as the timeout for waiting for a reply.
54 * If 0, then it will use a 1 second timeout instead of waiting
55 * forever as is done with CEC_RECEIVE.
56 * @sequence: The framework assigns a sequence number to messages that are
57 * sent. This can be used to track replies to previously sent
58 * messages.
59 * @flags: Set to 0.
Hans Verkuil31325832016-06-17 09:17:57 -030060 * @msg: The message payload.
61 * @reply: This field is ignored with CEC_RECEIVE and is only used by
62 * CEC_TRANSMIT. If non-zero, then wait for a reply with this
63 * opcode. Set to CEC_MSG_FEATURE_ABORT if you want to wait for
64 * a possible ABORT reply. If there was an error when sending the
65 * msg or FeatureAbort was returned, then reply is set to 0.
66 * If reply is non-zero upon return, then len/msg are set to
67 * the received message.
68 * If reply is zero upon return and status has the
69 * CEC_TX_STATUS_FEATURE_ABORT bit set, then len/msg are set to
70 * the received feature abort message.
71 * If reply is zero upon return and status has the
72 * CEC_TX_STATUS_MAX_RETRIES bit set, then no reply was seen at
73 * all. If reply is non-zero for CEC_TRANSMIT and the message is a
74 * broadcast, then -EINVAL is returned.
75 * if reply is non-zero, then timeout is set to 1000 (the required
76 * maximum response time).
Hans Verkuil980e0b362016-07-12 11:10:42 -030077 * @rx_status: The message receive status bits. Set by the driver.
78 * @tx_status: The message transmit status bits. Set by the driver.
Hans Verkuil31325832016-06-17 09:17:57 -030079 * @tx_arb_lost_cnt: The number of 'Arbitration Lost' events. Set by the driver.
80 * @tx_nack_cnt: The number of 'Not Acknowledged' events. Set by the driver.
81 * @tx_low_drive_cnt: The number of 'Low Drive Detected' events. Set by the
82 * driver.
83 * @tx_error_cnt: The number of 'Error' events. Set by the driver.
84 */
85struct cec_msg {
Hans Verkuil980e0b362016-07-12 11:10:42 -030086 __u64 tx_ts;
87 __u64 rx_ts;
Hans Verkuil31325832016-06-17 09:17:57 -030088 __u32 len;
89 __u32 timeout;
90 __u32 sequence;
91 __u32 flags;
Hans Verkuil31325832016-06-17 09:17:57 -030092 __u8 msg[CEC_MAX_MSG_SIZE];
93 __u8 reply;
Hans Verkuil980e0b362016-07-12 11:10:42 -030094 __u8 rx_status;
95 __u8 tx_status;
Hans Verkuil31325832016-06-17 09:17:57 -030096 __u8 tx_arb_lost_cnt;
97 __u8 tx_nack_cnt;
98 __u8 tx_low_drive_cnt;
99 __u8 tx_error_cnt;
100};
101
102/**
103 * cec_msg_initiator - return the initiator's logical address.
104 * @msg: the message structure
105 */
106static inline __u8 cec_msg_initiator(const struct cec_msg *msg)
107{
108 return msg->msg[0] >> 4;
109}
110
111/**
112 * cec_msg_destination - return the destination's logical address.
113 * @msg: the message structure
114 */
115static inline __u8 cec_msg_destination(const struct cec_msg *msg)
116{
117 return msg->msg[0] & 0xf;
118}
119
120/**
121 * cec_msg_opcode - return the opcode of the message, -1 for poll
122 * @msg: the message structure
123 */
124static inline int cec_msg_opcode(const struct cec_msg *msg)
125{
126 return msg->len > 1 ? msg->msg[1] : -1;
127}
128
129/**
130 * cec_msg_is_broadcast - return true if this is a broadcast message.
131 * @msg: the message structure
132 */
Hans Verkuil3145c752016-11-04 08:23:27 -0200133static inline int cec_msg_is_broadcast(const struct cec_msg *msg)
Hans Verkuil31325832016-06-17 09:17:57 -0300134{
135 return (msg->msg[0] & 0xf) == 0xf;
136}
137
138/**
139 * cec_msg_init - initialize the message structure.
140 * @msg: the message structure
141 * @initiator: the logical address of the initiator
142 * @destination:the logical address of the destination (0xf for broadcast)
143 *
144 * The whole structure is zeroed, the len field is set to 1 (i.e. a poll
145 * message) and the initiator and destination are filled in.
146 */
147static inline void cec_msg_init(struct cec_msg *msg,
148 __u8 initiator, __u8 destination)
149{
150 memset(msg, 0, sizeof(*msg));
151 msg->msg[0] = (initiator << 4) | destination;
152 msg->len = 1;
153}
154
155/**
156 * cec_msg_set_reply_to - fill in destination/initiator in a reply message.
157 * @msg: the message structure for the reply
158 * @orig: the original message structure
159 *
160 * Set the msg destination to the orig initiator and the msg initiator to the
161 * orig destination. Note that msg and orig may be the same pointer, in which
162 * case the change is done in place.
163 */
164static inline void cec_msg_set_reply_to(struct cec_msg *msg,
165 struct cec_msg *orig)
166{
167 /* The destination becomes the initiator and vice versa */
168 msg->msg[0] = (cec_msg_destination(orig) << 4) |
169 cec_msg_initiator(orig);
170 msg->reply = msg->timeout = 0;
171}
172
Hans Verkuiladc0c622016-11-01 08:55:05 -0200173/* cec_msg flags field */
174#define CEC_MSG_FL_REPLY_TO_FOLLOWERS (1 << 0)
175
176/* cec_msg tx/rx_status field */
Hans Verkuil31325832016-06-17 09:17:57 -0300177#define CEC_TX_STATUS_OK (1 << 0)
178#define CEC_TX_STATUS_ARB_LOST (1 << 1)
179#define CEC_TX_STATUS_NACK (1 << 2)
180#define CEC_TX_STATUS_LOW_DRIVE (1 << 3)
181#define CEC_TX_STATUS_ERROR (1 << 4)
182#define CEC_TX_STATUS_MAX_RETRIES (1 << 5)
183
184#define CEC_RX_STATUS_OK (1 << 0)
185#define CEC_RX_STATUS_TIMEOUT (1 << 1)
186#define CEC_RX_STATUS_FEATURE_ABORT (1 << 2)
187
Hans Verkuil3145c752016-11-04 08:23:27 -0200188static inline int cec_msg_status_is_ok(const struct cec_msg *msg)
Hans Verkuil31325832016-06-17 09:17:57 -0300189{
190 if (msg->tx_status && !(msg->tx_status & CEC_TX_STATUS_OK))
Hans Verkuil3145c752016-11-04 08:23:27 -0200191 return 0;
Hans Verkuil31325832016-06-17 09:17:57 -0300192 if (msg->rx_status && !(msg->rx_status & CEC_RX_STATUS_OK))
Hans Verkuil3145c752016-11-04 08:23:27 -0200193 return 0;
Hans Verkuil31325832016-06-17 09:17:57 -0300194 if (!msg->tx_status && !msg->rx_status)
Hans Verkuil3145c752016-11-04 08:23:27 -0200195 return 0;
Hans Verkuil31325832016-06-17 09:17:57 -0300196 return !(msg->rx_status & CEC_RX_STATUS_FEATURE_ABORT);
197}
198
199#define CEC_LOG_ADDR_INVALID 0xff
200#define CEC_PHYS_ADDR_INVALID 0xffff
201
202/*
203 * The maximum number of logical addresses one device can be assigned to.
204 * The CEC 2.0 spec allows for only 2 logical addresses at the moment. The
205 * Analog Devices CEC hardware supports 3. So let's go wild and go for 4.
206 */
207#define CEC_MAX_LOG_ADDRS 4
208
209/* The logical addresses defined by CEC 2.0 */
210#define CEC_LOG_ADDR_TV 0
211#define CEC_LOG_ADDR_RECORD_1 1
212#define CEC_LOG_ADDR_RECORD_2 2
213#define CEC_LOG_ADDR_TUNER_1 3
214#define CEC_LOG_ADDR_PLAYBACK_1 4
215#define CEC_LOG_ADDR_AUDIOSYSTEM 5
216#define CEC_LOG_ADDR_TUNER_2 6
217#define CEC_LOG_ADDR_TUNER_3 7
218#define CEC_LOG_ADDR_PLAYBACK_2 8
219#define CEC_LOG_ADDR_RECORD_3 9
220#define CEC_LOG_ADDR_TUNER_4 10
221#define CEC_LOG_ADDR_PLAYBACK_3 11
222#define CEC_LOG_ADDR_BACKUP_1 12
223#define CEC_LOG_ADDR_BACKUP_2 13
224#define CEC_LOG_ADDR_SPECIFIC 14
225#define CEC_LOG_ADDR_UNREGISTERED 15 /* as initiator address */
Hans Verkuil6e9b73c2017-02-09 13:14:13 -0200226#define CEC_LOG_ADDR_BROADCAST 15 /* as destination address */
Hans Verkuil31325832016-06-17 09:17:57 -0300227
228/* The logical address types that the CEC device wants to claim */
229#define CEC_LOG_ADDR_TYPE_TV 0
230#define CEC_LOG_ADDR_TYPE_RECORD 1
231#define CEC_LOG_ADDR_TYPE_TUNER 2
232#define CEC_LOG_ADDR_TYPE_PLAYBACK 3
233#define CEC_LOG_ADDR_TYPE_AUDIOSYSTEM 4
234#define CEC_LOG_ADDR_TYPE_SPECIFIC 5
235#define CEC_LOG_ADDR_TYPE_UNREGISTERED 6
236/*
237 * Switches should use UNREGISTERED.
238 * Processors should use SPECIFIC.
239 */
240
241#define CEC_LOG_ADDR_MASK_TV (1 << CEC_LOG_ADDR_TV)
242#define CEC_LOG_ADDR_MASK_RECORD ((1 << CEC_LOG_ADDR_RECORD_1) | \
243 (1 << CEC_LOG_ADDR_RECORD_2) | \
244 (1 << CEC_LOG_ADDR_RECORD_3))
245#define CEC_LOG_ADDR_MASK_TUNER ((1 << CEC_LOG_ADDR_TUNER_1) | \
246 (1 << CEC_LOG_ADDR_TUNER_2) | \
247 (1 << CEC_LOG_ADDR_TUNER_3) | \
248 (1 << CEC_LOG_ADDR_TUNER_4))
249#define CEC_LOG_ADDR_MASK_PLAYBACK ((1 << CEC_LOG_ADDR_PLAYBACK_1) | \
250 (1 << CEC_LOG_ADDR_PLAYBACK_2) | \
251 (1 << CEC_LOG_ADDR_PLAYBACK_3))
252#define CEC_LOG_ADDR_MASK_AUDIOSYSTEM (1 << CEC_LOG_ADDR_AUDIOSYSTEM)
253#define CEC_LOG_ADDR_MASK_BACKUP ((1 << CEC_LOG_ADDR_BACKUP_1) | \
254 (1 << CEC_LOG_ADDR_BACKUP_2))
255#define CEC_LOG_ADDR_MASK_SPECIFIC (1 << CEC_LOG_ADDR_SPECIFIC)
256#define CEC_LOG_ADDR_MASK_UNREGISTERED (1 << CEC_LOG_ADDR_UNREGISTERED)
257
Hans Verkuil3145c752016-11-04 08:23:27 -0200258static inline int cec_has_tv(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300259{
260 return log_addr_mask & CEC_LOG_ADDR_MASK_TV;
261}
262
Hans Verkuil3145c752016-11-04 08:23:27 -0200263static inline int cec_has_record(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300264{
265 return log_addr_mask & CEC_LOG_ADDR_MASK_RECORD;
266}
267
Hans Verkuil3145c752016-11-04 08:23:27 -0200268static inline int cec_has_tuner(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300269{
270 return log_addr_mask & CEC_LOG_ADDR_MASK_TUNER;
271}
272
Hans Verkuil3145c752016-11-04 08:23:27 -0200273static inline int cec_has_playback(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300274{
275 return log_addr_mask & CEC_LOG_ADDR_MASK_PLAYBACK;
276}
277
Hans Verkuil3145c752016-11-04 08:23:27 -0200278static inline int cec_has_audiosystem(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300279{
280 return log_addr_mask & CEC_LOG_ADDR_MASK_AUDIOSYSTEM;
281}
282
Hans Verkuil3145c752016-11-04 08:23:27 -0200283static inline int cec_has_backup(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300284{
285 return log_addr_mask & CEC_LOG_ADDR_MASK_BACKUP;
286}
287
Hans Verkuil3145c752016-11-04 08:23:27 -0200288static inline int cec_has_specific(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300289{
290 return log_addr_mask & CEC_LOG_ADDR_MASK_SPECIFIC;
291}
292
Hans Verkuil3145c752016-11-04 08:23:27 -0200293static inline int cec_is_unregistered(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300294{
295 return log_addr_mask & CEC_LOG_ADDR_MASK_UNREGISTERED;
296}
297
Hans Verkuil3145c752016-11-04 08:23:27 -0200298static inline int cec_is_unconfigured(__u16 log_addr_mask)
Hans Verkuil31325832016-06-17 09:17:57 -0300299{
300 return log_addr_mask == 0;
301}
302
303/*
304 * Use this if there is no vendor ID (CEC_G_VENDOR_ID) or if the vendor ID
305 * should be disabled (CEC_S_VENDOR_ID)
306 */
307#define CEC_VENDOR_ID_NONE 0xffffffff
308
309/* The message handling modes */
310/* Modes for initiator */
311#define CEC_MODE_NO_INITIATOR (0x0 << 0)
312#define CEC_MODE_INITIATOR (0x1 << 0)
313#define CEC_MODE_EXCL_INITIATOR (0x2 << 0)
314#define CEC_MODE_INITIATOR_MSK 0x0f
315
316/* Modes for follower */
317#define CEC_MODE_NO_FOLLOWER (0x0 << 4)
318#define CEC_MODE_FOLLOWER (0x1 << 4)
319#define CEC_MODE_EXCL_FOLLOWER (0x2 << 4)
320#define CEC_MODE_EXCL_FOLLOWER_PASSTHRU (0x3 << 4)
Hans Verkuil6303d972017-07-11 03:30:38 -0300321#define CEC_MODE_MONITOR_PIN (0xd << 4)
Hans Verkuil31325832016-06-17 09:17:57 -0300322#define CEC_MODE_MONITOR (0xe << 4)
323#define CEC_MODE_MONITOR_ALL (0xf << 4)
324#define CEC_MODE_FOLLOWER_MSK 0xf0
325
326/* Userspace has to configure the physical address */
327#define CEC_CAP_PHYS_ADDR (1 << 0)
328/* Userspace has to configure the logical addresses */
329#define CEC_CAP_LOG_ADDRS (1 << 1)
330/* Userspace can transmit messages (and thus become follower as well) */
331#define CEC_CAP_TRANSMIT (1 << 2)
332/*
333 * Passthrough all messages instead of processing them.
334 */
335#define CEC_CAP_PASSTHROUGH (1 << 3)
336/* Supports remote control */
337#define CEC_CAP_RC (1 << 4)
338/* Hardware can monitor all messages, not just directed and broadcast. */
339#define CEC_CAP_MONITOR_ALL (1 << 5)
Hans Verkuilf902c1e2017-06-07 11:46:12 -0300340/* Hardware can use CEC only if the HDMI HPD pin is high. */
341#define CEC_CAP_NEEDS_HPD (1 << 6)
Hans Verkuil6303d972017-07-11 03:30:38 -0300342/* Hardware can monitor CEC pin transitions */
343#define CEC_CAP_MONITOR_PIN (1 << 7)
Hans Verkuil31325832016-06-17 09:17:57 -0300344
345/**
346 * struct cec_caps - CEC capabilities structure.
347 * @driver: name of the CEC device driver.
348 * @name: name of the CEC device. @driver + @name must be unique.
349 * @available_log_addrs: number of available logical addresses.
350 * @capabilities: capabilities of the CEC adapter.
351 * @version: version of the CEC adapter framework.
352 */
353struct cec_caps {
354 char driver[32];
355 char name[32];
356 __u32 available_log_addrs;
357 __u32 capabilities;
358 __u32 version;
359};
360
361/**
362 * struct cec_log_addrs - CEC logical addresses structure.
363 * @log_addr: the claimed logical addresses. Set by the driver.
364 * @log_addr_mask: current logical address mask. Set by the driver.
365 * @cec_version: the CEC version that the adapter should implement. Set by the
366 * caller.
367 * @num_log_addrs: how many logical addresses should be claimed. Set by the
368 * caller.
369 * @vendor_id: the vendor ID of the device. Set by the caller.
Hans Verkuildcceb1e2016-08-10 09:24:45 -0300370 * @flags: flags.
Hans Verkuil31325832016-06-17 09:17:57 -0300371 * @osd_name: the OSD name of the device. Set by the caller.
372 * @primary_device_type: the primary device type for each logical address.
373 * Set by the caller.
374 * @log_addr_type: the logical address types. Set by the caller.
375 * @all_device_types: CEC 2.0: all device types represented by the logical
376 * address. Set by the caller.
377 * @features: CEC 2.0: The logical address features. Set by the caller.
378 */
379struct cec_log_addrs {
380 __u8 log_addr[CEC_MAX_LOG_ADDRS];
381 __u16 log_addr_mask;
382 __u8 cec_version;
383 __u8 num_log_addrs;
384 __u32 vendor_id;
385 __u32 flags;
386 char osd_name[15];
387 __u8 primary_device_type[CEC_MAX_LOG_ADDRS];
388 __u8 log_addr_type[CEC_MAX_LOG_ADDRS];
389
390 /* CEC 2.0 */
391 __u8 all_device_types[CEC_MAX_LOG_ADDRS];
392 __u8 features[CEC_MAX_LOG_ADDRS][12];
393};
394
Hans Verkuildcceb1e2016-08-10 09:24:45 -0300395/* Allow a fallback to unregistered */
396#define CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK (1 << 0)
Hans Verkuilf4062622016-11-01 07:59:34 -0200397/* Passthrough RC messages to the input subsystem */
398#define CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU (1 << 1)
Hans Verkuila69a1682016-11-02 07:41:41 -0200399/* CDC-Only device: supports only CDC messages */
400#define CEC_LOG_ADDRS_FL_CDC_ONLY (1 << 2)
Hans Verkuildcceb1e2016-08-10 09:24:45 -0300401
Hans Verkuil31325832016-06-17 09:17:57 -0300402/* Events */
403
404/* Event that occurs when the adapter state changes */
405#define CEC_EVENT_STATE_CHANGE 1
406/*
407 * This event is sent when messages are lost because the application
408 * didn't empty the message queue in time
409 */
410#define CEC_EVENT_LOST_MSGS 2
Hans Verkuil9a6b2a82017-08-15 15:26:25 -0400411#define CEC_EVENT_PIN_CEC_LOW 3
412#define CEC_EVENT_PIN_CEC_HIGH 4
Hans Verkuil31325832016-06-17 09:17:57 -0300413
414#define CEC_EVENT_FL_INITIAL_STATE (1 << 0)
Hans Verkuil6b2bbb02017-07-11 03:30:39 -0300415#define CEC_EVENT_FL_DROPPED_EVENTS (1 << 1)
Hans Verkuil31325832016-06-17 09:17:57 -0300416
417/**
418 * struct cec_event_state_change - used when the CEC adapter changes state.
419 * @phys_addr: the current physical address
420 * @log_addr_mask: the current logical address mask
421 */
422struct cec_event_state_change {
423 __u16 phys_addr;
424 __u16 log_addr_mask;
425};
426
427/**
Hans Verkuil6b2bbb02017-07-11 03:30:39 -0300428 * struct cec_event_lost_msgs - tells you how many messages were lost.
Hans Verkuil31325832016-06-17 09:17:57 -0300429 * @lost_msgs: how many messages were lost.
430 */
431struct cec_event_lost_msgs {
432 __u32 lost_msgs;
433};
434
435/**
436 * struct cec_event - CEC event structure
437 * @ts: the timestamp of when the event was sent.
438 * @event: the event.
439 * array.
440 * @state_change: the event payload for CEC_EVENT_STATE_CHANGE.
441 * @lost_msgs: the event payload for CEC_EVENT_LOST_MSGS.
442 * @raw: array to pad the union.
443 */
444struct cec_event {
445 __u64 ts;
446 __u32 event;
447 __u32 flags;
448 union {
449 struct cec_event_state_change state_change;
450 struct cec_event_lost_msgs lost_msgs;
451 __u32 raw[16];
452 };
453};
454
455/* ioctls */
456
457/* Adapter capabilities */
458#define CEC_ADAP_G_CAPS _IOWR('a', 0, struct cec_caps)
459
460/*
461 * phys_addr is either 0 (if this is the CEC root device)
462 * or a valid physical address obtained from the sink's EDID
463 * as read by this CEC device (if this is a source device)
464 * or a physical address obtained and modified from a sink
465 * EDID and used for a sink CEC device.
466 * If nothing is connected, then phys_addr is 0xffff.
467 * See HDMI 1.4b, section 8.7 (Physical Address).
468 *
469 * The CEC_ADAP_S_PHYS_ADDR ioctl may not be available if that is handled
470 * internally.
471 */
472#define CEC_ADAP_G_PHYS_ADDR _IOR('a', 1, __u16)
473#define CEC_ADAP_S_PHYS_ADDR _IOW('a', 2, __u16)
474
475/*
476 * Configure the CEC adapter. It sets the device type and which
477 * logical types it will try to claim. It will return which
478 * logical addresses it could actually claim.
479 * An error is returned if the adapter is disabled or if there
480 * is no physical address assigned.
481 */
482
483#define CEC_ADAP_G_LOG_ADDRS _IOR('a', 3, struct cec_log_addrs)
484#define CEC_ADAP_S_LOG_ADDRS _IOWR('a', 4, struct cec_log_addrs)
485
486/* Transmit/receive a CEC command */
487#define CEC_TRANSMIT _IOWR('a', 5, struct cec_msg)
488#define CEC_RECEIVE _IOWR('a', 6, struct cec_msg)
489
490/* Dequeue CEC events */
491#define CEC_DQEVENT _IOWR('a', 7, struct cec_event)
492
493/*
494 * Get and set the message handling mode for this filehandle.
495 */
496#define CEC_G_MODE _IOR('a', 8, __u32)
497#define CEC_S_MODE _IOW('a', 9, __u32)
498
499/*
500 * The remainder of this header defines all CEC messages and operands.
501 * The format matters since it the cec-ctl utility parses it to generate
502 * code for implementing all these messages.
503 *
504 * Comments ending with 'Feature' group messages for each feature.
505 * If messages are part of multiple features, then the "Has also"
506 * comment is used to list the previously defined messages that are
507 * supported by the feature.
508 *
509 * Before operands are defined a comment is added that gives the
510 * name of the operand and in brackets the variable name of the
511 * corresponding argument in the cec-funcs.h function.
512 */
513
514/* Messages */
515
516/* One Touch Play Feature */
517#define CEC_MSG_ACTIVE_SOURCE 0x82
518#define CEC_MSG_IMAGE_VIEW_ON 0x04
519#define CEC_MSG_TEXT_VIEW_ON 0x0d
520
521
522/* Routing Control Feature */
523
524/*
525 * Has also:
526 * CEC_MSG_ACTIVE_SOURCE
527 */
528
529#define CEC_MSG_INACTIVE_SOURCE 0x9d
530#define CEC_MSG_REQUEST_ACTIVE_SOURCE 0x85
531#define CEC_MSG_ROUTING_CHANGE 0x80
532#define CEC_MSG_ROUTING_INFORMATION 0x81
533#define CEC_MSG_SET_STREAM_PATH 0x86
534
535
536/* Standby Feature */
537#define CEC_MSG_STANDBY 0x36
538
539
540/* One Touch Record Feature */
541#define CEC_MSG_RECORD_OFF 0x0b
542#define CEC_MSG_RECORD_ON 0x09
543/* Record Source Type Operand (rec_src_type) */
544#define CEC_OP_RECORD_SRC_OWN 1
545#define CEC_OP_RECORD_SRC_DIGITAL 2
546#define CEC_OP_RECORD_SRC_ANALOG 3
547#define CEC_OP_RECORD_SRC_EXT_PLUG 4
548#define CEC_OP_RECORD_SRC_EXT_PHYS_ADDR 5
549/* Service Identification Method Operand (service_id_method) */
550#define CEC_OP_SERVICE_ID_METHOD_BY_DIG_ID 0
551#define CEC_OP_SERVICE_ID_METHOD_BY_CHANNEL 1
552/* Digital Service Broadcast System Operand (dig_bcast_system) */
553#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_GEN 0x00
554#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_GEN 0x01
555#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_GEN 0x02
556#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_BS 0x08
557#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_CS 0x09
558#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_T 0x0a
559#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_CABLE 0x10
560#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_SAT 0x11
561#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_T 0x12
562#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_C 0x18
563#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S 0x19
564#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S2 0x1a
565#define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_T 0x1b
566/* Analogue Broadcast Type Operand (ana_bcast_type) */
567#define CEC_OP_ANA_BCAST_TYPE_CABLE 0
568#define CEC_OP_ANA_BCAST_TYPE_SATELLITE 1
569#define CEC_OP_ANA_BCAST_TYPE_TERRESTRIAL 2
570/* Broadcast System Operand (bcast_system) */
571#define CEC_OP_BCAST_SYSTEM_PAL_BG 0x00
572#define CEC_OP_BCAST_SYSTEM_SECAM_LQ 0x01 /* SECAM L' */
573#define CEC_OP_BCAST_SYSTEM_PAL_M 0x02
574#define CEC_OP_BCAST_SYSTEM_NTSC_M 0x03
575#define CEC_OP_BCAST_SYSTEM_PAL_I 0x04
576#define CEC_OP_BCAST_SYSTEM_SECAM_DK 0x05
577#define CEC_OP_BCAST_SYSTEM_SECAM_BG 0x06
578#define CEC_OP_BCAST_SYSTEM_SECAM_L 0x07
579#define CEC_OP_BCAST_SYSTEM_PAL_DK 0x08
580#define CEC_OP_BCAST_SYSTEM_OTHER 0x1f
581/* Channel Number Format Operand (channel_number_fmt) */
582#define CEC_OP_CHANNEL_NUMBER_FMT_1_PART 0x01
583#define CEC_OP_CHANNEL_NUMBER_FMT_2_PART 0x02
584
585#define CEC_MSG_RECORD_STATUS 0x0a
586/* Record Status Operand (rec_status) */
587#define CEC_OP_RECORD_STATUS_CUR_SRC 0x01
588#define CEC_OP_RECORD_STATUS_DIG_SERVICE 0x02
589#define CEC_OP_RECORD_STATUS_ANA_SERVICE 0x03
590#define CEC_OP_RECORD_STATUS_EXT_INPUT 0x04
591#define CEC_OP_RECORD_STATUS_NO_DIG_SERVICE 0x05
592#define CEC_OP_RECORD_STATUS_NO_ANA_SERVICE 0x06
593#define CEC_OP_RECORD_STATUS_NO_SERVICE 0x07
594#define CEC_OP_RECORD_STATUS_INVALID_EXT_PLUG 0x09
595#define CEC_OP_RECORD_STATUS_INVALID_EXT_PHYS_ADDR 0x0a
596#define CEC_OP_RECORD_STATUS_UNSUP_CA 0x0b
597#define CEC_OP_RECORD_STATUS_NO_CA_ENTITLEMENTS 0x0c
598#define CEC_OP_RECORD_STATUS_CANT_COPY_SRC 0x0d
599#define CEC_OP_RECORD_STATUS_NO_MORE_COPIES 0x0e
600#define CEC_OP_RECORD_STATUS_NO_MEDIA 0x10
601#define CEC_OP_RECORD_STATUS_PLAYING 0x11
602#define CEC_OP_RECORD_STATUS_ALREADY_RECORDING 0x12
603#define CEC_OP_RECORD_STATUS_MEDIA_PROT 0x13
604#define CEC_OP_RECORD_STATUS_NO_SIGNAL 0x14
605#define CEC_OP_RECORD_STATUS_MEDIA_PROBLEM 0x15
606#define CEC_OP_RECORD_STATUS_NO_SPACE 0x16
607#define CEC_OP_RECORD_STATUS_PARENTAL_LOCK 0x17
608#define CEC_OP_RECORD_STATUS_TERMINATED_OK 0x1a
609#define CEC_OP_RECORD_STATUS_ALREADY_TERM 0x1b
610#define CEC_OP_RECORD_STATUS_OTHER 0x1f
611
612#define CEC_MSG_RECORD_TV_SCREEN 0x0f
613
614
615/* Timer Programming Feature */
616#define CEC_MSG_CLEAR_ANALOGUE_TIMER 0x33
617/* Recording Sequence Operand (recording_seq) */
618#define CEC_OP_REC_SEQ_SUNDAY 0x01
619#define CEC_OP_REC_SEQ_MONDAY 0x02
620#define CEC_OP_REC_SEQ_TUESDAY 0x04
621#define CEC_OP_REC_SEQ_WEDNESDAY 0x08
622#define CEC_OP_REC_SEQ_THURSDAY 0x10
623#define CEC_OP_REC_SEQ_FRIDAY 0x20
624#define CEC_OP_REC_SEQ_SATERDAY 0x40
625#define CEC_OP_REC_SEQ_ONCE_ONLY 0x00
626
627#define CEC_MSG_CLEAR_DIGITAL_TIMER 0x99
628
629#define CEC_MSG_CLEAR_EXT_TIMER 0xa1
630/* External Source Specifier Operand (ext_src_spec) */
631#define CEC_OP_EXT_SRC_PLUG 0x04
632#define CEC_OP_EXT_SRC_PHYS_ADDR 0x05
633
634#define CEC_MSG_SET_ANALOGUE_TIMER 0x34
635#define CEC_MSG_SET_DIGITAL_TIMER 0x97
636#define CEC_MSG_SET_EXT_TIMER 0xa2
637
638#define CEC_MSG_SET_TIMER_PROGRAM_TITLE 0x67
639#define CEC_MSG_TIMER_CLEARED_STATUS 0x43
640/* Timer Cleared Status Data Operand (timer_cleared_status) */
641#define CEC_OP_TIMER_CLR_STAT_RECORDING 0x00
642#define CEC_OP_TIMER_CLR_STAT_NO_MATCHING 0x01
643#define CEC_OP_TIMER_CLR_STAT_NO_INFO 0x02
644#define CEC_OP_TIMER_CLR_STAT_CLEARED 0x80
645
646#define CEC_MSG_TIMER_STATUS 0x35
647/* Timer Overlap Warning Operand (timer_overlap_warning) */
648#define CEC_OP_TIMER_OVERLAP_WARNING_NO_OVERLAP 0
649#define CEC_OP_TIMER_OVERLAP_WARNING_OVERLAP 1
650/* Media Info Operand (media_info) */
651#define CEC_OP_MEDIA_INFO_UNPROT_MEDIA 0
652#define CEC_OP_MEDIA_INFO_PROT_MEDIA 1
653#define CEC_OP_MEDIA_INFO_NO_MEDIA 2
654/* Programmed Indicator Operand (prog_indicator) */
655#define CEC_OP_PROG_IND_NOT_PROGRAMMED 0
656#define CEC_OP_PROG_IND_PROGRAMMED 1
657/* Programmed Info Operand (prog_info) */
658#define CEC_OP_PROG_INFO_ENOUGH_SPACE 0x08
659#define CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE 0x09
660#define CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE 0x0b
661#define CEC_OP_PROG_INFO_NONE_AVAILABLE 0x0a
662/* Not Programmed Error Info Operand (prog_error) */
663#define CEC_OP_PROG_ERROR_NO_FREE_TIMER 0x01
664#define CEC_OP_PROG_ERROR_DATE_OUT_OF_RANGE 0x02
665#define CEC_OP_PROG_ERROR_REC_SEQ_ERROR 0x03
666#define CEC_OP_PROG_ERROR_INV_EXT_PLUG 0x04
667#define CEC_OP_PROG_ERROR_INV_EXT_PHYS_ADDR 0x05
668#define CEC_OP_PROG_ERROR_CA_UNSUPP 0x06
669#define CEC_OP_PROG_ERROR_INSUF_CA_ENTITLEMENTS 0x07
670#define CEC_OP_PROG_ERROR_RESOLUTION_UNSUPP 0x08
671#define CEC_OP_PROG_ERROR_PARENTAL_LOCK 0x09
672#define CEC_OP_PROG_ERROR_CLOCK_FAILURE 0x0a
673#define CEC_OP_PROG_ERROR_DUPLICATE 0x0e
674
675
676/* System Information Feature */
677#define CEC_MSG_CEC_VERSION 0x9e
678/* CEC Version Operand (cec_version) */
679#define CEC_OP_CEC_VERSION_1_3A 4
680#define CEC_OP_CEC_VERSION_1_4 5
681#define CEC_OP_CEC_VERSION_2_0 6
682
683#define CEC_MSG_GET_CEC_VERSION 0x9f
684#define CEC_MSG_GIVE_PHYSICAL_ADDR 0x83
685#define CEC_MSG_GET_MENU_LANGUAGE 0x91
686#define CEC_MSG_REPORT_PHYSICAL_ADDR 0x84
687/* Primary Device Type Operand (prim_devtype) */
688#define CEC_OP_PRIM_DEVTYPE_TV 0
689#define CEC_OP_PRIM_DEVTYPE_RECORD 1
690#define CEC_OP_PRIM_DEVTYPE_TUNER 3
691#define CEC_OP_PRIM_DEVTYPE_PLAYBACK 4
692#define CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM 5
693#define CEC_OP_PRIM_DEVTYPE_SWITCH 6
694#define CEC_OP_PRIM_DEVTYPE_PROCESSOR 7
695
696#define CEC_MSG_SET_MENU_LANGUAGE 0x32
697#define CEC_MSG_REPORT_FEATURES 0xa6 /* HDMI 2.0 */
698/* All Device Types Operand (all_device_types) */
699#define CEC_OP_ALL_DEVTYPE_TV 0x80
700#define CEC_OP_ALL_DEVTYPE_RECORD 0x40
701#define CEC_OP_ALL_DEVTYPE_TUNER 0x20
702#define CEC_OP_ALL_DEVTYPE_PLAYBACK 0x10
703#define CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM 0x08
704#define CEC_OP_ALL_DEVTYPE_SWITCH 0x04
705/*
706 * And if you wondering what happened to PROCESSOR devices: those should
707 * be mapped to a SWITCH.
708 */
709
710/* Valid for RC Profile and Device Feature operands */
711#define CEC_OP_FEAT_EXT 0x80 /* Extension bit */
712/* RC Profile Operand (rc_profile) */
713#define CEC_OP_FEAT_RC_TV_PROFILE_NONE 0x00
714#define CEC_OP_FEAT_RC_TV_PROFILE_1 0x02
715#define CEC_OP_FEAT_RC_TV_PROFILE_2 0x06
716#define CEC_OP_FEAT_RC_TV_PROFILE_3 0x0a
717#define CEC_OP_FEAT_RC_TV_PROFILE_4 0x0e
718#define CEC_OP_FEAT_RC_SRC_HAS_DEV_ROOT_MENU 0x50
719#define CEC_OP_FEAT_RC_SRC_HAS_DEV_SETUP_MENU 0x48
720#define CEC_OP_FEAT_RC_SRC_HAS_CONTENTS_MENU 0x44
721#define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_TOP_MENU 0x42
722#define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_CONTEXT_MENU 0x41
723/* Device Feature Operand (dev_features) */
724#define CEC_OP_FEAT_DEV_HAS_RECORD_TV_SCREEN 0x40
725#define CEC_OP_FEAT_DEV_HAS_SET_OSD_STRING 0x20
726#define CEC_OP_FEAT_DEV_HAS_DECK_CONTROL 0x10
727#define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_RATE 0x08
728#define CEC_OP_FEAT_DEV_SINK_HAS_ARC_TX 0x04
729#define CEC_OP_FEAT_DEV_SOURCE_HAS_ARC_RX 0x02
730
731#define CEC_MSG_GIVE_FEATURES 0xa5 /* HDMI 2.0 */
732
733
734/* Deck Control Feature */
735#define CEC_MSG_DECK_CONTROL 0x42
736/* Deck Control Mode Operand (deck_control_mode) */
737#define CEC_OP_DECK_CTL_MODE_SKIP_FWD 1
738#define CEC_OP_DECK_CTL_MODE_SKIP_REV 2
739#define CEC_OP_DECK_CTL_MODE_STOP 3
740#define CEC_OP_DECK_CTL_MODE_EJECT 4
741
742#define CEC_MSG_DECK_STATUS 0x1b
743/* Deck Info Operand (deck_info) */
744#define CEC_OP_DECK_INFO_PLAY 0x11
745#define CEC_OP_DECK_INFO_RECORD 0x12
746#define CEC_OP_DECK_INFO_PLAY_REV 0x13
747#define CEC_OP_DECK_INFO_STILL 0x14
748#define CEC_OP_DECK_INFO_SLOW 0x15
749#define CEC_OP_DECK_INFO_SLOW_REV 0x16
750#define CEC_OP_DECK_INFO_FAST_FWD 0x17
751#define CEC_OP_DECK_INFO_FAST_REV 0x18
752#define CEC_OP_DECK_INFO_NO_MEDIA 0x19
753#define CEC_OP_DECK_INFO_STOP 0x1a
754#define CEC_OP_DECK_INFO_SKIP_FWD 0x1b
755#define CEC_OP_DECK_INFO_SKIP_REV 0x1c
756#define CEC_OP_DECK_INFO_INDEX_SEARCH_FWD 0x1d
757#define CEC_OP_DECK_INFO_INDEX_SEARCH_REV 0x1e
758#define CEC_OP_DECK_INFO_OTHER 0x1f
759
760#define CEC_MSG_GIVE_DECK_STATUS 0x1a
761/* Status Request Operand (status_req) */
762#define CEC_OP_STATUS_REQ_ON 1
763#define CEC_OP_STATUS_REQ_OFF 2
764#define CEC_OP_STATUS_REQ_ONCE 3
765
766#define CEC_MSG_PLAY 0x41
767/* Play Mode Operand (play_mode) */
768#define CEC_OP_PLAY_MODE_PLAY_FWD 0x24
769#define CEC_OP_PLAY_MODE_PLAY_REV 0x20
770#define CEC_OP_PLAY_MODE_PLAY_STILL 0x25
771#define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MIN 0x05
772#define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MED 0x06
773#define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MAX 0x07
774#define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MIN 0x09
775#define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MED 0x0a
776#define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MAX 0x0b
777#define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MIN 0x15
778#define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MED 0x16
779#define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MAX 0x17
780#define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MIN 0x19
781#define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MED 0x1a
782#define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MAX 0x1b
783
784
785/* Tuner Control Feature */
786#define CEC_MSG_GIVE_TUNER_DEVICE_STATUS 0x08
787#define CEC_MSG_SELECT_ANALOGUE_SERVICE 0x92
788#define CEC_MSG_SELECT_DIGITAL_SERVICE 0x93
789#define CEC_MSG_TUNER_DEVICE_STATUS 0x07
790/* Recording Flag Operand (rec_flag) */
791#define CEC_OP_REC_FLAG_USED 0
792#define CEC_OP_REC_FLAG_NOT_USED 1
793/* Tuner Display Info Operand (tuner_display_info) */
794#define CEC_OP_TUNER_DISPLAY_INFO_DIGITAL 0
795#define CEC_OP_TUNER_DISPLAY_INFO_NONE 1
796#define CEC_OP_TUNER_DISPLAY_INFO_ANALOGUE 2
797
798#define CEC_MSG_TUNER_STEP_DECREMENT 0x06
799#define CEC_MSG_TUNER_STEP_INCREMENT 0x05
800
801
802/* Vendor Specific Commands Feature */
803
804/*
805 * Has also:
806 * CEC_MSG_CEC_VERSION
807 * CEC_MSG_GET_CEC_VERSION
808 */
809#define CEC_MSG_DEVICE_VENDOR_ID 0x87
810#define CEC_MSG_GIVE_DEVICE_VENDOR_ID 0x8c
811#define CEC_MSG_VENDOR_COMMAND 0x89
812#define CEC_MSG_VENDOR_COMMAND_WITH_ID 0xa0
813#define CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN 0x8a
814#define CEC_MSG_VENDOR_REMOTE_BUTTON_UP 0x8b
815
816
817/* OSD Display Feature */
818#define CEC_MSG_SET_OSD_STRING 0x64
819/* Display Control Operand (disp_ctl) */
820#define CEC_OP_DISP_CTL_DEFAULT 0x00
821#define CEC_OP_DISP_CTL_UNTIL_CLEARED 0x40
822#define CEC_OP_DISP_CTL_CLEAR 0x80
823
824
825/* Device OSD Transfer Feature */
826#define CEC_MSG_GIVE_OSD_NAME 0x46
827#define CEC_MSG_SET_OSD_NAME 0x47
828
829
830/* Device Menu Control Feature */
831#define CEC_MSG_MENU_REQUEST 0x8d
832/* Menu Request Type Operand (menu_req) */
833#define CEC_OP_MENU_REQUEST_ACTIVATE 0x00
834#define CEC_OP_MENU_REQUEST_DEACTIVATE 0x01
835#define CEC_OP_MENU_REQUEST_QUERY 0x02
836
837#define CEC_MSG_MENU_STATUS 0x8e
838/* Menu State Operand (menu_state) */
839#define CEC_OP_MENU_STATE_ACTIVATED 0x00
840#define CEC_OP_MENU_STATE_DEACTIVATED 0x01
841
842#define CEC_MSG_USER_CONTROL_PRESSED 0x44
843/* UI Broadcast Type Operand (ui_bcast_type) */
844#define CEC_OP_UI_BCAST_TYPE_TOGGLE_ALL 0x00
845#define CEC_OP_UI_BCAST_TYPE_TOGGLE_DIG_ANA 0x01
846#define CEC_OP_UI_BCAST_TYPE_ANALOGUE 0x10
847#define CEC_OP_UI_BCAST_TYPE_ANALOGUE_T 0x20
848#define CEC_OP_UI_BCAST_TYPE_ANALOGUE_CABLE 0x30
849#define CEC_OP_UI_BCAST_TYPE_ANALOGUE_SAT 0x40
850#define CEC_OP_UI_BCAST_TYPE_DIGITAL 0x50
851#define CEC_OP_UI_BCAST_TYPE_DIGITAL_T 0x60
852#define CEC_OP_UI_BCAST_TYPE_DIGITAL_CABLE 0x70
853#define CEC_OP_UI_BCAST_TYPE_DIGITAL_SAT 0x80
854#define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT 0x90
855#define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT2 0x91
856#define CEC_OP_UI_BCAST_TYPE_IP 0xa0
857/* UI Sound Presentation Control Operand (ui_snd_pres_ctl) */
858#define CEC_OP_UI_SND_PRES_CTL_DUAL_MONO 0x10
859#define CEC_OP_UI_SND_PRES_CTL_KARAOKE 0x20
860#define CEC_OP_UI_SND_PRES_CTL_DOWNMIX 0x80
861#define CEC_OP_UI_SND_PRES_CTL_REVERB 0x90
862#define CEC_OP_UI_SND_PRES_CTL_EQUALIZER 0xa0
863#define CEC_OP_UI_SND_PRES_CTL_BASS_UP 0xb1
864#define CEC_OP_UI_SND_PRES_CTL_BASS_NEUTRAL 0xb2
865#define CEC_OP_UI_SND_PRES_CTL_BASS_DOWN 0xb3
866#define CEC_OP_UI_SND_PRES_CTL_TREBLE_UP 0xc1
867#define CEC_OP_UI_SND_PRES_CTL_TREBLE_NEUTRAL 0xc2
868#define CEC_OP_UI_SND_PRES_CTL_TREBLE_DOWN 0xc3
869
870#define CEC_MSG_USER_CONTROL_RELEASED 0x45
871
872
873/* Remote Control Passthrough Feature */
874
875/*
876 * Has also:
877 * CEC_MSG_USER_CONTROL_PRESSED
878 * CEC_MSG_USER_CONTROL_RELEASED
879 */
880
881
882/* Power Status Feature */
883#define CEC_MSG_GIVE_DEVICE_POWER_STATUS 0x8f
884#define CEC_MSG_REPORT_POWER_STATUS 0x90
885/* Power Status Operand (pwr_state) */
886#define CEC_OP_POWER_STATUS_ON 0
887#define CEC_OP_POWER_STATUS_STANDBY 1
888#define CEC_OP_POWER_STATUS_TO_ON 2
889#define CEC_OP_POWER_STATUS_TO_STANDBY 3
890
891
892/* General Protocol Messages */
893#define CEC_MSG_FEATURE_ABORT 0x00
894/* Abort Reason Operand (reason) */
895#define CEC_OP_ABORT_UNRECOGNIZED_OP 0
896#define CEC_OP_ABORT_INCORRECT_MODE 1
897#define CEC_OP_ABORT_NO_SOURCE 2
898#define CEC_OP_ABORT_INVALID_OP 3
899#define CEC_OP_ABORT_REFUSED 4
900#define CEC_OP_ABORT_UNDETERMINED 5
901
902#define CEC_MSG_ABORT 0xff
903
904
905/* System Audio Control Feature */
906
907/*
908 * Has also:
909 * CEC_MSG_USER_CONTROL_PRESSED
910 * CEC_MSG_USER_CONTROL_RELEASED
911 */
912#define CEC_MSG_GIVE_AUDIO_STATUS 0x71
913#define CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS 0x7d
914#define CEC_MSG_REPORT_AUDIO_STATUS 0x7a
915/* Audio Mute Status Operand (aud_mute_status) */
916#define CEC_OP_AUD_MUTE_STATUS_OFF 0
917#define CEC_OP_AUD_MUTE_STATUS_ON 1
918
919#define CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR 0xa3
920#define CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR 0xa4
921#define CEC_MSG_SET_SYSTEM_AUDIO_MODE 0x72
922/* System Audio Status Operand (sys_aud_status) */
923#define CEC_OP_SYS_AUD_STATUS_OFF 0
924#define CEC_OP_SYS_AUD_STATUS_ON 1
925
926#define CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST 0x70
927#define CEC_MSG_SYSTEM_AUDIO_MODE_STATUS 0x7e
928/* Audio Format ID Operand (audio_format_id) */
929#define CEC_OP_AUD_FMT_ID_CEA861 0
930#define CEC_OP_AUD_FMT_ID_CEA861_CXT 1
931
932
933/* Audio Rate Control Feature */
934#define CEC_MSG_SET_AUDIO_RATE 0x9a
935/* Audio Rate Operand (audio_rate) */
936#define CEC_OP_AUD_RATE_OFF 0
937#define CEC_OP_AUD_RATE_WIDE_STD 1
938#define CEC_OP_AUD_RATE_WIDE_FAST 2
939#define CEC_OP_AUD_RATE_WIDE_SLOW 3
940#define CEC_OP_AUD_RATE_NARROW_STD 4
941#define CEC_OP_AUD_RATE_NARROW_FAST 5
942#define CEC_OP_AUD_RATE_NARROW_SLOW 6
943
944
945/* Audio Return Channel Control Feature */
946#define CEC_MSG_INITIATE_ARC 0xc0
947#define CEC_MSG_REPORT_ARC_INITIATED 0xc1
948#define CEC_MSG_REPORT_ARC_TERMINATED 0xc2
949#define CEC_MSG_REQUEST_ARC_INITIATION 0xc3
950#define CEC_MSG_REQUEST_ARC_TERMINATION 0xc4
951#define CEC_MSG_TERMINATE_ARC 0xc5
952
953
954/* Dynamic Audio Lipsync Feature */
955/* Only for CEC 2.0 and up */
956#define CEC_MSG_REQUEST_CURRENT_LATENCY 0xa7
957#define CEC_MSG_REPORT_CURRENT_LATENCY 0xa8
958/* Low Latency Mode Operand (low_latency_mode) */
959#define CEC_OP_LOW_LATENCY_MODE_OFF 0
960#define CEC_OP_LOW_LATENCY_MODE_ON 1
961/* Audio Output Compensated Operand (audio_out_compensated) */
962#define CEC_OP_AUD_OUT_COMPENSATED_NA 0
963#define CEC_OP_AUD_OUT_COMPENSATED_DELAY 1
964#define CEC_OP_AUD_OUT_COMPENSATED_NO_DELAY 2
965#define CEC_OP_AUD_OUT_COMPENSATED_PARTIAL_DELAY 3
966
967
968/* Capability Discovery and Control Feature */
969#define CEC_MSG_CDC_MESSAGE 0xf8
970/* Ethernet-over-HDMI: nobody ever does this... */
971#define CEC_MSG_CDC_HEC_INQUIRE_STATE 0x00
972#define CEC_MSG_CDC_HEC_REPORT_STATE 0x01
973/* HEC Functionality State Operand (hec_func_state) */
974#define CEC_OP_HEC_FUNC_STATE_NOT_SUPPORTED 0
975#define CEC_OP_HEC_FUNC_STATE_INACTIVE 1
976#define CEC_OP_HEC_FUNC_STATE_ACTIVE 2
977#define CEC_OP_HEC_FUNC_STATE_ACTIVATION_FIELD 3
978/* Host Functionality State Operand (host_func_state) */
979#define CEC_OP_HOST_FUNC_STATE_NOT_SUPPORTED 0
980#define CEC_OP_HOST_FUNC_STATE_INACTIVE 1
981#define CEC_OP_HOST_FUNC_STATE_ACTIVE 2
982/* ENC Functionality State Operand (enc_func_state) */
983#define CEC_OP_ENC_FUNC_STATE_EXT_CON_NOT_SUPPORTED 0
984#define CEC_OP_ENC_FUNC_STATE_EXT_CON_INACTIVE 1
985#define CEC_OP_ENC_FUNC_STATE_EXT_CON_ACTIVE 2
986/* CDC Error Code Operand (cdc_errcode) */
987#define CEC_OP_CDC_ERROR_CODE_NONE 0
988#define CEC_OP_CDC_ERROR_CODE_CAP_UNSUPPORTED 1
989#define CEC_OP_CDC_ERROR_CODE_WRONG_STATE 2
990#define CEC_OP_CDC_ERROR_CODE_OTHER 3
991/* HEC Support Operand (hec_support) */
992#define CEC_OP_HEC_SUPPORT_NO 0
993#define CEC_OP_HEC_SUPPORT_YES 1
994/* HEC Activation Operand (hec_activation) */
995#define CEC_OP_HEC_ACTIVATION_ON 0
996#define CEC_OP_HEC_ACTIVATION_OFF 1
997
998#define CEC_MSG_CDC_HEC_SET_STATE_ADJACENT 0x02
999#define CEC_MSG_CDC_HEC_SET_STATE 0x03
1000/* HEC Set State Operand (hec_set_state) */
1001#define CEC_OP_HEC_SET_STATE_DEACTIVATE 0
1002#define CEC_OP_HEC_SET_STATE_ACTIVATE 1
1003
1004#define CEC_MSG_CDC_HEC_REQUEST_DEACTIVATION 0x04
1005#define CEC_MSG_CDC_HEC_NOTIFY_ALIVE 0x05
1006#define CEC_MSG_CDC_HEC_DISCOVER 0x06
1007/* Hotplug Detect messages */
1008#define CEC_MSG_CDC_HPD_SET_STATE 0x10
1009/* HPD State Operand (hpd_state) */
1010#define CEC_OP_HPD_STATE_CP_EDID_DISABLE 0
1011#define CEC_OP_HPD_STATE_CP_EDID_ENABLE 1
1012#define CEC_OP_HPD_STATE_CP_EDID_DISABLE_ENABLE 2
1013#define CEC_OP_HPD_STATE_EDID_DISABLE 3
1014#define CEC_OP_HPD_STATE_EDID_ENABLE 4
1015#define CEC_OP_HPD_STATE_EDID_DISABLE_ENABLE 5
1016#define CEC_MSG_CDC_HPD_REPORT_STATE 0x11
1017/* HPD Error Code Operand (hpd_error) */
1018#define CEC_OP_HPD_ERROR_NONE 0
1019#define CEC_OP_HPD_ERROR_INITIATOR_NOT_CAPABLE 1
1020#define CEC_OP_HPD_ERROR_INITIATOR_WRONG_STATE 2
1021#define CEC_OP_HPD_ERROR_OTHER 3
1022#define CEC_OP_HPD_ERROR_NONE_NO_VIDEO 4
1023
Hans Verkuila69a1682016-11-02 07:41:41 -02001024/* End of Messages */
1025
1026/* Helper functions to identify the 'special' CEC devices */
1027
Hans Verkuil3145c752016-11-04 08:23:27 -02001028static inline int cec_is_2nd_tv(const struct cec_log_addrs *las)
Hans Verkuila69a1682016-11-02 07:41:41 -02001029{
1030 /*
1031 * It is a second TV if the logical address is 14 or 15 and the
1032 * primary device type is a TV.
1033 */
1034 return las->num_log_addrs &&
1035 las->log_addr[0] >= CEC_LOG_ADDR_SPECIFIC &&
1036 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_TV;
1037}
1038
Hans Verkuil3145c752016-11-04 08:23:27 -02001039static inline int cec_is_processor(const struct cec_log_addrs *las)
Hans Verkuila69a1682016-11-02 07:41:41 -02001040{
1041 /*
1042 * It is a processor if the logical address is 12-15 and the
1043 * primary device type is a Processor.
1044 */
1045 return las->num_log_addrs &&
1046 las->log_addr[0] >= CEC_LOG_ADDR_BACKUP_1 &&
1047 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_PROCESSOR;
1048}
1049
Hans Verkuil3145c752016-11-04 08:23:27 -02001050static inline int cec_is_switch(const struct cec_log_addrs *las)
Hans Verkuila69a1682016-11-02 07:41:41 -02001051{
1052 /*
1053 * It is a switch if the logical address is 15 and the
1054 * primary device type is a Switch and the CDC-Only flag is not set.
1055 */
1056 return las->num_log_addrs == 1 &&
1057 las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1058 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1059 !(las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1060}
1061
Hans Verkuil3145c752016-11-04 08:23:27 -02001062static inline int cec_is_cdc_only(const struct cec_log_addrs *las)
Hans Verkuila69a1682016-11-02 07:41:41 -02001063{
1064 /*
1065 * It is a CDC-only device if the logical address is 15 and the
1066 * primary device type is a Switch and the CDC-Only flag is set.
1067 */
1068 return las->num_log_addrs == 1 &&
1069 las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1070 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1071 (las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1072}
1073
Hans Verkuil31325832016-06-17 09:17:57 -03001074#endif