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 <linux/slab.h>
16 #include <acpi/acpi.h>
17 #include <linux/ide.h>
18 #include <linux/pci.h>
19 #include <linux/dmi.h>
21 #include <acpi/acpi_bus.h>
23 #define REGS_PER_GTF 7
33 struct ide_acpi_drive_link {
34 acpi_handle obj_handle;
38 struct ide_acpi_hwif_link {
40 acpi_handle obj_handle;
41 struct GTM_buffer gtm;
42 struct ide_acpi_drive_link master;
43 struct ide_acpi_drive_link slave;
47 /* note: adds function name and KERN_DEBUG */
49 #define DEBPRINT(fmt, args...) \
50 printk(KERN_DEBUG "%s: " fmt, __func__, ## args)
52 #define DEBPRINT(fmt, args...) do {} while (0)
53 #endif /* DEBUGGING */
55 static int ide_noacpi;
56 module_param_named(noacpi, ide_noacpi, bool, 0);
57 MODULE_PARM_DESC(noacpi, "disable IDE ACPI support");
59 static int ide_acpigtf;
60 module_param_named(acpigtf, ide_acpigtf, bool, 0);
61 MODULE_PARM_DESC(acpigtf, "enable IDE ACPI _GTF support");
63 static int ide_acpionboot;
64 module_param_named(acpionboot, ide_acpionboot, bool, 0);
65 MODULE_PARM_DESC(acpionboot, "call IDE ACPI methods on boot");
67 static bool ide_noacpi_psx;
68 static int no_acpi_psx(const struct dmi_system_id *id)
70 ide_noacpi_psx = true;
71 printk(KERN_NOTICE"%s detected - disable ACPI _PSx.\n", id->ident);
75 static const struct dmi_system_id ide_acpi_dmi_table[] = {
77 /* We should check if this is because ACPI NVS isn't save/restored. */
79 .callback = no_acpi_psx,
82 DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies Ltd."),
83 DMI_MATCH(DMI_BIOS_VERSION, "KAM1.60")
87 { } /* terminate list */
90 int ide_acpi_init(void)
92 dmi_check_system(ide_acpi_dmi_table);
96 bool ide_port_acpi(ide_hwif_t *hwif)
98 return ide_noacpi == 0 && hwif->acpidata;
102 * ide_get_dev_handle - finds acpi_handle and PCI device.function
103 * @dev: device to locate
104 * @handle: returned acpi_handle for @dev
105 * @pcidevfn: return PCI device.func for @dev
107 * Returns the ACPI object handle to the corresponding PCI device.
109 * Returns 0 on success, <0 on error.
111 static int ide_get_dev_handle(struct device *dev, acpi_handle *handle,
114 struct pci_dev *pdev = to_pci_dev(dev);
115 unsigned int bus, devnum, func;
117 acpi_handle dev_handle;
119 struct acpi_device_info *dinfo = NULL;
122 bus = pdev->bus->number;
123 devnum = PCI_SLOT(pdev->devfn);
124 func = PCI_FUNC(pdev->devfn);
125 /* ACPI _ADR encoding for PCI bus: */
126 addr = (u64)(devnum << 16 | func);
128 DEBPRINT("ENTER: pci %02x:%02x.%01x\n", bus, devnum, func);
130 dev_handle = DEVICE_ACPI_HANDLE(dev);
132 DEBPRINT("no acpi handle for device\n");
136 status = acpi_get_object_info(dev_handle, &dinfo);
137 if (ACPI_FAILURE(status)) {
138 DEBPRINT("get_object_info for device failed\n");
141 if (dinfo && (dinfo->valid & ACPI_VALID_ADR) &&
142 dinfo->address == addr) {
144 *handle = dev_handle;
146 DEBPRINT("get_object_info for device has wrong "
147 " address: %llu, should be %u\n",
148 dinfo ? (unsigned long long)dinfo->address : -1ULL,
153 DEBPRINT("for dev=0x%x.%x, addr=0x%llx, *handle=0x%p\n",
154 devnum, func, (unsigned long long)addr, *handle);
162 * ide_acpi_hwif_get_handle - Get ACPI object handle for a given hwif
163 * @hwif: device to locate
165 * Retrieves the object handle for a given hwif.
167 * Returns handle on success, 0 on error.
169 static acpi_handle ide_acpi_hwif_get_handle(ide_hwif_t *hwif)
171 struct device *dev = hwif->gendev.parent;
172 acpi_handle uninitialized_var(dev_handle);
174 acpi_handle chan_handle;
177 DEBPRINT("ENTER: device %s\n", hwif->name);
180 DEBPRINT("no PCI device for %s\n", hwif->name);
184 err = ide_get_dev_handle(dev, &dev_handle, &pcidevfn);
186 DEBPRINT("ide_get_dev_handle failed (%d)\n", err);
190 /* get child objects of dev_handle == channel objects,
191 * + _their_ children == drive objects */
192 /* channel is hwif->channel */
193 chan_handle = acpi_get_child(dev_handle, hwif->channel);
194 DEBPRINT("chan adr=%d: handle=0x%p\n",
195 hwif->channel, chan_handle);
201 * do_drive_get_GTF - get the drive bootup default taskfile settings
202 * @drive: the drive for which the taskfile settings should be retrieved
203 * @gtf_length: number of bytes of _GTF data returned at @gtf_address
204 * @gtf_address: buffer containing _GTF taskfile arrays
206 * The _GTF method has no input parameters.
207 * It returns a variable number of register set values (registers
208 * hex 1F1..1F7, taskfiles).
209 * The <variable number> is not known in advance, so have ACPI-CA
210 * allocate the buffer as needed and return it, then free it later.
212 * The returned @gtf_length and @gtf_address are only valid if the
213 * function return value is 0.
215 static int do_drive_get_GTF(ide_drive_t *drive,
216 unsigned int *gtf_length, unsigned long *gtf_address,
217 unsigned long *obj_loc)
220 struct acpi_buffer output;
221 union acpi_object *out_obj;
228 if (!drive->acpidata->obj_handle) {
229 DEBPRINT("No ACPI object found for %s\n", drive->name);
233 /* Setting up output buffer */
234 output.length = ACPI_ALLOCATE_BUFFER;
235 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
237 /* _GTF has no input parameters */
239 status = acpi_evaluate_object(drive->acpidata->obj_handle, "_GTF",
241 if (ACPI_FAILURE(status)) {
243 "%s: Run _GTF error: status = 0x%x\n",
248 if (!output.length || !output.pointer) {
249 DEBPRINT("Run _GTF: "
250 "length or ptr is NULL (0x%llx, 0x%p)\n",
251 (unsigned long long)output.length,
256 out_obj = output.pointer;
257 if (out_obj->type != ACPI_TYPE_BUFFER) {
258 DEBPRINT("Run _GTF: error: "
259 "expected object type of ACPI_TYPE_BUFFER, "
260 "got 0x%x\n", out_obj->type);
262 kfree(output.pointer);
266 if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
267 out_obj->buffer.length % REGS_PER_GTF) {
269 "%s: unexpected GTF length (%d) or addr (0x%p)\n",
270 __func__, out_obj->buffer.length,
271 out_obj->buffer.pointer);
273 kfree(output.pointer);
277 *gtf_length = out_obj->buffer.length;
278 *gtf_address = (unsigned long)out_obj->buffer.pointer;
279 *obj_loc = (unsigned long)out_obj;
280 DEBPRINT("returning gtf_length=%d, gtf_address=0x%lx, obj_loc=0x%lx\n",
281 *gtf_length, *gtf_address, *obj_loc);
288 * do_drive_set_taskfiles - write the drive taskfile settings from _GTF
289 * @drive: the drive to which the taskfile command should be sent
290 * @gtf_length: total number of bytes of _GTF taskfiles
291 * @gtf_address: location of _GTF taskfile arrays
293 * Write {gtf_address, length gtf_length} in groups of
294 * REGS_PER_GTF bytes.
296 static int do_drive_set_taskfiles(ide_drive_t *drive,
297 unsigned int gtf_length,
298 unsigned long gtf_address)
301 int gtf_count = gtf_length / REGS_PER_GTF;
304 DEBPRINT("total GTF bytes=%u (0x%x), gtf_count=%d, addr=0x%lx\n",
305 gtf_length, gtf_length, gtf_count, gtf_address);
307 /* send all taskfile registers (0x1f1-0x1f7) *in*that*order* */
308 for (ix = 0; ix < gtf_count; ix++) {
309 u8 *gtf = (u8 *)(gtf_address + ix * REGS_PER_GTF);
312 DEBPRINT("(0x1f1-1f7): "
313 "hex: %02x %02x %02x %02x %02x %02x %02x\n",
314 gtf[0], gtf[1], gtf[2],
315 gtf[3], gtf[4], gtf[5], gtf[6]);
318 DEBPRINT("_GTF execution disabled\n");
322 /* convert GTF to taskfile */
323 memset(&cmd, 0, sizeof(cmd));
324 memcpy(&cmd.tf.feature, gtf, REGS_PER_GTF);
325 cmd.valid.out.tf = IDE_VALID_OUT_TF | IDE_VALID_DEVICE;
326 cmd.valid.in.tf = IDE_VALID_IN_TF | IDE_VALID_DEVICE;
328 err = ide_no_data_taskfile(drive, &cmd);
330 printk(KERN_ERR "%s: ide_no_data_taskfile failed: %u\n",
340 * ide_acpi_exec_tfs - get then write drive taskfile settings
341 * @drive: the drive for which the taskfile settings should be
344 * According to the ACPI spec this should be called after _STM
345 * has been evaluated for the interface. Some ACPI vendors interpret
346 * that as a hard requirement and modify the taskfile according
347 * to the Identify Drive information passed down with _STM.
348 * So one should really make sure to call this only after _STM has
351 int ide_acpi_exec_tfs(ide_drive_t *drive)
354 unsigned int gtf_length;
355 unsigned long gtf_address;
356 unsigned long obj_loc;
358 DEBPRINT("call get_GTF, drive=%s port=%d\n", drive->name, drive->dn);
360 ret = do_drive_get_GTF(drive, >f_length, >f_address, &obj_loc);
362 DEBPRINT("get_GTF error (%d)\n", ret);
366 DEBPRINT("call set_taskfiles, drive=%s\n", drive->name);
368 ret = do_drive_set_taskfiles(drive, gtf_length, gtf_address);
369 kfree((void *)obj_loc);
371 DEBPRINT("set_taskfiles error (%d)\n", ret);
374 DEBPRINT("ret=%d\n", ret);
380 * ide_acpi_get_timing - get the channel (controller) timings
381 * @hwif: target IDE interface (channel)
383 * This function executes the _GTM ACPI method for the target channel.
386 void ide_acpi_get_timing(ide_hwif_t *hwif)
389 struct acpi_buffer output;
390 union acpi_object *out_obj;
392 /* Setting up output buffer for _GTM */
393 output.length = ACPI_ALLOCATE_BUFFER;
394 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
396 /* _GTM has no input parameters */
397 status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_GTM",
400 DEBPRINT("_GTM status: %d, outptr: 0x%p, outlen: 0x%llx\n",
401 status, output.pointer,
402 (unsigned long long)output.length);
404 if (ACPI_FAILURE(status)) {
405 DEBPRINT("Run _GTM error: status = 0x%x\n", status);
409 if (!output.length || !output.pointer) {
410 DEBPRINT("Run _GTM: length or ptr is NULL (0x%llx, 0x%p)\n",
411 (unsigned long long)output.length,
413 kfree(output.pointer);
417 out_obj = output.pointer;
418 if (out_obj->type != ACPI_TYPE_BUFFER) {
419 DEBPRINT("Run _GTM: error: "
420 "expected object type of ACPI_TYPE_BUFFER, "
421 "got 0x%x\n", out_obj->type);
422 kfree(output.pointer);
426 if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
427 out_obj->buffer.length != sizeof(struct GTM_buffer)) {
429 "%s: unexpected _GTM length (0x%x)[should be 0x%zx] or "
431 __func__, out_obj->buffer.length,
432 sizeof(struct GTM_buffer), out_obj->buffer.pointer);
433 kfree(output.pointer);
437 memcpy(&hwif->acpidata->gtm, out_obj->buffer.pointer,
438 sizeof(struct GTM_buffer));
440 DEBPRINT("_GTM info: ptr: 0x%p, len: 0x%x, exp.len: 0x%Zx\n",
441 out_obj->buffer.pointer, out_obj->buffer.length,
442 sizeof(struct GTM_buffer));
444 DEBPRINT("_GTM fields: 0x%x, 0x%x, 0x%x, 0x%x, 0x%x\n",
445 hwif->acpidata->gtm.PIO_speed0,
446 hwif->acpidata->gtm.DMA_speed0,
447 hwif->acpidata->gtm.PIO_speed1,
448 hwif->acpidata->gtm.DMA_speed1,
449 hwif->acpidata->gtm.GTM_flags);
451 kfree(output.pointer);
455 * ide_acpi_push_timing - set the channel (controller) timings
456 * @hwif: target IDE interface (channel)
458 * This function executes the _STM ACPI method for the target channel.
460 * _STM requires Identify Drive data, which has to passed as an argument.
461 * Unfortunately drive->id is a mangled version which we can't readily
462 * use; hence we'll get the information afresh.
464 void ide_acpi_push_timing(ide_hwif_t *hwif)
467 struct acpi_object_list input;
468 union acpi_object in_params[3];
469 struct ide_acpi_drive_link *master = &hwif->acpidata->master;
470 struct ide_acpi_drive_link *slave = &hwif->acpidata->slave;
472 /* Give the GTM buffer + drive Identify data to the channel via the
474 /* setup input parameters buffer for _STM */
476 input.pointer = in_params;
477 in_params[0].type = ACPI_TYPE_BUFFER;
478 in_params[0].buffer.length = sizeof(struct GTM_buffer);
479 in_params[0].buffer.pointer = (u8 *)&hwif->acpidata->gtm;
480 in_params[1].type = ACPI_TYPE_BUFFER;
481 in_params[1].buffer.length = ATA_ID_WORDS * 2;
482 in_params[1].buffer.pointer = (u8 *)&master->idbuff;
483 in_params[2].type = ACPI_TYPE_BUFFER;
484 in_params[2].buffer.length = ATA_ID_WORDS * 2;
485 in_params[2].buffer.pointer = (u8 *)&slave->idbuff;
486 /* Output buffer: _STM has no output */
488 status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_STM",
491 if (ACPI_FAILURE(status)) {
492 DEBPRINT("Run _STM error: status = 0x%x\n", status);
494 DEBPRINT("_STM status: %d\n", status);
498 * ide_acpi_set_state - set the channel power state
499 * @hwif: target IDE interface
502 * This function executes the _PS0/_PS3 ACPI method to set the power state.
503 * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
505 void ide_acpi_set_state(ide_hwif_t *hwif, int on)
513 DEBPRINT("ENTER:\n");
515 /* channel first and then drives for power on and verse versa for power off */
517 acpi_bus_set_power(hwif->acpidata->obj_handle, ACPI_STATE_D0);
519 ide_port_for_each_present_dev(i, drive, hwif) {
520 if (drive->acpidata->obj_handle)
521 acpi_bus_set_power(drive->acpidata->obj_handle,
522 on ? ACPI_STATE_D0 : ACPI_STATE_D3);
526 acpi_bus_set_power(hwif->acpidata->obj_handle, ACPI_STATE_D3);
530 * ide_acpi_init_port - initialize the ACPI link for an IDE interface
531 * @hwif: target IDE interface (channel)
533 * The ACPI spec is not quite clear when the drive identify buffer
534 * should be obtained. Calling IDENTIFY DEVICE during shutdown
535 * is not the best of ideas as the drive might already being put to
536 * sleep. And obviously we can't call it during resume.
537 * So we get the information during startup; but this means that
538 * any changes during run-time will be lost after resume.
540 void ide_acpi_init_port(ide_hwif_t *hwif)
542 hwif->acpidata = kzalloc(sizeof(struct ide_acpi_hwif_link), GFP_KERNEL);
546 hwif->acpidata->obj_handle = ide_acpi_hwif_get_handle(hwif);
547 if (!hwif->acpidata->obj_handle) {
548 DEBPRINT("no ACPI object for %s found\n", hwif->name);
549 kfree(hwif->acpidata);
550 hwif->acpidata = NULL;
554 void ide_acpi_port_init_devices(ide_hwif_t *hwif)
559 if (hwif->acpidata == NULL)
563 * The ACPI spec mandates that we send information
564 * for both drives, regardless whether they are connected
567 hwif->devices[0]->acpidata = &hwif->acpidata->master;
568 hwif->devices[1]->acpidata = &hwif->acpidata->slave;
570 /* get _ADR info for each device */
571 ide_port_for_each_present_dev(i, drive, hwif) {
572 acpi_handle dev_handle;
574 DEBPRINT("ENTER: %s at channel#: %d port#: %d\n",
575 drive->name, hwif->channel, drive->dn & 1);
577 /* TBD: could also check ACPI object VALID bits */
578 dev_handle = acpi_get_child(hwif->acpidata->obj_handle,
581 DEBPRINT("drive %s handle 0x%p\n", drive->name, dev_handle);
583 drive->acpidata->obj_handle = dev_handle;
586 /* send IDENTIFY for each device */
587 ide_port_for_each_present_dev(i, drive, hwif) {
588 err = taskfile_lib_get_identify(drive, drive->acpidata->idbuff);
590 DEBPRINT("identify device %s failed (%d)\n",
594 if (ide_noacpi || ide_acpionboot == 0) {
595 DEBPRINT("ACPI methods disabled on boot\n");
599 /* ACPI _PS0 before _STM */
600 ide_acpi_set_state(hwif, 1);
602 * ACPI requires us to call _STM on startup
604 ide_acpi_get_timing(hwif);
605 ide_acpi_push_timing(hwif);
607 ide_port_for_each_present_dev(i, drive, hwif) {
608 ide_acpi_exec_tfs(drive);