]> Git Repo - linux.git/blame - drivers/media/cec/cec-adap.c
Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux.git] / drivers / media / cec / cec-adap.c
CommitLineData
b4e30a9e 1// SPDX-License-Identifier: GPL-2.0-only
9881fe0c
HV
2/*
3 * cec-adap.c - HDMI Consumer Electronics Control framework - CEC adapter
4 *
5 * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
9881fe0c
HV
6 */
7
8#include <linux/errno.h>
9#include <linux/init.h>
10#include <linux/module.h>
11#include <linux/kernel.h>
12#include <linux/kmod.h>
13#include <linux/ktime.h>
14#include <linux/slab.h>
15#include <linux/mm.h>
16#include <linux/string.h>
17#include <linux/types.h>
18
23111ec3
HV
19#include <drm/drm_edid.h>
20
9881fe0c
HV
21#include "cec-priv.h"
22
52bc30fd
HV
23static void cec_fill_msg_report_features(struct cec_adapter *adap,
24 struct cec_msg *msg,
25 unsigned int la_idx);
9881fe0c
HV
26
27/*
28 * 400 ms is the time it takes for one 16 byte message to be
29 * transferred and 5 is the maximum number of retries. Add
30 * another 100 ms as a margin. So if the transmit doesn't
31 * finish before that time something is really wrong and we
32 * have to time out.
33 *
34 * This is a sign that something it really wrong and a warning
35 * will be issued.
36 */
37#define CEC_XFER_TIMEOUT_MS (5 * 400 + 100)
38
39#define call_op(adap, op, arg...) \
40 (adap->ops->op ? adap->ops->op(adap, ## arg) : 0)
41
42#define call_void_op(adap, op, arg...) \
43 do { \
44 if (adap->ops->op) \
45 adap->ops->op(adap, ## arg); \
46 } while (0)
47
48static int cec_log_addr2idx(const struct cec_adapter *adap, u8 log_addr)
49{
50 int i;
51
52 for (i = 0; i < adap->log_addrs.num_log_addrs; i++)
53 if (adap->log_addrs.log_addr[i] == log_addr)
54 return i;
55 return -1;
56}
57
58static unsigned int cec_log_addr2dev(const struct cec_adapter *adap, u8 log_addr)
59{
60 int i = cec_log_addr2idx(adap, log_addr);
61
62 return adap->log_addrs.primary_device_type[i < 0 ? 0 : i];
63}
64
f94d463f
HV
65u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
66 unsigned int *offset)
67{
68 unsigned int loc = cec_get_edid_spa_location(edid, size);
69
70 if (offset)
71 *offset = loc;
72 if (loc == 0)
73 return CEC_PHYS_ADDR_INVALID;
74 return (edid[loc] << 8) | edid[loc + 1];
75}
76EXPORT_SYMBOL_GPL(cec_get_edid_phys_addr);
77
9881fe0c
HV
78/*
79 * Queue a new event for this filehandle. If ts == 0, then set it
80 * to the current time.
81 *
6b2bbb08
HV
82 * We keep a queue of at most max_event events where max_event differs
83 * per event. If the queue becomes full, then drop the oldest event and
84 * keep track of how many events we've dropped.
9881fe0c
HV
85 */
86void cec_queue_event_fh(struct cec_fh *fh,
87 const struct cec_event *new_ev, u64 ts)
88{
6ec1cbf6 89 static const u16 max_events[CEC_NUM_EVENTS] = {
4786b0d6 90 1, 1, 800, 800, 8, 8, 8, 8
6b2bbb08
HV
91 };
92 struct cec_event_entry *entry;
93 unsigned int ev_idx = new_ev->event - 1;
94
95 if (WARN_ON(ev_idx >= ARRAY_SIZE(fh->events)))
96 return;
9881fe0c
HV
97
98 if (ts == 0)
99 ts = ktime_get_ns();
100
101 mutex_lock(&fh->lock);
6b2bbb08
HV
102 if (ev_idx < CEC_NUM_CORE_EVENTS)
103 entry = &fh->core_events[ev_idx];
104 else
105 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
106 if (entry) {
107 if (new_ev->event == CEC_EVENT_LOST_MSGS &&
108 fh->queued_events[ev_idx]) {
109 entry->ev.lost_msgs.lost_msgs +=
110 new_ev->lost_msgs.lost_msgs;
111 goto unlock;
112 }
113 entry->ev = *new_ev;
114 entry->ev.ts = ts;
115
116 if (fh->queued_events[ev_idx] < max_events[ev_idx]) {
117 /* Add new msg at the end of the queue */
118 list_add_tail(&entry->list, &fh->events[ev_idx]);
119 fh->queued_events[ev_idx]++;
120 fh->total_queued_events++;
121 goto unlock;
122 }
123
124 if (ev_idx >= CEC_NUM_CORE_EVENTS) {
125 list_add_tail(&entry->list, &fh->events[ev_idx]);
126 /* drop the oldest event */
127 entry = list_first_entry(&fh->events[ev_idx],
128 struct cec_event_entry, list);
129 list_del(&entry->list);
130 kfree(entry);
131 }
9881fe0c 132 }
6b2bbb08
HV
133 /* Mark that events were lost */
134 entry = list_first_entry_or_null(&fh->events[ev_idx],
135 struct cec_event_entry, list);
136 if (entry)
137 entry->ev.flags |= CEC_EVENT_FL_DROPPED_EVENTS;
9881fe0c
HV
138
139unlock:
140 mutex_unlock(&fh->lock);
141 wake_up_interruptible(&fh->wait);
142}
143
144/* Queue a new event for all open filehandles. */
145static void cec_queue_event(struct cec_adapter *adap,
146 const struct cec_event *ev)
147{
148 u64 ts = ktime_get_ns();
149 struct cec_fh *fh;
150
62148f09 151 mutex_lock(&adap->devnode.lock);
9881fe0c
HV
152 list_for_each_entry(fh, &adap->devnode.fhs, list)
153 cec_queue_event_fh(fh, ev, ts);
62148f09 154 mutex_unlock(&adap->devnode.lock);
9881fe0c
HV
155}
156
b8d62f50 157/* Notify userspace that the CEC pin changed state at the given time. */
6ec1cbf6
HV
158void cec_queue_pin_cec_event(struct cec_adapter *adap, bool is_high,
159 bool dropped_events, ktime_t ts)
b8d62f50
HV
160{
161 struct cec_event ev = {
9a6b2a87
HV
162 .event = is_high ? CEC_EVENT_PIN_CEC_HIGH :
163 CEC_EVENT_PIN_CEC_LOW,
6ec1cbf6 164 .flags = dropped_events ? CEC_EVENT_FL_DROPPED_EVENTS : 0,
b8d62f50
HV
165 };
166 struct cec_fh *fh;
167
168 mutex_lock(&adap->devnode.lock);
169 list_for_each_entry(fh, &adap->devnode.fhs, list)
170 if (fh->mode_follower == CEC_MODE_MONITOR_PIN)
171 cec_queue_event_fh(fh, &ev, ktime_to_ns(ts));
172 mutex_unlock(&adap->devnode.lock);
173}
9a6b2a87 174EXPORT_SYMBOL_GPL(cec_queue_pin_cec_event);
b8d62f50 175
333ef6bd
HV
176/* Notify userspace that the HPD pin changed state at the given time. */
177void cec_queue_pin_hpd_event(struct cec_adapter *adap, bool is_high, ktime_t ts)
178{
179 struct cec_event ev = {
180 .event = is_high ? CEC_EVENT_PIN_HPD_HIGH :
181 CEC_EVENT_PIN_HPD_LOW,
182 };
183 struct cec_fh *fh;
184
185 mutex_lock(&adap->devnode.lock);
186 list_for_each_entry(fh, &adap->devnode.fhs, list)
187 cec_queue_event_fh(fh, &ev, ktime_to_ns(ts));
188 mutex_unlock(&adap->devnode.lock);
189}
190EXPORT_SYMBOL_GPL(cec_queue_pin_hpd_event);
191
4786b0d6
HV
192/* Notify userspace that the 5V pin changed state at the given time. */
193void cec_queue_pin_5v_event(struct cec_adapter *adap, bool is_high, ktime_t ts)
194{
195 struct cec_event ev = {
196 .event = is_high ? CEC_EVENT_PIN_5V_HIGH :
197 CEC_EVENT_PIN_5V_LOW,
198 };
199 struct cec_fh *fh;
200
201 mutex_lock(&adap->devnode.lock);
202 list_for_each_entry(fh, &adap->devnode.fhs, list)
203 cec_queue_event_fh(fh, &ev, ktime_to_ns(ts));
204 mutex_unlock(&adap->devnode.lock);
205}
206EXPORT_SYMBOL_GPL(cec_queue_pin_5v_event);
207
9881fe0c 208/*
6b2bbb08
HV
209 * Queue a new message for this filehandle.
210 *
211 * We keep a queue of at most CEC_MAX_MSG_RX_QUEUE_SZ messages. If the
212 * queue becomes full, then drop the oldest message and keep track
213 * of how many messages we've dropped.
9881fe0c
HV
214 */
215static void cec_queue_msg_fh(struct cec_fh *fh, const struct cec_msg *msg)
216{
6b2bbb08 217 static const struct cec_event ev_lost_msgs = {
9881fe0c 218 .event = CEC_EVENT_LOST_MSGS,
c848c49a
AM
219 .flags = 0,
220 {
221 .lost_msgs = { 1 },
222 },
9881fe0c
HV
223 };
224 struct cec_msg_entry *entry;
225
226 mutex_lock(&fh->lock);
227 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
6b2bbb08
HV
228 if (entry) {
229 entry->msg = *msg;
230 /* Add new msg at the end of the queue */
231 list_add_tail(&entry->list, &fh->msgs);
232
233 if (fh->queued_msgs < CEC_MAX_MSG_RX_QUEUE_SZ) {
234 /* All is fine if there is enough room */
235 fh->queued_msgs++;
236 mutex_unlock(&fh->lock);
237 wake_up_interruptible(&fh->wait);
238 return;
239 }
9881fe0c 240
6b2bbb08
HV
241 /*
242 * if the message queue is full, then drop the oldest one and
243 * send a lost message event.
244 */
245 entry = list_first_entry(&fh->msgs, struct cec_msg_entry, list);
9881fe0c 246 list_del(&entry->list);
6b2bbb08 247 kfree(entry);
9881fe0c 248 }
9881fe0c 249 mutex_unlock(&fh->lock);
9881fe0c 250
6b2bbb08
HV
251 /*
252 * We lost a message, either because kmalloc failed or the queue
253 * was full.
254 */
255 cec_queue_event_fh(fh, &ev_lost_msgs, ktime_get_ns());
9881fe0c
HV
256}
257
258/*
259 * Queue the message for those filehandles that are in monitor mode.
260 * If valid_la is true (this message is for us or was sent by us),
261 * then pass it on to any monitoring filehandle. If this message
262 * isn't for us or from us, then only give it to filehandles that
263 * are in MONITOR_ALL mode.
264 *
265 * This can only happen if the CEC_CAP_MONITOR_ALL capability is
266 * set and the CEC adapter was placed in 'monitor all' mode.
267 */
268static void cec_queue_msg_monitor(struct cec_adapter *adap,
269 const struct cec_msg *msg,
270 bool valid_la)
271{
272 struct cec_fh *fh;
273 u32 monitor_mode = valid_la ? CEC_MODE_MONITOR :
274 CEC_MODE_MONITOR_ALL;
275
62148f09 276 mutex_lock(&adap->devnode.lock);
9881fe0c
HV
277 list_for_each_entry(fh, &adap->devnode.fhs, list) {
278 if (fh->mode_follower >= monitor_mode)
279 cec_queue_msg_fh(fh, msg);
280 }
62148f09 281 mutex_unlock(&adap->devnode.lock);
9881fe0c
HV
282}
283
284/*
285 * Queue the message for follower filehandles.
286 */
287static void cec_queue_msg_followers(struct cec_adapter *adap,
288 const struct cec_msg *msg)
289{
290 struct cec_fh *fh;
291
62148f09 292 mutex_lock(&adap->devnode.lock);
9881fe0c
HV
293 list_for_each_entry(fh, &adap->devnode.fhs, list) {
294 if (fh->mode_follower == CEC_MODE_FOLLOWER)
295 cec_queue_msg_fh(fh, msg);
296 }
62148f09 297 mutex_unlock(&adap->devnode.lock);
9881fe0c
HV
298}
299
300/* Notify userspace of an adapter state change. */
301static void cec_post_state_event(struct cec_adapter *adap)
302{
303 struct cec_event ev = {
304 .event = CEC_EVENT_STATE_CHANGE,
305 };
306
307 ev.state_change.phys_addr = adap->phys_addr;
308 ev.state_change.log_addr_mask = adap->log_addrs.log_addr_mask;
309 cec_queue_event(adap, &ev);
310}
311
312/*
313 * A CEC transmit (and a possible wait for reply) completed.
314 * If this was in blocking mode, then complete it, otherwise
315 * queue the message for userspace to dequeue later.
316 *
317 * This function is called with adap->lock held.
318 */
319static void cec_data_completed(struct cec_data *data)
320{
321 /*
322 * Delete this transmit from the filehandle's xfer_list since
323 * we're done with it.
324 *
325 * Note that if the filehandle is closed before this transmit
326 * finished, then the release() function will set data->fh to NULL.
327 * Without that we would be referring to a closed filehandle.
328 */
329 if (data->fh)
330 list_del(&data->xfer_list);
331
332 if (data->blocking) {
333 /*
334 * Someone is blocking so mark the message as completed
335 * and call complete.
336 */
337 data->completed = true;
338 complete(&data->c);
339 } else {
340 /*
341 * No blocking, so just queue the message if needed and
342 * free the memory.
343 */
344 if (data->fh)
345 cec_queue_msg_fh(data->fh, &data->msg);
346 kfree(data);
347 }
348}
349
350/*
351 * A pending CEC transmit needs to be cancelled, either because the CEC
352 * adapter is disabled or the transmit takes an impossibly long time to
353 * finish.
354 *
355 * This function is called with adap->lock held.
356 */
7ec2b3b9 357static void cec_data_cancel(struct cec_data *data, u8 tx_status)
9881fe0c
HV
358{
359 /*
360 * It's either the current transmit, or it is a pending
361 * transmit. Take the appropriate action to clear it.
362 */
11065f85 363 if (data->adap->transmitting == data) {
9881fe0c 364 data->adap->transmitting = NULL;
11065f85 365 } else {
9881fe0c 366 list_del_init(&data->list);
11065f85
HV
367 if (!(data->msg.tx_status & CEC_TX_STATUS_OK))
368 data->adap->transmit_queue_sz--;
369 }
9881fe0c 370
73678158 371 if (data->msg.tx_status & CEC_TX_STATUS_OK) {
73678158 372 data->msg.rx_ts = ktime_get_ns();
7ec2b3b9 373 data->msg.rx_status = CEC_RX_STATUS_ABORTED;
73678158 374 } else {
73678158 375 data->msg.tx_ts = ktime_get_ns();
7ec2b3b9 376 data->msg.tx_status |= tx_status |
73678158
HV
377 CEC_TX_STATUS_MAX_RETRIES;
378 data->msg.tx_error_cnt++;
379 data->attempts = 0;
380 }
381
9881fe0c
HV
382 /* Queue transmitted message for monitoring purposes */
383 cec_queue_msg_monitor(data->adap, &data->msg, 1);
384
385 cec_data_completed(data);
386}
387
b39f93ef
HV
388/*
389 * Flush all pending transmits and cancel any pending timeout work.
390 *
391 * This function is called with adap->lock held.
392 */
393static void cec_flush(struct cec_adapter *adap)
394{
395 struct cec_data *data, *n;
396
397 /*
398 * If the adapter is disabled, or we're asked to stop,
399 * then cancel any pending transmits.
400 */
401 while (!list_empty(&adap->transmit_queue)) {
402 data = list_first_entry(&adap->transmit_queue,
403 struct cec_data, list);
7ec2b3b9 404 cec_data_cancel(data, CEC_TX_STATUS_ABORTED);
b39f93ef
HV
405 }
406 if (adap->transmitting)
7ec2b3b9 407 cec_data_cancel(adap->transmitting, CEC_TX_STATUS_ABORTED);
b39f93ef
HV
408
409 /* Cancel the pending timeout work. */
410 list_for_each_entry_safe(data, n, &adap->wait_queue, list) {
411 if (cancel_delayed_work(&data->work))
7ec2b3b9 412 cec_data_cancel(data, CEC_TX_STATUS_OK);
b39f93ef
HV
413 /*
414 * If cancel_delayed_work returned false, then
415 * the cec_wait_timeout function is running,
416 * which will call cec_data_completed. So no
417 * need to do anything special in that case.
418 */
419 }
420}
421
9881fe0c
HV
422/*
423 * Main CEC state machine
424 *
425 * Wait until the thread should be stopped, or we are not transmitting and
426 * a new transmit message is queued up, in which case we start transmitting
427 * that message. When the adapter finished transmitting the message it will
428 * call cec_transmit_done().
429 *
430 * If the adapter is disabled, then remove all queued messages instead.
431 *
432 * If the current transmit times out, then cancel that transmit.
433 */
434int cec_thread_func(void *_adap)
435{
436 struct cec_adapter *adap = _adap;
437
438 for (;;) {
439 unsigned int signal_free_time;
440 struct cec_data *data;
441 bool timeout = false;
442 u8 attempts;
443
444 if (adap->transmitting) {
445 int err;
446
447 /*
448 * We are transmitting a message, so add a timeout
449 * to prevent the state machine to get stuck waiting
450 * for this message to finalize and add a check to
451 * see if the adapter is disabled in which case the
452 * transmit should be canceled.
453 */
454 err = wait_event_interruptible_timeout(adap->kthread_waitq,
f902c1e9
HV
455 (adap->needs_hpd &&
456 (!adap->is_configured && !adap->is_configuring)) ||
9881fe0c 457 kthread_should_stop() ||
9881fe0c
HV
458 (!adap->transmitting &&
459 !list_empty(&adap->transmit_queue)),
460 msecs_to_jiffies(CEC_XFER_TIMEOUT_MS));
461 timeout = err == 0;
462 } else {
463 /* Otherwise we just wait for something to happen. */
464 wait_event_interruptible(adap->kthread_waitq,
465 kthread_should_stop() ||
466 (!adap->transmitting &&
467 !list_empty(&adap->transmit_queue)));
468 }
469
470 mutex_lock(&adap->lock);
471
f902c1e9
HV
472 if ((adap->needs_hpd &&
473 (!adap->is_configured && !adap->is_configuring)) ||
474 kthread_should_stop()) {
b39f93ef 475 cec_flush(adap);
9881fe0c
HV
476 goto unlock;
477 }
478
479 if (adap->transmitting && timeout) {
480 /*
bb789e03
HV
481 * If we timeout, then log that. Normally this does
482 * not happen and it is an indication of a faulty CEC
483 * adapter driver, or the CEC bus is in some weird
484 * state. On rare occasions it can happen if there is
485 * so much traffic on the bus that the adapter was
486 * unable to transmit for CEC_XFER_TIMEOUT_MS (2.1s).
9881fe0c 487 */
7ec2b3b9 488 pr_warn("cec-%s: message %*ph timed out\n", adap->name,
9881fe0c
HV
489 adap->transmitting->msg.len,
490 adap->transmitting->msg.msg);
bb789e03 491 adap->tx_timeouts++;
9881fe0c 492 /* Just give up on this. */
7ec2b3b9
HV
493 cec_data_cancel(adap->transmitting,
494 CEC_TX_STATUS_TIMEOUT);
9881fe0c
HV
495 goto unlock;
496 }
497
498 /*
499 * If we are still transmitting, or there is nothing new to
500 * transmit, then just continue waiting.
501 */
502 if (adap->transmitting || list_empty(&adap->transmit_queue))
503 goto unlock;
504
505 /* Get a new message to transmit */
506 data = list_first_entry(&adap->transmit_queue,
507 struct cec_data, list);
508 list_del_init(&data->list);
11065f85 509 adap->transmit_queue_sz--;
533a3f7b 510
9881fe0c
HV
511 /* Make this the current transmitting message */
512 adap->transmitting = data;
513
514 /*
515 * Suggested number of attempts as per the CEC 2.0 spec:
516 * 4 attempts is the default, except for 'secondary poll
517 * messages', i.e. poll messages not sent during the adapter
518 * configuration phase when it allocates logical addresses.
519 */
520 if (data->msg.len == 1 && adap->is_configured)
521 attempts = 2;
522 else
523 attempts = 4;
524
525 /* Set the suggested signal free time */
526 if (data->attempts) {
527 /* should be >= 3 data bit periods for a retry */
528 signal_free_time = CEC_SIGNAL_FREE_TIME_RETRY;
7d867a1b
HV
529 } else if (adap->last_initiator !=
530 cec_msg_initiator(&data->msg)) {
9881fe0c
HV
531 /* should be >= 5 data bit periods for new initiator */
532 signal_free_time = CEC_SIGNAL_FREE_TIME_NEW_INITIATOR;
7d867a1b 533 adap->last_initiator = cec_msg_initiator(&data->msg);
9881fe0c
HV
534 } else {
535 /*
536 * should be >= 7 data bit periods for sending another
537 * frame immediately after another.
538 */
539 signal_free_time = CEC_SIGNAL_FREE_TIME_NEXT_XFER;
540 }
541 if (data->attempts == 0)
542 data->attempts = attempts;
543
544 /* Tell the adapter to transmit, cancel on error */
545 if (adap->ops->adap_transmit(adap, data->attempts,
546 signal_free_time, &data->msg))
7ec2b3b9 547 cec_data_cancel(data, CEC_TX_STATUS_ABORTED);
9881fe0c
HV
548
549unlock:
550 mutex_unlock(&adap->lock);
551
552 if (kthread_should_stop())
553 break;
554 }
555 return 0;
556}
557
558/*
559 * Called by the CEC adapter if a transmit finished.
560 */
0861ad14
HV
561void cec_transmit_done_ts(struct cec_adapter *adap, u8 status,
562 u8 arb_lost_cnt, u8 nack_cnt, u8 low_drive_cnt,
563 u8 error_cnt, ktime_t ts)
9881fe0c
HV
564{
565 struct cec_data *data;
566 struct cec_msg *msg;
688318c3
HV
567 unsigned int attempts_made = arb_lost_cnt + nack_cnt +
568 low_drive_cnt + error_cnt;
9881fe0c 569
2c21ac0a 570 dprintk(2, "%s: status 0x%02x\n", __func__, status);
688318c3
HV
571 if (attempts_made < 1)
572 attempts_made = 1;
573
9881fe0c
HV
574 mutex_lock(&adap->lock);
575 data = adap->transmitting;
576 if (!data) {
577 /*
578 * This can happen if a transmit was issued and the cable is
579 * unplugged while the transmit is ongoing. Ignore this
580 * transmit in that case.
581 */
a7a04b5b
HV
582 dprintk(1, "%s was called without an ongoing transmit!\n",
583 __func__);
9881fe0c
HV
584 goto unlock;
585 }
586
587 msg = &data->msg;
588
589 /* Drivers must fill in the status! */
590 WARN_ON(status == 0);
0861ad14 591 msg->tx_ts = ktime_to_ns(ts);
9881fe0c
HV
592 msg->tx_status |= status;
593 msg->tx_arb_lost_cnt += arb_lost_cnt;
594 msg->tx_nack_cnt += nack_cnt;
595 msg->tx_low_drive_cnt += low_drive_cnt;
596 msg->tx_error_cnt += error_cnt;
597
598 /* Mark that we're done with this transmit */
599 adap->transmitting = NULL;
600
601 /*
602 * If there are still retry attempts left and there was an error and
603 * the hardware didn't signal that it retried itself (by setting
604 * CEC_TX_STATUS_MAX_RETRIES), then we will retry ourselves.
605 */
688318c3 606 if (data->attempts > attempts_made &&
9881fe0c
HV
607 !(status & (CEC_TX_STATUS_MAX_RETRIES | CEC_TX_STATUS_OK))) {
608 /* Retry this message */
688318c3 609 data->attempts -= attempts_made;
a7a04b5b
HV
610 if (msg->timeout)
611 dprintk(2, "retransmit: %*ph (attempts: %d, wait for 0x%02x)\n",
612 msg->len, msg->msg, data->attempts, msg->reply);
613 else
614 dprintk(2, "retransmit: %*ph (attempts: %d)\n",
615 msg->len, msg->msg, data->attempts);
9881fe0c
HV
616 /* Add the message in front of the transmit queue */
617 list_add(&data->list, &adap->transmit_queue);
11065f85 618 adap->transmit_queue_sz++;
9881fe0c
HV
619 goto wake_thread;
620 }
621
622 data->attempts = 0;
623
624 /* Always set CEC_TX_STATUS_MAX_RETRIES on error */
625 if (!(status & CEC_TX_STATUS_OK))
626 msg->tx_status |= CEC_TX_STATUS_MAX_RETRIES;
627
628 /* Queue transmitted message for monitoring purposes */
629 cec_queue_msg_monitor(adap, msg, 1);
630
86e3577f
HV
631 if ((status & CEC_TX_STATUS_OK) && adap->is_configured &&
632 msg->timeout) {
9881fe0c
HV
633 /*
634 * Queue the message into the wait queue if we want to wait
635 * for a reply.
636 */
637 list_add_tail(&data->list, &adap->wait_queue);
638 schedule_delayed_work(&data->work,
639 msecs_to_jiffies(msg->timeout));
640 } else {
641 /* Otherwise we're done */
642 cec_data_completed(data);
643 }
644
645wake_thread:
646 /*
647 * Wake up the main thread to see if another message is ready
648 * for transmitting or to retry the current message.
649 */
650 wake_up_interruptible(&adap->kthread_waitq);
651unlock:
652 mutex_unlock(&adap->lock);
653}
0861ad14 654EXPORT_SYMBOL_GPL(cec_transmit_done_ts);
9881fe0c 655
0861ad14
HV
656void cec_transmit_attempt_done_ts(struct cec_adapter *adap,
657 u8 status, ktime_t ts)
c94cdc1e 658{
bd34ca87 659 switch (status & ~CEC_TX_STATUS_MAX_RETRIES) {
c94cdc1e 660 case CEC_TX_STATUS_OK:
0861ad14 661 cec_transmit_done_ts(adap, status, 0, 0, 0, 0, ts);
c94cdc1e
HV
662 return;
663 case CEC_TX_STATUS_ARB_LOST:
0861ad14 664 cec_transmit_done_ts(adap, status, 1, 0, 0, 0, ts);
c94cdc1e
HV
665 return;
666 case CEC_TX_STATUS_NACK:
0861ad14 667 cec_transmit_done_ts(adap, status, 0, 1, 0, 0, ts);
c94cdc1e
HV
668 return;
669 case CEC_TX_STATUS_LOW_DRIVE:
0861ad14 670 cec_transmit_done_ts(adap, status, 0, 0, 1, 0, ts);
c94cdc1e
HV
671 return;
672 case CEC_TX_STATUS_ERROR:
0861ad14 673 cec_transmit_done_ts(adap, status, 0, 0, 0, 1, ts);
c94cdc1e
HV
674 return;
675 default:
676 /* Should never happen */
677 WARN(1, "cec-%s: invalid status 0x%02x\n", adap->name, status);
678 return;
679 }
680}
0861ad14 681EXPORT_SYMBOL_GPL(cec_transmit_attempt_done_ts);
c94cdc1e 682
9881fe0c
HV
683/*
684 * Called when waiting for a reply times out.
685 */
686static void cec_wait_timeout(struct work_struct *work)
687{
688 struct cec_data *data = container_of(work, struct cec_data, work.work);
689 struct cec_adapter *adap = data->adap;
690
691 mutex_lock(&adap->lock);
692 /*
693 * Sanity check in case the timeout and the arrival of the message
694 * happened at the same time.
695 */
696 if (list_empty(&data->list))
697 goto unlock;
698
699 /* Mark the message as timed out */
700 list_del_init(&data->list);
980e0b36 701 data->msg.rx_ts = ktime_get_ns();
9881fe0c
HV
702 data->msg.rx_status = CEC_RX_STATUS_TIMEOUT;
703 cec_data_completed(data);
704unlock:
705 mutex_unlock(&adap->lock);
706}
707
708/*
709 * Transmit a message. The fh argument may be NULL if the transmit is not
710 * associated with a specific filehandle.
711 *
712 * This function is called with adap->lock held.
713 */
714int cec_transmit_msg_fh(struct cec_adapter *adap, struct cec_msg *msg,
715 struct cec_fh *fh, bool block)
716{
717 struct cec_data *data;
9881fe0c 718
40df3a7e
HV
719 msg->rx_ts = 0;
720 msg->tx_ts = 0;
721 msg->rx_status = 0;
722 msg->tx_status = 0;
723 msg->tx_arb_lost_cnt = 0;
724 msg->tx_nack_cnt = 0;
725 msg->tx_low_drive_cnt = 0;
726 msg->tx_error_cnt = 0;
15e809e9 727 msg->sequence = 0;
40df3a7e 728
9881fe0c
HV
729 if (msg->reply && msg->timeout == 0) {
730 /* Make sure the timeout isn't 0. */
731 msg->timeout = 1000;
732 }
7ae2a888
HV
733 if (msg->timeout)
734 msg->flags &= CEC_MSG_FL_REPLY_TO_FOLLOWERS;
735 else
736 msg->flags = 0;
9881fe0c 737
1b396350
HV
738 if (msg->len > 1 && msg->msg[1] == CEC_MSG_CDC_MESSAGE) {
739 msg->msg[2] = adap->phys_addr >> 8;
740 msg->msg[3] = adap->phys_addr & 0xff;
741 }
742
9881fe0c
HV
743 /* Sanity checks */
744 if (msg->len == 0 || msg->len > CEC_MAX_MSG_SIZE) {
5a137df1 745 dprintk(1, "%s: invalid length %d\n", __func__, msg->len);
9881fe0c
HV
746 return -EINVAL;
747 }
1b396350
HV
748
749 memset(msg->msg + msg->len, 0, sizeof(msg->msg) - msg->len);
750
751 if (msg->timeout)
752 dprintk(2, "%s: %*ph (wait for 0x%02x%s)\n",
753 __func__, msg->len, msg->msg, msg->reply,
754 !block ? ", nb" : "");
755 else
756 dprintk(2, "%s: %*ph%s\n",
757 __func__, msg->len, msg->msg, !block ? " (nb)" : "");
758
9881fe0c 759 if (msg->timeout && msg->len == 1) {
1b396350 760 dprintk(1, "%s: can't reply to poll msg\n", __func__);
9881fe0c
HV
761 return -EINVAL;
762 }
763 if (msg->len == 1) {
42980da2 764 if (cec_msg_destination(msg) == 0xf) {
5a137df1 765 dprintk(1, "%s: invalid poll message\n", __func__);
9881fe0c
HV
766 return -EINVAL;
767 }
768 if (cec_has_log_addr(adap, cec_msg_destination(msg))) {
769 /*
770 * If the destination is a logical address our adapter
771 * has already claimed, then just NACK this.
772 * It depends on the hardware what it will do with a
773 * POLL to itself (some OK this), so it is just as
774 * easy to handle it here so the behavior will be
775 * consistent.
776 */
9a3f14ea 777 msg->tx_ts = ktime_get_ns();
9881fe0c
HV
778 msg->tx_status = CEC_TX_STATUS_NACK |
779 CEC_TX_STATUS_MAX_RETRIES;
780 msg->tx_nack_cnt = 1;
15e809e9
HV
781 msg->sequence = ++adap->sequence;
782 if (!msg->sequence)
783 msg->sequence = ++adap->sequence;
9881fe0c
HV
784 return 0;
785 }
786 }
787 if (msg->len > 1 && !cec_msg_is_broadcast(msg) &&
788 cec_has_log_addr(adap, cec_msg_destination(msg))) {
5a137df1 789 dprintk(1, "%s: destination is the adapter itself\n", __func__);
9881fe0c
HV
790 return -EINVAL;
791 }
42980da2 792 if (msg->len > 1 && adap->is_configured &&
9881fe0c 793 !cec_has_log_addr(adap, cec_msg_initiator(msg))) {
5a137df1
HV
794 dprintk(1, "%s: initiator has unknown logical address %d\n",
795 __func__, cec_msg_initiator(msg));
9881fe0c
HV
796 return -EINVAL;
797 }
25c21078 798 if (!adap->is_configured && !adap->is_configuring) {
f902c1e9 799 if (adap->needs_hpd || msg->msg[0] != 0xf0) {
25c21078
HV
800 dprintk(1, "%s: adapter is unconfigured\n", __func__);
801 return -ENONET;
802 }
803 if (msg->reply) {
804 dprintk(1, "%s: invalid msg->reply\n", __func__);
805 return -EINVAL;
806 }
807 }
9881fe0c 808
25c21078 809 if (adap->transmit_queue_sz >= CEC_MAX_MSG_TX_QUEUE_SZ) {
2efaf6eb 810 dprintk(2, "%s: transmit queue full\n", __func__);
11065f85 811 return -EBUSY;
25c21078 812 }
11065f85 813
9881fe0c
HV
814 data = kzalloc(sizeof(*data), GFP_KERNEL);
815 if (!data)
816 return -ENOMEM;
817
15e809e9
HV
818 msg->sequence = ++adap->sequence;
819 if (!msg->sequence)
820 msg->sequence = ++adap->sequence;
821
9881fe0c
HV
822 data->msg = *msg;
823 data->fh = fh;
824 data->adap = adap;
825 data->blocking = block;
826
9881fe0c
HV
827 init_completion(&data->c);
828 INIT_DELAYED_WORK(&data->work, cec_wait_timeout);
829
9881fe0c
HV
830 if (fh)
831 list_add_tail(&data->xfer_list, &fh->xfer_list);
533a3f7b 832
9881fe0c 833 list_add_tail(&data->list, &adap->transmit_queue);
11065f85 834 adap->transmit_queue_sz++;
9881fe0c
HV
835 if (!adap->transmitting)
836 wake_up_interruptible(&adap->kthread_waitq);
837
838 /* All done if we don't need to block waiting for completion */
839 if (!block)
840 return 0;
841
9881fe0c
HV
842 /*
843 * Release the lock and wait, retake the lock afterwards.
844 */
845 mutex_unlock(&adap->lock);
7ec2b3b9 846 wait_for_completion_killable(&data->c);
490d84f6
HV
847 if (!data->completed)
848 cancel_delayed_work_sync(&data->work);
9881fe0c
HV
849 mutex_lock(&adap->lock);
850
7ec2b3b9
HV
851 /* Cancel the transmit if it was interrupted */
852 if (!data->completed)
853 cec_data_cancel(data, CEC_TX_STATUS_ABORTED);
9881fe0c 854
7ec2b3b9
HV
855 /* The transmit completed (possibly with an error) */
856 *msg = data->msg;
857 kfree(data);
858 return 0;
9881fe0c
HV
859}
860
861/* Helper function to be used by drivers and this framework. */
862int cec_transmit_msg(struct cec_adapter *adap, struct cec_msg *msg,
863 bool block)
864{
865 int ret;
866
867 mutex_lock(&adap->lock);
868 ret = cec_transmit_msg_fh(adap, msg, NULL, block);
869 mutex_unlock(&adap->lock);
870 return ret;
871}
872EXPORT_SYMBOL_GPL(cec_transmit_msg);
873
874/*
875 * I don't like forward references but without this the low-level
876 * cec_received_msg() function would come after a bunch of high-level
877 * CEC protocol handling functions. That was very confusing.
878 */
879static int cec_receive_notify(struct cec_adapter *adap, struct cec_msg *msg,
880 bool is_reply);
881
3074fe4a
HV
882#define DIRECTED 0x80
883#define BCAST1_4 0x40
884#define BCAST2_0 0x20 /* broadcast only allowed for >= 2.0 */
885#define BCAST (BCAST1_4 | BCAST2_0)
886#define BOTH (BCAST | DIRECTED)
887
888/*
889 * Specify minimum length and whether the message is directed, broadcast
890 * or both. Messages that do not match the criteria are ignored as per
891 * the CEC specification.
892 */
893static const u8 cec_msg_size[256] = {
894 [CEC_MSG_ACTIVE_SOURCE] = 4 | BCAST,
895 [CEC_MSG_IMAGE_VIEW_ON] = 2 | DIRECTED,
896 [CEC_MSG_TEXT_VIEW_ON] = 2 | DIRECTED,
897 [CEC_MSG_INACTIVE_SOURCE] = 4 | DIRECTED,
898 [CEC_MSG_REQUEST_ACTIVE_SOURCE] = 2 | BCAST,
899 [CEC_MSG_ROUTING_CHANGE] = 6 | BCAST,
900 [CEC_MSG_ROUTING_INFORMATION] = 4 | BCAST,
901 [CEC_MSG_SET_STREAM_PATH] = 4 | BCAST,
902 [CEC_MSG_STANDBY] = 2 | BOTH,
903 [CEC_MSG_RECORD_OFF] = 2 | DIRECTED,
904 [CEC_MSG_RECORD_ON] = 3 | DIRECTED,
905 [CEC_MSG_RECORD_STATUS] = 3 | DIRECTED,
906 [CEC_MSG_RECORD_TV_SCREEN] = 2 | DIRECTED,
907 [CEC_MSG_CLEAR_ANALOGUE_TIMER] = 13 | DIRECTED,
908 [CEC_MSG_CLEAR_DIGITAL_TIMER] = 16 | DIRECTED,
909 [CEC_MSG_CLEAR_EXT_TIMER] = 13 | DIRECTED,
910 [CEC_MSG_SET_ANALOGUE_TIMER] = 13 | DIRECTED,
911 [CEC_MSG_SET_DIGITAL_TIMER] = 16 | DIRECTED,
912 [CEC_MSG_SET_EXT_TIMER] = 13 | DIRECTED,
913 [CEC_MSG_SET_TIMER_PROGRAM_TITLE] = 2 | DIRECTED,
914 [CEC_MSG_TIMER_CLEARED_STATUS] = 3 | DIRECTED,
915 [CEC_MSG_TIMER_STATUS] = 3 | DIRECTED,
916 [CEC_MSG_CEC_VERSION] = 3 | DIRECTED,
917 [CEC_MSG_GET_CEC_VERSION] = 2 | DIRECTED,
918 [CEC_MSG_GIVE_PHYSICAL_ADDR] = 2 | DIRECTED,
919 [CEC_MSG_GET_MENU_LANGUAGE] = 2 | DIRECTED,
920 [CEC_MSG_REPORT_PHYSICAL_ADDR] = 5 | BCAST,
921 [CEC_MSG_SET_MENU_LANGUAGE] = 5 | BCAST,
922 [CEC_MSG_REPORT_FEATURES] = 6 | BCAST,
923 [CEC_MSG_GIVE_FEATURES] = 2 | DIRECTED,
924 [CEC_MSG_DECK_CONTROL] = 3 | DIRECTED,
925 [CEC_MSG_DECK_STATUS] = 3 | DIRECTED,
926 [CEC_MSG_GIVE_DECK_STATUS] = 3 | DIRECTED,
927 [CEC_MSG_PLAY] = 3 | DIRECTED,
928 [CEC_MSG_GIVE_TUNER_DEVICE_STATUS] = 3 | DIRECTED,
929 [CEC_MSG_SELECT_ANALOGUE_SERVICE] = 6 | DIRECTED,
930 [CEC_MSG_SELECT_DIGITAL_SERVICE] = 9 | DIRECTED,
931 [CEC_MSG_TUNER_DEVICE_STATUS] = 7 | DIRECTED,
932 [CEC_MSG_TUNER_STEP_DECREMENT] = 2 | DIRECTED,
933 [CEC_MSG_TUNER_STEP_INCREMENT] = 2 | DIRECTED,
934 [CEC_MSG_DEVICE_VENDOR_ID] = 5 | BCAST,
935 [CEC_MSG_GIVE_DEVICE_VENDOR_ID] = 2 | DIRECTED,
936 [CEC_MSG_VENDOR_COMMAND] = 2 | DIRECTED,
937 [CEC_MSG_VENDOR_COMMAND_WITH_ID] = 5 | BOTH,
938 [CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN] = 2 | BOTH,
939 [CEC_MSG_VENDOR_REMOTE_BUTTON_UP] = 2 | BOTH,
940 [CEC_MSG_SET_OSD_STRING] = 3 | DIRECTED,
941 [CEC_MSG_GIVE_OSD_NAME] = 2 | DIRECTED,
942 [CEC_MSG_SET_OSD_NAME] = 2 | DIRECTED,
943 [CEC_MSG_MENU_REQUEST] = 3 | DIRECTED,
944 [CEC_MSG_MENU_STATUS] = 3 | DIRECTED,
945 [CEC_MSG_USER_CONTROL_PRESSED] = 3 | DIRECTED,
946 [CEC_MSG_USER_CONTROL_RELEASED] = 2 | DIRECTED,
947 [CEC_MSG_GIVE_DEVICE_POWER_STATUS] = 2 | DIRECTED,
948 [CEC_MSG_REPORT_POWER_STATUS] = 3 | DIRECTED | BCAST2_0,
949 [CEC_MSG_FEATURE_ABORT] = 4 | DIRECTED,
950 [CEC_MSG_ABORT] = 2 | DIRECTED,
951 [CEC_MSG_GIVE_AUDIO_STATUS] = 2 | DIRECTED,
952 [CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS] = 2 | DIRECTED,
953 [CEC_MSG_REPORT_AUDIO_STATUS] = 3 | DIRECTED,
954 [CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR] = 2 | DIRECTED,
955 [CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR] = 2 | DIRECTED,
956 [CEC_MSG_SET_SYSTEM_AUDIO_MODE] = 3 | BOTH,
957 [CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST] = 2 | DIRECTED,
958 [CEC_MSG_SYSTEM_AUDIO_MODE_STATUS] = 3 | DIRECTED,
959 [CEC_MSG_SET_AUDIO_RATE] = 3 | DIRECTED,
960 [CEC_MSG_INITIATE_ARC] = 2 | DIRECTED,
961 [CEC_MSG_REPORT_ARC_INITIATED] = 2 | DIRECTED,
962 [CEC_MSG_REPORT_ARC_TERMINATED] = 2 | DIRECTED,
963 [CEC_MSG_REQUEST_ARC_INITIATION] = 2 | DIRECTED,
964 [CEC_MSG_REQUEST_ARC_TERMINATION] = 2 | DIRECTED,
965 [CEC_MSG_TERMINATE_ARC] = 2 | DIRECTED,
966 [CEC_MSG_REQUEST_CURRENT_LATENCY] = 4 | BCAST,
f3854973 967 [CEC_MSG_REPORT_CURRENT_LATENCY] = 6 | BCAST,
3074fe4a
HV
968 [CEC_MSG_CDC_MESSAGE] = 2 | BCAST,
969};
970
9881fe0c 971/* Called by the CEC adapter if a message is received */
0861ad14
HV
972void cec_received_msg_ts(struct cec_adapter *adap,
973 struct cec_msg *msg, ktime_t ts)
9881fe0c
HV
974{
975 struct cec_data *data;
976 u8 msg_init = cec_msg_initiator(msg);
977 u8 msg_dest = cec_msg_destination(msg);
3074fe4a 978 u8 cmd = msg->msg[1];
9881fe0c
HV
979 bool is_reply = false;
980 bool valid_la = true;
3074fe4a 981 u8 min_len = 0;
9881fe0c 982
52d802d6
HV
983 if (WARN_ON(!msg->len || msg->len > CEC_MAX_MSG_SIZE))
984 return;
985
3f98da96
HV
986 /*
987 * Some CEC adapters will receive the messages that they transmitted.
988 * This test filters out those messages by checking if we are the
989 * initiator, and just returning in that case.
990 *
991 * Note that this won't work if this is an Unregistered device.
992 *
993 * It is bad practice if the hardware receives the message that it
994 * transmitted and luckily most CEC adapters behave correctly in this
995 * respect.
996 */
997 if (msg_init != CEC_LOG_ADDR_UNREGISTERED &&
998 cec_has_log_addr(adap, msg_init))
999 return;
1000
0861ad14 1001 msg->rx_ts = ktime_to_ns(ts);
9881fe0c 1002 msg->rx_status = CEC_RX_STATUS_OK;
9881fe0c 1003 msg->sequence = msg->reply = msg->timeout = 0;
980e0b36
HV
1004 msg->tx_status = 0;
1005 msg->tx_ts = 0;
8991a63d
HV
1006 msg->tx_arb_lost_cnt = 0;
1007 msg->tx_nack_cnt = 0;
1008 msg->tx_low_drive_cnt = 0;
1009 msg->tx_error_cnt = 0;
9881fe0c 1010 msg->flags = 0;
045344c3 1011 memset(msg->msg + msg->len, 0, sizeof(msg->msg) - msg->len);
9881fe0c 1012
980e0b36 1013 mutex_lock(&adap->lock);
a7a04b5b 1014 dprintk(2, "%s: %*ph\n", __func__, msg->len, msg->msg);
9881fe0c 1015
7d867a1b
HV
1016 adap->last_initiator = 0xff;
1017
9881fe0c
HV
1018 /* Check if this message was for us (directed or broadcast). */
1019 if (!cec_msg_is_broadcast(msg))
1020 valid_la = cec_has_log_addr(adap, msg_dest);
1021
3074fe4a
HV
1022 /*
1023 * Check if the length is not too short or if the message is a
1024 * broadcast message where a directed message was expected or
1025 * vice versa. If so, then the message has to be ignored (according
1026 * to section CEC 7.3 and CEC 12.2).
1027 */
1028 if (valid_la && msg->len > 1 && cec_msg_size[cmd]) {
1029 u8 dir_fl = cec_msg_size[cmd] & BOTH;
1030
1031 min_len = cec_msg_size[cmd] & 0x1f;
1032 if (msg->len < min_len)
1033 valid_la = false;
1034 else if (!cec_msg_is_broadcast(msg) && !(dir_fl & DIRECTED))
1035 valid_la = false;
1036 else if (cec_msg_is_broadcast(msg) && !(dir_fl & BCAST1_4))
1037 valid_la = false;
1038 else if (cec_msg_is_broadcast(msg) &&
1039 adap->log_addrs.cec_version >= CEC_OP_CEC_VERSION_2_0 &&
1040 !(dir_fl & BCAST2_0))
1041 valid_la = false;
1042 }
1043 if (valid_la && min_len) {
1044 /* These messages have special length requirements */
1045 switch (cmd) {
1046 case CEC_MSG_TIMER_STATUS:
1047 if (msg->msg[2] & 0x10) {
1048 switch (msg->msg[2] & 0xf) {
1049 case CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE:
1050 case CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE:
1051 if (msg->len < 5)
1052 valid_la = false;
1053 break;
1054 }
1055 } else if ((msg->msg[2] & 0xf) == CEC_OP_PROG_ERROR_DUPLICATE) {
1056 if (msg->len < 5)
1057 valid_la = false;
1058 }
1059 break;
1060 case CEC_MSG_RECORD_ON:
1061 switch (msg->msg[2]) {
1062 case CEC_OP_RECORD_SRC_OWN:
1063 break;
1064 case CEC_OP_RECORD_SRC_DIGITAL:
1065 if (msg->len < 10)
1066 valid_la = false;
1067 break;
1068 case CEC_OP_RECORD_SRC_ANALOG:
1069 if (msg->len < 7)
1070 valid_la = false;
1071 break;
1072 case CEC_OP_RECORD_SRC_EXT_PLUG:
1073 if (msg->len < 4)
1074 valid_la = false;
1075 break;
1076 case CEC_OP_RECORD_SRC_EXT_PHYS_ADDR:
1077 if (msg->len < 5)
1078 valid_la = false;
1079 break;
1080 }
1081 break;
1082 }
1083 }
1084
9881fe0c 1085 /* It's a valid message and not a poll or CDC message */
3074fe4a 1086 if (valid_la && msg->len > 1 && cmd != CEC_MSG_CDC_MESSAGE) {
9881fe0c
HV
1087 bool abort = cmd == CEC_MSG_FEATURE_ABORT;
1088
1089 /* The aborted command is in msg[2] */
1090 if (abort)
1091 cmd = msg->msg[2];
1092
1093 /*
1094 * Walk over all transmitted messages that are waiting for a
1095 * reply.
1096 */
1097 list_for_each_entry(data, &adap->wait_queue, list) {
1098 struct cec_msg *dst = &data->msg;
9881fe0c 1099
f5580d8d
HV
1100 /*
1101 * The *only* CEC message that has two possible replies
1102 * is CEC_MSG_INITIATE_ARC.
1103 * In this case allow either of the two replies.
1104 */
1105 if (!abort && dst->msg[1] == CEC_MSG_INITIATE_ARC &&
1106 (cmd == CEC_MSG_REPORT_ARC_INITIATED ||
1107 cmd == CEC_MSG_REPORT_ARC_TERMINATED) &&
1108 (dst->reply == CEC_MSG_REPORT_ARC_INITIATED ||
1109 dst->reply == CEC_MSG_REPORT_ARC_TERMINATED))
1110 dst->reply = cmd;
1111
9881fe0c
HV
1112 /* Does the command match? */
1113 if ((abort && cmd != dst->msg[1]) ||
1114 (!abort && cmd != dst->reply))
1115 continue;
1116
1117 /* Does the addressing match? */
1118 if (msg_init != cec_msg_destination(dst) &&
1119 !cec_msg_is_broadcast(dst))
1120 continue;
1121
1122 /* We got a reply */
980e0b36
HV
1123 memcpy(dst->msg, msg->msg, msg->len);
1124 dst->len = msg->len;
1125 dst->rx_ts = msg->rx_ts;
1126 dst->rx_status = msg->rx_status;
86e3577f 1127 if (abort)
9881fe0c 1128 dst->rx_status |= CEC_RX_STATUS_FEATURE_ABORT;
adc0c622 1129 msg->flags = dst->flags;
9881fe0c
HV
1130 /* Remove it from the wait_queue */
1131 list_del_init(&data->list);
1132
1133 /* Cancel the pending timeout work */
1134 if (!cancel_delayed_work(&data->work)) {
1135 mutex_unlock(&adap->lock);
1136 flush_scheduled_work();
1137 mutex_lock(&adap->lock);
1138 }
1139 /*
1140 * Mark this as a reply, provided someone is still
1141 * waiting for the answer.
1142 */
1143 if (data->fh)
1144 is_reply = true;
1145 cec_data_completed(data);
1146 break;
1147 }
1148 }
1149 mutex_unlock(&adap->lock);
1150
1151 /* Pass the message on to any monitoring filehandles */
1152 cec_queue_msg_monitor(adap, msg, valid_la);
1153
1154 /* We're done if it is not for us or a poll message */
1155 if (!valid_la || msg->len <= 1)
1156 return;
1157
3e92d8b2
HV
1158 if (adap->log_addrs.log_addr_mask == 0)
1159 return;
1160
9881fe0c
HV
1161 /*
1162 * Process the message on the protocol level. If is_reply is true,
1163 * then cec_receive_notify() won't pass on the reply to the listener(s)
1164 * since that was already done by cec_data_completed() above.
1165 */
1166 cec_receive_notify(adap, msg, is_reply);
1167}
0861ad14 1168EXPORT_SYMBOL_GPL(cec_received_msg_ts);
9881fe0c
HV
1169
1170/* Logical Address Handling */
1171
1172/*
1173 * Attempt to claim a specific logical address.
1174 *
1175 * This function is called with adap->lock held.
1176 */
1177static int cec_config_log_addr(struct cec_adapter *adap,
1178 unsigned int idx,
1179 unsigned int log_addr)
1180{
1181 struct cec_log_addrs *las = &adap->log_addrs;
1182 struct cec_msg msg = { };
55623b41
HV
1183 const unsigned int max_retries = 2;
1184 unsigned int i;
9881fe0c
HV
1185 int err;
1186
1187 if (cec_has_log_addr(adap, log_addr))
1188 return 0;
1189
1190 /* Send poll message */
1191 msg.len = 1;
42980da2 1192 msg.msg[0] = (log_addr << 4) | log_addr;
9881fe0c 1193
55623b41
HV
1194 for (i = 0; i < max_retries; i++) {
1195 err = cec_transmit_msg_fh(adap, &msg, NULL, true);
9881fe0c 1196
55623b41
HV
1197 /*
1198 * While trying to poll the physical address was reset
1199 * and the adapter was unconfigured, so bail out.
1200 */
1201 if (!adap->is_configuring)
1202 return -EINTR;
1203
1204 if (err)
1205 return err;
9881fe0c 1206
55623b41
HV
1207 /*
1208 * The message was aborted due to a disconnect or
1209 * unconfigure, just bail out.
1210 */
1211 if (msg.tx_status & CEC_TX_STATUS_ABORTED)
1212 return -EINTR;
1213 if (msg.tx_status & CEC_TX_STATUS_OK)
1214 return 0;
1215 if (msg.tx_status & CEC_TX_STATUS_NACK)
1216 break;
1217 /*
1218 * Retry up to max_retries times if the message was neither
1219 * OKed or NACKed. This can happen due to e.g. a Lost
1220 * Arbitration condition.
1221 */
1222 }
1223
1224 /*
1225 * If we are unable to get an OK or a NACK after max_retries attempts
1226 * (and note that each attempt already consists of four polls), then
1227 * then we assume that something is really weird and that it is not a
1228 * good idea to try and claim this logical address.
1229 */
1230 if (i == max_retries)
9881fe0c
HV
1231 return 0;
1232
1233 /*
1234 * Message not acknowledged, so this logical
1235 * address is free to use.
1236 */
1237 err = adap->ops->adap_log_addr(adap, log_addr);
1238 if (err)
1239 return err;
1240
1241 las->log_addr[idx] = log_addr;
1242 las->log_addr_mask |= 1 << log_addr;
1243 adap->phys_addrs[log_addr] = adap->phys_addr;
9881fe0c
HV
1244 return 1;
1245}
1246
1247/*
1248 * Unconfigure the adapter: clear all logical addresses and send
1249 * the state changed event.
1250 *
1251 * This function is called with adap->lock held.
1252 */
1253static void cec_adap_unconfigure(struct cec_adapter *adap)
1254{
f902c1e9
HV
1255 if (!adap->needs_hpd ||
1256 adap->phys_addr != CEC_PHYS_ADDR_INVALID)
1257 WARN_ON(adap->ops->adap_log_addr(adap, CEC_LOG_ADDR_INVALID));
9881fe0c
HV
1258 adap->log_addrs.log_addr_mask = 0;
1259 adap->is_configuring = false;
1260 adap->is_configured = false;
1261 memset(adap->phys_addrs, 0xff, sizeof(adap->phys_addrs));
533a3f7b 1262 cec_flush(adap);
9881fe0c
HV
1263 wake_up_interruptible(&adap->kthread_waitq);
1264 cec_post_state_event(adap);
1265}
1266
1267/*
1268 * Attempt to claim the required logical addresses.
1269 */
1270static int cec_config_thread_func(void *arg)
1271{
1272 /* The various LAs for each type of device */
1273 static const u8 tv_log_addrs[] = {
1274 CEC_LOG_ADDR_TV, CEC_LOG_ADDR_SPECIFIC,
1275 CEC_LOG_ADDR_INVALID
1276 };
1277 static const u8 record_log_addrs[] = {
1278 CEC_LOG_ADDR_RECORD_1, CEC_LOG_ADDR_RECORD_2,
1279 CEC_LOG_ADDR_RECORD_3,
1280 CEC_LOG_ADDR_BACKUP_1, CEC_LOG_ADDR_BACKUP_2,
1281 CEC_LOG_ADDR_INVALID
1282 };
1283 static const u8 tuner_log_addrs[] = {
1284 CEC_LOG_ADDR_TUNER_1, CEC_LOG_ADDR_TUNER_2,
1285 CEC_LOG_ADDR_TUNER_3, CEC_LOG_ADDR_TUNER_4,
1286 CEC_LOG_ADDR_BACKUP_1, CEC_LOG_ADDR_BACKUP_2,
1287 CEC_LOG_ADDR_INVALID
1288 };
1289 static const u8 playback_log_addrs[] = {
1290 CEC_LOG_ADDR_PLAYBACK_1, CEC_LOG_ADDR_PLAYBACK_2,
1291 CEC_LOG_ADDR_PLAYBACK_3,
1292 CEC_LOG_ADDR_BACKUP_1, CEC_LOG_ADDR_BACKUP_2,
1293 CEC_LOG_ADDR_INVALID
1294 };
1295 static const u8 audiosystem_log_addrs[] = {
1296 CEC_LOG_ADDR_AUDIOSYSTEM,
1297 CEC_LOG_ADDR_INVALID
1298 };
1299 static const u8 specific_use_log_addrs[] = {
1300 CEC_LOG_ADDR_SPECIFIC,
1301 CEC_LOG_ADDR_BACKUP_1, CEC_LOG_ADDR_BACKUP_2,
1302 CEC_LOG_ADDR_INVALID
1303 };
1304 static const u8 *type2addrs[6] = {
1305 [CEC_LOG_ADDR_TYPE_TV] = tv_log_addrs,
1306 [CEC_LOG_ADDR_TYPE_RECORD] = record_log_addrs,
1307 [CEC_LOG_ADDR_TYPE_TUNER] = tuner_log_addrs,
1308 [CEC_LOG_ADDR_TYPE_PLAYBACK] = playback_log_addrs,
1309 [CEC_LOG_ADDR_TYPE_AUDIOSYSTEM] = audiosystem_log_addrs,
1310 [CEC_LOG_ADDR_TYPE_SPECIFIC] = specific_use_log_addrs,
1311 };
1312 static const u16 type2mask[] = {
1313 [CEC_LOG_ADDR_TYPE_TV] = CEC_LOG_ADDR_MASK_TV,
1314 [CEC_LOG_ADDR_TYPE_RECORD] = CEC_LOG_ADDR_MASK_RECORD,
1315 [CEC_LOG_ADDR_TYPE_TUNER] = CEC_LOG_ADDR_MASK_TUNER,
1316 [CEC_LOG_ADDR_TYPE_PLAYBACK] = CEC_LOG_ADDR_MASK_PLAYBACK,
1317 [CEC_LOG_ADDR_TYPE_AUDIOSYSTEM] = CEC_LOG_ADDR_MASK_AUDIOSYSTEM,
1318 [CEC_LOG_ADDR_TYPE_SPECIFIC] = CEC_LOG_ADDR_MASK_SPECIFIC,
1319 };
1320 struct cec_adapter *adap = arg;
1321 struct cec_log_addrs *las = &adap->log_addrs;
1322 int err;
1323 int i, j;
1324
1325 mutex_lock(&adap->lock);
1326 dprintk(1, "physical address: %x.%x.%x.%x, claim %d logical addresses\n",
1327 cec_phys_addr_exp(adap->phys_addr), las->num_log_addrs);
1328 las->log_addr_mask = 0;
1329
1330 if (las->log_addr_type[0] == CEC_LOG_ADDR_TYPE_UNREGISTERED)
1331 goto configured;
1332
1333 for (i = 0; i < las->num_log_addrs; i++) {
1334 unsigned int type = las->log_addr_type[i];
1335 const u8 *la_list;
1336 u8 last_la;
1337
1338 /*
1339 * The TV functionality can only map to physical address 0.
1340 * For any other address, try the Specific functionality
1341 * instead as per the spec.
1342 */
1343 if (adap->phys_addr && type == CEC_LOG_ADDR_TYPE_TV)
1344 type = CEC_LOG_ADDR_TYPE_SPECIFIC;
1345
1346 la_list = type2addrs[type];
1347 last_la = las->log_addr[i];
1348 las->log_addr[i] = CEC_LOG_ADDR_INVALID;
1349 if (last_la == CEC_LOG_ADDR_INVALID ||
1350 last_la == CEC_LOG_ADDR_UNREGISTERED ||
f9f96fc1 1351 !((1 << last_la) & type2mask[type]))
9881fe0c
HV
1352 last_la = la_list[0];
1353
1354 err = cec_config_log_addr(adap, i, last_la);
1355 if (err > 0) /* Reused last LA */
1356 continue;
1357
1358 if (err < 0)
1359 goto unconfigure;
1360
1361 for (j = 0; la_list[j] != CEC_LOG_ADDR_INVALID; j++) {
1362 /* Tried this one already, skip it */
1363 if (la_list[j] == last_la)
1364 continue;
1365 /* The backup addresses are CEC 2.0 specific */
1366 if ((la_list[j] == CEC_LOG_ADDR_BACKUP_1 ||
1367 la_list[j] == CEC_LOG_ADDR_BACKUP_2) &&
1368 las->cec_version < CEC_OP_CEC_VERSION_2_0)
1369 continue;
1370
1371 err = cec_config_log_addr(adap, i, la_list[j]);
1372 if (err == 0) /* LA is in use */
1373 continue;
1374 if (err < 0)
1375 goto unconfigure;
1376 /* Done, claimed an LA */
1377 break;
1378 }
1379
1380 if (la_list[j] == CEC_LOG_ADDR_INVALID)
1381 dprintk(1, "could not claim LA %d\n", i);
1382 }
1383
dcceb1ea
HV
1384 if (adap->log_addrs.log_addr_mask == 0 &&
1385 !(las->flags & CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK))
1386 goto unconfigure;
1387
9881fe0c
HV
1388configured:
1389 if (adap->log_addrs.log_addr_mask == 0) {
1390 /* Fall back to unregistered */
1391 las->log_addr[0] = CEC_LOG_ADDR_UNREGISTERED;
1392 las->log_addr_mask = 1 << las->log_addr[0];
0c1d61b0
HV
1393 for (i = 1; i < las->num_log_addrs; i++)
1394 las->log_addr[i] = CEC_LOG_ADDR_INVALID;
9881fe0c 1395 }
7af26f88
HV
1396 for (i = las->num_log_addrs; i < CEC_MAX_LOG_ADDRS; i++)
1397 las->log_addr[i] = CEC_LOG_ADDR_INVALID;
9881fe0c
HV
1398 adap->is_configured = true;
1399 adap->is_configuring = false;
1400 cec_post_state_event(adap);
9881fe0c 1401
f60f3560
HV
1402 /*
1403 * Now post the Report Features and Report Physical Address broadcast
1404 * messages. Note that these are non-blocking transmits, meaning that
1405 * they are just queued up and once adap->lock is unlocked the main
1406 * thread will kick in and start transmitting these.
1407 *
1408 * If after this function is done (but before one or more of these
1409 * messages are actually transmitted) the CEC adapter is unconfigured,
1410 * then any remaining messages will be dropped by the main thread.
1411 */
9881fe0c 1412 for (i = 0; i < las->num_log_addrs; i++) {
52bc30fd
HV
1413 struct cec_msg msg = {};
1414
a69a168a
HV
1415 if (las->log_addr[i] == CEC_LOG_ADDR_INVALID ||
1416 (las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY))
9881fe0c
HV
1417 continue;
1418
52bc30fd
HV
1419 msg.msg[0] = (las->log_addr[i] << 4) | 0x0f;
1420
1421 /* Report Features must come first according to CEC 2.0 */
1422 if (las->log_addr[i] != CEC_LOG_ADDR_UNREGISTERED &&
1423 adap->log_addrs.cec_version >= CEC_OP_CEC_VERSION_2_0) {
1424 cec_fill_msg_report_features(adap, &msg, i);
f60f3560 1425 cec_transmit_msg_fh(adap, &msg, NULL, false);
52bc30fd
HV
1426 }
1427
d3d64bc7
HV
1428 /* Report Physical Address */
1429 cec_msg_report_physical_addr(&msg, adap->phys_addr,
1430 las->primary_device_type[i]);
a7a04b5b 1431 dprintk(1, "config: la %d pa %x.%x.%x.%x\n",
d3d64bc7
HV
1432 las->log_addr[i],
1433 cec_phys_addr_exp(adap->phys_addr));
f60f3560 1434 cec_transmit_msg_fh(adap, &msg, NULL, false);
9881fe0c 1435 }
9881fe0c 1436 adap->kthread_config = NULL;
9881fe0c 1437 complete(&adap->config_completion);
f60f3560 1438 mutex_unlock(&adap->lock);
9881fe0c
HV
1439 return 0;
1440
1441unconfigure:
1442 for (i = 0; i < las->num_log_addrs; i++)
1443 las->log_addr[i] = CEC_LOG_ADDR_INVALID;
1444 cec_adap_unconfigure(adap);
1445 adap->kthread_config = NULL;
1446 mutex_unlock(&adap->lock);
1447 complete(&adap->config_completion);
1448 return 0;
1449}
1450
1451/*
1452 * Called from either __cec_s_phys_addr or __cec_s_log_addrs to claim the
1453 * logical addresses.
1454 *
1455 * This function is called with adap->lock held.
1456 */
1457static void cec_claim_log_addrs(struct cec_adapter *adap, bool block)
1458{
1459 if (WARN_ON(adap->is_configuring || adap->is_configured))
1460 return;
1461
1462 init_completion(&adap->config_completion);
1463
1464 /* Ready to kick off the thread */
1465 adap->is_configuring = true;
1466 adap->kthread_config = kthread_run(cec_config_thread_func, adap,
1467 "ceccfg-%s", adap->name);
1468 if (IS_ERR(adap->kthread_config)) {
1469 adap->kthread_config = NULL;
1470 } else if (block) {
1471 mutex_unlock(&adap->lock);
1472 wait_for_completion(&adap->config_completion);
1473 mutex_lock(&adap->lock);
1474 }
1475}
1476
1477/* Set a new physical address and send an event notifying userspace of this.
1478 *
1479 * This function is called with adap->lock held.
1480 */
1481void __cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr, bool block)
1482{
152b0a9a
HV
1483 if (phys_addr == adap->phys_addr)
1484 return;
1485 if (phys_addr != CEC_PHYS_ADDR_INVALID && adap->devnode.unregistered)
9881fe0c
HV
1486 return;
1487
f902c1e9
HV
1488 dprintk(1, "new physical address %x.%x.%x.%x\n",
1489 cec_phys_addr_exp(phys_addr));
9881fe0c
HV
1490 if (phys_addr == CEC_PHYS_ADDR_INVALID ||
1491 adap->phys_addr != CEC_PHYS_ADDR_INVALID) {
1492 adap->phys_addr = CEC_PHYS_ADDR_INVALID;
1493 cec_post_state_event(adap);
1494 cec_adap_unconfigure(adap);
1495 /* Disabling monitor all mode should always succeed */
1496 if (adap->monitor_all_cnt)
1497 WARN_ON(call_op(adap, adap_monitor_all_enable, false));
533a3f7b 1498 mutex_lock(&adap->devnode.lock);
f902c1e9 1499 if (adap->needs_hpd || list_empty(&adap->devnode.fhs))
533a3f7b
HV
1500 WARN_ON(adap->ops->adap_enable(adap, false));
1501 mutex_unlock(&adap->devnode.lock);
9881fe0c
HV
1502 if (phys_addr == CEC_PHYS_ADDR_INVALID)
1503 return;
1504 }
1505
533a3f7b 1506 mutex_lock(&adap->devnode.lock);
7d867a1b
HV
1507 adap->last_initiator = 0xff;
1508
f902c1e9 1509 if ((adap->needs_hpd || list_empty(&adap->devnode.fhs)) &&
533a3f7b
HV
1510 adap->ops->adap_enable(adap, true)) {
1511 mutex_unlock(&adap->devnode.lock);
9881fe0c 1512 return;
533a3f7b 1513 }
9881fe0c
HV
1514
1515 if (adap->monitor_all_cnt &&
1516 call_op(adap, adap_monitor_all_enable, true)) {
f902c1e9 1517 if (adap->needs_hpd || list_empty(&adap->devnode.fhs))
533a3f7b
HV
1518 WARN_ON(adap->ops->adap_enable(adap, false));
1519 mutex_unlock(&adap->devnode.lock);
9881fe0c
HV
1520 return;
1521 }
533a3f7b
HV
1522 mutex_unlock(&adap->devnode.lock);
1523
9881fe0c
HV
1524 adap->phys_addr = phys_addr;
1525 cec_post_state_event(adap);
1526 if (adap->log_addrs.num_log_addrs)
1527 cec_claim_log_addrs(adap, block);
1528}
1529
1530void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr, bool block)
1531{
1532 if (IS_ERR_OR_NULL(adap))
1533 return;
1534
9881fe0c
HV
1535 mutex_lock(&adap->lock);
1536 __cec_s_phys_addr(adap, phys_addr, block);
1537 mutex_unlock(&adap->lock);
1538}
1539EXPORT_SYMBOL_GPL(cec_s_phys_addr);
1540
23111ec3
HV
1541void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
1542 const struct edid *edid)
1543{
1544 u16 pa = CEC_PHYS_ADDR_INVALID;
1545
1546 if (edid && edid->extensions)
1547 pa = cec_get_edid_phys_addr((const u8 *)edid,
1548 EDID_LENGTH * (edid->extensions + 1), NULL);
1549 cec_s_phys_addr(adap, pa, false);
1550}
1551EXPORT_SYMBOL_GPL(cec_s_phys_addr_from_edid);
1552
9881fe0c
HV
1553/*
1554 * Called from either the ioctl or a driver to set the logical addresses.
1555 *
1556 * This function is called with adap->lock held.
1557 */
1558int __cec_s_log_addrs(struct cec_adapter *adap,
1559 struct cec_log_addrs *log_addrs, bool block)
1560{
1561 u16 type_mask = 0;
1562 int i;
1563
c000e5da
HV
1564 if (adap->devnode.unregistered)
1565 return -ENODEV;
1566
9881fe0c 1567 if (!log_addrs || log_addrs->num_log_addrs == 0) {
9881fe0c 1568 cec_adap_unconfigure(adap);
299708e4
HV
1569 adap->log_addrs.num_log_addrs = 0;
1570 for (i = 0; i < CEC_MAX_LOG_ADDRS; i++)
1571 adap->log_addrs.log_addr[i] = CEC_LOG_ADDR_INVALID;
1572 adap->log_addrs.osd_name[0] = '\0';
1573 adap->log_addrs.vendor_id = CEC_VENDOR_ID_NONE;
1574 adap->log_addrs.cec_version = CEC_OP_CEC_VERSION_2_0;
9881fe0c
HV
1575 return 0;
1576 }
1577
a69a168a
HV
1578 if (log_addrs->flags & CEC_LOG_ADDRS_FL_CDC_ONLY) {
1579 /*
1580 * Sanitize log_addrs fields if a CDC-Only device is
1581 * requested.
1582 */
1583 log_addrs->num_log_addrs = 1;
1584 log_addrs->osd_name[0] = '\0';
1585 log_addrs->vendor_id = CEC_VENDOR_ID_NONE;
1586 log_addrs->log_addr_type[0] = CEC_LOG_ADDR_TYPE_UNREGISTERED;
1587 /*
1588 * This is just an internal convention since a CDC-Only device
1589 * doesn't have to be a switch. But switches already use
1590 * unregistered, so it makes some kind of sense to pick this
1591 * as the primary device. Since a CDC-Only device never sends
1592 * any 'normal' CEC messages this primary device type is never
1593 * sent over the CEC bus.
1594 */
1595 log_addrs->primary_device_type[0] = CEC_OP_PRIM_DEVTYPE_SWITCH;
1596 log_addrs->all_device_types[0] = 0;
1597 log_addrs->features[0][0] = 0;
1598 log_addrs->features[0][1] = 0;
1599 }
1600
9881fe0c
HV
1601 /* Ensure the osd name is 0-terminated */
1602 log_addrs->osd_name[sizeof(log_addrs->osd_name) - 1] = '\0';
1603
1604 /* Sanity checks */
1605 if (log_addrs->num_log_addrs > adap->available_log_addrs) {
1606 dprintk(1, "num_log_addrs > %d\n", adap->available_log_addrs);
1607 return -EINVAL;
1608 }
1609
1610 /*
1611 * Vendor ID is a 24 bit number, so check if the value is
1612 * within the correct range.
1613 */
1614 if (log_addrs->vendor_id != CEC_VENDOR_ID_NONE &&
79cabaa3
HV
1615 (log_addrs->vendor_id & 0xff000000) != 0) {
1616 dprintk(1, "invalid vendor ID\n");
9881fe0c 1617 return -EINVAL;
79cabaa3 1618 }
9881fe0c
HV
1619
1620 if (log_addrs->cec_version != CEC_OP_CEC_VERSION_1_4 &&
79cabaa3
HV
1621 log_addrs->cec_version != CEC_OP_CEC_VERSION_2_0) {
1622 dprintk(1, "invalid CEC version\n");
9881fe0c 1623 return -EINVAL;
79cabaa3 1624 }
9881fe0c
HV
1625
1626 if (log_addrs->num_log_addrs > 1)
1627 for (i = 0; i < log_addrs->num_log_addrs; i++)
1628 if (log_addrs->log_addr_type[i] ==
1629 CEC_LOG_ADDR_TYPE_UNREGISTERED) {
1630 dprintk(1, "num_log_addrs > 1 can't be combined with unregistered LA\n");
1631 return -EINVAL;
1632 }
1633
9881fe0c 1634 for (i = 0; i < log_addrs->num_log_addrs; i++) {
009a6208 1635 const u8 feature_sz = ARRAY_SIZE(log_addrs->features[0]);
9881fe0c
HV
1636 u8 *features = log_addrs->features[i];
1637 bool op_is_dev_features = false;
a161bef0 1638 unsigned j;
9881fe0c
HV
1639
1640 log_addrs->log_addr[i] = CEC_LOG_ADDR_INVALID;
1641 if (type_mask & (1 << log_addrs->log_addr_type[i])) {
1642 dprintk(1, "duplicate logical address type\n");
1643 return -EINVAL;
1644 }
1645 type_mask |= 1 << log_addrs->log_addr_type[i];
1646 if ((type_mask & (1 << CEC_LOG_ADDR_TYPE_RECORD)) &&
1647 (type_mask & (1 << CEC_LOG_ADDR_TYPE_PLAYBACK))) {
1648 /* Record already contains the playback functionality */
1649 dprintk(1, "invalid record + playback combination\n");
1650 return -EINVAL;
1651 }
1652 if (log_addrs->primary_device_type[i] >
1653 CEC_OP_PRIM_DEVTYPE_PROCESSOR) {
1654 dprintk(1, "unknown primary device type\n");
1655 return -EINVAL;
1656 }
1657 if (log_addrs->primary_device_type[i] == 2) {
1658 dprintk(1, "invalid primary device type\n");
1659 return -EINVAL;
1660 }
1661 if (log_addrs->log_addr_type[i] > CEC_LOG_ADDR_TYPE_UNREGISTERED) {
1662 dprintk(1, "unknown logical address type\n");
1663 return -EINVAL;
1664 }
a161bef0
HV
1665 for (j = 0; j < feature_sz; j++) {
1666 if ((features[j] & 0x80) == 0) {
9881fe0c
HV
1667 if (op_is_dev_features)
1668 break;
1669 op_is_dev_features = true;
1670 }
1671 }
a161bef0 1672 if (!op_is_dev_features || j == feature_sz) {
9881fe0c
HV
1673 dprintk(1, "malformed features\n");
1674 return -EINVAL;
1675 }
009a6208 1676 /* Zero unused part of the feature array */
a161bef0 1677 memset(features + j + 1, 0, feature_sz - j - 1);
9881fe0c
HV
1678 }
1679
1680 if (log_addrs->cec_version >= CEC_OP_CEC_VERSION_2_0) {
1681 if (log_addrs->num_log_addrs > 2) {
1682 dprintk(1, "CEC 2.0 allows no more than 2 logical addresses\n");
1683 return -EINVAL;
1684 }
1685 if (log_addrs->num_log_addrs == 2) {
1686 if (!(type_mask & ((1 << CEC_LOG_ADDR_TYPE_AUDIOSYSTEM) |
1687 (1 << CEC_LOG_ADDR_TYPE_TV)))) {
a7a04b5b 1688 dprintk(1, "two LAs is only allowed for audiosystem and TV\n");
9881fe0c
HV
1689 return -EINVAL;
1690 }
1691 if (!(type_mask & ((1 << CEC_LOG_ADDR_TYPE_PLAYBACK) |
1692 (1 << CEC_LOG_ADDR_TYPE_RECORD)))) {
a7a04b5b 1693 dprintk(1, "an audiosystem/TV can only be combined with record or playback\n");
9881fe0c
HV
1694 return -EINVAL;
1695 }
1696 }
1697 }
1698
009a6208
HV
1699 /* Zero unused LAs */
1700 for (i = log_addrs->num_log_addrs; i < CEC_MAX_LOG_ADDRS; i++) {
1701 log_addrs->primary_device_type[i] = 0;
1702 log_addrs->log_addr_type[i] = 0;
1703 log_addrs->all_device_types[i] = 0;
1704 memset(log_addrs->features[i], 0,
1705 sizeof(log_addrs->features[i]));
1706 }
1707
9881fe0c
HV
1708 log_addrs->log_addr_mask = adap->log_addrs.log_addr_mask;
1709 adap->log_addrs = *log_addrs;
1710 if (adap->phys_addr != CEC_PHYS_ADDR_INVALID)
1711 cec_claim_log_addrs(adap, block);
1712 return 0;
1713}
1714
1715int cec_s_log_addrs(struct cec_adapter *adap,
1716 struct cec_log_addrs *log_addrs, bool block)
1717{
1718 int err;
1719
9881fe0c
HV
1720 mutex_lock(&adap->lock);
1721 err = __cec_s_log_addrs(adap, log_addrs, block);
1722 mutex_unlock(&adap->lock);
1723 return err;
1724}
1725EXPORT_SYMBOL_GPL(cec_s_log_addrs);
1726
1727/* High-level core CEC message handling */
1728
52bc30fd
HV
1729/* Fill in the Report Features message */
1730static void cec_fill_msg_report_features(struct cec_adapter *adap,
1731 struct cec_msg *msg,
1732 unsigned int la_idx)
9881fe0c 1733{
9881fe0c
HV
1734 const struct cec_log_addrs *las = &adap->log_addrs;
1735 const u8 *features = las->features[la_idx];
1736 bool op_is_dev_features = false;
1737 unsigned int idx;
1738
9881fe0c 1739 /* Report Features */
52bc30fd
HV
1740 msg->msg[0] = (las->log_addr[la_idx] << 4) | 0x0f;
1741 msg->len = 4;
1742 msg->msg[1] = CEC_MSG_REPORT_FEATURES;
1743 msg->msg[2] = adap->log_addrs.cec_version;
1744 msg->msg[3] = las->all_device_types[la_idx];
9881fe0c
HV
1745
1746 /* Write RC Profiles first, then Device Features */
1747 for (idx = 0; idx < ARRAY_SIZE(las->features[0]); idx++) {
52bc30fd 1748 msg->msg[msg->len++] = features[idx];
9881fe0c
HV
1749 if ((features[idx] & CEC_OP_FEAT_EXT) == 0) {
1750 if (op_is_dev_features)
1751 break;
1752 op_is_dev_features = true;
1753 }
1754 }
9881fe0c
HV
1755}
1756
9881fe0c
HV
1757/* Transmit the Feature Abort message */
1758static int cec_feature_abort_reason(struct cec_adapter *adap,
1759 struct cec_msg *msg, u8 reason)
1760{
1761 struct cec_msg tx_msg = { };
1762
1763 /*
1764 * Don't reply with CEC_MSG_FEATURE_ABORT to a CEC_MSG_FEATURE_ABORT
1765 * message!
1766 */
1767 if (msg->msg[1] == CEC_MSG_FEATURE_ABORT)
1768 return 0;
a8e97e53
HV
1769 /* Don't Feature Abort messages from 'Unregistered' */
1770 if (cec_msg_initiator(msg) == CEC_LOG_ADDR_UNREGISTERED)
1771 return 0;
9881fe0c
HV
1772 cec_msg_set_reply_to(&tx_msg, msg);
1773 cec_msg_feature_abort(&tx_msg, msg->msg[1], reason);
1774 return cec_transmit_msg(adap, &tx_msg, false);
1775}
1776
1777static int cec_feature_abort(struct cec_adapter *adap, struct cec_msg *msg)
1778{
1779 return cec_feature_abort_reason(adap, msg,
1780 CEC_OP_ABORT_UNRECOGNIZED_OP);
1781}
1782
1783static int cec_feature_refused(struct cec_adapter *adap, struct cec_msg *msg)
1784{
1785 return cec_feature_abort_reason(adap, msg,
1786 CEC_OP_ABORT_REFUSED);
1787}
1788
1789/*
1790 * Called when a CEC message is received. This function will do any
1791 * necessary core processing. The is_reply bool is true if this message
1792 * is a reply to an earlier transmit.
1793 *
1794 * The message is either a broadcast message or a valid directed message.
1795 */
1796static int cec_receive_notify(struct cec_adapter *adap, struct cec_msg *msg,
1797 bool is_reply)
1798{
1799 bool is_broadcast = cec_msg_is_broadcast(msg);
1800 u8 dest_laddr = cec_msg_destination(msg);
1801 u8 init_laddr = cec_msg_initiator(msg);
1802 u8 devtype = cec_log_addr2dev(adap, dest_laddr);
1803 int la_idx = cec_log_addr2idx(adap, dest_laddr);
9881fe0c
HV
1804 bool from_unregistered = init_laddr == 0xf;
1805 struct cec_msg tx_cec_msg = { };
1806
a7a04b5b 1807 dprintk(2, "%s: %*ph\n", __func__, msg->len, msg->msg);
9881fe0c 1808
a69a168a
HV
1809 /* If this is a CDC-Only device, then ignore any non-CDC messages */
1810 if (cec_is_cdc_only(&adap->log_addrs) &&
1811 msg->msg[1] != CEC_MSG_CDC_MESSAGE)
1812 return 0;
1813
9881fe0c
HV
1814 if (adap->ops->received) {
1815 /* Allow drivers to process the message first */
1816 if (adap->ops->received(adap, msg) != -ENOMSG)
1817 return 0;
1818 }
1819
1820 /*
1821 * REPORT_PHYSICAL_ADDR, CEC_MSG_USER_CONTROL_PRESSED and
1822 * CEC_MSG_USER_CONTROL_RELEASED messages always have to be
1823 * handled by the CEC core, even if the passthrough mode is on.
1824 * The others are just ignored if passthrough mode is on.
1825 */
1826 switch (msg->msg[1]) {
1827 case CEC_MSG_GET_CEC_VERSION:
9881fe0c
HV
1828 case CEC_MSG_ABORT:
1829 case CEC_MSG_GIVE_DEVICE_POWER_STATUS:
9881fe0c 1830 case CEC_MSG_GIVE_OSD_NAME:
845d6524
JA
1831 /*
1832 * These messages reply with a directed message, so ignore if
1833 * the initiator is Unregistered.
1834 */
1835 if (!adap->passthrough && from_unregistered)
1836 return 0;
1837 /* Fall through */
1838 case CEC_MSG_GIVE_DEVICE_VENDOR_ID:
9881fe0c 1839 case CEC_MSG_GIVE_FEATURES:
845d6524 1840 case CEC_MSG_GIVE_PHYSICAL_ADDR:
9881fe0c
HV
1841 /*
1842 * Skip processing these messages if the passthrough mode
1843 * is on.
1844 */
1845 if (adap->passthrough)
1846 goto skip_processing;
1847 /* Ignore if addressing is wrong */
845d6524 1848 if (is_broadcast)
9881fe0c
HV
1849 return 0;
1850 break;
1851
1852 case CEC_MSG_USER_CONTROL_PRESSED:
1853 case CEC_MSG_USER_CONTROL_RELEASED:
1854 /* Wrong addressing mode: don't process */
1855 if (is_broadcast || from_unregistered)
1856 goto skip_processing;
1857 break;
1858
1859 case CEC_MSG_REPORT_PHYSICAL_ADDR:
1860 /*
1861 * This message is always processed, regardless of the
1862 * passthrough setting.
1863 *
1864 * Exception: don't process if wrong addressing mode.
1865 */
1866 if (!is_broadcast)
1867 goto skip_processing;
1868 break;
1869
1870 default:
1871 break;
1872 }
1873
1874 cec_msg_set_reply_to(&tx_cec_msg, msg);
1875
1876 switch (msg->msg[1]) {
1877 /* The following messages are processed but still passed through */
f8db65fe
HV
1878 case CEC_MSG_REPORT_PHYSICAL_ADDR: {
1879 u16 pa = (msg->msg[2] << 8) | msg->msg[3];
1880
1881 if (!from_unregistered)
1882 adap->phys_addrs[init_laddr] = pa;
a7a04b5b 1883 dprintk(1, "reported physical address %x.%x.%x.%x for logical address %d\n",
f8db65fe 1884 cec_phys_addr_exp(pa), init_laddr);
9881fe0c 1885 break;
f8db65fe 1886 }
9881fe0c
HV
1887
1888 case CEC_MSG_USER_CONTROL_PRESSED:
f4062625
HV
1889 if (!(adap->capabilities & CEC_CAP_RC) ||
1890 !(adap->log_addrs.flags & CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU))
9881fe0c
HV
1891 break;
1892
5f2c467c 1893#ifdef CONFIG_MEDIA_CEC_RC
9881fe0c
HV
1894 switch (msg->msg[2]) {
1895 /*
1896 * Play function, this message can have variable length
1897 * depending on the specific play function that is used.
1898 */
1899 case 0x60:
1900 if (msg->len == 2)
57c642cb
SY
1901 rc_keydown(adap->rc, RC_PROTO_CEC,
1902 msg->msg[2], 0);
9881fe0c 1903 else
57c642cb
SY
1904 rc_keydown(adap->rc, RC_PROTO_CEC,
1905 msg->msg[2] << 8 | msg->msg[3], 0);
9881fe0c
HV
1906 break;
1907 /*
1908 * Other function messages that are not handled.
1909 * Currently the RC framework does not allow to supply an
1910 * additional parameter to a keypress. These "keys" contain
1911 * other information such as channel number, an input number
1912 * etc.
1913 * For the time being these messages are not processed by the
1914 * framework and are simply forwarded to the user space.
1915 */
1916 case 0x56: case 0x57:
1917 case 0x67: case 0x68: case 0x69: case 0x6a:
1918 break;
1919 default:
57c642cb 1920 rc_keydown(adap->rc, RC_PROTO_CEC, msg->msg[2], 0);
9881fe0c
HV
1921 break;
1922 }
1923#endif
1924 break;
1925
1926 case CEC_MSG_USER_CONTROL_RELEASED:
f4062625
HV
1927 if (!(adap->capabilities & CEC_CAP_RC) ||
1928 !(adap->log_addrs.flags & CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU))
9881fe0c 1929 break;
5f2c467c 1930#ifdef CONFIG_MEDIA_CEC_RC
9881fe0c
HV
1931 rc_keyup(adap->rc);
1932#endif
1933 break;
1934
1935 /*
1936 * The remaining messages are only processed if the passthrough mode
1937 * is off.
1938 */
1939 case CEC_MSG_GET_CEC_VERSION:
1940 cec_msg_cec_version(&tx_cec_msg, adap->log_addrs.cec_version);
1941 return cec_transmit_msg(adap, &tx_cec_msg, false);
1942
1943 case CEC_MSG_GIVE_PHYSICAL_ADDR:
1944 /* Do nothing for CEC switches using addr 15 */
1945 if (devtype == CEC_OP_PRIM_DEVTYPE_SWITCH && dest_laddr == 15)
1946 return 0;
1947 cec_msg_report_physical_addr(&tx_cec_msg, adap->phys_addr, devtype);
1948 return cec_transmit_msg(adap, &tx_cec_msg, false);
1949
1950 case CEC_MSG_GIVE_DEVICE_VENDOR_ID:
1951 if (adap->log_addrs.vendor_id == CEC_VENDOR_ID_NONE)
1952 return cec_feature_abort(adap, msg);
1953 cec_msg_device_vendor_id(&tx_cec_msg, adap->log_addrs.vendor_id);
1954 return cec_transmit_msg(adap, &tx_cec_msg, false);
1955
1956 case CEC_MSG_ABORT:
1957 /* Do nothing for CEC switches */
1958 if (devtype == CEC_OP_PRIM_DEVTYPE_SWITCH)
1959 return 0;
1960 return cec_feature_refused(adap, msg);
1961
1962 case CEC_MSG_GIVE_OSD_NAME: {
1963 if (adap->log_addrs.osd_name[0] == 0)
1964 return cec_feature_abort(adap, msg);
1965 cec_msg_set_osd_name(&tx_cec_msg, adap->log_addrs.osd_name);
1966 return cec_transmit_msg(adap, &tx_cec_msg, false);
1967 }
1968
1969 case CEC_MSG_GIVE_FEATURES:
a24f56d4
HV
1970 if (adap->log_addrs.cec_version < CEC_OP_CEC_VERSION_2_0)
1971 return cec_feature_abort(adap, msg);
52bc30fd
HV
1972 cec_fill_msg_report_features(adap, &tx_cec_msg, la_idx);
1973 return cec_transmit_msg(adap, &tx_cec_msg, false);
9881fe0c
HV
1974
1975 default:
1976 /*
1977 * Unprocessed messages are aborted if userspace isn't doing
1978 * any processing either.
1979 */
a179b693 1980 if (!is_broadcast && !is_reply && !adap->follower_cnt &&
9881fe0c
HV
1981 !adap->cec_follower && msg->msg[1] != CEC_MSG_FEATURE_ABORT)
1982 return cec_feature_abort(adap, msg);
1983 break;
1984 }
1985
1986skip_processing:
adc0c622
HV
1987 /* If this was a reply, then we're done, unless otherwise specified */
1988 if (is_reply && !(msg->flags & CEC_MSG_FL_REPLY_TO_FOLLOWERS))
9881fe0c
HV
1989 return 0;
1990
1991 /*
1992 * Send to the exclusive follower if there is one, otherwise send
1993 * to all followers.
1994 */
1995 if (adap->cec_follower)
1996 cec_queue_msg_fh(adap->cec_follower, msg);
1997 else
1998 cec_queue_msg_followers(adap, msg);
1999 return 0;
2000}
2001
2002/*
2003 * Helper functions to keep track of the 'monitor all' use count.
2004 *
2005 * These functions are called with adap->lock held.
2006 */
2007int cec_monitor_all_cnt_inc(struct cec_adapter *adap)
2008{
2009 int ret = 0;
2010
2011 if (adap->monitor_all_cnt == 0)
2012 ret = call_op(adap, adap_monitor_all_enable, 1);
2013 if (ret == 0)
2014 adap->monitor_all_cnt++;
2015 return ret;
2016}
2017
2018void cec_monitor_all_cnt_dec(struct cec_adapter *adap)
2019{
2020 adap->monitor_all_cnt--;
2021 if (adap->monitor_all_cnt == 0)
2022 WARN_ON(call_op(adap, adap_monitor_all_enable, 0));
2023}
2024
48ea2e92
HV
2025/*
2026 * Helper functions to keep track of the 'monitor pin' use count.
2027 *
2028 * These functions are called with adap->lock held.
2029 */
2030int cec_monitor_pin_cnt_inc(struct cec_adapter *adap)
2031{
2032 int ret = 0;
2033
2034 if (adap->monitor_pin_cnt == 0)
2035 ret = call_op(adap, adap_monitor_pin_enable, 1);
2036 if (ret == 0)
2037 adap->monitor_pin_cnt++;
2038 return ret;
2039}
2040
2041void cec_monitor_pin_cnt_dec(struct cec_adapter *adap)
2042{
2043 adap->monitor_pin_cnt--;
2044 if (adap->monitor_pin_cnt == 0)
2045 WARN_ON(call_op(adap, adap_monitor_pin_enable, 0));
2046}
2047
20249f84 2048#ifdef CONFIG_DEBUG_FS
9881fe0c
HV
2049/*
2050 * Log the current state of the CEC adapter.
2051 * Very useful for debugging.
2052 */
2053int cec_adap_status(struct seq_file *file, void *priv)
2054{
2055 struct cec_adapter *adap = dev_get_drvdata(file->private);
2056 struct cec_data *data;
2057
2058 mutex_lock(&adap->lock);
2059 seq_printf(file, "configured: %d\n", adap->is_configured);
2060 seq_printf(file, "configuring: %d\n", adap->is_configuring);
2061 seq_printf(file, "phys_addr: %x.%x.%x.%x\n",
2062 cec_phys_addr_exp(adap->phys_addr));
2063 seq_printf(file, "number of LAs: %d\n", adap->log_addrs.num_log_addrs);
2064 seq_printf(file, "LA mask: 0x%04x\n", adap->log_addrs.log_addr_mask);
2065 if (adap->cec_follower)
2066 seq_printf(file, "has CEC follower%s\n",
2067 adap->passthrough ? " (in passthrough mode)" : "");
2068 if (adap->cec_initiator)
2069 seq_puts(file, "has CEC initiator\n");
2070 if (adap->monitor_all_cnt)
2071 seq_printf(file, "file handles in Monitor All mode: %u\n",
2072 adap->monitor_all_cnt);
bb789e03
HV
2073 if (adap->tx_timeouts) {
2074 seq_printf(file, "transmit timeouts: %u\n",
2075 adap->tx_timeouts);
2076 adap->tx_timeouts = 0;
2077 }
9881fe0c
HV
2078 data = adap->transmitting;
2079 if (data)
11065f85
HV
2080 seq_printf(file, "transmitting message: %*ph (reply: %02x, timeout: %ums)\n",
2081 data->msg.len, data->msg.msg, data->msg.reply,
2082 data->msg.timeout);
2083 seq_printf(file, "pending transmits: %u\n", adap->transmit_queue_sz);
9881fe0c 2084 list_for_each_entry(data, &adap->transmit_queue, list) {
11065f85
HV
2085 seq_printf(file, "queued tx message: %*ph (reply: %02x, timeout: %ums)\n",
2086 data->msg.len, data->msg.msg, data->msg.reply,
2087 data->msg.timeout);
9881fe0c
HV
2088 }
2089 list_for_each_entry(data, &adap->wait_queue, list) {
11065f85
HV
2090 seq_printf(file, "message waiting for reply: %*ph (reply: %02x, timeout: %ums)\n",
2091 data->msg.len, data->msg.msg, data->msg.reply,
2092 data->msg.timeout);
9881fe0c
HV
2093 }
2094
2095 call_void_op(adap, adap_status, file);
2096 mutex_unlock(&adap->lock);
2097 return 0;
2098}
2099#endif
This page took 0.517921 seconds and 4 git commands to generate.