Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / ide / ide-acpi.c
1 /*
2  * Provides ACPI support for IDE drives.
3  *
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
8  */
9
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>
21
22 #define REGS_PER_GTF            7
23
24 struct GTM_buffer {
25         u32     PIO_speed0;
26         u32     DMA_speed0;
27         u32     PIO_speed1;
28         u32     DMA_speed1;
29         u32     GTM_flags;
30 };
31
32 struct ide_acpi_drive_link {
33         acpi_handle      obj_handle;
34         u8               idbuff[512];
35 };
36
37 struct ide_acpi_hwif_link {
38         ide_hwif_t                      *hwif;
39         acpi_handle                      obj_handle;
40         struct GTM_buffer                gtm;
41         struct ide_acpi_drive_link       master;
42         struct ide_acpi_drive_link       slave;
43 };
44
45 #undef DEBUGGING
46 /* note: adds function name and KERN_DEBUG */
47 #ifdef DEBUGGING
48 #define DEBPRINT(fmt, args...)  \
49                 printk(KERN_DEBUG "%s: " fmt, __func__, ## args)
50 #else
51 #define DEBPRINT(fmt, args...)  do {} while (0)
52 #endif  /* DEBUGGING */
53
54 static bool ide_noacpi;
55 module_param_named(noacpi, ide_noacpi, bool, 0);
56 MODULE_PARM_DESC(noacpi, "disable IDE ACPI support");
57
58 static bool ide_acpigtf;
59 module_param_named(acpigtf, ide_acpigtf, bool, 0);
60 MODULE_PARM_DESC(acpigtf, "enable IDE ACPI _GTF support");
61
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");
65
66 static bool ide_noacpi_psx;
67 static int no_acpi_psx(const struct dmi_system_id *id)
68 {
69         ide_noacpi_psx = true;
70         printk(KERN_NOTICE"%s detected - disable ACPI _PSx.\n", id->ident);
71         return 0;
72 }
73
74 static const struct dmi_system_id ide_acpi_dmi_table[] = {
75         /* Bug 9673. */
76         /* We should check if this is because ACPI NVS isn't save/restored. */
77         {
78                 .callback = no_acpi_psx,
79                 .ident    = "HP nx9005",
80                 .matches  = {
81                         DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies Ltd."),
82                         DMI_MATCH(DMI_BIOS_VERSION, "KAM1.60")
83                 },
84         },
85
86         { }     /* terminate list */
87 };
88
89 int ide_acpi_init(void)
90 {
91         dmi_check_system(ide_acpi_dmi_table);
92         return 0;
93 }
94
95 bool ide_port_acpi(ide_hwif_t *hwif)
96 {
97         return ide_noacpi == 0 && hwif->acpidata;
98 }
99
100 static acpi_handle acpi_get_child(acpi_handle handle, u64 addr)
101 {
102         struct acpi_device *adev;
103
104         if (!handle || acpi_bus_get_device(handle, &adev))
105                 return NULL;
106
107         adev = acpi_find_child_device(adev, addr, false);
108         return adev ? adev->handle : NULL;
109 }
110
111 /**
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
116  *
117  * Returns the ACPI object handle to the corresponding PCI device.
118  *
119  * Returns 0 on success, <0 on error.
120  */
121 static int ide_get_dev_handle(struct device *dev, acpi_handle *handle,
122                                u64 *pcidevfn)
123 {
124         struct pci_dev *pdev = to_pci_dev(dev);
125         unsigned int bus, devnum, func;
126         u64 addr;
127         acpi_handle dev_handle;
128         acpi_status status;
129         struct acpi_device_info *dinfo = NULL;
130         int ret = -ENODEV;
131
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);
137
138         DEBPRINT("ENTER: pci %02x:%02x.%01x\n", bus, devnum, func);
139
140         dev_handle = ACPI_HANDLE(dev);
141         if (!dev_handle) {
142                 DEBPRINT("no acpi handle for device\n");
143                 goto err;
144         }
145
146         status = acpi_get_object_info(dev_handle, &dinfo);
147         if (ACPI_FAILURE(status)) {
148                 DEBPRINT("get_object_info for device failed\n");
149                 goto err;
150         }
151         if (dinfo && (dinfo->valid & ACPI_VALID_ADR) &&
152             dinfo->address == addr) {
153                 *pcidevfn = addr;
154                 *handle = dev_handle;
155         } else {
156                 DEBPRINT("get_object_info for device has wrong "
157                         " address: %llu, should be %u\n",
158                         dinfo ? (unsigned long long)dinfo->address : -1ULL,
159                         (unsigned int)addr);
160                 goto err;
161         }
162
163         DEBPRINT("for dev=0x%x.%x, addr=0x%llx, *handle=0x%p\n",
164                  devnum, func, (unsigned long long)addr, *handle);
165         ret = 0;
166 err:
167         kfree(dinfo);
168         return ret;
169 }
170
171 /**
172  * ide_acpi_hwif_get_handle - Get ACPI object handle for a given hwif
173  * @hwif: device to locate
174  *
175  * Retrieves the object handle for a given hwif.
176  *
177  * Returns handle on success, 0 on error.
178  */
179 static acpi_handle ide_acpi_hwif_get_handle(ide_hwif_t *hwif)
180 {
181         struct device           *dev = hwif->gendev.parent;
182         acpi_handle             uninitialized_var(dev_handle);
183         u64                     pcidevfn;
184         acpi_handle             chan_handle;
185         int                     err;
186
187         DEBPRINT("ENTER: device %s\n", hwif->name);
188
189         if (!dev) {
190                 DEBPRINT("no PCI device for %s\n", hwif->name);
191                 return NULL;
192         }
193
194         err = ide_get_dev_handle(dev, &dev_handle, &pcidevfn);
195         if (err < 0) {
196                 DEBPRINT("ide_get_dev_handle failed (%d)\n", err);
197                 return NULL;
198         }
199
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);
206
207         return chan_handle;
208 }
209
210 /**
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
215  *
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.
221  *
222  * The returned @gtf_length and @gtf_address are only valid if the
223  * function return value is 0.
224  */
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)
228 {
229         acpi_status                     status;
230         struct acpi_buffer              output;
231         union acpi_object               *out_obj;
232         int                             err = -ENODEV;
233
234         *gtf_length = 0;
235         *gtf_address = 0UL;
236         *obj_loc = 0UL;
237
238         if (!drive->acpidata->obj_handle) {
239                 DEBPRINT("No ACPI object found for %s\n", drive->name);
240                 goto out;
241         }
242
243         /* Setting up output buffer */
244         output.length = ACPI_ALLOCATE_BUFFER;
245         output.pointer = NULL;  /* ACPI-CA sets this; save/free it later */
246
247         /* _GTF has no input parameters */
248         err = -EIO;
249         status = acpi_evaluate_object(drive->acpidata->obj_handle, "_GTF",
250                                       NULL, &output);
251         if (ACPI_FAILURE(status)) {
252                 printk(KERN_DEBUG
253                        "%s: Run _GTF error: status = 0x%x\n",
254                        __func__, status);
255                 goto out;
256         }
257
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,
262                        output.pointer);
263                 goto out;
264         }
265
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);
271                 err = -ENOENT;
272                 kfree(output.pointer);
273                 goto out;
274         }
275
276         if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
277             out_obj->buffer.length % REGS_PER_GTF) {
278                 printk(KERN_ERR
279                        "%s: unexpected GTF length (%d) or addr (0x%p)\n",
280                        __func__, out_obj->buffer.length,
281                        out_obj->buffer.pointer);
282                 err = -ENOENT;
283                 kfree(output.pointer);
284                 goto out;
285         }
286
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);
292         err = 0;
293 out:
294         return err;
295 }
296
297 /**
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
302  *
303  * Write {gtf_address, length gtf_length} in groups of
304  * REGS_PER_GTF bytes.
305  */
306 static int do_drive_set_taskfiles(ide_drive_t *drive,
307                                   unsigned int gtf_length,
308                                   unsigned long gtf_address)
309 {
310         int                     rc = 0, err;
311         int                     gtf_count = gtf_length / REGS_PER_GTF;
312         int                     ix;
313
314         DEBPRINT("total GTF bytes=%u (0x%x), gtf_count=%d, addr=0x%lx\n",
315                  gtf_length, gtf_length, gtf_count, gtf_address);
316
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);
320                 struct ide_cmd cmd;
321
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]);
326
327                 if (!ide_acpigtf) {
328                         DEBPRINT("_GTF execution disabled\n");
329                         continue;
330                 }
331
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;
337
338                 err = ide_no_data_taskfile(drive, &cmd);
339                 if (err) {
340                         printk(KERN_ERR "%s: ide_no_data_taskfile failed: %u\n",
341                                         __func__, err);
342                         rc = err;
343                 }
344         }
345
346         return rc;
347 }
348
349 /**
350  * ide_acpi_exec_tfs - get then write drive taskfile settings
351  * @drive: the drive for which the taskfile settings should be
352  *         written.
353  *
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
359  * been executed.
360  */
361 int ide_acpi_exec_tfs(ide_drive_t *drive)
362 {
363         int             ret;
364         unsigned int    gtf_length;
365         unsigned long   gtf_address;
366         unsigned long   obj_loc;
367
368         DEBPRINT("call get_GTF, drive=%s port=%d\n", drive->name, drive->dn);
369
370         ret = do_drive_get_GTF(drive, &gtf_length, &gtf_address, &obj_loc);
371         if (ret < 0) {
372                 DEBPRINT("get_GTF error (%d)\n", ret);
373                 return ret;
374         }
375
376         DEBPRINT("call set_taskfiles, drive=%s\n", drive->name);
377
378         ret = do_drive_set_taskfiles(drive, gtf_length, gtf_address);
379         kfree((void *)obj_loc);
380         if (ret < 0) {
381                 DEBPRINT("set_taskfiles error (%d)\n", ret);
382         }
383
384         DEBPRINT("ret=%d\n", ret);
385
386         return ret;
387 }
388
389 /**
390  * ide_acpi_get_timing - get the channel (controller) timings
391  * @hwif: target IDE interface (channel)
392  *
393  * This function executes the _GTM ACPI method for the target channel.
394  *
395  */
396 void ide_acpi_get_timing(ide_hwif_t *hwif)
397 {
398         acpi_status             status;
399         struct acpi_buffer      output;
400         union acpi_object       *out_obj;
401
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 */
405
406         /* _GTM has no input parameters */
407         status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_GTM",
408                                       NULL, &output);
409
410         DEBPRINT("_GTM status: %d, outptr: 0x%p, outlen: 0x%llx\n",
411                  status, output.pointer,
412                  (unsigned long long)output.length);
413
414         if (ACPI_FAILURE(status)) {
415                 DEBPRINT("Run _GTM error: status = 0x%x\n", status);
416                 return;
417         }
418
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,
422                        output.pointer);
423                 kfree(output.pointer);
424                 return;
425         }
426
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);
433                 return;
434         }
435
436         if (!out_obj->buffer.length || !out_obj->buffer.pointer ||
437             out_obj->buffer.length != sizeof(struct GTM_buffer)) {
438                 printk(KERN_ERR
439                         "%s: unexpected _GTM length (0x%x)[should be 0x%zx] or "
440                         "addr (0x%p)\n",
441                         __func__, out_obj->buffer.length,
442                         sizeof(struct GTM_buffer), out_obj->buffer.pointer);
443                 kfree(output.pointer);
444                 return;
445         }
446
447         memcpy(&hwif->acpidata->gtm, out_obj->buffer.pointer,
448                sizeof(struct GTM_buffer));
449
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));
453
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);
460
461         kfree(output.pointer);
462 }
463
464 /**
465  * ide_acpi_push_timing - set the channel (controller) timings
466  * @hwif: target IDE interface (channel)
467  *
468  * This function executes the _STM ACPI method for the target channel.
469  *
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.
473  */
474 void ide_acpi_push_timing(ide_hwif_t *hwif)
475 {
476         acpi_status             status;
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;
481
482         /* Give the GTM buffer + drive Identify data to the channel via the
483          * _STM method: */
484         /* setup input parameters buffer for _STM */
485         input.count = 3;
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 */
497
498         status = acpi_evaluate_object(hwif->acpidata->obj_handle, "_STM",
499                                       &input, NULL);
500
501         if (ACPI_FAILURE(status)) {
502                 DEBPRINT("Run _STM error: status = 0x%x\n", status);
503         }
504         DEBPRINT("_STM status: %d\n", status);
505 }
506
507 /**
508  * ide_acpi_set_state - set the channel power state
509  * @hwif: target IDE interface
510  * @on: state, on/off
511  *
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
514  */
515 void ide_acpi_set_state(ide_hwif_t *hwif, int on)
516 {
517         ide_drive_t *drive;
518         int i;
519
520         if (ide_noacpi_psx)
521                 return;
522
523         DEBPRINT("ENTER:\n");
524
525         /* channel first and then drives for power on and verse versa for power off */
526         if (on)
527                 acpi_bus_set_power(hwif->acpidata->obj_handle, ACPI_STATE_D0);
528
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);
533         }
534
535         if (!on)
536                 acpi_bus_set_power(hwif->acpidata->obj_handle,
537                                    ACPI_STATE_D3_COLD);
538 }
539
540 /**
541  * ide_acpi_init_port - initialize the ACPI link for an IDE interface
542  * @hwif: target IDE interface (channel)
543  *
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.
550  */
551 void ide_acpi_init_port(ide_hwif_t *hwif)
552 {
553         hwif->acpidata = kzalloc(sizeof(struct ide_acpi_hwif_link), GFP_KERNEL);
554         if (!hwif->acpidata)
555                 return;
556
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;
562         }
563 }
564
565 void ide_acpi_port_init_devices(ide_hwif_t *hwif)
566 {
567         ide_drive_t *drive;
568         int i, err;
569
570         if (hwif->acpidata == NULL)
571                 return;
572
573         /*
574          * The ACPI spec mandates that we send information
575          * for both drives, regardless whether they are connected
576          * or not.
577          */
578         hwif->devices[0]->acpidata = &hwif->acpidata->master;
579         hwif->devices[1]->acpidata = &hwif->acpidata->slave;
580
581         /* get _ADR info for each device */
582         ide_port_for_each_present_dev(i, drive, hwif) {
583                 acpi_handle dev_handle;
584
585                 DEBPRINT("ENTER: %s at channel#: %d port#: %d\n",
586                          drive->name, hwif->channel, drive->dn & 1);
587
588                 /* TBD: could also check ACPI object VALID bits */
589                 dev_handle = acpi_get_child(hwif->acpidata->obj_handle,
590                                             drive->dn & 1);
591
592                 DEBPRINT("drive %s handle 0x%p\n", drive->name, dev_handle);
593
594                 drive->acpidata->obj_handle = dev_handle;
595         }
596
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);
600                 if (err)
601                         DEBPRINT("identify device %s failed (%d)\n",
602                                  drive->name, err);
603         }
604
605         if (ide_noacpi || ide_acpionboot == 0) {
606                 DEBPRINT("ACPI methods disabled on boot\n");
607                 return;
608         }
609
610         /* ACPI _PS0 before _STM */
611         ide_acpi_set_state(hwif, 1);
612         /*
613          * ACPI requires us to call _STM on startup
614          */
615         ide_acpi_get_timing(hwif);
616         ide_acpi_push_timing(hwif);
617
618         ide_port_for_each_present_dev(i, drive, hwif) {
619                 ide_acpi_exec_tfs(drive);
620         }
621 }