cec.h 35 KB

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