2 * Provides ACPI support for IDE drives.
4 * Copyright (C) 2005 Intel Corp.
5 * Copyright (C) 2005 Randy Dunlap
6 * Copyright (C) 2006 SUSE Linux Products GmbH
7 * Copyright (C) 2006 Hannes Reinecke
10 #include <linux/acpi.h>
11 #include <linux/ata.h>
12 #include <linux/delay.h>
13 #include <linux/device.h>
14 #include <linux/errno.h>
15 #include <linux/kernel.h>
16 #include <linux/slab.h>
17 #include <linux/ide.h>
18 #include <linux/pci.h>
19 #include <linux/dmi.h>
20 #include <linux/module.h>
22 #define REGS_PER_GTF 7
32 struct ide_acpi_drive_link {
33 acpi_handle obj_handle;
37 struct ide_acpi_hwif_link {
39 acpi_handle obj_handle;
40 struct GTM_buffer gtm;
41 struct ide_acpi_drive_link master;
42 struct ide_acpi_drive_link slave;
46 /* note: adds function name and KERN_DEBUG */
48 #define DEBPRINT(fmt, args...) \
49 printk(KERN_DEBUG "%s: " fmt, __func__, ## args)
51 #define DEBPRINT(fmt, args...) do {} while (0)
52 #endif /* DEBUGGING */
54 static bool ide_noacpi;
55 module_param_named(noacpi, ide_noacpi, bool, 0);
56 MODULE_PARM_DESC(noacpi, "disable IDE ACPI support");
58 static bool ide_acpigtf;
59 module_param_named(acpigtf, ide_acpigtf, bool, 0);
60 MODULE_PARM_DESC(acpigtf, "enable IDE ACPI _GTF support");
62 static bool ide_acpionboot;
63 module_param_named(acpionboot, ide_acpionboot, bool, 0);
64 MODULE_PARM_DESC(acpionboot, "call IDE ACPI methods on boot");
66 static bool ide_noacpi_psx;
67 static int no_acpi_psx(const struct dmi_system_id *id)
69 ide_noacpi_psx = true;
70 printk(KERN_NOTICE"%s detected - disable ACPI _PSx.\n", id->ident);
74 static const struct dmi_system_id ide_acpi_dmi_table[] = {
76 /* We should check if this is because ACPI NVS isn't save/restored. */
78 .callback = no_acpi_psx,
81 DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies Ltd."),
82 DMI_MATCH(DMI_BIOS_VERSION, "KAM1.60")
86 { } /* terminate list */
89 int ide_acpi_init(void)
91 dmi_check_system(ide_acpi_dmi_table);
95 bool ide_port_acpi(ide_hwif_t *hwif)
97 return ide_noacpi == 0 && hwif->acpidata;
100 static acpi_handle acpi_get_child(acpi_handle handle, u64 addr)
102 struct acpi_device *adev;
104 if (!handle || acpi_bus_get_device(handle, &adev))
107 adev = acpi_find_child_device(adev, addr, false);
108 return adev ? adev->handle : NULL;
112 * ide_get_dev_handle - finds acpi_handle and PCI device.function
113 * @dev: device to locate
114 * @handle: returned acpi_handle for @dev
115 * @pcidevfn: return PCI device.func for @dev
117 * Returns the ACPI object handle to the corresponding PCI device.
119 * Returns 0 on success, <0 on error.
121 static int ide_get_dev_handle(struct device *dev, acpi_handle *handle,
124 struct pci_dev *pdev = to_pci_dev(dev);
125 unsigned int bus, devnum, func;
127 acpi_handle dev_handle;
129 struct acpi_device_info *dinfo = NULL;
132 bus = pdev->bus->number;
133 devnum = PCI_SLOT(pdev->devfn);
134 func = PCI_FUNC(pdev->devfn);
135 /* ACPI _ADR encoding for PCI bus: */
136 addr = (u64)(devnum << 16 | func);
138 DEBPRINT("ENTER: pci %02x:%02x.%01x\n", bus, devnum, func);
140 dev_handle = ACPI_HANDLE(dev);
142 DEBPRINT("no acpi handle for device\n");
146 status = acpi_get_object_info(dev_handle, &dinfo);
147 if (ACPI_FAILURE(status)) {
148 DEBPRINT("get_object_info for device failed\n");
151 if (dinfo && (dinfo->valid & ACPI_VALID_ADR) &&
152 dinfo->address == addr) {
154 *handle = dev_handle;
156 DEBPRINT("get_object_info for device has wrong "
157 " address: %llu, should be %u\n",
158 dinfo ? (unsigned long long)dinfo->address : -1ULL,
163 DEBPRINT("for dev=0x%x.%x, addr=0x%llx, *handle=0x%p\n",
164 devnum, func, (unsigned long long)addr, *handle);
172 * ide_acpi_hwif_get_handle - Get ACPI object handle for a given hwif
173 * @hwif: device to locate
175 * Retrieves the object handle for a given hwif.
177 * Returns handle on success, 0 on error.
179 static acpi_handle ide_acpi_hwif_get_handle(ide_hwif_t *hwif)
181 struct device *dev = hwif->gendev.parent;
182 acpi_handle uninitialized_var(dev_handle);
184 acpi_handle chan_handle;
187 DEBPRINT("ENTER: device %s\n", hwif->name);
190 DEBPRINT("no PCI device for %s\n", hwif->name);
194 err = ide_get_dev_handle(dev, &dev_handle, &pcidevfn);
196 DEBPRINT("ide_get_dev_handle failed (%d)\n", err);
200 /* get child objects of dev_handle == channel objects,
201 * + _their_ children == drive objects */
202 /* channel is hwif->channel */
203 chan_handle = acpi_get_child(dev_handle, hwif->channel);
204 DEBPRINT("chan adr=%d: handle=0x%p\n",
205 hwif->channel, chan_handle);
211 * do_drive_get_GTF - get the drive bootup default taskfile settings
212 * @drive: the drive for which the taskfile settings should be retrieved
213 * @gtf_length: number of bytes of _GTF data returned at @gtf_address
214 * @gtf_address: buffer containing _GTF taskfile arrays
216 * The _GTF method has no input parameters.
217 * It returns a variable number of register set values (registers
218 * hex 1F1..1F7, taskfiles).
219 * The <variable number> is not known in advance, so have ACPI-CA
220 * allocate the buffer as needed and return it, then free it later.
222 * The returned @gtf_length and @gtf_address are only valid if the
223 * function return value is 0.
225 static int do_drive_get_GTF(ide_drive_t *drive,
226 unsigned int *gtf_length, unsigned long *gtf_address,
227 unsigned long *obj_loc)
230 struct acpi_buffer output;
231 union acpi_object *out_obj;
238 if (!drive->acpidata->obj_handle) {
239 DEBPRINT("No ACPI object found for %s\n", drive->name);
243 /* Setting up output buffer */
244 output.length = ACPI_ALLOCATE_BUFFER;
245 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
247 /* _GTF has no input parameters */
249 status = acpi_evaluate_object(drive->acpidata->obj_handle, "_GTF",
251 if (ACPI_FAILURE(status)) {
253 "%s: Run _GTF error: status = 0x%x\n",
258 if (!output.length || !output.pointer) {
259 DEBPRINT("Run _GTF: "
260 "length or ptr is NULL (0x%llx, 0x%p)\n",
261 (unsigned long long)output.length,
266 out_obj = output.pointer;
267 if (out_obj->type != ACPI_TYPE_BUFFER) {
268 DEBPRINT("Run _GTF: error: "
269 "expected object type of ACPI_TYPE_BUFFER, "
270 "got 0x%x\n", out_obj->type);
272 kfree(output.pointer);
276 if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
277 out_obj->buffer.length % REGS_PER_GTF) {
279 "%s: unexpected GTF length (%d) or addr (0x%p)\n",
280 __func__, out_obj->buffer.length,
281 out_obj->buffer.pointer);
283 kfree(output.pointer);
287 *gtf_length = out_obj->buffer.length;
288 *gtf_address = (unsigned long)out_obj->buffer.pointer;
289 *obj_loc = (unsigned long)out_obj;
290 DEBPRINT("returning gtf_length=%d, gtf_address=0x%lx, obj_loc=0x%lx\n",
291 *gtf_length, *gtf_address, *obj_loc);
298 * do_drive_set_taskfiles - write the drive taskfile settings from _GTF
299 * @drive: the drive to which the taskfile command should be sent
300 * @gtf_length: total number of bytes of _GTF taskfiles
301 * @gtf_address: location of _GTF taskfile arrays
303 * Write {gtf_address, length gtf_length} in groups of
304 * REGS_PER_GTF bytes.
306 static int do_drive_set_taskfiles(ide_drive_t *drive,
307 unsigned int gtf_length,
308 unsigned long gtf_address)
311 int gtf_count = gtf_length / REGS_PER_GTF;
314 DEBPRINT("total GTF bytes=%u (0x%x), gtf_count=%d, addr=0x%lx\n",
315 gtf_length, gtf_length, gtf_count, gtf_address);
317 /* send all taskfile registers (0x1f1-0x1f7) *in*that*order* */
318 for (ix = 0; ix < gtf_count; ix++) {
319 u8 *gtf = (u8 *)(gtf_address + ix * REGS_PER_GTF);
322 DEBPRINT("(0x1f1-1f7): "
323 "hex: %02x %02x %02x %02x %02x %02x %02x\n",
324 gtf[0], gtf[1], gtf[2],
325 gtf[3], gtf[4], gtf[5], gtf[6]);
328 DEBPRINT("_GTF execution disabled\n");
332 /* convert GTF to taskfile */
333 memset(&cmd, 0, sizeof(cmd));
334 memcpy(&cmd.tf.feature, gtf, REGS_PER_GTF);
335 cmd.valid.out.tf = IDE_VALID_OUT_TF | IDE_VALID_DEVICE;
336 cmd.valid.in.tf = IDE_VALID_IN_TF | IDE_VALID_DEVICE;
338 err = ide_no_data_taskfile(drive, &cmd);
340 printk(KERN_ERR "%s: ide_no_data_taskfile failed: %u\n",
350 * ide_acpi_exec_tfs - get then write drive taskfile settings
351 * @drive: the drive for which the taskfile settings should be
354 * According to the ACPI spec this should be called after _STM
355 * has been evaluated for the interface. Some ACPI vendors interpret
356 * that as a hard requirement and modify the taskfile according
357 * to the Identify Drive information passed down with _STM.
358 * So one should really make sure to call this only after _STM has
361 int ide_acpi_exec_tfs(ide_drive_t *drive)
364 unsigned int gtf_length;
365 unsigned long gtf_address;
366 unsigned long obj_loc;
368 DEBPRINT("call get_GTF, drive=%s port=%d\n", drive->name, drive->dn);
370 ret = do_drive_get_GTF(drive, >f_length, >f_address, &obj_loc);
372 DEBPRINT("get_GTF error (%d)\n", ret);
376 DEBPRINT("call set_taskfiles, drive=%s\n", drive->name);
378 ret = do_drive_set_taskfiles(drive, gtf_length, gtf_address);
379 kfree((void *)obj_loc);
381 DEBPRINT("set_taskfiles error (%d)\n", ret);
384 DEBPRINT("ret=%d\n", ret);
390 * ide_acpi_get_timing - get the channel (controller) timings
391 * @hwif: target IDE interface (channel)
393 * This function executes the _GTM ACPI method for the target channel.
396 void ide_acpi_get_timing(ide_hwif_t *hwif)
399 struct acpi_buffer output;
400 union acpi_object *out_obj;
402 /* Setting up output buffer for _GTM */
403 output.length = ACPI_ALLOCATE_BUFFER;
404 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
406 /* _GTM has no input parameters */
407 status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_GTM",
410 DEBPRINT("_GTM status: %d, outptr: 0x%p, outlen: 0x%llx\n",
411 status, output.pointer,
412 (unsigned long long)output.length);
414 if (ACPI_FAILURE(status)) {
415 DEBPRINT("Run _GTM error: status = 0x%x\n", status);
419 if (!output.length || !output.pointer) {
420 DEBPRINT("Run _GTM: length or ptr is NULL (0x%llx, 0x%p)\n",
421 (unsigned long long)output.length,
423 kfree(output.pointer);
427 out_obj = output.pointer;
428 if (out_obj->type != ACPI_TYPE_BUFFER) {
429 DEBPRINT("Run _GTM: error: "
430 "expected object type of ACPI_TYPE_BUFFER, "
431 "got 0x%x\n", out_obj->type);
432 kfree(output.pointer);
436 if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
437 out_obj->buffer.length != sizeof(struct GTM_buffer)) {
439 "%s: unexpected _GTM length (0x%x)[should be 0x%zx] or "
441 __func__, out_obj->buffer.length,
442 sizeof(struct GTM_buffer), out_obj->buffer.pointer);
443 kfree(output.pointer);
447 memcpy(&hwif->acpidata->gtm, out_obj->buffer.pointer,
448 sizeof(struct GTM_buffer));
450 DEBPRINT("_GTM info: ptr: 0x%p, len: 0x%x, exp.len: 0x%Zx\n",
451 out_obj->buffer.pointer, out_obj->buffer.length,
452 sizeof(struct GTM_buffer));
454 DEBPRINT("_GTM fields: 0x%x, 0x%x, 0x%x, 0x%x, 0x%x\n",
455 hwif->acpidata->gtm.PIO_speed0,
456 hwif->acpidata->gtm.DMA_speed0,
457 hwif->acpidata->gtm.PIO_speed1,
458 hwif->acpidata->gtm.DMA_speed1,
459 hwif->acpidata->gtm.GTM_flags);
461 kfree(output.pointer);
465 * ide_acpi_push_timing - set the channel (controller) timings
466 * @hwif: target IDE interface (channel)
468 * This function executes the _STM ACPI method for the target channel.
470 * _STM requires Identify Drive data, which has to passed as an argument.
471 * Unfortunately drive->id is a mangled version which we can't readily
472 * use; hence we'll get the information afresh.
474 void ide_acpi_push_timing(ide_hwif_t *hwif)
477 struct acpi_object_list input;
478 union acpi_object in_params[3];
479 struct ide_acpi_drive_link *master = &hwif->acpidata->master;
480 struct ide_acpi_drive_link *slave = &hwif->acpidata->slave;
482 /* Give the GTM buffer + drive Identify data to the channel via the
484 /* setup input parameters buffer for _STM */
486 input.pointer = in_params;
487 in_params[0].type = ACPI_TYPE_BUFFER;
488 in_params[0].buffer.length = sizeof(struct GTM_buffer);
489 in_params[0].buffer.pointer = (u8 *)&hwif->acpidata->gtm;
490 in_params[1].type = ACPI_TYPE_BUFFER;
491 in_params[1].buffer.length = ATA_ID_WORDS * 2;
492 in_params[1].buffer.pointer = (u8 *)&master->idbuff;
493 in_params[2].type = ACPI_TYPE_BUFFER;
494 in_params[2].buffer.length = ATA_ID_WORDS * 2;
495 in_params[2].buffer.pointer = (u8 *)&slave->idbuff;
496 /* Output buffer: _STM has no output */
498 status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_STM",
501 if (ACPI_FAILURE(status)) {
502 DEBPRINT("Run _STM error: status = 0x%x\n", status);
504 DEBPRINT("_STM status: %d\n", status);
508 * ide_acpi_set_state - set the channel power state
509 * @hwif: target IDE interface
512 * This function executes the _PS0/_PS3 ACPI method to set the power state.
513 * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
515 void ide_acpi_set_state(ide_hwif_t *hwif, int on)
523 DEBPRINT("ENTER:\n");
525 /* channel first and then drives for power on and verse versa for power off */
527 acpi_bus_set_power(hwif->acpidata->obj_handle, ACPI_STATE_D0);
529 ide_port_for_each_present_dev(i, drive, hwif) {
530 if (drive->acpidata->obj_handle)
531 acpi_bus_set_power(drive->acpidata->obj_handle,
532 on ? ACPI_STATE_D0 : ACPI_STATE_D3_COLD);
536 acpi_bus_set_power(hwif->acpidata->obj_handle,
541 * ide_acpi_init_port - initialize the ACPI link for an IDE interface
542 * @hwif: target IDE interface (channel)
544 * The ACPI spec is not quite clear when the drive identify buffer
545 * should be obtained. Calling IDENTIFY DEVICE during shutdown
546 * is not the best of ideas as the drive might already being put to
547 * sleep. And obviously we can't call it during resume.
548 * So we get the information during startup; but this means that
549 * any changes during run-time will be lost after resume.
551 void ide_acpi_init_port(ide_hwif_t *hwif)
553 hwif->acpidata = kzalloc(sizeof(struct ide_acpi_hwif_link), GFP_KERNEL);
557 hwif->acpidata->obj_handle = ide_acpi_hwif_get_handle(hwif);
558 if (!hwif->acpidata->obj_handle) {
559 DEBPRINT("no ACPI object for %s found\n", hwif->name);
560 kfree(hwif->acpidata);
561 hwif->acpidata = NULL;
565 void ide_acpi_port_init_devices(ide_hwif_t *hwif)
570 if (hwif->acpidata == NULL)
574 * The ACPI spec mandates that we send information
575 * for both drives, regardless whether they are connected
578 hwif->devices[0]->acpidata = &hwif->acpidata->master;
579 hwif->devices[1]->acpidata = &hwif->acpidata->slave;
581 /* get _ADR info for each device */
582 ide_port_for_each_present_dev(i, drive, hwif) {
583 acpi_handle dev_handle;
585 DEBPRINT("ENTER: %s at channel#: %d port#: %d\n",
586 drive->name, hwif->channel, drive->dn & 1);
588 /* TBD: could also check ACPI object VALID bits */
589 dev_handle = acpi_get_child(hwif->acpidata->obj_handle,
592 DEBPRINT("drive %s handle 0x%p\n", drive->name, dev_handle);
594 drive->acpidata->obj_handle = dev_handle;
597 /* send IDENTIFY for each device */
598 ide_port_for_each_present_dev(i, drive, hwif) {
599 err = taskfile_lib_get_identify(drive, drive->acpidata->idbuff);
601 DEBPRINT("identify device %s failed (%d)\n",
605 if (ide_noacpi || ide_acpionboot == 0) {
606 DEBPRINT("ACPI methods disabled on boot\n");
610 /* ACPI _PS0 before _STM */
611 ide_acpi_set_state(hwif, 1);
613 * ACPI requires us to call _STM on startup
615 ide_acpi_get_timing(hwif);
616 ide_acpi_push_timing(hwif);
618 ide_port_for_each_present_dev(i, drive, hwif) {
619 ide_acpi_exec_tfs(drive);