cec.h 37 KB

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