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 118b48463fSLv Zheng #include <linux/acpi.h> 1291087dfaSAlexey Starikovskiy #include <linux/wait.h> 135a0e3ad6STejun Heo #include <linux/slab.h> 1491087dfaSAlexey Starikovskiy #include <linux/delay.h> 15cc4b859cSPaul Gortmaker #include <linux/module.h> 1691087dfaSAlexey Starikovskiy #include <linux/interrupt.h> 173349fb64SChris Bainbridge #include <linux/dmi.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; 33add68d6aSChris Bainbridge bool done; 3491087dfaSAlexey Starikovskiy }; 3591087dfaSAlexey Starikovskiy 3691087dfaSAlexey Starikovskiy static int acpi_smbus_hc_add(struct acpi_device *device); 3751fac838SRafael J. Wysocki static int acpi_smbus_hc_remove(struct acpi_device *device); 3891087dfaSAlexey Starikovskiy 3991087dfaSAlexey Starikovskiy static const struct acpi_device_id sbs_device_ids[] = { 4091087dfaSAlexey Starikovskiy {"ACPI0001", 0}, 4191087dfaSAlexey Starikovskiy {"ACPI0005", 0}, 4291087dfaSAlexey Starikovskiy {"", 0}, 4391087dfaSAlexey Starikovskiy }; 4491087dfaSAlexey Starikovskiy 4591087dfaSAlexey Starikovskiy MODULE_DEVICE_TABLE(acpi, sbs_device_ids); 4691087dfaSAlexey Starikovskiy 4791087dfaSAlexey Starikovskiy static struct acpi_driver acpi_smb_hc_driver = { 4891087dfaSAlexey Starikovskiy .name = "smbus_hc", 4991087dfaSAlexey Starikovskiy .class = ACPI_SMB_HC_CLASS, 5091087dfaSAlexey Starikovskiy .ids = sbs_device_ids, 5191087dfaSAlexey Starikovskiy .ops = { 5291087dfaSAlexey Starikovskiy .add = acpi_smbus_hc_add, 5391087dfaSAlexey Starikovskiy .remove = acpi_smbus_hc_remove, 5491087dfaSAlexey Starikovskiy }, 5591087dfaSAlexey Starikovskiy }; 5691087dfaSAlexey Starikovskiy 5791087dfaSAlexey Starikovskiy union acpi_smb_status { 5891087dfaSAlexey Starikovskiy u8 raw; 5991087dfaSAlexey Starikovskiy struct { 6091087dfaSAlexey Starikovskiy u8 status:5; 6191087dfaSAlexey Starikovskiy u8 reserved:1; 6291087dfaSAlexey Starikovskiy u8 alarm:1; 6391087dfaSAlexey Starikovskiy u8 done:1; 6491087dfaSAlexey Starikovskiy } fields; 6591087dfaSAlexey Starikovskiy }; 6691087dfaSAlexey Starikovskiy 6791087dfaSAlexey Starikovskiy enum acpi_smb_status_codes { 6891087dfaSAlexey Starikovskiy SMBUS_OK = 0, 6991087dfaSAlexey Starikovskiy SMBUS_UNKNOWN_FAILURE = 0x07, 7091087dfaSAlexey Starikovskiy SMBUS_DEVICE_ADDRESS_NACK = 0x10, 7191087dfaSAlexey Starikovskiy SMBUS_DEVICE_ERROR = 0x11, 7291087dfaSAlexey Starikovskiy SMBUS_DEVICE_COMMAND_ACCESS_DENIED = 0x12, 7391087dfaSAlexey Starikovskiy SMBUS_UNKNOWN_ERROR = 0x13, 7491087dfaSAlexey Starikovskiy SMBUS_DEVICE_ACCESS_DENIED = 0x17, 7591087dfaSAlexey Starikovskiy SMBUS_TIMEOUT = 0x18, 7691087dfaSAlexey Starikovskiy SMBUS_HOST_UNSUPPORTED_PROTOCOL = 0x19, 7791087dfaSAlexey Starikovskiy SMBUS_BUSY = 0x1a, 7891087dfaSAlexey Starikovskiy SMBUS_PEC_ERROR = 0x1f, 7991087dfaSAlexey Starikovskiy }; 8091087dfaSAlexey Starikovskiy 8191087dfaSAlexey Starikovskiy enum acpi_smb_offset { 8291087dfaSAlexey Starikovskiy ACPI_SMB_PROTOCOL = 0, /* protocol, PEC */ 8391087dfaSAlexey Starikovskiy ACPI_SMB_STATUS = 1, /* status */ 8491087dfaSAlexey Starikovskiy ACPI_SMB_ADDRESS = 2, /* address */ 8591087dfaSAlexey Starikovskiy ACPI_SMB_COMMAND = 3, /* command */ 8691087dfaSAlexey Starikovskiy ACPI_SMB_DATA = 4, /* 32 data registers */ 8791087dfaSAlexey Starikovskiy ACPI_SMB_BLOCK_COUNT = 0x24, /* number of data bytes */ 8891087dfaSAlexey Starikovskiy ACPI_SMB_ALARM_ADDRESS = 0x25, /* alarm address */ 8991087dfaSAlexey Starikovskiy ACPI_SMB_ALARM_DATA = 0x26, /* 2 bytes alarm data */ 9091087dfaSAlexey Starikovskiy }; 9191087dfaSAlexey Starikovskiy 923349fb64SChris Bainbridge static bool macbook; 933349fb64SChris Bainbridge 9491087dfaSAlexey Starikovskiy static inline int smb_hc_read(struct acpi_smb_hc *hc, u8 address, u8 *data) 9591087dfaSAlexey Starikovskiy { 9691087dfaSAlexey Starikovskiy return ec_read(hc->offset + address, data); 9791087dfaSAlexey Starikovskiy } 9891087dfaSAlexey Starikovskiy 9991087dfaSAlexey Starikovskiy static inline int smb_hc_write(struct acpi_smb_hc *hc, u8 address, u8 data) 10091087dfaSAlexey Starikovskiy { 10191087dfaSAlexey Starikovskiy return ec_write(hc->offset + address, data); 10291087dfaSAlexey Starikovskiy } 10391087dfaSAlexey Starikovskiy 10491087dfaSAlexey Starikovskiy static int wait_transaction_complete(struct acpi_smb_hc *hc, int timeout) 10591087dfaSAlexey Starikovskiy { 106add68d6aSChris Bainbridge if (wait_event_timeout(hc->wait, hc->done, msecs_to_jiffies(timeout))) 10791087dfaSAlexey Starikovskiy return 0; 10891087dfaSAlexey Starikovskiy return -ETIME; 10991087dfaSAlexey Starikovskiy } 11091087dfaSAlexey Starikovskiy 111e5685b9dSAdrian Bunk static int acpi_smbus_transaction(struct acpi_smb_hc *hc, u8 protocol, 112e5685b9dSAdrian Bunk u8 address, u8 command, u8 *data, u8 length) 11391087dfaSAlexey Starikovskiy { 11491087dfaSAlexey Starikovskiy int ret = -EFAULT, i; 11591087dfaSAlexey Starikovskiy u8 temp, sz = 0; 11691087dfaSAlexey Starikovskiy 117bbafbecbSAlexey Starikovskiy if (!hc) { 118bbafbecbSAlexey Starikovskiy printk(KERN_ERR PREFIX "host controller is not configured\n"); 119bbafbecbSAlexey Starikovskiy return ret; 120bbafbecbSAlexey Starikovskiy } 121bbafbecbSAlexey Starikovskiy 12291087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 123add68d6aSChris Bainbridge hc->done = false; 1243349fb64SChris Bainbridge if (macbook) 1253349fb64SChris Bainbridge udelay(5); 12691087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_PROTOCOL, &temp)) 12791087dfaSAlexey Starikovskiy goto end; 12891087dfaSAlexey Starikovskiy if (temp) { 12991087dfaSAlexey Starikovskiy ret = -EBUSY; 13091087dfaSAlexey Starikovskiy goto end; 13191087dfaSAlexey Starikovskiy } 13291087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_COMMAND, command); 13391087dfaSAlexey Starikovskiy if (!(protocol & 0x01)) { 13491087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_BLOCK_COUNT, length); 13591087dfaSAlexey Starikovskiy for (i = 0; i < length; ++i) 13691087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_DATA + i, data[i]); 13791087dfaSAlexey Starikovskiy } 13891087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_ADDRESS, address << 1); 13991087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_PROTOCOL, protocol); 14091087dfaSAlexey Starikovskiy /* 14191087dfaSAlexey Starikovskiy * Wait for completion. Save the status code, data size, 14291087dfaSAlexey Starikovskiy * and data into the return package (if required by the protocol). 14391087dfaSAlexey Starikovskiy */ 14491087dfaSAlexey Starikovskiy ret = wait_transaction_complete(hc, 1000); 14591087dfaSAlexey Starikovskiy if (ret || !(protocol & 0x01)) 14691087dfaSAlexey Starikovskiy goto end; 14791087dfaSAlexey Starikovskiy switch (protocol) { 14891087dfaSAlexey Starikovskiy case SMBUS_RECEIVE_BYTE: 14991087dfaSAlexey Starikovskiy case SMBUS_READ_BYTE: 15091087dfaSAlexey Starikovskiy sz = 1; 15191087dfaSAlexey Starikovskiy break; 15291087dfaSAlexey Starikovskiy case SMBUS_READ_WORD: 15391087dfaSAlexey Starikovskiy sz = 2; 15491087dfaSAlexey Starikovskiy break; 15591087dfaSAlexey Starikovskiy case SMBUS_READ_BLOCK: 15691087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_BLOCK_COUNT, &sz)) { 15791087dfaSAlexey Starikovskiy ret = -EFAULT; 15891087dfaSAlexey Starikovskiy goto end; 15991087dfaSAlexey Starikovskiy } 16091087dfaSAlexey Starikovskiy sz &= 0x1f; 16191087dfaSAlexey Starikovskiy break; 16291087dfaSAlexey Starikovskiy } 16391087dfaSAlexey Starikovskiy for (i = 0; i < sz; ++i) 16491087dfaSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_DATA + i, &data[i]); 16591087dfaSAlexey Starikovskiy end: 16691087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 16791087dfaSAlexey Starikovskiy return ret; 16891087dfaSAlexey Starikovskiy } 16991087dfaSAlexey Starikovskiy 17091087dfaSAlexey Starikovskiy int acpi_smbus_read(struct acpi_smb_hc *hc, u8 protocol, u8 address, 17191087dfaSAlexey Starikovskiy u8 command, u8 *data) 17291087dfaSAlexey Starikovskiy { 17391087dfaSAlexey Starikovskiy return acpi_smbus_transaction(hc, protocol, address, command, data, 0); 17491087dfaSAlexey Starikovskiy } 17591087dfaSAlexey Starikovskiy 17691087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_read); 17791087dfaSAlexey Starikovskiy 17891087dfaSAlexey Starikovskiy int acpi_smbus_write(struct acpi_smb_hc *hc, u8 protocol, u8 address, 17991087dfaSAlexey Starikovskiy u8 command, u8 *data, u8 length) 18091087dfaSAlexey Starikovskiy { 18191087dfaSAlexey Starikovskiy return acpi_smbus_transaction(hc, protocol, address, command, data, length); 18291087dfaSAlexey Starikovskiy } 18391087dfaSAlexey Starikovskiy 18491087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_write); 18591087dfaSAlexey Starikovskiy 18691087dfaSAlexey Starikovskiy int acpi_smbus_register_callback(struct acpi_smb_hc *hc, 18791087dfaSAlexey Starikovskiy smbus_alarm_callback callback, void *context) 18891087dfaSAlexey Starikovskiy { 18991087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 19091087dfaSAlexey Starikovskiy hc->callback = callback; 19191087dfaSAlexey Starikovskiy hc->context = context; 19291087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 19391087dfaSAlexey Starikovskiy return 0; 19491087dfaSAlexey Starikovskiy } 19591087dfaSAlexey Starikovskiy 19691087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_register_callback); 19791087dfaSAlexey Starikovskiy 19891087dfaSAlexey Starikovskiy int acpi_smbus_unregister_callback(struct acpi_smb_hc *hc) 19991087dfaSAlexey Starikovskiy { 20091087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 20191087dfaSAlexey Starikovskiy hc->callback = NULL; 20291087dfaSAlexey Starikovskiy hc->context = NULL; 20391087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 20491087dfaSAlexey Starikovskiy return 0; 20591087dfaSAlexey Starikovskiy } 20691087dfaSAlexey Starikovskiy 20791087dfaSAlexey Starikovskiy EXPORT_SYMBOL_GPL(acpi_smbus_unregister_callback); 20891087dfaSAlexey Starikovskiy 209c2d00f2dSAlexey Starikovskiy static inline void acpi_smbus_callback(void *context) 21091087dfaSAlexey Starikovskiy { 21191087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc = context; 21291087dfaSAlexey Starikovskiy if (hc->callback) 21391087dfaSAlexey Starikovskiy hc->callback(hc->context); 21491087dfaSAlexey Starikovskiy } 21591087dfaSAlexey Starikovskiy 21691087dfaSAlexey Starikovskiy static int smbus_alarm(void *context) 21791087dfaSAlexey Starikovskiy { 21891087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc = context; 21991087dfaSAlexey Starikovskiy union acpi_smb_status status; 220c2d00f2dSAlexey Starikovskiy u8 address; 22191087dfaSAlexey Starikovskiy if (smb_hc_read(hc, ACPI_SMB_STATUS, &status.raw)) 22291087dfaSAlexey Starikovskiy return 0; 22391087dfaSAlexey Starikovskiy /* Check if it is only a completion notify */ 224add68d6aSChris Bainbridge if (status.fields.done && status.fields.status == SMBUS_OK) { 225add68d6aSChris Bainbridge hc->done = true; 22691087dfaSAlexey Starikovskiy wake_up(&hc->wait); 227add68d6aSChris Bainbridge } 22891087dfaSAlexey Starikovskiy if (!status.fields.alarm) 22991087dfaSAlexey Starikovskiy return 0; 23091087dfaSAlexey Starikovskiy mutex_lock(&hc->lock); 231c2d00f2dSAlexey Starikovskiy smb_hc_read(hc, ACPI_SMB_ALARM_ADDRESS, &address); 23209f1fb41SAlexey Starikovskiy status.fields.alarm = 0; 23391087dfaSAlexey Starikovskiy smb_hc_write(hc, ACPI_SMB_STATUS, status.raw); 234c2d00f2dSAlexey Starikovskiy /* We are only interested in events coming from known devices */ 235c2d00f2dSAlexey Starikovskiy switch (address >> 1) { 236c2d00f2dSAlexey Starikovskiy case ACPI_SBS_CHARGER: 237c2d00f2dSAlexey Starikovskiy case ACPI_SBS_MANAGER: 238c2d00f2dSAlexey Starikovskiy case ACPI_SBS_BATTERY: 239f5347867SAlexey Starikovskiy acpi_os_execute(OSL_NOTIFY_HANDLER, 240c2d00f2dSAlexey Starikovskiy acpi_smbus_callback, hc); 241c2d00f2dSAlexey Starikovskiy default:; 242c2d00f2dSAlexey Starikovskiy } 24391087dfaSAlexey Starikovskiy mutex_unlock(&hc->lock); 24491087dfaSAlexey Starikovskiy return 0; 24591087dfaSAlexey Starikovskiy } 24691087dfaSAlexey Starikovskiy 24791087dfaSAlexey Starikovskiy typedef int (*acpi_ec_query_func) (void *data); 24891087dfaSAlexey Starikovskiy 24991087dfaSAlexey Starikovskiy extern int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, 25091087dfaSAlexey Starikovskiy acpi_handle handle, acpi_ec_query_func func, 25191087dfaSAlexey Starikovskiy void *data); 25291087dfaSAlexey Starikovskiy 2533349fb64SChris Bainbridge static int macbook_dmi_match(const struct dmi_system_id *d) 2543349fb64SChris Bainbridge { 2553349fb64SChris Bainbridge pr_debug("Detected MacBook, enabling workaround\n"); 2563349fb64SChris Bainbridge macbook = true; 2573349fb64SChris Bainbridge return 0; 2583349fb64SChris Bainbridge } 2593349fb64SChris Bainbridge 2603349fb64SChris Bainbridge static struct dmi_system_id acpi_smbus_dmi_table[] = { 2613349fb64SChris Bainbridge { macbook_dmi_match, "Apple MacBook", { 2623349fb64SChris Bainbridge DMI_MATCH(DMI_BOARD_VENDOR, "Apple"), 2633349fb64SChris Bainbridge DMI_MATCH(DMI_PRODUCT_NAME, "MacBook") }, 2643349fb64SChris Bainbridge }, 2653349fb64SChris Bainbridge { }, 2663349fb64SChris Bainbridge }; 2673349fb64SChris Bainbridge 26891087dfaSAlexey Starikovskiy static int acpi_smbus_hc_add(struct acpi_device *device) 26991087dfaSAlexey Starikovskiy { 27091087dfaSAlexey Starikovskiy int status; 27127663c58SMatthew Wilcox unsigned long long val; 27291087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc; 27391087dfaSAlexey Starikovskiy 2743349fb64SChris Bainbridge dmi_check_system(acpi_smbus_dmi_table); 2753349fb64SChris Bainbridge 27691087dfaSAlexey Starikovskiy if (!device) 27791087dfaSAlexey Starikovskiy return -EINVAL; 27891087dfaSAlexey Starikovskiy 27991087dfaSAlexey Starikovskiy status = acpi_evaluate_integer(device->handle, "_EC", NULL, &val); 28091087dfaSAlexey Starikovskiy if (ACPI_FAILURE(status)) { 28191087dfaSAlexey Starikovskiy printk(KERN_ERR PREFIX "error obtaining _EC.\n"); 28291087dfaSAlexey Starikovskiy return -EIO; 28391087dfaSAlexey Starikovskiy } 28491087dfaSAlexey Starikovskiy 28591087dfaSAlexey Starikovskiy strcpy(acpi_device_name(device), ACPI_SMB_HC_DEVICE_NAME); 28691087dfaSAlexey Starikovskiy strcpy(acpi_device_class(device), ACPI_SMB_HC_CLASS); 28791087dfaSAlexey Starikovskiy 28891087dfaSAlexey Starikovskiy hc = kzalloc(sizeof(struct acpi_smb_hc), GFP_KERNEL); 28991087dfaSAlexey Starikovskiy if (!hc) 29091087dfaSAlexey Starikovskiy return -ENOMEM; 29191087dfaSAlexey Starikovskiy mutex_init(&hc->lock); 29291087dfaSAlexey Starikovskiy init_waitqueue_head(&hc->wait); 29391087dfaSAlexey Starikovskiy 29491087dfaSAlexey Starikovskiy hc->ec = acpi_driver_data(device->parent); 29591087dfaSAlexey Starikovskiy hc->offset = (val >> 8) & 0xff; 29691087dfaSAlexey Starikovskiy hc->query_bit = val & 0xff; 297db89b4f0SPavel Machek device->driver_data = hc; 29891087dfaSAlexey Starikovskiy 29991087dfaSAlexey Starikovskiy acpi_ec_add_query_handler(hc->ec, hc->query_bit, NULL, smbus_alarm, hc); 30091087dfaSAlexey Starikovskiy printk(KERN_INFO PREFIX "SBS HC: EC = 0x%p, offset = 0x%0x, query_bit = 0x%0x\n", 30191087dfaSAlexey Starikovskiy hc->ec, hc->offset, hc->query_bit); 30291087dfaSAlexey Starikovskiy 30391087dfaSAlexey Starikovskiy return 0; 30491087dfaSAlexey Starikovskiy } 30591087dfaSAlexey Starikovskiy 30691087dfaSAlexey Starikovskiy extern void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit); 30791087dfaSAlexey Starikovskiy 30851fac838SRafael J. Wysocki static int acpi_smbus_hc_remove(struct acpi_device *device) 30991087dfaSAlexey Starikovskiy { 31091087dfaSAlexey Starikovskiy struct acpi_smb_hc *hc; 31191087dfaSAlexey Starikovskiy 31291087dfaSAlexey Starikovskiy if (!device) 31391087dfaSAlexey Starikovskiy return -EINVAL; 31491087dfaSAlexey Starikovskiy 31591087dfaSAlexey Starikovskiy hc = acpi_driver_data(device); 31691087dfaSAlexey Starikovskiy acpi_ec_remove_query_handler(hc->ec, hc->query_bit); 31791087dfaSAlexey Starikovskiy kfree(hc); 318db89b4f0SPavel Machek device->driver_data = NULL; 31991087dfaSAlexey Starikovskiy return 0; 32091087dfaSAlexey Starikovskiy } 32191087dfaSAlexey Starikovskiy 322e84a239eSMika Westerberg module_acpi_driver(acpi_smb_hc_driver); 32391087dfaSAlexey Starikovskiy 32491087dfaSAlexey Starikovskiy MODULE_LICENSE("GPL"); 32591087dfaSAlexey Starikovskiy MODULE_AUTHOR("Alexey Starikovskiy"); 32691087dfaSAlexey Starikovskiy MODULE_DESCRIPTION("ACPI SMBus HC driver"); 327