2 * SMBus driver for ACPI Embedded Controller ($Revision: 1.3 $)
4 * Copyright (c) 2002, 2005 Ducrot Bruno
5 * Copyright (c) 2005 Rich Townsend (tiny hacks & tweaks)
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation version 2.
12 #include <linux/version.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/kernel.h>
16 #include <linux/stddef.h>
17 #include <linux/init.h>
18 #include <linux/i2c.h>
19 #include <linux/acpi.h>
20 #include <linux/delay.h>
24 #define xudelay(t) udelay(t)
25 #define xmsleep(t) msleep(t)
27 #define ACPI_EC_HC_COMPONENT 0x00080000
28 #define ACPI_EC_HC_CLASS "ec_hc_smbus"
29 #define ACPI_EC_HC_HID "ACPI0001"
30 #define ACPI_EC_HC_DRIVER_NAME "ACPI EC HC smbus driver"
31 #define ACPI_EC_HC_DEVICE_NAME "EC HC smbus"
33 #define _COMPONENT ACPI_EC_HC_COMPONENT
35 ACPI_MODULE_NAME("acpi_smbus")
37 static int acpi_ec_hc_add(struct acpi_device *device);
38 static int acpi_ec_hc_remove(struct acpi_device *device, int type);
40 static struct acpi_driver acpi_ec_hc_driver = {
41 .name = ACPI_EC_HC_DRIVER_NAME,
42 .class = ACPI_EC_HC_CLASS,
43 .ids = ACPI_EC_HC_HID,
45 .add = acpi_ec_hc_add,
46 .remove = acpi_ec_hc_remove,
50 /* Various bit mask for EC_SC (R) */
58 /* Commands for EC_SC (W) */
66 * ACPI 2.0 chapter 13 SMBus 2.0 EC register model
69 #define ACPI_EC_SMB_PRTCL 0x00 /* protocol, PEC */
70 #define ACPI_EC_SMB_STS 0x01 /* status */
71 #define ACPI_EC_SMB_ADDR 0x02 /* address */
72 #define ACPI_EC_SMB_CMD 0x03 /* command */
73 #define ACPI_EC_SMB_DATA 0x04 /* 32 data registers */
74 #define ACPI_EC_SMB_BCNT 0x24 /* number of data bytes */
75 #define ACPI_EC_SMB_ALRM_A 0x25 /* alarm address */
76 #define ACPI_EC_SMB_ALRM_D 0x26 /* 2 bytes alarm data */
78 #define ACPI_EC_SMB_STS_DONE 0x80
79 #define ACPI_EC_SMB_STS_ALRM 0x40
80 #define ACPI_EC_SMB_STS_RES 0x20
81 #define ACPI_EC_SMB_STS_STATUS 0x1f
83 #define ACPI_EC_SMB_STATUS_OK 0x00
84 #define ACPI_EC_SMB_STATUS_FAIL 0x07
85 #define ACPI_EC_SMB_STATUS_DNAK 0x10
86 #define ACPI_EC_SMB_STATUS_DERR 0x11
87 #define ACPI_EC_SMB_STATUS_CMD_DENY 0x12
88 #define ACPI_EC_SMB_STATUS_UNKNOWN 0x13
89 #define ACPI_EC_SMB_STATUS_ACC_DENY 0x17
90 #define ACPI_EC_SMB_STATUS_TIMEOUT 0x18
91 #define ACPI_EC_SMB_STATUS_NOTSUP 0x19
92 #define ACPI_EC_SMB_STATUS_BUSY 0x1A
93 #define ACPI_EC_SMB_STATUS_PEC 0x1F
95 #define ACPI_EC_SMB_PRTCL_WRITE 0x00
96 #define ACPI_EC_SMB_PRTCL_READ 0x01
97 #define ACPI_EC_SMB_PRTCL_QUICK 0x02
98 #define ACPI_EC_SMB_PRTCL_BYTE 0x04
99 #define ACPI_EC_SMB_PRTCL_BYTE_DATA 0x06
100 #define ACPI_EC_SMB_PRTCL_WORD_DATA 0x08
101 #define ACPI_EC_SMB_PRTCL_BLOCK_DATA 0x0a
102 #define ACPI_EC_SMB_PRTCL_PROC_CALL 0x0c
103 #define ACPI_EC_SMB_PRTCL_BLOCK_PROC_CALL 0x0d
104 #define ACPI_EC_SMB_PRTCL_I2C_BLOCK_DATA 0x4a
105 #define ACPI_EC_SMB_PRTCL_PEC 0x80
107 /* Length of pre/post transaction sleep (msec) */
108 #define ACPI_EC_SMB_TRANSACTION_SLEEP 1
109 #define ACPI_EC_SMB_ACCESS_SLEEP1 1
110 #define ACPI_EC_SMB_ACCESS_SLEEP2 10
112 static int acpi_ec_smb_read(struct acpi_ec_smbus *smbus, u8 address, u8 * data)
117 err = ec_read(smbus->base + address, &val);
121 xmsleep(ACPI_EC_SMB_TRANSACTION_SLEEP);
125 static int acpi_ec_smb_write(struct acpi_ec_smbus *smbus, u8 address, u8 data)
129 err = ec_write(smbus->base + address, data);
134 acpi_ec_smb_access(struct i2c_adapter *adap, u16 addr, unsigned short flags,
135 char read_write, u8 command, int size,
136 union i2c_smbus_data *data)
138 struct acpi_ec_smbus *smbus = adap->algo_data;
139 unsigned char protocol, len = 0, pec, temp[2] = { 0, 0 };
142 if (read_write == I2C_SMBUS_READ) {
143 protocol = ACPI_EC_SMB_PRTCL_READ;
145 protocol = ACPI_EC_SMB_PRTCL_WRITE;
147 pec = (flags & I2C_CLIENT_PEC) ? ACPI_EC_SMB_PRTCL_PEC : 0;
151 case I2C_SMBUS_QUICK:
152 protocol |= ACPI_EC_SMB_PRTCL_QUICK;
153 read_write = I2C_SMBUS_WRITE;
157 if (read_write == I2C_SMBUS_WRITE) {
158 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA, data->byte);
160 protocol |= ACPI_EC_SMB_PRTCL_BYTE;
163 case I2C_SMBUS_BYTE_DATA:
164 acpi_ec_smb_write(smbus, ACPI_EC_SMB_CMD, command);
165 if (read_write == I2C_SMBUS_WRITE) {
166 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA, data->byte);
168 protocol |= ACPI_EC_SMB_PRTCL_BYTE_DATA;
171 case I2C_SMBUS_WORD_DATA:
172 acpi_ec_smb_write(smbus, ACPI_EC_SMB_CMD, command);
173 if (read_write == I2C_SMBUS_WRITE) {
174 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA, data->word);
175 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA + 1,
178 protocol |= ACPI_EC_SMB_PRTCL_WORD_DATA | pec;
181 case I2C_SMBUS_BLOCK_DATA:
182 acpi_ec_smb_write(smbus, ACPI_EC_SMB_CMD, command);
183 if (read_write == I2C_SMBUS_WRITE) {
184 len = min_t(u8, data->block[0], 32);
185 acpi_ec_smb_write(smbus, ACPI_EC_SMB_BCNT, len);
186 for (i = 0; i < len; i++)
187 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA + i,
190 protocol |= ACPI_EC_SMB_PRTCL_BLOCK_DATA | pec;
193 case I2C_SMBUS_I2C_BLOCK_DATA:
194 len = min_t(u8, data->block[0], 32);
195 acpi_ec_smb_write(smbus, ACPI_EC_SMB_CMD, command);
196 acpi_ec_smb_write(smbus, ACPI_EC_SMB_BCNT, len);
197 if (read_write == I2C_SMBUS_WRITE) {
198 for (i = 0; i < len; i++) {
199 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA + i,
203 protocol |= ACPI_EC_SMB_PRTCL_I2C_BLOCK_DATA;
206 case I2C_SMBUS_PROC_CALL:
207 acpi_ec_smb_write(smbus, ACPI_EC_SMB_CMD, command);
208 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA, data->word);
209 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA + 1, data->word >> 8);
210 protocol = ACPI_EC_SMB_PRTCL_PROC_CALL | pec;
211 read_write = I2C_SMBUS_READ;
214 case I2C_SMBUS_BLOCK_PROC_CALL:
216 len = min_t(u8, data->block[0], 31);
217 acpi_ec_smb_write(smbus, ACPI_EC_SMB_CMD, command);
218 acpi_ec_smb_write(smbus, ACPI_EC_SMB_BCNT, len);
219 for (i = 0; i < len; i++)
220 acpi_ec_smb_write(smbus, ACPI_EC_SMB_DATA + i,
222 protocol = ACPI_EC_SMB_PRTCL_BLOCK_PROC_CALL | pec;
223 read_write = I2C_SMBUS_READ;
227 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "EC SMBus adapter: "
228 "Unsupported transaction %d\n", size));
232 acpi_ec_smb_write(smbus, ACPI_EC_SMB_ADDR, addr << 1);
233 acpi_ec_smb_write(smbus, ACPI_EC_SMB_PRTCL, protocol);
235 acpi_ec_smb_read(smbus, ACPI_EC_SMB_STS, temp + 0);
237 if (~temp[0] & ACPI_EC_SMB_STS_DONE) {
239 acpi_ec_smb_read(smbus, ACPI_EC_SMB_STS, temp + 0);
241 if (~temp[0] & ACPI_EC_SMB_STS_DONE) {
242 xmsleep(ACPI_EC_SMB_ACCESS_SLEEP2);
243 acpi_ec_smb_read(smbus, ACPI_EC_SMB_STS, temp + 0);
245 if ((~temp[0] & ACPI_EC_SMB_STS_DONE)
246 || (temp[0] & ACPI_EC_SMB_STS_STATUS)) {
250 if (read_write == I2C_SMBUS_WRITE) {
257 case I2C_SMBUS_BYTE_DATA:
258 acpi_ec_smb_read(smbus, ACPI_EC_SMB_DATA, &data->byte);
261 case I2C_SMBUS_WORD_DATA:
262 case I2C_SMBUS_PROC_CALL:
263 acpi_ec_smb_read(smbus, ACPI_EC_SMB_DATA, temp + 0);
264 acpi_ec_smb_read(smbus, ACPI_EC_SMB_DATA + 1, temp + 1);
265 data->word = (temp[1] << 8) | temp[0];
268 case I2C_SMBUS_BLOCK_DATA:
269 case I2C_SMBUS_BLOCK_PROC_CALL:
271 acpi_ec_smb_read(smbus, ACPI_EC_SMB_BCNT, &len);
272 len = min_t(u8, len, 32);
273 case I2C_SMBUS_I2C_BLOCK_DATA:
274 for (i = 0; i < len; i++)
275 acpi_ec_smb_read(smbus, ACPI_EC_SMB_DATA + i,
276 data->block + i + 1);
277 data->block[0] = len;
284 static u32 acpi_ec_smb_func(struct i2c_adapter *adapter)
287 return (I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
288 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
289 I2C_FUNC_SMBUS_BLOCK_DATA |
290 I2C_FUNC_SMBUS_PROC_CALL |
291 I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
292 I2C_FUNC_SMBUS_I2C_BLOCK | I2C_FUNC_SMBUS_HWPEC_CALC);
295 static const struct i2c_algorithm acpi_ec_smbus_algorithm = {
296 .smbus_xfer = acpi_ec_smb_access,
297 .functionality = acpi_ec_smb_func,
300 static int acpi_ec_hc_add(struct acpi_device *device)
304 struct acpi_ec_hc *ec_hc;
305 struct acpi_ec_smbus *smbus;
311 ec_hc = kzalloc(sizeof(struct acpi_ec_hc), GFP_KERNEL);
316 smbus = kzalloc(sizeof(struct acpi_ec_smbus), GFP_KERNEL);
322 ec_hc->handle = device->handle;
323 strcpy(acpi_device_name(device), ACPI_EC_HC_DEVICE_NAME);
324 strcpy(acpi_device_class(device), ACPI_EC_HC_CLASS);
325 acpi_driver_data(device) = ec_hc;
327 status = acpi_evaluate_integer(ec_hc->handle, "_EC", NULL, &val);
328 if (ACPI_FAILURE(status)) {
329 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "Error obtaining _EC\n"));
335 smbus->ec = acpi_driver_data(device->parent);
336 smbus->base = (val & 0xff00ull) >> 8;
337 smbus->alert = val & 0xffull;
339 smbus->adapter.owner = THIS_MODULE;
340 smbus->adapter.algo = &acpi_ec_smbus_algorithm;
341 smbus->adapter.algo_data = smbus;
342 smbus->adapter.dev.parent = &device->dev;
344 if (i2c_add_adapter(&smbus->adapter)) {
345 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
346 "EC SMBus adapter: Failed to register adapter\n"));
352 ec_hc->smbus = smbus;
354 printk(KERN_INFO PREFIX "%s [%s]\n",
355 acpi_device_name(device), acpi_device_bid(device));
360 static int acpi_ec_hc_remove(struct acpi_device *device, int type)
362 struct acpi_ec_hc *ec_hc;
367 ec_hc = acpi_driver_data(device);
369 i2c_del_adapter(&ec_hc->smbus->adapter);
376 static int __init acpi_ec_hc_init(void)
380 result = acpi_bus_register_driver(&acpi_ec_hc_driver);
387 static void __exit acpi_ec_hc_exit(void)
389 acpi_bus_unregister_driver(&acpi_ec_hc_driver);
392 struct acpi_ec_hc *acpi_get_ec_hc(struct acpi_device *device)
394 return acpi_driver_data(device->parent);
397 EXPORT_SYMBOL(acpi_get_ec_hc);
399 module_init(acpi_ec_hc_init);
400 module_exit(acpi_ec_hc_exit);
402 MODULE_LICENSE("GPL");
403 MODULE_AUTHOR("Ducrot Bruno");
404 MODULE_DESCRIPTION("ACPI EC SMBus driver");