1a10e763bSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 291087dfaSAlexey Starikovskiy /* 391087dfaSAlexey Starikovskiy * SMBus driver for ACPI Embedded Controller (v0.1) 491087dfaSAlexey Starikovskiy * 591087dfaSAlexey Starikovskiy * Copyright (c) 2007 Alexey Starikovskiy 691087dfaSAlexey Starikovskiy */ 791087dfaSAlexey Starikovskiy 8bd10c13bSHanjun Guo #define pr_fmt(fmt) "ACPI: " fmt 9bd10c13bSHanjun Guo 108b48463fSLv Zheng #include <linux/acpi.h> 1191087dfaSAlexey Starikovskiy #include <linux/wait.h> 125a0e3ad6STejun Heo #include <linux/slab.h> 1391087dfaSAlexey Starikovskiy #include <linux/delay.h> 14cc4b859cSPaul Gortmaker #include <linux/module.h> 1591087dfaSAlexey Starikovskiy #include <linux/interrupt.h> 1691087dfaSAlexey Starikovskiy #include "sbshc.h" 1791087dfaSAlexey Starikovskiy 1897c227cbSDan Carpenter #define ACPI_SMB_HC_CLASS "smbus_host_ctl" 1991087dfaSAlexey Starikovskiy #define ACPI_SMB_HC_DEVICE_NAME "ACPI SMBus HC" 2091087dfaSAlexey Starikovskiy 2191087dfaSAlexey Starikovskiy struct acpi_smb_hc { 2291087dfaSAlexey Starikovskiy struct acpi_ec *ec; 2391087dfaSAlexey Starikovskiy struct mutex lock; 2491087dfaSAlexey Starikovskiy wait_queue_head_t wait; 2591087dfaSAlexey Starikovskiy u8 offset; 2691087dfaSAlexey Starikovskiy u8 query_bit; 2791087dfaSAlexey Starikovskiy smbus_alarm_callback callback; 2891087dfaSAlexey Starikovskiy void *context; 29add68d6aSChris Bainbridge bool done; 3091087dfaSAlexey Starikovskiy }; 3191087dfaSAlexey Starikovskiy 3291087dfaSAlexey Starikovskiy static int acpi_smbus_hc_add(struct acpi_device *device); 3351fac838SRafael J. Wysocki static int acpi_smbus_hc_remove(struct acpi_device *device); 3491087dfaSAlexey Starikovskiy 3591087dfaSAlexey Starikovskiy static const struct acpi_device_id sbs_device_ids[] = { 3691087dfaSAlexey Starikovskiy {"ACPI0001", 0}, 3791087dfaSAlexey Starikovskiy {"ACPI0005", 0}, 3891087dfaSAlexey Starikovskiy {"", 0}, 3991087dfaSAlexey Starikovskiy }; 4091087dfaSAlexey Starikovskiy 4191087dfaSAlexey Starikovskiy MODULE_DEVICE_TABLE(acpi, sbs_device_ids); 4291087dfaSAlexey Starikovskiy 4391087dfaSAlexey Starikovskiy static struct acpi_driver acpi_smb_hc_driver = { 4491087dfaSAlexey Starikovskiy .name = "smbus_hc", 4591087dfaSAlexey Starikovskiy .class = ACPI_SMB_HC_CLASS, 4691087dfaSAlexey Starikovskiy .ids = sbs_device_ids, 4791087dfaSAlexey Starikovskiy .ops = { 4891087dfaSAlexey Starikovskiy .add = acpi_smbus_hc_add, 4991087dfaSAlexey Starikovskiy .remove = acpi_smbus_hc_remove, 5091087dfaSAlexey Starikovskiy }, 5191087dfaSAlexey Starikovskiy }; 5291087dfaSAlexey Starikovskiy 5391087dfaSAlexey Starikovskiy union acpi_smb_status { 5491087dfaSAlexey Starikovskiy u8 raw; 5591087dfaSAlexey Starikovskiy struct { 5691087dfaSAlexey Starikovskiy u8 status:5; 5791087dfaSAlexey Starikovskiy u8 reserved:1; 5891087dfaSAlexey Starikovskiy u8 alarm:1; 5991087dfaSAlexey Starikovskiy u8 done:1; 6091087dfaSAlexey Starikovskiy } fields; 6191087dfaSAlexey Starikovskiy }; 6291087dfaSAlexey Starikovskiy 6391087dfaSAlexey Starikovskiy enum acpi_smb_status_codes { 6491087dfaSAlexey Starikovskiy SMBUS_OK = 0, 6591087dfaSAlexey Starikovskiy SMBUS_UNKNOWN_FAILURE = 0x07, 6691087dfaSAlexey Starikovskiy SMBUS_DEVICE_ADDRESS_NACK = 0x10, 6791087dfaSAlexey Starikovskiy SMBUS_DEVICE_ERROR = 0x11, 6891087dfaSAlexey Starikovskiy SMBUS_DEVICE_COMMAND_ACCESS_DENIED = 0x12, 6991087dfaSAlexey Starikovskiy SMBUS_UNKNOWN_ERROR = 0x13, 7091087dfaSAlexey Starikovskiy SMBUS_DEVICE_ACCESS_DENIED = 0x17, 7191087dfaSAlexey Starikovskiy SMBUS_TIMEOUT = 0x18, 7291087dfaSAlexey Starikovskiy SMBUS_HOST_UNSUPPORTED_PROTOCOL = 0x19, 7391087dfaSAlexey Starikovskiy SMBUS_BUSY = 0x1a, 7491087dfaSAlexey Starikovskiy SMBUS_PEC_ERROR = 0x1f, 7591087dfaSAlexey Starikovskiy }; 7691087dfaSAlexey Starikovskiy 7791087dfaSAlexey Starikovskiy enum acpi_smb_offset { 7891087dfaSAlexey Starikovskiy ACPI_SMB_PROTOCOL = 0, /* protocol, PEC */ 7991087dfaSAlexey Starikovskiy ACPI_SMB_STATUS = 1, /* status */ 8091087dfaSAlexey Starikovskiy ACPI_SMB_ADDRESS = 2, /* address */ 8191087dfaSAlexey Starikovskiy ACPI_SMB_COMMAND = 3, /* command */ 8291087dfaSAlexey Starikovskiy ACPI_SMB_DATA = 4, /* 32 data registers */ 8391087dfaSAlexey Starikovskiy ACPI_SMB_BLOCK_COUNT = 0x24, /* number of data bytes */ 8491087dfaSAlexey Starikovskiy ACPI_SMB_ALARM_ADDRESS = 0x25, /* alarm address */ 8591087dfaSAlexey Starikovskiy ACPI_SMB_ALARM_DATA = 0x26, /* 2 bytes alarm data */ 8691087dfaSAlexey Starikovskiy }; 8791087dfaSAlexey Starikovskiy 8891087dfaSAlexey Starikovskiy static inline int smb_hc_read(struct acpi_smb_hc *hc, u8 address, u8 *data) 8991087dfaSAlexey Starikovskiy { 9091087dfaSAlexey Starikovskiy return ec_read(hc->offset + address, data); 9191087dfaSAlexey Starikovskiy } 9291087dfaSAlexey Starikovskiy 9391087dfaSAlexey Starikovskiy static inline int smb_hc_write(struct acpi_smb_hc *hc, u8 address, u8 data) 9491087dfaSAlexey Starikovskiy { 9591087dfaSAlexey Starikovskiy return ec_write(hc->offset + address, data); 9691087dfaSAlexey Starikovskiy } 9791087dfaSAlexey Starikovskiy 9891087dfaSAlexey Starikovskiy static int wait_transaction_complete(struct acpi_smb_hc *hc, int timeout) 9991087dfaSAlexey Starikovskiy { 100add68d6aSChris Bainbridge if (wait_event_timeout(hc->wait, hc->done, msecs_to_jiffies(timeout))) 10191087dfaSAlexey Starikovskiy return 0; 10291087dfaSAlexey Starikovskiy return -ETIME; 10391087dfaSAlexey Starikovskiy } 10491087dfaSAlexey Starikovskiy 105e5685b9dSAdrian Bunk static int acpi_smbus_transaction(struct acpi_smb_hc *hc, u8 protocol, 106e5685b9dSAdrian Bunk u8 address, u8 command, u8 *data, u8 length) 10791087dfaSAlexey Starikovskiy { 10891087dfaSAlexey Starikovskiy int ret = -EFAULT, i; 10991087dfaSAlexey Starikovskiy u8 temp, sz = 0; 11091087dfaSAlexey Starikovskiy 111bbafbecbSAlexey Starikovskiy if (!hc) { 112bd10c13bSHanjun Guo pr_err("host controller is not configured\n"); 113bbafbecbSAlexey Starikovskiy return ret; 114bbafbecbSAlexey Starikovskiy } 115bbafbecbSAlexey Starikovskiy 11691087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 117add68d6aSChris Bainbridge hc->done = false; 11891087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_PROTOCOL, &temp)) 11991087dfaSAlexey Starikovskiy goto end; 12091087dfaSAlexey Starikovskiy if (temp) { 12191087dfaSAlexey Starikovskiy ret = -EBUSY; 12291087dfaSAlexey Starikovskiy goto end; 12391087dfaSAlexey Starikovskiy } 12491087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_COMMAND, command); 12591087dfaSAlexey Starikovskiy if (!(protocol & 0x01)) { 12691087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_BLOCK_COUNT, length); 12791087dfaSAlexey Starikovskiy for (i = 0; i < length; ++i) 12891087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_DATA + i, data[i]); 12991087dfaSAlexey Starikovskiy } 13091087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_ADDRESS, address << 1); 13191087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_PROTOCOL, protocol); 13291087dfaSAlexey Starikovskiy /* 13391087dfaSAlexey Starikovskiy * Wait for completion. Save the status code, data size, 13491087dfaSAlexey Starikovskiy * and data into the return package (if required by the protocol). 13591087dfaSAlexey Starikovskiy */ 13691087dfaSAlexey Starikovskiy ret = wait_transaction_complete(hc, 1000); 13791087dfaSAlexey Starikovskiy if (ret || !(protocol & 0x01)) 13891087dfaSAlexey Starikovskiy goto end; 13991087dfaSAlexey Starikovskiy switch (protocol) { 14091087dfaSAlexey Starikovskiy case SMBUS_RECEIVE_BYTE: 14191087dfaSAlexey Starikovskiy case SMBUS_READ_BYTE: 14291087dfaSAlexey Starikovskiy sz = 1; 14391087dfaSAlexey Starikovskiy break; 14491087dfaSAlexey Starikovskiy case SMBUS_READ_WORD: 14591087dfaSAlexey Starikovskiy sz = 2; 14691087dfaSAlexey Starikovskiy break; 14791087dfaSAlexey Starikovskiy case SMBUS_READ_BLOCK: 14891087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_BLOCK_COUNT, &sz)) { 14991087dfaSAlexey Starikovskiy ret = -EFAULT; 15091087dfaSAlexey Starikovskiy goto end; 15191087dfaSAlexey Starikovskiy } 15291087dfaSAlexey Starikovskiy sz &= 0x1f; 15391087dfaSAlexey Starikovskiy break; 15491087dfaSAlexey Starikovskiy } 15591087dfaSAlexey Starikovskiy for (i = 0; i < sz; ++i) 15691087dfaSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_DATA + i, &data[i]); 15791087dfaSAlexey Starikovskiy end: 15891087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 15991087dfaSAlexey Starikovskiy return ret; 16091087dfaSAlexey Starikovskiy } 16191087dfaSAlexey Starikovskiy 16291087dfaSAlexey Starikovskiy int acpi_smbus_read(struct acpi_smb_hc *hc, u8 protocol, u8 address, 16391087dfaSAlexey Starikovskiy u8 command, u8 *data) 16491087dfaSAlexey Starikovskiy { 16591087dfaSAlexey Starikovskiy return acpi_smbus_transaction(hc, protocol, address, command, data, 0); 16691087dfaSAlexey Starikovskiy } 16791087dfaSAlexey Starikovskiy 16891087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_read); 16991087dfaSAlexey Starikovskiy 17091087dfaSAlexey Starikovskiy int acpi_smbus_write(struct acpi_smb_hc *hc, u8 protocol, u8 address, 17191087dfaSAlexey Starikovskiy u8 command, u8 *data, u8 length) 17291087dfaSAlexey Starikovskiy { 17391087dfaSAlexey Starikovskiy return acpi_smbus_transaction(hc, protocol, address, command, data, length); 17491087dfaSAlexey Starikovskiy } 17591087dfaSAlexey Starikovskiy 17691087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_write); 17791087dfaSAlexey Starikovskiy 17891087dfaSAlexey Starikovskiy int acpi_smbus_register_callback(struct acpi_smb_hc *hc, 17991087dfaSAlexey Starikovskiy smbus_alarm_callback callback, void *context) 18091087dfaSAlexey Starikovskiy { 18191087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 18291087dfaSAlexey Starikovskiy hc->callback = callback; 18391087dfaSAlexey Starikovskiy hc->context = context; 18491087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 18591087dfaSAlexey Starikovskiy return 0; 18691087dfaSAlexey Starikovskiy } 18791087dfaSAlexey Starikovskiy 18891087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_register_callback); 18991087dfaSAlexey Starikovskiy 19091087dfaSAlexey Starikovskiy int acpi_smbus_unregister_callback(struct acpi_smb_hc *hc) 19191087dfaSAlexey Starikovskiy { 19291087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 19391087dfaSAlexey Starikovskiy hc->callback = NULL; 19491087dfaSAlexey Starikovskiy hc->context = NULL; 19591087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 196757c968cSRonald Tschalär acpi_os_wait_events_complete(); 19791087dfaSAlexey Starikovskiy return 0; 19891087dfaSAlexey Starikovskiy } 19991087dfaSAlexey Starikovskiy 20091087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_unregister_callback); 20191087dfaSAlexey Starikovskiy 202c2d00f2dSAlexey Starikovskiy static inline void acpi_smbus_callback(void *context) 20391087dfaSAlexey Starikovskiy { 20491087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc = context; 20591087dfaSAlexey Starikovskiy if (hc->callback) 20691087dfaSAlexey Starikovskiy hc->callback(hc->context); 20791087dfaSAlexey Starikovskiy } 20891087dfaSAlexey Starikovskiy 20991087dfaSAlexey Starikovskiy static int smbus_alarm(void *context) 21091087dfaSAlexey Starikovskiy { 21191087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc = context; 21291087dfaSAlexey Starikovskiy union acpi_smb_status status; 213c2d00f2dSAlexey Starikovskiy u8 address; 21491087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_STATUS, &status.raw)) 21591087dfaSAlexey Starikovskiy return 0; 21691087dfaSAlexey Starikovskiy /* Check if it is only a completion notify */ 217add68d6aSChris Bainbridge if (status.fields.done && status.fields.status == SMBUS_OK) { 218add68d6aSChris Bainbridge hc->done = true; 21991087dfaSAlexey Starikovskiy wake_up(&hc->wait); 220add68d6aSChris Bainbridge } 22191087dfaSAlexey Starikovskiy if (!status.fields.alarm) 22291087dfaSAlexey Starikovskiy return 0; 22391087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 224c2d00f2dSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_ALARM_ADDRESS, &address); 22509f1fb41SAlexey Starikovskiy status.fields.alarm = 0; 22691087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_STATUS, status.raw); 227c2d00f2dSAlexey Starikovskiy /* We are only interested in events coming from known devices */ 228c2d00f2dSAlexey Starikovskiy switch (address >> 1) { 229c2d00f2dSAlexey Starikovskiy case ACPI_SBS_CHARGER: 230c2d00f2dSAlexey Starikovskiy case ACPI_SBS_MANAGER: 231c2d00f2dSAlexey Starikovskiy case ACPI_SBS_BATTERY: 232f5347867SAlexey Starikovskiy acpi_os_execute(OSL_NOTIFY_HANDLER, 233c2d00f2dSAlexey Starikovskiy acpi_smbus_callback, hc); 234c2d00f2dSAlexey Starikovskiy } 23591087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 23691087dfaSAlexey Starikovskiy return 0; 23791087dfaSAlexey Starikovskiy } 23891087dfaSAlexey Starikovskiy 23991087dfaSAlexey Starikovskiy typedef int (*acpi_ec_query_func) (void *data); 24091087dfaSAlexey Starikovskiy 24191087dfaSAlexey Starikovskiy extern int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, 24291087dfaSAlexey Starikovskiy acpi_handle handle, acpi_ec_query_func func, 24391087dfaSAlexey Starikovskiy void *data); 24491087dfaSAlexey Starikovskiy 24591087dfaSAlexey Starikovskiy static int acpi_smbus_hc_add(struct acpi_device *device) 24691087dfaSAlexey Starikovskiy { 24791087dfaSAlexey Starikovskiy int status; 24827663c58SMatthew Wilcox unsigned long long val; 24991087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc; 25091087dfaSAlexey Starikovskiy 25191087dfaSAlexey Starikovskiy if (!device) 25291087dfaSAlexey Starikovskiy return -EINVAL; 25391087dfaSAlexey Starikovskiy 25491087dfaSAlexey Starikovskiy status = acpi_evaluate_integer(device->handle, "_EC", NULL, &val); 25591087dfaSAlexey Starikovskiy if (ACPI_FAILURE(status)) { 256bd10c13bSHanjun Guo pr_err("error obtaining _EC.\n"); 25791087dfaSAlexey Starikovskiy return -EIO; 25891087dfaSAlexey Starikovskiy } 25991087dfaSAlexey Starikovskiy 26091087dfaSAlexey Starikovskiy strcpy(acpi_device_name(device), ACPI_SMB_HC_DEVICE_NAME); 26191087dfaSAlexey Starikovskiy strcpy(acpi_device_class(device), ACPI_SMB_HC_CLASS); 26291087dfaSAlexey Starikovskiy 26391087dfaSAlexey Starikovskiy hc = kzalloc(sizeof(struct acpi_smb_hc), GFP_KERNEL); 26491087dfaSAlexey Starikovskiy if (!hc) 26591087dfaSAlexey Starikovskiy return -ENOMEM; 26691087dfaSAlexey Starikovskiy mutex_init(&hc->lock); 26791087dfaSAlexey Starikovskiy init_waitqueue_head(&hc->wait); 26891087dfaSAlexey Starikovskiy 269*62fcb99bSRafael J. Wysocki hc->ec = acpi_driver_data(acpi_dev_parent(device)); 27091087dfaSAlexey Starikovskiy hc->offset = (val >> 8) & 0xff; 27191087dfaSAlexey Starikovskiy hc->query_bit = val & 0xff; 272db89b4f0SPavel Machek device->driver_data = hc; 27391087dfaSAlexey Starikovskiy 27491087dfaSAlexey Starikovskiy acpi_ec_add_query_handler(hc->ec, hc->query_bit, NULL, smbus_alarm, hc); 27543cdd1b7SGreg Kroah-Hartman dev_info(&device->dev, "SBS HC: offset = 0x%0x, query_bit = 0x%0x\n", 27643cdd1b7SGreg Kroah-Hartman hc->offset, hc->query_bit); 27791087dfaSAlexey Starikovskiy 27891087dfaSAlexey Starikovskiy return 0; 27991087dfaSAlexey Starikovskiy } 28091087dfaSAlexey Starikovskiy 28191087dfaSAlexey Starikovskiy extern void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit); 28291087dfaSAlexey Starikovskiy 28351fac838SRafael J. Wysocki static int acpi_smbus_hc_remove(struct acpi_device *device) 28491087dfaSAlexey Starikovskiy { 28591087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc; 28691087dfaSAlexey Starikovskiy 28791087dfaSAlexey Starikovskiy if (!device) 28891087dfaSAlexey Starikovskiy return -EINVAL; 28991087dfaSAlexey Starikovskiy 29091087dfaSAlexey Starikovskiy hc = acpi_driver_data(device); 29191087dfaSAlexey Starikovskiy acpi_ec_remove_query_handler(hc->ec, hc->query_bit); 292757c968cSRonald Tschalär acpi_os_wait_events_complete(); 29391087dfaSAlexey Starikovskiy kfree(hc); 294db89b4f0SPavel Machek device->driver_data = NULL; 29591087dfaSAlexey Starikovskiy return 0; 29691087dfaSAlexey Starikovskiy } 29791087dfaSAlexey Starikovskiy 298e84a239eSMika Westerberg module_acpi_driver(acpi_smb_hc_driver); 29991087dfaSAlexey Starikovskiy 30091087dfaSAlexey Starikovskiy MODULE_LICENSE("GPL"); 30191087dfaSAlexey Starikovskiy MODULE_AUTHOR("Alexey Starikovskiy"); 30291087dfaSAlexey Starikovskiy MODULE_DESCRIPTION("ACPI SMBus HC driver"); 303