191087dfaSAlexey Starikovskiy /* 291087dfaSAlexey Starikovskiy * SMBus driver for ACPI Embedded Controller (v0.1) 391087dfaSAlexey Starikovskiy * 491087dfaSAlexey Starikovskiy * Copyright (c) 2007 Alexey Starikovskiy 591087dfaSAlexey Starikovskiy * 691087dfaSAlexey Starikovskiy * This program is free software; you can redistribute it and/or modify 791087dfaSAlexey Starikovskiy * it under the terms of the GNU General Public License as published by 891087dfaSAlexey Starikovskiy * the Free Software Foundation version 2. 991087dfaSAlexey Starikovskiy */ 1091087dfaSAlexey Starikovskiy 1191087dfaSAlexey Starikovskiy #include <acpi/acpi_bus.h> 1291087dfaSAlexey Starikovskiy #include <acpi/acpi_drivers.h> 1391087dfaSAlexey Starikovskiy #include <linux/wait.h> 145a0e3ad6STejun Heo #include <linux/slab.h> 1591087dfaSAlexey Starikovskiy #include <linux/delay.h> 16cc4b859cSPaul Gortmaker #include <linux/module.h> 1791087dfaSAlexey Starikovskiy #include <linux/interrupt.h> 1891087dfaSAlexey Starikovskiy #include "sbshc.h" 1991087dfaSAlexey Starikovskiy 20a192a958SLen Brown #define PREFIX "ACPI: " 21a192a958SLen Brown 2297c227cbSDan Carpenter #define ACPI_SMB_HC_CLASS "smbus_host_ctl" 2391087dfaSAlexey Starikovskiy #define ACPI_SMB_HC_DEVICE_NAME "ACPI SMBus HC" 2491087dfaSAlexey Starikovskiy 2591087dfaSAlexey Starikovskiy struct acpi_smb_hc { 2691087dfaSAlexey Starikovskiy struct acpi_ec *ec; 2791087dfaSAlexey Starikovskiy struct mutex lock; 2891087dfaSAlexey Starikovskiy wait_queue_head_t wait; 2991087dfaSAlexey Starikovskiy u8 offset; 3091087dfaSAlexey Starikovskiy u8 query_bit; 3191087dfaSAlexey Starikovskiy smbus_alarm_callback callback; 3291087dfaSAlexey Starikovskiy void *context; 3391087dfaSAlexey Starikovskiy }; 3491087dfaSAlexey Starikovskiy 3591087dfaSAlexey Starikovskiy static int acpi_smbus_hc_add(struct acpi_device *device); 3651fac838SRafael J. Wysocki static int acpi_smbus_hc_remove(struct acpi_device *device); 3791087dfaSAlexey Starikovskiy 3891087dfaSAlexey Starikovskiy static const struct acpi_device_id sbs_device_ids[] = { 3991087dfaSAlexey Starikovskiy {"ACPI0001", 0}, 4091087dfaSAlexey Starikovskiy {"ACPI0005", 0}, 4191087dfaSAlexey Starikovskiy {"", 0}, 4291087dfaSAlexey Starikovskiy }; 4391087dfaSAlexey Starikovskiy 4491087dfaSAlexey Starikovskiy MODULE_DEVICE_TABLE(acpi, sbs_device_ids); 4591087dfaSAlexey Starikovskiy 4691087dfaSAlexey Starikovskiy static struct acpi_driver acpi_smb_hc_driver = { 4791087dfaSAlexey Starikovskiy .name = "smbus_hc", 4891087dfaSAlexey Starikovskiy .class = ACPI_SMB_HC_CLASS, 4991087dfaSAlexey Starikovskiy .ids = sbs_device_ids, 5091087dfaSAlexey Starikovskiy .ops = { 5191087dfaSAlexey Starikovskiy .add = acpi_smbus_hc_add, 5291087dfaSAlexey Starikovskiy .remove = acpi_smbus_hc_remove, 5391087dfaSAlexey Starikovskiy }, 5491087dfaSAlexey Starikovskiy }; 5591087dfaSAlexey Starikovskiy 5691087dfaSAlexey Starikovskiy union acpi_smb_status { 5791087dfaSAlexey Starikovskiy u8 raw; 5891087dfaSAlexey Starikovskiy struct { 5991087dfaSAlexey Starikovskiy u8 status:5; 6091087dfaSAlexey Starikovskiy u8 reserved:1; 6191087dfaSAlexey Starikovskiy u8 alarm:1; 6291087dfaSAlexey Starikovskiy u8 done:1; 6391087dfaSAlexey Starikovskiy } fields; 6491087dfaSAlexey Starikovskiy }; 6591087dfaSAlexey Starikovskiy 6691087dfaSAlexey Starikovskiy enum acpi_smb_status_codes { 6791087dfaSAlexey Starikovskiy SMBUS_OK = 0, 6891087dfaSAlexey Starikovskiy SMBUS_UNKNOWN_FAILURE = 0x07, 6991087dfaSAlexey Starikovskiy SMBUS_DEVICE_ADDRESS_NACK = 0x10, 7091087dfaSAlexey Starikovskiy SMBUS_DEVICE_ERROR = 0x11, 7191087dfaSAlexey Starikovskiy SMBUS_DEVICE_COMMAND_ACCESS_DENIED = 0x12, 7291087dfaSAlexey Starikovskiy SMBUS_UNKNOWN_ERROR = 0x13, 7391087dfaSAlexey Starikovskiy SMBUS_DEVICE_ACCESS_DENIED = 0x17, 7491087dfaSAlexey Starikovskiy SMBUS_TIMEOUT = 0x18, 7591087dfaSAlexey Starikovskiy SMBUS_HOST_UNSUPPORTED_PROTOCOL = 0x19, 7691087dfaSAlexey Starikovskiy SMBUS_BUSY = 0x1a, 7791087dfaSAlexey Starikovskiy SMBUS_PEC_ERROR = 0x1f, 7891087dfaSAlexey Starikovskiy }; 7991087dfaSAlexey Starikovskiy 8091087dfaSAlexey Starikovskiy enum acpi_smb_offset { 8191087dfaSAlexey Starikovskiy ACPI_SMB_PROTOCOL = 0, /* protocol, PEC */ 8291087dfaSAlexey Starikovskiy ACPI_SMB_STATUS = 1, /* status */ 8391087dfaSAlexey Starikovskiy ACPI_SMB_ADDRESS = 2, /* address */ 8491087dfaSAlexey Starikovskiy ACPI_SMB_COMMAND = 3, /* command */ 8591087dfaSAlexey Starikovskiy ACPI_SMB_DATA = 4, /* 32 data registers */ 8691087dfaSAlexey Starikovskiy ACPI_SMB_BLOCK_COUNT = 0x24, /* number of data bytes */ 8791087dfaSAlexey Starikovskiy ACPI_SMB_ALARM_ADDRESS = 0x25, /* alarm address */ 8891087dfaSAlexey Starikovskiy ACPI_SMB_ALARM_DATA = 0x26, /* 2 bytes alarm data */ 8991087dfaSAlexey Starikovskiy }; 9091087dfaSAlexey Starikovskiy 9191087dfaSAlexey Starikovskiy static inline int smb_hc_read(struct acpi_smb_hc *hc, u8 address, u8 *data) 9291087dfaSAlexey Starikovskiy { 9391087dfaSAlexey Starikovskiy return ec_read(hc->offset + address, data); 9491087dfaSAlexey Starikovskiy } 9591087dfaSAlexey Starikovskiy 9691087dfaSAlexey Starikovskiy static inline int smb_hc_write(struct acpi_smb_hc *hc, u8 address, u8 data) 9791087dfaSAlexey Starikovskiy { 9891087dfaSAlexey Starikovskiy return ec_write(hc->offset + address, data); 9991087dfaSAlexey Starikovskiy } 10091087dfaSAlexey Starikovskiy 10191087dfaSAlexey Starikovskiy static inline int smb_check_done(struct acpi_smb_hc *hc) 10291087dfaSAlexey Starikovskiy { 10391087dfaSAlexey Starikovskiy union acpi_smb_status status = {.raw = 0}; 10491087dfaSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_STATUS, &status.raw); 10591087dfaSAlexey Starikovskiy return status.fields.done && (status.fields.status == SMBUS_OK); 10691087dfaSAlexey Starikovskiy } 10791087dfaSAlexey Starikovskiy 10891087dfaSAlexey Starikovskiy static int wait_transaction_complete(struct acpi_smb_hc *hc, int timeout) 10991087dfaSAlexey Starikovskiy { 11091087dfaSAlexey Starikovskiy if (wait_event_timeout(hc->wait, smb_check_done(hc), 11191087dfaSAlexey Starikovskiy msecs_to_jiffies(timeout))) 11291087dfaSAlexey Starikovskiy return 0; 113266feefeSZhao Yakui /* 114266feefeSZhao Yakui * After the timeout happens, OS will try to check the status of SMbus. 115266feefeSZhao Yakui * If the status is what OS expected, it will be regarded as the bogus 116266feefeSZhao Yakui * timeout. 117266feefeSZhao Yakui */ 118266feefeSZhao Yakui if (smb_check_done(hc)) 119266feefeSZhao Yakui return 0; 12091087dfaSAlexey Starikovskiy else 12191087dfaSAlexey Starikovskiy return -ETIME; 12291087dfaSAlexey Starikovskiy } 12391087dfaSAlexey Starikovskiy 124e5685b9dSAdrian Bunk static int acpi_smbus_transaction(struct acpi_smb_hc *hc, u8 protocol, 125e5685b9dSAdrian Bunk u8 address, u8 command, u8 *data, u8 length) 12691087dfaSAlexey Starikovskiy { 12791087dfaSAlexey Starikovskiy int ret = -EFAULT, i; 12891087dfaSAlexey Starikovskiy u8 temp, sz = 0; 12991087dfaSAlexey Starikovskiy 130bbafbecbSAlexey Starikovskiy if (!hc) { 131bbafbecbSAlexey Starikovskiy printk(KERN_ERR PREFIX "host controller is not configured\n"); 132bbafbecbSAlexey Starikovskiy return ret; 133bbafbecbSAlexey Starikovskiy } 134bbafbecbSAlexey Starikovskiy 13591087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 13691087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_PROTOCOL, &temp)) 13791087dfaSAlexey Starikovskiy goto end; 13891087dfaSAlexey Starikovskiy if (temp) { 13991087dfaSAlexey Starikovskiy ret = -EBUSY; 14091087dfaSAlexey Starikovskiy goto end; 14191087dfaSAlexey Starikovskiy } 14291087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_COMMAND, command); 14391087dfaSAlexey Starikovskiy if (!(protocol & 0x01)) { 14491087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_BLOCK_COUNT, length); 14591087dfaSAlexey Starikovskiy for (i = 0; i < length; ++i) 14691087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_DATA + i, data[i]); 14791087dfaSAlexey Starikovskiy } 14891087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_ADDRESS, address << 1); 14991087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_PROTOCOL, protocol); 15091087dfaSAlexey Starikovskiy /* 15191087dfaSAlexey Starikovskiy * Wait for completion. Save the status code, data size, 15291087dfaSAlexey Starikovskiy * and data into the return package (if required by the protocol). 15391087dfaSAlexey Starikovskiy */ 15491087dfaSAlexey Starikovskiy ret = wait_transaction_complete(hc, 1000); 15591087dfaSAlexey Starikovskiy if (ret || !(protocol & 0x01)) 15691087dfaSAlexey Starikovskiy goto end; 15791087dfaSAlexey Starikovskiy switch (protocol) { 15891087dfaSAlexey Starikovskiy case SMBUS_RECEIVE_BYTE: 15991087dfaSAlexey Starikovskiy case SMBUS_READ_BYTE: 16091087dfaSAlexey Starikovskiy sz = 1; 16191087dfaSAlexey Starikovskiy break; 16291087dfaSAlexey Starikovskiy case SMBUS_READ_WORD: 16391087dfaSAlexey Starikovskiy sz = 2; 16491087dfaSAlexey Starikovskiy break; 16591087dfaSAlexey Starikovskiy case SMBUS_READ_BLOCK: 16691087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_BLOCK_COUNT, &sz)) { 16791087dfaSAlexey Starikovskiy ret = -EFAULT; 16891087dfaSAlexey Starikovskiy goto end; 16991087dfaSAlexey Starikovskiy } 17091087dfaSAlexey Starikovskiy sz &= 0x1f; 17191087dfaSAlexey Starikovskiy break; 17291087dfaSAlexey Starikovskiy } 17391087dfaSAlexey Starikovskiy for (i = 0; i < sz; ++i) 17491087dfaSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_DATA + i, &data[i]); 17591087dfaSAlexey Starikovskiy end: 17691087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 17791087dfaSAlexey Starikovskiy return ret; 17891087dfaSAlexey Starikovskiy } 17991087dfaSAlexey Starikovskiy 18091087dfaSAlexey Starikovskiy int acpi_smbus_read(struct acpi_smb_hc *hc, u8 protocol, u8 address, 18191087dfaSAlexey Starikovskiy u8 command, u8 *data) 18291087dfaSAlexey Starikovskiy { 18391087dfaSAlexey Starikovskiy return acpi_smbus_transaction(hc, protocol, address, command, data, 0); 18491087dfaSAlexey Starikovskiy } 18591087dfaSAlexey Starikovskiy 18691087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_read); 18791087dfaSAlexey Starikovskiy 18891087dfaSAlexey Starikovskiy int acpi_smbus_write(struct acpi_smb_hc *hc, u8 protocol, u8 address, 18991087dfaSAlexey Starikovskiy u8 command, u8 *data, u8 length) 19091087dfaSAlexey Starikovskiy { 19191087dfaSAlexey Starikovskiy return acpi_smbus_transaction(hc, protocol, address, command, data, length); 19291087dfaSAlexey Starikovskiy } 19391087dfaSAlexey Starikovskiy 19491087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_write); 19591087dfaSAlexey Starikovskiy 19691087dfaSAlexey Starikovskiy int acpi_smbus_register_callback(struct acpi_smb_hc *hc, 19791087dfaSAlexey Starikovskiy smbus_alarm_callback callback, void *context) 19891087dfaSAlexey Starikovskiy { 19991087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 20091087dfaSAlexey Starikovskiy hc->callback = callback; 20191087dfaSAlexey Starikovskiy hc->context = context; 20291087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 20391087dfaSAlexey Starikovskiy return 0; 20491087dfaSAlexey Starikovskiy } 20591087dfaSAlexey Starikovskiy 20691087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_register_callback); 20791087dfaSAlexey Starikovskiy 20891087dfaSAlexey Starikovskiy int acpi_smbus_unregister_callback(struct acpi_smb_hc *hc) 20991087dfaSAlexey Starikovskiy { 21091087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 21191087dfaSAlexey Starikovskiy hc->callback = NULL; 21291087dfaSAlexey Starikovskiy hc->context = NULL; 21391087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 21491087dfaSAlexey Starikovskiy return 0; 21591087dfaSAlexey Starikovskiy } 21691087dfaSAlexey Starikovskiy 21791087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_unregister_callback); 21891087dfaSAlexey Starikovskiy 219c2d00f2dSAlexey Starikovskiy static inline void acpi_smbus_callback(void *context) 22091087dfaSAlexey Starikovskiy { 22191087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc = context; 22291087dfaSAlexey Starikovskiy if (hc->callback) 22391087dfaSAlexey Starikovskiy hc->callback(hc->context); 22491087dfaSAlexey Starikovskiy } 22591087dfaSAlexey Starikovskiy 22691087dfaSAlexey Starikovskiy static int smbus_alarm(void *context) 22791087dfaSAlexey Starikovskiy { 22891087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc = context; 22991087dfaSAlexey Starikovskiy union acpi_smb_status status; 230c2d00f2dSAlexey Starikovskiy u8 address; 23191087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_STATUS, &status.raw)) 23291087dfaSAlexey Starikovskiy return 0; 23391087dfaSAlexey Starikovskiy /* Check if it is only a completion notify */ 23491087dfaSAlexey Starikovskiy if (status.fields.done) 23591087dfaSAlexey Starikovskiy wake_up(&hc->wait); 23691087dfaSAlexey Starikovskiy if (!status.fields.alarm) 23791087dfaSAlexey Starikovskiy return 0; 23891087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 239c2d00f2dSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_ALARM_ADDRESS, &address); 24009f1fb41SAlexey Starikovskiy status.fields.alarm = 0; 24191087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_STATUS, status.raw); 242c2d00f2dSAlexey Starikovskiy /* We are only interested in events coming from known devices */ 243c2d00f2dSAlexey Starikovskiy switch (address >> 1) { 244c2d00f2dSAlexey Starikovskiy case ACPI_SBS_CHARGER: 245c2d00f2dSAlexey Starikovskiy case ACPI_SBS_MANAGER: 246c2d00f2dSAlexey Starikovskiy case ACPI_SBS_BATTERY: 247f5347867SAlexey Starikovskiy acpi_os_execute(OSL_NOTIFY_HANDLER, 248c2d00f2dSAlexey Starikovskiy acpi_smbus_callback, hc); 249c2d00f2dSAlexey Starikovskiy default:; 250c2d00f2dSAlexey Starikovskiy } 25191087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 25291087dfaSAlexey Starikovskiy return 0; 25391087dfaSAlexey Starikovskiy } 25491087dfaSAlexey Starikovskiy 25591087dfaSAlexey Starikovskiy typedef int (*acpi_ec_query_func) (void *data); 25691087dfaSAlexey Starikovskiy 25791087dfaSAlexey Starikovskiy extern int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, 25891087dfaSAlexey Starikovskiy acpi_handle handle, acpi_ec_query_func func, 25991087dfaSAlexey Starikovskiy void *data); 26091087dfaSAlexey Starikovskiy 26191087dfaSAlexey Starikovskiy static int acpi_smbus_hc_add(struct acpi_device *device) 26291087dfaSAlexey Starikovskiy { 26391087dfaSAlexey Starikovskiy int status; 26427663c58SMatthew Wilcox unsigned long long val; 26591087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc; 26691087dfaSAlexey Starikovskiy 26791087dfaSAlexey Starikovskiy if (!device) 26891087dfaSAlexey Starikovskiy return -EINVAL; 26991087dfaSAlexey Starikovskiy 27091087dfaSAlexey Starikovskiy status = acpi_evaluate_integer(device->handle, "_EC", NULL, &val); 27191087dfaSAlexey Starikovskiy if (ACPI_FAILURE(status)) { 27291087dfaSAlexey Starikovskiy printk(KERN_ERR PREFIX "error obtaining _EC.\n"); 27391087dfaSAlexey Starikovskiy return -EIO; 27491087dfaSAlexey Starikovskiy } 27591087dfaSAlexey Starikovskiy 27691087dfaSAlexey Starikovskiy strcpy(acpi_device_name(device), ACPI_SMB_HC_DEVICE_NAME); 27791087dfaSAlexey Starikovskiy strcpy(acpi_device_class(device), ACPI_SMB_HC_CLASS); 27891087dfaSAlexey Starikovskiy 27991087dfaSAlexey Starikovskiy hc = kzalloc(sizeof(struct acpi_smb_hc), GFP_KERNEL); 28091087dfaSAlexey Starikovskiy if (!hc) 28191087dfaSAlexey Starikovskiy return -ENOMEM; 28291087dfaSAlexey Starikovskiy mutex_init(&hc->lock); 28391087dfaSAlexey Starikovskiy init_waitqueue_head(&hc->wait); 28491087dfaSAlexey Starikovskiy 28591087dfaSAlexey Starikovskiy hc->ec = acpi_driver_data(device->parent); 28691087dfaSAlexey Starikovskiy hc->offset = (val >> 8) & 0xff; 28791087dfaSAlexey Starikovskiy hc->query_bit = val & 0xff; 288db89b4f0SPavel Machek device->driver_data = hc; 28991087dfaSAlexey Starikovskiy 29091087dfaSAlexey Starikovskiy acpi_ec_add_query_handler(hc->ec, hc->query_bit, NULL, smbus_alarm, hc); 29191087dfaSAlexey Starikovskiy printk(KERN_INFO PREFIX "SBS HC: EC = 0x%p, offset = 0x%0x, query_bit = 0x%0x\n", 29291087dfaSAlexey Starikovskiy hc->ec, hc->offset, hc->query_bit); 29391087dfaSAlexey Starikovskiy 29491087dfaSAlexey Starikovskiy return 0; 29591087dfaSAlexey Starikovskiy } 29691087dfaSAlexey Starikovskiy 29791087dfaSAlexey Starikovskiy extern void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit); 29891087dfaSAlexey Starikovskiy 29951fac838SRafael J. Wysocki static int acpi_smbus_hc_remove(struct acpi_device *device) 30091087dfaSAlexey Starikovskiy { 30191087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc; 30291087dfaSAlexey Starikovskiy 30391087dfaSAlexey Starikovskiy if (!device) 30491087dfaSAlexey Starikovskiy return -EINVAL; 30591087dfaSAlexey Starikovskiy 30691087dfaSAlexey Starikovskiy hc = acpi_driver_data(device); 30791087dfaSAlexey Starikovskiy acpi_ec_remove_query_handler(hc->ec, hc->query_bit); 30891087dfaSAlexey Starikovskiy kfree(hc); 309db89b4f0SPavel Machek device->driver_data = NULL; 31091087dfaSAlexey Starikovskiy return 0; 31191087dfaSAlexey Starikovskiy } 31291087dfaSAlexey Starikovskiy 313e84a239eSMika Westerberg module_acpi_driver(acpi_smb_hc_driver); 31491087dfaSAlexey Starikovskiy 31591087dfaSAlexey Starikovskiy MODULE_LICENSE("GPL"); 31691087dfaSAlexey Starikovskiy MODULE_AUTHOR("Alexey Starikovskiy"); 31791087dfaSAlexey Starikovskiy MODULE_DESCRIPTION("ACPI SMBus HC driver"); 318