cec.h 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206
  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. /**
  135. * cec_msg_recv_is_tx_result - return true if this message contains the
  136. * result of an earlier non-blocking transmit
  137. * @msg: the message structure from CEC_RECEIVE
  138. */
  139. static __inline__ int cec_msg_recv_is_tx_result(const struct cec_msg *msg)
  140. {
  141. return msg->sequence && msg->tx_status && !msg->rx_status;
  142. }
  143. /**
  144. * cec_msg_recv_is_rx_result - return true if this message contains the
  145. * reply of an earlier non-blocking transmit
  146. * @msg: the message structure from CEC_RECEIVE
  147. */
  148. static __inline__ int cec_msg_recv_is_rx_result(const struct cec_msg *msg)
  149. {
  150. return msg->sequence && !msg->tx_status && msg->rx_status;
  151. }
  152. /* cec_msg flags field */
  153. #define CEC_MSG_FL_REPLY_TO_FOLLOWERS (1 << 0)
  154. #define CEC_MSG_FL_RAW (1 << 1)
  155. /* cec_msg tx/rx_status field */
  156. #define CEC_TX_STATUS_OK (1 << 0)
  157. #define CEC_TX_STATUS_ARB_LOST (1 << 1)
  158. #define CEC_TX_STATUS_NACK (1 << 2)
  159. #define CEC_TX_STATUS_LOW_DRIVE (1 << 3)
  160. #define CEC_TX_STATUS_ERROR (1 << 4)
  161. #define CEC_TX_STATUS_MAX_RETRIES (1 << 5)
  162. #define CEC_TX_STATUS_ABORTED (1 << 6)
  163. #define CEC_TX_STATUS_TIMEOUT (1 << 7)
  164. #define CEC_RX_STATUS_OK (1 << 0)
  165. #define CEC_RX_STATUS_TIMEOUT (1 << 1)
  166. #define CEC_RX_STATUS_FEATURE_ABORT (1 << 2)
  167. #define CEC_RX_STATUS_ABORTED (1 << 3)
  168. static __inline__ int cec_msg_status_is_ok(const struct cec_msg *msg)
  169. {
  170. if (msg->tx_status && !(msg->tx_status & CEC_TX_STATUS_OK))
  171. return 0;
  172. if (msg->rx_status && !(msg->rx_status & CEC_RX_STATUS_OK))
  173. return 0;
  174. if (!msg->tx_status && !msg->rx_status)
  175. return 0;
  176. return !(msg->rx_status & CEC_RX_STATUS_FEATURE_ABORT);
  177. }
  178. #define CEC_LOG_ADDR_INVALID 0xff
  179. #define CEC_PHYS_ADDR_INVALID 0xffff
  180. /*
  181. * The maximum number of logical addresses one device can be assigned to.
  182. * The CEC 2.0 spec allows for only 2 logical addresses at the moment. The
  183. * Analog Devices CEC hardware supports 3. So let's go wild and go for 4.
  184. */
  185. #define CEC_MAX_LOG_ADDRS 4
  186. /* The logical addresses defined by CEC 2.0 */
  187. #define CEC_LOG_ADDR_TV 0
  188. #define CEC_LOG_ADDR_RECORD_1 1
  189. #define CEC_LOG_ADDR_RECORD_2 2
  190. #define CEC_LOG_ADDR_TUNER_1 3
  191. #define CEC_LOG_ADDR_PLAYBACK_1 4
  192. #define CEC_LOG_ADDR_AUDIOSYSTEM 5
  193. #define CEC_LOG_ADDR_TUNER_2 6
  194. #define CEC_LOG_ADDR_TUNER_3 7
  195. #define CEC_LOG_ADDR_PLAYBACK_2 8
  196. #define CEC_LOG_ADDR_RECORD_3 9
  197. #define CEC_LOG_ADDR_TUNER_4 10
  198. #define CEC_LOG_ADDR_PLAYBACK_3 11
  199. #define CEC_LOG_ADDR_BACKUP_1 12
  200. #define CEC_LOG_ADDR_BACKUP_2 13
  201. #define CEC_LOG_ADDR_SPECIFIC 14
  202. #define CEC_LOG_ADDR_UNREGISTERED 15 /* as initiator address */
  203. #define CEC_LOG_ADDR_BROADCAST 15 /* as destination address */
  204. /* The logical address types that the CEC device wants to claim */
  205. #define CEC_LOG_ADDR_TYPE_TV 0
  206. #define CEC_LOG_ADDR_TYPE_RECORD 1
  207. #define CEC_LOG_ADDR_TYPE_TUNER 2
  208. #define CEC_LOG_ADDR_TYPE_PLAYBACK 3
  209. #define CEC_LOG_ADDR_TYPE_AUDIOSYSTEM 4
  210. #define CEC_LOG_ADDR_TYPE_SPECIFIC 5
  211. #define CEC_LOG_ADDR_TYPE_UNREGISTERED 6
  212. /*
  213. * Switches should use UNREGISTERED.
  214. * Processors should use SPECIFIC.
  215. */
  216. #define CEC_LOG_ADDR_MASK_TV (1 << CEC_LOG_ADDR_TV)
  217. #define CEC_LOG_ADDR_MASK_RECORD ((1 << CEC_LOG_ADDR_RECORD_1) | \
  218. (1 << CEC_LOG_ADDR_RECORD_2) | \
  219. (1 << CEC_LOG_ADDR_RECORD_3))
  220. #define CEC_LOG_ADDR_MASK_TUNER ((1 << CEC_LOG_ADDR_TUNER_1) | \
  221. (1 << CEC_LOG_ADDR_TUNER_2) | \
  222. (1 << CEC_LOG_ADDR_TUNER_3) | \
  223. (1 << CEC_LOG_ADDR_TUNER_4))
  224. #define CEC_LOG_ADDR_MASK_PLAYBACK ((1 << CEC_LOG_ADDR_PLAYBACK_1) | \
  225. (1 << CEC_LOG_ADDR_PLAYBACK_2) | \
  226. (1 << CEC_LOG_ADDR_PLAYBACK_3))
  227. #define CEC_LOG_ADDR_MASK_AUDIOSYSTEM (1 << CEC_LOG_ADDR_AUDIOSYSTEM)
  228. #define CEC_LOG_ADDR_MASK_BACKUP ((1 << CEC_LOG_ADDR_BACKUP_1) | \
  229. (1 << CEC_LOG_ADDR_BACKUP_2))
  230. #define CEC_LOG_ADDR_MASK_SPECIFIC (1 << CEC_LOG_ADDR_SPECIFIC)
  231. #define CEC_LOG_ADDR_MASK_UNREGISTERED (1 << CEC_LOG_ADDR_UNREGISTERED)
  232. static __inline__ int cec_has_tv(__u16 log_addr_mask)
  233. {
  234. return log_addr_mask & CEC_LOG_ADDR_MASK_TV;
  235. }
  236. static __inline__ int cec_has_record(__u16 log_addr_mask)
  237. {
  238. return log_addr_mask & CEC_LOG_ADDR_MASK_RECORD;
  239. }
  240. static __inline__ int cec_has_tuner(__u16 log_addr_mask)
  241. {
  242. return log_addr_mask & CEC_LOG_ADDR_MASK_TUNER;
  243. }
  244. static __inline__ int cec_has_playback(__u16 log_addr_mask)
  245. {
  246. return log_addr_mask & CEC_LOG_ADDR_MASK_PLAYBACK;
  247. }
  248. static __inline__ int cec_has_audiosystem(__u16 log_addr_mask)
  249. {
  250. return log_addr_mask & CEC_LOG_ADDR_MASK_AUDIOSYSTEM;
  251. }
  252. static __inline__ int cec_has_backup(__u16 log_addr_mask)
  253. {
  254. return log_addr_mask & CEC_LOG_ADDR_MASK_BACKUP;
  255. }
  256. static __inline__ int cec_has_specific(__u16 log_addr_mask)
  257. {
  258. return log_addr_mask & CEC_LOG_ADDR_MASK_SPECIFIC;
  259. }
  260. static __inline__ int cec_is_unregistered(__u16 log_addr_mask)
  261. {
  262. return log_addr_mask & CEC_LOG_ADDR_MASK_UNREGISTERED;
  263. }
  264. static __inline__ int cec_is_unconfigured(__u16 log_addr_mask)
  265. {
  266. return log_addr_mask == 0;
  267. }
  268. /*
  269. * Use this if there is no vendor ID (CEC_G_VENDOR_ID) or if the vendor ID
  270. * should be disabled (CEC_S_VENDOR_ID)
  271. */
  272. #define CEC_VENDOR_ID_NONE 0xffffffff
  273. /* The message handling modes */
  274. /* Modes for initiator */
  275. #define CEC_MODE_NO_INITIATOR (0x0 << 0)
  276. #define CEC_MODE_INITIATOR (0x1 << 0)
  277. #define CEC_MODE_EXCL_INITIATOR (0x2 << 0)
  278. #define CEC_MODE_INITIATOR_MSK 0x0f
  279. /* Modes for follower */
  280. #define CEC_MODE_NO_FOLLOWER (0x0 << 4)
  281. #define CEC_MODE_FOLLOWER (0x1 << 4)
  282. #define CEC_MODE_EXCL_FOLLOWER (0x2 << 4)
  283. #define CEC_MODE_EXCL_FOLLOWER_PASSTHRU (0x3 << 4)
  284. #define CEC_MODE_MONITOR_PIN (0xd << 4)
  285. #define CEC_MODE_MONITOR (0xe << 4)
  286. #define CEC_MODE_MONITOR_ALL (0xf << 4)
  287. #define CEC_MODE_FOLLOWER_MSK 0xf0
  288. /* Userspace has to configure the physical address */
  289. #define CEC_CAP_PHYS_ADDR (1 << 0)
  290. /* Userspace has to configure the logical addresses */
  291. #define CEC_CAP_LOG_ADDRS (1 << 1)
  292. /* Userspace can transmit messages (and thus become follower as well) */
  293. #define CEC_CAP_TRANSMIT (1 << 2)
  294. /*
  295. * Passthrough all messages instead of processing them.
  296. */
  297. #define CEC_CAP_PASSTHROUGH (1 << 3)
  298. /* Supports remote control */
  299. #define CEC_CAP_RC (1 << 4)
  300. /* Hardware can monitor all messages, not just directed and broadcast. */
  301. #define CEC_CAP_MONITOR_ALL (1 << 5)
  302. /* Hardware can use CEC only if the HDMI HPD pin is high. */
  303. #define CEC_CAP_NEEDS_HPD (1 << 6)
  304. /* Hardware can monitor CEC pin transitions */
  305. #define CEC_CAP_MONITOR_PIN (1 << 7)
  306. /* CEC_ADAP_G_CONNECTOR_INFO is available */
  307. #define CEC_CAP_CONNECTOR_INFO (1 << 8)
  308. /**
  309. * struct cec_caps - CEC capabilities structure.
  310. * @driver: name of the CEC device driver.
  311. * @name: name of the CEC device. @driver + @name must be unique.
  312. * @available_log_addrs: number of available logical addresses.
  313. * @capabilities: capabilities of the CEC adapter.
  314. * @version: version of the CEC adapter framework.
  315. */
  316. struct cec_caps {
  317. char driver[32];
  318. char name[32];
  319. __u32 available_log_addrs;
  320. __u32 capabilities;
  321. __u32 version;
  322. };
  323. /**
  324. * struct cec_log_addrs - CEC logical addresses structure.
  325. * @log_addr: the claimed logical addresses. Set by the driver.
  326. * @log_addr_mask: current logical address mask. Set by the driver.
  327. * @cec_version: the CEC version that the adapter should implement. Set by the
  328. * caller.
  329. * @num_log_addrs: how many logical addresses should be claimed. Set by the
  330. * caller.
  331. * @vendor_id: the vendor ID of the device. Set by the caller.
  332. * @flags: flags.
  333. * @osd_name: the OSD name of the device. Set by the caller.
  334. * @primary_device_type: the primary device type for each logical address.
  335. * Set by the caller.
  336. * @log_addr_type: the logical address types. Set by the caller.
  337. * @all_device_types: CEC 2.0: all device types represented by the logical
  338. * address. Set by the caller.
  339. * @features: CEC 2.0: The logical address features. Set by the caller.
  340. */
  341. struct cec_log_addrs {
  342. __u8 log_addr[CEC_MAX_LOG_ADDRS];
  343. __u16 log_addr_mask;
  344. __u8 cec_version;
  345. __u8 num_log_addrs;
  346. __u32 vendor_id;
  347. __u32 flags;
  348. char osd_name[15];
  349. __u8 primary_device_type[CEC_MAX_LOG_ADDRS];
  350. __u8 log_addr_type[CEC_MAX_LOG_ADDRS];
  351. /* CEC 2.0 */
  352. __u8 all_device_types[CEC_MAX_LOG_ADDRS];
  353. __u8 features[CEC_MAX_LOG_ADDRS][12];
  354. };
  355. /* Allow a fallback to unregistered */
  356. #define CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK (1 << 0)
  357. /* Passthrough RC messages to the input subsystem */
  358. #define CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU (1 << 1)
  359. /* CDC-Only device: supports only CDC messages */
  360. #define CEC_LOG_ADDRS_FL_CDC_ONLY (1 << 2)
  361. /**
  362. * struct cec_drm_connector_info - tells which drm connector is
  363. * associated with the CEC adapter.
  364. * @card_no: drm card number
  365. * @connector_id: drm connector ID
  366. */
  367. struct cec_drm_connector_info {
  368. __u32 card_no;
  369. __u32 connector_id;
  370. };
  371. #define CEC_CONNECTOR_TYPE_NO_CONNECTOR 0
  372. #define CEC_CONNECTOR_TYPE_DRM 1
  373. /**
  374. * struct cec_connector_info - tells if and which connector is
  375. * associated with the CEC adapter.
  376. * @type: connector type (if any)
  377. * @drm: drm connector info
  378. * @raw: array to pad the union
  379. */
  380. struct cec_connector_info {
  381. __u32 type;
  382. union {
  383. struct cec_drm_connector_info drm;
  384. __u32 raw[16];
  385. };
  386. };
  387. /* Events */
  388. /* Event that occurs when the adapter state changes */
  389. #define CEC_EVENT_STATE_CHANGE 1
  390. /*
  391. * This event is sent when messages are lost because the application
  392. * didn't empty the message queue in time
  393. */
  394. #define CEC_EVENT_LOST_MSGS 2
  395. #define CEC_EVENT_PIN_CEC_LOW 3
  396. #define CEC_EVENT_PIN_CEC_HIGH 4
  397. #define CEC_EVENT_PIN_HPD_LOW 5
  398. #define CEC_EVENT_PIN_HPD_HIGH 6
  399. #define CEC_EVENT_PIN_5V_LOW 7
  400. #define CEC_EVENT_PIN_5V_HIGH 8
  401. #define CEC_EVENT_FL_INITIAL_STATE (1 << 0)
  402. #define CEC_EVENT_FL_DROPPED_EVENTS (1 << 1)
  403. /**
  404. * struct cec_event_state_change - used when the CEC adapter changes state.
  405. * @phys_addr: the current physical address
  406. * @log_addr_mask: the current logical address mask
  407. * @have_conn_info: if non-zero, then HDMI connector information is available.
  408. * This field is only valid if CEC_CAP_CONNECTOR_INFO is set. If that
  409. * capability is set and @have_conn_info is zero, then that indicates
  410. * that the HDMI connector device is not instantiated, either because
  411. * the HDMI driver is still configuring the device or because the HDMI
  412. * device was unbound.
  413. */
  414. struct cec_event_state_change {
  415. __u16 phys_addr;
  416. __u16 log_addr_mask;
  417. __u16 have_conn_info;
  418. };
  419. /**
  420. * struct cec_event_lost_msgs - tells you how many messages were lost.
  421. * @lost_msgs: how many messages were lost.
  422. */
  423. struct cec_event_lost_msgs {
  424. __u32 lost_msgs;
  425. };
  426. /**
  427. * struct cec_event - CEC event structure
  428. * @ts: the timestamp of when the event was sent.
  429. * @event: the event.
  430. * @flags: event flags.
  431. * @state_change: the event payload for CEC_EVENT_STATE_CHANGE.
  432. * @lost_msgs: the event payload for CEC_EVENT_LOST_MSGS.
  433. * @raw: array to pad the union.
  434. */
  435. struct cec_event {
  436. __u64 ts;
  437. __u32 event;
  438. __u32 flags;
  439. union {
  440. struct cec_event_state_change state_change;
  441. struct cec_event_lost_msgs lost_msgs;
  442. __u32 raw[16];
  443. };
  444. };
  445. /* ioctls */
  446. /* Adapter capabilities */
  447. #define CEC_ADAP_G_CAPS _IOWR('a', 0, struct cec_caps)
  448. /*
  449. * phys_addr is either 0 (if this is the CEC root device)
  450. * or a valid physical address obtained from the sink's EDID
  451. * as read by this CEC device (if this is a source device)
  452. * or a physical address obtained and modified from a sink
  453. * EDID and used for a sink CEC device.
  454. * If nothing is connected, then phys_addr is 0xffff.
  455. * See HDMI 1.4b, section 8.7 (Physical Address).
  456. *
  457. * The CEC_ADAP_S_PHYS_ADDR ioctl may not be available if that is handled
  458. * internally.
  459. */
  460. #define CEC_ADAP_G_PHYS_ADDR _IOR('a', 1, __u16)
  461. #define CEC_ADAP_S_PHYS_ADDR _IOW('a', 2, __u16)
  462. /*
  463. * Configure the CEC adapter. It sets the device type and which
  464. * logical types it will try to claim. It will return which
  465. * logical addresses it could actually claim.
  466. * An error is returned if the adapter is disabled or if there
  467. * is no physical address assigned.
  468. */
  469. #define CEC_ADAP_G_LOG_ADDRS _IOR('a', 3, struct cec_log_addrs)
  470. #define CEC_ADAP_S_LOG_ADDRS _IOWR('a', 4, struct cec_log_addrs)
  471. /* Transmit/receive a CEC command */
  472. #define CEC_TRANSMIT _IOWR('a', 5, struct cec_msg)
  473. #define CEC_RECEIVE _IOWR('a', 6, struct cec_msg)
  474. /* Dequeue CEC events */
  475. #define CEC_DQEVENT _IOWR('a', 7, struct cec_event)
  476. /*
  477. * Get and set the message handling mode for this filehandle.
  478. */
  479. #define CEC_G_MODE _IOR('a', 8, __u32)
  480. #define CEC_S_MODE _IOW('a', 9, __u32)
  481. /* Get the connector info */
  482. #define CEC_ADAP_G_CONNECTOR_INFO _IOR('a', 10, struct cec_connector_info)
  483. /*
  484. * The remainder of this header defines all CEC messages and operands.
  485. * The format matters since it the cec-ctl utility parses it to generate
  486. * code for implementing all these messages.
  487. *
  488. * Comments ending with 'Feature' group messages for each feature.
  489. * If messages are part of multiple features, then the "Has also"
  490. * comment is used to list the previously defined messages that are
  491. * supported by the feature.
  492. *
  493. * Before operands are defined a comment is added that gives the
  494. * name of the operand and in brackets the variable name of the
  495. * corresponding argument in the cec-funcs.h function.
  496. */
  497. /* Messages */
  498. /* One Touch Play Feature */
  499. #define CEC_MSG_ACTIVE_SOURCE 0x82
  500. #define CEC_MSG_IMAGE_VIEW_ON 0x04
  501. #define CEC_MSG_TEXT_VIEW_ON 0x0d
  502. /* Routing Control Feature */
  503. /*
  504. * Has also:
  505. * CEC_MSG_ACTIVE_SOURCE
  506. */
  507. #define CEC_MSG_INACTIVE_SOURCE 0x9d
  508. #define CEC_MSG_REQUEST_ACTIVE_SOURCE 0x85
  509. #define CEC_MSG_ROUTING_CHANGE 0x80
  510. #define CEC_MSG_ROUTING_INFORMATION 0x81
  511. #define CEC_MSG_SET_STREAM_PATH 0x86
  512. /* Standby Feature */
  513. #define CEC_MSG_STANDBY 0x36
  514. /* One Touch Record Feature */
  515. #define CEC_MSG_RECORD_OFF 0x0b
  516. #define CEC_MSG_RECORD_ON 0x09
  517. /* Record Source Type Operand (rec_src_type) */
  518. #define CEC_OP_RECORD_SRC_OWN 1
  519. #define CEC_OP_RECORD_SRC_DIGITAL 2
  520. #define CEC_OP_RECORD_SRC_ANALOG 3
  521. #define CEC_OP_RECORD_SRC_EXT_PLUG 4
  522. #define CEC_OP_RECORD_SRC_EXT_PHYS_ADDR 5
  523. /* Service Identification Method Operand (service_id_method) */
  524. #define CEC_OP_SERVICE_ID_METHOD_BY_DIG_ID 0
  525. #define CEC_OP_SERVICE_ID_METHOD_BY_CHANNEL 1
  526. /* Digital Service Broadcast System Operand (dig_bcast_system) */
  527. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_GEN 0x00
  528. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_GEN 0x01
  529. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_GEN 0x02
  530. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_BS 0x08
  531. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_CS 0x09
  532. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_T 0x0a
  533. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_CABLE 0x10
  534. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_SAT 0x11
  535. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_T 0x12
  536. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_C 0x18
  537. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S 0x19
  538. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S2 0x1a
  539. #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_T 0x1b
  540. /* Analogue Broadcast Type Operand (ana_bcast_type) */
  541. #define CEC_OP_ANA_BCAST_TYPE_CABLE 0
  542. #define CEC_OP_ANA_BCAST_TYPE_SATELLITE 1
  543. #define CEC_OP_ANA_BCAST_TYPE_TERRESTRIAL 2
  544. /* Broadcast System Operand (bcast_system) */
  545. #define CEC_OP_BCAST_SYSTEM_PAL_BG 0x00
  546. #define CEC_OP_BCAST_SYSTEM_SECAM_LQ 0x01 /* SECAM L' */
  547. #define CEC_OP_BCAST_SYSTEM_PAL_M 0x02
  548. #define CEC_OP_BCAST_SYSTEM_NTSC_M 0x03
  549. #define CEC_OP_BCAST_SYSTEM_PAL_I 0x04
  550. #define CEC_OP_BCAST_SYSTEM_SECAM_DK 0x05
  551. #define CEC_OP_BCAST_SYSTEM_SECAM_BG 0x06
  552. #define CEC_OP_BCAST_SYSTEM_SECAM_L 0x07
  553. #define CEC_OP_BCAST_SYSTEM_PAL_DK 0x08
  554. #define CEC_OP_BCAST_SYSTEM_OTHER 0x1f
  555. /* Channel Number Format Operand (channel_number_fmt) */
  556. #define CEC_OP_CHANNEL_NUMBER_FMT_1_PART 0x01
  557. #define CEC_OP_CHANNEL_NUMBER_FMT_2_PART 0x02
  558. #define CEC_MSG_RECORD_STATUS 0x0a
  559. /* Record Status Operand (rec_status) */
  560. #define CEC_OP_RECORD_STATUS_CUR_SRC 0x01
  561. #define CEC_OP_RECORD_STATUS_DIG_SERVICE 0x02
  562. #define CEC_OP_RECORD_STATUS_ANA_SERVICE 0x03
  563. #define CEC_OP_RECORD_STATUS_EXT_INPUT 0x04
  564. #define CEC_OP_RECORD_STATUS_NO_DIG_SERVICE 0x05
  565. #define CEC_OP_RECORD_STATUS_NO_ANA_SERVICE 0x06
  566. #define CEC_OP_RECORD_STATUS_NO_SERVICE 0x07
  567. #define CEC_OP_RECORD_STATUS_INVALID_EXT_PLUG 0x09
  568. #define CEC_OP_RECORD_STATUS_INVALID_EXT_PHYS_ADDR 0x0a
  569. #define CEC_OP_RECORD_STATUS_UNSUP_CA 0x0b
  570. #define CEC_OP_RECORD_STATUS_NO_CA_ENTITLEMENTS 0x0c
  571. #define CEC_OP_RECORD_STATUS_CANT_COPY_SRC 0x0d
  572. #define CEC_OP_RECORD_STATUS_NO_MORE_COPIES 0x0e
  573. #define CEC_OP_RECORD_STATUS_NO_MEDIA 0x10
  574. #define CEC_OP_RECORD_STATUS_PLAYING 0x11
  575. #define CEC_OP_RECORD_STATUS_ALREADY_RECORDING 0x12
  576. #define CEC_OP_RECORD_STATUS_MEDIA_PROT 0x13
  577. #define CEC_OP_RECORD_STATUS_NO_SIGNAL 0x14
  578. #define CEC_OP_RECORD_STATUS_MEDIA_PROBLEM 0x15
  579. #define CEC_OP_RECORD_STATUS_NO_SPACE 0x16
  580. #define CEC_OP_RECORD_STATUS_PARENTAL_LOCK 0x17
  581. #define CEC_OP_RECORD_STATUS_TERMINATED_OK 0x1a
  582. #define CEC_OP_RECORD_STATUS_ALREADY_TERM 0x1b
  583. #define CEC_OP_RECORD_STATUS_OTHER 0x1f
  584. #define CEC_MSG_RECORD_TV_SCREEN 0x0f
  585. /* Timer Programming Feature */
  586. #define CEC_MSG_CLEAR_ANALOGUE_TIMER 0x33
  587. /* Recording Sequence Operand (recording_seq) */
  588. #define CEC_OP_REC_SEQ_SUNDAY 0x01
  589. #define CEC_OP_REC_SEQ_MONDAY 0x02
  590. #define CEC_OP_REC_SEQ_TUESDAY 0x04
  591. #define CEC_OP_REC_SEQ_WEDNESDAY 0x08
  592. #define CEC_OP_REC_SEQ_THURSDAY 0x10
  593. #define CEC_OP_REC_SEQ_FRIDAY 0x20
  594. #define CEC_OP_REC_SEQ_SATURDAY 0x40
  595. #define CEC_OP_REC_SEQ_ONCE_ONLY 0x00
  596. #define CEC_MSG_CLEAR_DIGITAL_TIMER 0x99
  597. #define CEC_MSG_CLEAR_EXT_TIMER 0xa1
  598. /* External Source Specifier Operand (ext_src_spec) */
  599. #define CEC_OP_EXT_SRC_PLUG 0x04
  600. #define CEC_OP_EXT_SRC_PHYS_ADDR 0x05
  601. #define CEC_MSG_SET_ANALOGUE_TIMER 0x34
  602. #define CEC_MSG_SET_DIGITAL_TIMER 0x97
  603. #define CEC_MSG_SET_EXT_TIMER 0xa2
  604. #define CEC_MSG_SET_TIMER_PROGRAM_TITLE 0x67
  605. #define CEC_MSG_TIMER_CLEARED_STATUS 0x43
  606. /* Timer Cleared Status Data Operand (timer_cleared_status) */
  607. #define CEC_OP_TIMER_CLR_STAT_RECORDING 0x00
  608. #define CEC_OP_TIMER_CLR_STAT_NO_MATCHING 0x01
  609. #define CEC_OP_TIMER_CLR_STAT_NO_INFO 0x02
  610. #define CEC_OP_TIMER_CLR_STAT_CLEARED 0x80
  611. #define CEC_MSG_TIMER_STATUS 0x35
  612. /* Timer Overlap Warning Operand (timer_overlap_warning) */
  613. #define CEC_OP_TIMER_OVERLAP_WARNING_NO_OVERLAP 0
  614. #define CEC_OP_TIMER_OVERLAP_WARNING_OVERLAP 1
  615. /* Media Info Operand (media_info) */
  616. #define CEC_OP_MEDIA_INFO_UNPROT_MEDIA 0
  617. #define CEC_OP_MEDIA_INFO_PROT_MEDIA 1
  618. #define CEC_OP_MEDIA_INFO_NO_MEDIA 2
  619. /* Programmed Indicator Operand (prog_indicator) */
  620. #define CEC_OP_PROG_IND_NOT_PROGRAMMED 0
  621. #define CEC_OP_PROG_IND_PROGRAMMED 1
  622. /* Programmed Info Operand (prog_info) */
  623. #define CEC_OP_PROG_INFO_ENOUGH_SPACE 0x08
  624. #define CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE 0x09
  625. #define CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE 0x0b
  626. #define CEC_OP_PROG_INFO_NONE_AVAILABLE 0x0a
  627. /* Not Programmed Error Info Operand (prog_error) */
  628. #define CEC_OP_PROG_ERROR_NO_FREE_TIMER 0x01
  629. #define CEC_OP_PROG_ERROR_DATE_OUT_OF_RANGE 0x02
  630. #define CEC_OP_PROG_ERROR_REC_SEQ_ERROR 0x03
  631. #define CEC_OP_PROG_ERROR_INV_EXT_PLUG 0x04
  632. #define CEC_OP_PROG_ERROR_INV_EXT_PHYS_ADDR 0x05
  633. #define CEC_OP_PROG_ERROR_CA_UNSUPP 0x06
  634. #define CEC_OP_PROG_ERROR_INSUF_CA_ENTITLEMENTS 0x07
  635. #define CEC_OP_PROG_ERROR_RESOLUTION_UNSUPP 0x08
  636. #define CEC_OP_PROG_ERROR_PARENTAL_LOCK 0x09
  637. #define CEC_OP_PROG_ERROR_CLOCK_FAILURE 0x0a
  638. #define CEC_OP_PROG_ERROR_DUPLICATE 0x0e
  639. /* System Information Feature */
  640. #define CEC_MSG_CEC_VERSION 0x9e
  641. /* CEC Version Operand (cec_version) */
  642. #define CEC_OP_CEC_VERSION_1_3A 4
  643. #define CEC_OP_CEC_VERSION_1_4 5
  644. #define CEC_OP_CEC_VERSION_2_0 6
  645. #define CEC_MSG_GET_CEC_VERSION 0x9f
  646. #define CEC_MSG_GIVE_PHYSICAL_ADDR 0x83
  647. #define CEC_MSG_GET_MENU_LANGUAGE 0x91
  648. #define CEC_MSG_REPORT_PHYSICAL_ADDR 0x84
  649. /* Primary Device Type Operand (prim_devtype) */
  650. #define CEC_OP_PRIM_DEVTYPE_TV 0
  651. #define CEC_OP_PRIM_DEVTYPE_RECORD 1
  652. #define CEC_OP_PRIM_DEVTYPE_TUNER 3
  653. #define CEC_OP_PRIM_DEVTYPE_PLAYBACK 4
  654. #define CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM 5
  655. #define CEC_OP_PRIM_DEVTYPE_SWITCH 6
  656. #define CEC_OP_PRIM_DEVTYPE_PROCESSOR 7
  657. #define CEC_MSG_SET_MENU_LANGUAGE 0x32
  658. #define CEC_MSG_REPORT_FEATURES 0xa6 /* HDMI 2.0 */
  659. /* All Device Types Operand (all_device_types) */
  660. #define CEC_OP_ALL_DEVTYPE_TV 0x80
  661. #define CEC_OP_ALL_DEVTYPE_RECORD 0x40
  662. #define CEC_OP_ALL_DEVTYPE_TUNER 0x20
  663. #define CEC_OP_ALL_DEVTYPE_PLAYBACK 0x10
  664. #define CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM 0x08
  665. #define CEC_OP_ALL_DEVTYPE_SWITCH 0x04
  666. /*
  667. * And if you wondering what happened to PROCESSOR devices: those should
  668. * be mapped to a SWITCH.
  669. */
  670. /* Valid for RC Profile and Device Feature operands */
  671. #define CEC_OP_FEAT_EXT 0x80 /* Extension bit */
  672. /* RC Profile Operand (rc_profile) */
  673. #define CEC_OP_FEAT_RC_TV_PROFILE_NONE 0x00
  674. #define CEC_OP_FEAT_RC_TV_PROFILE_1 0x02
  675. #define CEC_OP_FEAT_RC_TV_PROFILE_2 0x06
  676. #define CEC_OP_FEAT_RC_TV_PROFILE_3 0x0a
  677. #define CEC_OP_FEAT_RC_TV_PROFILE_4 0x0e
  678. #define CEC_OP_FEAT_RC_SRC_HAS_DEV_ROOT_MENU 0x50
  679. #define CEC_OP_FEAT_RC_SRC_HAS_DEV_SETUP_MENU 0x48
  680. #define CEC_OP_FEAT_RC_SRC_HAS_CONTENTS_MENU 0x44
  681. #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_TOP_MENU 0x42
  682. #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_CONTEXT_MENU 0x41
  683. /* Device Feature Operand (dev_features) */
  684. #define CEC_OP_FEAT_DEV_HAS_RECORD_TV_SCREEN 0x40
  685. #define CEC_OP_FEAT_DEV_HAS_SET_OSD_STRING 0x20
  686. #define CEC_OP_FEAT_DEV_HAS_DECK_CONTROL 0x10
  687. #define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_RATE 0x08
  688. #define CEC_OP_FEAT_DEV_SINK_HAS_ARC_TX 0x04
  689. #define CEC_OP_FEAT_DEV_SOURCE_HAS_ARC_RX 0x02
  690. #define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_VOLUME_LEVEL 0x01
  691. #define CEC_MSG_GIVE_FEATURES 0xa5 /* HDMI 2.0 */
  692. /* Deck Control Feature */
  693. #define CEC_MSG_DECK_CONTROL 0x42
  694. /* Deck Control Mode Operand (deck_control_mode) */
  695. #define CEC_OP_DECK_CTL_MODE_SKIP_FWD 1
  696. #define CEC_OP_DECK_CTL_MODE_SKIP_REV 2
  697. #define CEC_OP_DECK_CTL_MODE_STOP 3
  698. #define CEC_OP_DECK_CTL_MODE_EJECT 4
  699. #define CEC_MSG_DECK_STATUS 0x1b
  700. /* Deck Info Operand (deck_info) */
  701. #define CEC_OP_DECK_INFO_PLAY 0x11
  702. #define CEC_OP_DECK_INFO_RECORD 0x12
  703. #define CEC_OP_DECK_INFO_PLAY_REV 0x13
  704. #define CEC_OP_DECK_INFO_STILL 0x14
  705. #define CEC_OP_DECK_INFO_SLOW 0x15
  706. #define CEC_OP_DECK_INFO_SLOW_REV 0x16
  707. #define CEC_OP_DECK_INFO_FAST_FWD 0x17
  708. #define CEC_OP_DECK_INFO_FAST_REV 0x18
  709. #define CEC_OP_DECK_INFO_NO_MEDIA 0x19
  710. #define CEC_OP_DECK_INFO_STOP 0x1a
  711. #define CEC_OP_DECK_INFO_SKIP_FWD 0x1b
  712. #define CEC_OP_DECK_INFO_SKIP_REV 0x1c
  713. #define CEC_OP_DECK_INFO_INDEX_SEARCH_FWD 0x1d
  714. #define CEC_OP_DECK_INFO_INDEX_SEARCH_REV 0x1e
  715. #define CEC_OP_DECK_INFO_OTHER 0x1f
  716. #define CEC_MSG_GIVE_DECK_STATUS 0x1a
  717. /* Status Request Operand (status_req) */
  718. #define CEC_OP_STATUS_REQ_ON 1
  719. #define CEC_OP_STATUS_REQ_OFF 2
  720. #define CEC_OP_STATUS_REQ_ONCE 3
  721. #define CEC_MSG_PLAY 0x41
  722. /* Play Mode Operand (play_mode) */
  723. #define CEC_OP_PLAY_MODE_PLAY_FWD 0x24
  724. #define CEC_OP_PLAY_MODE_PLAY_REV 0x20
  725. #define CEC_OP_PLAY_MODE_PLAY_STILL 0x25
  726. #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MIN 0x05
  727. #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MED 0x06
  728. #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MAX 0x07
  729. #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MIN 0x09
  730. #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MED 0x0a
  731. #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MAX 0x0b
  732. #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MIN 0x15
  733. #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MED 0x16
  734. #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MAX 0x17
  735. #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MIN 0x19
  736. #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MED 0x1a
  737. #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MAX 0x1b
  738. /* Tuner Control Feature */
  739. #define CEC_MSG_GIVE_TUNER_DEVICE_STATUS 0x08
  740. #define CEC_MSG_SELECT_ANALOGUE_SERVICE 0x92
  741. #define CEC_MSG_SELECT_DIGITAL_SERVICE 0x93
  742. #define CEC_MSG_TUNER_DEVICE_STATUS 0x07
  743. /* Recording Flag Operand (rec_flag) */
  744. #define CEC_OP_REC_FLAG_NOT_USED 0
  745. #define CEC_OP_REC_FLAG_USED 1
  746. /* Tuner Display Info Operand (tuner_display_info) */
  747. #define CEC_OP_TUNER_DISPLAY_INFO_DIGITAL 0
  748. #define CEC_OP_TUNER_DISPLAY_INFO_NONE 1
  749. #define CEC_OP_TUNER_DISPLAY_INFO_ANALOGUE 2
  750. #define CEC_MSG_TUNER_STEP_DECREMENT 0x06
  751. #define CEC_MSG_TUNER_STEP_INCREMENT 0x05
  752. /* Vendor Specific Commands Feature */
  753. /*
  754. * Has also:
  755. * CEC_MSG_CEC_VERSION
  756. * CEC_MSG_GET_CEC_VERSION
  757. */
  758. #define CEC_MSG_DEVICE_VENDOR_ID 0x87
  759. #define CEC_MSG_GIVE_DEVICE_VENDOR_ID 0x8c
  760. #define CEC_MSG_VENDOR_COMMAND 0x89
  761. #define CEC_MSG_VENDOR_COMMAND_WITH_ID 0xa0
  762. #define CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN 0x8a
  763. #define CEC_MSG_VENDOR_REMOTE_BUTTON_UP 0x8b
  764. /* OSD Display Feature */
  765. #define CEC_MSG_SET_OSD_STRING 0x64
  766. /* Display Control Operand (disp_ctl) */
  767. #define CEC_OP_DISP_CTL_DEFAULT 0x00
  768. #define CEC_OP_DISP_CTL_UNTIL_CLEARED 0x40
  769. #define CEC_OP_DISP_CTL_CLEAR 0x80
  770. /* Device OSD Transfer Feature */
  771. #define CEC_MSG_GIVE_OSD_NAME 0x46
  772. #define CEC_MSG_SET_OSD_NAME 0x47
  773. /* Device Menu Control Feature */
  774. #define CEC_MSG_MENU_REQUEST 0x8d
  775. /* Menu Request Type Operand (menu_req) */
  776. #define CEC_OP_MENU_REQUEST_ACTIVATE 0x00
  777. #define CEC_OP_MENU_REQUEST_DEACTIVATE 0x01
  778. #define CEC_OP_MENU_REQUEST_QUERY 0x02
  779. #define CEC_MSG_MENU_STATUS 0x8e
  780. /* Menu State Operand (menu_state) */
  781. #define CEC_OP_MENU_STATE_ACTIVATED 0x00
  782. #define CEC_OP_MENU_STATE_DEACTIVATED 0x01
  783. #define CEC_MSG_USER_CONTROL_PRESSED 0x44
  784. /* UI Command Operand (ui_cmd) */
  785. #define CEC_OP_UI_CMD_SELECT 0x00
  786. #define CEC_OP_UI_CMD_UP 0x01
  787. #define CEC_OP_UI_CMD_DOWN 0x02
  788. #define CEC_OP_UI_CMD_LEFT 0x03
  789. #define CEC_OP_UI_CMD_RIGHT 0x04
  790. #define CEC_OP_UI_CMD_RIGHT_UP 0x05
  791. #define CEC_OP_UI_CMD_RIGHT_DOWN 0x06
  792. #define CEC_OP_UI_CMD_LEFT_UP 0x07
  793. #define CEC_OP_UI_CMD_LEFT_DOWN 0x08
  794. #define CEC_OP_UI_CMD_DEVICE_ROOT_MENU 0x09
  795. #define CEC_OP_UI_CMD_DEVICE_SETUP_MENU 0x0a
  796. #define CEC_OP_UI_CMD_CONTENTS_MENU 0x0b
  797. #define CEC_OP_UI_CMD_FAVORITE_MENU 0x0c
  798. #define CEC_OP_UI_CMD_BACK 0x0d
  799. #define CEC_OP_UI_CMD_MEDIA_TOP_MENU 0x10
  800. #define CEC_OP_UI_CMD_MEDIA_CONTEXT_SENSITIVE_MENU 0x11
  801. #define CEC_OP_UI_CMD_NUMBER_ENTRY_MODE 0x1d
  802. #define CEC_OP_UI_CMD_NUMBER_11 0x1e
  803. #define CEC_OP_UI_CMD_NUMBER_12 0x1f
  804. #define CEC_OP_UI_CMD_NUMBER_0_OR_NUMBER_10 0x20
  805. #define CEC_OP_UI_CMD_NUMBER_1 0x21
  806. #define CEC_OP_UI_CMD_NUMBER_2 0x22
  807. #define CEC_OP_UI_CMD_NUMBER_3 0x23
  808. #define CEC_OP_UI_CMD_NUMBER_4 0x24
  809. #define CEC_OP_UI_CMD_NUMBER_5 0x25
  810. #define CEC_OP_UI_CMD_NUMBER_6 0x26
  811. #define CEC_OP_UI_CMD_NUMBER_7 0x27
  812. #define CEC_OP_UI_CMD_NUMBER_8 0x28
  813. #define CEC_OP_UI_CMD_NUMBER_9 0x29
  814. #define CEC_OP_UI_CMD_DOT 0x2a
  815. #define CEC_OP_UI_CMD_ENTER 0x2b
  816. #define CEC_OP_UI_CMD_CLEAR 0x2c
  817. #define CEC_OP_UI_CMD_NEXT_FAVORITE 0x2f
  818. #define CEC_OP_UI_CMD_CHANNEL_UP 0x30
  819. #define CEC_OP_UI_CMD_CHANNEL_DOWN 0x31
  820. #define CEC_OP_UI_CMD_PREVIOUS_CHANNEL 0x32
  821. #define CEC_OP_UI_CMD_SOUND_SELECT 0x33
  822. #define CEC_OP_UI_CMD_INPUT_SELECT 0x34
  823. #define CEC_OP_UI_CMD_DISPLAY_INFORMATION 0x35
  824. #define CEC_OP_UI_CMD_HELP 0x36
  825. #define CEC_OP_UI_CMD_PAGE_UP 0x37
  826. #define CEC_OP_UI_CMD_PAGE_DOWN 0x38
  827. #define CEC_OP_UI_CMD_POWER 0x40
  828. #define CEC_OP_UI_CMD_VOLUME_UP 0x41
  829. #define CEC_OP_UI_CMD_VOLUME_DOWN 0x42
  830. #define CEC_OP_UI_CMD_MUTE 0x43
  831. #define CEC_OP_UI_CMD_PLAY 0x44
  832. #define CEC_OP_UI_CMD_STOP 0x45
  833. #define CEC_OP_UI_CMD_PAUSE 0x46
  834. #define CEC_OP_UI_CMD_RECORD 0x47
  835. #define CEC_OP_UI_CMD_REWIND 0x48
  836. #define CEC_OP_UI_CMD_FAST_FORWARD 0x49
  837. #define CEC_OP_UI_CMD_EJECT 0x4a
  838. #define CEC_OP_UI_CMD_SKIP_FORWARD 0x4b
  839. #define CEC_OP_UI_CMD_SKIP_BACKWARD 0x4c
  840. #define CEC_OP_UI_CMD_STOP_RECORD 0x4d
  841. #define CEC_OP_UI_CMD_PAUSE_RECORD 0x4e
  842. #define CEC_OP_UI_CMD_ANGLE 0x50
  843. #define CEC_OP_UI_CMD_SUB_PICTURE 0x51
  844. #define CEC_OP_UI_CMD_VIDEO_ON_DEMAND 0x52
  845. #define CEC_OP_UI_CMD_ELECTRONIC_PROGRAM_GUIDE 0x53
  846. #define CEC_OP_UI_CMD_TIMER_PROGRAMMING 0x54
  847. #define CEC_OP_UI_CMD_INITIAL_CONFIGURATION 0x55
  848. #define CEC_OP_UI_CMD_SELECT_BROADCAST_TYPE 0x56
  849. #define CEC_OP_UI_CMD_SELECT_SOUND_PRESENTATION 0x57
  850. #define CEC_OP_UI_CMD_AUDIO_DESCRIPTION 0x58
  851. #define CEC_OP_UI_CMD_INTERNET 0x59
  852. #define CEC_OP_UI_CMD_3D_MODE 0x5a
  853. #define CEC_OP_UI_CMD_PLAY_FUNCTION 0x60
  854. #define CEC_OP_UI_CMD_PAUSE_PLAY_FUNCTION 0x61
  855. #define CEC_OP_UI_CMD_RECORD_FUNCTION 0x62
  856. #define CEC_OP_UI_CMD_PAUSE_RECORD_FUNCTION 0x63
  857. #define CEC_OP_UI_CMD_STOP_FUNCTION 0x64
  858. #define CEC_OP_UI_CMD_MUTE_FUNCTION 0x65
  859. #define CEC_OP_UI_CMD_RESTORE_VOLUME_FUNCTION 0x66
  860. #define CEC_OP_UI_CMD_TUNE_FUNCTION 0x67
  861. #define CEC_OP_UI_CMD_SELECT_MEDIA_FUNCTION 0x68
  862. #define CEC_OP_UI_CMD_SELECT_AV_INPUT_FUNCTION 0x69
  863. #define CEC_OP_UI_CMD_SELECT_AUDIO_INPUT_FUNCTION 0x6a
  864. #define CEC_OP_UI_CMD_POWER_TOGGLE_FUNCTION 0x6b
  865. #define CEC_OP_UI_CMD_POWER_OFF_FUNCTION 0x6c
  866. #define CEC_OP_UI_CMD_POWER_ON_FUNCTION 0x6d
  867. #define CEC_OP_UI_CMD_F1_BLUE 0x71
  868. #define CEC_OP_UI_CMD_F2_RED 0x72
  869. #define CEC_OP_UI_CMD_F3_GREEN 0x73
  870. #define CEC_OP_UI_CMD_F4_YELLOW 0x74
  871. #define CEC_OP_UI_CMD_F5 0x75
  872. #define CEC_OP_UI_CMD_DATA 0x76
  873. /* UI Broadcast Type Operand (ui_bcast_type) */
  874. #define CEC_OP_UI_BCAST_TYPE_TOGGLE_ALL 0x00
  875. #define CEC_OP_UI_BCAST_TYPE_TOGGLE_DIG_ANA 0x01
  876. #define CEC_OP_UI_BCAST_TYPE_ANALOGUE 0x10
  877. #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_T 0x20
  878. #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_CABLE 0x30
  879. #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_SAT 0x40
  880. #define CEC_OP_UI_BCAST_TYPE_DIGITAL 0x50
  881. #define CEC_OP_UI_BCAST_TYPE_DIGITAL_T 0x60
  882. #define CEC_OP_UI_BCAST_TYPE_DIGITAL_CABLE 0x70
  883. #define CEC_OP_UI_BCAST_TYPE_DIGITAL_SAT 0x80
  884. #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT 0x90
  885. #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT2 0x91
  886. #define CEC_OP_UI_BCAST_TYPE_IP 0xa0
  887. /* UI Sound Presentation Control Operand (ui_snd_pres_ctl) */
  888. #define CEC_OP_UI_SND_PRES_CTL_DUAL_MONO 0x10
  889. #define CEC_OP_UI_SND_PRES_CTL_KARAOKE 0x20
  890. #define CEC_OP_UI_SND_PRES_CTL_DOWNMIX 0x80
  891. #define CEC_OP_UI_SND_PRES_CTL_REVERB 0x90
  892. #define CEC_OP_UI_SND_PRES_CTL_EQUALIZER 0xa0
  893. #define CEC_OP_UI_SND_PRES_CTL_BASS_UP 0xb1
  894. #define CEC_OP_UI_SND_PRES_CTL_BASS_NEUTRAL 0xb2
  895. #define CEC_OP_UI_SND_PRES_CTL_BASS_DOWN 0xb3
  896. #define CEC_OP_UI_SND_PRES_CTL_TREBLE_UP 0xc1
  897. #define CEC_OP_UI_SND_PRES_CTL_TREBLE_NEUTRAL 0xc2
  898. #define CEC_OP_UI_SND_PRES_CTL_TREBLE_DOWN 0xc3
  899. #define CEC_MSG_USER_CONTROL_RELEASED 0x45
  900. /* Remote Control Passthrough Feature */
  901. /*
  902. * Has also:
  903. * CEC_MSG_USER_CONTROL_PRESSED
  904. * CEC_MSG_USER_CONTROL_RELEASED
  905. */
  906. /* Power Status Feature */
  907. #define CEC_MSG_GIVE_DEVICE_POWER_STATUS 0x8f
  908. #define CEC_MSG_REPORT_POWER_STATUS 0x90
  909. /* Power Status Operand (pwr_state) */
  910. #define CEC_OP_POWER_STATUS_ON 0
  911. #define CEC_OP_POWER_STATUS_STANDBY 1
  912. #define CEC_OP_POWER_STATUS_TO_ON 2
  913. #define CEC_OP_POWER_STATUS_TO_STANDBY 3
  914. /* General Protocol Messages */
  915. #define CEC_MSG_FEATURE_ABORT 0x00
  916. /* Abort Reason Operand (reason) */
  917. #define CEC_OP_ABORT_UNRECOGNIZED_OP 0
  918. #define CEC_OP_ABORT_INCORRECT_MODE 1
  919. #define CEC_OP_ABORT_NO_SOURCE 2
  920. #define CEC_OP_ABORT_INVALID_OP 3
  921. #define CEC_OP_ABORT_REFUSED 4
  922. #define CEC_OP_ABORT_UNDETERMINED 5
  923. #define CEC_MSG_ABORT 0xff
  924. /* System Audio Control Feature */
  925. /*
  926. * Has also:
  927. * CEC_MSG_USER_CONTROL_PRESSED
  928. * CEC_MSG_USER_CONTROL_RELEASED
  929. */
  930. #define CEC_MSG_GIVE_AUDIO_STATUS 0x71
  931. #define CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS 0x7d
  932. #define CEC_MSG_REPORT_AUDIO_STATUS 0x7a
  933. /* Audio Mute Status Operand (aud_mute_status) */
  934. #define CEC_OP_AUD_MUTE_STATUS_OFF 0
  935. #define CEC_OP_AUD_MUTE_STATUS_ON 1
  936. #define CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR 0xa3
  937. #define CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR 0xa4
  938. #define CEC_MSG_SET_SYSTEM_AUDIO_MODE 0x72
  939. /* System Audio Status Operand (sys_aud_status) */
  940. #define CEC_OP_SYS_AUD_STATUS_OFF 0
  941. #define CEC_OP_SYS_AUD_STATUS_ON 1
  942. #define CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST 0x70
  943. #define CEC_MSG_SYSTEM_AUDIO_MODE_STATUS 0x7e
  944. /* Audio Format ID Operand (audio_format_id) */
  945. #define CEC_OP_AUD_FMT_ID_CEA861 0
  946. #define CEC_OP_AUD_FMT_ID_CEA861_CXT 1
  947. #define CEC_MSG_SET_AUDIO_VOLUME_LEVEL 0x73
  948. /* Audio Rate Control Feature */
  949. #define CEC_MSG_SET_AUDIO_RATE 0x9a
  950. /* Audio Rate Operand (audio_rate) */
  951. #define CEC_OP_AUD_RATE_OFF 0
  952. #define CEC_OP_AUD_RATE_WIDE_STD 1
  953. #define CEC_OP_AUD_RATE_WIDE_FAST 2
  954. #define CEC_OP_AUD_RATE_WIDE_SLOW 3
  955. #define CEC_OP_AUD_RATE_NARROW_STD 4
  956. #define CEC_OP_AUD_RATE_NARROW_FAST 5
  957. #define CEC_OP_AUD_RATE_NARROW_SLOW 6
  958. /* Audio Return Channel Control Feature */
  959. #define CEC_MSG_INITIATE_ARC 0xc0
  960. #define CEC_MSG_REPORT_ARC_INITIATED 0xc1
  961. #define CEC_MSG_REPORT_ARC_TERMINATED 0xc2
  962. #define CEC_MSG_REQUEST_ARC_INITIATION 0xc3
  963. #define CEC_MSG_REQUEST_ARC_TERMINATION 0xc4
  964. #define CEC_MSG_TERMINATE_ARC 0xc5
  965. /* Dynamic Audio Lipsync Feature */
  966. /* Only for CEC 2.0 and up */
  967. #define CEC_MSG_REQUEST_CURRENT_LATENCY 0xa7
  968. #define CEC_MSG_REPORT_CURRENT_LATENCY 0xa8
  969. /* Low Latency Mode Operand (low_latency_mode) */
  970. #define CEC_OP_LOW_LATENCY_MODE_OFF 0
  971. #define CEC_OP_LOW_LATENCY_MODE_ON 1
  972. /* Audio Output Compensated Operand (audio_out_compensated) */
  973. #define CEC_OP_AUD_OUT_COMPENSATED_NA 0
  974. #define CEC_OP_AUD_OUT_COMPENSATED_DELAY 1
  975. #define CEC_OP_AUD_OUT_COMPENSATED_NO_DELAY 2
  976. #define CEC_OP_AUD_OUT_COMPENSATED_PARTIAL_DELAY 3
  977. /* Capability Discovery and Control Feature */
  978. #define CEC_MSG_CDC_MESSAGE 0xf8
  979. /* Ethernet-over-HDMI: nobody ever does this... */
  980. #define CEC_MSG_CDC_HEC_INQUIRE_STATE 0x00
  981. #define CEC_MSG_CDC_HEC_REPORT_STATE 0x01
  982. /* HEC Functionality State Operand (hec_func_state) */
  983. #define CEC_OP_HEC_FUNC_STATE_NOT_SUPPORTED 0
  984. #define CEC_OP_HEC_FUNC_STATE_INACTIVE 1
  985. #define CEC_OP_HEC_FUNC_STATE_ACTIVE 2
  986. #define CEC_OP_HEC_FUNC_STATE_ACTIVATION_FIELD 3
  987. /* Host Functionality State Operand (host_func_state) */
  988. #define CEC_OP_HOST_FUNC_STATE_NOT_SUPPORTED 0
  989. #define CEC_OP_HOST_FUNC_STATE_INACTIVE 1
  990. #define CEC_OP_HOST_FUNC_STATE_ACTIVE 2
  991. /* ENC Functionality State Operand (enc_func_state) */
  992. #define CEC_OP_ENC_FUNC_STATE_EXT_CON_NOT_SUPPORTED 0
  993. #define CEC_OP_ENC_FUNC_STATE_EXT_CON_INACTIVE 1
  994. #define CEC_OP_ENC_FUNC_STATE_EXT_CON_ACTIVE 2
  995. /* CDC Error Code Operand (cdc_errcode) */
  996. #define CEC_OP_CDC_ERROR_CODE_NONE 0
  997. #define CEC_OP_CDC_ERROR_CODE_CAP_UNSUPPORTED 1
  998. #define CEC_OP_CDC_ERROR_CODE_WRONG_STATE 2
  999. #define CEC_OP_CDC_ERROR_CODE_OTHER 3
  1000. /* HEC Support Operand (hec_support) */
  1001. #define CEC_OP_HEC_SUPPORT_NO 0
  1002. #define CEC_OP_HEC_SUPPORT_YES 1
  1003. /* HEC Activation Operand (hec_activation) */
  1004. #define CEC_OP_HEC_ACTIVATION_ON 0
  1005. #define CEC_OP_HEC_ACTIVATION_OFF 1
  1006. #define CEC_MSG_CDC_HEC_SET_STATE_ADJACENT 0x02
  1007. #define CEC_MSG_CDC_HEC_SET_STATE 0x03
  1008. /* HEC Set State Operand (hec_set_state) */
  1009. #define CEC_OP_HEC_SET_STATE_DEACTIVATE 0
  1010. #define CEC_OP_HEC_SET_STATE_ACTIVATE 1
  1011. #define CEC_MSG_CDC_HEC_REQUEST_DEACTIVATION 0x04
  1012. #define CEC_MSG_CDC_HEC_NOTIFY_ALIVE 0x05
  1013. #define CEC_MSG_CDC_HEC_DISCOVER 0x06
  1014. /* Hotplug Detect messages */
  1015. #define CEC_MSG_CDC_HPD_SET_STATE 0x10
  1016. /* HPD State Operand (hpd_state) */
  1017. #define CEC_OP_HPD_STATE_CP_EDID_DISABLE 0
  1018. #define CEC_OP_HPD_STATE_CP_EDID_ENABLE 1
  1019. #define CEC_OP_HPD_STATE_CP_EDID_DISABLE_ENABLE 2
  1020. #define CEC_OP_HPD_STATE_EDID_DISABLE 3
  1021. #define CEC_OP_HPD_STATE_EDID_ENABLE 4
  1022. #define CEC_OP_HPD_STATE_EDID_DISABLE_ENABLE 5
  1023. #define CEC_MSG_CDC_HPD_REPORT_STATE 0x11
  1024. /* HPD Error Code Operand (hpd_error) */
  1025. #define CEC_OP_HPD_ERROR_NONE 0
  1026. #define CEC_OP_HPD_ERROR_INITIATOR_NOT_CAPABLE 1
  1027. #define CEC_OP_HPD_ERROR_INITIATOR_WRONG_STATE 2
  1028. #define CEC_OP_HPD_ERROR_OTHER 3
  1029. #define CEC_OP_HPD_ERROR_NONE_NO_VIDEO 4
  1030. /* End of Messages */
  1031. /* Helper functions to identify the 'special' CEC devices */
  1032. static __inline__ int cec_is_2nd_tv(const struct cec_log_addrs *las)
  1033. {
  1034. /*
  1035. * It is a second TV if the logical address is 14 or 15 and the
  1036. * primary device type is a TV.
  1037. */
  1038. return las->num_log_addrs &&
  1039. las->log_addr[0] >= CEC_LOG_ADDR_SPECIFIC &&
  1040. las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_TV;
  1041. }
  1042. static __inline__ int cec_is_processor(const struct cec_log_addrs *las)
  1043. {
  1044. /*
  1045. * It is a processor if the logical address is 12-15 and the
  1046. * primary device type is a Processor.
  1047. */
  1048. return las->num_log_addrs &&
  1049. las->log_addr[0] >= CEC_LOG_ADDR_BACKUP_1 &&
  1050. las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_PROCESSOR;
  1051. }
  1052. static __inline__ int cec_is_switch(const struct cec_log_addrs *las)
  1053. {
  1054. /*
  1055. * It is a switch if the logical address is 15 and the
  1056. * primary device type is a Switch and the CDC-Only flag is not set.
  1057. */
  1058. return las->num_log_addrs == 1 &&
  1059. las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
  1060. las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
  1061. !(las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
  1062. }
  1063. static __inline__ int cec_is_cdc_only(const struct cec_log_addrs *las)
  1064. {
  1065. /*
  1066. * It is a CDC-only device if the logical address is 15 and the
  1067. * primary device type is a Switch and the CDC-Only flag is set.
  1068. */
  1069. return las->num_log_addrs == 1 &&
  1070. las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
  1071. las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
  1072. (las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
  1073. }
  1074. #endif