2
* SMBus driver for ACPI SMBus CMI
4
* Copyright (C) 2009 Crane Cai <crane.cai@amd.com>
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation version 2.
11
#include <linux/module.h>
12
#include <linux/slab.h>
13
#include <linux/kernel.h>
14
#include <linux/stddef.h>
15
#include <linux/init.h>
16
#include <linux/i2c.h>
17
#include <linux/acpi.h>
19
#define ACPI_SMBUS_HC_CLASS "smbus"
20
#define ACPI_SMBUS_HC_DEVICE_NAME "cmi"
22
ACPI_MODULE_NAME("smbus_cmi");
24
struct smbus_methods_t {
30
struct acpi_smbus_cmi {
32
struct i2c_adapter adapter;
36
struct smbus_methods_t *methods;
39
static const struct smbus_methods_t smbus_methods = {
45
/* Some IBM BIOSes omit the leading underscore */
46
static const struct smbus_methods_t ibm_smbus_methods = {
52
static const struct acpi_device_id acpi_smbus_cmi_ids[] = {
53
{"SMBUS01", (kernel_ulong_t)&smbus_methods},
54
{ACPI_SMBUS_IBM_HID, (kernel_ulong_t)&ibm_smbus_methods},
57
MODULE_DEVICE_TABLE(acpi, acpi_smbus_cmi_ids);
59
#define ACPI_SMBUS_STATUS_OK 0x00
60
#define ACPI_SMBUS_STATUS_FAIL 0x07
61
#define ACPI_SMBUS_STATUS_DNAK 0x10
62
#define ACPI_SMBUS_STATUS_DERR 0x11
63
#define ACPI_SMBUS_STATUS_CMD_DENY 0x12
64
#define ACPI_SMBUS_STATUS_UNKNOWN 0x13
65
#define ACPI_SMBUS_STATUS_ACC_DENY 0x17
66
#define ACPI_SMBUS_STATUS_TIMEOUT 0x18
67
#define ACPI_SMBUS_STATUS_NOTSUP 0x19
68
#define ACPI_SMBUS_STATUS_BUSY 0x1a
69
#define ACPI_SMBUS_STATUS_PEC 0x1f
71
#define ACPI_SMBUS_PRTCL_WRITE 0x00
72
#define ACPI_SMBUS_PRTCL_READ 0x01
73
#define ACPI_SMBUS_PRTCL_QUICK 0x02
74
#define ACPI_SMBUS_PRTCL_BYTE 0x04
75
#define ACPI_SMBUS_PRTCL_BYTE_DATA 0x06
76
#define ACPI_SMBUS_PRTCL_WORD_DATA 0x08
77
#define ACPI_SMBUS_PRTCL_BLOCK_DATA 0x0a
81
acpi_smbus_cmi_access(struct i2c_adapter *adap, u16 addr, unsigned short flags,
82
char read_write, u8 command, int size,
83
union i2c_smbus_data *data)
86
struct acpi_smbus_cmi *smbus_cmi = adap->algo_data;
87
unsigned char protocol;
88
acpi_status status = 0;
89
struct acpi_object_list input;
90
union acpi_object mt_params[5];
91
struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
92
union acpi_object *obj;
93
union acpi_object *pkg;
97
dev_dbg(&adap->dev, "access size: %d %s\n", size,
98
(read_write) ? "READ" : "WRITE");
100
case I2C_SMBUS_QUICK:
101
protocol = ACPI_SMBUS_PRTCL_QUICK;
103
if (read_write == I2C_SMBUS_WRITE) {
104
mt_params[3].type = ACPI_TYPE_INTEGER;
105
mt_params[3].integer.value = 0;
106
mt_params[4].type = ACPI_TYPE_INTEGER;
107
mt_params[4].integer.value = 0;
112
protocol = ACPI_SMBUS_PRTCL_BYTE;
113
if (read_write == I2C_SMBUS_WRITE) {
114
mt_params[3].type = ACPI_TYPE_INTEGER;
115
mt_params[3].integer.value = 0;
116
mt_params[4].type = ACPI_TYPE_INTEGER;
117
mt_params[4].integer.value = 0;
123
case I2C_SMBUS_BYTE_DATA:
124
protocol = ACPI_SMBUS_PRTCL_BYTE_DATA;
125
if (read_write == I2C_SMBUS_WRITE) {
126
mt_params[3].type = ACPI_TYPE_INTEGER;
127
mt_params[3].integer.value = 1;
128
mt_params[4].type = ACPI_TYPE_INTEGER;
129
mt_params[4].integer.value = data->byte;
133
case I2C_SMBUS_WORD_DATA:
134
protocol = ACPI_SMBUS_PRTCL_WORD_DATA;
135
if (read_write == I2C_SMBUS_WRITE) {
136
mt_params[3].type = ACPI_TYPE_INTEGER;
137
mt_params[3].integer.value = 2;
138
mt_params[4].type = ACPI_TYPE_INTEGER;
139
mt_params[4].integer.value = data->word;
143
case I2C_SMBUS_BLOCK_DATA:
144
protocol = ACPI_SMBUS_PRTCL_BLOCK_DATA;
145
if (read_write == I2C_SMBUS_WRITE) {
146
len = data->block[0];
147
if (len == 0 || len > I2C_SMBUS_BLOCK_MAX)
149
mt_params[3].type = ACPI_TYPE_INTEGER;
150
mt_params[3].integer.value = len;
151
mt_params[4].type = ACPI_TYPE_BUFFER;
152
mt_params[4].buffer.pointer = data->block + 1;
157
dev_warn(&adap->dev, "Unsupported transaction %d\n", size);
161
if (read_write == I2C_SMBUS_READ) {
162
protocol |= ACPI_SMBUS_PRTCL_READ;
163
method = smbus_cmi->methods->mt_sbr;
166
protocol |= ACPI_SMBUS_PRTCL_WRITE;
167
method = smbus_cmi->methods->mt_sbw;
171
input.pointer = mt_params;
172
mt_params[0].type = ACPI_TYPE_INTEGER;
173
mt_params[0].integer.value = protocol;
174
mt_params[1].type = ACPI_TYPE_INTEGER;
175
mt_params[1].integer.value = addr;
176
mt_params[2].type = ACPI_TYPE_INTEGER;
177
mt_params[2].integer.value = command;
179
status = acpi_evaluate_object(smbus_cmi->handle, method, &input,
181
if (ACPI_FAILURE(status)) {
182
ACPI_ERROR((AE_INFO, "Evaluating %s: %i", method, status));
186
pkg = buffer.pointer;
187
if (pkg && pkg->type == ACPI_TYPE_PACKAGE)
188
obj = pkg->package.elements;
190
ACPI_ERROR((AE_INFO, "Invalid argument type"));
194
if (obj == NULL || obj->type != ACPI_TYPE_INTEGER) {
195
ACPI_ERROR((AE_INFO, "Invalid argument type"));
200
result = obj->integer.value;
201
ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s return status: %i\n",
205
case ACPI_SMBUS_STATUS_OK:
208
case ACPI_SMBUS_STATUS_BUSY:
211
case ACPI_SMBUS_STATUS_TIMEOUT:
214
case ACPI_SMBUS_STATUS_DNAK:
222
if (read_write == I2C_SMBUS_WRITE || size == I2C_SMBUS_QUICK)
225
obj = pkg->package.elements + 1;
226
if (obj == NULL || obj->type != ACPI_TYPE_INTEGER) {
227
ACPI_ERROR((AE_INFO, "Invalid argument type"));
232
len = obj->integer.value;
233
obj = pkg->package.elements + 2;
236
case I2C_SMBUS_BYTE_DATA:
237
case I2C_SMBUS_WORD_DATA:
238
if (obj == NULL || obj->type != ACPI_TYPE_INTEGER) {
239
ACPI_ERROR((AE_INFO, "Invalid argument type"));
244
data->word = obj->integer.value;
246
data->byte = obj->integer.value;
248
case I2C_SMBUS_BLOCK_DATA:
249
if (obj == NULL || obj->type != ACPI_TYPE_BUFFER) {
250
ACPI_ERROR((AE_INFO, "Invalid argument type"));
254
if (len == 0 || len > I2C_SMBUS_BLOCK_MAX)
256
data->block[0] = len;
257
memcpy(data->block + 1, obj->buffer.pointer, len);
262
kfree(buffer.pointer);
263
dev_dbg(&adap->dev, "Transaction status: %i\n", result);
267
static u32 acpi_smbus_cmi_func(struct i2c_adapter *adapter)
269
struct acpi_smbus_cmi *smbus_cmi = adapter->algo_data;
272
ret = smbus_cmi->cap_read | smbus_cmi->cap_write ?
273
I2C_FUNC_SMBUS_QUICK : 0;
275
ret |= smbus_cmi->cap_read ?
276
(I2C_FUNC_SMBUS_READ_BYTE |
277
I2C_FUNC_SMBUS_READ_BYTE_DATA |
278
I2C_FUNC_SMBUS_READ_WORD_DATA |
279
I2C_FUNC_SMBUS_READ_BLOCK_DATA) : 0;
281
ret |= smbus_cmi->cap_write ?
282
(I2C_FUNC_SMBUS_WRITE_BYTE |
283
I2C_FUNC_SMBUS_WRITE_BYTE_DATA |
284
I2C_FUNC_SMBUS_WRITE_WORD_DATA |
285
I2C_FUNC_SMBUS_WRITE_BLOCK_DATA) : 0;
290
static const struct i2c_algorithm acpi_smbus_cmi_algorithm = {
291
.smbus_xfer = acpi_smbus_cmi_access,
292
.functionality = acpi_smbus_cmi_func,
296
static int acpi_smbus_cmi_add_cap(struct acpi_smbus_cmi *smbus_cmi,
299
struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
300
union acpi_object *obj;
303
if (!strcmp(name, smbus_cmi->methods->mt_info)) {
304
status = acpi_evaluate_object(smbus_cmi->handle,
305
smbus_cmi->methods->mt_info,
307
if (ACPI_FAILURE(status)) {
308
ACPI_ERROR((AE_INFO, "Evaluating %s: %i",
309
smbus_cmi->methods->mt_info, status));
313
obj = buffer.pointer;
314
if (obj && obj->type == ACPI_TYPE_PACKAGE)
315
obj = obj->package.elements;
317
ACPI_ERROR((AE_INFO, "Invalid argument type"));
318
kfree(buffer.pointer);
322
if (obj->type != ACPI_TYPE_INTEGER) {
323
ACPI_ERROR((AE_INFO, "Invalid argument type"));
324
kfree(buffer.pointer);
327
ACPI_DEBUG_PRINT((ACPI_DB_INFO, "SMBus CMI Version %x"
328
"\n", (int)obj->integer.value));
330
kfree(buffer.pointer);
331
smbus_cmi->cap_info = 1;
332
} else if (!strcmp(name, smbus_cmi->methods->mt_sbr))
333
smbus_cmi->cap_read = 1;
334
else if (!strcmp(name, smbus_cmi->methods->mt_sbw))
335
smbus_cmi->cap_write = 1;
337
ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Unsupported CMI method: %s\n",
343
static acpi_status acpi_smbus_cmi_query_methods(acpi_handle handle, u32 level,
344
void *context, void **return_value)
347
struct acpi_buffer buffer = { sizeof(node_name), node_name };
348
struct acpi_smbus_cmi *smbus_cmi = context;
351
status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
353
if (ACPI_SUCCESS(status))
354
acpi_smbus_cmi_add_cap(smbus_cmi, node_name);
359
static int acpi_smbus_cmi_add(struct acpi_device *device)
361
struct acpi_smbus_cmi *smbus_cmi;
362
const struct acpi_device_id *id;
364
smbus_cmi = kzalloc(sizeof(struct acpi_smbus_cmi), GFP_KERNEL);
368
smbus_cmi->handle = device->handle;
369
strcpy(acpi_device_name(device), ACPI_SMBUS_HC_DEVICE_NAME);
370
strcpy(acpi_device_class(device), ACPI_SMBUS_HC_CLASS);
371
device->driver_data = smbus_cmi;
372
smbus_cmi->cap_info = 0;
373
smbus_cmi->cap_read = 0;
374
smbus_cmi->cap_write = 0;
376
for (id = acpi_smbus_cmi_ids; id->id[0]; id++)
377
if (!strcmp(id->id, acpi_device_hid(device)))
379
(struct smbus_methods_t *) id->driver_data;
381
acpi_walk_namespace(ACPI_TYPE_METHOD, smbus_cmi->handle, 1,
382
acpi_smbus_cmi_query_methods, NULL, smbus_cmi, NULL);
384
if (smbus_cmi->cap_info == 0)
387
snprintf(smbus_cmi->adapter.name, sizeof(smbus_cmi->adapter.name),
388
"SMBus CMI adapter %s",
389
acpi_device_name(device));
390
smbus_cmi->adapter.owner = THIS_MODULE;
391
smbus_cmi->adapter.algo = &acpi_smbus_cmi_algorithm;
392
smbus_cmi->adapter.algo_data = smbus_cmi;
393
smbus_cmi->adapter.class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
394
smbus_cmi->adapter.dev.parent = &device->dev;
396
if (i2c_add_adapter(&smbus_cmi->adapter)) {
397
dev_err(&device->dev, "Couldn't register adapter!\n");
405
device->driver_data = NULL;
409
static int acpi_smbus_cmi_remove(struct acpi_device *device, int type)
411
struct acpi_smbus_cmi *smbus_cmi = acpi_driver_data(device);
413
i2c_del_adapter(&smbus_cmi->adapter);
415
device->driver_data = NULL;
420
static struct acpi_driver acpi_smbus_cmi_driver = {
421
.name = ACPI_SMBUS_HC_DEVICE_NAME,
422
.class = ACPI_SMBUS_HC_CLASS,
423
.ids = acpi_smbus_cmi_ids,
425
.add = acpi_smbus_cmi_add,
426
.remove = acpi_smbus_cmi_remove,
430
static int __init acpi_smbus_cmi_init(void)
432
return acpi_bus_register_driver(&acpi_smbus_cmi_driver);
435
static void __exit acpi_smbus_cmi_exit(void)
437
acpi_bus_unregister_driver(&acpi_smbus_cmi_driver);
440
module_init(acpi_smbus_cmi_init);
441
module_exit(acpi_smbus_cmi_exit);
443
MODULE_LICENSE("GPL");
444
MODULE_AUTHOR("Crane Cai <crane.cai@amd.com>");
445
MODULE_DESCRIPTION("ACPI SMBus CMI driver");