cec.h 36 KB

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