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/ata.h>
11 #include <linux/delay.h>
12 #include <linux/device.h>
13 #include <linux/errno.h>
14 #include <linux/kernel.h>
15 #include <acpi/acpi.h>
16 #include <linux/ide.h>
17 #include <linux/pci.h>
18 #include <linux/dmi.h>
20 #include <acpi/acpi_bus.h>
21 #include <acpi/acnames.h>
22 #include <acpi/acnamesp.h>
23 #include <acpi/acparser.h>
24 #include <acpi/acexcep.h>
25 #include <acpi/acmacros.h>
26 #include <acpi/actypes.h>
28 #define REGS_PER_GTF 7
29 struct taskfile_array {
30 u8 tfa[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
41 struct ide_acpi_drive_link {
42 acpi_handle obj_handle;
46 struct ide_acpi_hwif_link {
48 acpi_handle obj_handle;
49 struct GTM_buffer gtm;
50 struct ide_acpi_drive_link master;
51 struct ide_acpi_drive_link slave;
55 /* note: adds function name and KERN_DEBUG */
57 #define DEBPRINT(fmt, args...) \
58 printk(KERN_DEBUG "%s: " fmt, __func__, ## args)
60 #define DEBPRINT(fmt, args...) do {} while (0)
61 #endif /* DEBUGGING */
64 module_param_named(noacpi, ide_noacpi, bool, 0);
65 MODULE_PARM_DESC(noacpi, "disable IDE ACPI support");
68 module_param_named(acpigtf, ide_acpigtf, bool, 0);
69 MODULE_PARM_DESC(acpigtf, "enable IDE ACPI _GTF support");
72 module_param_named(acpionboot, ide_acpionboot, bool, 0);
73 MODULE_PARM_DESC(acpionboot, "call IDE ACPI methods on boot");
75 static bool ide_noacpi_psx;
76 static int no_acpi_psx(const struct dmi_system_id *id)
78 ide_noacpi_psx = true;
79 printk(KERN_NOTICE"%s detected - disable ACPI _PSx.\n", id->ident);
83 static const struct dmi_system_id ide_acpi_dmi_table[] = {
85 /* We should check if this is because ACPI NVS isn't save/restored. */
87 .callback = no_acpi_psx,
90 DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies Ltd."),
91 DMI_MATCH(DMI_BIOS_VERSION, "KAM1.60")
95 { } /* terminate list */
98 static int ide_acpi_blacklist(void)
104 dmi_check_system(ide_acpi_dmi_table);
109 * ide_get_dev_handle - finds acpi_handle and PCI device.function
110 * @dev: device to locate
111 * @handle: returned acpi_handle for @dev
112 * @pcidevfn: return PCI device.func for @dev
114 * Returns the ACPI object handle to the corresponding PCI device.
116 * Returns 0 on success, <0 on error.
118 static int ide_get_dev_handle(struct device *dev, acpi_handle *handle,
119 acpi_integer *pcidevfn)
121 struct pci_dev *pdev = to_pci_dev(dev);
122 unsigned int bus, devnum, func;
124 acpi_handle dev_handle;
125 struct acpi_buffer buffer = {.length = ACPI_ALLOCATE_BUFFER,
128 struct acpi_device_info *dinfo = NULL;
131 bus = pdev->bus->number;
132 devnum = PCI_SLOT(pdev->devfn);
133 func = PCI_FUNC(pdev->devfn);
134 /* ACPI _ADR encoding for PCI bus: */
135 addr = (acpi_integer)(devnum << 16 | func);
137 DEBPRINT("ENTER: pci %02x:%02x.%01x\n", bus, devnum, func);
139 dev_handle = DEVICE_ACPI_HANDLE(dev);
141 DEBPRINT("no acpi handle for device\n");
145 status = acpi_get_object_info(dev_handle, &buffer);
146 if (ACPI_FAILURE(status)) {
147 DEBPRINT("get_object_info for device failed\n");
150 dinfo = buffer.pointer;
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);
183 acpi_integer pcidevfn;
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 * ide_acpi_drive_get_handle - Get ACPI object handle for a given drive
212 * @drive: device to locate
214 * Retrieves the object handle of a given drive. According to the ACPI
215 * spec the drive is a child of the hwif.
217 * Returns handle on success, 0 on error.
219 static acpi_handle ide_acpi_drive_get_handle(ide_drive_t *drive)
221 ide_hwif_t *hwif = HWIF(drive);
223 acpi_handle drive_handle;
228 if (!hwif->acpidata->obj_handle)
231 port = hwif->channel ? drive->dn - 2: drive->dn;
233 DEBPRINT("ENTER: %s at channel#: %d port#: %d\n",
234 drive->name, hwif->channel, port);
237 /* TBD: could also check ACPI object VALID bits */
238 drive_handle = acpi_get_child(hwif->acpidata->obj_handle, port);
239 DEBPRINT("drive %s handle 0x%p\n", drive->name, drive_handle);
245 * do_drive_get_GTF - get the drive bootup default taskfile settings
246 * @drive: the drive for which the taskfile settings should be retrieved
247 * @gtf_length: number of bytes of _GTF data returned at @gtf_address
248 * @gtf_address: buffer containing _GTF taskfile arrays
250 * The _GTF method has no input parameters.
251 * It returns a variable number of register set values (registers
252 * hex 1F1..1F7, taskfiles).
253 * The <variable number> is not known in advance, so have ACPI-CA
254 * allocate the buffer as needed and return it, then free it later.
256 * The returned @gtf_length and @gtf_address are only valid if the
257 * function return value is 0.
259 static int do_drive_get_GTF(ide_drive_t *drive,
260 unsigned int *gtf_length, unsigned long *gtf_address,
261 unsigned long *obj_loc)
264 struct acpi_buffer output;
265 union acpi_object *out_obj;
266 ide_hwif_t *hwif = HWIF(drive);
267 struct device *dev = hwif->gendev.parent;
279 DEBPRINT("no PCI device for %s\n", hwif->name);
283 if (!hwif->acpidata) {
284 DEBPRINT("no ACPI data for %s\n", hwif->name);
288 port = hwif->channel ? drive->dn - 2: drive->dn;
290 DEBPRINT("ENTER: %s at %s, port#: %d, hard_port#: %d\n",
291 hwif->name, dev->bus_id, port, hwif->channel);
293 if (!drive->present) {
294 DEBPRINT("%s drive %d:%d not present\n",
295 hwif->name, hwif->channel, port);
299 /* Get this drive's _ADR info. if not already known. */
300 if (!drive->acpidata->obj_handle) {
301 drive->acpidata->obj_handle = ide_acpi_drive_get_handle(drive);
302 if (!drive->acpidata->obj_handle) {
303 DEBPRINT("No ACPI object found for %s\n",
309 /* Setting up output buffer */
310 output.length = ACPI_ALLOCATE_BUFFER;
311 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
313 /* _GTF has no input parameters */
315 status = acpi_evaluate_object(drive->acpidata->obj_handle, "_GTF",
317 if (ACPI_FAILURE(status)) {
319 "%s: Run _GTF error: status = 0x%x\n",
324 if (!output.length || !output.pointer) {
325 DEBPRINT("Run _GTF: "
326 "length or ptr is NULL (0x%llx, 0x%p)\n",
327 (unsigned long long)output.length,
332 out_obj = output.pointer;
333 if (out_obj->type != ACPI_TYPE_BUFFER) {
334 DEBPRINT("Run _GTF: error: "
335 "expected object type of ACPI_TYPE_BUFFER, "
336 "got 0x%x\n", out_obj->type);
338 kfree(output.pointer);
342 if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
343 out_obj->buffer.length % REGS_PER_GTF) {
345 "%s: unexpected GTF length (%d) or addr (0x%p)\n",
346 __func__, out_obj->buffer.length,
347 out_obj->buffer.pointer);
349 kfree(output.pointer);
353 *gtf_length = out_obj->buffer.length;
354 *gtf_address = (unsigned long)out_obj->buffer.pointer;
355 *obj_loc = (unsigned long)out_obj;
356 DEBPRINT("returning gtf_length=%d, gtf_address=0x%lx, obj_loc=0x%lx\n",
357 *gtf_length, *gtf_address, *obj_loc);
364 * taskfile_load_raw - send taskfile registers to drive
365 * @drive: drive to which output is sent
366 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
368 * Outputs IDE taskfile to the drive.
370 static int taskfile_load_raw(ide_drive_t *drive,
371 const struct taskfile_array *gtf)
376 DEBPRINT("(0x1f1-1f7): hex: "
377 "%02x %02x %02x %02x %02x %02x %02x\n",
378 gtf->tfa[0], gtf->tfa[1], gtf->tfa[2],
379 gtf->tfa[3], gtf->tfa[4], gtf->tfa[5], gtf->tfa[6]);
381 memset(&args, 0, sizeof(ide_task_t));
383 /* convert gtf to IDE Taskfile */
384 memcpy(&args.tf_array[7], >f->tfa, 7);
385 args.tf_flags = IDE_TFLAG_TF | IDE_TFLAG_DEVICE;
388 DEBPRINT("_GTF execution disabled\n");
392 err = ide_no_data_taskfile(drive, &args);
394 printk(KERN_ERR "%s: ide_no_data_taskfile failed: %u\n",
401 * do_drive_set_taskfiles - write the drive taskfile settings from _GTF
402 * @drive: the drive to which the taskfile command should be sent
403 * @gtf_length: total number of bytes of _GTF taskfiles
404 * @gtf_address: location of _GTF taskfile arrays
406 * Write {gtf_address, length gtf_length} in groups of
407 * REGS_PER_GTF bytes.
409 static int do_drive_set_taskfiles(ide_drive_t *drive,
410 unsigned int gtf_length,
411 unsigned long gtf_address)
413 int rc = -ENODEV, err;
414 int gtf_count = gtf_length / REGS_PER_GTF;
416 struct taskfile_array *gtf;
421 DEBPRINT("ENTER: %s, hard_port#: %d\n", drive->name, drive->dn);
425 if (!gtf_count) /* shouldn't be here */
428 DEBPRINT("total GTF bytes=%u (0x%x), gtf_count=%d, addr=0x%lx\n",
429 gtf_length, gtf_length, gtf_count, gtf_address);
431 if (gtf_length % REGS_PER_GTF) {
432 printk(KERN_ERR "%s: unexpected GTF length (%d)\n",
433 __func__, gtf_length);
438 for (ix = 0; ix < gtf_count; ix++) {
439 gtf = (struct taskfile_array *)
440 (gtf_address + ix * REGS_PER_GTF);
442 /* send all TaskFile registers (0x1f1-0x1f7) *in*that*order* */
443 err = taskfile_load_raw(drive, gtf);
453 * ide_acpi_exec_tfs - get then write drive taskfile settings
454 * @drive: the drive for which the taskfile settings should be
457 * According to the ACPI spec this should be called after _STM
458 * has been evaluated for the interface. Some ACPI vendors interpret
459 * that as a hard requirement and modify the taskfile according
460 * to the Identify Drive information passed down with _STM.
461 * So one should really make sure to call this only after _STM has
464 int ide_acpi_exec_tfs(ide_drive_t *drive)
467 unsigned int gtf_length;
468 unsigned long gtf_address;
469 unsigned long obj_loc;
474 DEBPRINT("call get_GTF, drive=%s port=%d\n", drive->name, drive->dn);
476 ret = do_drive_get_GTF(drive, >f_length, >f_address, &obj_loc);
478 DEBPRINT("get_GTF error (%d)\n", ret);
482 DEBPRINT("call set_taskfiles, drive=%s\n", drive->name);
484 ret = do_drive_set_taskfiles(drive, gtf_length, gtf_address);
485 kfree((void *)obj_loc);
487 DEBPRINT("set_taskfiles error (%d)\n", ret);
490 DEBPRINT("ret=%d\n", ret);
496 * ide_acpi_get_timing - get the channel (controller) timings
497 * @hwif: target IDE interface (channel)
499 * This function executes the _GTM ACPI method for the target channel.
502 void ide_acpi_get_timing(ide_hwif_t *hwif)
505 struct acpi_buffer output;
506 union acpi_object *out_obj;
511 DEBPRINT("ENTER:\n");
513 if (!hwif->acpidata) {
514 DEBPRINT("no ACPI data for %s\n", hwif->name);
518 /* Setting up output buffer for _GTM */
519 output.length = ACPI_ALLOCATE_BUFFER;
520 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
522 /* _GTM has no input parameters */
523 status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_GTM",
526 DEBPRINT("_GTM status: %d, outptr: 0x%p, outlen: 0x%llx\n",
527 status, output.pointer,
528 (unsigned long long)output.length);
530 if (ACPI_FAILURE(status)) {
531 DEBPRINT("Run _GTM error: status = 0x%x\n", status);
535 if (!output.length || !output.pointer) {
536 DEBPRINT("Run _GTM: length or ptr is NULL (0x%llx, 0x%p)\n",
537 (unsigned long long)output.length,
539 kfree(output.pointer);
543 out_obj = output.pointer;
544 if (out_obj->type != ACPI_TYPE_BUFFER) {
545 kfree(output.pointer);
546 DEBPRINT("Run _GTM: error: "
547 "expected object type of ACPI_TYPE_BUFFER, "
548 "got 0x%x\n", out_obj->type);
552 if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
553 out_obj->buffer.length != sizeof(struct GTM_buffer)) {
554 kfree(output.pointer);
556 "%s: unexpected _GTM length (0x%x)[should be 0x%zx] or "
558 __func__, out_obj->buffer.length,
559 sizeof(struct GTM_buffer), out_obj->buffer.pointer);
563 memcpy(&hwif->acpidata->gtm, out_obj->buffer.pointer,
564 sizeof(struct GTM_buffer));
566 DEBPRINT("_GTM info: ptr: 0x%p, len: 0x%x, exp.len: 0x%Zx\n",
567 out_obj->buffer.pointer, out_obj->buffer.length,
568 sizeof(struct GTM_buffer));
570 DEBPRINT("_GTM fields: 0x%x, 0x%x, 0x%x, 0x%x, 0x%x\n",
571 hwif->acpidata->gtm.PIO_speed0,
572 hwif->acpidata->gtm.DMA_speed0,
573 hwif->acpidata->gtm.PIO_speed1,
574 hwif->acpidata->gtm.DMA_speed1,
575 hwif->acpidata->gtm.GTM_flags);
577 kfree(output.pointer);
581 * ide_acpi_push_timing - set the channel (controller) timings
582 * @hwif: target IDE interface (channel)
584 * This function executes the _STM ACPI method for the target channel.
586 * _STM requires Identify Drive data, which has to passed as an argument.
587 * Unfortunately hd_driveid is a mangled version which we can't readily
588 * use; hence we'll get the information afresh.
590 void ide_acpi_push_timing(ide_hwif_t *hwif)
593 struct acpi_object_list input;
594 union acpi_object in_params[3];
595 struct ide_acpi_drive_link *master = &hwif->acpidata->master;
596 struct ide_acpi_drive_link *slave = &hwif->acpidata->slave;
601 DEBPRINT("ENTER:\n");
603 if (!hwif->acpidata) {
604 DEBPRINT("no ACPI data for %s\n", hwif->name);
608 /* Give the GTM buffer + drive Identify data to the channel via the
610 /* setup input parameters buffer for _STM */
612 input.pointer = in_params;
613 in_params[0].type = ACPI_TYPE_BUFFER;
614 in_params[0].buffer.length = sizeof(struct GTM_buffer);
615 in_params[0].buffer.pointer = (u8 *)&hwif->acpidata->gtm;
616 in_params[1].type = ACPI_TYPE_BUFFER;
617 in_params[1].buffer.length = sizeof(struct hd_driveid);
618 in_params[1].buffer.pointer = (u8 *)&master->idbuff;
619 in_params[2].type = ACPI_TYPE_BUFFER;
620 in_params[2].buffer.length = sizeof(struct hd_driveid);
621 in_params[2].buffer.pointer = (u8 *)&slave->idbuff;
622 /* Output buffer: _STM has no output */
624 status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_STM",
627 if (ACPI_FAILURE(status)) {
628 DEBPRINT("Run _STM error: status = 0x%x\n", status);
630 DEBPRINT("_STM status: %d\n", status);
634 * ide_acpi_set_state - set the channel power state
635 * @hwif: target IDE interface
638 * This function executes the _PS0/_PS3 ACPI method to set the power state.
639 * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
641 void ide_acpi_set_state(ide_hwif_t *hwif, int on)
645 if (ide_noacpi || ide_noacpi_psx)
648 DEBPRINT("ENTER:\n");
650 if (!hwif->acpidata) {
651 DEBPRINT("no ACPI data for %s\n", hwif->name);
654 /* channel first and then drives for power on and verse versa for power off */
656 acpi_bus_set_power(hwif->acpidata->obj_handle, ACPI_STATE_D0);
657 for (unit = 0; unit < MAX_DRIVES; ++unit) {
658 ide_drive_t *drive = &hwif->drives[unit];
660 if (!drive->acpidata->obj_handle)
661 drive->acpidata->obj_handle = ide_acpi_drive_get_handle(drive);
663 if (drive->acpidata->obj_handle && drive->present) {
664 acpi_bus_set_power(drive->acpidata->obj_handle,
665 on? ACPI_STATE_D0: ACPI_STATE_D3);
669 acpi_bus_set_power(hwif->acpidata->obj_handle, ACPI_STATE_D3);
673 * ide_acpi_init - initialize the ACPI link for an IDE interface
674 * @hwif: target IDE interface (channel)
676 * The ACPI spec is not quite clear when the drive identify buffer
677 * should be obtained. Calling IDENTIFY DEVICE during shutdown
678 * is not the best of ideas as the drive might already being put to
679 * sleep. And obviously we can't call it during resume.
680 * So we get the information during startup; but this means that
681 * any changes during run-time will be lost after resume.
683 void ide_acpi_init(ide_hwif_t *hwif)
685 ide_acpi_blacklist();
687 hwif->acpidata = kzalloc(sizeof(struct ide_acpi_hwif_link), GFP_KERNEL);
691 hwif->acpidata->obj_handle = ide_acpi_hwif_get_handle(hwif);
692 if (!hwif->acpidata->obj_handle) {
693 DEBPRINT("no ACPI object for %s found\n", hwif->name);
694 kfree(hwif->acpidata);
695 hwif->acpidata = NULL;
699 void ide_acpi_port_init_devices(ide_hwif_t *hwif)
704 if (hwif->acpidata == NULL)
708 * The ACPI spec mandates that we send information
709 * for both drives, regardless whether they are connected
712 hwif->drives[0].acpidata = &hwif->acpidata->master;
713 hwif->drives[1].acpidata = &hwif->acpidata->slave;
716 * Send IDENTIFY for each drive
718 for (i = 0; i < MAX_DRIVES; i++) {
719 drive = &hwif->drives[i];
721 memset(drive->acpidata, 0, sizeof(*drive->acpidata));
726 err = taskfile_lib_get_identify(drive, drive->acpidata->idbuff);
728 DEBPRINT("identify device %s failed (%d)\n",
732 if (!ide_acpionboot) {
733 DEBPRINT("ACPI methods disabled on boot\n");
737 /* ACPI _PS0 before _STM */
738 ide_acpi_set_state(hwif, 1);
740 * ACPI requires us to call _STM on startup
742 ide_acpi_get_timing(hwif);
743 ide_acpi_push_timing(hwif);
745 for (i = 0; i < MAX_DRIVES; i++) {
746 drive = &hwif->drives[i];
749 /* Execute ACPI startup code */
750 ide_acpi_exec_tfs(drive);