Lines Matching full:ec
3 * ec.c - ACPI Embedded Controller Driver (v3)
17 #define pr_fmt(fmt) "ACPI: EC: " fmt
40 /* EC status register */
45 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
49 * This leads to lots of practical timing issues for the host EC driver.
50 * The following variations are defined (from the target EC firmware's
59 * kind of EC firmware has implemented an event queue and will
79 /* EC commands */
88 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
90 #define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */
92 * when trying to clear the EC */
109 /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
112 MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
120 MODULE_PARM_DESC(ec_busy_polling, "Use busy polling to advance EC transaction");
124 MODULE_PARM_DESC(ec_polling_guard, "Guard time(us) between EC accesses in polling modes");
170 struct acpi_ec *ec; member
173 static int acpi_ec_submit_query(struct acpi_ec *ec);
174 static void advance_transaction(struct acpi_ec *ec, bool interrupt);
194 * Splitters used by the developers to track the boundary of the EC
230 #define ec_dbg_ref(ec, fmt, ...) \ argument
231 ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
237 static bool acpi_ec_started(struct acpi_ec *ec) in acpi_ec_started() argument
239 return test_bit(EC_FLAGS_STARTED, &ec->flags) && in acpi_ec_started()
240 !test_bit(EC_FLAGS_STOPPED, &ec->flags); in acpi_ec_started()
243 static bool acpi_ec_event_enabled(struct acpi_ec *ec) in acpi_ec_event_enabled() argument
248 * the EC transactions are allowed to be performed. in acpi_ec_event_enabled()
250 if (!test_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags)) in acpi_ec_event_enabled()
256 * 1. true: The EC event handling is disabled before entering in acpi_ec_event_enabled()
258 * 2. false: The EC event handling is automatically disabled as in acpi_ec_event_enabled()
259 * soon as the EC driver is stopped. in acpi_ec_event_enabled()
262 return acpi_ec_started(ec); in acpi_ec_event_enabled()
264 return test_bit(EC_FLAGS_STARTED, &ec->flags); in acpi_ec_event_enabled()
267 static bool acpi_ec_flushed(struct acpi_ec *ec) in acpi_ec_flushed() argument
269 return ec->reference_count == 1; in acpi_ec_flushed()
273 * EC Registers
276 static inline u8 acpi_ec_read_status(struct acpi_ec *ec) in acpi_ec_read_status() argument
278 u8 x = inb(ec->command_addr); in acpi_ec_read_status()
291 static inline u8 acpi_ec_read_data(struct acpi_ec *ec) in acpi_ec_read_data() argument
293 u8 x = inb(ec->data_addr); in acpi_ec_read_data()
295 ec->timestamp = jiffies; in acpi_ec_read_data()
300 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command) in acpi_ec_write_cmd() argument
303 outb(command, ec->command_addr); in acpi_ec_write_cmd()
304 ec->timestamp = jiffies; in acpi_ec_write_cmd()
307 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data) in acpi_ec_write_data() argument
310 outb(data, ec->data_addr); in acpi_ec_write_data()
311 ec->timestamp = jiffies; in acpi_ec_write_data()
339 static inline bool acpi_ec_gpe_status_set(struct acpi_ec *ec) in acpi_ec_gpe_status_set() argument
343 (void)acpi_get_gpe_status(NULL, ec->gpe, &gpe_status); in acpi_ec_gpe_status_set()
347 static inline void acpi_ec_enable_gpe(struct acpi_ec *ec, bool open) in acpi_ec_enable_gpe() argument
350 acpi_enable_gpe(NULL, ec->gpe); in acpi_ec_enable_gpe()
352 BUG_ON(ec->reference_count < 1); in acpi_ec_enable_gpe()
353 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE); in acpi_ec_enable_gpe()
355 if (acpi_ec_gpe_status_set(ec)) { in acpi_ec_enable_gpe()
362 advance_transaction(ec, false); in acpi_ec_enable_gpe()
366 static inline void acpi_ec_disable_gpe(struct acpi_ec *ec, bool close) in acpi_ec_disable_gpe() argument
369 acpi_disable_gpe(NULL, ec->gpe); in acpi_ec_disable_gpe()
371 BUG_ON(ec->reference_count < 1); in acpi_ec_disable_gpe()
372 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE); in acpi_ec_disable_gpe()
380 static void acpi_ec_submit_request(struct acpi_ec *ec) in acpi_ec_submit_request() argument
382 ec->reference_count++; in acpi_ec_submit_request()
383 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags) && in acpi_ec_submit_request()
384 ec->gpe >= 0 && ec->reference_count == 1) in acpi_ec_submit_request()
385 acpi_ec_enable_gpe(ec, true); in acpi_ec_submit_request()
388 static void acpi_ec_complete_request(struct acpi_ec *ec) in acpi_ec_complete_request() argument
392 ec->reference_count--; in acpi_ec_complete_request()
393 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags) && in acpi_ec_complete_request()
394 ec->gpe >= 0 && ec->reference_count == 0) in acpi_ec_complete_request()
395 acpi_ec_disable_gpe(ec, true); in acpi_ec_complete_request()
396 flushed = acpi_ec_flushed(ec); in acpi_ec_complete_request()
398 wake_up(&ec->wait); in acpi_ec_complete_request()
401 static void acpi_ec_mask_events(struct acpi_ec *ec) in acpi_ec_mask_events() argument
403 if (!test_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags)) { in acpi_ec_mask_events()
404 if (ec->gpe >= 0) in acpi_ec_mask_events()
405 acpi_ec_disable_gpe(ec, false); in acpi_ec_mask_events()
407 disable_irq_nosync(ec->irq); in acpi_ec_mask_events()
410 set_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags); in acpi_ec_mask_events()
414 static void acpi_ec_unmask_events(struct acpi_ec *ec) in acpi_ec_unmask_events() argument
416 if (test_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags)) { in acpi_ec_unmask_events()
417 clear_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags); in acpi_ec_unmask_events()
418 if (ec->gpe >= 0) in acpi_ec_unmask_events()
419 acpi_ec_enable_gpe(ec, false); in acpi_ec_unmask_events()
421 enable_irq(ec->irq); in acpi_ec_unmask_events()
431 * @ec: the EC device
438 static bool acpi_ec_submit_flushable_request(struct acpi_ec *ec) in acpi_ec_submit_flushable_request() argument
440 if (!acpi_ec_started(ec)) in acpi_ec_submit_flushable_request()
442 acpi_ec_submit_request(ec); in acpi_ec_submit_flushable_request()
446 static void acpi_ec_submit_event(struct acpi_ec *ec) in acpi_ec_submit_event() argument
452 acpi_ec_mask_events(ec); in acpi_ec_submit_event()
453 if (!acpi_ec_event_enabled(ec)) in acpi_ec_submit_event()
456 if (ec->event_state != EC_EVENT_READY) in acpi_ec_submit_event()
462 ec->event_state = EC_EVENT_IN_PROGRESS; in acpi_ec_submit_event()
470 if (ec->events_to_process++ > 0) in acpi_ec_submit_event()
473 ec->events_in_progress++; in acpi_ec_submit_event()
474 queue_work(ec_wq, &ec->work); in acpi_ec_submit_event()
477 static void acpi_ec_complete_event(struct acpi_ec *ec) in acpi_ec_complete_event() argument
479 if (ec->event_state == EC_EVENT_IN_PROGRESS) in acpi_ec_complete_event()
480 ec->event_state = EC_EVENT_COMPLETE; in acpi_ec_complete_event()
483 static void acpi_ec_close_event(struct acpi_ec *ec) in acpi_ec_close_event() argument
485 if (ec->event_state != EC_EVENT_READY) in acpi_ec_close_event()
489 ec->event_state = EC_EVENT_READY; in acpi_ec_close_event()
490 acpi_ec_unmask_events(ec); in acpi_ec_close_event()
493 static inline void __acpi_ec_enable_event(struct acpi_ec *ec) in __acpi_ec_enable_event() argument
495 if (!test_and_set_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags)) in __acpi_ec_enable_event()
501 advance_transaction(ec, false); in __acpi_ec_enable_event()
504 static inline void __acpi_ec_disable_event(struct acpi_ec *ec) in __acpi_ec_disable_event() argument
506 if (test_and_clear_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags)) in __acpi_ec_disable_event()
511 * Process _Q events that might have accumulated in the EC.
512 * Run with locked ec mutex.
514 static void acpi_ec_clear(struct acpi_ec *ec) in acpi_ec_clear() argument
519 if (acpi_ec_submit_query(ec)) in acpi_ec_clear()
523 pr_warn("Warning: Maximum of %d stale EC events cleared\n", i); in acpi_ec_clear()
525 pr_info("%d stale EC events cleared\n", i); in acpi_ec_clear()
528 static void acpi_ec_enable_event(struct acpi_ec *ec) in acpi_ec_enable_event() argument
532 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_enable_event()
533 if (acpi_ec_started(ec)) in acpi_ec_enable_event()
534 __acpi_ec_enable_event(ec); in acpi_ec_enable_event()
535 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_enable_event()
539 acpi_ec_clear(ec); in acpi_ec_enable_event()
545 flush_workqueue(ec_wq); /* flush ec->work */ in __acpi_ec_flush_work()
549 static void acpi_ec_disable_event(struct acpi_ec *ec) in acpi_ec_disable_event() argument
553 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_disable_event()
554 __acpi_ec_disable_event(ec); in acpi_ec_disable_event()
555 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_disable_event()
574 static bool acpi_ec_guard_event(struct acpi_ec *ec) in acpi_ec_guard_event() argument
579 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_guard_event()
593 ec->event_state != EC_EVENT_READY && in acpi_ec_guard_event()
594 (!ec->curr || ec->curr->command != ACPI_EC_COMMAND_QUERY); in acpi_ec_guard_event()
595 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_guard_event()
599 static int ec_transaction_polled(struct acpi_ec *ec) in ec_transaction_polled() argument
604 spin_lock_irqsave(&ec->lock, flags); in ec_transaction_polled()
605 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_POLL)) in ec_transaction_polled()
607 spin_unlock_irqrestore(&ec->lock, flags); in ec_transaction_polled()
611 static int ec_transaction_completed(struct acpi_ec *ec) in ec_transaction_completed() argument
616 spin_lock_irqsave(&ec->lock, flags); in ec_transaction_completed()
617 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE)) in ec_transaction_completed()
619 spin_unlock_irqrestore(&ec->lock, flags); in ec_transaction_completed()
623 static inline void ec_transaction_transition(struct acpi_ec *ec, unsigned long flag) in ec_transaction_transition() argument
625 ec->curr->flags |= flag; in ec_transaction_transition()
627 if (ec->curr->command != ACPI_EC_COMMAND_QUERY) in ec_transaction_transition()
633 acpi_ec_close_event(ec); in ec_transaction_transition()
639 acpi_ec_close_event(ec); in ec_transaction_transition()
645 acpi_ec_complete_event(ec); in ec_transaction_transition()
649 static void acpi_ec_spurious_interrupt(struct acpi_ec *ec, struct transaction *t) in acpi_ec_spurious_interrupt() argument
656 acpi_ec_mask_events(ec); in acpi_ec_spurious_interrupt()
659 static void advance_transaction(struct acpi_ec *ec, bool interrupt) in advance_transaction() argument
661 struct transaction *t = ec->curr; in advance_transaction()
667 status = acpi_ec_read_status(ec); in advance_transaction()
675 ec->event_state == EC_EVENT_COMPLETE) in advance_transaction()
676 acpi_ec_close_event(ec); in advance_transaction()
685 acpi_ec_write_data(ec, t->wdata[t->wi++]); in advance_transaction()
687 acpi_ec_spurious_interrupt(ec, t); in advance_transaction()
690 t->rdata[t->ri++] = acpi_ec_read_data(ec); in advance_transaction()
692 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE); in advance_transaction()
699 acpi_ec_spurious_interrupt(ec, t); in advance_transaction()
702 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE); in advance_transaction()
706 acpi_ec_write_cmd(ec, t->command); in advance_transaction()
707 ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL); in advance_transaction()
712 acpi_ec_submit_event(ec); in advance_transaction()
715 wake_up(&ec->wait); in advance_transaction()
718 static void start_transaction(struct acpi_ec *ec) in start_transaction() argument
720 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0; in start_transaction()
721 ec->curr->flags = 0; in start_transaction()
724 static int ec_guard(struct acpi_ec *ec) in ec_guard() argument
726 unsigned long guard = usecs_to_jiffies(ec->polling_guard); in ec_guard()
727 unsigned long timeout = ec->timestamp + guard; in ec_guard()
729 /* Ensure guarding period before polling EC status */ in ec_guard()
731 if (ec->busy_polling) { in ec_guard()
733 if (ec_transaction_completed(ec)) in ec_guard()
747 if (!ec_transaction_polled(ec) && in ec_guard()
748 !acpi_ec_guard_event(ec)) in ec_guard()
750 if (wait_event_timeout(ec->wait, in ec_guard()
751 ec_transaction_completed(ec), in ec_guard()
759 static int ec_poll(struct acpi_ec *ec) in ec_poll() argument
768 if (!ec_guard(ec)) in ec_poll()
770 spin_lock_irqsave(&ec->lock, flags); in ec_poll()
771 advance_transaction(ec, false); in ec_poll()
772 spin_unlock_irqrestore(&ec->lock, flags); in ec_poll()
775 spin_lock_irqsave(&ec->lock, flags); in ec_poll()
776 start_transaction(ec); in ec_poll()
777 spin_unlock_irqrestore(&ec->lock, flags); in ec_poll()
782 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, in acpi_ec_transaction_unlocked() argument
792 spin_lock_irqsave(&ec->lock, tmp); in acpi_ec_transaction_unlocked()
794 if (!acpi_ec_submit_flushable_request(ec)) { in acpi_ec_transaction_unlocked()
798 ec_dbg_ref(ec, "Increase command"); in acpi_ec_transaction_unlocked()
800 ec->curr = t; in acpi_ec_transaction_unlocked()
802 start_transaction(ec); in acpi_ec_transaction_unlocked()
803 spin_unlock_irqrestore(&ec->lock, tmp); in acpi_ec_transaction_unlocked()
805 ret = ec_poll(ec); in acpi_ec_transaction_unlocked()
807 spin_lock_irqsave(&ec->lock, tmp); in acpi_ec_transaction_unlocked()
809 acpi_ec_unmask_events(ec); in acpi_ec_transaction_unlocked()
811 ec->curr = NULL; in acpi_ec_transaction_unlocked()
813 acpi_ec_complete_request(ec); in acpi_ec_transaction_unlocked()
814 ec_dbg_ref(ec, "Decrease command"); in acpi_ec_transaction_unlocked()
816 spin_unlock_irqrestore(&ec->lock, tmp); in acpi_ec_transaction_unlocked()
820 static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t) in acpi_ec_transaction() argument
825 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata)) in acpi_ec_transaction()
828 mutex_lock(&ec->mutex); in acpi_ec_transaction()
829 if (ec->global_lock) { in acpi_ec_transaction()
837 status = acpi_ec_transaction_unlocked(ec, t); in acpi_ec_transaction()
839 if (ec->global_lock) in acpi_ec_transaction()
842 mutex_unlock(&ec->mutex); in acpi_ec_transaction()
846 static int acpi_ec_burst_enable(struct acpi_ec *ec) in acpi_ec_burst_enable() argument
853 return acpi_ec_transaction_unlocked(ec, &t); in acpi_ec_burst_enable()
856 static int acpi_ec_burst_disable(struct acpi_ec *ec) in acpi_ec_burst_disable() argument
862 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ? in acpi_ec_burst_disable()
863 acpi_ec_transaction_unlocked(ec, &t) : 0; in acpi_ec_burst_disable()
866 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data) in acpi_ec_read() argument
874 result = acpi_ec_transaction(ec, &t); in acpi_ec_read()
879 static int acpi_ec_read_unlocked(struct acpi_ec *ec, u8 address, u8 *data) in acpi_ec_read_unlocked() argument
887 result = acpi_ec_transaction_unlocked(ec, &t); in acpi_ec_read_unlocked()
892 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data) in acpi_ec_write() argument
899 return acpi_ec_transaction(ec, &t); in acpi_ec_write()
902 static int acpi_ec_write_unlocked(struct acpi_ec *ec, u8 address, u8 data) in acpi_ec_write_unlocked() argument
909 return acpi_ec_transaction_unlocked(ec, &t); in acpi_ec_write_unlocked()
954 /* Get the handle to the EC device */
963 static void acpi_ec_start(struct acpi_ec *ec, bool resuming) in acpi_ec_start() argument
967 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_start()
968 if (!test_and_set_bit(EC_FLAGS_STARTED, &ec->flags)) { in acpi_ec_start()
969 ec_dbg_drv("Starting EC"); in acpi_ec_start()
972 acpi_ec_submit_request(ec); in acpi_ec_start()
973 ec_dbg_ref(ec, "Increase driver"); in acpi_ec_start()
975 ec_log_drv("EC started"); in acpi_ec_start()
977 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_start()
980 static bool acpi_ec_stopped(struct acpi_ec *ec) in acpi_ec_stopped() argument
985 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_stopped()
986 flushed = acpi_ec_flushed(ec); in acpi_ec_stopped()
987 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_stopped()
991 static void acpi_ec_stop(struct acpi_ec *ec, bool suspending) in acpi_ec_stop() argument
995 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_stop()
996 if (acpi_ec_started(ec)) { in acpi_ec_stop()
997 ec_dbg_drv("Stopping EC"); in acpi_ec_stop()
998 set_bit(EC_FLAGS_STOPPED, &ec->flags); in acpi_ec_stop()
999 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_stop()
1000 wait_event(ec->wait, acpi_ec_stopped(ec)); in acpi_ec_stop()
1001 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_stop()
1004 acpi_ec_complete_request(ec); in acpi_ec_stop()
1005 ec_dbg_ref(ec, "Decrease driver"); in acpi_ec_stop()
1007 __acpi_ec_disable_event(ec); in acpi_ec_stop()
1008 clear_bit(EC_FLAGS_STARTED, &ec->flags); in acpi_ec_stop()
1009 clear_bit(EC_FLAGS_STOPPED, &ec->flags); in acpi_ec_stop()
1010 ec_log_drv("EC stopped"); in acpi_ec_stop()
1012 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_stop()
1015 static void acpi_ec_enter_noirq(struct acpi_ec *ec) in acpi_ec_enter_noirq() argument
1019 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_enter_noirq()
1020 ec->busy_polling = true; in acpi_ec_enter_noirq()
1021 ec->polling_guard = 0; in acpi_ec_enter_noirq()
1023 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_enter_noirq()
1026 static void acpi_ec_leave_noirq(struct acpi_ec *ec) in acpi_ec_leave_noirq() argument
1030 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_leave_noirq()
1031 ec->busy_polling = ec_busy_polling; in acpi_ec_leave_noirq()
1032 ec->polling_guard = ec_polling_guard; in acpi_ec_leave_noirq()
1034 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_leave_noirq()
1039 struct acpi_ec *ec = first_ec; in acpi_ec_block_transactions() local
1041 if (!ec) in acpi_ec_block_transactions()
1044 mutex_lock(&ec->mutex); in acpi_ec_block_transactions()
1046 acpi_ec_stop(ec, true); in acpi_ec_block_transactions()
1047 mutex_unlock(&ec->mutex); in acpi_ec_block_transactions()
1064 acpi_ec_get_query_handler_by_value(struct acpi_ec *ec, u8 value) in acpi_ec_get_query_handler_by_value() argument
1068 mutex_lock(&ec->mutex); in acpi_ec_get_query_handler_by_value()
1069 list_for_each_entry(handler, &ec->list, node) { in acpi_ec_get_query_handler_by_value()
1072 mutex_unlock(&ec->mutex); in acpi_ec_get_query_handler_by_value()
1076 mutex_unlock(&ec->mutex); in acpi_ec_get_query_handler_by_value()
1093 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, in acpi_ec_add_query_handler() argument
1110 mutex_lock(&ec->mutex); in acpi_ec_add_query_handler()
1112 list_add(&handler->node, &ec->list); in acpi_ec_add_query_handler()
1113 mutex_unlock(&ec->mutex); in acpi_ec_add_query_handler()
1119 static void acpi_ec_remove_query_handlers(struct acpi_ec *ec, in acpi_ec_remove_query_handlers() argument
1125 mutex_lock(&ec->mutex); in acpi_ec_remove_query_handlers()
1126 list_for_each_entry_safe(handler, tmp, &ec->list, node) { in acpi_ec_remove_query_handlers()
1131 * EC queries. in acpi_ec_remove_query_handlers()
1139 mutex_unlock(&ec->mutex); in acpi_ec_remove_query_handlers()
1144 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit) in acpi_ec_remove_query_handler() argument
1146 acpi_ec_remove_query_handlers(ec, false, query_bit); in acpi_ec_remove_query_handler()
1155 struct acpi_ec *ec = q->ec; in acpi_ec_event_processor() local
1166 spin_lock_irq(&ec->lock); in acpi_ec_event_processor()
1167 ec->queries_in_progress--; in acpi_ec_event_processor()
1168 spin_unlock_irq(&ec->lock); in acpi_ec_event_processor()
1174 static struct acpi_ec_query *acpi_ec_create_query(struct acpi_ec *ec, u8 *pval) in acpi_ec_create_query() argument
1188 q->ec = ec; in acpi_ec_create_query()
1192 static int acpi_ec_submit_query(struct acpi_ec *ec) in acpi_ec_submit_query() argument
1198 q = acpi_ec_create_query(ec, &value); in acpi_ec_submit_query()
1203 * Query the EC to find out which _Qxx method we need to evaluate. in acpi_ec_submit_query()
1207 result = acpi_ec_transaction(ec, &q->transaction); in acpi_ec_submit_query()
1216 q->handler = acpi_ec_get_query_handler_by_value(ec, value); in acpi_ec_submit_query()
1231 spin_lock_irq(&ec->lock); in acpi_ec_submit_query()
1233 ec->queries_in_progress++; in acpi_ec_submit_query()
1236 spin_unlock_irq(&ec->lock); in acpi_ec_submit_query()
1248 struct acpi_ec *ec = container_of(work, struct acpi_ec, work); in acpi_ec_event_handler() local
1252 spin_lock_irq(&ec->lock); in acpi_ec_event_handler()
1254 while (ec->events_to_process) { in acpi_ec_event_handler()
1255 spin_unlock_irq(&ec->lock); in acpi_ec_event_handler()
1257 acpi_ec_submit_query(ec); in acpi_ec_event_handler()
1259 spin_lock_irq(&ec->lock); in acpi_ec_event_handler()
1261 ec->events_to_process--; in acpi_ec_event_handler()
1272 acpi_ec_complete_event(ec); in acpi_ec_event_handler()
1276 spin_unlock_irq(&ec->lock); in acpi_ec_event_handler()
1278 guard_timeout = !!ec_guard(ec); in acpi_ec_event_handler()
1280 spin_lock_irq(&ec->lock); in acpi_ec_event_handler()
1283 if (guard_timeout && !ec->curr) in acpi_ec_event_handler()
1284 advance_transaction(ec, false); in acpi_ec_event_handler()
1286 acpi_ec_close_event(ec); in acpi_ec_event_handler()
1291 ec->events_in_progress--; in acpi_ec_event_handler()
1293 spin_unlock_irq(&ec->lock); in acpi_ec_event_handler()
1296 static void clear_gpe_and_advance_transaction(struct acpi_ec *ec, bool interrupt) in clear_gpe_and_advance_transaction() argument
1310 if (ec->gpe >= 0 && acpi_ec_gpe_status_set(ec)) in clear_gpe_and_advance_transaction()
1311 acpi_clear_gpe(NULL, ec->gpe); in clear_gpe_and_advance_transaction()
1313 advance_transaction(ec, true); in clear_gpe_and_advance_transaction()
1316 static void acpi_ec_handle_interrupt(struct acpi_ec *ec) in acpi_ec_handle_interrupt() argument
1320 spin_lock_irqsave(&ec->lock, flags); in acpi_ec_handle_interrupt()
1322 clear_gpe_and_advance_transaction(ec, true); in acpi_ec_handle_interrupt()
1324 spin_unlock_irqrestore(&ec->lock, flags); in acpi_ec_handle_interrupt()
1349 struct acpi_ec *ec = handler_context; in acpi_ec_space_handler() local
1360 mutex_lock(&ec->mutex); in acpi_ec_space_handler()
1362 if (ec->global_lock) { in acpi_ec_space_handler()
1372 if (ec->busy_polling || bits > 8) in acpi_ec_space_handler()
1373 acpi_ec_burst_enable(ec); in acpi_ec_space_handler()
1377 acpi_ec_read_unlocked(ec, address, value) : in acpi_ec_space_handler()
1378 acpi_ec_write_unlocked(ec, address, *value); in acpi_ec_space_handler()
1383 if (ec->busy_polling || bits > 8) in acpi_ec_space_handler()
1384 acpi_ec_burst_disable(ec); in acpi_ec_space_handler()
1386 if (ec->global_lock) in acpi_ec_space_handler()
1390 mutex_unlock(&ec->mutex); in acpi_ec_space_handler()
1413 static void acpi_ec_free(struct acpi_ec *ec) in acpi_ec_free() argument
1415 if (first_ec == ec) in acpi_ec_free()
1417 if (boot_ec == ec) in acpi_ec_free()
1419 kfree(ec); in acpi_ec_free()
1424 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL); in acpi_ec_alloc() local
1426 if (!ec) in acpi_ec_alloc()
1428 mutex_init(&ec->mutex); in acpi_ec_alloc()
1429 init_waitqueue_head(&ec->wait); in acpi_ec_alloc()
1430 INIT_LIST_HEAD(&ec->list); in acpi_ec_alloc()
1431 spin_lock_init(&ec->lock); in acpi_ec_alloc()
1432 INIT_WORK(&ec->work, acpi_ec_event_handler); in acpi_ec_alloc()
1433 ec->timestamp = jiffies; in acpi_ec_alloc()
1434 ec->busy_polling = true; in acpi_ec_alloc()
1435 ec->polling_guard = 0; in acpi_ec_alloc()
1436 ec->gpe = -1; in acpi_ec_alloc()
1437 ec->irq = -1; in acpi_ec_alloc()
1438 return ec; in acpi_ec_alloc()
1447 struct acpi_ec *ec = context; in acpi_ec_register_query_methods() local
1454 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL); in acpi_ec_register_query_methods()
1463 struct acpi_ec *ec = context; in ec_parse_device() local
1466 ec->command_addr = ec->data_addr = 0; in ec_parse_device()
1469 ec_parse_io_ports, ec); in ec_parse_device()
1472 if (ec->data_addr == 0 || ec->command_addr == 0) in ec_parse_device()
1475 /* Get GPE bit assignment (EC events). */ in ec_parse_device()
1479 ec->gpe = tmp; in ec_parse_device()
1485 /* Use the global lock for all EC transactions? */ in ec_parse_device()
1488 ec->global_lock = tmp; in ec_parse_device()
1489 ec->handle = handle; in ec_parse_device()
1493 static bool install_gpe_event_handler(struct acpi_ec *ec) in install_gpe_event_handler() argument
1497 status = acpi_install_gpe_raw_handler(NULL, ec->gpe, in install_gpe_event_handler()
1499 &acpi_ec_gpe_handler, ec); in install_gpe_event_handler()
1503 if (test_bit(EC_FLAGS_STARTED, &ec->flags) && ec->reference_count >= 1) in install_gpe_event_handler()
1504 acpi_ec_enable_gpe(ec, true); in install_gpe_event_handler()
1509 static bool install_gpio_irq_event_handler(struct acpi_ec *ec) in install_gpio_irq_event_handler() argument
1511 return request_threaded_irq(ec->irq, NULL, acpi_ec_irq_handler, in install_gpio_irq_event_handler()
1512 IRQF_SHARED | IRQF_ONESHOT, "ACPI EC", ec) >= 0; in install_gpio_irq_event_handler()
1517 * @ec: Target EC.
1518 * @device: ACPI device object corresponding to @ec.
1521 * Install a handler for the EC address space type unless it has been installed
1522 * already. If @device is not NULL, also look for EC query methods in the
1524 * handler for the EC, if possible.
1532 static int ec_install_handlers(struct acpi_ec *ec, struct acpi_device *device, in ec_install_handlers() argument
1537 acpi_ec_start(ec, false); in ec_install_handlers()
1539 if (!test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) { in ec_install_handlers()
1540 acpi_handle scope_handle = ec == first_ec ? ACPI_ROOT_OBJECT : ec->handle; in ec_install_handlers()
1542 acpi_ec_enter_noirq(ec); in ec_install_handlers()
1546 NULL, ec); in ec_install_handlers()
1548 acpi_ec_stop(ec, false); in ec_install_handlers()
1551 set_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags); in ec_install_handlers()
1554 if (call_reg && !test_bit(EC_FLAGS_EC_REG_CALLED, &ec->flags)) { in ec_install_handlers()
1555 acpi_execute_reg_methods(ec->handle, ACPI_UINT32_MAX, ACPI_ADR_SPACE_EC); in ec_install_handlers()
1556 set_bit(EC_FLAGS_EC_REG_CALLED, &ec->flags); in ec_install_handlers()
1562 if (ec->gpe < 0) { in ec_install_handlers()
1572 ec->irq = irq; in ec_install_handlers()
1575 if (!test_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags)) { in ec_install_handlers()
1577 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1, in ec_install_handlers()
1579 NULL, ec, NULL); in ec_install_handlers()
1580 set_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags); in ec_install_handlers()
1582 if (!test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags)) { in ec_install_handlers()
1585 if (ec->gpe >= 0) in ec_install_handlers()
1586 ready = install_gpe_event_handler(ec); in ec_install_handlers()
1587 else if (ec->irq >= 0) in ec_install_handlers()
1588 ready = install_gpio_irq_event_handler(ec); in ec_install_handlers()
1591 set_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags); in ec_install_handlers()
1592 acpi_ec_leave_noirq(ec); in ec_install_handlers()
1596 * the EC can be polled for events. in ec_install_handlers()
1599 /* EC is fully operational, allow queries */ in ec_install_handlers()
1600 acpi_ec_enable_event(ec); in ec_install_handlers()
1605 static void ec_remove_handlers(struct acpi_ec *ec) in ec_remove_handlers() argument
1607 acpi_handle scope_handle = ec == first_ec ? ACPI_ROOT_OBJECT : ec->handle; in ec_remove_handlers()
1609 if (test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) { in ec_remove_handlers()
1615 clear_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags); in ec_remove_handlers()
1619 * Stops handling the EC transactions after removing the operation in ec_remove_handlers()
1621 * invoked during the removal can result in new EC transactions. in ec_remove_handlers()
1623 * Flushes the EC requests and thus disables the GPE before in ec_remove_handlers()
1629 acpi_ec_stop(ec, false); in ec_remove_handlers()
1631 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags)) { in ec_remove_handlers()
1632 if (ec->gpe >= 0 && in ec_remove_handlers()
1633 ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe, in ec_remove_handlers()
1637 if (ec->irq >= 0) in ec_remove_handlers()
1638 free_irq(ec->irq, ec); in ec_remove_handlers()
1640 clear_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags); in ec_remove_handlers()
1642 if (test_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags)) { in ec_remove_handlers()
1643 acpi_ec_remove_query_handlers(ec, true, 0); in ec_remove_handlers()
1644 clear_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags); in ec_remove_handlers()
1648 static int acpi_ec_setup(struct acpi_ec *ec, struct acpi_device *device, bool call_reg) in acpi_ec_setup() argument
1652 /* First EC capable of handling transactions */ in acpi_ec_setup()
1654 first_ec = ec; in acpi_ec_setup()
1656 ret = ec_install_handlers(ec, device, call_reg); in acpi_ec_setup()
1658 if (ec == first_ec) in acpi_ec_setup()
1664 pr_info("EC_CMD/EC_SC=0x%lx, EC_DATA=0x%lx\n", ec->command_addr, in acpi_ec_setup()
1665 ec->data_addr); in acpi_ec_setup()
1667 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags)) { in acpi_ec_setup()
1668 if (ec->gpe >= 0) in acpi_ec_setup()
1669 pr_info("GPE=0x%x\n", ec->gpe); in acpi_ec_setup()
1671 pr_info("IRQ=%d\n", ec->irq); in acpi_ec_setup()
1679 struct acpi_ec *ec; in acpi_ec_add() local
1687 /* Fast path: this device corresponds to the boot EC. */ in acpi_ec_add()
1688 ec = boot_ec; in acpi_ec_add()
1692 ec = acpi_ec_alloc(); in acpi_ec_add()
1693 if (!ec) in acpi_ec_add()
1696 status = ec_parse_device(device->handle, 0, ec, NULL); in acpi_ec_add()
1702 if (boot_ec && ec->command_addr == boot_ec->command_addr && in acpi_ec_add()
1703 ec->data_addr == boot_ec->data_addr) { in acpi_ec_add()
1707 * quirks. So do not change boot_ec->gpe to ec->gpe, in acpi_ec_add()
1710 boot_ec->handle = ec->handle; in acpi_ec_add()
1713 boot_ec->gpe = ec->gpe; in acpi_ec_add()
1715 acpi_handle_debug(ec->handle, "duplicated.\n"); in acpi_ec_add()
1716 acpi_ec_free(ec); in acpi_ec_add()
1717 ec = boot_ec; in acpi_ec_add()
1721 ret = acpi_ec_setup(ec, device, true); in acpi_ec_add()
1725 if (ec == boot_ec) in acpi_ec_add()
1727 "Boot %s EC initialization complete\n", in acpi_ec_add()
1730 acpi_handle_info(ec->handle, in acpi_ec_add()
1731 "EC: Used to handle transactions and events\n"); in acpi_ec_add()
1733 device->driver_data = ec; in acpi_ec_add()
1735 ret = !!request_region(ec->data_addr, 1, "EC data"); in acpi_ec_add()
1736 WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr); in acpi_ec_add()
1737 ret = !!request_region(ec->command_addr, 1, "EC cmd"); in acpi_ec_add()
1738 WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr); in acpi_ec_add()
1740 /* Reprobe devices depending on the EC */ in acpi_ec_add()
1743 acpi_handle_debug(ec->handle, "enumerated.\n"); in acpi_ec_add()
1747 if (ec != boot_ec) in acpi_ec_add()
1748 acpi_ec_free(ec); in acpi_ec_add()
1755 struct acpi_ec *ec; in acpi_ec_remove() local
1760 ec = acpi_driver_data(device); in acpi_ec_remove()
1761 release_region(ec->data_addr, 1); in acpi_ec_remove()
1762 release_region(ec->command_addr, 1); in acpi_ec_remove()
1764 if (ec != boot_ec) { in acpi_ec_remove()
1765 ec_remove_handlers(ec); in acpi_ec_remove()
1766 acpi_ec_free(ec); in acpi_ec_remove()
1779 struct acpi_ec *ec = context; in ec_parse_io_ports() local
1789 if (ec->data_addr == 0) in ec_parse_io_ports()
1790 ec->data_addr = resource->data.io.minimum; in ec_parse_io_ports()
1791 else if (ec->command_addr == 0) in ec_parse_io_ports()
1792 ec->command_addr = resource->data.io.minimum; in ec_parse_io_ports()
1807 * namespace EC before the main ACPI device enumeration process. It is
1812 struct acpi_ec *ec; in acpi_ec_dsdt_probe() local
1820 * picking up an invalid EC device. in acpi_ec_dsdt_probe()
1825 ec = acpi_ec_alloc(); in acpi_ec_dsdt_probe()
1826 if (!ec) in acpi_ec_dsdt_probe()
1833 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device, ec, NULL); in acpi_ec_dsdt_probe()
1834 if (ACPI_FAILURE(status) || !ec->handle) { in acpi_ec_dsdt_probe()
1835 acpi_ec_free(ec); in acpi_ec_dsdt_probe()
1840 * When the DSDT EC is available, always re-configure boot EC to in acpi_ec_dsdt_probe()
1846 ret = acpi_ec_setup(ec, NULL, true); in acpi_ec_dsdt_probe()
1848 acpi_ec_free(ec); in acpi_ec_dsdt_probe()
1852 boot_ec = ec; in acpi_ec_dsdt_probe()
1854 acpi_handle_info(ec->handle, in acpi_ec_dsdt_probe()
1855 "Boot DSDT EC used to handle transactions\n"); in acpi_ec_dsdt_probe()
1859 * acpi_ec_ecdt_start - Finalize the boot ECDT EC initialization.
1861 * First, look for an ACPI handle for the boot ECDT EC if acpi_ec_add() has not
1864 * Next, in case the DSDT EC is not functioning, it is still necessary to
1865 * provide a functional ECDT EC to handle events, so add an extra device object
1868 * This is useful on platforms with valid ECDT and invalid DSDT EC settings,
1877 /* Bail out if a matching EC has been found in the namespace. */ in acpi_ec_ecdt_start()
1891 /* Add a special ACPI device object to represent the boot EC. */ in acpi_ec_ecdt_start()
1899 * On some hardware it is necessary to clear events accumulated by the EC during
1905 * Ideally, the EC should also be instructed NOT to accumulate events during
1917 pr_debug("Detected system needing EC poll on resume.\n"); in ec_clear_on_resume()
1937 * with DSDT EC, don't duplicate the DSDT EC with ECDT EC in this case.
2017 struct acpi_ec *ec; in acpi_ec_ecdt_probe() local
2021 /* Generate a boot ec context. */ in acpi_ec_ecdt_probe()
2045 * However some ThinkBook machines have a ECDT table with a valid EC in acpi_ec_ecdt_probe()
2055 ec = acpi_ec_alloc(); in acpi_ec_ecdt_probe()
2056 if (!ec) in acpi_ec_ecdt_probe()
2060 ec->command_addr = ecdt_ptr->data.address; in acpi_ec_ecdt_probe()
2061 ec->data_addr = ecdt_ptr->control.address; in acpi_ec_ecdt_probe()
2063 ec->command_addr = ecdt_ptr->control.address; in acpi_ec_ecdt_probe()
2064 ec->data_addr = ecdt_ptr->data.address; in acpi_ec_ecdt_probe()
2072 ec->gpe = ecdt_ptr->gpe; in acpi_ec_ecdt_probe()
2074 ec->handle = ACPI_ROOT_OBJECT; in acpi_ec_ecdt_probe()
2080 ret = acpi_ec_setup(ec, NULL, false); in acpi_ec_ecdt_probe()
2082 acpi_ec_free(ec); in acpi_ec_ecdt_probe()
2086 boot_ec = ec; in acpi_ec_ecdt_probe()
2089 pr_info("Boot ECDT EC used to handle transactions\n"); in acpi_ec_ecdt_probe()
2098 struct acpi_ec *ec = in acpi_ec_suspend() local
2102 acpi_ec_disable_event(ec); in acpi_ec_suspend()
2108 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev)); in acpi_ec_suspend_noirq() local
2114 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) && in acpi_ec_suspend_noirq()
2115 ec->gpe >= 0 && ec->reference_count >= 1) in acpi_ec_suspend_noirq()
2116 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE); in acpi_ec_suspend_noirq()
2118 acpi_ec_enter_noirq(ec); in acpi_ec_suspend_noirq()
2125 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev)); in acpi_ec_resume_noirq() local
2127 acpi_ec_leave_noirq(ec); in acpi_ec_resume_noirq()
2129 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) && in acpi_ec_resume_noirq()
2130 ec->gpe >= 0 && ec->reference_count >= 1) in acpi_ec_resume_noirq()
2131 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE); in acpi_ec_resume_noirq()
2138 struct acpi_ec *ec = in acpi_ec_resume() local
2141 acpi_ec_enable_event(ec); in acpi_ec_resume()
2158 static bool acpi_ec_work_in_progress(struct acpi_ec *ec) in acpi_ec_work_in_progress() argument
2160 return ec->events_in_progress + ec->queries_in_progress > 0; in acpi_ec_work_in_progress()
2172 * than the EC one. in acpi_ec_dispatch_gpe()
2181 * Note that if any non-EC GPEs are active at this point, the SCI will in acpi_ec_dispatch_gpe()
2188 * Dispatch the EC GPE in-band, but do not report wakeup in any case in acpi_ec_dispatch_gpe()
2194 pm_pr_dbg("ACPI EC GPE status set\n"); in acpi_ec_dispatch_gpe()
2205 pm_pr_dbg("ACPI EC GPE dispatched\n"); in acpi_ec_dispatch_gpe()
2207 /* Drain EC work. */ in acpi_ec_dispatch_gpe()
2211 pm_pr_dbg("ACPI EC work flushed\n"); in acpi_ec_dispatch_gpe()
2269 .name = "ec",
2326 * Lenovo Legion Go S; touchscreen blocks HW sleep when woken up from EC
2371 * Disable EC wakeup on following systems to prevent periodic in acpi_ec_init()
2372 * wakeup from EC GPE. in acpi_ec_init()
2376 pr_debug("Disabling EC wakeup on suspend-to-idle\n"); in acpi_ec_init()
2385 /* EC driver currently not unloadable */