blob: e1b1dd215267de23dfc19d23a97a2be102f8ab1e [file] [log] [blame]
Thomas Gleixnerc82ee6d2019-05-19 15:51:48 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04003 * libata-core.c - helper library for ATA
4 *
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04005 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
6 * Copyright 2003-2004 Jeff Garzik
7 *
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04008 * libata documentation is available via 'make {ps|pdf}docs',
Mauro Carvalho Chehab19285f32017-05-14 11:52:56 -03009 * as Documentation/driver-api/libata.rst
Jeff Garzikaf36d7f2005-08-28 20:18:39 -040010 *
11 * Hardware documentation available from http://www.t13.org/ and
12 * http://www.sata-io.org/
13 *
Alan Cox92c52c52007-11-19 14:30:16 +000014 * Standards documents from:
15 * http://www.t13.org (ATA standards, PCI DMA IDE spec)
16 * http://www.t10.org (SCSI MMC - for ATAPI MMC)
17 * http://www.sata-io.org (SATA)
18 * http://www.compactflash.org (CF)
19 * http://www.qic.org (QIC157 - Tape and DSC)
20 * http://www.ce-ata.org (CE-ATA: not supported)
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +010021 *
22 * libata is essentially a library of internal helper functions for
23 * low-level ATA host controller drivers. As such, the API/ABI is
24 * likely to change as new drivers are added and updated.
25 * Do not depend on ABI/API stability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 */
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/module.h>
30#include <linux/pci.h>
31#include <linux/init.h>
32#include <linux/list.h>
33#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/spinlock.h>
35#include <linux/blkdev.h>
36#include <linux/delay.h>
37#include <linux/timer.h>
Anil Veliyankara Madam848c3922016-01-07 21:18:52 -080038#include <linux/time.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/interrupt.h>
40#include <linux/completion.h>
41#include <linux/suspend.h>
42#include <linux/workqueue.h>
David Hardeman378f0582005-09-17 17:55:31 +100043#include <linux/scatterlist.h>
Jeff Garzik2dcb4072007-10-19 06:42:56 -040044#include <linux/io.h>
Mark Lorde18086d2009-03-19 13:32:21 -040045#include <linux/log2.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090046#include <linux/slab.h>
George Spelvin428ac5f2014-08-06 16:09:27 -070047#include <linux/glob.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <scsi/scsi.h>
Jeff Garzik193515d2005-11-07 00:59:37 -050049#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <scsi/scsi_host.h>
51#include <linux/libata.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <asm/byteorder.h>
Hannes Reineckefe5af0c2016-04-25 12:45:48 +020053#include <asm/unaligned.h>
Tejun Heo140b5e592007-12-12 12:21:52 +090054#include <linux/cdrom.h>
Akinobu Mita9990b6f2010-04-12 21:11:41 +090055#include <linux/ratelimit.h>
Stephan Linzeb25cb92016-06-10 07:59:56 +020056#include <linux/leds.h>
Lin Ming9ee4f392011-12-05 09:20:28 +080057#include <linux/pm_runtime.h>
Brian Norrisb7db04d2012-11-02 12:29:32 -070058#include <linux/platform_device.h>
Bartlomiej Zolnierkiewiczbbf5a092020-03-26 16:58:01 +010059#include <asm/setup.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Hannes Reinecke255c03d2015-03-27 16:46:38 +010061#define CREATE_TRACE_POINTS
62#include <trace/events/libata.h>
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#include "libata.h"
Gwendal Grignoud9027472010-05-25 12:31:38 -070065#include "libata-transport.h"
Jeff Garzikfda0efc2007-01-31 07:43:15 -050066
Tejun Heo029cfd62008-03-25 12:22:49 +090067const struct ata_port_operations ata_base_port_ops = {
Tejun Heo0aa11132008-04-07 22:47:18 +090068 .prereset = ata_std_prereset,
Tejun Heo203c75b2008-04-07 22:47:18 +090069 .postreset = ata_std_postreset,
Tejun Heoa1efdab2008-03-25 12:22:50 +090070 .error_handler = ata_std_error_handler,
Dan Williamse4a9c372012-06-21 23:25:27 -070071 .sched_eh = ata_std_sched_eh,
72 .end_eh = ata_std_end_eh,
Tejun Heo029cfd62008-03-25 12:22:49 +090073};
74
75const struct ata_port_operations sata_port_ops = {
76 .inherits = &ata_base_port_ops,
77
78 .qc_defer = ata_std_qc_defer,
Tejun Heo57c9efd2008-04-07 22:47:19 +090079 .hardreset = sata_std_hardreset,
Tejun Heo029cfd62008-03-25 12:22:49 +090080};
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +010081EXPORT_SYMBOL_GPL(sata_port_ops);
Tejun Heo029cfd62008-03-25 12:22:49 +090082
Tejun Heo3373efd2006-05-15 20:57:53 +090083static unsigned int ata_dev_init_params(struct ata_device *dev,
84 u16 heads, u16 sectors);
85static unsigned int ata_dev_set_xfermode(struct ata_device *dev);
86static void ata_dev_xfermask(struct ata_device *dev);
Tejun Heo75683fe2007-07-05 13:31:27 +090087static unsigned long ata_dev_blacklisted(const struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Tero Roponena78f57a2012-04-22 11:38:00 +030089atomic_t ata_print_id = ATOMIC_INIT(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +010091#ifdef CONFIG_ATA_FORCE
Tejun Heo33267322008-02-13 09:15:09 +090092struct ata_force_param {
93 const char *name;
Bartlomiej Zolnierkiewicz8ba5a452020-03-26 16:58:02 +010094 u8 cbl;
95 u8 spd_limit;
Tejun Heo33267322008-02-13 09:15:09 +090096 unsigned long xfer_mask;
97 unsigned int horkage_on;
98 unsigned int horkage_off;
Bartlomiej Zolnierkiewicz8ba5a452020-03-26 16:58:02 +010099 u16 lflags;
Tejun Heo33267322008-02-13 09:15:09 +0900100};
101
102struct ata_force_ent {
103 int port;
104 int device;
105 struct ata_force_param param;
106};
107
108static struct ata_force_ent *ata_force_tbl;
109static int ata_force_tbl_size;
110
Bartlomiej Zolnierkiewiczbbf5a092020-03-26 16:58:01 +0100111static char ata_force_param_buf[COMMAND_LINE_SIZE] __initdata;
Tejun Heo7afb4222008-03-09 20:21:53 +0900112/* param_buf is thrown away after initialization, disallow read */
113module_param_string(force, ata_force_param_buf, sizeof(ata_force_param_buf), 0);
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -0200114MODULE_PARM_DESC(force, "Force ATA configurations including cable type, link speed and transfer mode (see Documentation/admin-guide/kernel-parameters.rst for details)");
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +0100115#endif
Tejun Heo33267322008-02-13 09:15:09 +0900116
Tejun Heo2486fa52008-07-31 07:52:40 +0900117static int atapi_enabled = 1;
Jeff Garzik1623c812005-08-30 03:37:42 -0400118module_param(atapi_enabled, int, 0444);
Evgeni Golovad5d8ea2009-06-22 09:46:20 +0200119MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on [default])");
Jeff Garzik1623c812005-08-30 03:37:42 -0400120
Adrian Bunkc5c61bd2008-02-25 02:07:25 +0200121static int atapi_dmadir = 0;
Albert Lee95de7192006-04-04 10:57:18 +0800122module_param(atapi_dmadir, int, 0444);
Evgeni Golovad5d8ea2009-06-22 09:46:20 +0200123MODULE_PARM_DESC(atapi_dmadir, "Enable ATAPI DMADIR bridge support (0=off [default], 1=on)");
Albert Lee95de7192006-04-04 10:57:18 +0800124
Mark Lordbaf4fdf2007-08-08 01:08:45 +0900125int atapi_passthru16 = 1;
126module_param(atapi_passthru16, int, 0444);
Evgeni Golovad5d8ea2009-06-22 09:46:20 +0200127MODULE_PARM_DESC(atapi_passthru16, "Enable ATA_16 passthru for ATAPI devices (0=off, 1=on [default])");
Mark Lordbaf4fdf2007-08-08 01:08:45 +0900128
Jeff Garzikc3c013a2006-02-27 22:31:19 -0500129int libata_fua = 0;
130module_param_named(fua, libata_fua, int, 0444);
Evgeni Golovad5d8ea2009-06-22 09:46:20 +0200131MODULE_PARM_DESC(fua, "FUA support (0=off [default], 1=on)");
Jeff Garzikc3c013a2006-02-27 22:31:19 -0500132
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400133static int ata_ignore_hpa;
Alan Cox1e999732007-04-11 00:23:13 +0100134module_param_named(ignore_hpa, ata_ignore_hpa, int, 0644);
135MODULE_PARM_DESC(ignore_hpa, "Ignore HPA limit (0=keep BIOS limits, 1=ignore limits, using full disk)");
136
Alan Coxb3a70602007-10-02 12:38:26 -0400137static int libata_dma_mask = ATA_DMA_MASK_ATA|ATA_DMA_MASK_ATAPI|ATA_DMA_MASK_CFA;
138module_param_named(dma, libata_dma_mask, int, 0444);
139MODULE_PARM_DESC(dma, "DMA enable/disable (0x1==ATA, 0x2==ATAPI, 0x4==CF)");
140
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900141static int ata_probe_timeout;
Andrew Mortona8601e52006-06-25 01:36:52 -0700142module_param(ata_probe_timeout, int, 0444);
143MODULE_PARM_DESC(ata_probe_timeout, "Set ATA probing timeout (seconds)");
144
Jeff Garzik6ebe9d82007-10-05 16:28:36 -0400145int libata_noacpi = 0;
Jeff Garzikd7d0dad2007-03-28 01:57:37 -0400146module_param_named(noacpi, libata_noacpi, int, 0444);
Evgeni Golovad5d8ea2009-06-22 09:46:20 +0200147MODULE_PARM_DESC(noacpi, "Disable the use of ACPI in probe/suspend/resume (0=off [default], 1=on)");
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700148
Alan Coxae8d4ee2007-11-04 22:05:49 -0500149int libata_allow_tpm = 0;
150module_param_named(allow_tpm, libata_allow_tpm, int, 0444);
Evgeni Golovad5d8ea2009-06-22 09:46:20 +0200151MODULE_PARM_DESC(allow_tpm, "Permit the use of TPM commands (0=off [default], 1=on)");
Alan Coxae8d4ee2007-11-04 22:05:49 -0500152
Tejun Heoe7ecd432010-05-19 15:38:58 +0200153static int atapi_an;
154module_param(atapi_an, int, 0444);
155MODULE_PARM_DESC(atapi_an, "Enable ATAPI AN media presence notification (0=0ff [default], 1=on)");
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157MODULE_AUTHOR("Jeff Garzik");
158MODULE_DESCRIPTION("Library module for ATA devices");
159MODULE_LICENSE("GPL");
160MODULE_VERSION(DRV_VERSION);
161
Damien Le Moal891fd7c2021-08-16 10:44:50 +0900162static inline bool ata_dev_print_info(struct ata_device *dev)
163{
164 struct ata_eh_context *ehc = &dev->link->eh_context;
165
166 return ehc->i.flags & ATA_EHI_PRINTINFO;
167}
Edward Falk0baab862005-06-02 18:17:13 -0400168
Tejun Heo9913ff8a2009-01-29 20:31:31 +0900169static bool ata_sstatus_online(u32 sstatus)
170{
171 return (sstatus & 0xf) == 0x3;
172}
173
Tejun Heo1eca4362008-11-03 20:03:17 +0900174/**
175 * ata_link_next - link iteration helper
176 * @link: the previous link, NULL to start
177 * @ap: ATA port containing links to iterate
178 * @mode: iteration mode, one of ATA_LITER_*
Tejun Heoaadffb62008-07-31 17:02:41 +0900179 *
Tejun Heo1eca4362008-11-03 20:03:17 +0900180 * LOCKING:
181 * Host lock or EH context.
182 *
183 * RETURNS:
184 * Pointer to the next link.
Tejun Heoaadffb62008-07-31 17:02:41 +0900185 */
Tejun Heo1eca4362008-11-03 20:03:17 +0900186struct ata_link *ata_link_next(struct ata_link *link, struct ata_port *ap,
187 enum ata_link_iter_mode mode)
Tejun Heoaadffb62008-07-31 17:02:41 +0900188{
Tejun Heo1eca4362008-11-03 20:03:17 +0900189 BUG_ON(mode != ATA_LITER_EDGE &&
190 mode != ATA_LITER_PMP_FIRST && mode != ATA_LITER_HOST_FIRST);
Tejun Heoaadffb62008-07-31 17:02:41 +0900191
Tejun Heo1eca4362008-11-03 20:03:17 +0900192 /* NULL link indicates start of iteration */
193 if (!link)
194 switch (mode) {
195 case ATA_LITER_EDGE:
196 case ATA_LITER_PMP_FIRST:
197 if (sata_pmp_attached(ap))
198 return ap->pmp_link;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500199 fallthrough;
Tejun Heo1eca4362008-11-03 20:03:17 +0900200 case ATA_LITER_HOST_FIRST:
201 return &ap->link;
202 }
203
204 /* we just iterated over the host link, what's next? */
205 if (link == &ap->link)
206 switch (mode) {
207 case ATA_LITER_HOST_FIRST:
208 if (sata_pmp_attached(ap))
209 return ap->pmp_link;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500210 fallthrough;
Tejun Heo1eca4362008-11-03 20:03:17 +0900211 case ATA_LITER_PMP_FIRST:
212 if (unlikely(ap->slave_link))
Tejun Heob1c72912008-07-31 17:02:43 +0900213 return ap->slave_link;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500214 fallthrough;
Tejun Heo1eca4362008-11-03 20:03:17 +0900215 case ATA_LITER_EDGE:
Tejun Heoaadffb62008-07-31 17:02:41 +0900216 return NULL;
Tejun Heob1c72912008-07-31 17:02:43 +0900217 }
Tejun Heoaadffb62008-07-31 17:02:41 +0900218
Tejun Heob1c72912008-07-31 17:02:43 +0900219 /* slave_link excludes PMP */
220 if (unlikely(link == ap->slave_link))
221 return NULL;
222
Tejun Heo1eca4362008-11-03 20:03:17 +0900223 /* we were over a PMP link */
Tejun Heoaadffb62008-07-31 17:02:41 +0900224 if (++link < ap->pmp_link + ap->nr_pmp_links)
225 return link;
Tejun Heo1eca4362008-11-03 20:03:17 +0900226
227 if (mode == ATA_LITER_PMP_FIRST)
228 return &ap->link;
229
Tejun Heoaadffb62008-07-31 17:02:41 +0900230 return NULL;
231}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100232EXPORT_SYMBOL_GPL(ata_link_next);
Tejun Heoaadffb62008-07-31 17:02:41 +0900233
Edward Falk0baab862005-06-02 18:17:13 -0400234/**
Tejun Heo1eca4362008-11-03 20:03:17 +0900235 * ata_dev_next - device iteration helper
236 * @dev: the previous device, NULL to start
237 * @link: ATA link containing devices to iterate
238 * @mode: iteration mode, one of ATA_DITER_*
239 *
240 * LOCKING:
241 * Host lock or EH context.
242 *
243 * RETURNS:
244 * Pointer to the next device.
245 */
246struct ata_device *ata_dev_next(struct ata_device *dev, struct ata_link *link,
247 enum ata_dev_iter_mode mode)
248{
249 BUG_ON(mode != ATA_DITER_ENABLED && mode != ATA_DITER_ENABLED_REVERSE &&
250 mode != ATA_DITER_ALL && mode != ATA_DITER_ALL_REVERSE);
251
252 /* NULL dev indicates start of iteration */
253 if (!dev)
254 switch (mode) {
255 case ATA_DITER_ENABLED:
256 case ATA_DITER_ALL:
257 dev = link->device;
258 goto check;
259 case ATA_DITER_ENABLED_REVERSE:
260 case ATA_DITER_ALL_REVERSE:
261 dev = link->device + ata_link_max_devices(link) - 1;
262 goto check;
263 }
264
265 next:
266 /* move to the next one */
267 switch (mode) {
268 case ATA_DITER_ENABLED:
269 case ATA_DITER_ALL:
270 if (++dev < link->device + ata_link_max_devices(link))
271 goto check;
272 return NULL;
273 case ATA_DITER_ENABLED_REVERSE:
274 case ATA_DITER_ALL_REVERSE:
275 if (--dev >= link->device)
276 goto check;
277 return NULL;
278 }
279
280 check:
281 if ((mode == ATA_DITER_ENABLED || mode == ATA_DITER_ENABLED_REVERSE) &&
282 !ata_dev_enabled(dev))
283 goto next;
284 return dev;
285}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100286EXPORT_SYMBOL_GPL(ata_dev_next);
Tejun Heo1eca4362008-11-03 20:03:17 +0900287
288/**
Tejun Heob1c72912008-07-31 17:02:43 +0900289 * ata_dev_phys_link - find physical link for a device
290 * @dev: ATA device to look up physical link for
291 *
292 * Look up physical link which @dev is attached to. Note that
293 * this is different from @dev->link only when @dev is on slave
294 * link. For all other cases, it's the same as @dev->link.
295 *
296 * LOCKING:
297 * Don't care.
298 *
299 * RETURNS:
300 * Pointer to the found physical link.
301 */
302struct ata_link *ata_dev_phys_link(struct ata_device *dev)
303{
304 struct ata_port *ap = dev->link->ap;
305
306 if (!ap->slave_link)
307 return dev->link;
308 if (!dev->devno)
309 return &ap->link;
310 return ap->slave_link;
311}
312
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +0100313#ifdef CONFIG_ATA_FORCE
Tejun Heob1c72912008-07-31 17:02:43 +0900314/**
Tejun Heo33267322008-02-13 09:15:09 +0900315 * ata_force_cbl - force cable type according to libata.force
Randy Dunlap4cdfa1b2008-02-22 12:21:37 -0800316 * @ap: ATA port of interest
Tejun Heo33267322008-02-13 09:15:09 +0900317 *
318 * Force cable type according to libata.force and whine about it.
319 * The last entry which has matching port number is used, so it
320 * can be specified as part of device force parameters. For
321 * example, both "a:40c,1.00:udma4" and "1.00:40c,udma4" have the
322 * same effect.
323 *
324 * LOCKING:
325 * EH context.
326 */
327void ata_force_cbl(struct ata_port *ap)
328{
329 int i;
330
331 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
332 const struct ata_force_ent *fe = &ata_force_tbl[i];
333
334 if (fe->port != -1 && fe->port != ap->print_id)
335 continue;
336
337 if (fe->param.cbl == ATA_CBL_NONE)
338 continue;
339
340 ap->cbl = fe->param.cbl;
Joe Perchesa9a79df2011-04-15 15:51:59 -0700341 ata_port_notice(ap, "FORCE: cable set to %s\n", fe->param.name);
Tejun Heo33267322008-02-13 09:15:09 +0900342 return;
343 }
344}
345
346/**
Tejun Heo05944bd2008-08-13 20:19:09 +0900347 * ata_force_link_limits - force link limits according to libata.force
Tejun Heo33267322008-02-13 09:15:09 +0900348 * @link: ATA link of interest
349 *
Tejun Heo05944bd2008-08-13 20:19:09 +0900350 * Force link flags and SATA spd limit according to libata.force
351 * and whine about it. When only the port part is specified
352 * (e.g. 1:), the limit applies to all links connected to both
353 * the host link and all fan-out ports connected via PMP. If the
354 * device part is specified as 0 (e.g. 1.00:), it specifies the
355 * first fan-out link not the host link. Device number 15 always
Tejun Heob1c72912008-07-31 17:02:43 +0900356 * points to the host link whether PMP is attached or not. If the
357 * controller has slave link, device number 16 points to it.
Tejun Heo33267322008-02-13 09:15:09 +0900358 *
359 * LOCKING:
360 * EH context.
361 */
Tejun Heo05944bd2008-08-13 20:19:09 +0900362static void ata_force_link_limits(struct ata_link *link)
Tejun Heo33267322008-02-13 09:15:09 +0900363{
Tejun Heo05944bd2008-08-13 20:19:09 +0900364 bool did_spd = false;
Tejun Heob1c72912008-07-31 17:02:43 +0900365 int linkno = link->pmp;
366 int i;
Tejun Heo33267322008-02-13 09:15:09 +0900367
368 if (ata_is_host_link(link))
Tejun Heob1c72912008-07-31 17:02:43 +0900369 linkno += 15;
Tejun Heo33267322008-02-13 09:15:09 +0900370
371 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
372 const struct ata_force_ent *fe = &ata_force_tbl[i];
373
374 if (fe->port != -1 && fe->port != link->ap->print_id)
375 continue;
376
377 if (fe->device != -1 && fe->device != linkno)
378 continue;
379
Tejun Heo05944bd2008-08-13 20:19:09 +0900380 /* only honor the first spd limit */
381 if (!did_spd && fe->param.spd_limit) {
382 link->hw_sata_spd_limit = (1 << fe->param.spd_limit) - 1;
Joe Perchesa9a79df2011-04-15 15:51:59 -0700383 ata_link_notice(link, "FORCE: PHY spd limit set to %s\n",
Tejun Heo05944bd2008-08-13 20:19:09 +0900384 fe->param.name);
385 did_spd = true;
386 }
Tejun Heo33267322008-02-13 09:15:09 +0900387
Tejun Heo05944bd2008-08-13 20:19:09 +0900388 /* let lflags stack */
389 if (fe->param.lflags) {
390 link->flags |= fe->param.lflags;
Joe Perchesa9a79df2011-04-15 15:51:59 -0700391 ata_link_notice(link,
Tejun Heo05944bd2008-08-13 20:19:09 +0900392 "FORCE: link flag 0x%x forced -> 0x%x\n",
393 fe->param.lflags, link->flags);
394 }
Tejun Heo33267322008-02-13 09:15:09 +0900395 }
396}
397
398/**
399 * ata_force_xfermask - force xfermask according to libata.force
400 * @dev: ATA device of interest
401 *
402 * Force xfer_mask according to libata.force and whine about it.
403 * For consistency with link selection, device number 15 selects
404 * the first device connected to the host link.
405 *
406 * LOCKING:
407 * EH context.
408 */
409static void ata_force_xfermask(struct ata_device *dev)
410{
411 int devno = dev->link->pmp + dev->devno;
412 int alt_devno = devno;
413 int i;
414
Tejun Heob1c72912008-07-31 17:02:43 +0900415 /* allow n.15/16 for devices attached to host port */
416 if (ata_is_host_link(dev->link))
417 alt_devno += 15;
Tejun Heo33267322008-02-13 09:15:09 +0900418
419 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
420 const struct ata_force_ent *fe = &ata_force_tbl[i];
421 unsigned long pio_mask, mwdma_mask, udma_mask;
422
423 if (fe->port != -1 && fe->port != dev->link->ap->print_id)
424 continue;
425
426 if (fe->device != -1 && fe->device != devno &&
427 fe->device != alt_devno)
428 continue;
429
430 if (!fe->param.xfer_mask)
431 continue;
432
433 ata_unpack_xfermask(fe->param.xfer_mask,
434 &pio_mask, &mwdma_mask, &udma_mask);
435 if (udma_mask)
436 dev->udma_mask = udma_mask;
437 else if (mwdma_mask) {
438 dev->udma_mask = 0;
439 dev->mwdma_mask = mwdma_mask;
440 } else {
441 dev->udma_mask = 0;
442 dev->mwdma_mask = 0;
443 dev->pio_mask = pio_mask;
444 }
445
Joe Perchesa9a79df2011-04-15 15:51:59 -0700446 ata_dev_notice(dev, "FORCE: xfer_mask set to %s\n",
447 fe->param.name);
Tejun Heo33267322008-02-13 09:15:09 +0900448 return;
449 }
450}
451
452/**
453 * ata_force_horkage - force horkage according to libata.force
454 * @dev: ATA device of interest
455 *
456 * Force horkage according to libata.force and whine about it.
457 * For consistency with link selection, device number 15 selects
458 * the first device connected to the host link.
459 *
460 * LOCKING:
461 * EH context.
462 */
463static void ata_force_horkage(struct ata_device *dev)
464{
465 int devno = dev->link->pmp + dev->devno;
466 int alt_devno = devno;
467 int i;
468
Tejun Heob1c72912008-07-31 17:02:43 +0900469 /* allow n.15/16 for devices attached to host port */
470 if (ata_is_host_link(dev->link))
471 alt_devno += 15;
Tejun Heo33267322008-02-13 09:15:09 +0900472
473 for (i = 0; i < ata_force_tbl_size; i++) {
474 const struct ata_force_ent *fe = &ata_force_tbl[i];
475
476 if (fe->port != -1 && fe->port != dev->link->ap->print_id)
477 continue;
478
479 if (fe->device != -1 && fe->device != devno &&
480 fe->device != alt_devno)
481 continue;
482
483 if (!(~dev->horkage & fe->param.horkage_on) &&
484 !(dev->horkage & fe->param.horkage_off))
485 continue;
486
487 dev->horkage |= fe->param.horkage_on;
488 dev->horkage &= ~fe->param.horkage_off;
489
Joe Perchesa9a79df2011-04-15 15:51:59 -0700490 ata_dev_notice(dev, "FORCE: horkage modified (%s)\n",
491 fe->param.name);
Tejun Heo33267322008-02-13 09:15:09 +0900492 }
493}
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +0100494#else
495static inline void ata_force_link_limits(struct ata_link *link) { }
496static inline void ata_force_xfermask(struct ata_device *dev) { }
497static inline void ata_force_horkage(struct ata_device *dev) { }
498#endif
Tejun Heo33267322008-02-13 09:15:09 +0900499
500/**
Tejun Heo436d34b2008-04-02 17:28:46 +0900501 * atapi_cmd_type - Determine ATAPI command type from SCSI opcode
502 * @opcode: SCSI opcode
503 *
504 * Determine ATAPI command type from @opcode.
505 *
506 * LOCKING:
507 * None.
508 *
509 * RETURNS:
510 * ATAPI_{READ|WRITE|READ_CD|PASS_THRU|MISC}
511 */
512int atapi_cmd_type(u8 opcode)
513{
514 switch (opcode) {
515 case GPCMD_READ_10:
516 case GPCMD_READ_12:
517 return ATAPI_READ;
518
519 case GPCMD_WRITE_10:
520 case GPCMD_WRITE_12:
521 case GPCMD_WRITE_AND_VERIFY_10:
522 return ATAPI_WRITE;
523
524 case GPCMD_READ_CD:
525 case GPCMD_READ_CD_MSF:
526 return ATAPI_READ_CD;
527
Tejun Heoe52dcc42008-04-02 17:35:19 +0900528 case ATA_16:
529 case ATA_12:
530 if (atapi_passthru16)
531 return ATAPI_PASS_THRU;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500532 fallthrough;
Tejun Heo436d34b2008-04-02 17:28:46 +0900533 default:
534 return ATAPI_MISC;
535 }
536}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100537EXPORT_SYMBOL_GPL(atapi_cmd_type);
Tejun Heo436d34b2008-04-02 17:28:46 +0900538
Albert Lee8cbd6df2005-10-12 15:06:27 +0800539static const u8 ata_rw_cmds[] = {
540 /* pio multi */
541 ATA_CMD_READ_MULTI,
542 ATA_CMD_WRITE_MULTI,
543 ATA_CMD_READ_MULTI_EXT,
544 ATA_CMD_WRITE_MULTI_EXT,
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100545 0,
546 0,
547 0,
548 ATA_CMD_WRITE_MULTI_FUA_EXT,
Albert Lee8cbd6df2005-10-12 15:06:27 +0800549 /* pio */
550 ATA_CMD_PIO_READ,
551 ATA_CMD_PIO_WRITE,
552 ATA_CMD_PIO_READ_EXT,
553 ATA_CMD_PIO_WRITE_EXT,
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100554 0,
555 0,
556 0,
557 0,
Albert Lee8cbd6df2005-10-12 15:06:27 +0800558 /* dma */
559 ATA_CMD_READ,
560 ATA_CMD_WRITE,
561 ATA_CMD_READ_EXT,
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100562 ATA_CMD_WRITE_EXT,
563 0,
564 0,
565 0,
566 ATA_CMD_WRITE_FUA_EXT
Albert Lee8cbd6df2005-10-12 15:06:27 +0800567};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
569/**
Albert Lee8cbd6df2005-10-12 15:06:27 +0800570 * ata_rwcmd_protocol - set taskfile r/w commands and protocol
Tejun Heobd056d72006-11-14 22:47:10 +0900571 * @tf: command to examine and configure
572 * @dev: device tf belongs to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 *
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500574 * Examine the device configuration and tf->flags to calculate
Albert Lee8cbd6df2005-10-12 15:06:27 +0800575 * the proper read/write commands and protocol to use.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 *
577 * LOCKING:
578 * caller.
579 */
Tejun Heobd056d72006-11-14 22:47:10 +0900580static int ata_rwcmd_protocol(struct ata_taskfile *tf, struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100582 u8 cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100584 int index, fua, lba48, write;
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500585
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100586 fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
Albert Lee8cbd6df2005-10-12 15:06:27 +0800587 lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
588 write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Albert Lee8cbd6df2005-10-12 15:06:27 +0800590 if (dev->flags & ATA_DFLAG_PIO) {
591 tf->protocol = ATA_PROT_PIO;
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100592 index = dev->multi_count ? 0 : 8;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900593 } else if (lba48 && (dev->link->ap->flags & ATA_FLAG_PIO_LBA48)) {
Alan Cox8d238e02006-01-17 20:50:31 +0000594 /* Unable to use DMA due to host limitation */
595 tf->protocol = ATA_PROT_PIO;
Albert Lee0565c262006-02-13 18:55:25 +0800596 index = dev->multi_count ? 0 : 8;
Albert Lee8cbd6df2005-10-12 15:06:27 +0800597 } else {
598 tf->protocol = ATA_PROT_DMA;
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100599 index = 16;
Albert Lee8cbd6df2005-10-12 15:06:27 +0800600 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Tejun Heo9a3dccc2006-01-06 09:56:18 +0100602 cmd = ata_rw_cmds[index + fua + lba48 + write];
603 if (cmd) {
604 tf->command = cmd;
605 return 0;
606 }
607 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608}
609
Tejun Heocb95d562006-03-06 04:31:56 +0900610/**
Tejun Heo35b649f2006-11-14 22:37:35 +0900611 * ata_tf_read_block - Read block address from ATA taskfile
612 * @tf: ATA taskfile of interest
613 * @dev: ATA device @tf belongs to
614 *
615 * LOCKING:
616 * None.
617 *
618 * Read block address from @tf. This function can handle all
619 * three address formats - LBA, LBA48 and CHS. tf->protocol and
620 * flags select the address format to use.
621 *
622 * RETURNS:
623 * Block address read from @tf.
624 */
Hannes Reineckecffd1ee2016-04-04 11:43:57 +0200625u64 ata_tf_read_block(const struct ata_taskfile *tf, struct ata_device *dev)
Tejun Heo35b649f2006-11-14 22:37:35 +0900626{
627 u64 block = 0;
628
Tejun Heofe16d4f2015-08-03 11:41:33 -0400629 if (tf->flags & ATA_TFLAG_LBA) {
Tejun Heo35b649f2006-11-14 22:37:35 +0900630 if (tf->flags & ATA_TFLAG_LBA48) {
631 block |= (u64)tf->hob_lbah << 40;
632 block |= (u64)tf->hob_lbam << 32;
Roland Dreier44901a92008-11-04 10:34:48 -0800633 block |= (u64)tf->hob_lbal << 24;
Tejun Heo35b649f2006-11-14 22:37:35 +0900634 } else
635 block |= (tf->device & 0xf) << 24;
636
637 block |= tf->lbah << 16;
638 block |= tf->lbam << 8;
639 block |= tf->lbal;
640 } else {
641 u32 cyl, head, sect;
642
643 cyl = tf->lbam | (tf->lbah << 8);
644 head = tf->device & 0xf;
645 sect = tf->lbal;
646
Tejun Heoac8672e2009-08-16 21:21:21 +0900647 if (!sect) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700648 ata_dev_warn(dev,
649 "device reported invalid CHS sector 0\n");
Hannes Reineckecffd1ee2016-04-04 11:43:57 +0200650 return U64_MAX;
Tejun Heoac8672e2009-08-16 21:21:21 +0900651 }
652
653 block = (cyl * dev->heads + head) * dev->sectors + sect - 1;
Tejun Heo35b649f2006-11-14 22:37:35 +0900654 }
655
656 return block;
657}
658
659/**
Tejun Heobd056d72006-11-14 22:47:10 +0900660 * ata_build_rw_tf - Build ATA taskfile for given read/write request
661 * @tf: Target ATA taskfile
662 * @dev: ATA device @tf belongs to
663 * @block: Block address
664 * @n_block: Number of blocks
665 * @tf_flags: RW/FUA etc...
666 * @tag: tag
Adam Manzanares8e061782016-10-17 11:27:29 -0700667 * @class: IO priority class
Tejun Heobd056d72006-11-14 22:47:10 +0900668 *
669 * LOCKING:
670 * None.
671 *
672 * Build ATA taskfile @tf for read/write request described by
673 * @block, @n_block, @tf_flags and @tag on @dev.
674 *
675 * RETURNS:
676 *
677 * 0 on success, -ERANGE if the request is too large for @dev,
678 * -EINVAL if the request is invalid.
679 */
680int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
681 u64 block, u32 n_block, unsigned int tf_flags,
Adam Manzanares8e061782016-10-17 11:27:29 -0700682 unsigned int tag, int class)
Tejun Heobd056d72006-11-14 22:47:10 +0900683{
684 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
685 tf->flags |= tf_flags;
686
Jens Axboe2e2cc672018-05-11 12:51:06 -0600687 if (ata_ncq_enabled(dev) && !ata_tag_internal(tag)) {
Tejun Heobd056d72006-11-14 22:47:10 +0900688 /* yay, NCQ */
689 if (!lba_48_ok(block, n_block))
690 return -ERANGE;
691
692 tf->protocol = ATA_PROT_NCQ;
693 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
694
695 if (tf->flags & ATA_TFLAG_WRITE)
696 tf->command = ATA_CMD_FPDMA_WRITE;
697 else
698 tf->command = ATA_CMD_FPDMA_READ;
699
700 tf->nsect = tag << 3;
701 tf->hob_feature = (n_block >> 8) & 0xff;
702 tf->feature = n_block & 0xff;
703
704 tf->hob_lbah = (block >> 40) & 0xff;
705 tf->hob_lbam = (block >> 32) & 0xff;
706 tf->hob_lbal = (block >> 24) & 0xff;
707 tf->lbah = (block >> 16) & 0xff;
708 tf->lbam = (block >> 8) & 0xff;
709 tf->lbal = block & 0xff;
710
Sergei Shtylyov9ca7cfa2012-08-21 22:18:50 +0400711 tf->device = ATA_LBA;
Tejun Heobd056d72006-11-14 22:47:10 +0900712 if (tf->flags & ATA_TFLAG_FUA)
713 tf->device |= 1 << 7;
Adam Manzanares8e061782016-10-17 11:27:29 -0700714
Damien Le Moal2360fa12021-08-16 10:44:51 +0900715 if (dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE &&
716 class == IOPRIO_CLASS_RT)
717 tf->hob_nsect |= ATA_PRIO_HIGH << ATA_SHIFT_PRIO;
Tejun Heobd056d72006-11-14 22:47:10 +0900718 } else if (dev->flags & ATA_DFLAG_LBA) {
719 tf->flags |= ATA_TFLAG_LBA;
720
721 if (lba_28_ok(block, n_block)) {
722 /* use LBA28 */
723 tf->device |= (block >> 24) & 0xf;
724 } else if (lba_48_ok(block, n_block)) {
725 if (!(dev->flags & ATA_DFLAG_LBA48))
726 return -ERANGE;
727
728 /* use LBA48 */
729 tf->flags |= ATA_TFLAG_LBA48;
730
731 tf->hob_nsect = (n_block >> 8) & 0xff;
732
733 tf->hob_lbah = (block >> 40) & 0xff;
734 tf->hob_lbam = (block >> 32) & 0xff;
735 tf->hob_lbal = (block >> 24) & 0xff;
736 } else
737 /* request too large even for LBA48 */
738 return -ERANGE;
739
740 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
741 return -EINVAL;
742
743 tf->nsect = n_block & 0xff;
744
745 tf->lbah = (block >> 16) & 0xff;
746 tf->lbam = (block >> 8) & 0xff;
747 tf->lbal = block & 0xff;
748
749 tf->device |= ATA_LBA;
750 } else {
751 /* CHS */
752 u32 sect, head, cyl, track;
753
754 /* The request -may- be too large for CHS addressing. */
755 if (!lba_28_ok(block, n_block))
756 return -ERANGE;
757
758 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
759 return -EINVAL;
760
761 /* Convert LBA to CHS */
762 track = (u32)block / dev->sectors;
763 cyl = track / dev->heads;
764 head = track % dev->heads;
765 sect = (u32)block % dev->sectors + 1;
766
Tejun Heobd056d72006-11-14 22:47:10 +0900767 /* Check whether the converted CHS can fit.
768 Cylinder: 0-65535
769 Head: 0-15
770 Sector: 1-255*/
771 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
772 return -ERANGE;
773
774 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
775 tf->lbal = sect;
776 tf->lbam = cyl;
777 tf->lbah = cyl >> 8;
778 tf->device |= head;
779 }
780
781 return 0;
782}
783
784/**
Tejun Heocb95d562006-03-06 04:31:56 +0900785 * ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
786 * @pio_mask: pio_mask
787 * @mwdma_mask: mwdma_mask
788 * @udma_mask: udma_mask
789 *
790 * Pack @pio_mask, @mwdma_mask and @udma_mask into a single
791 * unsigned int xfer_mask.
792 *
793 * LOCKING:
794 * None.
795 *
796 * RETURNS:
797 * Packed xfer_mask.
798 */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900799unsigned long ata_pack_xfermask(unsigned long pio_mask,
800 unsigned long mwdma_mask,
801 unsigned long udma_mask)
Tejun Heocb95d562006-03-06 04:31:56 +0900802{
803 return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
804 ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
805 ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
806}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100807EXPORT_SYMBOL_GPL(ata_pack_xfermask);
Tejun Heocb95d562006-03-06 04:31:56 +0900808
Tejun Heoc0489e42006-03-24 14:07:49 +0900809/**
810 * ata_unpack_xfermask - Unpack xfer_mask into pio, mwdma and udma masks
811 * @xfer_mask: xfer_mask to unpack
812 * @pio_mask: resulting pio_mask
813 * @mwdma_mask: resulting mwdma_mask
814 * @udma_mask: resulting udma_mask
815 *
816 * Unpack @xfer_mask into @pio_mask, @mwdma_mask and @udma_mask.
Masanari Iidac9b55602016-04-13 23:36:27 +0900817 * Any NULL destination masks will be ignored.
Tejun Heoc0489e42006-03-24 14:07:49 +0900818 */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900819void ata_unpack_xfermask(unsigned long xfer_mask, unsigned long *pio_mask,
820 unsigned long *mwdma_mask, unsigned long *udma_mask)
Tejun Heoc0489e42006-03-24 14:07:49 +0900821{
822 if (pio_mask)
823 *pio_mask = (xfer_mask & ATA_MASK_PIO) >> ATA_SHIFT_PIO;
824 if (mwdma_mask)
825 *mwdma_mask = (xfer_mask & ATA_MASK_MWDMA) >> ATA_SHIFT_MWDMA;
826 if (udma_mask)
827 *udma_mask = (xfer_mask & ATA_MASK_UDMA) >> ATA_SHIFT_UDMA;
828}
829
Tejun Heocb95d562006-03-06 04:31:56 +0900830static const struct ata_xfer_ent {
Tejun Heobe9a50c2006-03-31 22:48:52 +0900831 int shift, bits;
Tejun Heocb95d562006-03-06 04:31:56 +0900832 u8 base;
833} ata_xfer_tbl[] = {
Tejun Heo70cd0712007-11-27 19:43:40 +0900834 { ATA_SHIFT_PIO, ATA_NR_PIO_MODES, XFER_PIO_0 },
835 { ATA_SHIFT_MWDMA, ATA_NR_MWDMA_MODES, XFER_MW_DMA_0 },
836 { ATA_SHIFT_UDMA, ATA_NR_UDMA_MODES, XFER_UDMA_0 },
Tejun Heocb95d562006-03-06 04:31:56 +0900837 { -1, },
838};
839
840/**
841 * ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
842 * @xfer_mask: xfer_mask of interest
843 *
844 * Return matching XFER_* value for @xfer_mask. Only the highest
845 * bit of @xfer_mask is considered.
846 *
847 * LOCKING:
848 * None.
849 *
850 * RETURNS:
Tejun Heo70cd0712007-11-27 19:43:40 +0900851 * Matching XFER_* value, 0xff if no match found.
Tejun Heocb95d562006-03-06 04:31:56 +0900852 */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900853u8 ata_xfer_mask2mode(unsigned long xfer_mask)
Tejun Heocb95d562006-03-06 04:31:56 +0900854{
855 int highbit = fls(xfer_mask) - 1;
856 const struct ata_xfer_ent *ent;
857
858 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
859 if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
860 return ent->base + highbit - ent->shift;
Tejun Heo70cd0712007-11-27 19:43:40 +0900861 return 0xff;
Tejun Heocb95d562006-03-06 04:31:56 +0900862}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100863EXPORT_SYMBOL_GPL(ata_xfer_mask2mode);
Tejun Heocb95d562006-03-06 04:31:56 +0900864
865/**
866 * ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
867 * @xfer_mode: XFER_* of interest
868 *
869 * Return matching xfer_mask for @xfer_mode.
870 *
871 * LOCKING:
872 * None.
873 *
874 * RETURNS:
875 * Matching xfer_mask, 0 if no match found.
876 */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900877unsigned long ata_xfer_mode2mask(u8 xfer_mode)
Tejun Heocb95d562006-03-06 04:31:56 +0900878{
879 const struct ata_xfer_ent *ent;
880
881 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
882 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
Tejun Heo70cd0712007-11-27 19:43:40 +0900883 return ((2 << (ent->shift + xfer_mode - ent->base)) - 1)
884 & ~((1 << ent->shift) - 1);
Tejun Heocb95d562006-03-06 04:31:56 +0900885 return 0;
886}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100887EXPORT_SYMBOL_GPL(ata_xfer_mode2mask);
Tejun Heocb95d562006-03-06 04:31:56 +0900888
889/**
890 * ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
891 * @xfer_mode: XFER_* of interest
892 *
893 * Return matching xfer_shift for @xfer_mode.
894 *
895 * LOCKING:
896 * None.
897 *
898 * RETURNS:
899 * Matching xfer_shift, -1 if no match found.
900 */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900901int ata_xfer_mode2shift(unsigned long xfer_mode)
Tejun Heocb95d562006-03-06 04:31:56 +0900902{
903 const struct ata_xfer_ent *ent;
904
905 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
906 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
907 return ent->shift;
908 return -1;
909}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100910EXPORT_SYMBOL_GPL(ata_xfer_mode2shift);
Tejun Heocb95d562006-03-06 04:31:56 +0900911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912/**
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900913 * ata_mode_string - convert xfer_mask to string
914 * @xfer_mask: mask of bits supported; only highest bit counts.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 *
916 * Determine string which represents the highest speed
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900917 * (highest bit in @modemask).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 *
919 * LOCKING:
920 * None.
921 *
922 * RETURNS:
923 * Constant C string representing highest speed listed in
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900924 * @mode_mask, or the constant C string "<n/a>".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900926const char *ata_mode_string(unsigned long xfer_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927{
Tejun Heo75f554b2006-03-06 04:31:57 +0900928 static const char * const xfer_mode_str[] = {
929 "PIO0",
930 "PIO1",
931 "PIO2",
932 "PIO3",
933 "PIO4",
Alan Coxb352e572006-08-10 18:52:12 +0100934 "PIO5",
935 "PIO6",
Tejun Heo75f554b2006-03-06 04:31:57 +0900936 "MWDMA0",
937 "MWDMA1",
938 "MWDMA2",
Alan Coxb352e572006-08-10 18:52:12 +0100939 "MWDMA3",
940 "MWDMA4",
Tejun Heo75f554b2006-03-06 04:31:57 +0900941 "UDMA/16",
942 "UDMA/25",
943 "UDMA/33",
944 "UDMA/44",
945 "UDMA/66",
946 "UDMA/100",
947 "UDMA/133",
948 "UDMA7",
949 };
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900950 int highbit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900952 highbit = fls(xfer_mask) - 1;
953 if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
954 return xfer_mode_str[highbit];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 return "<n/a>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +0100957EXPORT_SYMBOL_GPL(ata_mode_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
Gwendal Grignoud9027472010-05-25 12:31:38 -0700959const char *sata_spd_string(unsigned int spd)
Tejun Heo4c360c82006-04-01 01:38:17 +0900960{
961 static const char * const spd_str[] = {
962 "1.5 Gbps",
963 "3.0 Gbps",
Shane Huang8522ee22008-12-30 11:00:37 +0800964 "6.0 Gbps",
Tejun Heo4c360c82006-04-01 01:38:17 +0900965 };
966
967 if (spd == 0 || (spd - 1) >= ARRAY_SIZE(spd_str))
968 return "<unknown>";
969 return spd_str[spd - 1];
970}
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972/**
973 * ata_dev_classify - determine device type based on ATA-spec signature
974 * @tf: ATA taskfile register set for device to be identified
975 *
976 * Determine from taskfile register contents whether a device is
977 * ATA or ATAPI, as per "Signature and persistence" section
978 * of ATA/PI spec (volume 1, sect 5.14).
979 *
980 * LOCKING:
981 * None.
982 *
983 * RETURNS:
Hannes Reinecke9162c652014-11-05 13:08:21 +0100984 * Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, %ATA_DEV_PMP,
985 * %ATA_DEV_ZAC, or %ATA_DEV_UNKNOWN the event of failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400987unsigned int ata_dev_classify(const struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988{
989 /* Apple's open source Darwin code hints that some devices only
990 * put a proper signature into the LBA mid/high registers,
991 * So, we only check those. It's sufficient for uniqueness.
Tejun Heo633273a2007-09-23 13:19:54 +0900992 *
993 * ATA/ATAPI-7 (d1532v1r1: Feb. 19, 2003) specified separate
994 * signatures for ATA and ATAPI devices attached on SerialATA,
995 * 0x3c/0xc3 and 0x69/0x96 respectively. However, SerialATA
996 * spec has never mentioned about using different signatures
997 * for ATA/ATAPI devices. Then, Serial ATA II: Port
998 * Multiplier specification began to use 0x69/0x96 to identify
999 * port multpliers and 0x3c/0xc3 to identify SEMB device.
1000 * ATA/ATAPI-7 dropped descriptions about 0x3c/0xc3 and
1001 * 0x69/0x96 shortly and described them as reserved for
1002 * SerialATA.
1003 *
1004 * We follow the current spec and consider that 0x69/0x96
1005 * identifies a port multiplier and 0x3c/0xc3 a SEMB device.
Tejun Heo79b42ba2009-04-15 06:21:10 +09001006 * Unfortunately, WDC WD1600JS-62MHB5 (a hard drive) reports
1007 * SEMB signature. This is worked around in
1008 * ata_dev_read_id().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 */
Hannes Reinecke6c952a02021-12-21 08:20:26 +01001010 if (tf->lbam == 0 && tf->lbah == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 return ATA_DEV_ATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
Hannes Reinecke6c952a02021-12-21 08:20:26 +01001013 if (tf->lbam == 0x14 && tf->lbah == 0xeb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 return ATA_DEV_ATAPI;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Hannes Reinecke6c952a02021-12-21 08:20:26 +01001016 if (tf->lbam == 0x69 && tf->lbah == 0x96)
Tejun Heo633273a2007-09-23 13:19:54 +09001017 return ATA_DEV_PMP;
Tejun Heo633273a2007-09-23 13:19:54 +09001018
Hannes Reinecke6c952a02021-12-21 08:20:26 +01001019 if (tf->lbam == 0x3c && tf->lbah == 0xc3)
Tejun Heo79b42ba2009-04-15 06:21:10 +09001020 return ATA_DEV_SEMB;
Tejun Heo633273a2007-09-23 13:19:54 +09001021
Hannes Reinecke6c952a02021-12-21 08:20:26 +01001022 if (tf->lbam == 0xcd && tf->lbah == 0xab)
Hannes Reinecke9162c652014-11-05 13:08:21 +01001023 return ATA_DEV_ZAC;
Hannes Reinecke9162c652014-11-05 13:08:21 +01001024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 return ATA_DEV_UNKNOWN;
1026}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001027EXPORT_SYMBOL_GPL(ata_dev_classify);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
1029/**
Tejun Heo6a62a042006-02-13 10:02:46 +09001030 * ata_id_string - Convert IDENTIFY DEVICE page into string
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 * @id: IDENTIFY DEVICE results we will examine
1032 * @s: string into which data is output
1033 * @ofs: offset into identify device page
1034 * @len: length of string to return. must be an even number.
1035 *
1036 * The strings in the IDENTIFY DEVICE page are broken up into
1037 * 16-bit chunks. Run through the string, and output each
1038 * 8-bit chunk linearly, regardless of platform.
1039 *
1040 * LOCKING:
1041 * caller.
1042 */
1043
Tejun Heo6a62a042006-02-13 10:02:46 +09001044void ata_id_string(const u16 *id, unsigned char *s,
1045 unsigned int ofs, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046{
1047 unsigned int c;
1048
Alan Cox963e4972008-07-24 17:16:06 +01001049 BUG_ON(len & 1);
1050
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 while (len > 0) {
1052 c = id[ofs] >> 8;
1053 *s = c;
1054 s++;
1055
1056 c = id[ofs] & 0xff;
1057 *s = c;
1058 s++;
1059
1060 ofs++;
1061 len -= 2;
1062 }
1063}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001064EXPORT_SYMBOL_GPL(ata_id_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
Tejun Heo0e949ff2006-02-12 22:47:04 +09001066/**
Tejun Heo6a62a042006-02-13 10:02:46 +09001067 * ata_id_c_string - Convert IDENTIFY DEVICE page into C string
Tejun Heo0e949ff2006-02-12 22:47:04 +09001068 * @id: IDENTIFY DEVICE results we will examine
1069 * @s: string into which data is output
1070 * @ofs: offset into identify device page
1071 * @len: length of string to return. must be an odd number.
1072 *
Tejun Heo6a62a042006-02-13 10:02:46 +09001073 * This function is identical to ata_id_string except that it
Tejun Heo0e949ff2006-02-12 22:47:04 +09001074 * trims trailing spaces and terminates the resulting string with
1075 * null. @len must be actual maximum length (even number) + 1.
1076 *
1077 * LOCKING:
1078 * caller.
1079 */
Tejun Heo6a62a042006-02-13 10:02:46 +09001080void ata_id_c_string(const u16 *id, unsigned char *s,
1081 unsigned int ofs, unsigned int len)
Tejun Heo0e949ff2006-02-12 22:47:04 +09001082{
1083 unsigned char *p;
1084
Tejun Heo6a62a042006-02-13 10:02:46 +09001085 ata_id_string(id, s, ofs, len - 1);
Tejun Heo0e949ff2006-02-12 22:47:04 +09001086
1087 p = s + strnlen(s, len - 1);
1088 while (p > s && p[-1] == ' ')
1089 p--;
1090 *p = '\0';
1091}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001092EXPORT_SYMBOL_GPL(ata_id_c_string);
Edward Falk0baab862005-06-02 18:17:13 -04001093
Tejun Heodb6f8752007-09-03 12:31:58 +09001094static u64 ata_id_n_sectors(const u16 *id)
1095{
1096 if (ata_id_has_lba(id)) {
1097 if (ata_id_has_lba48(id))
Robert Hancock968e5942009-02-16 20:15:08 -06001098 return ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
Tejun Heodb6f8752007-09-03 12:31:58 +09001099 else
Robert Hancock968e5942009-02-16 20:15:08 -06001100 return ata_id_u32(id, ATA_ID_LBA_CAPACITY);
Tejun Heodb6f8752007-09-03 12:31:58 +09001101 } else {
1102 if (ata_id_current_chs_valid(id))
Robert Hancock968e5942009-02-16 20:15:08 -06001103 return id[ATA_ID_CUR_CYLS] * id[ATA_ID_CUR_HEADS] *
1104 id[ATA_ID_CUR_SECTORS];
Tejun Heodb6f8752007-09-03 12:31:58 +09001105 else
Robert Hancock968e5942009-02-16 20:15:08 -06001106 return id[ATA_ID_CYLS] * id[ATA_ID_HEADS] *
1107 id[ATA_ID_SECTORS];
Tejun Heodb6f8752007-09-03 12:31:58 +09001108 }
1109}
1110
Tejun Heoa5987e02008-03-27 19:14:23 +09001111u64 ata_tf_to_lba48(const struct ata_taskfile *tf)
Alan Cox1e999732007-04-11 00:23:13 +01001112{
1113 u64 sectors = 0;
1114
1115 sectors |= ((u64)(tf->hob_lbah & 0xff)) << 40;
1116 sectors |= ((u64)(tf->hob_lbam & 0xff)) << 32;
Roland Dreierba14a9c2008-10-28 16:52:20 -07001117 sectors |= ((u64)(tf->hob_lbal & 0xff)) << 24;
Alan Cox1e999732007-04-11 00:23:13 +01001118 sectors |= (tf->lbah & 0xff) << 16;
1119 sectors |= (tf->lbam & 0xff) << 8;
1120 sectors |= (tf->lbal & 0xff);
1121
Tejun Heoa5987e02008-03-27 19:14:23 +09001122 return sectors;
Alan Cox1e999732007-04-11 00:23:13 +01001123}
1124
Tejun Heoa5987e02008-03-27 19:14:23 +09001125u64 ata_tf_to_lba(const struct ata_taskfile *tf)
Alan Cox1e999732007-04-11 00:23:13 +01001126{
1127 u64 sectors = 0;
1128
1129 sectors |= (tf->device & 0x0f) << 24;
1130 sectors |= (tf->lbah & 0xff) << 16;
1131 sectors |= (tf->lbam & 0xff) << 8;
1132 sectors |= (tf->lbal & 0xff);
1133
Tejun Heoa5987e02008-03-27 19:14:23 +09001134 return sectors;
Alan Cox1e999732007-04-11 00:23:13 +01001135}
1136
1137/**
Tejun Heoc728a912007-09-03 12:32:30 +09001138 * ata_read_native_max_address - Read native max address
1139 * @dev: target device
1140 * @max_sectors: out parameter for the result native max address
Alan Cox1e999732007-04-11 00:23:13 +01001141 *
Tejun Heoc728a912007-09-03 12:32:30 +09001142 * Perform an LBA48 or LBA28 native size query upon the device in
1143 * question.
1144 *
1145 * RETURNS:
1146 * 0 on success, -EACCES if command is aborted by the drive.
1147 * -EIO on other errors.
Alan Cox1e999732007-04-11 00:23:13 +01001148 */
Tejun Heoc728a912007-09-03 12:32:30 +09001149static int ata_read_native_max_address(struct ata_device *dev, u64 *max_sectors)
Alan Cox1e999732007-04-11 00:23:13 +01001150{
Tejun Heoc728a912007-09-03 12:32:30 +09001151 unsigned int err_mask;
Alan Cox1e999732007-04-11 00:23:13 +01001152 struct ata_taskfile tf;
Tejun Heoc728a912007-09-03 12:32:30 +09001153 int lba48 = ata_id_has_lba48(dev->id);
Alan Cox1e999732007-04-11 00:23:13 +01001154
1155 ata_tf_init(dev, &tf);
1156
Tejun Heoc728a912007-09-03 12:32:30 +09001157 /* always clear all address registers */
Alan Cox1e999732007-04-11 00:23:13 +01001158 tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
Tejun Heoc728a912007-09-03 12:32:30 +09001159
1160 if (lba48) {
1161 tf.command = ATA_CMD_READ_NATIVE_MAX_EXT;
1162 tf.flags |= ATA_TFLAG_LBA48;
1163 } else
1164 tf.command = ATA_CMD_READ_NATIVE_MAX;
1165
Hannes Reineckebd18bc02016-07-14 09:05:46 +09001166 tf.protocol = ATA_PROT_NODATA;
Tejun Heoc728a912007-09-03 12:32:30 +09001167 tf.device |= ATA_LBA;
Alan Cox1e999732007-04-11 00:23:13 +01001168
Tejun Heo2b789102007-10-09 15:05:44 +09001169 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
Tejun Heoc728a912007-09-03 12:32:30 +09001170 if (err_mask) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001171 ata_dev_warn(dev,
1172 "failed to read native max address (err_mask=0x%x)\n",
1173 err_mask);
Tejun Heoc728a912007-09-03 12:32:30 +09001174 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
1175 return -EACCES;
1176 return -EIO;
1177 }
Alan Cox1e999732007-04-11 00:23:13 +01001178
Tejun Heoc728a912007-09-03 12:32:30 +09001179 if (lba48)
Tejun Heoa5987e02008-03-27 19:14:23 +09001180 *max_sectors = ata_tf_to_lba48(&tf) + 1;
Tejun Heoc728a912007-09-03 12:32:30 +09001181 else
Tejun Heoa5987e02008-03-27 19:14:23 +09001182 *max_sectors = ata_tf_to_lba(&tf) + 1;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04001183 if (dev->horkage & ATA_HORKAGE_HPA_SIZE)
Alan Cox93328e112007-09-29 04:06:48 -04001184 (*max_sectors)--;
Tejun Heoc728a912007-09-03 12:32:30 +09001185 return 0;
Alan Cox1e999732007-04-11 00:23:13 +01001186}
1187
1188/**
Tejun Heoc728a912007-09-03 12:32:30 +09001189 * ata_set_max_sectors - Set max sectors
1190 * @dev: target device
Randy Dunlap6b38d1d2007-05-01 17:35:55 -07001191 * @new_sectors: new max sectors value to set for the device
Alan Cox1e999732007-04-11 00:23:13 +01001192 *
Tejun Heoc728a912007-09-03 12:32:30 +09001193 * Set max sectors of @dev to @new_sectors.
1194 *
1195 * RETURNS:
1196 * 0 on success, -EACCES if command is aborted or denied (due to
1197 * previous non-volatile SET_MAX) by the drive. -EIO on other
1198 * errors.
Alan Cox1e999732007-04-11 00:23:13 +01001199 */
Tejun Heo05027ad2007-09-03 12:32:57 +09001200static int ata_set_max_sectors(struct ata_device *dev, u64 new_sectors)
Alan Cox1e999732007-04-11 00:23:13 +01001201{
Tejun Heoc728a912007-09-03 12:32:30 +09001202 unsigned int err_mask;
Alan Cox1e999732007-04-11 00:23:13 +01001203 struct ata_taskfile tf;
Tejun Heoc728a912007-09-03 12:32:30 +09001204 int lba48 = ata_id_has_lba48(dev->id);
Alan Cox1e999732007-04-11 00:23:13 +01001205
1206 new_sectors--;
1207
1208 ata_tf_init(dev, &tf);
1209
Alan Cox1e999732007-04-11 00:23:13 +01001210 tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
Tejun Heoc728a912007-09-03 12:32:30 +09001211
1212 if (lba48) {
1213 tf.command = ATA_CMD_SET_MAX_EXT;
1214 tf.flags |= ATA_TFLAG_LBA48;
1215
1216 tf.hob_lbal = (new_sectors >> 24) & 0xff;
1217 tf.hob_lbam = (new_sectors >> 32) & 0xff;
1218 tf.hob_lbah = (new_sectors >> 40) & 0xff;
Tejun Heo1e582ba2007-09-21 20:07:14 +09001219 } else {
Tejun Heoc728a912007-09-03 12:32:30 +09001220 tf.command = ATA_CMD_SET_MAX;
1221
Tejun Heo1e582ba2007-09-21 20:07:14 +09001222 tf.device |= (new_sectors >> 24) & 0xf;
1223 }
1224
Hannes Reineckebd18bc02016-07-14 09:05:46 +09001225 tf.protocol = ATA_PROT_NODATA;
Tejun Heoc728a912007-09-03 12:32:30 +09001226 tf.device |= ATA_LBA;
Alan Cox1e999732007-04-11 00:23:13 +01001227
1228 tf.lbal = (new_sectors >> 0) & 0xff;
1229 tf.lbam = (new_sectors >> 8) & 0xff;
1230 tf.lbah = (new_sectors >> 16) & 0xff;
Alan Cox1e999732007-04-11 00:23:13 +01001231
Tejun Heo2b789102007-10-09 15:05:44 +09001232 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
Tejun Heoc728a912007-09-03 12:32:30 +09001233 if (err_mask) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001234 ata_dev_warn(dev,
1235 "failed to set max address (err_mask=0x%x)\n",
1236 err_mask);
Tejun Heoc728a912007-09-03 12:32:30 +09001237 if (err_mask == AC_ERR_DEV &&
1238 (tf.feature & (ATA_ABORTED | ATA_IDNF)))
1239 return -EACCES;
1240 return -EIO;
1241 }
Alan Cox1e999732007-04-11 00:23:13 +01001242
Tejun Heoc728a912007-09-03 12:32:30 +09001243 return 0;
Alan Cox1e999732007-04-11 00:23:13 +01001244}
1245
1246/**
1247 * ata_hpa_resize - Resize a device with an HPA set
1248 * @dev: Device to resize
1249 *
1250 * Read the size of an LBA28 or LBA48 disk with HPA features and resize
1251 * it if required to the full size of the media. The caller must check
1252 * the drive has the HPA feature set enabled.
Tejun Heo05027ad2007-09-03 12:32:57 +09001253 *
1254 * RETURNS:
1255 * 0 on success, -errno on failure.
Alan Cox1e999732007-04-11 00:23:13 +01001256 */
Tejun Heo05027ad2007-09-03 12:32:57 +09001257static int ata_hpa_resize(struct ata_device *dev)
Alan Cox1e999732007-04-11 00:23:13 +01001258{
Damien Le Moal891fd7c2021-08-16 10:44:50 +09001259 bool print_info = ata_dev_print_info(dev);
Tejun Heo445d2112010-04-05 10:33:13 +09001260 bool unlock_hpa = ata_ignore_hpa || dev->flags & ATA_DFLAG_UNLOCK_HPA;
Tejun Heo05027ad2007-09-03 12:32:57 +09001261 u64 sectors = ata_id_n_sectors(dev->id);
1262 u64 native_sectors;
Tejun Heoc728a912007-09-03 12:32:30 +09001263 int rc;
Jeff Garzika617c092007-05-21 20:14:23 -04001264
Tejun Heo05027ad2007-09-03 12:32:57 +09001265 /* do we need to do it? */
Hannes Reinecke9162c652014-11-05 13:08:21 +01001266 if ((dev->class != ATA_DEV_ATA && dev->class != ATA_DEV_ZAC) ||
Tejun Heo05027ad2007-09-03 12:32:57 +09001267 !ata_id_has_lba(dev->id) || !ata_id_hpa_enabled(dev->id) ||
1268 (dev->horkage & ATA_HORKAGE_BROKEN_HPA))
Tejun Heoc728a912007-09-03 12:32:30 +09001269 return 0;
Alan Cox1e999732007-04-11 00:23:13 +01001270
Tejun Heo05027ad2007-09-03 12:32:57 +09001271 /* read native max address */
1272 rc = ata_read_native_max_address(dev, &native_sectors);
1273 if (rc) {
Tejun Heodda7aba2008-03-23 21:05:15 +09001274 /* If device aborted the command or HPA isn't going to
1275 * be unlocked, skip HPA resizing.
Tejun Heo05027ad2007-09-03 12:32:57 +09001276 */
Tejun Heo445d2112010-04-05 10:33:13 +09001277 if (rc == -EACCES || !unlock_hpa) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001278 ata_dev_warn(dev,
1279 "HPA support seems broken, skipping HPA handling\n");
Tejun Heo05027ad2007-09-03 12:32:57 +09001280 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
Alan Cox1e999732007-04-11 00:23:13 +01001281
Tejun Heo05027ad2007-09-03 12:32:57 +09001282 /* we can continue if device aborted the command */
1283 if (rc == -EACCES)
1284 rc = 0;
Alan Cox1e999732007-04-11 00:23:13 +01001285 }
Tejun Heo37301a52007-06-25 20:45:54 +09001286
Tejun Heo05027ad2007-09-03 12:32:57 +09001287 return rc;
1288 }
Tejun Heo5920dad2009-07-15 17:11:41 +09001289 dev->n_native_sectors = native_sectors;
Tejun Heo05027ad2007-09-03 12:32:57 +09001290
1291 /* nothing to do? */
Tejun Heo445d2112010-04-05 10:33:13 +09001292 if (native_sectors <= sectors || !unlock_hpa) {
Tejun Heo05027ad2007-09-03 12:32:57 +09001293 if (!print_info || native_sectors == sectors)
1294 return 0;
1295
1296 if (native_sectors > sectors)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001297 ata_dev_info(dev,
Tejun Heo05027ad2007-09-03 12:32:57 +09001298 "HPA detected: current %llu, native %llu\n",
1299 (unsigned long long)sectors,
1300 (unsigned long long)native_sectors);
1301 else if (native_sectors < sectors)
Joe Perchesa9a79df2011-04-15 15:51:59 -07001302 ata_dev_warn(dev,
1303 "native sectors (%llu) is smaller than sectors (%llu)\n",
Tejun Heo05027ad2007-09-03 12:32:57 +09001304 (unsigned long long)native_sectors,
1305 (unsigned long long)sectors);
1306 return 0;
1307 }
1308
1309 /* let's unlock HPA */
1310 rc = ata_set_max_sectors(dev, native_sectors);
1311 if (rc == -EACCES) {
1312 /* if device aborted the command, skip HPA resizing */
Joe Perchesa9a79df2011-04-15 15:51:59 -07001313 ata_dev_warn(dev,
1314 "device aborted resize (%llu -> %llu), skipping HPA handling\n",
1315 (unsigned long long)sectors,
1316 (unsigned long long)native_sectors);
Tejun Heo05027ad2007-09-03 12:32:57 +09001317 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1318 return 0;
1319 } else if (rc)
1320 return rc;
1321
1322 /* re-read IDENTIFY data */
1323 rc = ata_dev_reread_id(dev, 0);
1324 if (rc) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001325 ata_dev_err(dev,
1326 "failed to re-read IDENTIFY data after HPA resizing\n");
Tejun Heo05027ad2007-09-03 12:32:57 +09001327 return rc;
1328 }
1329
1330 if (print_info) {
1331 u64 new_sectors = ata_id_n_sectors(dev->id);
Joe Perchesa9a79df2011-04-15 15:51:59 -07001332 ata_dev_info(dev,
Tejun Heo05027ad2007-09-03 12:32:57 +09001333 "HPA unlocked: %llu -> %llu, native %llu\n",
1334 (unsigned long long)sectors,
1335 (unsigned long long)new_sectors,
1336 (unsigned long long)native_sectors);
1337 }
1338
1339 return 0;
Alan Cox1e999732007-04-11 00:23:13 +01001340}
1341
Edward Falk0baab862005-06-02 18:17:13 -04001342/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 * ata_dump_id - IDENTIFY DEVICE info debugging output
Hannes Reinecke6044f3c2021-12-21 08:20:27 +01001344 * @dev: device from which the information is fetched
Tejun Heo0bd33002006-02-12 22:47:05 +09001345 * @id: IDENTIFY DEVICE page to dump
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 *
Tejun Heo0bd33002006-02-12 22:47:05 +09001347 * Dump selected 16-bit words from the given IDENTIFY DEVICE
1348 * page.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 *
1350 * LOCKING:
1351 * caller.
1352 */
1353
Hannes Reinecke6044f3c2021-12-21 08:20:27 +01001354static inline void ata_dump_id(struct ata_device *dev, const u16 *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355{
Hannes Reinecke6044f3c2021-12-21 08:20:27 +01001356 ata_dev_dbg(dev,
1357 "49==0x%04x 53==0x%04x 63==0x%04x 64==0x%04x 75==0x%04x\n"
1358 "80==0x%04x 81==0x%04x 82==0x%04x 83==0x%04x 84==0x%04x\n"
1359 "88==0x%04x 93==0x%04x\n",
1360 id[49], id[53], id[63], id[64], id[75], id[80],
1361 id[81], id[82], id[83], id[84], id[88], id[93]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
Tejun Heocb95d562006-03-06 04:31:56 +09001364/**
1365 * ata_id_xfermask - Compute xfermask from the given IDENTIFY data
1366 * @id: IDENTIFY data to compute xfer mask from
1367 *
1368 * Compute the xfermask for this device. This is not as trivial
1369 * as it seems if we must consider early devices correctly.
1370 *
1371 * FIXME: pre IDE drive timing (do we care ?).
1372 *
1373 * LOCKING:
1374 * None.
1375 *
1376 * RETURNS:
1377 * Computed xfermask
1378 */
Tejun Heo7dc951a2007-11-27 19:43:42 +09001379unsigned long ata_id_xfermask(const u16 *id)
Tejun Heocb95d562006-03-06 04:31:56 +09001380{
Tejun Heo7dc951a2007-11-27 19:43:42 +09001381 unsigned long pio_mask, mwdma_mask, udma_mask;
Tejun Heocb95d562006-03-06 04:31:56 +09001382
1383 /* Usual case. Word 53 indicates word 64 is valid */
1384 if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
1385 pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
1386 pio_mask <<= 3;
1387 pio_mask |= 0x7;
1388 } else {
1389 /* If word 64 isn't valid then Word 51 high byte holds
1390 * the PIO timing number for the maximum. Turn it into
1391 * a mask.
1392 */
Lennert Buytenhek7a0f1c82007-01-29 13:28:47 +01001393 u8 mode = (id[ATA_ID_OLD_PIO_MODES] >> 8) & 0xFF;
Alan Cox46767aeb2006-09-29 18:26:47 +01001394 if (mode < 5) /* Valid PIO range */
Jeff Garzik2dcb4072007-10-19 06:42:56 -04001395 pio_mask = (2 << mode) - 1;
Alan Cox46767aeb2006-09-29 18:26:47 +01001396 else
1397 pio_mask = 1;
Tejun Heocb95d562006-03-06 04:31:56 +09001398
1399 /* But wait.. there's more. Design your standards by
1400 * committee and you too can get a free iordy field to
1401 * process. However its the speeds not the modes that
1402 * are supported... Note drivers using the timing API
1403 * will get this right anyway
1404 */
1405 }
1406
1407 mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;
Tejun Heofb21f0d2006-03-12 12:34:35 +09001408
Alan Coxb352e572006-08-10 18:52:12 +01001409 if (ata_id_is_cfa(id)) {
1410 /*
1411 * Process compact flash extended modes
1412 */
Sergei Shtylyov62afe5d2009-04-13 20:50:00 +04001413 int pio = (id[ATA_ID_CFA_MODES] >> 0) & 0x7;
1414 int dma = (id[ATA_ID_CFA_MODES] >> 3) & 0x7;
Alan Coxb352e572006-08-10 18:52:12 +01001415
1416 if (pio)
1417 pio_mask |= (1 << 5);
1418 if (pio > 1)
1419 pio_mask |= (1 << 6);
1420 if (dma)
1421 mwdma_mask |= (1 << 3);
1422 if (dma > 1)
1423 mwdma_mask |= (1 << 4);
1424 }
1425
Tejun Heofb21f0d2006-03-12 12:34:35 +09001426 udma_mask = 0;
1427 if (id[ATA_ID_FIELD_VALID] & (1 << 2))
1428 udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;
Tejun Heocb95d562006-03-06 04:31:56 +09001429
1430 return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
1431}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001432EXPORT_SYMBOL_GPL(ata_id_xfermask);
Tejun Heocb95d562006-03-06 04:31:56 +09001433
Adrian Bunk7102d232007-01-04 00:09:36 +01001434static void ata_qc_complete_internal(struct ata_queued_cmd *qc)
Tejun Heoa2a7a662005-12-13 14:48:31 +09001435{
Tejun Heo77853bf2006-01-23 13:09:36 +09001436 struct completion *waiting = qc->private_data;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001437
Tejun Heoa2a7a662005-12-13 14:48:31 +09001438 complete(waiting);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001439}
1440
1441/**
Tejun Heo24326972006-11-14 22:47:09 +09001442 * ata_exec_internal_sg - execute libata internal command
Tejun Heoa2a7a662005-12-13 14:48:31 +09001443 * @dev: Device to which the command is sent
1444 * @tf: Taskfile registers for the command and the result
Tejun Heod69cf372006-04-02 18:51:53 +09001445 * @cdb: CDB for packet command
Masanari Iidae2278672014-02-18 22:54:36 +09001446 * @dma_dir: Data transfer direction of the command
Randy Dunlap5c1ad8b2007-10-18 14:12:26 -07001447 * @sgl: sg list for the data buffer of the command
Tejun Heo24326972006-11-14 22:47:09 +09001448 * @n_elem: Number of sg entries
Tejun Heo2b789102007-10-09 15:05:44 +09001449 * @timeout: Timeout in msecs (0 for default)
Tejun Heoa2a7a662005-12-13 14:48:31 +09001450 *
1451 * Executes libata internal command with timeout. @tf contains
1452 * command on entry and result on return. Timeout and error
1453 * conditions are reported via return value. No recovery action
1454 * is taken after a command times out. It's caller's duty to
1455 * clean up after timeout.
1456 *
1457 * LOCKING:
1458 * None. Should be called with kernel context, might sleep.
Tejun Heo551e8882006-06-12 14:09:49 +09001459 *
1460 * RETURNS:
1461 * Zero on success, AC_ERR_* mask on failure
Tejun Heoa2a7a662005-12-13 14:48:31 +09001462 */
Tejun Heo24326972006-11-14 22:47:09 +09001463unsigned ata_exec_internal_sg(struct ata_device *dev,
1464 struct ata_taskfile *tf, const u8 *cdb,
Jens Axboe87260212007-10-16 11:14:12 +02001465 int dma_dir, struct scatterlist *sgl,
Tejun Heo2b789102007-10-09 15:05:44 +09001466 unsigned int n_elem, unsigned long timeout)
Tejun Heoa2a7a662005-12-13 14:48:31 +09001467{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001468 struct ata_link *link = dev->link;
1469 struct ata_port *ap = link->ap;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001470 u8 command = tf->command;
Tejun Heo87fbc5a2008-05-20 02:17:54 +09001471 int auto_timeout = 0;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001472 struct ata_queued_cmd *qc;
Jens Axboe28361c42018-05-11 12:51:09 -06001473 unsigned int preempted_tag;
Jens Axboee3ed89392018-05-11 12:51:05 -06001474 u32 preempted_sactive;
1475 u64 preempted_qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +09001476 int preempted_nr_active_links;
Ingo Molnar60be6b92006-07-03 00:25:26 -07001477 DECLARE_COMPLETION_ONSTACK(wait);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001478 unsigned long flags;
Tejun Heo77853bf2006-01-23 13:09:36 +09001479 unsigned int err_mask;
Tejun Heod95a7172006-05-15 20:58:14 +09001480 int rc;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001481
Jeff Garzikba6a1302006-06-22 23:46:10 -04001482 spin_lock_irqsave(ap->lock, flags);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001483
Tejun Heoe3180492006-05-15 20:58:09 +09001484 /* no internal command while frozen */
Tejun Heob51e9e52006-06-29 01:29:30 +09001485 if (ap->pflags & ATA_PFLAG_FROZEN) {
Jeff Garzikba6a1302006-06-22 23:46:10 -04001486 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heoe3180492006-05-15 20:58:09 +09001487 return AC_ERR_SYSTEM;
1488 }
1489
Tejun Heo2ab7db12006-05-15 20:58:02 +09001490 /* initialize internal qc */
Jens Axboe28361c42018-05-11 12:51:09 -06001491 qc = __ata_qc_from_tag(ap, ATA_TAG_INTERNAL);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001492
Jens Axboe28361c42018-05-11 12:51:09 -06001493 qc->tag = ATA_TAG_INTERNAL;
1494 qc->hw_tag = 0;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001495 qc->scsicmd = NULL;
1496 qc->ap = ap;
1497 qc->dev = dev;
1498 ata_qc_reinit(qc);
1499
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001500 preempted_tag = link->active_tag;
1501 preempted_sactive = link->sactive;
Tejun Heodedaf2b2006-05-15 21:03:43 +09001502 preempted_qc_active = ap->qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +09001503 preempted_nr_active_links = ap->nr_active_links;
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001504 link->active_tag = ATA_TAG_POISON;
1505 link->sactive = 0;
Tejun Heodedaf2b2006-05-15 21:03:43 +09001506 ap->qc_active = 0;
Tejun Heoda917d62007-09-23 13:14:12 +09001507 ap->nr_active_links = 0;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001508
1509 /* prepare & issue qc */
Tejun Heoa2a7a662005-12-13 14:48:31 +09001510 qc->tf = *tf;
Tejun Heod69cf372006-04-02 18:51:53 +09001511 if (cdb)
1512 memcpy(qc->cdb, cdb, ATAPI_CDB_LEN);
Vincent Pelletiere7714512013-05-18 18:44:04 +02001513
1514 /* some SATA bridges need us to indicate data xfer direction */
1515 if (tf->protocol == ATAPI_PROT_DMA && (dev->flags & ATA_DFLAG_DMADIR) &&
1516 dma_dir == DMA_FROM_DEVICE)
1517 qc->tf.feature |= ATAPI_DMADIR;
1518
Tejun Heoe61e0672006-05-15 20:57:40 +09001519 qc->flags |= ATA_QCFLAG_RESULT_TF;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001520 qc->dma_dir = dma_dir;
1521 if (dma_dir != DMA_NONE) {
Tejun Heo24326972006-11-14 22:47:09 +09001522 unsigned int i, buflen = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001523 struct scatterlist *sg;
Tejun Heo24326972006-11-14 22:47:09 +09001524
Jens Axboe87260212007-10-16 11:14:12 +02001525 for_each_sg(sgl, sg, n_elem, i)
1526 buflen += sg->length;
Tejun Heo24326972006-11-14 22:47:09 +09001527
Jens Axboe87260212007-10-16 11:14:12 +02001528 ata_sg_init(qc, sgl, n_elem);
Brian King49c80422007-01-30 11:32:26 -06001529 qc->nbytes = buflen;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001530 }
1531
Tejun Heo77853bf2006-01-23 13:09:36 +09001532 qc->private_data = &wait;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001533 qc->complete_fn = ata_qc_complete_internal;
1534
Tejun Heo8e0e6942006-03-31 20:41:11 +09001535 ata_qc_issue(qc);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001536
Jeff Garzikba6a1302006-06-22 23:46:10 -04001537 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001538
Tejun Heo87fbc5a2008-05-20 02:17:54 +09001539 if (!timeout) {
1540 if (ata_probe_timeout)
1541 timeout = ata_probe_timeout * 1000;
1542 else {
1543 timeout = ata_internal_cmd_timeout(dev, command);
1544 auto_timeout = 1;
1545 }
1546 }
Tejun Heo2b789102007-10-09 15:05:44 +09001547
Tejun Heoc0c362b2010-09-06 17:57:14 +02001548 if (ap->ops->error_handler)
1549 ata_eh_release(ap);
1550
Tejun Heo2b789102007-10-09 15:05:44 +09001551 rc = wait_for_completion_timeout(&wait, msecs_to_jiffies(timeout));
Albert Lee41ade502006-03-14 11:19:04 +08001552
Tejun Heoc0c362b2010-09-06 17:57:14 +02001553 if (ap->ops->error_handler)
1554 ata_eh_acquire(ap);
1555
Tejun Heoc4291372010-05-10 21:41:38 +02001556 ata_sff_flush_pio_task(ap);
Tejun Heod95a7172006-05-15 20:58:14 +09001557
1558 if (!rc) {
Jeff Garzikba6a1302006-06-22 23:46:10 -04001559 spin_lock_irqsave(ap->lock, flags);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001560
1561 /* We're racing with irq here. If we lose, the
1562 * following test prevents us from completing the qc
Tejun Heod95a7172006-05-15 20:58:14 +09001563 * twice. If we win, the port is frozen and will be
1564 * cleaned up by ->post_internal_cmd().
Tejun Heoa2a7a662005-12-13 14:48:31 +09001565 */
Tejun Heo77853bf2006-01-23 13:09:36 +09001566 if (qc->flags & ATA_QCFLAG_ACTIVE) {
Tejun Heod95a7172006-05-15 20:58:14 +09001567 qc->err_mask |= AC_ERR_TIMEOUT;
1568
1569 if (ap->ops->error_handler)
1570 ata_port_freeze(ap);
1571 else
1572 ata_qc_complete(qc);
Tejun Heof15a1da2006-05-15 20:57:56 +09001573
Hannes Reinecke16d42462021-12-21 08:21:04 +01001574 ata_dev_warn(dev, "qc timeout (cmd 0x%x)\n",
1575 command);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001576 }
1577
Jeff Garzikba6a1302006-06-22 23:46:10 -04001578 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heoa2a7a662005-12-13 14:48:31 +09001579 }
1580
Tejun Heod95a7172006-05-15 20:58:14 +09001581 /* do post_internal_cmd */
1582 if (ap->ops->post_internal_cmd)
1583 ap->ops->post_internal_cmd(qc);
1584
Tejun Heoa51d6442007-03-20 15:24:11 +09001585 /* perform minimal error analysis */
1586 if (qc->flags & ATA_QCFLAG_FAILED) {
1587 if (qc->result_tf.command & (ATA_ERR | ATA_DF))
1588 qc->err_mask |= AC_ERR_DEV;
1589
1590 if (!qc->err_mask)
1591 qc->err_mask |= AC_ERR_OTHER;
1592
1593 if (qc->err_mask & ~AC_ERR_OTHER)
1594 qc->err_mask &= ~AC_ERR_OTHER;
Damien Le Moal2dae9952016-12-19 10:17:40 +09001595 } else if (qc->tf.command == ATA_CMD_REQ_SENSE_DATA) {
1596 qc->result_tf.command |= ATA_SENSE;
Tejun Heod95a7172006-05-15 20:58:14 +09001597 }
1598
Tejun Heo15869302006-05-15 20:57:33 +09001599 /* finish up */
Jeff Garzikba6a1302006-06-22 23:46:10 -04001600 spin_lock_irqsave(ap->lock, flags);
Tejun Heo15869302006-05-15 20:57:33 +09001601
Tejun Heoe61e0672006-05-15 20:57:40 +09001602 *tf = qc->result_tf;
Tejun Heo77853bf2006-01-23 13:09:36 +09001603 err_mask = qc->err_mask;
1604
1605 ata_qc_free(qc);
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001606 link->active_tag = preempted_tag;
1607 link->sactive = preempted_sactive;
Tejun Heodedaf2b2006-05-15 21:03:43 +09001608 ap->qc_active = preempted_qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +09001609 ap->nr_active_links = preempted_nr_active_links;
Tejun Heo77853bf2006-01-23 13:09:36 +09001610
Jeff Garzikba6a1302006-06-22 23:46:10 -04001611 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo15869302006-05-15 20:57:33 +09001612
Tejun Heo87fbc5a2008-05-20 02:17:54 +09001613 if ((err_mask & AC_ERR_TIMEOUT) && auto_timeout)
1614 ata_internal_cmd_timed_out(dev, command);
1615
Tejun Heo77853bf2006-01-23 13:09:36 +09001616 return err_mask;
Tejun Heoa2a7a662005-12-13 14:48:31 +09001617}
1618
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619/**
Tejun Heo33480a02006-12-12 02:15:31 +09001620 * ata_exec_internal - execute libata internal command
Tejun Heo24326972006-11-14 22:47:09 +09001621 * @dev: Device to which the command is sent
1622 * @tf: Taskfile registers for the command and the result
1623 * @cdb: CDB for packet command
Masanari Iidae2278672014-02-18 22:54:36 +09001624 * @dma_dir: Data transfer direction of the command
Tejun Heo24326972006-11-14 22:47:09 +09001625 * @buf: Data buffer of the command
1626 * @buflen: Length of data buffer
Tejun Heo2b789102007-10-09 15:05:44 +09001627 * @timeout: Timeout in msecs (0 for default)
Tejun Heo24326972006-11-14 22:47:09 +09001628 *
1629 * Wrapper around ata_exec_internal_sg() which takes simple
1630 * buffer instead of sg list.
1631 *
1632 * LOCKING:
1633 * None. Should be called with kernel context, might sleep.
1634 *
1635 * RETURNS:
1636 * Zero on success, AC_ERR_* mask on failure
1637 */
1638unsigned ata_exec_internal(struct ata_device *dev,
1639 struct ata_taskfile *tf, const u8 *cdb,
Tejun Heo2b789102007-10-09 15:05:44 +09001640 int dma_dir, void *buf, unsigned int buflen,
1641 unsigned long timeout)
Tejun Heo24326972006-11-14 22:47:09 +09001642{
Tejun Heo33480a02006-12-12 02:15:31 +09001643 struct scatterlist *psg = NULL, sg;
1644 unsigned int n_elem = 0;
Tejun Heo24326972006-11-14 22:47:09 +09001645
Tejun Heo33480a02006-12-12 02:15:31 +09001646 if (dma_dir != DMA_NONE) {
1647 WARN_ON(!buf);
1648 sg_init_one(&sg, buf, buflen);
1649 psg = &sg;
1650 n_elem++;
1651 }
Tejun Heo24326972006-11-14 22:47:09 +09001652
Tejun Heo2b789102007-10-09 15:05:44 +09001653 return ata_exec_internal_sg(dev, tf, cdb, dma_dir, psg, n_elem,
1654 timeout);
Tejun Heo24326972006-11-14 22:47:09 +09001655}
1656
1657/**
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001658 * ata_pio_need_iordy - check if iordy needed
1659 * @adev: ATA device
1660 *
1661 * Check if the current speed of the device requires IORDY. Used
1662 * by various controllers for chip configuration.
1663 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001664unsigned int ata_pio_need_iordy(const struct ata_device *adev)
1665{
Tejun Heo0d9e6652009-06-11 11:04:45 +09001666 /* Don't set IORDY if we're preparing for reset. IORDY may
1667 * lead to controller lock up on certain controllers if the
1668 * port is not occupied. See bko#11703 for details.
1669 */
1670 if (adev->link->ap->pflags & ATA_PFLAG_RESETTING)
1671 return 0;
1672 /* Controller doesn't support IORDY. Probably a pointless
1673 * check as the caller should know this.
1674 */
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001675 if (adev->link->ap->flags & ATA_FLAG_NO_IORDY)
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001676 return 0;
David Daney5c18c4d2008-12-10 15:39:12 -08001677 /* CF spec. r4.1 Table 22 says no iordy on PIO5 and PIO6. */
1678 if (ata_id_is_cfa(adev->id)
1679 && (adev->pio_mode == XFER_PIO_5 || adev->pio_mode == XFER_PIO_6))
1680 return 0;
Alan Cox432729f2007-03-08 23:22:59 +00001681 /* PIO3 and higher it is mandatory */
1682 if (adev->pio_mode > XFER_PIO_2)
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001683 return 1;
Alan Cox432729f2007-03-08 23:22:59 +00001684 /* We turn it on when possible */
1685 if (ata_id_has_iordy(adev->id))
1686 return 1;
1687 return 0;
1688}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001689EXPORT_SYMBOL_GPL(ata_pio_need_iordy);
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001690
Alan Cox432729f2007-03-08 23:22:59 +00001691/**
1692 * ata_pio_mask_no_iordy - Return the non IORDY mask
1693 * @adev: ATA device
1694 *
1695 * Compute the highest mode possible if we are not using iordy. Return
1696 * -1 if no iordy mode is available.
1697 */
Alan Cox432729f2007-03-08 23:22:59 +00001698static u32 ata_pio_mask_no_iordy(const struct ata_device *adev)
1699{
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001700 /* If we have no drive specific rule, then PIO 2 is non IORDY */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001701 if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
Alan Cox432729f2007-03-08 23:22:59 +00001702 u16 pio = adev->id[ATA_ID_EIDE_PIO];
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001703 /* Is the speed faster than the drive allows non IORDY ? */
1704 if (pio) {
1705 /* This is cycle times not frequency - watch the logic! */
1706 if (pio > 240) /* PIO2 is 240nS per cycle */
Alan Cox432729f2007-03-08 23:22:59 +00001707 return 3 << ATA_SHIFT_PIO;
1708 return 7 << ATA_SHIFT_PIO;
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001709 }
1710 }
Alan Cox432729f2007-03-08 23:22:59 +00001711 return 3 << ATA_SHIFT_PIO;
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001712}
1713
1714/**
Alan Cox963e4972008-07-24 17:16:06 +01001715 * ata_do_dev_read_id - default ID read method
1716 * @dev: device
1717 * @tf: proposed taskfile
1718 * @id: data buffer
1719 *
1720 * Issue the identify taskfile and hand back the buffer containing
1721 * identify data. For some RAID controllers and for pre ATA devices
1722 * this function is wrapped or replaced by the driver
1723 */
1724unsigned int ata_do_dev_read_id(struct ata_device *dev,
Damien Le Moal0561e512022-01-04 17:54:18 +09001725 struct ata_taskfile *tf, __le16 *id)
Alan Cox963e4972008-07-24 17:16:06 +01001726{
1727 return ata_exec_internal(dev, tf, NULL, DMA_FROM_DEVICE,
1728 id, sizeof(id[0]) * ATA_ID_WORDS, 0);
1729}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01001730EXPORT_SYMBOL_GPL(ata_do_dev_read_id);
Alan Cox963e4972008-07-24 17:16:06 +01001731
1732/**
Tejun Heo49016ac2006-02-21 02:12:11 +09001733 * ata_dev_read_id - Read ID data from the specified device
Tejun Heo49016ac2006-02-21 02:12:11 +09001734 * @dev: target device
1735 * @p_class: pointer to class of the target device (may be changed)
Tejun Heobff04642006-11-10 18:08:10 +09001736 * @flags: ATA_READID_* flags
Tejun Heofe635c72006-05-15 20:57:35 +09001737 * @id: buffer to read IDENTIFY data into
Tejun Heo49016ac2006-02-21 02:12:11 +09001738 *
1739 * Read ID data from the specified device. ATA_CMD_ID_ATA is
1740 * performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
Tejun Heoaec5c3c2006-03-25 01:33:34 +09001741 * devices. This function also issues ATA_CMD_INIT_DEV_PARAMS
1742 * for pre-ATA4 drives.
Tejun Heo49016ac2006-02-21 02:12:11 +09001743 *
Alan Cox50a99012007-08-08 14:27:00 +01001744 * FIXME: ATA_CMD_ID_ATA is optional for early drives and right
Jeff Garzik2dcb4072007-10-19 06:42:56 -04001745 * now we abort if we hit that case.
Alan Cox50a99012007-08-08 14:27:00 +01001746 *
Tejun Heo49016ac2006-02-21 02:12:11 +09001747 * LOCKING:
1748 * Kernel thread context (may sleep)
1749 *
1750 * RETURNS:
1751 * 0 on success, -errno otherwise.
1752 */
Tejun Heoa9beec92006-05-31 18:27:44 +09001753int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
Tejun Heobff04642006-11-10 18:08:10 +09001754 unsigned int flags, u16 *id)
Tejun Heo49016ac2006-02-21 02:12:11 +09001755{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001756 struct ata_port *ap = dev->link->ap;
Tejun Heo49016ac2006-02-21 02:12:11 +09001757 unsigned int class = *p_class;
Tejun Heo49016ac2006-02-21 02:12:11 +09001758 struct ata_taskfile tf;
1759 unsigned int err_mask = 0;
1760 const char *reason;
Tejun Heo79b42ba2009-04-15 06:21:10 +09001761 bool is_semb = class == ATA_DEV_SEMB;
Tejun Heo54936f82007-05-11 14:35:29 +02001762 int may_fallback = 1, tried_spinup = 0;
Tejun Heo49016ac2006-02-21 02:12:11 +09001763 int rc;
1764
Alan Cox963e4972008-07-24 17:16:06 +01001765retry:
Tejun Heo3373efd2006-05-15 20:57:53 +09001766 ata_tf_init(dev, &tf);
Tejun Heo49016ac2006-02-21 02:12:11 +09001767
1768 switch (class) {
Tejun Heo79b42ba2009-04-15 06:21:10 +09001769 case ATA_DEV_SEMB:
1770 class = ATA_DEV_ATA; /* some hard drives report SEMB sig */
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001771 fallthrough;
Tejun Heo49016ac2006-02-21 02:12:11 +09001772 case ATA_DEV_ATA:
Hannes Reinecke9162c652014-11-05 13:08:21 +01001773 case ATA_DEV_ZAC:
Tejun Heo49016ac2006-02-21 02:12:11 +09001774 tf.command = ATA_CMD_ID_ATA;
1775 break;
1776 case ATA_DEV_ATAPI:
1777 tf.command = ATA_CMD_ID_ATAPI;
1778 break;
1779 default:
1780 rc = -ENODEV;
1781 reason = "unsupported class";
1782 goto err_out;
1783 }
1784
1785 tf.protocol = ATA_PROT_PIO;
Tejun Heo81afe892007-02-07 12:37:41 -08001786
1787 /* Some devices choke if TF registers contain garbage. Make
1788 * sure those are properly initialized.
1789 */
1790 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1791
1792 /* Device presence detection is unreliable on some
1793 * controllers. Always poll IDENTIFY if available.
1794 */
1795 tf.flags |= ATA_TFLAG_POLLING;
Tejun Heo49016ac2006-02-21 02:12:11 +09001796
Alan Cox963e4972008-07-24 17:16:06 +01001797 if (ap->ops->read_id)
Damien Le Moal0561e512022-01-04 17:54:18 +09001798 err_mask = ap->ops->read_id(dev, &tf, (__le16 *)id);
Alan Cox963e4972008-07-24 17:16:06 +01001799 else
Damien Le Moal0561e512022-01-04 17:54:18 +09001800 err_mask = ata_do_dev_read_id(dev, &tf, (__le16 *)id);
Alan Cox963e4972008-07-24 17:16:06 +01001801
Tejun Heo49016ac2006-02-21 02:12:11 +09001802 if (err_mask) {
Tejun Heo800b3992006-12-03 21:34:13 +09001803 if (err_mask & AC_ERR_NODEV_HINT) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001804 ata_dev_dbg(dev, "NODEV after polling detection\n");
Tejun Heo55a8e2c2006-11-10 18:08:10 +09001805 return -ENOENT;
1806 }
1807
Tejun Heo79b42ba2009-04-15 06:21:10 +09001808 if (is_semb) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07001809 ata_dev_info(dev,
1810 "IDENTIFY failed on device w/ SEMB sig, disabled\n");
Tejun Heo79b42ba2009-04-15 06:21:10 +09001811 /* SEMB is not supported yet */
1812 *p_class = ATA_DEV_SEMB_UNSUP;
1813 return 0;
1814 }
1815
Tejun Heo1ffc1512008-03-23 15:16:53 +09001816 if ((err_mask == AC_ERR_DEV) && (tf.feature & ATA_ABORTED)) {
1817 /* Device or controller might have reported
1818 * the wrong device class. Give a shot at the
1819 * other IDENTIFY if the current one is
1820 * aborted by the device.
1821 */
1822 if (may_fallback) {
1823 may_fallback = 0;
Tejun Heo54936f82007-05-11 14:35:29 +02001824
Tejun Heo1ffc1512008-03-23 15:16:53 +09001825 if (class == ATA_DEV_ATA)
1826 class = ATA_DEV_ATAPI;
1827 else
1828 class = ATA_DEV_ATA;
1829 goto retry;
1830 }
1831
1832 /* Control reaches here iff the device aborted
1833 * both flavors of IDENTIFYs which happens
1834 * sometimes with phantom devices.
1835 */
Joe Perchesa9a79df2011-04-15 15:51:59 -07001836 ata_dev_dbg(dev,
1837 "both IDENTIFYs aborted, assuming NODEV\n");
Tejun Heo1ffc1512008-03-23 15:16:53 +09001838 return -ENOENT;
Tejun Heo54936f82007-05-11 14:35:29 +02001839 }
1840
Tejun Heo49016ac2006-02-21 02:12:11 +09001841 rc = -EIO;
1842 reason = "I/O error";
Tejun Heo49016ac2006-02-21 02:12:11 +09001843 goto err_out;
1844 }
1845
Tejun Heo43c9c592010-05-23 12:59:11 +02001846 if (dev->horkage & ATA_HORKAGE_DUMP_ID) {
Hannes Reinecke4baa5742021-12-21 08:20:28 +01001847 ata_dev_info(dev, "dumping IDENTIFY data, "
Joe Perchesa9a79df2011-04-15 15:51:59 -07001848 "class=%d may_fallback=%d tried_spinup=%d\n",
1849 class, may_fallback, tried_spinup);
Hannes Reinecke4baa5742021-12-21 08:20:28 +01001850 print_hex_dump(KERN_INFO, "", DUMP_PREFIX_OFFSET,
Tejun Heo43c9c592010-05-23 12:59:11 +02001851 16, 2, id, ATA_ID_WORDS * sizeof(*id), true);
1852 }
1853
Tejun Heo54936f82007-05-11 14:35:29 +02001854 /* Falling back doesn't make sense if ID data was read
1855 * successfully at least once.
1856 */
1857 may_fallback = 0;
1858
Tejun Heo49016ac2006-02-21 02:12:11 +09001859 swap_buf_le16(id, ATA_ID_WORDS);
1860
Tejun Heo49016ac2006-02-21 02:12:11 +09001861 /* sanity check */
Tejun Heoa4f57492006-09-12 20:35:49 -07001862 rc = -EINVAL;
Alan Cox60700682007-06-07 16:13:55 +01001863 reason = "device reports invalid type";
Tejun Heoa4f57492006-09-12 20:35:49 -07001864
Hannes Reinecke9162c652014-11-05 13:08:21 +01001865 if (class == ATA_DEV_ATA || class == ATA_DEV_ZAC) {
Tejun Heoa4f57492006-09-12 20:35:49 -07001866 if (!ata_id_is_ata(id) && !ata_id_is_cfa(id))
1867 goto err_out;
Andy Whitcroftdb63a4c2012-05-04 22:15:10 +01001868 if (ap->host->flags & ATA_HOST_IGNORE_ATA &&
1869 ata_id_is_ata(id)) {
1870 ata_dev_dbg(dev,
1871 "host indicates ignore ATA devices, ignored\n");
1872 return -ENOENT;
1873 }
Tejun Heoa4f57492006-09-12 20:35:49 -07001874 } else {
1875 if (ata_id_is_ata(id))
1876 goto err_out;
Tejun Heo49016ac2006-02-21 02:12:11 +09001877 }
1878
Mark Lord169439c2007-04-17 18:26:07 -04001879 if (!tried_spinup && (id[2] == 0x37c8 || id[2] == 0x738c)) {
1880 tried_spinup = 1;
1881 /*
1882 * Drive powered-up in standby mode, and requires a specific
1883 * SET_FEATURES spin-up subcommand before it will accept
1884 * anything other than the original IDENTIFY command.
1885 */
Jeff Garzik218f3d32007-10-25 00:33:27 -04001886 err_mask = ata_dev_set_feature(dev, SETFEATURES_SPINUP, 0);
Ryan Powerfb0582f92007-08-10 13:59:35 -07001887 if (err_mask && id[2] != 0x738c) {
Mark Lord169439c2007-04-17 18:26:07 -04001888 rc = -EIO;
1889 reason = "SPINUP failed";
1890 goto err_out;
1891 }
1892 /*
1893 * If the drive initially returned incomplete IDENTIFY info,
1894 * we now must reissue the IDENTIFY command.
1895 */
1896 if (id[2] == 0x37c8)
1897 goto retry;
1898 }
1899
Hannes Reinecke9162c652014-11-05 13:08:21 +01001900 if ((flags & ATA_READID_POSTRESET) &&
1901 (class == ATA_DEV_ATA || class == ATA_DEV_ZAC)) {
Tejun Heo49016ac2006-02-21 02:12:11 +09001902 /*
1903 * The exact sequence expected by certain pre-ATA4 drives is:
1904 * SRST RESET
Alan Cox50a99012007-08-08 14:27:00 +01001905 * IDENTIFY (optional in early ATA)
1906 * INITIALIZE DEVICE PARAMETERS (later IDE and ATA)
Tejun Heo49016ac2006-02-21 02:12:11 +09001907 * anything else..
1908 * Some drives were very specific about that exact sequence.
Alan Cox50a99012007-08-08 14:27:00 +01001909 *
1910 * Note that ATA4 says lba is mandatory so the second check
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001911 * should never trigger.
Tejun Heo49016ac2006-02-21 02:12:11 +09001912 */
1913 if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
Tejun Heo3373efd2006-05-15 20:57:53 +09001914 err_mask = ata_dev_init_params(dev, id[3], id[6]);
Tejun Heo49016ac2006-02-21 02:12:11 +09001915 if (err_mask) {
1916 rc = -EIO;
1917 reason = "INIT_DEV_PARAMS failed";
1918 goto err_out;
1919 }
1920
1921 /* current CHS translation info (id[53-58]) might be
1922 * changed. reread the identify device info.
1923 */
Tejun Heobff04642006-11-10 18:08:10 +09001924 flags &= ~ATA_READID_POSTRESET;
Tejun Heo49016ac2006-02-21 02:12:11 +09001925 goto retry;
1926 }
1927 }
1928
1929 *p_class = class;
Tejun Heofe635c72006-05-15 20:57:35 +09001930
Tejun Heo49016ac2006-02-21 02:12:11 +09001931 return 0;
1932
1933 err_out:
Hannes Reinecke16d42462021-12-21 08:21:04 +01001934 ata_dev_warn(dev, "failed to IDENTIFY (%s, err_mask=0x%x)\n",
1935 reason, err_mask);
Tejun Heo49016ac2006-02-21 02:12:11 +09001936 return rc;
1937}
1938
Christoph Hellwigf01f62c2017-06-04 14:42:20 +02001939/**
1940 * ata_read_log_page - read a specific log page
1941 * @dev: target device
1942 * @log: log to read
1943 * @page: page to read
1944 * @buf: buffer to store read page
1945 * @sectors: number of sectors to read
1946 *
1947 * Read log page using READ_LOG_EXT command.
1948 *
1949 * LOCKING:
1950 * Kernel thread context (may sleep).
1951 *
1952 * RETURNS:
1953 * 0 on success, AC_ERR_* mask otherwise.
1954 */
1955unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
1956 u8 page, void *buf, unsigned int sectors)
1957{
1958 unsigned long ap_flags = dev->link->ap->flags;
1959 struct ata_taskfile tf;
1960 unsigned int err_mask;
1961 bool dma = false;
1962
Hannes Reinecke46337782021-12-21 08:20:37 +01001963 ata_dev_dbg(dev, "read log page - log 0x%x, page 0x%x\n", log, page);
Christoph Hellwigf01f62c2017-06-04 14:42:20 +02001964
1965 /*
1966 * Return error without actually issuing the command on controllers
1967 * which e.g. lockup on a read log page.
1968 */
1969 if (ap_flags & ATA_FLAG_NO_LOG_PAGE)
1970 return AC_ERR_DEV;
1971
1972retry:
1973 ata_tf_init(dev, &tf);
Reimar Döffingerf971a852021-10-12 08:27:44 +02001974 if (ata_dma_enabled(dev) && ata_id_has_read_log_dma_ext(dev->id) &&
Damien Le Moal7cfdfdc2017-07-10 14:45:20 +09001975 !(dev->horkage & ATA_HORKAGE_NO_DMA_LOG)) {
Christoph Hellwigf01f62c2017-06-04 14:42:20 +02001976 tf.command = ATA_CMD_READ_LOG_DMA_EXT;
1977 tf.protocol = ATA_PROT_DMA;
1978 dma = true;
1979 } else {
1980 tf.command = ATA_CMD_READ_LOG_EXT;
1981 tf.protocol = ATA_PROT_PIO;
1982 dma = false;
1983 }
1984 tf.lbal = log;
1985 tf.lbam = page;
1986 tf.nsect = sectors;
1987 tf.hob_nsect = sectors >> 8;
1988 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_LBA48 | ATA_TFLAG_DEVICE;
1989
1990 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_FROM_DEVICE,
1991 buf, sectors * ATA_SECT_SIZE, 0);
1992
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09001993 if (err_mask) {
1994 if (dma) {
1995 dev->horkage |= ATA_HORKAGE_NO_DMA_LOG;
1996 goto retry;
1997 }
Damien Le Moal23ef63d2021-11-15 12:37:46 +09001998 ata_dev_err(dev,
1999 "Read log 0x%02x page 0x%02x failed, Emask 0x%x\n",
2000 (unsigned int)log, (unsigned int)page, err_mask);
Christoph Hellwigf01f62c2017-06-04 14:42:20 +02002001 }
2002
Christoph Hellwigf01f62c2017-06-04 14:42:20 +02002003 return err_mask;
2004}
2005
Christoph Hellwigefe205a2017-06-04 14:42:21 +02002006static bool ata_log_supported(struct ata_device *dev, u8 log)
2007{
2008 struct ata_port *ap = dev->link->ap;
2009
Anton Lundinac9f0c82022-02-03 10:41:35 +01002010 if (dev->horkage & ATA_HORKAGE_NO_LOG_DIR)
2011 return false;
2012
Christoph Hellwigefe205a2017-06-04 14:42:21 +02002013 if (ata_read_log_page(dev, ATA_LOG_DIRECTORY, 0, ap->sector_buf, 1))
2014 return false;
2015 return get_unaligned_le16(&ap->sector_buf[log * 2]) ? true : false;
2016}
2017
Christoph Hellwiga0fd2452017-06-04 14:42:23 +02002018static bool ata_identify_page_supported(struct ata_device *dev, u8 page)
2019{
2020 struct ata_port *ap = dev->link->ap;
2021 unsigned int err, i;
2022
Damien Le Moal636f6e22021-11-09 08:45:25 +09002023 if (dev->horkage & ATA_HORKAGE_NO_ID_DEV_LOG)
2024 return false;
2025
Christoph Hellwiga0fd2452017-06-04 14:42:23 +02002026 if (!ata_log_supported(dev, ATA_LOG_IDENTIFY_DEVICE)) {
Damien Le Moal636f6e22021-11-09 08:45:25 +09002027 /*
2028 * IDENTIFY DEVICE data log is defined as mandatory starting
2029 * with ACS-3 (ATA version 10). Warn about the missing log
2030 * for drives which implement this ATA level or above.
2031 */
2032 if (ata_id_major_version(dev->id) >= 10)
2033 ata_dev_warn(dev,
2034 "ATA Identify Device Log not supported\n");
2035 dev->horkage |= ATA_HORKAGE_NO_ID_DEV_LOG;
Christoph Hellwiga0fd2452017-06-04 14:42:23 +02002036 return false;
2037 }
2038
2039 /*
2040 * Read IDENTIFY DEVICE data log, page 0, to figure out if the page is
2041 * supported.
2042 */
2043 err = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE, 0, ap->sector_buf,
2044 1);
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09002045 if (err)
Christoph Hellwiga0fd2452017-06-04 14:42:23 +02002046 return false;
Christoph Hellwiga0fd2452017-06-04 14:42:23 +02002047
2048 for (i = 0; i < ap->sector_buf[8]; i++) {
2049 if (ap->sector_buf[9 + i] == page)
2050 return true;
2051 }
2052
2053 return false;
2054}
2055
Tejun Heo90627122009-01-29 20:31:36 +09002056static int ata_do_link_spd_horkage(struct ata_device *dev)
2057{
2058 struct ata_link *plink = ata_dev_phys_link(dev);
2059 u32 target, target_limit;
2060
2061 if (!sata_scr_valid(plink))
2062 return 0;
2063
2064 if (dev->horkage & ATA_HORKAGE_1_5_GBPS)
2065 target = 1;
2066 else
2067 return 0;
2068
2069 target_limit = (1 << target) - 1;
2070
2071 /* if already on stricter limit, no need to push further */
2072 if (plink->sata_spd_limit <= target_limit)
2073 return 0;
2074
2075 plink->sata_spd_limit = target_limit;
2076
2077 /* Request another EH round by returning -EAGAIN if link is
2078 * going faster than the target speed. Forward progress is
2079 * guaranteed by setting sata_spd_limit to target_limit above.
2080 */
2081 if (plink->sata_spd > target) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07002082 ata_dev_info(dev, "applying link speed limit horkage to %s\n",
2083 sata_spd_string(target));
Tejun Heo90627122009-01-29 20:31:36 +09002084 return -EAGAIN;
2085 }
2086 return 0;
2087}
2088
Tejun Heo3373efd2006-05-15 20:57:53 +09002089static inline u8 ata_dev_knobble(struct ata_device *dev)
Tejun Heo4b2f3ed2006-03-01 16:09:36 +09002090{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002091 struct ata_port *ap = dev->link->ap;
Jens Axboe9ce8e302008-08-27 15:23:18 +02002092
2093 if (ata_dev_blacklisted(dev) & ATA_HORKAGE_BRIDGE_OK)
2094 return 0;
2095
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002096 return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
Tejun Heo4b2f3ed2006-03-01 16:09:36 +09002097}
2098
Hannes Reinecke5a233552016-04-25 12:45:46 +02002099static void ata_dev_config_ncq_send_recv(struct ata_device *dev)
2100{
2101 struct ata_port *ap = dev->link->ap;
2102 unsigned int err_mask;
2103
Christoph Hellwigefe205a2017-06-04 14:42:21 +02002104 if (!ata_log_supported(dev, ATA_LOG_NCQ_SEND_RECV)) {
2105 ata_dev_warn(dev, "NCQ Send/Recv Log not supported\n");
Hannes Reineckefe5af0c2016-04-25 12:45:48 +02002106 return;
2107 }
Hannes Reinecke5a233552016-04-25 12:45:46 +02002108 err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_SEND_RECV,
2109 0, ap->sector_buf, 1);
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09002110 if (!err_mask) {
Hannes Reinecke5a233552016-04-25 12:45:46 +02002111 u8 *cmds = dev->ncq_send_recv_cmds;
2112
2113 dev->flags |= ATA_DFLAG_NCQ_SEND_RECV;
2114 memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_SEND_RECV_SIZE);
2115
2116 if (dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM) {
2117 ata_dev_dbg(dev, "disabling queued TRIM support\n");
2118 cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &=
2119 ~ATA_LOG_NCQ_SEND_RECV_DSM_TRIM;
2120 }
2121 }
2122}
2123
Hannes Reinecke284b3b72016-04-25 12:45:54 +02002124static void ata_dev_config_ncq_non_data(struct ata_device *dev)
2125{
2126 struct ata_port *ap = dev->link->ap;
2127 unsigned int err_mask;
Hannes Reinecke284b3b72016-04-25 12:45:54 +02002128
Christoph Hellwigefe205a2017-06-04 14:42:21 +02002129 if (!ata_log_supported(dev, ATA_LOG_NCQ_NON_DATA)) {
Hannes Reinecke284b3b72016-04-25 12:45:54 +02002130 ata_dev_warn(dev,
2131 "NCQ Send/Recv Log not supported\n");
2132 return;
2133 }
2134 err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_NON_DATA,
2135 0, ap->sector_buf, 1);
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09002136 if (!err_mask) {
Hannes Reinecke284b3b72016-04-25 12:45:54 +02002137 u8 *cmds = dev->ncq_non_data_cmds;
2138
2139 memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_NON_DATA_SIZE);
2140 }
2141}
2142
Adam Manzanares8e061782016-10-17 11:27:29 -07002143static void ata_dev_config_ncq_prio(struct ata_device *dev)
2144{
2145 struct ata_port *ap = dev->link->ap;
2146 unsigned int err_mask;
2147
Damien Le Moal06f6c4c2021-11-15 12:47:26 +09002148 if (!ata_identify_page_supported(dev, ATA_LOG_SATA_SETTINGS))
2149 return;
2150
Adam Manzanares8e061782016-10-17 11:27:29 -07002151 err_mask = ata_read_log_page(dev,
Christoph Hellwig1d51d5f2017-06-04 14:42:22 +02002152 ATA_LOG_IDENTIFY_DEVICE,
Adam Manzanares8e061782016-10-17 11:27:29 -07002153 ATA_LOG_SATA_SETTINGS,
2154 ap->sector_buf,
2155 1);
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09002156 if (err_mask)
Damien Le Moal2360fa12021-08-16 10:44:51 +09002157 goto not_supported;
Adam Manzanares8e061782016-10-17 11:27:29 -07002158
Damien Le Moal2360fa12021-08-16 10:44:51 +09002159 if (!(ap->sector_buf[ATA_LOG_NCQ_PRIO_OFFSET] & BIT(3)))
2160 goto not_supported;
Adam Manzanares8e061782016-10-17 11:27:29 -07002161
Damien Le Moal2360fa12021-08-16 10:44:51 +09002162 dev->flags |= ATA_DFLAG_NCQ_PRIO;
2163
2164 return;
2165
2166not_supported:
2167 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
2168 dev->flags &= ~ATA_DFLAG_NCQ_PRIO;
Adam Manzanares8e061782016-10-17 11:27:29 -07002169}
2170
Kate Hsuan7a8526a2021-09-03 17:44:11 +08002171static bool ata_dev_check_adapter(struct ata_device *dev,
2172 unsigned short vendor_id)
2173{
2174 struct pci_dev *pcidev = NULL;
2175 struct device *parent_dev = NULL;
2176
2177 for (parent_dev = dev->tdev.parent; parent_dev != NULL;
2178 parent_dev = parent_dev->parent) {
2179 if (dev_is_pci(parent_dev)) {
2180 pcidev = to_pci_dev(parent_dev);
2181 if (pcidev->vendor == vendor_id)
2182 return true;
2183 break;
2184 }
2185 }
2186
2187 return false;
2188}
2189
Shaohua Li388539f2009-07-27 09:24:35 +08002190static int ata_dev_config_ncq(struct ata_device *dev,
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002191 char *desc, size_t desc_sz)
2192{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002193 struct ata_port *ap = dev->link->ap;
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002194 int hdepth = 0, ddepth = ata_id_queue_depth(dev->id);
Shaohua Li388539f2009-07-27 09:24:35 +08002195 unsigned int err_mask;
2196 char *aa_desc = "";
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002197
2198 if (!ata_id_has_ncq(dev->id)) {
2199 desc[0] = '\0';
Shaohua Li388539f2009-07-27 09:24:35 +08002200 return 0;
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002201 }
Bartlomiej Zolnierkiewiczcba97ea2020-03-26 16:58:09 +01002202 if (!IS_ENABLED(CONFIG_SATA_HOST))
2203 return 0;
Tejun Heo75683fe2007-07-05 13:31:27 +09002204 if (dev->horkage & ATA_HORKAGE_NONCQ) {
Alan Cox6919a0a2006-10-27 19:08:46 -07002205 snprintf(desc, desc_sz, "NCQ (not used)");
Shaohua Li388539f2009-07-27 09:24:35 +08002206 return 0;
Alan Cox6919a0a2006-10-27 19:08:46 -07002207 }
Kate Hsuan7a8526a2021-09-03 17:44:11 +08002208
2209 if (dev->horkage & ATA_HORKAGE_NO_NCQ_ON_ATI &&
2210 ata_dev_check_adapter(dev, PCI_VENDOR_ID_ATI)) {
2211 snprintf(desc, desc_sz, "NCQ (not used)");
2212 return 0;
2213 }
2214
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002215 if (ap->flags & ATA_FLAG_NCQ) {
Jens Axboe69278f72018-05-11 12:51:10 -06002216 hdepth = min(ap->scsi_host->can_queue, ATA_MAX_QUEUE);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002217 dev->flags |= ATA_DFLAG_NCQ;
2218 }
2219
Shaohua Li388539f2009-07-27 09:24:35 +08002220 if (!(dev->horkage & ATA_HORKAGE_BROKEN_FPDMA_AA) &&
2221 (ap->flags & ATA_FLAG_FPDMA_AA) &&
2222 ata_id_has_fpdma_aa(dev->id)) {
2223 err_mask = ata_dev_set_feature(dev, SETFEATURES_SATA_ENABLE,
2224 SATA_FPDMA_AA);
2225 if (err_mask) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07002226 ata_dev_err(dev,
2227 "failed to enable AA (error_mask=0x%x)\n",
2228 err_mask);
Shaohua Li388539f2009-07-27 09:24:35 +08002229 if (err_mask != AC_ERR_DEV) {
2230 dev->horkage |= ATA_HORKAGE_BROKEN_FPDMA_AA;
2231 return -EIO;
2232 }
2233 } else
2234 aa_desc = ", AA";
2235 }
2236
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002237 if (hdepth >= ddepth)
Shaohua Li388539f2009-07-27 09:24:35 +08002238 snprintf(desc, desc_sz, "NCQ (depth %d)%s", ddepth, aa_desc);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002239 else
Shaohua Li388539f2009-07-27 09:24:35 +08002240 snprintf(desc, desc_sz, "NCQ (depth %d/%d)%s", hdepth,
2241 ddepth, aa_desc);
Marc Carinoed369112013-08-24 23:22:50 -07002242
Hannes Reinecke284b3b72016-04-25 12:45:54 +02002243 if ((ap->flags & ATA_FLAG_FPDMA_AUX)) {
2244 if (ata_id_has_ncq_send_and_recv(dev->id))
2245 ata_dev_config_ncq_send_recv(dev);
2246 if (ata_id_has_ncq_non_data(dev->id))
2247 ata_dev_config_ncq_non_data(dev);
Adam Manzanares8e061782016-10-17 11:27:29 -07002248 if (ata_id_has_ncq_prio(dev->id))
2249 ata_dev_config_ncq_prio(dev);
Marc Carinoed369112013-08-24 23:22:50 -07002250 }
2251
Shaohua Li388539f2009-07-27 09:24:35 +08002252 return 0;
Tejun Heoa6e6ce82006-05-15 21:03:48 +09002253}
2254
Hannes Reineckee87fd282016-04-04 11:43:55 +02002255static void ata_dev_config_sense_reporting(struct ata_device *dev)
2256{
2257 unsigned int err_mask;
2258
2259 if (!ata_id_has_sense_reporting(dev->id))
2260 return;
2261
2262 if (ata_id_sense_reporting_enabled(dev->id))
2263 return;
2264
2265 err_mask = ata_dev_set_feature(dev, SETFEATURE_SENSE_DATA, 0x1);
2266 if (err_mask) {
2267 ata_dev_dbg(dev,
2268 "failed to enable Sense Data Reporting, Emask 0x%x\n",
2269 err_mask);
2270 }
2271}
2272
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002273static void ata_dev_config_zac(struct ata_device *dev)
2274{
2275 struct ata_port *ap = dev->link->ap;
2276 unsigned int err_mask;
2277 u8 *identify_buf = ap->sector_buf;
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002278
2279 dev->zac_zones_optimal_open = U32_MAX;
2280 dev->zac_zones_optimal_nonseq = U32_MAX;
2281 dev->zac_zones_max_open = U32_MAX;
2282
2283 /*
2284 * Always set the 'ZAC' flag for Host-managed devices.
2285 */
2286 if (dev->class == ATA_DEV_ZAC)
2287 dev->flags |= ATA_DFLAG_ZAC;
2288 else if (ata_id_zoned_cap(dev->id) == 0x01)
2289 /*
2290 * Check for host-aware devices.
2291 */
2292 dev->flags |= ATA_DFLAG_ZAC;
2293
2294 if (!(dev->flags & ATA_DFLAG_ZAC))
2295 return;
2296
Christoph Hellwiga0fd2452017-06-04 14:42:23 +02002297 if (!ata_identify_page_supported(dev, ATA_LOG_ZONED_INFORMATION)) {
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002298 ata_dev_warn(dev,
2299 "ATA Zoned Information Log not supported\n");
2300 return;
2301 }
2302
2303 /*
2304 * Read IDENTIFY DEVICE data log, page 9 (Zoned-device information)
2305 */
Christoph Hellwig1d51d5f2017-06-04 14:42:22 +02002306 err_mask = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE,
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002307 ATA_LOG_ZONED_INFORMATION,
2308 identify_buf, 1);
2309 if (!err_mask) {
2310 u64 zoned_cap, opt_open, opt_nonseq, max_open;
2311
2312 zoned_cap = get_unaligned_le64(&identify_buf[8]);
2313 if ((zoned_cap >> 63))
2314 dev->zac_zoned_cap = (zoned_cap & 1);
2315 opt_open = get_unaligned_le64(&identify_buf[24]);
2316 if ((opt_open >> 63))
2317 dev->zac_zones_optimal_open = (u32)opt_open;
2318 opt_nonseq = get_unaligned_le64(&identify_buf[32]);
2319 if ((opt_nonseq >> 63))
2320 dev->zac_zones_optimal_nonseq = (u32)opt_nonseq;
2321 max_open = get_unaligned_le64(&identify_buf[40]);
2322 if ((max_open >> 63))
2323 dev->zac_zones_max_open = (u32)max_open;
2324 }
2325}
2326
Christoph Hellwig818831c2017-06-04 14:42:24 +02002327static void ata_dev_config_trusted(struct ata_device *dev)
2328{
2329 struct ata_port *ap = dev->link->ap;
2330 u64 trusted_cap;
2331 unsigned int err;
2332
Christoph Hellwige8f11db2017-08-29 14:42:06 +02002333 if (!ata_id_has_trusted(dev->id))
2334 return;
2335
Christoph Hellwig818831c2017-06-04 14:42:24 +02002336 if (!ata_identify_page_supported(dev, ATA_LOG_SECURITY)) {
2337 ata_dev_warn(dev,
2338 "Security Log not supported\n");
2339 return;
2340 }
2341
2342 err = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE, ATA_LOG_SECURITY,
2343 ap->sector_buf, 1);
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09002344 if (err)
Christoph Hellwig818831c2017-06-04 14:42:24 +02002345 return;
Christoph Hellwig818831c2017-06-04 14:42:24 +02002346
2347 trusted_cap = get_unaligned_le64(&ap->sector_buf[40]);
2348 if (!(trusted_cap & (1ULL << 63))) {
2349 ata_dev_dbg(dev,
2350 "Trusted Computing capability qword not valid!\n");
2351 return;
2352 }
2353
2354 if (trusted_cap & (1 << 0))
2355 dev->flags |= ATA_DFLAG_TRUSTED;
2356}
2357
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002358static int ata_dev_config_lba(struct ata_device *dev)
2359{
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002360 const u16 *id = dev->id;
2361 const char *lba_desc;
2362 char ncq_desc[24];
2363 int ret;
2364
2365 dev->flags |= ATA_DFLAG_LBA;
2366
2367 if (ata_id_has_lba48(id)) {
2368 lba_desc = "LBA48";
2369 dev->flags |= ATA_DFLAG_LBA48;
2370 if (dev->n_sectors >= (1UL << 28) &&
2371 ata_id_has_flush_ext(id))
2372 dev->flags |= ATA_DFLAG_FLUSH_EXT;
2373 } else {
2374 lba_desc = "LBA";
2375 }
2376
2377 /* config NCQ */
2378 ret = ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
2379
2380 /* print device info to dmesg */
Hannes Reinecke1c95a272021-12-21 08:21:07 +01002381 if (ata_dev_print_info(dev))
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002382 ata_dev_info(dev,
2383 "%llu sectors, multi %u: %s %s\n",
2384 (unsigned long long)dev->n_sectors,
2385 dev->multi_count, lba_desc, ncq_desc);
2386
2387 return ret;
2388}
2389
2390static void ata_dev_config_chs(struct ata_device *dev)
2391{
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002392 const u16 *id = dev->id;
2393
2394 if (ata_id_current_chs_valid(id)) {
2395 /* Current CHS translation is valid. */
2396 dev->cylinders = id[54];
2397 dev->heads = id[55];
2398 dev->sectors = id[56];
2399 } else {
2400 /* Default translation */
2401 dev->cylinders = id[1];
2402 dev->heads = id[3];
2403 dev->sectors = id[6];
2404 }
2405
2406 /* print device info to dmesg */
Hannes Reinecke1c95a272021-12-21 08:21:07 +01002407 if (ata_dev_print_info(dev))
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002408 ata_dev_info(dev,
2409 "%llu sectors, multi %u, CHS %u/%u/%u\n",
2410 (unsigned long long)dev->n_sectors,
2411 dev->multi_count, dev->cylinders,
2412 dev->heads, dev->sectors);
2413}
2414
Damien Le Moald8d87782021-08-16 10:44:49 +09002415static void ata_dev_config_devslp(struct ata_device *dev)
2416{
2417 u8 *sata_setting = dev->link->ap->sector_buf;
2418 unsigned int err_mask;
2419 int i, j;
2420
2421 /*
2422 * Check device sleep capability. Get DevSlp timing variables
2423 * from SATA Settings page of Identify Device Data Log.
2424 */
Damien Le Moal06f6c4c2021-11-15 12:47:26 +09002425 if (!ata_id_has_devslp(dev->id) ||
2426 !ata_identify_page_supported(dev, ATA_LOG_SATA_SETTINGS))
Damien Le Moald8d87782021-08-16 10:44:49 +09002427 return;
2428
2429 err_mask = ata_read_log_page(dev,
2430 ATA_LOG_IDENTIFY_DEVICE,
2431 ATA_LOG_SATA_SETTINGS,
2432 sata_setting, 1);
Damien Le Moalfc5c8aa2021-08-16 10:44:52 +09002433 if (err_mask)
Damien Le Moald8d87782021-08-16 10:44:49 +09002434 return;
Damien Le Moald8d87782021-08-16 10:44:49 +09002435
2436 dev->flags |= ATA_DFLAG_DEVSLP;
2437 for (i = 0; i < ATA_LOG_DEVSLP_SIZE; i++) {
2438 j = ATA_LOG_DEVSLP_OFFSET + i;
2439 dev->devslp_timing[i] = sata_setting[j];
2440 }
2441}
2442
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09002443static void ata_dev_config_cpr(struct ata_device *dev)
2444{
2445 unsigned int err_mask;
2446 size_t buf_len;
2447 int i, nr_cpr = 0;
2448 struct ata_cpr_log *cpr_log = NULL;
2449 u8 *desc, *buf = NULL;
2450
2451 if (!ata_identify_page_supported(dev,
2452 ATA_LOG_CONCURRENT_POSITIONING_RANGES))
2453 goto out;
2454
2455 /*
2456 * Read IDENTIFY DEVICE data log, page 0x47
2457 * (concurrent positioning ranges). We can have at most 255 32B range
2458 * descriptors plus a 64B header.
2459 */
2460 buf_len = (64 + 255 * 32 + 511) & ~511;
2461 buf = kzalloc(buf_len, GFP_KERNEL);
2462 if (!buf)
2463 goto out;
2464
2465 err_mask = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE,
2466 ATA_LOG_CONCURRENT_POSITIONING_RANGES,
2467 buf, buf_len >> 9);
2468 if (err_mask)
2469 goto out;
2470
2471 nr_cpr = buf[0];
2472 if (!nr_cpr)
2473 goto out;
2474
2475 cpr_log = kzalloc(struct_size(cpr_log, cpr, nr_cpr), GFP_KERNEL);
2476 if (!cpr_log)
2477 goto out;
2478
2479 cpr_log->nr_cpr = nr_cpr;
2480 desc = &buf[64];
2481 for (i = 0; i < nr_cpr; i++, desc += 32) {
2482 cpr_log->cpr[i].num = desc[0];
2483 cpr_log->cpr[i].num_storage_elements = desc[1];
2484 cpr_log->cpr[i].start_lba = get_unaligned_le64(&desc[8]);
2485 cpr_log->cpr[i].num_lbas = get_unaligned_le64(&desc[16]);
2486 }
2487
2488out:
2489 swap(dev->cpr_log, cpr_log);
2490 kfree(cpr_log);
2491 kfree(buf);
2492}
2493
Damien Le Moald633b8a2021-08-16 10:44:53 +09002494static void ata_dev_print_features(struct ata_device *dev)
2495{
2496 if (!(dev->flags & ATA_DFLAG_FEATURES_MASK))
2497 return;
2498
2499 ata_dev_info(dev,
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09002500 "Features:%s%s%s%s%s%s\n",
Damien Le Moald633b8a2021-08-16 10:44:53 +09002501 dev->flags & ATA_DFLAG_TRUSTED ? " Trust" : "",
2502 dev->flags & ATA_DFLAG_DA ? " Dev-Attention" : "",
2503 dev->flags & ATA_DFLAG_DEVSLP ? " Dev-Sleep" : "",
2504 dev->flags & ATA_DFLAG_NCQ_SEND_RECV ? " NCQ-sndrcv" : "",
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09002505 dev->flags & ATA_DFLAG_NCQ_PRIO ? " NCQ-prio" : "",
2506 dev->cpr_log ? " CPR" : "");
Damien Le Moald633b8a2021-08-16 10:44:53 +09002507}
2508
Tejun Heo49016ac2006-02-21 02:12:11 +09002509/**
Tejun Heoffeae412006-03-01 16:09:35 +09002510 * ata_dev_configure - Configure the specified ATA/ATAPI device
Tejun Heoffeae412006-03-01 16:09:35 +09002511 * @dev: Target device to configure
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 *
Tejun Heoffeae412006-03-01 16:09:35 +09002513 * Configure @dev according to @dev->id. Generic and low-level
2514 * driver specific fixups are also applied.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 *
2516 * LOCKING:
Tejun Heoffeae412006-03-01 16:09:35 +09002517 * Kernel thread context (may sleep)
2518 *
2519 * RETURNS:
2520 * 0 on success, -errno otherwise
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 */
Tejun Heoefdaedc2006-11-01 18:38:52 +09002522int ata_dev_configure(struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002524 struct ata_port *ap = dev->link->ap;
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002525 bool print_info = ata_dev_print_info(dev);
Tejun Heo1148c3a2006-03-13 19:48:04 +09002526 const u16 *id = dev->id;
Tejun Heo7dc951a2007-11-27 19:43:42 +09002527 unsigned long xfer_mask;
Shane Huang65fe1f02012-09-07 22:40:01 +08002528 unsigned int err_mask;
Alan Coxb352e572006-08-10 18:52:12 +01002529 char revbuf[7]; /* XYZ-99\0 */
Eric D. Mudama3f64f562007-01-30 23:00:40 -07002530 char fwrevbuf[ATA_ID_FW_REV_LEN+1];
2531 char modelbuf[ATA_ID_PROD_LEN+1];
Brian Kinge6d902a2006-06-28 08:30:31 -05002532 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533
Hannes Reinecke96c810f2021-12-21 08:21:06 +01002534 if (!ata_dev_enabled(dev)) {
2535 ata_dev_dbg(dev, "no device\n");
Tejun Heoffeae412006-03-01 16:09:35 +09002536 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 }
2538
Tejun Heo75683fe2007-07-05 13:31:27 +09002539 /* set horkage */
2540 dev->horkage |= ata_dev_blacklisted(dev);
Tejun Heo33267322008-02-13 09:15:09 +09002541 ata_force_horkage(dev);
Tejun Heo75683fe2007-07-05 13:31:27 +09002542
Tejun Heo50af2fa2008-05-19 01:15:14 +09002543 if (dev->horkage & ATA_HORKAGE_DISABLE) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07002544 ata_dev_info(dev, "unsupported device, disabling\n");
Tejun Heo50af2fa2008-05-19 01:15:14 +09002545 ata_dev_disable(dev);
2546 return 0;
2547 }
2548
Tejun Heo2486fa52008-07-31 07:52:40 +09002549 if ((!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) &&
2550 dev->class == ATA_DEV_ATAPI) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07002551 ata_dev_warn(dev, "WARNING: ATAPI is %s, device ignored\n",
2552 atapi_enabled ? "not supported with this driver"
2553 : "disabled");
Tejun Heo2486fa52008-07-31 07:52:40 +09002554 ata_dev_disable(dev);
2555 return 0;
2556 }
2557
Tejun Heo90627122009-01-29 20:31:36 +09002558 rc = ata_do_link_spd_horkage(dev);
2559 if (rc)
2560 return rc;
2561
Tejun Heoecd75ad2014-01-16 09:47:17 -05002562 /* some WD SATA-1 drives have issues with LPM, turn on NOLPM for them */
2563 if ((dev->horkage & ATA_HORKAGE_WD_BROKEN_LPM) &&
2564 (id[ATA_ID_SATA_CAPABILITY] & 0xe) == 0x2)
2565 dev->horkage |= ATA_HORKAGE_NOLPM;
2566
Hans de Goede240630e2018-07-01 12:15:46 +02002567 if (ap->flags & ATA_FLAG_NO_LPM)
2568 dev->horkage |= ATA_HORKAGE_NOLPM;
2569
Tejun Heoecd75ad2014-01-16 09:47:17 -05002570 if (dev->horkage & ATA_HORKAGE_NOLPM) {
2571 ata_dev_warn(dev, "LPM support broken, forcing max_power\n");
2572 dev->link->ap->target_lpm_policy = ATA_LPM_MAX_POWER;
2573 }
2574
Tejun Heo67465442007-05-15 03:28:16 +09002575 /* let ACPI work its magic */
2576 rc = ata_acpi_on_devcfg(dev);
2577 if (rc)
2578 return rc;
Kristen Carlson Accardi08573a82006-11-10 16:14:47 -08002579
Tejun Heo05027ad2007-09-03 12:32:57 +09002580 /* massage HPA, do it early as it might change IDENTIFY data */
2581 rc = ata_hpa_resize(dev);
2582 if (rc)
2583 return rc;
2584
Tejun Heoc39f5eb2006-03-13 19:51:19 +09002585 /* print device capabilities */
Hannes Reinecke17a1e1b2021-12-21 08:21:05 +01002586 ata_dev_dbg(dev,
2587 "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
2588 "85:%04x 86:%04x 87:%04x 88:%04x\n",
2589 __func__,
2590 id[49], id[82], id[83], id[84],
2591 id[85], id[86], id[87], id[88]);
Tejun Heoc39f5eb2006-03-13 19:51:19 +09002592
Tejun Heo208a9932006-03-05 17:55:58 +09002593 /* initialize to-be-configured parameters */
Tejun Heoea1dd4e2006-04-02 18:51:53 +09002594 dev->flags &= ~ATA_DFLAG_CFG_MASK;
Tejun Heo208a9932006-03-05 17:55:58 +09002595 dev->max_sectors = 0;
2596 dev->cdb_len = 0;
2597 dev->n_sectors = 0;
2598 dev->cylinders = 0;
2599 dev->heads = 0;
2600 dev->sectors = 0;
Mark Lorde18086d2009-03-19 13:32:21 -04002601 dev->multi_count = 0;
Tejun Heo208a9932006-03-05 17:55:58 +09002602
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 /*
2604 * common ATA, ATAPI feature tests
2605 */
2606
Tejun Heoff8854b2006-03-06 04:31:56 +09002607 /* find max transfer mode; for printk only */
Tejun Heo1148c3a2006-03-13 19:48:04 +09002608 xfer_mask = ata_id_xfermask(id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609
Hannes Reinecke6044f3c2021-12-21 08:20:27 +01002610 ata_dump_id(dev, id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611
Albert Leeef143d52007-06-05 13:01:33 +08002612 /* SCSI only uses 4-char revisions, dump full 8 chars from ATA */
2613 ata_id_c_string(dev->id, fwrevbuf, ATA_ID_FW_REV,
2614 sizeof(fwrevbuf));
2615
2616 ata_id_c_string(dev->id, modelbuf, ATA_ID_PROD,
2617 sizeof(modelbuf));
2618
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619 /* ATA-specific feature tests */
Hannes Reinecke9162c652014-11-05 13:08:21 +01002620 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
Alan Coxb352e572006-08-10 18:52:12 +01002621 if (ata_id_is_cfa(id)) {
Sergei Shtylyov62afe5d2009-04-13 20:50:00 +04002622 /* CPRM may make this media unusable */
2623 if (id[ATA_ID_CFA_KEY_MGMT] & 1)
Joe Perchesa9a79df2011-04-15 15:51:59 -07002624 ata_dev_warn(dev,
2625 "supports DRM functions and may not be fully accessible\n");
Alan Coxb352e572006-08-10 18:52:12 +01002626 snprintf(revbuf, 7, "CFA");
Alan Coxae8d4ee2007-11-04 22:05:49 -05002627 } else {
Jeff Garzik2dcb4072007-10-19 06:42:56 -04002628 snprintf(revbuf, 7, "ATA-%d", ata_id_major_version(id));
Alan Coxae8d4ee2007-11-04 22:05:49 -05002629 /* Warn the user if the device has TPM extensions */
2630 if (ata_id_has_tpm(id))
Joe Perchesa9a79df2011-04-15 15:51:59 -07002631 ata_dev_warn(dev,
2632 "supports DRM functions and may not be fully accessible\n");
Alan Coxae8d4ee2007-11-04 22:05:49 -05002633 }
Alan Coxb352e572006-08-10 18:52:12 +01002634
Tejun Heo1148c3a2006-03-13 19:48:04 +09002635 dev->n_sectors = ata_id_n_sectors(id);
Tejun Heo29407402006-02-12 22:47:04 +09002636
Mark Lorde18086d2009-03-19 13:32:21 -04002637 /* get current R/W Multiple count setting */
2638 if ((dev->id[47] >> 8) == 0x80 && (dev->id[59] & 0x100)) {
2639 unsigned int max = dev->id[47] & 0xff;
2640 unsigned int cnt = dev->id[59] & 0xff;
2641 /* only recognize/allow powers of two here */
2642 if (is_power_of_2(max) && is_power_of_2(cnt))
2643 if (cnt <= max)
2644 dev->multi_count = cnt;
2645 }
Eric D. Mudama3f64f562007-01-30 23:00:40 -07002646
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002647 /* print device info to dmesg */
Hannes Reinecke1c95a272021-12-21 08:21:07 +01002648 if (print_info)
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002649 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2650 revbuf, modelbuf, fwrevbuf,
2651 ata_mode_string(xfer_mask));
2652
Tejun Heo1148c3a2006-03-13 19:48:04 +09002653 if (ata_id_has_lba(id)) {
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002654 rc = ata_dev_config_lba(dev);
Shaohua Li388539f2009-07-27 09:24:35 +08002655 if (rc)
2656 return rc;
Tejun Heoffeae412006-03-01 16:09:35 +09002657 } else {
Damien Le Moal891fd7c2021-08-16 10:44:50 +09002658 ata_dev_config_chs(dev);
Albert Lee07f6f7d2005-11-01 19:33:20 +08002659 }
2660
Damien Le Moald8d87782021-08-16 10:44:49 +09002661 ata_dev_config_devslp(dev);
Hannes Reineckee87fd282016-04-04 11:43:55 +02002662 ata_dev_config_sense_reporting(dev);
Hannes Reinecke6d1003a2016-04-25 12:45:56 +02002663 ata_dev_config_zac(dev);
Christoph Hellwig818831c2017-06-04 14:42:24 +02002664 ata_dev_config_trusted(dev);
Damien Le Moalfe22e1c2021-10-27 11:22:21 +09002665 ata_dev_config_cpr(dev);
Minwoo Imb1ffbf82017-06-24 03:41:10 +09002666 dev->cdb_len = 32;
Damien Le Moald633b8a2021-08-16 10:44:53 +09002667
Hannes Reinecke1c95a272021-12-21 08:21:07 +01002668 if (print_info)
Damien Le Moald633b8a2021-08-16 10:44:53 +09002669 ata_dev_print_features(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670 }
2671
2672 /* ATAPI-specific feature tests */
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05002673 else if (dev->class == ATA_DEV_ATAPI) {
Tejun Heo854c73a2007-09-23 13:14:11 +09002674 const char *cdb_intr_string = "";
2675 const char *atapi_an_string = "";
Tejun Heo91163002008-02-21 13:25:50 +09002676 const char *dma_dir_string = "";
Tejun Heo7d77b242007-09-23 13:14:13 +09002677 u32 sntf;
Albert Lee08a556d2006-03-31 13:29:04 +08002678
Tejun Heo1148c3a2006-03-13 19:48:04 +09002679 rc = atapi_cdb_len(id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
Hannes Reinecke16d42462021-12-21 08:21:04 +01002681 ata_dev_warn(dev, "unsupported CDB len %d\n", rc);
Tejun Heoffeae412006-03-01 16:09:35 +09002682 rc = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 goto err_out_nosup;
2684 }
Tejun Heo6e7846e2006-02-12 23:32:58 +09002685 dev->cdb_len = (unsigned int) rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686
Tejun Heo7d77b242007-09-23 13:14:13 +09002687 /* Enable ATAPI AN if both the host and device have
2688 * the support. If PMP is attached, SNTF is required
2689 * to enable ATAPI AN to discern between PHY status
2690 * changed notifications and ATAPI ANs.
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04002691 */
Tejun Heoe7ecd432010-05-19 15:38:58 +02002692 if (atapi_an &&
2693 (ap->flags & ATA_FLAG_AN) && ata_id_has_atapi_AN(id) &&
Tejun Heo071f44b2008-04-07 22:47:22 +09002694 (!sata_pmp_attached(ap) ||
Tejun Heo7d77b242007-09-23 13:14:13 +09002695 sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf) == 0)) {
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04002696 /* issue SET feature command to turn this on */
Jeff Garzik218f3d32007-10-25 00:33:27 -04002697 err_mask = ata_dev_set_feature(dev,
2698 SETFEATURES_SATA_ENABLE, SATA_AN);
Tejun Heo854c73a2007-09-23 13:14:11 +09002699 if (err_mask)
Joe Perchesa9a79df2011-04-15 15:51:59 -07002700 ata_dev_err(dev,
2701 "failed to enable ATAPI AN (err_mask=0x%x)\n",
2702 err_mask);
Tejun Heo854c73a2007-09-23 13:14:11 +09002703 else {
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04002704 dev->flags |= ATA_DFLAG_AN;
Tejun Heo854c73a2007-09-23 13:14:11 +09002705 atapi_an_string = ", ATAPI AN";
2706 }
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04002707 }
2708
Albert Lee08a556d2006-03-31 13:29:04 +08002709 if (ata_id_cdb_intr(dev->id)) {
Albert Lee312f7da2005-09-27 17:38:03 +08002710 dev->flags |= ATA_DFLAG_CDB_INTR;
Albert Lee08a556d2006-03-31 13:29:04 +08002711 cdb_intr_string = ", CDB intr";
2712 }
Albert Lee312f7da2005-09-27 17:38:03 +08002713
Vincent Pelletier966fbe12013-05-21 22:30:58 +02002714 if (atapi_dmadir || (dev->horkage & ATA_HORKAGE_ATAPI_DMADIR) || atapi_id_dmadir(dev->id)) {
Tejun Heo91163002008-02-21 13:25:50 +09002715 dev->flags |= ATA_DFLAG_DMADIR;
2716 dma_dir_string = ", DMADIR";
2717 }
2718
Aaron Luafe75952013-01-15 17:20:58 +08002719 if (ata_id_has_da(dev->id)) {
Lin Mingb1354cb2012-06-25 16:13:08 +08002720 dev->flags |= ATA_DFLAG_DA;
Aaron Luafe75952013-01-15 17:20:58 +08002721 zpodd_init(dev);
2722 }
Lin Mingb1354cb2012-06-25 16:13:08 +08002723
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 /* print device info to dmesg */
Hannes Reinecke1c95a272021-12-21 08:21:07 +01002725 if (print_info)
Joe Perchesa9a79df2011-04-15 15:51:59 -07002726 ata_dev_info(dev,
2727 "ATAPI: %s, %s, max %s%s%s%s\n",
2728 modelbuf, fwrevbuf,
2729 ata_mode_string(xfer_mask),
2730 cdb_intr_string, atapi_an_string,
2731 dma_dir_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732 }
2733
Tejun Heo914ed352006-11-01 18:39:55 +09002734 /* determine max_sectors */
2735 dev->max_sectors = ATA_MAX_SECTORS;
2736 if (dev->flags & ATA_DFLAG_LBA48)
2737 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2738
Alan Coxc5038fc2007-10-25 14:21:16 +01002739 /* Limit PATA drive on SATA cable bridge transfers to udma5,
2740 200 sectors */
Tejun Heo3373efd2006-05-15 20:57:53 +09002741 if (ata_dev_knobble(dev)) {
Hannes Reinecke1c95a272021-12-21 08:21:07 +01002742 if (print_info)
Joe Perchesa9a79df2011-04-15 15:51:59 -07002743 ata_dev_info(dev, "applying bridge limits\n");
Tejun Heo5a529132006-03-24 14:07:50 +09002744 dev->udma_mask &= ATA_UDMA5;
Tejun Heo4b2f3ed2006-03-01 16:09:36 +09002745 dev->max_sectors = ATA_MAX_SECTORS;
2746 }
2747
Tony Battersbyf8d8e572007-10-30 11:44:35 -04002748 if ((dev->class == ATA_DEV_ATAPI) &&
Albert Leef442cd82007-11-15 10:35:47 +09002749 (atapi_command_packet_set(id) == TYPE_TAPE)) {
Tony Battersbyf8d8e572007-10-30 11:44:35 -04002750 dev->max_sectors = ATA_MAX_SECTORS_TAPE;
Albert Leef442cd82007-11-15 10:35:47 +09002751 dev->horkage |= ATA_HORKAGE_STUCK_ERR;
2752 }
Tony Battersbyf8d8e572007-10-30 11:44:35 -04002753
Tejun Heo75683fe2007-07-05 13:31:27 +09002754 if (dev->horkage & ATA_HORKAGE_MAX_SEC_128)
Tejun Heo03ec52d2007-04-12 13:38:11 +09002755 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_128,
2756 dev->max_sectors);
Albert Lee18d6e9d2007-04-02 11:34:15 +08002757
David Milburnaf34d632015-07-13 11:48:23 -05002758 if (dev->horkage & ATA_HORKAGE_MAX_SEC_1024)
2759 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_1024,
2760 dev->max_sectors);
2761
Shan Haia32450e2013-03-18 10:30:44 +08002762 if (dev->horkage & ATA_HORKAGE_MAX_SEC_LBA48)
2763 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2764
Tejun Heo4b2f3ed2006-03-01 16:09:36 +09002765 if (ap->ops->dev_config)
Alancd0d3bb2007-03-02 00:56:15 +00002766 ap->ops->dev_config(dev);
Tejun Heo4b2f3ed2006-03-01 16:09:36 +09002767
Alan Coxc5038fc2007-10-25 14:21:16 +01002768 if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
2769 /* Let the user know. We don't want to disallow opens for
2770 rescue purposes, or in case the vendor is just a blithering
2771 idiot. Do this after the dev_config call as some controllers
2772 with buggy firmware may want to avoid reporting false device
2773 bugs */
2774
2775 if (print_info) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07002776 ata_dev_warn(dev,
Alan Coxc5038fc2007-10-25 14:21:16 +01002777"Drive reports diagnostics failure. This may indicate a drive\n");
Joe Perchesa9a79df2011-04-15 15:51:59 -07002778 ata_dev_warn(dev,
Alan Coxc5038fc2007-10-25 14:21:16 +01002779"fault or invalid emulation. Contact drive vendor for information.\n");
2780 }
2781 }
2782
Tejun Heoac70a962008-11-27 13:36:48 +09002783 if ((dev->horkage & ATA_HORKAGE_FIRMWARE_WARN) && print_info) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07002784 ata_dev_warn(dev, "WARNING: device requires firmware update to be fully functional\n");
2785 ata_dev_warn(dev, " contact the vendor or visit http://ata.wiki.kernel.org\n");
Tejun Heoac70a962008-11-27 13:36:48 +09002786 }
2787
Tejun Heoffeae412006-03-01 16:09:35 +09002788 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789
2790err_out_nosup:
Tejun Heoffeae412006-03-01 16:09:35 +09002791 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792}
2793
2794/**
Alan Cox2e41e8e2007-03-08 23:19:19 +00002795 * ata_cable_40wire - return 40 wire cable type
Alan Coxbe0d18d2007-03-06 02:37:56 -08002796 * @ap: port
2797 *
Alan Cox2e41e8e2007-03-08 23:19:19 +00002798 * Helper method for drivers which want to hardwire 40 wire cable
Alan Coxbe0d18d2007-03-06 02:37:56 -08002799 * detection.
2800 */
2801
2802int ata_cable_40wire(struct ata_port *ap)
2803{
2804 return ATA_CBL_PATA40;
2805}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01002806EXPORT_SYMBOL_GPL(ata_cable_40wire);
Alan Coxbe0d18d2007-03-06 02:37:56 -08002807
2808/**
Alan Cox2e41e8e2007-03-08 23:19:19 +00002809 * ata_cable_80wire - return 80 wire cable type
Alan Coxbe0d18d2007-03-06 02:37:56 -08002810 * @ap: port
2811 *
Alan Cox2e41e8e2007-03-08 23:19:19 +00002812 * Helper method for drivers which want to hardwire 80 wire cable
Alan Coxbe0d18d2007-03-06 02:37:56 -08002813 * detection.
2814 */
2815
2816int ata_cable_80wire(struct ata_port *ap)
2817{
2818 return ATA_CBL_PATA80;
2819}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01002820EXPORT_SYMBOL_GPL(ata_cable_80wire);
Alan Coxbe0d18d2007-03-06 02:37:56 -08002821
2822/**
2823 * ata_cable_unknown - return unknown PATA cable.
2824 * @ap: port
2825 *
2826 * Helper method for drivers which have no PATA cable detection.
2827 */
2828
2829int ata_cable_unknown(struct ata_port *ap)
2830{
2831 return ATA_CBL_PATA_UNK;
2832}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01002833EXPORT_SYMBOL_GPL(ata_cable_unknown);
Alan Coxbe0d18d2007-03-06 02:37:56 -08002834
2835/**
Tejun Heoc88f90c2007-11-27 19:43:48 +09002836 * ata_cable_ignore - return ignored PATA cable.
2837 * @ap: port
2838 *
2839 * Helper method for drivers which don't use cable type to limit
2840 * transfer mode.
2841 */
2842int ata_cable_ignore(struct ata_port *ap)
2843{
2844 return ATA_CBL_PATA_IGN;
2845}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01002846EXPORT_SYMBOL_GPL(ata_cable_ignore);
Tejun Heoc88f90c2007-11-27 19:43:48 +09002847
2848/**
Alan Coxbe0d18d2007-03-06 02:37:56 -08002849 * ata_cable_sata - return SATA cable type
2850 * @ap: port
2851 *
2852 * Helper method for drivers which have SATA cables
2853 */
2854
2855int ata_cable_sata(struct ata_port *ap)
2856{
2857 return ATA_CBL_SATA;
2858}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01002859EXPORT_SYMBOL_GPL(ata_cable_sata);
Alan Coxbe0d18d2007-03-06 02:37:56 -08002860
2861/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002862 * ata_bus_probe - Reset and probe ATA bus
2863 * @ap: Bus to probe
2864 *
Jeff Garzik0cba6322005-05-30 19:49:12 -04002865 * Master ATA bus probing function. Initiates a hardware-dependent
2866 * bus reset, then attempts to identify any devices found on
2867 * the bus.
2868 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869 * LOCKING:
Jeff Garzik0cba6322005-05-30 19:49:12 -04002870 * PCI/etc. bus probe sem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 *
2872 * RETURNS:
Tejun Heo96072e62006-04-01 01:38:17 +09002873 * Zero on success, negative errno otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874 */
2875
Brian King80289162006-08-07 14:27:31 -05002876int ata_bus_probe(struct ata_port *ap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877{
Tejun Heo28ca5c52006-03-01 16:09:36 +09002878 unsigned int classes[ATA_MAX_DEVICES];
Tejun Heo14d2bac2006-04-02 17:54:46 +09002879 int tries[ATA_MAX_DEVICES];
Tejun Heof58229f2007-08-06 18:36:23 +09002880 int rc;
Tejun Heoe82cbdb2006-04-01 01:38:18 +09002881 struct ata_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882
Tejun Heo1eca4362008-11-03 20:03:17 +09002883 ata_for_each_dev(dev, &ap->link, ALL)
Tejun Heof58229f2007-08-06 18:36:23 +09002884 tries[dev->devno] = ATA_PROBE_MAX_TRIES;
Tejun Heo14d2bac2006-04-02 17:54:46 +09002885
2886 retry:
Tejun Heo1eca4362008-11-03 20:03:17 +09002887 ata_for_each_dev(dev, &ap->link, ALL) {
Tejun Heocdeab112007-10-29 16:41:09 +09002888 /* If we issue an SRST then an ATA drive (not ATAPI)
2889 * may change configuration and be in PIO0 timing. If
2890 * we do a hard reset (or are coming from power on)
2891 * this is true for ATA or ATAPI. Until we've set a
2892 * suitable controller mode we should not touch the
2893 * bus as we may be talking too fast.
2894 */
2895 dev->pio_mode = XFER_PIO_0;
Aaron Lu54169122012-12-03 11:35:02 +08002896 dev->dma_mode = 0xff;
Tejun Heocdeab112007-10-29 16:41:09 +09002897
2898 /* If the controller has a pio mode setup function
2899 * then use it to set the chipset to rights. Don't
2900 * touch the DMA setup as that will be dealt with when
2901 * configuring devices.
2902 */
2903 if (ap->ops->set_piomode)
2904 ap->ops->set_piomode(ap, dev);
2905 }
2906
Tejun Heo20444702006-03-13 01:57:01 +09002907 /* reset and determine device classes */
Tejun Heo52783c52006-05-31 18:28:22 +09002908 ap->ops->phy_reset(ap);
Tejun Heo2061a472006-03-12 00:57:39 +09002909
Tejun Heo1eca4362008-11-03 20:03:17 +09002910 ata_for_each_dev(dev, &ap->link, ALL) {
Tejun Heo3e4ec342010-05-10 21:41:30 +02002911 if (dev->class != ATA_DEV_UNKNOWN)
Tejun Heo52783c52006-05-31 18:28:22 +09002912 classes[dev->devno] = dev->class;
2913 else
2914 classes[dev->devno] = ATA_DEV_NONE;
Tejun Heo20444702006-03-13 01:57:01 +09002915
Tejun Heo52783c52006-05-31 18:28:22 +09002916 dev->class = ATA_DEV_UNKNOWN;
Tejun Heo28ca5c52006-03-01 16:09:36 +09002917 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918
Jeff Garzikf31f0cc2007-03-02 17:47:28 -05002919 /* read IDENTIFY page and configure devices. We have to do the identify
2920 specific sequence bass-ackwards so that PDIAG- is released by
2921 the slave device */
2922
Tejun Heo1eca4362008-11-03 20:03:17 +09002923 ata_for_each_dev(dev, &ap->link, ALL_REVERSE) {
Tejun Heof58229f2007-08-06 18:36:23 +09002924 if (tries[dev->devno])
2925 dev->class = classes[dev->devno];
Tejun Heo14d2bac2006-04-02 17:54:46 +09002926
Tejun Heoe1211e32006-04-01 01:38:18 +09002927 if (!ata_dev_enabled(dev))
Tejun Heoffeae412006-03-01 16:09:35 +09002928 continue;
2929
Tejun Heobff04642006-11-10 18:08:10 +09002930 rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
2931 dev->id);
Tejun Heo14d2bac2006-04-02 17:54:46 +09002932 if (rc)
2933 goto fail;
Jeff Garzikf31f0cc2007-03-02 17:47:28 -05002934 }
2935
Alan Coxbe0d18d2007-03-06 02:37:56 -08002936 /* Now ask for the cable type as PDIAG- should have been released */
2937 if (ap->ops->cable_detect)
2938 ap->cbl = ap->ops->cable_detect(ap);
2939
Tejun Heo1eca4362008-11-03 20:03:17 +09002940 /* We may have SATA bridge glue hiding here irrespective of
2941 * the reported cable types and sensed types. When SATA
2942 * drives indicate we have a bridge, we don't know which end
2943 * of the link the bridge is which is a problem.
2944 */
2945 ata_for_each_dev(dev, &ap->link, ENABLED)
Alan Cox614fe292007-08-22 23:22:45 +01002946 if (ata_id_is_sata(dev->id))
2947 ap->cbl = ATA_CBL_SATA;
Alan Cox614fe292007-08-22 23:22:45 +01002948
Jeff Garzikf31f0cc2007-03-02 17:47:28 -05002949 /* After the identify sequence we can now set up the devices. We do
2950 this in the normal order so that the user doesn't get confused */
2951
Tejun Heo1eca4362008-11-03 20:03:17 +09002952 ata_for_each_dev(dev, &ap->link, ENABLED) {
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002953 ap->link.eh_context.i.flags |= ATA_EHI_PRINTINFO;
Tejun Heoefdaedc2006-11-01 18:38:52 +09002954 rc = ata_dev_configure(dev);
Tejun Heo9af5c9c2007-08-06 18:36:22 +09002955 ap->link.eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
Tejun Heo14d2bac2006-04-02 17:54:46 +09002956 if (rc)
2957 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958 }
2959
Tejun Heoe82cbdb2006-04-01 01:38:18 +09002960 /* configure transfer mode */
Tejun Heo02607312007-08-06 18:36:23 +09002961 rc = ata_set_mode(&ap->link, &dev);
Tejun Heo4ae72a12007-02-02 16:22:30 +09002962 if (rc)
Tejun Heo51713d32006-04-11 22:26:29 +09002963 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964
Tejun Heo1eca4362008-11-03 20:03:17 +09002965 ata_for_each_dev(dev, &ap->link, ENABLED)
2966 return 0;
Alan Coxe35a9e02006-03-27 18:46:37 +01002967
Tejun Heo96072e62006-04-01 01:38:17 +09002968 return -ENODEV;
Tejun Heo14d2bac2006-04-02 17:54:46 +09002969
2970 fail:
Tejun Heo4ae72a12007-02-02 16:22:30 +09002971 tries[dev->devno]--;
2972
Tejun Heo14d2bac2006-04-02 17:54:46 +09002973 switch (rc) {
2974 case -EINVAL:
Tejun Heo4ae72a12007-02-02 16:22:30 +09002975 /* eeek, something went very wrong, give up */
Tejun Heo14d2bac2006-04-02 17:54:46 +09002976 tries[dev->devno] = 0;
2977 break;
Tejun Heo4ae72a12007-02-02 16:22:30 +09002978
2979 case -ENODEV:
2980 /* give it just one more chance */
2981 tries[dev->devno] = min(tries[dev->devno], 1);
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05002982 fallthrough;
Tejun Heo14d2bac2006-04-02 17:54:46 +09002983 case -EIO:
Tejun Heo4ae72a12007-02-02 16:22:30 +09002984 if (tries[dev->devno] == 1) {
2985 /* This is the last chance, better to slow
2986 * down than lose it.
2987 */
Tejun Heoa07d4992009-01-29 20:31:33 +09002988 sata_down_spd_limit(&ap->link, 0);
Tejun Heo4ae72a12007-02-02 16:22:30 +09002989 ata_down_xfermask_limit(dev, ATA_DNXFER_PIO);
2990 }
Tejun Heo14d2bac2006-04-02 17:54:46 +09002991 }
2992
Tejun Heo4ae72a12007-02-02 16:22:30 +09002993 if (!tries[dev->devno])
Tejun Heo3373efd2006-05-15 20:57:53 +09002994 ata_dev_disable(dev);
Tejun Heoec573752006-04-11 22:26:29 +09002995
Tejun Heo14d2bac2006-04-02 17:54:46 +09002996 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997}
2998
2999/**
Tejun Heo3be680b2005-12-19 22:35:02 +09003000 * sata_print_link_status - Print SATA link status
Tejun Heo936fd732007-08-06 18:36:23 +09003001 * @link: SATA link to printk link status about
Tejun Heo3be680b2005-12-19 22:35:02 +09003002 *
3003 * This function prints link speed and status of a SATA link.
3004 *
3005 * LOCKING:
3006 * None.
3007 */
Adrian Bunk6bdb4fc2008-04-21 11:51:11 +03003008static void sata_print_link_status(struct ata_link *link)
Tejun Heo3be680b2005-12-19 22:35:02 +09003009{
Tejun Heo6d5f9732006-04-03 00:09:41 +09003010 u32 sstatus, scontrol, tmp;
Tejun Heo3be680b2005-12-19 22:35:02 +09003011
Tejun Heo936fd732007-08-06 18:36:23 +09003012 if (sata_scr_read(link, SCR_STATUS, &sstatus))
Tejun Heo3be680b2005-12-19 22:35:02 +09003013 return;
Tejun Heo936fd732007-08-06 18:36:23 +09003014 sata_scr_read(link, SCR_CONTROL, &scontrol);
Tejun Heo3be680b2005-12-19 22:35:02 +09003015
Tejun Heob1c72912008-07-31 17:02:43 +09003016 if (ata_phys_link_online(link)) {
Tejun Heo3be680b2005-12-19 22:35:02 +09003017 tmp = (sstatus >> 4) & 0xf;
Joe Perchesa9a79df2011-04-15 15:51:59 -07003018 ata_link_info(link, "SATA link up %s (SStatus %X SControl %X)\n",
3019 sata_spd_string(tmp), sstatus, scontrol);
Tejun Heo3be680b2005-12-19 22:35:02 +09003020 } else {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003021 ata_link_info(link, "SATA link down (SStatus %X SControl %X)\n",
3022 sstatus, scontrol);
Tejun Heo3be680b2005-12-19 22:35:02 +09003023 }
3024}
3025
3026/**
Alan Coxebdfca6e2006-03-23 15:38:34 +00003027 * ata_dev_pair - return other device on cable
Alan Coxebdfca6e2006-03-23 15:38:34 +00003028 * @adev: device
3029 *
3030 * Obtain the other device on the same cable, or if none is
3031 * present NULL is returned
3032 */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05003033
Tejun Heo3373efd2006-05-15 20:57:53 +09003034struct ata_device *ata_dev_pair(struct ata_device *adev)
Alan Coxebdfca6e2006-03-23 15:38:34 +00003035{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09003036 struct ata_link *link = adev->link;
3037 struct ata_device *pair = &link->device[1 - adev->devno];
Tejun Heoe1211e32006-04-01 01:38:18 +09003038 if (!ata_dev_enabled(pair))
Alan Coxebdfca6e2006-03-23 15:38:34 +00003039 return NULL;
3040 return pair;
3041}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01003042EXPORT_SYMBOL_GPL(ata_dev_pair);
Alan Coxebdfca6e2006-03-23 15:38:34 +00003043
3044/**
Tejun Heo3c567b72006-05-15 20:57:23 +09003045 * sata_down_spd_limit - adjust SATA spd limit downward
Tejun Heo936fd732007-08-06 18:36:23 +09003046 * @link: Link to adjust SATA spd limit for
Tejun Heoa07d4992009-01-29 20:31:33 +09003047 * @spd_limit: Additional limit
Tejun Heo1c3fae42006-04-02 20:53:28 +09003048 *
Tejun Heo936fd732007-08-06 18:36:23 +09003049 * Adjust SATA spd limit of @link downward. Note that this
Tejun Heo1c3fae42006-04-02 20:53:28 +09003050 * function only adjusts the limit. The change must be applied
Tejun Heo3c567b72006-05-15 20:57:23 +09003051 * using sata_set_spd().
Tejun Heo1c3fae42006-04-02 20:53:28 +09003052 *
Tejun Heoa07d4992009-01-29 20:31:33 +09003053 * If @spd_limit is non-zero, the speed is limited to equal to or
3054 * lower than @spd_limit if such speed is supported. If
3055 * @spd_limit is slower than any supported speed, only the lowest
3056 * supported speed is allowed.
3057 *
Tejun Heo1c3fae42006-04-02 20:53:28 +09003058 * LOCKING:
3059 * Inherited from caller.
3060 *
3061 * RETURNS:
3062 * 0 on success, negative errno on failure
3063 */
Tejun Heoa07d4992009-01-29 20:31:33 +09003064int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
Tejun Heo1c3fae42006-04-02 20:53:28 +09003065{
Tejun Heo81952c52006-05-15 20:57:47 +09003066 u32 sstatus, spd, mask;
Tejun Heoa07d4992009-01-29 20:31:33 +09003067 int rc, bit;
Tejun Heo1c3fae42006-04-02 20:53:28 +09003068
Tejun Heo936fd732007-08-06 18:36:23 +09003069 if (!sata_scr_valid(link))
Tejun Heo008a7892007-07-16 14:29:40 +09003070 return -EOPNOTSUPP;
3071
3072 /* If SCR can be read, use it to determine the current SPD.
Tejun Heo936fd732007-08-06 18:36:23 +09003073 * If not, use cached value in link->sata_spd.
Tejun Heo008a7892007-07-16 14:29:40 +09003074 */
Tejun Heo936fd732007-08-06 18:36:23 +09003075 rc = sata_scr_read(link, SCR_STATUS, &sstatus);
Tejun Heo9913ff8a2009-01-29 20:31:31 +09003076 if (rc == 0 && ata_sstatus_online(sstatus))
Tejun Heo008a7892007-07-16 14:29:40 +09003077 spd = (sstatus >> 4) & 0xf;
3078 else
Tejun Heo936fd732007-08-06 18:36:23 +09003079 spd = link->sata_spd;
Tejun Heo1c3fae42006-04-02 20:53:28 +09003080
Tejun Heo936fd732007-08-06 18:36:23 +09003081 mask = link->sata_spd_limit;
Tejun Heo1c3fae42006-04-02 20:53:28 +09003082 if (mask <= 1)
3083 return -EINVAL;
Tejun Heo008a7892007-07-16 14:29:40 +09003084
3085 /* unconditionally mask off the highest bit */
Tejun Heoa07d4992009-01-29 20:31:33 +09003086 bit = fls(mask) - 1;
3087 mask &= ~(1 << bit);
Tejun Heo1c3fae42006-04-02 20:53:28 +09003088
David Milburn2dc0b462017-11-14 16:17:25 -06003089 /*
3090 * Mask off all speeds higher than or equal to the current one. At
3091 * this point, if current SPD is not available and we previously
3092 * recorded the link speed from SStatus, the driver has already
3093 * masked off the highest bit so mask should already be 1 or 0.
3094 * Otherwise, we should not force 1.5Gbps on a link where we have
3095 * not previously recorded speed from SStatus. Just return in this
3096 * case.
Tejun Heo008a7892007-07-16 14:29:40 +09003097 */
3098 if (spd > 1)
3099 mask &= (1 << (spd - 1)) - 1;
3100 else
David Milburn2dc0b462017-11-14 16:17:25 -06003101 return -EINVAL;
Tejun Heo008a7892007-07-16 14:29:40 +09003102
3103 /* were we already at the bottom? */
Tejun Heo1c3fae42006-04-02 20:53:28 +09003104 if (!mask)
3105 return -EINVAL;
3106
Tejun Heoa07d4992009-01-29 20:31:33 +09003107 if (spd_limit) {
3108 if (mask & ((1 << spd_limit) - 1))
3109 mask &= (1 << spd_limit) - 1;
3110 else {
3111 bit = ffs(mask) - 1;
3112 mask = 1 << bit;
3113 }
3114 }
3115
Tejun Heo936fd732007-08-06 18:36:23 +09003116 link->sata_spd_limit = mask;
Tejun Heo1c3fae42006-04-02 20:53:28 +09003117
Joe Perchesa9a79df2011-04-15 15:51:59 -07003118 ata_link_warn(link, "limiting SATA link speed to %s\n",
3119 sata_spd_string(fls(mask)));
Tejun Heo1c3fae42006-04-02 20:53:28 +09003120
3121 return 0;
3122}
3123
Bartlomiej Zolnierkiewicza9b2c122020-03-26 16:58:07 +01003124#ifdef CONFIG_ATA_ACPI
Tejun Heocf176e12006-04-02 17:54:46 +09003125/**
Tejun Heoa0f79b92007-12-18 16:33:05 +09003126 * ata_timing_cycle2mode - find xfer mode for the specified cycle duration
3127 * @xfer_shift: ATA_SHIFT_* value for transfer type to examine.
3128 * @cycle: cycle duration in ns
3129 *
3130 * Return matching xfer mode for @cycle. The returned mode is of
3131 * the transfer type specified by @xfer_shift. If @cycle is too
3132 * slow for @xfer_shift, 0xff is returned. If @cycle is faster
3133 * than the fastest known mode, the fasted mode is returned.
3134 *
3135 * LOCKING:
3136 * None.
3137 *
3138 * RETURNS:
3139 * Matching xfer_mode, 0xff if no match found.
3140 */
3141u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle)
3142{
3143 u8 base_mode = 0xff, last_mode = 0xff;
3144 const struct ata_xfer_ent *ent;
3145 const struct ata_timing *t;
3146
3147 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
3148 if (ent->shift == xfer_shift)
3149 base_mode = ent->base;
3150
3151 for (t = ata_timing_find_mode(base_mode);
3152 t && ata_xfer_mode2shift(t->mode) == xfer_shift; t++) {
3153 unsigned short this_cycle;
3154
3155 switch (xfer_shift) {
3156 case ATA_SHIFT_PIO:
3157 case ATA_SHIFT_MWDMA:
3158 this_cycle = t->cycle;
3159 break;
3160 case ATA_SHIFT_UDMA:
3161 this_cycle = t->udma;
3162 break;
3163 default:
3164 return 0xff;
3165 }
3166
3167 if (cycle > this_cycle)
3168 break;
3169
3170 last_mode = t->mode;
3171 }
3172
3173 return last_mode;
3174}
Bartlomiej Zolnierkiewicza9b2c122020-03-26 16:58:07 +01003175#endif
Tejun Heoa0f79b92007-12-18 16:33:05 +09003176
3177/**
Tejun Heocf176e12006-04-02 17:54:46 +09003178 * ata_down_xfermask_limit - adjust dev xfer masks downward
Tejun Heocf176e12006-04-02 17:54:46 +09003179 * @dev: Device to adjust xfer masks
Tejun Heo458337d2007-02-02 16:22:30 +09003180 * @sel: ATA_DNXFER_* selector
Tejun Heocf176e12006-04-02 17:54:46 +09003181 *
3182 * Adjust xfer masks of @dev downward. Note that this function
3183 * does not apply the change. Invoking ata_set_mode() afterwards
3184 * will apply the limit.
3185 *
3186 * LOCKING:
3187 * Inherited from caller.
3188 *
3189 * RETURNS:
3190 * 0 on success, negative errno on failure
3191 */
Tejun Heo458337d2007-02-02 16:22:30 +09003192int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel)
Tejun Heocf176e12006-04-02 17:54:46 +09003193{
Tejun Heo458337d2007-02-02 16:22:30 +09003194 char buf[32];
Tejun Heo7dc951a2007-11-27 19:43:42 +09003195 unsigned long orig_mask, xfer_mask;
3196 unsigned long pio_mask, mwdma_mask, udma_mask;
Tejun Heo458337d2007-02-02 16:22:30 +09003197 int quiet, highbit;
Tejun Heocf176e12006-04-02 17:54:46 +09003198
Tejun Heo458337d2007-02-02 16:22:30 +09003199 quiet = !!(sel & ATA_DNXFER_QUIET);
3200 sel &= ~ATA_DNXFER_QUIET;
Tejun Heocf176e12006-04-02 17:54:46 +09003201
Tejun Heo458337d2007-02-02 16:22:30 +09003202 xfer_mask = orig_mask = ata_pack_xfermask(dev->pio_mask,
3203 dev->mwdma_mask,
3204 dev->udma_mask);
3205 ata_unpack_xfermask(xfer_mask, &pio_mask, &mwdma_mask, &udma_mask);
Tejun Heocf176e12006-04-02 17:54:46 +09003206
Tejun Heo458337d2007-02-02 16:22:30 +09003207 switch (sel) {
3208 case ATA_DNXFER_PIO:
3209 highbit = fls(pio_mask) - 1;
3210 pio_mask &= ~(1 << highbit);
3211 break;
3212
3213 case ATA_DNXFER_DMA:
3214 if (udma_mask) {
3215 highbit = fls(udma_mask) - 1;
3216 udma_mask &= ~(1 << highbit);
3217 if (!udma_mask)
3218 return -ENOENT;
3219 } else if (mwdma_mask) {
3220 highbit = fls(mwdma_mask) - 1;
3221 mwdma_mask &= ~(1 << highbit);
3222 if (!mwdma_mask)
3223 return -ENOENT;
3224 }
3225 break;
3226
3227 case ATA_DNXFER_40C:
3228 udma_mask &= ATA_UDMA_MASK_40C;
3229 break;
3230
3231 case ATA_DNXFER_FORCE_PIO0:
3232 pio_mask &= 1;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05003233 fallthrough;
Tejun Heo458337d2007-02-02 16:22:30 +09003234 case ATA_DNXFER_FORCE_PIO:
3235 mwdma_mask = 0;
3236 udma_mask = 0;
3237 break;
3238
Tejun Heo458337d2007-02-02 16:22:30 +09003239 default:
3240 BUG();
3241 }
3242
3243 xfer_mask &= ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
3244
3245 if (!(xfer_mask & ATA_MASK_PIO) || xfer_mask == orig_mask)
3246 return -ENOENT;
3247
3248 if (!quiet) {
3249 if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
3250 snprintf(buf, sizeof(buf), "%s:%s",
3251 ata_mode_string(xfer_mask),
3252 ata_mode_string(xfer_mask & ATA_MASK_PIO));
3253 else
3254 snprintf(buf, sizeof(buf), "%s",
3255 ata_mode_string(xfer_mask));
3256
Joe Perchesa9a79df2011-04-15 15:51:59 -07003257 ata_dev_warn(dev, "limiting speed to %s\n", buf);
Tejun Heo458337d2007-02-02 16:22:30 +09003258 }
Tejun Heocf176e12006-04-02 17:54:46 +09003259
3260 ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
3261 &dev->udma_mask);
3262
Tejun Heocf176e12006-04-02 17:54:46 +09003263 return 0;
Tejun Heocf176e12006-04-02 17:54:46 +09003264}
3265
Tejun Heo3373efd2006-05-15 20:57:53 +09003266static int ata_dev_set_mode(struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003267{
Tejun Heod0cb43b2009-07-09 09:27:50 +09003268 struct ata_port *ap = dev->link->ap;
Tejun Heo9af5c9c2007-08-06 18:36:22 +09003269 struct ata_eh_context *ehc = &dev->link->eh_context;
Tejun Heod0cb43b2009-07-09 09:27:50 +09003270 const bool nosetxfer = dev->horkage & ATA_HORKAGE_NOSETXFER;
Tejun Heo4055dee2008-02-07 10:34:08 +09003271 const char *dev_err_whine = "";
3272 int ign_dev_err = 0;
Tejun Heod0cb43b2009-07-09 09:27:50 +09003273 unsigned int err_mask = 0;
Tejun Heo83206a22006-03-24 15:25:31 +09003274 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275
Tejun Heoe8384602006-04-02 18:51:53 +09003276 dev->flags &= ~ATA_DFLAG_PIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277 if (dev->xfer_shift == ATA_SHIFT_PIO)
3278 dev->flags |= ATA_DFLAG_PIO;
3279
Tejun Heod0cb43b2009-07-09 09:27:50 +09003280 if (nosetxfer && ap->flags & ATA_FLAG_SATA && ata_id_is_sata(dev->id))
3281 dev_err_whine = " (SET_XFERMODE skipped)";
3282 else {
3283 if (nosetxfer)
Joe Perchesa9a79df2011-04-15 15:51:59 -07003284 ata_dev_warn(dev,
3285 "NOSETXFER but PATA detected - can't "
3286 "skip SETXFER, might malfunction\n");
Tejun Heod0cb43b2009-07-09 09:27:50 +09003287 err_mask = ata_dev_set_xfermode(dev);
3288 }
Jeff Garzik2dcb4072007-10-19 06:42:56 -04003289
Tejun Heo4055dee2008-02-07 10:34:08 +09003290 if (err_mask & ~AC_ERR_DEV)
3291 goto fail;
Jeff Garzik2dcb4072007-10-19 06:42:56 -04003292
Tejun Heo4055dee2008-02-07 10:34:08 +09003293 /* revalidate */
Tejun Heobaa1e782006-11-01 18:39:27 +09003294 ehc->i.flags |= ATA_EHI_POST_SETMODE;
Tejun Heo422c9da2007-09-23 13:14:12 +09003295 rc = ata_dev_revalidate(dev, ATA_DEV_UNKNOWN, 0);
Tejun Heobaa1e782006-11-01 18:39:27 +09003296 ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
Tejun Heo5eb45c02006-04-02 18:51:52 +09003297 if (rc)
Tejun Heo83206a22006-03-24 15:25:31 +09003298 return rc;
Tejun Heo48a8a142006-03-05 17:55:58 +09003299
Alan Coxb93fda12008-04-08 16:36:44 +01003300 if (dev->xfer_shift == ATA_SHIFT_PIO) {
3301 /* Old CFA may refuse this command, which is just fine */
3302 if (ata_id_is_cfa(dev->id))
3303 ign_dev_err = 1;
3304 /* Catch several broken garbage emulations plus some pre
3305 ATA devices */
3306 if (ata_id_major_version(dev->id) == 0 &&
3307 dev->pio_mode <= XFER_PIO_2)
3308 ign_dev_err = 1;
3309 /* Some very old devices and some bad newer ones fail
3310 any kind of SET_XFERMODE request but support PIO0-2
3311 timings and no IORDY */
3312 if (!ata_id_has_iordy(dev->id) && dev->pio_mode <= XFER_PIO_2)
3313 ign_dev_err = 1;
3314 }
Tejun Heo4055dee2008-02-07 10:34:08 +09003315 /* Early MWDMA devices do DMA but don't allow DMA mode setting.
3316 Don't fail an MWDMA0 set IFF the device indicates it is in MWDMA0 */
3317 if (dev->xfer_shift == ATA_SHIFT_MWDMA &&
3318 dev->dma_mode == XFER_MW_DMA_0 &&
3319 (dev->id[63] >> 8) & 1)
3320 ign_dev_err = 1;
3321
3322 /* if the device is actually configured correctly, ignore dev err */
3323 if (dev->xfer_mode == ata_xfer_mask2mode(ata_id_xfermask(dev->id)))
3324 ign_dev_err = 1;
3325
3326 if (err_mask & AC_ERR_DEV) {
3327 if (!ign_dev_err)
3328 goto fail;
3329 else
3330 dev_err_whine = " (device error ignored)";
3331 }
3332
Hannes Reinecke46337782021-12-21 08:20:37 +01003333 ata_dev_dbg(dev, "xfer_shift=%u, xfer_mode=0x%x\n",
3334 dev->xfer_shift, (int)dev->xfer_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003335
Damien Le Moal07b9b6d2018-05-09 09:28:10 +09003336 if (!(ehc->i.flags & ATA_EHI_QUIET) ||
3337 ehc->i.flags & ATA_EHI_DID_HARDRESET)
3338 ata_dev_info(dev, "configured for %s%s\n",
3339 ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)),
3340 dev_err_whine);
Tejun Heo4055dee2008-02-07 10:34:08 +09003341
Tejun Heo83206a22006-03-24 15:25:31 +09003342 return 0;
Tejun Heo4055dee2008-02-07 10:34:08 +09003343
3344 fail:
Joe Perchesa9a79df2011-04-15 15:51:59 -07003345 ata_dev_err(dev, "failed to set xfermode (err_mask=0x%x)\n", err_mask);
Tejun Heo4055dee2008-02-07 10:34:08 +09003346 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003347}
3348
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349/**
Alan04351822007-03-06 02:37:52 -08003350 * ata_do_set_mode - Program timings and issue SET FEATURES - XFER
Tejun Heo02607312007-08-06 18:36:23 +09003351 * @link: link on which timings will be programmed
Joe Perches1967b7f2008-02-03 17:08:11 +02003352 * @r_failed_dev: out parameter for failed device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003353 *
Alan04351822007-03-06 02:37:52 -08003354 * Standard implementation of the function used to tune and set
3355 * ATA device disk transfer mode (PIO3, UDMA6, etc.). If
3356 * ata_dev_set_mode() fails, pointer to the failing device is
Tejun Heoe82cbdb2006-04-01 01:38:18 +09003357 * returned in @r_failed_dev.
Jeff Garzik780a87f2005-05-30 15:41:05 -04003358 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003359 * LOCKING:
Jeff Garzik0cba6322005-05-30 19:49:12 -04003360 * PCI/etc. bus probe sem.
Tejun Heoe82cbdb2006-04-01 01:38:18 +09003361 *
3362 * RETURNS:
3363 * 0 on success, negative errno otherwise
Linus Torvalds1da177e2005-04-16 15:20:36 -07003364 */
Alan04351822007-03-06 02:37:52 -08003365
Tejun Heo02607312007-08-06 18:36:23 +09003366int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367{
Tejun Heo02607312007-08-06 18:36:23 +09003368 struct ata_port *ap = link->ap;
Tejun Heoe8e06192006-04-01 01:38:18 +09003369 struct ata_device *dev;
Tejun Heof58229f2007-08-06 18:36:23 +09003370 int rc = 0, used_dma = 0, found = 0;
Tejun Heo3adcebb2006-05-15 20:57:37 +09003371
Tejun Heoa6d5a512006-03-06 04:31:57 +09003372 /* step 1: calculate xfer_mask */
Tejun Heo1eca4362008-11-03 20:03:17 +09003373 ata_for_each_dev(dev, link, ENABLED) {
Tejun Heo7dc951a2007-11-27 19:43:42 +09003374 unsigned long pio_mask, dma_mask;
Alan Coxb3a70602007-10-02 12:38:26 -04003375 unsigned int mode_mask;
Tejun Heoa6d5a512006-03-06 04:31:57 +09003376
Alan Coxb3a70602007-10-02 12:38:26 -04003377 mode_mask = ATA_DMA_MASK_ATA;
3378 if (dev->class == ATA_DEV_ATAPI)
3379 mode_mask = ATA_DMA_MASK_ATAPI;
3380 else if (ata_id_is_cfa(dev->id))
3381 mode_mask = ATA_DMA_MASK_CFA;
3382
Tejun Heo3373efd2006-05-15 20:57:53 +09003383 ata_dev_xfermask(dev);
Tejun Heo33267322008-02-13 09:15:09 +09003384 ata_force_xfermask(dev);
Tejun Heoa6d5a512006-03-06 04:31:57 +09003385
Tejun Heoacf356b2006-03-24 14:07:50 +09003386 pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);
Alan Coxb3a70602007-10-02 12:38:26 -04003387
3388 if (libata_dma_mask & mode_mask)
Sergei Shtylyov80a9c432011-12-22 22:41:32 +03003389 dma_mask = ata_pack_xfermask(0, dev->mwdma_mask,
3390 dev->udma_mask);
Alan Coxb3a70602007-10-02 12:38:26 -04003391 else
3392 dma_mask = 0;
3393
Tejun Heoacf356b2006-03-24 14:07:50 +09003394 dev->pio_mode = ata_xfer_mask2mode(pio_mask);
3395 dev->dma_mode = ata_xfer_mask2mode(dma_mask);
Alan Cox5444a6f2006-03-27 18:58:20 +01003396
Tejun Heo4f659772006-04-01 01:38:18 +09003397 found = 1;
Alan Coxb15b3eb2008-08-01 09:18:34 +01003398 if (ata_dma_enabled(dev))
Alan Cox5444a6f2006-03-27 18:58:20 +01003399 used_dma = 1;
Tejun Heoa6d5a512006-03-06 04:31:57 +09003400 }
Tejun Heo4f659772006-04-01 01:38:18 +09003401 if (!found)
Tejun Heoe82cbdb2006-04-01 01:38:18 +09003402 goto out;
Tejun Heoa6d5a512006-03-06 04:31:57 +09003403
3404 /* step 2: always set host PIO timings */
Tejun Heo1eca4362008-11-03 20:03:17 +09003405 ata_for_each_dev(dev, link, ENABLED) {
Tejun Heo70cd0712007-11-27 19:43:40 +09003406 if (dev->pio_mode == 0xff) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003407 ata_dev_warn(dev, "no PIO support\n");
Tejun Heoe8e06192006-04-01 01:38:18 +09003408 rc = -EINVAL;
Tejun Heoe82cbdb2006-04-01 01:38:18 +09003409 goto out;
Tejun Heoe8e06192006-04-01 01:38:18 +09003410 }
3411
3412 dev->xfer_mode = dev->pio_mode;
3413 dev->xfer_shift = ATA_SHIFT_PIO;
3414 if (ap->ops->set_piomode)
3415 ap->ops->set_piomode(ap, dev);
3416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417
Tejun Heoa6d5a512006-03-06 04:31:57 +09003418 /* step 3: set host DMA timings */
Tejun Heo1eca4362008-11-03 20:03:17 +09003419 ata_for_each_dev(dev, link, ENABLED) {
3420 if (!ata_dma_enabled(dev))
Tejun Heoe8e06192006-04-01 01:38:18 +09003421 continue;
3422
3423 dev->xfer_mode = dev->dma_mode;
3424 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
3425 if (ap->ops->set_dmamode)
3426 ap->ops->set_dmamode(ap, dev);
3427 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428
3429 /* step 4: update devices' xfer mode */
Tejun Heo1eca4362008-11-03 20:03:17 +09003430 ata_for_each_dev(dev, link, ENABLED) {
Tejun Heo3373efd2006-05-15 20:57:53 +09003431 rc = ata_dev_set_mode(dev);
Tejun Heo5bbc53f2006-04-01 01:38:17 +09003432 if (rc)
Tejun Heoe82cbdb2006-04-01 01:38:18 +09003433 goto out;
Tejun Heo83206a22006-03-24 15:25:31 +09003434 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435
Tejun Heoe8e06192006-04-01 01:38:18 +09003436 /* Record simplex status. If we selected DMA then the other
3437 * host channels are not permitted to do so.
Alan Cox5444a6f2006-03-27 18:58:20 +01003438 */
Jeff Garzikcca39742006-08-24 03:19:22 -04003439 if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
Alan032af1c2007-03-01 17:36:46 +00003440 ap->host->simplex_claimed = ap;
Alan Cox5444a6f2006-03-27 18:58:20 +01003441
Tejun Heoe82cbdb2006-04-01 01:38:18 +09003442 out:
3443 if (rc)
3444 *r_failed_dev = dev;
3445 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003446}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01003447EXPORT_SYMBOL_GPL(ata_do_set_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003448
3449/**
Tejun Heoaa2731a2008-04-07 22:47:19 +09003450 * ata_wait_ready - wait for link to become ready
3451 * @link: link to be waited on
3452 * @deadline: deadline jiffies for the operation
3453 * @check_ready: callback to check link readiness
3454 *
3455 * Wait for @link to become ready. @check_ready should return
3456 * positive number if @link is ready, 0 if it isn't, -ENODEV if
3457 * link doesn't seem to be occupied, other errno for other error
3458 * conditions.
3459 *
3460 * Transient -ENODEV conditions are allowed for
3461 * ATA_TMOUT_FF_WAIT.
3462 *
3463 * LOCKING:
3464 * EH context.
3465 *
3466 * RETURNS:
Masanari Iidac9b55602016-04-13 23:36:27 +09003467 * 0 if @link is ready before @deadline; otherwise, -errno.
Tejun Heoaa2731a2008-04-07 22:47:19 +09003468 */
3469int ata_wait_ready(struct ata_link *link, unsigned long deadline,
3470 int (*check_ready)(struct ata_link *link))
3471{
3472 unsigned long start = jiffies;
Tejun Heob48d58f2010-04-09 19:46:38 +09003473 unsigned long nodev_deadline;
Tejun Heoaa2731a2008-04-07 22:47:19 +09003474 int warned = 0;
3475
Tejun Heob48d58f2010-04-09 19:46:38 +09003476 /* choose which 0xff timeout to use, read comment in libata.h */
3477 if (link->ap->host->flags & ATA_HOST_PARALLEL_SCAN)
3478 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT_LONG);
3479 else
3480 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT);
3481
Tejun Heob1c72912008-07-31 17:02:43 +09003482 /* Slave readiness can't be tested separately from master. On
3483 * M/S emulation configuration, this function should be called
3484 * only on the master and it will handle both master and slave.
3485 */
3486 WARN_ON(link == link->ap->slave_link);
3487
Tejun Heoaa2731a2008-04-07 22:47:19 +09003488 if (time_after(nodev_deadline, deadline))
3489 nodev_deadline = deadline;
3490
3491 while (1) {
3492 unsigned long now = jiffies;
3493 int ready, tmp;
3494
3495 ready = tmp = check_ready(link);
3496 if (ready > 0)
3497 return 0;
3498
Tejun Heob48d58f2010-04-09 19:46:38 +09003499 /*
3500 * -ENODEV could be transient. Ignore -ENODEV if link
Tejun Heoaa2731a2008-04-07 22:47:19 +09003501 * is online. Also, some SATA devices take a long
Tejun Heob48d58f2010-04-09 19:46:38 +09003502 * time to clear 0xff after reset. Wait for
3503 * ATA_TMOUT_FF_WAIT[_LONG] on -ENODEV if link isn't
3504 * offline.
Tejun Heoaa2731a2008-04-07 22:47:19 +09003505 *
3506 * Note that some PATA controllers (pata_ali) explode
3507 * if status register is read more than once when
3508 * there's no device attached.
3509 */
3510 if (ready == -ENODEV) {
3511 if (ata_link_online(link))
3512 ready = 0;
3513 else if ((link->ap->flags & ATA_FLAG_SATA) &&
3514 !ata_link_offline(link) &&
3515 time_before(now, nodev_deadline))
3516 ready = 0;
3517 }
3518
3519 if (ready)
3520 return ready;
3521 if (time_after(now, deadline))
3522 return -EBUSY;
3523
3524 if (!warned && time_after(now, start + 5 * HZ) &&
3525 (deadline - now > 3 * HZ)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003526 ata_link_warn(link,
Tejun Heoaa2731a2008-04-07 22:47:19 +09003527 "link is slow to respond, please be patient "
3528 "(ready=%d)\n", tmp);
3529 warned = 1;
3530 }
3531
Tejun Heo97750ce2010-09-06 17:56:29 +02003532 ata_msleep(link->ap, 50);
Tejun Heoaa2731a2008-04-07 22:47:19 +09003533 }
3534}
3535
3536/**
3537 * ata_wait_after_reset - wait for link to become ready after reset
3538 * @link: link to be waited on
3539 * @deadline: deadline jiffies for the operation
3540 * @check_ready: callback to check link readiness
3541 *
3542 * Wait for @link to become ready after reset.
3543 *
3544 * LOCKING:
3545 * EH context.
3546 *
3547 * RETURNS:
Masanari Iidac9b55602016-04-13 23:36:27 +09003548 * 0 if @link is ready before @deadline; otherwise, -errno.
Tejun Heoaa2731a2008-04-07 22:47:19 +09003549 */
Harvey Harrison2b4221b2008-04-24 18:37:34 -07003550int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
Tejun Heoaa2731a2008-04-07 22:47:19 +09003551 int (*check_ready)(struct ata_link *link))
3552{
Tejun Heo97750ce2010-09-06 17:56:29 +02003553 ata_msleep(link->ap, ATA_WAIT_AFTER_RESET);
Tejun Heoaa2731a2008-04-07 22:47:19 +09003554
3555 return ata_wait_ready(link, deadline, check_ready);
3556}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01003557EXPORT_SYMBOL_GPL(ata_wait_after_reset);
Tejun Heoaa2731a2008-04-07 22:47:19 +09003558
3559/**
Tejun Heo0aa11132008-04-07 22:47:18 +09003560 * ata_std_prereset - prepare for reset
Tejun Heocc0680a2007-08-06 18:36:23 +09003561 * @link: ATA link to be reset
Tejun Heod4b2bab2007-02-02 16:50:52 +09003562 * @deadline: deadline jiffies for the operation
Tejun Heof5914a42006-05-31 18:27:48 +09003563 *
Tejun Heocc0680a2007-08-06 18:36:23 +09003564 * @link is about to be reset. Initialize it. Failure from
Tejun Heob8cffc62007-02-02 16:50:52 +09003565 * prereset makes libata abort whole reset sequence and give up
3566 * that port, so prereset should be best-effort. It does its
3567 * best to prepare for reset sequence but if things go wrong, it
3568 * should just whine, not fail.
Tejun Heof5914a42006-05-31 18:27:48 +09003569 *
3570 * LOCKING:
3571 * Kernel thread context (may sleep)
3572 *
3573 * RETURNS:
3574 * 0 on success, -errno otherwise.
3575 */
Tejun Heo0aa11132008-04-07 22:47:18 +09003576int ata_std_prereset(struct ata_link *link, unsigned long deadline)
Tejun Heof5914a42006-05-31 18:27:48 +09003577{
Tejun Heocc0680a2007-08-06 18:36:23 +09003578 struct ata_port *ap = link->ap;
Tejun Heo936fd732007-08-06 18:36:23 +09003579 struct ata_eh_context *ehc = &link->eh_context;
Tejun Heoe9c83912006-07-03 16:07:26 +09003580 const unsigned long *timing = sata_ehc_deb_timing(ehc);
Tejun Heof5914a42006-05-31 18:27:48 +09003581 int rc;
3582
Tejun Heof5914a42006-05-31 18:27:48 +09003583 /* if we're about to do hardreset, nothing more to do */
3584 if (ehc->i.action & ATA_EH_HARDRESET)
3585 return 0;
3586
Tejun Heo936fd732007-08-06 18:36:23 +09003587 /* if SATA, resume link */
Tejun Heoa16abc02007-05-21 18:33:47 +02003588 if (ap->flags & ATA_FLAG_SATA) {
Tejun Heo936fd732007-08-06 18:36:23 +09003589 rc = sata_link_resume(link, timing, deadline);
Tejun Heob8cffc62007-02-02 16:50:52 +09003590 /* whine about phy resume failure but proceed */
3591 if (rc && rc != -EOPNOTSUPP)
Joe Perchesa9a79df2011-04-15 15:51:59 -07003592 ata_link_warn(link,
3593 "failed to resume link for reset (errno=%d)\n",
3594 rc);
Tejun Heof5914a42006-05-31 18:27:48 +09003595 }
3596
Tejun Heo45db2f62008-04-08 01:46:56 +09003597 /* no point in trying softreset on offline link */
Tejun Heob1c72912008-07-31 17:02:43 +09003598 if (ata_phys_link_offline(link))
Tejun Heo45db2f62008-04-08 01:46:56 +09003599 ehc->i.action &= ~ATA_EH_SOFTRESET;
3600
Tejun Heof5914a42006-05-31 18:27:48 +09003601 return 0;
3602}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01003603EXPORT_SYMBOL_GPL(ata_std_prereset);
Tejun Heof5914a42006-05-31 18:27:48 +09003604
Tejun Heoc2bd5802006-01-24 17:05:22 +09003605/**
Tejun Heo57c9efd2008-04-07 22:47:19 +09003606 * sata_std_hardreset - COMRESET w/o waiting or classification
3607 * @link: link to reset
3608 * @class: resulting class of attached device
3609 * @deadline: deadline jiffies for the operation
3610 *
3611 * Standard SATA COMRESET w/o waiting or classification.
3612 *
3613 * LOCKING:
3614 * Kernel thread context (may sleep)
3615 *
3616 * RETURNS:
3617 * 0 if link offline, -EAGAIN if link online, -errno on errors.
3618 */
3619int sata_std_hardreset(struct ata_link *link, unsigned int *class,
3620 unsigned long deadline)
3621{
3622 const unsigned long *timing = sata_ehc_deb_timing(&link->eh_context);
3623 bool online;
3624 int rc;
3625
3626 /* do hardreset */
3627 rc = sata_link_hardreset(link, timing, deadline, &online, NULL);
Tejun Heo57c9efd2008-04-07 22:47:19 +09003628 return online ? -EAGAIN : rc;
3629}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01003630EXPORT_SYMBOL_GPL(sata_std_hardreset);
Tejun Heo57c9efd2008-04-07 22:47:19 +09003631
3632/**
Tejun Heo203c75b2008-04-07 22:47:18 +09003633 * ata_std_postreset - standard postreset callback
Tejun Heocc0680a2007-08-06 18:36:23 +09003634 * @link: the target ata_link
Tejun Heoc2bd5802006-01-24 17:05:22 +09003635 * @classes: classes of attached devices
3636 *
3637 * This function is invoked after a successful reset. Note that
3638 * the device might have been reset more than once using
3639 * different reset methods before postreset is invoked.
Tejun Heoc2bd5802006-01-24 17:05:22 +09003640 *
Tejun Heoc2bd5802006-01-24 17:05:22 +09003641 * LOCKING:
3642 * Kernel thread context (may sleep)
3643 */
Tejun Heo203c75b2008-04-07 22:47:18 +09003644void ata_std_postreset(struct ata_link *link, unsigned int *classes)
Tejun Heoc2bd5802006-01-24 17:05:22 +09003645{
Tejun Heof0465192008-05-19 01:15:08 +09003646 u32 serror;
3647
Tejun Heof0465192008-05-19 01:15:08 +09003648 /* reset complete, clear SError */
3649 if (!sata_scr_read(link, SCR_ERROR, &serror))
3650 sata_scr_write(link, SCR_ERROR, serror);
3651
Tejun Heoc2bd5802006-01-24 17:05:22 +09003652 /* print link status */
Tejun Heo936fd732007-08-06 18:36:23 +09003653 sata_print_link_status(link);
Tejun Heoc2bd5802006-01-24 17:05:22 +09003654}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01003655EXPORT_SYMBOL_GPL(ata_std_postreset);
Tejun Heoc2bd5802006-01-24 17:05:22 +09003656
Tejun Heoa62c0fc2006-01-24 17:05:22 +09003657/**
Tejun Heo623a3122006-03-05 17:55:58 +09003658 * ata_dev_same_device - Determine whether new ID matches configured device
Tejun Heo623a3122006-03-05 17:55:58 +09003659 * @dev: device to compare against
3660 * @new_class: class of the new device
3661 * @new_id: IDENTIFY page of the new device
3662 *
3663 * Compare @new_class and @new_id against @dev and determine
3664 * whether @dev is the device indicated by @new_class and
3665 * @new_id.
3666 *
3667 * LOCKING:
3668 * None.
3669 *
3670 * RETURNS:
3671 * 1 if @dev matches @new_class and @new_id, 0 otherwise.
3672 */
Tejun Heo3373efd2006-05-15 20:57:53 +09003673static int ata_dev_same_device(struct ata_device *dev, unsigned int new_class,
3674 const u16 *new_id)
Tejun Heo623a3122006-03-05 17:55:58 +09003675{
3676 const u16 *old_id = dev->id;
Tejun Heoa0cf7332007-01-02 20:18:49 +09003677 unsigned char model[2][ATA_ID_PROD_LEN + 1];
3678 unsigned char serial[2][ATA_ID_SERNO_LEN + 1];
Tejun Heo623a3122006-03-05 17:55:58 +09003679
3680 if (dev->class != new_class) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003681 ata_dev_info(dev, "class mismatch %d != %d\n",
3682 dev->class, new_class);
Tejun Heo623a3122006-03-05 17:55:58 +09003683 return 0;
3684 }
3685
Tejun Heoa0cf7332007-01-02 20:18:49 +09003686 ata_id_c_string(old_id, model[0], ATA_ID_PROD, sizeof(model[0]));
3687 ata_id_c_string(new_id, model[1], ATA_ID_PROD, sizeof(model[1]));
3688 ata_id_c_string(old_id, serial[0], ATA_ID_SERNO, sizeof(serial[0]));
3689 ata_id_c_string(new_id, serial[1], ATA_ID_SERNO, sizeof(serial[1]));
Tejun Heo623a3122006-03-05 17:55:58 +09003690
3691 if (strcmp(model[0], model[1])) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003692 ata_dev_info(dev, "model number mismatch '%s' != '%s'\n",
3693 model[0], model[1]);
Tejun Heo623a3122006-03-05 17:55:58 +09003694 return 0;
3695 }
3696
3697 if (strcmp(serial[0], serial[1])) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003698 ata_dev_info(dev, "serial number mismatch '%s' != '%s'\n",
3699 serial[0], serial[1]);
Tejun Heo623a3122006-03-05 17:55:58 +09003700 return 0;
3701 }
3702
Tejun Heo623a3122006-03-05 17:55:58 +09003703 return 1;
3704}
3705
3706/**
Tejun Heofe309112007-05-15 03:28:15 +09003707 * ata_dev_reread_id - Re-read IDENTIFY data
Henrik Kretzschmar3fae4502007-06-19 10:10:50 +02003708 * @dev: target ATA device
Tejun Heobff04642006-11-10 18:08:10 +09003709 * @readid_flags: read ID flags
Tejun Heo623a3122006-03-05 17:55:58 +09003710 *
3711 * Re-read IDENTIFY page and make sure @dev is still attached to
3712 * the port.
3713 *
3714 * LOCKING:
3715 * Kernel thread context (may sleep)
3716 *
3717 * RETURNS:
3718 * 0 on success, negative errno otherwise
3719 */
Tejun Heofe309112007-05-15 03:28:15 +09003720int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags)
Tejun Heo623a3122006-03-05 17:55:58 +09003721{
Tejun Heo5eb45c02006-04-02 18:51:52 +09003722 unsigned int class = dev->class;
Tejun Heo9af5c9c2007-08-06 18:36:22 +09003723 u16 *id = (void *)dev->link->ap->sector_buf;
Tejun Heo623a3122006-03-05 17:55:58 +09003724 int rc;
3725
Tejun Heofe635c72006-05-15 20:57:35 +09003726 /* read ID data */
Tejun Heobff04642006-11-10 18:08:10 +09003727 rc = ata_dev_read_id(dev, &class, readid_flags, id);
Tejun Heo623a3122006-03-05 17:55:58 +09003728 if (rc)
Tejun Heofe309112007-05-15 03:28:15 +09003729 return rc;
Tejun Heo623a3122006-03-05 17:55:58 +09003730
3731 /* is the device still there? */
Tejun Heofe309112007-05-15 03:28:15 +09003732 if (!ata_dev_same_device(dev, class, id))
3733 return -ENODEV;
Tejun Heo623a3122006-03-05 17:55:58 +09003734
Tejun Heofe635c72006-05-15 20:57:35 +09003735 memcpy(dev->id, id, sizeof(id[0]) * ATA_ID_WORDS);
Tejun Heofe309112007-05-15 03:28:15 +09003736 return 0;
3737}
3738
3739/**
3740 * ata_dev_revalidate - Revalidate ATA device
3741 * @dev: device to revalidate
Tejun Heo422c9da2007-09-23 13:14:12 +09003742 * @new_class: new class code
Tejun Heofe309112007-05-15 03:28:15 +09003743 * @readid_flags: read ID flags
3744 *
3745 * Re-read IDENTIFY page, make sure @dev is still attached to the
3746 * port and reconfigure it according to the new IDENTIFY page.
3747 *
3748 * LOCKING:
3749 * Kernel thread context (may sleep)
3750 *
3751 * RETURNS:
3752 * 0 on success, negative errno otherwise
3753 */
Tejun Heo422c9da2007-09-23 13:14:12 +09003754int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
3755 unsigned int readid_flags)
Tejun Heofe309112007-05-15 03:28:15 +09003756{
Tejun Heo6ddcd3b2007-05-15 03:28:15 +09003757 u64 n_sectors = dev->n_sectors;
Tejun Heo5920dad2009-07-15 17:11:41 +09003758 u64 n_native_sectors = dev->n_native_sectors;
Tejun Heofe309112007-05-15 03:28:15 +09003759 int rc;
3760
3761 if (!ata_dev_enabled(dev))
3762 return -ENODEV;
3763
Tejun Heo422c9da2007-09-23 13:14:12 +09003764 /* fail early if !ATA && !ATAPI to avoid issuing [P]IDENTIFY to PMP */
3765 if (ata_class_enabled(new_class) &&
Borislav Petkovf0d06132009-04-26 16:33:34 +02003766 new_class != ATA_DEV_ATA &&
3767 new_class != ATA_DEV_ATAPI &&
Hannes Reinecke9162c652014-11-05 13:08:21 +01003768 new_class != ATA_DEV_ZAC &&
Borislav Petkovf0d06132009-04-26 16:33:34 +02003769 new_class != ATA_DEV_SEMB) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003770 ata_dev_info(dev, "class mismatch %u != %u\n",
3771 dev->class, new_class);
Tejun Heo422c9da2007-09-23 13:14:12 +09003772 rc = -ENODEV;
3773 goto fail;
3774 }
3775
Tejun Heofe309112007-05-15 03:28:15 +09003776 /* re-read ID */
3777 rc = ata_dev_reread_id(dev, readid_flags);
3778 if (rc)
3779 goto fail;
Tejun Heo623a3122006-03-05 17:55:58 +09003780
3781 /* configure device according to the new ID */
Tejun Heoefdaedc2006-11-01 18:38:52 +09003782 rc = ata_dev_configure(dev);
Tejun Heo6ddcd3b2007-05-15 03:28:15 +09003783 if (rc)
3784 goto fail;
3785
3786 /* verify n_sectors hasn't changed */
Tejun Heo445d2112010-04-05 10:33:13 +09003787 if (dev->class != ATA_DEV_ATA || !n_sectors ||
3788 dev->n_sectors == n_sectors)
3789 return 0;
3790
3791 /* n_sectors has changed */
Joe Perchesa9a79df2011-04-15 15:51:59 -07003792 ata_dev_warn(dev, "n_sectors mismatch %llu != %llu\n",
3793 (unsigned long long)n_sectors,
3794 (unsigned long long)dev->n_sectors);
Tejun Heo445d2112010-04-05 10:33:13 +09003795
3796 /*
3797 * Something could have caused HPA to be unlocked
3798 * involuntarily. If n_native_sectors hasn't changed and the
3799 * new size matches it, keep the device.
3800 */
3801 if (dev->n_native_sectors == n_native_sectors &&
3802 dev->n_sectors > n_sectors && dev->n_sectors == n_native_sectors) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003803 ata_dev_warn(dev,
3804 "new n_sectors matches native, probably "
3805 "late HPA unlock, n_sectors updated\n");
Tejun Heo68939ce2010-05-15 20:09:33 +02003806 /* use the larger n_sectors */
Tejun Heo445d2112010-04-05 10:33:13 +09003807 return 0;
Tejun Heo6ddcd3b2007-05-15 03:28:15 +09003808 }
3809
Tejun Heo445d2112010-04-05 10:33:13 +09003810 /*
3811 * Some BIOSes boot w/o HPA but resume w/ HPA locked. Try
3812 * unlocking HPA in those cases.
3813 *
3814 * https://bugzilla.kernel.org/show_bug.cgi?id=15396
3815 */
3816 if (dev->n_native_sectors == n_native_sectors &&
3817 dev->n_sectors < n_sectors && n_sectors == n_native_sectors &&
3818 !(dev->horkage & ATA_HORKAGE_BROKEN_HPA)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07003819 ata_dev_warn(dev,
3820 "old n_sectors matches native, probably "
3821 "late HPA lock, will try to unlock HPA\n");
Tejun Heo445d2112010-04-05 10:33:13 +09003822 /* try unlocking HPA */
3823 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
3824 rc = -EIO;
3825 } else
3826 rc = -ENODEV;
Tejun Heo623a3122006-03-05 17:55:58 +09003827
Tejun Heo445d2112010-04-05 10:33:13 +09003828 /* restore original n_[native_]sectors and fail */
3829 dev->n_native_sectors = n_native_sectors;
3830 dev->n_sectors = n_sectors;
Tejun Heo623a3122006-03-05 17:55:58 +09003831 fail:
Joe Perchesa9a79df2011-04-15 15:51:59 -07003832 ata_dev_err(dev, "revalidation failed (errno=%d)\n", rc);
Tejun Heo623a3122006-03-05 17:55:58 +09003833 return rc;
3834}
3835
Alan Cox6919a0a2006-10-27 19:08:46 -07003836struct ata_blacklist_entry {
3837 const char *model_num;
3838 const char *model_rev;
3839 unsigned long horkage;
3840};
3841
3842static const struct ata_blacklist_entry ata_device_blacklist [] = {
3843 /* Devices with DMA related problems under Linux */
3844 { "WDC AC11000H", NULL, ATA_HORKAGE_NODMA },
3845 { "WDC AC22100H", NULL, ATA_HORKAGE_NODMA },
3846 { "WDC AC32500H", NULL, ATA_HORKAGE_NODMA },
3847 { "WDC AC33100H", NULL, ATA_HORKAGE_NODMA },
3848 { "WDC AC31600H", NULL, ATA_HORKAGE_NODMA },
3849 { "WDC AC32100H", "24.09P07", ATA_HORKAGE_NODMA },
3850 { "WDC AC23200L", "21.10N21", ATA_HORKAGE_NODMA },
3851 { "Compaq CRD-8241B", NULL, ATA_HORKAGE_NODMA },
3852 { "CRD-8400B", NULL, ATA_HORKAGE_NODMA },
Mark Lord7da4c932010-07-01 18:18:12 -04003853 { "CRD-848[02]B", NULL, ATA_HORKAGE_NODMA },
Alan Cox6919a0a2006-10-27 19:08:46 -07003854 { "CRD-84", NULL, ATA_HORKAGE_NODMA },
3855 { "SanDisk SDP3B", NULL, ATA_HORKAGE_NODMA },
3856 { "SanDisk SDP3B-64", NULL, ATA_HORKAGE_NODMA },
3857 { "SANYO CD-ROM CRD", NULL, ATA_HORKAGE_NODMA },
3858 { "HITACHI CDR-8", NULL, ATA_HORKAGE_NODMA },
Mark Lord7da4c932010-07-01 18:18:12 -04003859 { "HITACHI CDR-8[34]35",NULL, ATA_HORKAGE_NODMA },
Alan Cox6919a0a2006-10-27 19:08:46 -07003860 { "Toshiba CD-ROM XM-6202B", NULL, ATA_HORKAGE_NODMA },
3861 { "TOSHIBA CD-ROM XM-1702BC", NULL, ATA_HORKAGE_NODMA },
3862 { "CD-532E-A", NULL, ATA_HORKAGE_NODMA },
3863 { "E-IDE CD-ROM CR-840",NULL, ATA_HORKAGE_NODMA },
3864 { "CD-ROM Drive/F5A", NULL, ATA_HORKAGE_NODMA },
3865 { "WPI CDD-820", NULL, ATA_HORKAGE_NODMA },
3866 { "SAMSUNG CD-ROM SC-148C", NULL, ATA_HORKAGE_NODMA },
3867 { "SAMSUNG CD-ROM SC", NULL, ATA_HORKAGE_NODMA },
Alan Cox6919a0a2006-10-27 19:08:46 -07003868 { "ATAPI CD-ROM DRIVE 40X MAXIMUM",NULL,ATA_HORKAGE_NODMA },
3869 { "_NEC DV5800A", NULL, ATA_HORKAGE_NODMA },
Jeff Garzik2dcb4072007-10-19 06:42:56 -04003870 { "SAMSUNG CD-ROM SN-124", "N001", ATA_HORKAGE_NODMA },
Dave Jones39f19882007-05-21 14:31:03 -04003871 { "Seagate STT20000A", NULL, ATA_HORKAGE_NODMA },
Prarit Bhargavad17d7942012-08-23 15:11:52 -04003872 { " 2GB ATA Flash Disk", "ADMA428M", ATA_HORKAGE_NODMA },
Shikha Jainb00622f2016-01-11 14:55:45 -08003873 { "VRFDFC22048UCHC-TE*", NULL, ATA_HORKAGE_NODMA },
Tejun Heo3af9a772007-09-23 13:19:54 +09003874 /* Odd clown on sil3726/4726 PMPs */
Tejun Heo50af2fa2008-05-19 01:15:14 +09003875 { "Config Disk", NULL, ATA_HORKAGE_DISABLE },
Hannes Reineckea66307d2021-12-08 07:58:53 +01003876 /* Similar story with ASMedia 1092 */
3877 { "ASMT109x- Config", NULL, ATA_HORKAGE_DISABLE },
Alan Cox6919a0a2006-10-27 19:08:46 -07003878
Albert Lee18d6e9d2007-04-02 11:34:15 +08003879 /* Weird ATAPI devices */
Tejun Heo40a1d532007-06-27 02:49:38 +09003880 { "TORiSAN DVD-ROM DRD-N216", NULL, ATA_HORKAGE_MAX_SEC_128 },
Tejun Heo6a87e422008-11-03 19:01:09 +09003881 { "QUANTUM DAT DAT72-000", NULL, ATA_HORKAGE_ATAPI_MOD16_DMA },
Shan Haia32450e2013-03-18 10:30:44 +08003882 { "Slimtype DVD A DS8A8SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
Shan Hai0523f032013-10-28 16:08:01 +08003883 { "Slimtype DVD A DS8A9SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
Albert Lee18d6e9d2007-04-02 11:34:15 +08003884
David Milburnaf34d632015-07-13 11:48:23 -05003885 /*
3886 * Causes silent data corruption with higher max sects.
3887 * http://lkml.kernel.org/g/x49wpy40ysk.fsf@segfault.boston.devel.redhat.com
3888 */
3889 { "ST380013AS", "3.20", ATA_HORKAGE_MAX_SEC_1024 },
3890
Tejun Heo1488a1e2016-07-18 18:40:00 -04003891 /*
Tejun Heoe0edc8c2017-01-06 11:48:50 -05003892 * These devices time out with higher max sects.
Tejun Heo1488a1e2016-07-18 18:40:00 -04003893 * https://bugzilla.kernel.org/show_bug.cgi?id=121671
3894 */
Tejun Heoe0edc8c2017-01-06 11:48:50 -05003895 { "LITEON CX1-JB*-HP", NULL, ATA_HORKAGE_MAX_SEC_1024 },
Xinyu Lindb5ff902017-12-17 20:13:39 +08003896 { "LITEON EP1-*", NULL, ATA_HORKAGE_MAX_SEC_1024 },
Tejun Heo1488a1e2016-07-18 18:40:00 -04003897
Alan Cox6919a0a2006-10-27 19:08:46 -07003898 /* Devices we expect to fail diagnostics */
3899
3900 /* Devices where NCQ should be avoided */
3901 /* NCQ is slow */
Jeff Garzik2dcb4072007-10-19 06:42:56 -04003902 { "WDC WD740ADFD-00", NULL, ATA_HORKAGE_NONCQ },
Tejun Heo459ad682007-12-07 12:46:23 +09003903 { "WDC WD740ADFD-00NLR1", NULL, ATA_HORKAGE_NONCQ, },
Tejun Heo09125ea2007-02-28 15:21:23 +09003904 /* http://thread.gmane.org/gmane.linux.ide/14907 */
3905 { "FUJITSU MHT2060BH", NULL, ATA_HORKAGE_NONCQ },
Paul Rolland7acfaf32007-03-26 21:43:44 -08003906 /* NCQ is broken */
Jeff Garzik539cc7c2007-09-20 16:31:47 -04003907 { "Maxtor *", "BANC*", ATA_HORKAGE_NONCQ },
Alan Cox0e3dbc02007-09-20 15:22:47 +01003908 { "Maxtor 7V300F0", "VA111630", ATA_HORKAGE_NONCQ },
Paolo Ornatida6f0ec2007-10-04 11:06:56 +09003909 { "ST380817AS", "3.42", ATA_HORKAGE_NONCQ },
Tejun Heoe41bd3e2007-12-09 19:45:39 +09003910 { "ST3160023AS", "3.42", ATA_HORKAGE_NONCQ },
Lubomir Bulej5ccfca92008-12-22 11:35:22 +01003911 { "OCZ CORE_SSD", "02.10104", ATA_HORKAGE_NONCQ },
Jeff Garzik539cc7c2007-09-20 16:31:47 -04003912
Tejun Heoac70a962008-11-27 13:36:48 +09003913 /* Seagate NCQ + FLUSH CACHE firmware bug */
Mark Lord4d1f9082010-07-05 18:53:37 -04003914 { "ST31500341AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
Tejun Heoac70a962008-11-27 13:36:48 +09003915 ATA_HORKAGE_FIRMWARE_WARN },
Tejun Heod10d4912008-12-11 13:42:42 +09003916
Mark Lord4d1f9082010-07-05 18:53:37 -04003917 { "ST31000333AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
Tejun Heod10d4912008-12-11 13:42:42 +09003918 ATA_HORKAGE_FIRMWARE_WARN },
3919
Mark Lord4d1f9082010-07-05 18:53:37 -04003920 { "ST3640[36]23AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
Tejun Heod10d4912008-12-11 13:42:42 +09003921 ATA_HORKAGE_FIRMWARE_WARN },
3922
Mark Lord4d1f9082010-07-05 18:53:37 -04003923 { "ST3320[68]13AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
Tejun Heoac70a962008-11-27 13:36:48 +09003924 ATA_HORKAGE_FIRMWARE_WARN },
3925
Hans de Goede31f62642019-06-11 16:32:59 +02003926 /* drives which fail FPDMA_AA activation (some may freeze afterwards)
3927 the ST disks also have LPM issues */
Hans de Goede8756a252019-07-01 18:58:13 +02003928 { "ST1000LM024 HN-M101MBB", NULL, ATA_HORKAGE_BROKEN_FPDMA_AA |
Hans de Goede31f62642019-06-11 16:32:59 +02003929 ATA_HORKAGE_NOLPM, },
Aleksei Mamlin08c85d22015-07-01 13:48:30 +03003930 { "VB0250EAVER", "HPG7", ATA_HORKAGE_BROKEN_FPDMA_AA },
Michele Baldessari87809942013-11-25 19:00:14 +00003931
Robert Hancock36e337d2007-04-02 22:05:29 -06003932 /* Blacklist entries taken from Silicon Image 3124/3132
3933 Windows driver .inf file - also several Linux problem reports */
3934 { "HTS541060G9SA00", "MB3OC60D", ATA_HORKAGE_NONCQ, },
3935 { "HTS541080G9SA00", "MB4OC60D", ATA_HORKAGE_NONCQ, },
3936 { "HTS541010G9SA00", "MBZOC60D", ATA_HORKAGE_NONCQ, },
Alan Cox6919a0a2006-10-27 19:08:46 -07003937
Tejun Heo68b0ddb2010-04-05 10:51:26 +09003938 /* https://bugzilla.kernel.org/show_bug.cgi?id=15573 */
3939 { "C300-CTFDDAC128MAG", "0001", ATA_HORKAGE_NONCQ, },
3940
Tejun Heo3b545562020-09-02 12:32:45 -04003941 /* Sandisk SD7/8/9s lock up hard on large trims */
3942 { "SanDisk SD[789]*", NULL, ATA_HORKAGE_MAX_TRIM_128M, },
Tejun Heo322579d2018-05-08 14:21:56 -07003943
Tejun Heo16c55b02007-08-29 11:58:33 +09003944 /* devices which puke on READ_NATIVE_MAX */
3945 { "HDS724040KLSA80", "KFAOA20N", ATA_HORKAGE_BROKEN_HPA, },
3946 { "WDC WD3200JD-00KLB0", "WD-WCAMR1130137", ATA_HORKAGE_BROKEN_HPA },
3947 { "WDC WD2500JD-00HBB0", "WD-WMAL71490727", ATA_HORKAGE_BROKEN_HPA },
3948 { "MAXTOR 6L080L4", "A93.0500", ATA_HORKAGE_BROKEN_HPA },
Alan Cox6919a0a2006-10-27 19:08:46 -07003949
Tejun Heo7831387b2009-08-07 01:59:15 +09003950 /* this one allows HPA unlocking but fails IOs on the area */
3951 { "OCZ-VERTEX", "1.30", ATA_HORKAGE_BROKEN_HPA },
3952
Alan Cox93328e112007-09-29 04:06:48 -04003953 /* Devices which report 1 sector over size HPA */
3954 { "ST340823A", NULL, ATA_HORKAGE_HPA_SIZE, },
3955 { "ST320413A", NULL, ATA_HORKAGE_HPA_SIZE, },
Mikko Rapelib152fcd2008-02-19 01:41:25 +01003956 { "ST310211A", NULL, ATA_HORKAGE_HPA_SIZE, },
Alan Cox93328e112007-09-29 04:06:48 -04003957
Alan Cox6bbfd532007-11-05 22:58:58 +00003958 /* Devices which get the IVB wrong */
3959 { "QUANTUM FIREBALLlct10 05", "A03.0900", ATA_HORKAGE_IVB, },
Alan Coxa79067e2008-04-29 14:08:36 +01003960 /* Maybe we should just blacklist TSSTcorp... */
Mark Lord7da4c932010-07-01 18:18:12 -04003961 { "TSSTcorp CDDVDW SH-S202[HJN]", "SB0[01]", ATA_HORKAGE_IVB, },
Alan Cox6bbfd532007-11-05 22:58:58 +00003962
Jens Axboe9ce8e302008-08-27 15:23:18 +02003963 /* Devices that do not need bridging limits applied */
3964 { "MTRON MSP-SATA*", NULL, ATA_HORKAGE_BRIDGE_OK, },
Jeff Garzik04d0f1b82012-08-17 13:36:59 -04003965 { "BUFFALO HD-QSU2/R5", NULL, ATA_HORKAGE_BRIDGE_OK, },
Jens Axboe9ce8e302008-08-27 15:23:18 +02003966
Tejun Heo90627122009-01-29 20:31:36 +09003967 /* Devices which aren't very happy with higher link speeds */
3968 { "WD My Book", NULL, ATA_HORKAGE_1_5_GBPS, },
Daniel J Bluemanc5310772012-07-23 12:22:37 +08003969 { "Seagate FreeAgent GoFlex", NULL, ATA_HORKAGE_1_5_GBPS, },
Tejun Heo90627122009-01-29 20:31:36 +09003970
Tejun Heod0cb43b2009-07-09 09:27:50 +09003971 /*
3972 * Devices which choke on SETXFER. Applies only if both the
3973 * device and controller are SATA.
3974 */
Tejun Heocd691872011-06-22 12:13:10 +02003975 { "PIONEER DVD-RW DVRTD08", NULL, ATA_HORKAGE_NOSETXFER },
Vladimir LAVALLADE3a251792012-01-08 13:50:13 +01003976 { "PIONEER DVD-RW DVRTD08A", NULL, ATA_HORKAGE_NOSETXFER },
3977 { "PIONEER DVD-RW DVR-215", NULL, ATA_HORKAGE_NOSETXFER },
Tejun Heocd691872011-06-22 12:13:10 +02003978 { "PIONEER DVD-RW DVR-212D", NULL, ATA_HORKAGE_NOSETXFER },
3979 { "PIONEER DVD-RW DVR-216D", NULL, ATA_HORKAGE_NOSETXFER },
Tejun Heod0cb43b2009-07-09 09:27:50 +09003980
Kai-Heng Fengb17e57292018-02-18 22:17:09 +08003981 /* Crucial BX100 SSD 500GB has broken LPM support */
Hans de Goede3bf7b5d2018-03-19 16:33:59 +01003982 { "CT500BX100SSD1", NULL, ATA_HORKAGE_NOLPM },
Kai-Heng Fengb17e57292018-02-18 22:17:09 +08003983
Hans de Goeded418ff52018-03-19 16:34:00 +01003984 /* 512GB MX100 with MU01 firmware has both queued TRIM and LPM issues */
3985 { "Crucial_CT512MX100*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
Hans de Goede9c7be59f2018-02-16 10:48:20 +01003986 ATA_HORKAGE_ZERO_AFTER_TRIM |
3987 ATA_HORKAGE_NOLPM, },
Hans de Goeded418ff52018-03-19 16:34:00 +01003988 /* 512GB MX100 with newer firmware has only LPM issues */
3989 { "Crucial_CT512MX100*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM |
3990 ATA_HORKAGE_NOLPM, },
Hans de Goede9c7be59f2018-02-16 10:48:20 +01003991
Hans de Goede62ac3f72018-03-19 16:33:58 +01003992 /* 480GB+ M500 SSDs have both queued TRIM and LPM issues */
3993 { "Crucial_CT480M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
3994 ATA_HORKAGE_ZERO_AFTER_TRIM |
3995 ATA_HORKAGE_NOLPM, },
3996 { "Crucial_CT960M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
3997 ATA_HORKAGE_ZERO_AFTER_TRIM |
3998 ATA_HORKAGE_NOLPM, },
3999
François Cami76936e92018-05-13 20:11:15 +02004000 /* These specific Samsung models/firmware-revs do not handle LPM well */
Hans de Goedeb5b4d3a2018-04-24 11:19:07 +02004001 { "SAMSUNG MZMPC128HBFU-000MV", "CXM14M1Q", ATA_HORKAGE_NOLPM, },
François Cami76936e92018-05-13 20:11:15 +02004002 { "SAMSUNG SSD PM830 mSATA *", "CXM13D1Q", ATA_HORKAGE_NOLPM, },
Diego Viola410b5c72018-11-12 17:22:52 -02004003 { "SAMSUNG MZ7TD256HAFV-000L9", NULL, ATA_HORKAGE_NOLPM, },
Hans de Goededd957492019-02-03 10:02:07 +01004004 { "SAMSUNG MZ7TE512HMHP-000L1", "EXT06L0Q", ATA_HORKAGE_NOLPM, },
Hans de Goedeb5b4d3a2018-04-24 11:19:07 +02004005
Marc Carinof78dea02013-12-16 18:15:53 -08004006 /* devices that don't properly handle queued TRIM commands */
Sudip Mukherjee136d7692018-05-19 22:29:36 +01004007 { "Micron_M500IT_*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
4008 ATA_HORKAGE_ZERO_AFTER_TRIM, },
Martin K. Petersen243918b2015-06-18 14:50:18 -04004009 { "Micron_M500_*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
Martin K. Petersene61f7d12015-01-08 10:34:27 -05004010 ATA_HORKAGE_ZERO_AFTER_TRIM, },
Martin K. Petersenff7f53f2015-03-27 15:17:20 -04004011 { "Crucial_CT*M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4012 ATA_HORKAGE_ZERO_AFTER_TRIM, },
Martin K. Petersen9051bd32015-07-15 21:03:23 -04004013 { "Micron_M5[15]0_*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
Martin K. Petersenff7f53f2015-03-27 15:17:20 -04004014 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4015 { "Crucial_CT*M550*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
4016 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4017 { "Crucial_CT*MX100*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
4018 ATA_HORKAGE_ZERO_AFTER_TRIM, },
Ju Hyung Parkca6bfcb2018-03-11 02:28:35 +09004019 { "Samsung SSD 840*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4020 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4021 { "Samsung SSD 850*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
Martin K. Petersen6fc4d972015-03-27 15:17:21 -04004022 ATA_HORKAGE_ZERO_AFTER_TRIM, },
Hans de Goede8a6430a2021-08-23 11:52:20 +02004023 { "Samsung SSD 860*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
Kate Hsuan7a8526a2021-09-03 17:44:11 +08004024 ATA_HORKAGE_ZERO_AFTER_TRIM |
4025 ATA_HORKAGE_NO_NCQ_ON_ATI, },
Hans de Goede8a6430a2021-08-23 11:52:20 +02004026 { "Samsung SSD 870*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
Kate Hsuan7a8526a2021-09-03 17:44:11 +08004027 ATA_HORKAGE_ZERO_AFTER_TRIM |
4028 ATA_HORKAGE_NO_NCQ_ON_ATI, },
Guillermo A. Amaral7a7184b2015-08-25 23:29:13 -07004029 { "FCCT*M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4030 ATA_HORKAGE_ZERO_AFTER_TRIM, },
Martin K. Petersene61f7d12015-01-08 10:34:27 -05004031
Arne Fitzenreitercda57b12015-07-15 13:54:37 +02004032 /* devices that don't properly handle TRIM commands */
4033 { "SuperSSpeed S238*", NULL, ATA_HORKAGE_NOTRIM, },
4034
Martin K. Petersene61f7d12015-01-08 10:34:27 -05004035 /*
4036 * As defined, the DRAT (Deterministic Read After Trim) and RZAT
4037 * (Return Zero After Trim) flags in the ATA Command Set are
4038 * unreliable in the sense that they only define what happens if
4039 * the device successfully executed the DSM TRIM command. TRIM
4040 * is only advisory, however, and the device is free to silently
4041 * ignore all or parts of the request.
4042 *
4043 * Whitelist drives that are known to reliably return zeroes
4044 * after TRIM.
4045 */
4046
4047 /*
4048 * The intel 510 drive has buggy DRAT/RZAT. Explicitly exclude
4049 * that model before whitelisting all other intel SSDs.
4050 */
4051 { "INTEL*SSDSC2MH*", NULL, 0, },
4052
Martin K. Petersenff7f53f2015-03-27 15:17:20 -04004053 { "Micron*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4054 { "Crucial*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
Martin K. Petersene61f7d12015-01-08 10:34:27 -05004055 { "INTEL*SSD*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4056 { "SSD*INTEL*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4057 { "Samsung*SSD*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4058 { "SAMSUNG*SSD*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
Juha-Matti Tillifd6f32f2018-12-02 12:47:08 +02004059 { "SAMSUNG*MZ7KM*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
Martin K. Petersene61f7d12015-01-08 10:34:27 -05004060 { "ST[1248][0248]0[FH]*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
Marc Carinof78dea02013-12-16 18:15:53 -08004061
Tejun Heoecd75ad2014-01-16 09:47:17 -05004062 /*
4063 * Some WD SATA-I drives spin up and down erratically when the link
4064 * is put into the slumber mode. We don't have full list of the
4065 * affected devices. Disable LPM if the device matches one of the
4066 * known prefixes and is SATA-1. As a side effect LPM partial is
4067 * lost too.
4068 *
4069 * https://bugzilla.kernel.org/show_bug.cgi?id=57211
4070 */
4071 { "WDC WD800JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4072 { "WDC WD1200JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4073 { "WDC WD1600JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4074 { "WDC WD2000JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4075 { "WDC WD2500JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4076 { "WDC WD3000JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4077 { "WDC WD3200JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4078
Anton Lundinac9f0c82022-02-03 10:41:35 +01004079 /*
4080 * This sata dom device goes on a walkabout when the ATA_LOG_DIRECTORY
4081 * log page is accessed. Ensure we never ask for this log page with
4082 * these devices.
4083 */
4084 { "SATADOM-ML 3ME", NULL, ATA_HORKAGE_NO_LOG_DIR },
4085
Alan Cox6919a0a2006-10-27 19:08:46 -07004086 /* End Marker */
4087 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004088};
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05004089
Tejun Heo75683fe2007-07-05 13:31:27 +09004090static unsigned long ata_dev_blacklisted(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004091{
Tejun Heo8bfa79f2007-01-02 20:19:40 +09004092 unsigned char model_num[ATA_ID_PROD_LEN + 1];
4093 unsigned char model_rev[ATA_ID_FW_REV_LEN + 1];
Alan Cox6919a0a2006-10-27 19:08:46 -07004094 const struct ata_blacklist_entry *ad = ata_device_blacklist;
Albert Lee3a778272006-06-22 13:00:25 +08004095
Tejun Heo8bfa79f2007-01-02 20:19:40 +09004096 ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
4097 ata_id_c_string(dev->id, model_rev, ATA_ID_FW_REV, sizeof(model_rev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07004098
Alan Cox6919a0a2006-10-27 19:08:46 -07004099 while (ad->model_num) {
George Spelvin1c402792014-10-07 07:26:38 -04004100 if (glob_match(ad->model_num, model_num)) {
Alan Cox6919a0a2006-10-27 19:08:46 -07004101 if (ad->model_rev == NULL)
4102 return ad->horkage;
George Spelvin1c402792014-10-07 07:26:38 -04004103 if (glob_match(ad->model_rev, model_rev))
Alan Cox6919a0a2006-10-27 19:08:46 -07004104 return ad->horkage;
Alan Coxf4b15fe2006-03-22 15:54:04 +00004105 }
Alan Cox6919a0a2006-10-27 19:08:46 -07004106 ad++;
Alan Coxf4b15fe2006-03-22 15:54:04 +00004107 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004108 return 0;
4109}
4110
Alan Cox6919a0a2006-10-27 19:08:46 -07004111static int ata_dma_blacklisted(const struct ata_device *dev)
4112{
4113 /* We don't support polling DMA.
4114 * DMA blacklist those ATAPI devices with CDB-intr (and use PIO)
4115 * if the LLDD handles only interrupts in the HSM_ST_LAST state.
4116 */
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004117 if ((dev->link->ap->flags & ATA_FLAG_PIO_POLLING) &&
Alan Cox6919a0a2006-10-27 19:08:46 -07004118 (dev->flags & ATA_DFLAG_CDB_INTR))
4119 return 1;
Tejun Heo75683fe2007-07-05 13:31:27 +09004120 return (dev->horkage & ATA_HORKAGE_NODMA) ? 1 : 0;
Alan Cox6919a0a2006-10-27 19:08:46 -07004121}
4122
Tejun Heoa6d5a512006-03-06 04:31:57 +09004123/**
Alan Cox6bbfd532007-11-05 22:58:58 +00004124 * ata_is_40wire - check drive side detection
4125 * @dev: device
4126 *
4127 * Perform drive side detection decoding, allowing for device vendors
4128 * who can't follow the documentation.
4129 */
4130
4131static int ata_is_40wire(struct ata_device *dev)
4132{
4133 if (dev->horkage & ATA_HORKAGE_IVB)
4134 return ata_drive_40wire_relaxed(dev->id);
4135 return ata_drive_40wire(dev->id);
4136}
4137
4138/**
Alan Cox15a55512008-03-28 14:33:46 -07004139 * cable_is_40wire - 40/80/SATA decider
4140 * @ap: port to consider
4141 *
4142 * This function encapsulates the policy for speed management
4143 * in one place. At the moment we don't cache the result but
4144 * there is a good case for setting ap->cbl to the result when
4145 * we are called with unknown cables (and figuring out if it
4146 * impacts hotplug at all).
4147 *
4148 * Return 1 if the cable appears to be 40 wire.
4149 */
4150
4151static int cable_is_40wire(struct ata_port *ap)
4152{
4153 struct ata_link *link;
4154 struct ata_device *dev;
4155
Tejun Heo4a9c7b32008-10-27 19:59:23 +09004156 /* If the controller thinks we are 40 wire, we are. */
Alan Cox15a55512008-03-28 14:33:46 -07004157 if (ap->cbl == ATA_CBL_PATA40)
4158 return 1;
Tejun Heo4a9c7b32008-10-27 19:59:23 +09004159
4160 /* If the controller thinks we are 80 wire, we are. */
Alan Cox15a55512008-03-28 14:33:46 -07004161 if (ap->cbl == ATA_CBL_PATA80 || ap->cbl == ATA_CBL_SATA)
4162 return 0;
Tejun Heo4a9c7b32008-10-27 19:59:23 +09004163
4164 /* If the system is known to be 40 wire short cable (eg
4165 * laptop), then we allow 80 wire modes even if the drive
4166 * isn't sure.
4167 */
Alan Coxf7920682008-04-08 16:37:50 +01004168 if (ap->cbl == ATA_CBL_PATA40_SHORT)
4169 return 0;
Alan Cox15a55512008-03-28 14:33:46 -07004170
Tejun Heo4a9c7b32008-10-27 19:59:23 +09004171 /* If the controller doesn't know, we scan.
4172 *
4173 * Note: We look for all 40 wire detects at this point. Any
4174 * 80 wire detect is taken to be 80 wire cable because
4175 * - in many setups only the one drive (slave if present) will
4176 * give a valid detect
4177 * - if you have a non detect capable drive you don't want it
4178 * to colour the choice
4179 */
Tejun Heo1eca4362008-11-03 20:03:17 +09004180 ata_for_each_link(link, ap, EDGE) {
4181 ata_for_each_dev(dev, link, ENABLED) {
4182 if (!ata_is_40wire(dev))
Alan Cox15a55512008-03-28 14:33:46 -07004183 return 0;
4184 }
4185 }
4186 return 1;
4187}
4188
4189/**
Tejun Heoa6d5a512006-03-06 04:31:57 +09004190 * ata_dev_xfermask - Compute supported xfermask of the given device
Tejun Heoa6d5a512006-03-06 04:31:57 +09004191 * @dev: Device to compute xfermask for
4192 *
Tejun Heoacf356b2006-03-24 14:07:50 +09004193 * Compute supported xfermask of @dev and store it in
4194 * dev->*_mask. This function is responsible for applying all
4195 * known limits including host controller limits, device
4196 * blacklist, etc...
Tejun Heoa6d5a512006-03-06 04:31:57 +09004197 *
4198 * LOCKING:
4199 * None.
Tejun Heoa6d5a512006-03-06 04:31:57 +09004200 */
Tejun Heo3373efd2006-05-15 20:57:53 +09004201static void ata_dev_xfermask(struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004202{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004203 struct ata_link *link = dev->link;
4204 struct ata_port *ap = link->ap;
Jeff Garzikcca39742006-08-24 03:19:22 -04004205 struct ata_host *host = ap->host;
Tejun Heoa6d5a512006-03-06 04:31:57 +09004206 unsigned long xfer_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004207
Tejun Heo37deecb2006-08-10 16:59:07 +09004208 /* controller modes available */
Tejun Heo565083e2006-04-02 17:54:47 +09004209 xfer_mask = ata_pack_xfermask(ap->pio_mask,
4210 ap->mwdma_mask, ap->udma_mask);
4211
Robert Hancock8343f882007-03-06 02:37:51 -08004212 /* drive modes available */
Tejun Heo37deecb2006-08-10 16:59:07 +09004213 xfer_mask &= ata_pack_xfermask(dev->pio_mask,
4214 dev->mwdma_mask, dev->udma_mask);
4215 xfer_mask &= ata_id_xfermask(dev->id);
Tejun Heo565083e2006-04-02 17:54:47 +09004216
Alan Coxb352e572006-08-10 18:52:12 +01004217 /*
4218 * CFA Advanced TrueIDE timings are not allowed on a shared
4219 * cable
4220 */
4221 if (ata_dev_pair(dev)) {
4222 /* No PIO5 or PIO6 */
4223 xfer_mask &= ~(0x03 << (ATA_SHIFT_PIO + 5));
4224 /* No MWDMA3 or MWDMA 4 */
4225 xfer_mask &= ~(0x03 << (ATA_SHIFT_MWDMA + 3));
4226 }
4227
Tejun Heo37deecb2006-08-10 16:59:07 +09004228 if (ata_dma_blacklisted(dev)) {
4229 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
Joe Perchesa9a79df2011-04-15 15:51:59 -07004230 ata_dev_warn(dev,
4231 "device is on DMA blacklist, disabling DMA\n");
Tejun Heo37deecb2006-08-10 16:59:07 +09004232 }
Tejun Heoa6d5a512006-03-06 04:31:57 +09004233
Petr Vandrovec14d66ab2007-03-08 10:12:12 +01004234 if ((host->flags & ATA_HOST_SIMPLEX) &&
Jeff Garzik2dcb4072007-10-19 06:42:56 -04004235 host->simplex_claimed && host->simplex_claimed != ap) {
Tejun Heo37deecb2006-08-10 16:59:07 +09004236 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
Joe Perchesa9a79df2011-04-15 15:51:59 -07004237 ata_dev_warn(dev,
4238 "simplex DMA is claimed by other device, disabling DMA\n");
Alan Cox5444a6f2006-03-27 18:58:20 +01004239 }
Tejun Heo565083e2006-04-02 17:54:47 +09004240
Jeff Garzike4246752007-03-09 09:56:46 -05004241 if (ap->flags & ATA_FLAG_NO_IORDY)
4242 xfer_mask &= ata_pio_mask_no_iordy(dev);
4243
Alan Cox5444a6f2006-03-27 18:58:20 +01004244 if (ap->ops->mode_filter)
Alan Coxa76b62ca2007-03-09 09:34:07 -05004245 xfer_mask = ap->ops->mode_filter(dev, xfer_mask);
Alan Cox5444a6f2006-03-27 18:58:20 +01004246
Robert Hancock8343f882007-03-06 02:37:51 -08004247 /* Apply cable rule here. Don't apply it early because when
4248 * we handle hot plug the cable type can itself change.
4249 * Check this last so that we know if the transfer rate was
4250 * solely limited by the cable.
4251 * Unknown or 80 wire cables reported host side are checked
4252 * drive side as well. Cases where we know a 40wire cable
4253 * is used safely for 80 are not checked here.
4254 */
4255 if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
4256 /* UDMA/44 or higher would be available */
Alan Cox15a55512008-03-28 14:33:46 -07004257 if (cable_is_40wire(ap)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07004258 ata_dev_warn(dev,
4259 "limited to UDMA/33 due to 40-wire cable\n");
Robert Hancock8343f882007-03-06 02:37:51 -08004260 xfer_mask &= ~(0xF8 << ATA_SHIFT_UDMA);
4261 }
4262
Tejun Heo565083e2006-04-02 17:54:47 +09004263 ata_unpack_xfermask(xfer_mask, &dev->pio_mask,
4264 &dev->mwdma_mask, &dev->udma_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004265}
4266
Linus Torvalds1da177e2005-04-16 15:20:36 -07004267/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004268 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
Linus Torvalds1da177e2005-04-16 15:20:36 -07004269 * @dev: Device to which command will be sent
4270 *
Jeff Garzik780a87f2005-05-30 15:41:05 -04004271 * Issue SET FEATURES - XFER MODE command to device @dev
4272 * on port @ap.
4273 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004274 * LOCKING:
Jeff Garzik0cba6322005-05-30 19:49:12 -04004275 * PCI/etc. bus probe sem.
Tejun Heo83206a22006-03-24 15:25:31 +09004276 *
4277 * RETURNS:
4278 * 0 on success, AC_ERR_* mask otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004279 */
4280
Tejun Heo3373efd2006-05-15 20:57:53 +09004281static unsigned int ata_dev_set_xfermode(struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004282{
Tejun Heoa0123702005-12-13 14:49:31 +09004283 struct ata_taskfile tf;
Tejun Heo83206a22006-03-24 15:25:31 +09004284 unsigned int err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004285
4286 /* set up set-features taskfile */
Hannes Reinecke46337782021-12-21 08:20:37 +01004287 ata_dev_dbg(dev, "set features - xfer mode\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004288
Tejun Heo464cf172007-05-27 15:10:40 +02004289 /* Some controllers and ATAPI devices show flaky interrupt
4290 * behavior after setting xfer mode. Use polling instead.
4291 */
Tejun Heo3373efd2006-05-15 20:57:53 +09004292 ata_tf_init(dev, &tf);
Tejun Heoa0123702005-12-13 14:49:31 +09004293 tf.command = ATA_CMD_SET_FEATURES;
4294 tf.feature = SETFEATURES_XFER;
Tejun Heo464cf172007-05-27 15:10:40 +02004295 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_POLLING;
Tejun Heoa0123702005-12-13 14:49:31 +09004296 tf.protocol = ATA_PROT_NODATA;
Alan Coxb9f8ab22007-11-19 14:33:11 +00004297 /* If we are using IORDY we must send the mode setting command */
Jeff Garzik11b7bec2007-11-23 21:12:14 -05004298 if (ata_pio_need_iordy(dev))
4299 tf.nsect = dev->xfer_mode;
Alan Coxb9f8ab22007-11-19 14:33:11 +00004300 /* If the device has IORDY and the controller does not - turn it off */
4301 else if (ata_id_has_iordy(dev->id))
Jeff Garzik11b7bec2007-11-23 21:12:14 -05004302 tf.nsect = 0x01;
Alan Coxb9f8ab22007-11-19 14:33:11 +00004303 else /* In the ancient relic department - skip all of this */
4304 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004305
Mikulas Patockad531be22015-07-08 13:06:12 -04004306 /* On some disks, this command causes spin-up, so we need longer timeout */
4307 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 15000);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004308
Tejun Heo83206a22006-03-24 15:25:31 +09004309 return err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004310}
Tejun Heo1152b262010-09-01 17:50:05 +02004311
Linus Torvalds1da177e2005-04-16 15:20:36 -07004312/**
Jeff Garzik218f3d32007-10-25 00:33:27 -04004313 * ata_dev_set_feature - Issue SET FEATURES - SATA FEATURES
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004314 * @dev: Device to which command will be sent
4315 * @enable: Whether to enable or disable the feature
Jeff Garzik218f3d32007-10-25 00:33:27 -04004316 * @feature: The sector count represents the feature to set
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004317 *
4318 * Issue SET FEATURES - SATA FEATURES command to device @dev
Jeff Garzik218f3d32007-10-25 00:33:27 -04004319 * on port @ap with sector count
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004320 *
4321 * LOCKING:
4322 * PCI/etc. bus probe sem.
4323 *
4324 * RETURNS:
4325 * 0 on success, AC_ERR_* mask otherwise.
4326 */
Tejun Heo1152b262010-09-01 17:50:05 +02004327unsigned int ata_dev_set_feature(struct ata_device *dev, u8 enable, u8 feature)
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004328{
4329 struct ata_taskfile tf;
4330 unsigned int err_mask;
Damien Le Moal974e0a42016-04-04 12:17:09 -04004331 unsigned long timeout = 0;
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004332
4333 /* set up set-features taskfile */
Hannes Reinecke46337782021-12-21 08:20:37 +01004334 ata_dev_dbg(dev, "set features - SATA features\n");
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004335
4336 ata_tf_init(dev, &tf);
4337 tf.command = ATA_CMD_SET_FEATURES;
4338 tf.feature = enable;
4339 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4340 tf.protocol = ATA_PROT_NODATA;
Jeff Garzik218f3d32007-10-25 00:33:27 -04004341 tf.nsect = feature;
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004342
Damien Le Moal974e0a42016-04-04 12:17:09 -04004343 if (enable == SETFEATURES_SPINUP)
4344 timeout = ata_probe_timeout ?
4345 ata_probe_timeout * 1000 : SETFEATURES_SPINUP_TIMEOUT;
4346 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, timeout);
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004347
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004348 return err_mask;
4349}
Jeff Garzik633de4c2012-09-13 01:12:29 -04004350EXPORT_SYMBOL_GPL(ata_dev_set_feature);
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -04004351
4352/**
Albert Lee8bf62ece2005-05-12 15:29:42 -04004353 * ata_dev_init_params - Issue INIT DEV PARAMS command
Albert Lee8bf62ece2005-05-12 15:29:42 -04004354 * @dev: Device to which command will be sent
Randy Dunlape2a7f772006-05-18 10:50:18 -07004355 * @heads: Number of heads (taskfile parameter)
4356 * @sectors: Number of sectors (taskfile parameter)
Albert Lee8bf62ece2005-05-12 15:29:42 -04004357 *
4358 * LOCKING:
Tejun Heo6aff8f12006-02-15 18:24:09 +09004359 * Kernel thread context (may sleep)
4360 *
4361 * RETURNS:
4362 * 0 on success, AC_ERR_* mask otherwise.
Albert Lee8bf62ece2005-05-12 15:29:42 -04004363 */
Tejun Heo3373efd2006-05-15 20:57:53 +09004364static unsigned int ata_dev_init_params(struct ata_device *dev,
4365 u16 heads, u16 sectors)
Albert Lee8bf62ece2005-05-12 15:29:42 -04004366{
Tejun Heoa0123702005-12-13 14:49:31 +09004367 struct ata_taskfile tf;
Tejun Heo6aff8f12006-02-15 18:24:09 +09004368 unsigned int err_mask;
Albert Lee8bf62ece2005-05-12 15:29:42 -04004369
4370 /* Number of sectors per track 1-255. Number of heads 1-16 */
4371 if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
Albert Lee00b6f5e2006-03-27 16:39:18 +08004372 return AC_ERR_INVALID;
Albert Lee8bf62ece2005-05-12 15:29:42 -04004373
4374 /* set up init dev params taskfile */
Hannes Reinecke46337782021-12-21 08:20:37 +01004375 ata_dev_dbg(dev, "init dev params \n");
Albert Lee8bf62ece2005-05-12 15:29:42 -04004376
Tejun Heo3373efd2006-05-15 20:57:53 +09004377 ata_tf_init(dev, &tf);
Tejun Heoa0123702005-12-13 14:49:31 +09004378 tf.command = ATA_CMD_INIT_DEV_PARAMS;
4379 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4380 tf.protocol = ATA_PROT_NODATA;
4381 tf.nsect = sectors;
4382 tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
Albert Lee8bf62ece2005-05-12 15:29:42 -04004383
Tejun Heo2b789102007-10-09 15:05:44 +09004384 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
Alan Cox18b24662007-08-08 14:28:49 +01004385 /* A clean abort indicates an original or just out of spec drive
4386 and we should continue as we issue the setup based on the
4387 drive reported working geometry */
4388 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
4389 err_mask = 0;
Albert Lee8bf62ece2005-05-12 15:29:42 -04004390
Tejun Heo6aff8f12006-02-15 18:24:09 +09004391 return err_mask;
Albert Lee8bf62ece2005-05-12 15:29:42 -04004392}
4393
4394/**
Tejun Heo5895ef92008-06-17 12:36:26 +09004395 * atapi_check_dma - Check whether ATAPI DMA can be supported
Linus Torvalds1da177e2005-04-16 15:20:36 -07004396 * @qc: Metadata associated with taskfile to check
4397 *
Jeff Garzik780a87f2005-05-30 15:41:05 -04004398 * Allow low-level driver to filter ATA PACKET commands, returning
4399 * a status indicating whether or not it is OK to use DMA for the
4400 * supplied PACKET command.
4401 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004402 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004403 * spin_lock_irqsave(host lock)
Jeff Garzik0cba6322005-05-30 19:49:12 -04004404 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004405 * RETURNS: 0 when ATAPI DMA can be used
4406 * nonzero otherwise
4407 */
Tejun Heo5895ef92008-06-17 12:36:26 +09004408int atapi_check_dma(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004409{
4410 struct ata_port *ap = qc->ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004411
Tejun Heob9a41972007-06-27 02:48:43 +09004412 /* Don't allow DMA if it isn't multiple of 16 bytes. Quite a
4413 * few ATAPI devices choke on such DMA requests.
4414 */
Tejun Heo6a87e422008-11-03 19:01:09 +09004415 if (!(qc->dev->horkage & ATA_HORKAGE_ATAPI_MOD16_DMA) &&
4416 unlikely(qc->nbytes & 15))
Tejun Heob9a41972007-06-27 02:48:43 +09004417 return 1;
Albert Lee6f23a312007-04-02 11:39:25 +08004418
Linus Torvalds1da177e2005-04-16 15:20:36 -07004419 if (ap->ops->check_atapi_dma)
Tejun Heob9a41972007-06-27 02:48:43 +09004420 return ap->ops->check_atapi_dma(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004421
Tejun Heob9a41972007-06-27 02:48:43 +09004422 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004423}
Tejun Heob9a41972007-06-27 02:48:43 +09004424
Linus Torvalds1da177e2005-04-16 15:20:36 -07004425/**
Tejun Heo31cc23b2007-09-23 13:14:12 +09004426 * ata_std_qc_defer - Check whether a qc needs to be deferred
4427 * @qc: ATA command in question
4428 *
4429 * Non-NCQ commands cannot run with any other command, NCQ or
4430 * not. As upper layer only knows the queue depth, we are
4431 * responsible for maintaining exclusion. This function checks
4432 * whether a new command @qc can be issued.
4433 *
4434 * LOCKING:
4435 * spin_lock_irqsave(host lock)
4436 *
4437 * RETURNS:
4438 * ATA_DEFER_* if deferring is needed, 0 otherwise.
4439 */
4440int ata_std_qc_defer(struct ata_queued_cmd *qc)
4441{
4442 struct ata_link *link = qc->dev->link;
4443
Hannes Reinecke179b3102016-07-14 09:05:43 +09004444 if (ata_is_ncq(qc->tf.protocol)) {
Tejun Heo31cc23b2007-09-23 13:14:12 +09004445 if (!ata_tag_valid(link->active_tag))
4446 return 0;
4447 } else {
4448 if (!ata_tag_valid(link->active_tag) && !link->sactive)
4449 return 0;
4450 }
4451
4452 return ATA_DEFER_LINK;
4453}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01004454EXPORT_SYMBOL_GPL(ata_std_qc_defer);
Tejun Heo31cc23b2007-09-23 13:14:12 +09004455
Jiri Slaby95364f32019-10-31 10:59:45 +01004456enum ata_completion_errors ata_noop_qc_prep(struct ata_queued_cmd *qc)
4457{
4458 return AC_ERR_OK;
4459}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01004460EXPORT_SYMBOL_GPL(ata_noop_qc_prep);
Brian Kinge46834c2006-03-17 17:04:03 -06004461
Jeff Garzik0cba6322005-05-30 19:49:12 -04004462/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04004463 * ata_sg_init - Associate command with scatter-gather table.
4464 * @qc: Command to be associated
4465 * @sg: Scatter-gather table.
4466 * @n_elem: Number of elements in s/g table.
4467 *
4468 * Initialize the data-related elements of queued_cmd @qc
4469 * to point to a scatter-gather table @sg, containing @n_elem
4470 * elements.
4471 *
4472 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004473 * spin_lock_irqsave(host lock)
Jeff Garzik0cba6322005-05-30 19:49:12 -04004474 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004475void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
4476 unsigned int n_elem)
4477{
Tejun Heoff2aeb12007-12-05 16:43:11 +09004478 qc->sg = sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004479 qc->n_elem = n_elem;
Tejun Heoff2aeb12007-12-05 16:43:11 +09004480 qc->cursg = qc->sg;
4481}
4482
Geert Uytterhoeven2874d5e2017-01-03 19:09:49 +01004483#ifdef CONFIG_HAS_DMA
4484
4485/**
4486 * ata_sg_clean - Unmap DMA memory associated with command
4487 * @qc: Command containing DMA memory to be released
4488 *
4489 * Unmap all mapped DMA memory associated with this command.
4490 *
4491 * LOCKING:
4492 * spin_lock_irqsave(host lock)
4493 */
Jason Yanaf27e012017-03-10 10:05:40 +08004494static void ata_sg_clean(struct ata_queued_cmd *qc)
Geert Uytterhoeven2874d5e2017-01-03 19:09:49 +01004495{
4496 struct ata_port *ap = qc->ap;
4497 struct scatterlist *sg = qc->sg;
4498 int dir = qc->dma_dir;
4499
4500 WARN_ON_ONCE(sg == NULL);
4501
Geert Uytterhoeven2874d5e2017-01-03 19:09:49 +01004502 if (qc->n_elem)
4503 dma_unmap_sg(ap->dev, sg, qc->orig_n_elem, dir);
4504
4505 qc->flags &= ~ATA_QCFLAG_DMAMAP;
4506 qc->sg = NULL;
4507}
4508
Linus Torvalds1da177e2005-04-16 15:20:36 -07004509/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04004510 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
4511 * @qc: Command with scatter-gather table to be mapped.
4512 *
4513 * DMA-map the scatter-gather table associated with queued_cmd @qc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004514 *
4515 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004516 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004517 *
4518 * RETURNS:
Jeff Garzik0cba6322005-05-30 19:49:12 -04004519 * Zero on success, negative on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004520 *
4521 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004522static int ata_sg_setup(struct ata_queued_cmd *qc)
4523{
4524 struct ata_port *ap = qc->ap;
James Bottomleydde20202008-02-19 11:36:56 +01004525 unsigned int n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004526
James Bottomleydde20202008-02-19 11:36:56 +01004527 n_elem = dma_map_sg(ap->dev, qc->sg, qc->n_elem, qc->dma_dir);
4528 if (n_elem < 1)
4529 return -1;
Jeff Garzikcedc9a42005-10-05 07:13:30 -04004530
FUJITA Tomonori58256272009-02-27 17:35:43 +09004531 qc->orig_n_elem = qc->n_elem;
James Bottomleydde20202008-02-19 11:36:56 +01004532 qc->n_elem = n_elem;
Tejun Heof92a2632007-12-05 16:43:10 +09004533 qc->flags |= ATA_QCFLAG_DMAMAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004534
4535 return 0;
4536}
4537
Geert Uytterhoeven2874d5e2017-01-03 19:09:49 +01004538#else /* !CONFIG_HAS_DMA */
4539
4540static inline void ata_sg_clean(struct ata_queued_cmd *qc) {}
4541static inline int ata_sg_setup(struct ata_queued_cmd *qc) { return -1; }
4542
4543#endif /* !CONFIG_HAS_DMA */
4544
Linus Torvalds1da177e2005-04-16 15:20:36 -07004545/**
Randy Dunlapc893a3a2006-01-28 13:15:32 -05004546 * swap_buf_le16 - swap halves of 16-bit words in place
Edward Falk0baab862005-06-02 18:17:13 -04004547 * @buf: Buffer to swap
4548 * @buf_words: Number of 16-bit words in buffer.
4549 *
4550 * Swap halves of 16-bit words if needed to convert from
4551 * little-endian byte order to native cpu byte order, or
4552 * vice-versa.
4553 *
4554 * LOCKING:
Randy Dunlap6f0ef4f2005-10-25 01:44:30 -04004555 * Inherited from caller.
Edward Falk0baab862005-06-02 18:17:13 -04004556 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004557void swap_buf_le16(u16 *buf, unsigned int buf_words)
4558{
4559#ifdef __BIG_ENDIAN
4560 unsigned int i;
4561
4562 for (i = 0; i < buf_words; i++)
4563 buf[i] = le16_to_cpu(buf[i]);
4564#endif /* __BIG_ENDIAN */
4565}
4566
Albert Lee6ae4cfb2005-08-12 14:15:34 +08004567/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004568 * ata_qc_new_init - Request an available ATA command, and initialize it
Linus Torvalds1da177e2005-04-16 15:20:36 -07004569 * @dev: Device from whom we request an available command structure
Randy Dunlap38755e82015-08-09 18:37:36 -07004570 * @tag: tag
Linus Torvalds1da177e2005-04-16 15:20:36 -07004571 *
4572 * LOCKING:
Jeff Garzik0cba6322005-05-30 19:49:12 -04004573 * None.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004574 */
4575
Shaohua Li98bd4be2015-01-23 19:52:07 -08004576struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004577{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004578 struct ata_port *ap = dev->link->ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004579 struct ata_queued_cmd *qc;
4580
Shaohua Li98bd4be2015-01-23 19:52:07 -08004581 /* no command while frozen */
4582 if (unlikely(ap->pflags & ATA_PFLAG_FROZEN))
4583 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004584
Shaohua Li98bd4be2015-01-23 19:52:07 -08004585 /* libsas case */
Shaohua Li5067c042015-03-12 10:32:18 -07004586 if (ap->flags & ATA_FLAG_SAS_HOST) {
Shaohua Li98bd4be2015-01-23 19:52:07 -08004587 tag = ata_sas_allocate_tag(ap);
4588 if (tag < 0)
4589 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004590 }
4591
Shaohua Li98bd4be2015-01-23 19:52:07 -08004592 qc = __ata_qc_from_tag(ap, tag);
Jens Axboe5ac40792018-05-11 12:51:03 -06004593 qc->tag = qc->hw_tag = tag;
Shaohua Li98bd4be2015-01-23 19:52:07 -08004594 qc->scsicmd = NULL;
4595 qc->ap = ap;
4596 qc->dev = dev;
4597
4598 ata_qc_reinit(qc);
4599
Linus Torvalds1da177e2005-04-16 15:20:36 -07004600 return qc;
4601}
4602
Tejun Heo8a8bc222008-11-10 14:48:21 +09004603/**
4604 * ata_qc_free - free unused ata_queued_cmd
4605 * @qc: Command to complete
4606 *
4607 * Designed to free unused ata_queued_cmd object
4608 * in case something prevents using it.
4609 *
4610 * LOCKING:
4611 * spin_lock_irqsave(host lock)
4612 */
4613void ata_qc_free(struct ata_queued_cmd *qc)
4614{
Julia Lawalla1104012009-10-17 08:41:47 +02004615 struct ata_port *ap;
Tejun Heo8a8bc222008-11-10 14:48:21 +09004616 unsigned int tag;
4617
Tejun Heoefcb3cf2009-01-09 19:19:14 +09004618 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
Julia Lawalla1104012009-10-17 08:41:47 +02004619 ap = qc->ap;
Tejun Heo8a8bc222008-11-10 14:48:21 +09004620
4621 qc->flags = 0;
4622 tag = qc->tag;
Jens Axboe28361c42018-05-11 12:51:09 -06004623 if (ata_tag_valid(tag)) {
Tejun Heo8a8bc222008-11-10 14:48:21 +09004624 qc->tag = ATA_TAG_POISON;
Shaohua Li5067c042015-03-12 10:32:18 -07004625 if (ap->flags & ATA_FLAG_SAS_HOST)
Shaohua Li98bd4be2015-01-23 19:52:07 -08004626 ata_sas_free_tag(tag, ap);
Tejun Heo8a8bc222008-11-10 14:48:21 +09004627 }
4628}
4629
Tejun Heo76014422006-02-11 15:13:49 +09004630void __ata_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004631{
Julia Lawalla1104012009-10-17 08:41:47 +02004632 struct ata_port *ap;
4633 struct ata_link *link;
Tejun Heodedaf2b2006-05-15 21:03:43 +09004634
Tejun Heoefcb3cf2009-01-09 19:19:14 +09004635 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
4636 WARN_ON_ONCE(!(qc->flags & ATA_QCFLAG_ACTIVE));
Julia Lawalla1104012009-10-17 08:41:47 +02004637 ap = qc->ap;
4638 link = qc->dev->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004639
4640 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
4641 ata_sg_clean(qc);
4642
Tejun Heo7401abf2006-05-15 20:57:32 +09004643 /* command should be marked inactive atomically with qc completion */
Hannes Reinecke179b3102016-07-14 09:05:43 +09004644 if (ata_is_ncq(qc->tf.protocol)) {
Jens Axboe4e5b6262018-05-11 12:51:04 -06004645 link->sactive &= ~(1 << qc->hw_tag);
Tejun Heoda917d62007-09-23 13:14:12 +09004646 if (!link->sactive)
4647 ap->nr_active_links--;
4648 } else {
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004649 link->active_tag = ATA_TAG_POISON;
Tejun Heoda917d62007-09-23 13:14:12 +09004650 ap->nr_active_links--;
4651 }
4652
4653 /* clear exclusive status */
4654 if (unlikely(qc->flags & ATA_QCFLAG_CLEAR_EXCL &&
4655 ap->excl_link == link))
4656 ap->excl_link = NULL;
Tejun Heo7401abf2006-05-15 20:57:32 +09004657
Albert Lee3f3791d2005-08-16 14:25:38 +08004658 /* atapi: mark qc as inactive to prevent the interrupt handler
4659 * from completing the command twice later, before the error handler
4660 * is called. (when rc != 0 and atapi request sense is needed)
4661 */
4662 qc->flags &= ~ATA_QCFLAG_ACTIVE;
Jens Axboee3ed89392018-05-11 12:51:05 -06004663 ap->qc_active &= ~(1ULL << qc->tag);
Albert Lee3f3791d2005-08-16 14:25:38 +08004664
Linus Torvalds1da177e2005-04-16 15:20:36 -07004665 /* call completion callback */
Tejun Heo77853bf2006-01-23 13:09:36 +09004666 qc->complete_fn(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004667}
4668
Tejun Heo39599a52006-11-14 22:37:35 +09004669static void fill_result_tf(struct ata_queued_cmd *qc)
4670{
4671 struct ata_port *ap = qc->ap;
4672
Tejun Heo39599a52006-11-14 22:37:35 +09004673 qc->result_tf.flags = qc->tf.flags;
Tejun Heo22183bf2008-04-07 22:47:20 +09004674 ap->ops->qc_fill_rtf(qc);
Tejun Heo39599a52006-11-14 22:37:35 +09004675}
4676
Tejun Heo00115e02007-11-27 19:28:58 +09004677static void ata_verify_xfer(struct ata_queued_cmd *qc)
4678{
4679 struct ata_device *dev = qc->dev;
4680
Christoph Hellwigeb0effd2016-07-16 22:16:41 +09004681 if (!ata_is_data(qc->tf.protocol))
Tejun Heo00115e02007-11-27 19:28:58 +09004682 return;
4683
4684 if ((dev->mwdma_mask || dev->udma_mask) && ata_is_pio(qc->tf.protocol))
4685 return;
4686
4687 dev->flags &= ~ATA_DFLAG_DUBIOUS_XFER;
4688}
4689
Tejun Heof686bcb2006-05-15 20:58:05 +09004690/**
4691 * ata_qc_complete - Complete an active ATA command
4692 * @qc: Command to complete
Tejun Heof686bcb2006-05-15 20:58:05 +09004693 *
Tejun Heo1aadf5c2010-06-25 15:03:34 +02004694 * Indicate to the mid and upper layers that an ATA command has
4695 * completed, with either an ok or not-ok status.
4696 *
4697 * Refrain from calling this function multiple times when
4698 * successfully completing multiple NCQ commands.
4699 * ata_qc_complete_multiple() should be used instead, which will
4700 * properly update IRQ expect state.
Tejun Heof686bcb2006-05-15 20:58:05 +09004701 *
4702 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004703 * spin_lock_irqsave(host lock)
Tejun Heof686bcb2006-05-15 20:58:05 +09004704 */
4705void ata_qc_complete(struct ata_queued_cmd *qc)
4706{
4707 struct ata_port *ap = qc->ap;
4708
Stephan Linzeb25cb92016-06-10 07:59:56 +02004709 /* Trigger the LED (if available) */
Linus Walleijd1ed7c52018-02-24 23:45:56 +01004710 ledtrig_disk_activity(!!(qc->tf.flags & ATA_TFLAG_WRITE));
Stephan Linzeb25cb92016-06-10 07:59:56 +02004711
Tejun Heof686bcb2006-05-15 20:58:05 +09004712 /* XXX: New EH and old EH use different mechanisms to
4713 * synchronize EH with regular execution path.
4714 *
4715 * In new EH, a failed qc is marked with ATA_QCFLAG_FAILED.
4716 * Normal execution path is responsible for not accessing a
4717 * failed qc. libata core enforces the rule by returning NULL
4718 * from ata_qc_from_tag() for failed qcs.
4719 *
4720 * Old EH depends on ata_qc_complete() nullifying completion
4721 * requests if ATA_QCFLAG_EH_SCHEDULED is set. Old EH does
4722 * not synchronize with interrupt handler. Only PIO task is
4723 * taken care of.
4724 */
4725 if (ap->ops->error_handler) {
Tejun Heo4dbfa392007-10-25 18:22:44 +09004726 struct ata_device *dev = qc->dev;
4727 struct ata_eh_info *ehi = &dev->link->eh_info;
4728
Tejun Heof686bcb2006-05-15 20:58:05 +09004729 if (unlikely(qc->err_mask))
4730 qc->flags |= ATA_QCFLAG_FAILED;
4731
Tejun Heof08dc1a2010-12-09 15:59:32 +01004732 /*
4733 * Finish internal commands without any further processing
4734 * and always with the result TF filled.
4735 */
4736 if (unlikely(ata_tag_internal(qc->tag))) {
Tejun Heof4b31db92009-10-16 13:00:51 +09004737 fill_result_tf(qc);
Hannes Reinecke255c03d2015-03-27 16:46:38 +01004738 trace_ata_qc_complete_internal(qc);
Tejun Heof08dc1a2010-12-09 15:59:32 +01004739 __ata_qc_complete(qc);
4740 return;
4741 }
Tejun Heof4b31db92009-10-16 13:00:51 +09004742
Tejun Heof08dc1a2010-12-09 15:59:32 +01004743 /*
4744 * Non-internal qc has failed. Fill the result TF and
4745 * summon EH.
4746 */
4747 if (unlikely(qc->flags & ATA_QCFLAG_FAILED)) {
4748 fill_result_tf(qc);
Hannes Reinecke255c03d2015-03-27 16:46:38 +01004749 trace_ata_qc_complete_failed(qc);
Tejun Heof08dc1a2010-12-09 15:59:32 +01004750 ata_qc_schedule_eh(qc);
Tejun Heof4b31db92009-10-16 13:00:51 +09004751 return;
Tejun Heof686bcb2006-05-15 20:58:05 +09004752 }
4753
Tejun Heo4dc738e2009-09-17 18:45:27 +09004754 WARN_ON_ONCE(ap->pflags & ATA_PFLAG_FROZEN);
4755
Tejun Heof686bcb2006-05-15 20:58:05 +09004756 /* read result TF if requested */
4757 if (qc->flags & ATA_QCFLAG_RESULT_TF)
Tejun Heo39599a52006-11-14 22:37:35 +09004758 fill_result_tf(qc);
Tejun Heof686bcb2006-05-15 20:58:05 +09004759
Hannes Reinecke255c03d2015-03-27 16:46:38 +01004760 trace_ata_qc_complete_done(qc);
Tejun Heo4dbfa392007-10-25 18:22:44 +09004761 /* Some commands need post-processing after successful
4762 * completion.
4763 */
4764 switch (qc->tf.command) {
4765 case ATA_CMD_SET_FEATURES:
4766 if (qc->tf.feature != SETFEATURES_WC_ON &&
Tom Yan0c127352016-07-12 21:37:02 +08004767 qc->tf.feature != SETFEATURES_WC_OFF &&
4768 qc->tf.feature != SETFEATURES_RA_ON &&
4769 qc->tf.feature != SETFEATURES_RA_OFF)
Tejun Heo4dbfa392007-10-25 18:22:44 +09004770 break;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05004771 fallthrough;
Tejun Heo4dbfa392007-10-25 18:22:44 +09004772 case ATA_CMD_INIT_DEV_PARAMS: /* CHS translation changed */
4773 case ATA_CMD_SET_MULTI: /* multi_count changed */
4774 /* revalidate device */
4775 ehi->dev_action[dev->devno] |= ATA_EH_REVALIDATE;
4776 ata_port_schedule_eh(ap);
4777 break;
Tejun Heo054a5fb2007-10-25 18:30:36 +09004778
4779 case ATA_CMD_SLEEP:
4780 dev->flags |= ATA_DFLAG_SLEEPING;
4781 break;
Tejun Heo4dbfa392007-10-25 18:22:44 +09004782 }
4783
Tejun Heo00115e02007-11-27 19:28:58 +09004784 if (unlikely(dev->flags & ATA_DFLAG_DUBIOUS_XFER))
4785 ata_verify_xfer(qc);
4786
Tejun Heof686bcb2006-05-15 20:58:05 +09004787 __ata_qc_complete(qc);
4788 } else {
4789 if (qc->flags & ATA_QCFLAG_EH_SCHEDULED)
4790 return;
4791
4792 /* read result TF if failed or requested */
4793 if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
Tejun Heo39599a52006-11-14 22:37:35 +09004794 fill_result_tf(qc);
Tejun Heof686bcb2006-05-15 20:58:05 +09004795
4796 __ata_qc_complete(qc);
4797 }
4798}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01004799EXPORT_SYMBOL_GPL(ata_qc_complete);
Tejun Heof686bcb2006-05-15 20:58:05 +09004800
Tejun Heodedaf2b2006-05-15 21:03:43 +09004801/**
Sascha Hauer8385d752019-12-13 09:04:08 +01004802 * ata_qc_get_active - get bitmask of active qcs
4803 * @ap: port in question
4804 *
4805 * LOCKING:
4806 * spin_lock_irqsave(host lock)
4807 *
4808 * RETURNS:
4809 * Bitmask of active qcs
4810 */
4811u64 ata_qc_get_active(struct ata_port *ap)
4812{
4813 u64 qc_active = ap->qc_active;
4814
4815 /* ATA_TAG_INTERNAL is sent to hw as tag 0 */
4816 if (qc_active & (1ULL << ATA_TAG_INTERNAL)) {
4817 qc_active |= (1 << 0);
4818 qc_active &= ~(1ULL << ATA_TAG_INTERNAL);
4819 }
4820
4821 return qc_active;
4822}
4823EXPORT_SYMBOL_GPL(ata_qc_get_active);
4824
4825/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004826 * ata_qc_issue - issue taskfile to device
4827 * @qc: command to issue to device
4828 *
4829 * Prepare an ATA command to submission to device.
4830 * This includes mapping the data into a DMA-able
4831 * area, filling in the S/G table, and finally
4832 * writing the taskfile to hardware, starting the command.
4833 *
4834 * LOCKING:
Jeff Garzikcca39742006-08-24 03:19:22 -04004835 * spin_lock_irqsave(host lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004836 */
Tejun Heo8e0e6942006-03-31 20:41:11 +09004837void ata_qc_issue(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004838{
4839 struct ata_port *ap = qc->ap;
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004840 struct ata_link *link = qc->dev->link;
Tejun Heo405e66b2007-11-27 19:28:53 +09004841 u8 prot = qc->tf.protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004842
Tejun Heodedaf2b2006-05-15 21:03:43 +09004843 /* Make sure only one non-NCQ command is outstanding. The
4844 * check is skipped for old EH because it reuses active qc to
4845 * request ATAPI sense.
4846 */
Tejun Heoefcb3cf2009-01-09 19:19:14 +09004847 WARN_ON_ONCE(ap->ops->error_handler && ata_tag_valid(link->active_tag));
Tejun Heodedaf2b2006-05-15 21:03:43 +09004848
Tejun Heo1973a022007-12-05 10:36:13 +09004849 if (ata_is_ncq(prot)) {
Jens Axboe4e5b6262018-05-11 12:51:04 -06004850 WARN_ON_ONCE(link->sactive & (1 << qc->hw_tag));
Tejun Heoda917d62007-09-23 13:14:12 +09004851
4852 if (!link->sactive)
4853 ap->nr_active_links++;
Jens Axboe4e5b6262018-05-11 12:51:04 -06004854 link->sactive |= 1 << qc->hw_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +09004855 } else {
Tejun Heoefcb3cf2009-01-09 19:19:14 +09004856 WARN_ON_ONCE(link->sactive);
Tejun Heoda917d62007-09-23 13:14:12 +09004857
4858 ap->nr_active_links++;
Tejun Heo9af5c9c2007-08-06 18:36:22 +09004859 link->active_tag = qc->tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +09004860 }
4861
Tejun Heoe4a70e72006-03-31 20:36:47 +09004862 qc->flags |= ATA_QCFLAG_ACTIVE;
Jens Axboee3ed89392018-05-11 12:51:05 -06004863 ap->qc_active |= 1ULL << qc->tag;
Tejun Heoe4a70e72006-03-31 20:36:47 +09004864
Tejun Heo60f5d6e2010-08-23 11:27:27 +02004865 /*
4866 * We guarantee to LLDs that they will have at least one
Tejun Heof92a2632007-12-05 16:43:10 +09004867 * non-zero sg if the command is a data command.
4868 */
Eric Biggers9173e5e2018-02-03 20:33:27 -08004869 if (ata_is_data(prot) && (!qc->sg || !qc->n_elem || !qc->nbytes))
Tejun Heo60f5d6e2010-08-23 11:27:27 +02004870 goto sys_err;
Tejun Heof92a2632007-12-05 16:43:10 +09004871
Tejun Heo405e66b2007-11-27 19:28:53 +09004872 if (ata_is_dma(prot) || (ata_is_pio(prot) &&
Tejun Heof92a2632007-12-05 16:43:10 +09004873 (ap->flags & ATA_FLAG_PIO_DMA)))
Tejun Heo001102d2007-12-05 16:43:09 +09004874 if (ata_sg_setup(qc))
Tejun Heo60f5d6e2010-08-23 11:27:27 +02004875 goto sys_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004876
Tejun Heocf480622008-01-24 00:05:14 +09004877 /* if device is sleeping, schedule reset and abort the link */
Tejun Heo054a5fb2007-10-25 18:30:36 +09004878 if (unlikely(qc->dev->flags & ATA_DFLAG_SLEEPING)) {
Tejun Heocf480622008-01-24 00:05:14 +09004879 link->eh_info.action |= ATA_EH_RESET;
Tejun Heo054a5fb2007-10-25 18:30:36 +09004880 ata_ehi_push_desc(&link->eh_info, "waking up from sleep");
4881 ata_link_abort(link);
4882 return;
4883 }
4884
Hannes Reineckefc914fa2021-12-21 08:20:30 +01004885 trace_ata_qc_prep(qc);
Jiri Slaby95364f32019-10-31 10:59:45 +01004886 qc->err_mask |= ap->ops->qc_prep(qc);
4887 if (unlikely(qc->err_mask))
4888 goto err;
Hannes Reinecke255c03d2015-03-27 16:46:38 +01004889 trace_ata_qc_issue(qc);
Tejun Heo8e0e6942006-03-31 20:41:11 +09004890 qc->err_mask |= ap->ops->qc_issue(qc);
4891 if (unlikely(qc->err_mask))
4892 goto err;
4893 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004894
Tejun Heo60f5d6e2010-08-23 11:27:27 +02004895sys_err:
Tejun Heo8e0e6942006-03-31 20:41:11 +09004896 qc->err_mask |= AC_ERR_SYSTEM;
4897err:
4898 ata_qc_complete(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004899}
4900
4901/**
Tejun Heob1c72912008-07-31 17:02:43 +09004902 * ata_phys_link_online - test whether the given link is online
Tejun Heo936fd732007-08-06 18:36:23 +09004903 * @link: ATA link to test
Tejun Heo34bf2172006-05-15 20:57:46 +09004904 *
Tejun Heo936fd732007-08-06 18:36:23 +09004905 * Test whether @link is online. Note that this function returns
4906 * 0 if online status of @link cannot be obtained, so
4907 * ata_link_online(link) != !ata_link_offline(link).
Tejun Heo34bf2172006-05-15 20:57:46 +09004908 *
4909 * LOCKING:
4910 * None.
4911 *
4912 * RETURNS:
Tejun Heob5b3fa32008-07-31 17:02:42 +09004913 * True if the port online status is available and online.
Tejun Heo34bf2172006-05-15 20:57:46 +09004914 */
Tejun Heob1c72912008-07-31 17:02:43 +09004915bool ata_phys_link_online(struct ata_link *link)
Tejun Heo34bf2172006-05-15 20:57:46 +09004916{
4917 u32 sstatus;
4918
Tejun Heo936fd732007-08-06 18:36:23 +09004919 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
Tejun Heo9913ff8a2009-01-29 20:31:31 +09004920 ata_sstatus_online(sstatus))
Tejun Heob5b3fa32008-07-31 17:02:42 +09004921 return true;
4922 return false;
Tejun Heo34bf2172006-05-15 20:57:46 +09004923}
4924
4925/**
Tejun Heob1c72912008-07-31 17:02:43 +09004926 * ata_phys_link_offline - test whether the given link is offline
Tejun Heo936fd732007-08-06 18:36:23 +09004927 * @link: ATA link to test
Tejun Heo34bf2172006-05-15 20:57:46 +09004928 *
Tejun Heo936fd732007-08-06 18:36:23 +09004929 * Test whether @link is offline. Note that this function
4930 * returns 0 if offline status of @link cannot be obtained, so
4931 * ata_link_online(link) != !ata_link_offline(link).
Tejun Heo34bf2172006-05-15 20:57:46 +09004932 *
4933 * LOCKING:
4934 * None.
4935 *
4936 * RETURNS:
Tejun Heob5b3fa32008-07-31 17:02:42 +09004937 * True if the port offline status is available and offline.
Tejun Heo34bf2172006-05-15 20:57:46 +09004938 */
Tejun Heob1c72912008-07-31 17:02:43 +09004939bool ata_phys_link_offline(struct ata_link *link)
Tejun Heo34bf2172006-05-15 20:57:46 +09004940{
4941 u32 sstatus;
4942
Tejun Heo936fd732007-08-06 18:36:23 +09004943 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
Tejun Heo9913ff8a2009-01-29 20:31:31 +09004944 !ata_sstatus_online(sstatus))
Tejun Heob5b3fa32008-07-31 17:02:42 +09004945 return true;
4946 return false;
Tejun Heo34bf2172006-05-15 20:57:46 +09004947}
Edward Falk0baab862005-06-02 18:17:13 -04004948
Tejun Heob1c72912008-07-31 17:02:43 +09004949/**
4950 * ata_link_online - test whether the given link is online
4951 * @link: ATA link to test
4952 *
4953 * Test whether @link is online. This is identical to
4954 * ata_phys_link_online() when there's no slave link. When
4955 * there's a slave link, this function should only be called on
4956 * the master link and will return true if any of M/S links is
4957 * online.
4958 *
4959 * LOCKING:
4960 * None.
4961 *
4962 * RETURNS:
4963 * True if the port online status is available and online.
4964 */
4965bool ata_link_online(struct ata_link *link)
4966{
4967 struct ata_link *slave = link->ap->slave_link;
4968
4969 WARN_ON(link == slave); /* shouldn't be called on slave link */
4970
4971 return ata_phys_link_online(link) ||
4972 (slave && ata_phys_link_online(slave));
4973}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01004974EXPORT_SYMBOL_GPL(ata_link_online);
Tejun Heob1c72912008-07-31 17:02:43 +09004975
4976/**
4977 * ata_link_offline - test whether the given link is offline
4978 * @link: ATA link to test
4979 *
4980 * Test whether @link is offline. This is identical to
4981 * ata_phys_link_offline() when there's no slave link. When
4982 * there's a slave link, this function should only be called on
4983 * the master link and will return true if both M/S links are
4984 * offline.
4985 *
4986 * LOCKING:
4987 * None.
4988 *
4989 * RETURNS:
4990 * True if the port offline status is available and offline.
4991 */
4992bool ata_link_offline(struct ata_link *link)
4993{
4994 struct ata_link *slave = link->ap->slave_link;
4995
4996 WARN_ON(link == slave); /* shouldn't be called on slave link */
4997
4998 return ata_phys_link_offline(link) &&
4999 (!slave || ata_phys_link_offline(slave));
5000}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005001EXPORT_SYMBOL_GPL(ata_link_offline);
Tejun Heob1c72912008-07-31 17:02:43 +09005002
Tejun Heo6ffa01d2007-03-02 17:32:47 +09005003#ifdef CONFIG_PM
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005004static void ata_port_request_pm(struct ata_port *ap, pm_message_t mesg,
5005 unsigned int action, unsigned int ehi_flags,
5006 bool async)
Tejun Heo500530f2006-07-03 16:07:27 +09005007{
Lin Ming5ef41082011-12-05 09:20:27 +08005008 struct ata_link *link;
Tejun Heo500530f2006-07-03 16:07:27 +09005009 unsigned long flags;
Tejun Heo500530f2006-07-03 16:07:27 +09005010
Lin Ming5ef41082011-12-05 09:20:27 +08005011 /* Previous resume operation might still be in
5012 * progress. Wait for PM_PENDING to clear.
5013 */
5014 if (ap->pflags & ATA_PFLAG_PM_PENDING) {
5015 ata_port_wait_eh(ap);
5016 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
Tejun Heo500530f2006-07-03 16:07:27 +09005017 }
5018
Lin Ming5ef41082011-12-05 09:20:27 +08005019 /* request PM ops to EH */
5020 spin_lock_irqsave(ap->lock, flags);
5021
5022 ap->pm_mesg = mesg;
Lin Ming5ef41082011-12-05 09:20:27 +08005023 ap->pflags |= ATA_PFLAG_PM_PENDING;
5024 ata_for_each_link(link, ap, HOST_FIRST) {
5025 link->eh_info.action |= action;
5026 link->eh_info.flags |= ehi_flags;
5027 }
5028
5029 ata_port_schedule_eh(ap);
5030
5031 spin_unlock_irqrestore(ap->lock, flags);
5032
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005033 if (!async) {
Lin Ming5ef41082011-12-05 09:20:27 +08005034 ata_port_wait_eh(ap);
5035 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5036 }
Tejun Heo500530f2006-07-03 16:07:27 +09005037}
5038
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005039/*
5040 * On some hardware, device fails to respond after spun down for suspend. As
5041 * the device won't be used before being resumed, we don't need to touch the
5042 * device. Ask EH to skip the usual stuff and proceed directly to suspend.
5043 *
5044 * http://thread.gmane.org/gmane.linux.ide/46764
5045 */
5046static const unsigned int ata_port_suspend_ehi = ATA_EHI_QUIET
5047 | ATA_EHI_NO_AUTOPSY
5048 | ATA_EHI_NO_RECOVERY;
5049
5050static void ata_port_suspend(struct ata_port *ap, pm_message_t mesg)
Lin Ming5ef41082011-12-05 09:20:27 +08005051{
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005052 ata_port_request_pm(ap, mesg, 0, ata_port_suspend_ehi, false);
Lin Ming5ef41082011-12-05 09:20:27 +08005053}
5054
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005055static void ata_port_suspend_async(struct ata_port *ap, pm_message_t mesg)
5056{
5057 ata_port_request_pm(ap, mesg, 0, ata_port_suspend_ehi, true);
5058}
5059
5060static int ata_port_pm_suspend(struct device *dev)
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005061{
5062 struct ata_port *ap = to_ata_port(dev);
5063
Lin Ming5ef41082011-12-05 09:20:27 +08005064 if (pm_runtime_suspended(dev))
5065 return 0;
5066
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005067 ata_port_suspend(ap, PMSG_SUSPEND);
5068 return 0;
Lin Ming33574d62011-12-22 14:50:49 +08005069}
5070
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005071static int ata_port_pm_freeze(struct device *dev)
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005072{
5073 struct ata_port *ap = to_ata_port(dev);
5074
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005075 if (pm_runtime_suspended(dev))
5076 return 0;
5077
5078 ata_port_suspend(ap, PMSG_FREEZE);
5079 return 0;
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005080}
5081
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005082static int ata_port_pm_poweroff(struct device *dev)
Lin Minge90b1e52011-12-22 14:50:48 +08005083{
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005084 ata_port_suspend(to_ata_port(dev), PMSG_HIBERNATE);
5085 return 0;
5086}
Lin Minge90b1e52011-12-22 14:50:48 +08005087
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005088static const unsigned int ata_port_resume_ehi = ATA_EHI_NO_AUTOPSY
5089 | ATA_EHI_QUIET;
Lin Minge90b1e52011-12-22 14:50:48 +08005090
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005091static void ata_port_resume(struct ata_port *ap, pm_message_t mesg)
5092{
5093 ata_port_request_pm(ap, mesg, ATA_EH_RESET, ata_port_resume_ehi, false);
5094}
5095
5096static void ata_port_resume_async(struct ata_port *ap, pm_message_t mesg)
5097{
5098 ata_port_request_pm(ap, mesg, ATA_EH_RESET, ata_port_resume_ehi, true);
5099}
5100
5101static int ata_port_pm_resume(struct device *dev)
5102{
Todd Brandt200421a2014-03-14 13:52:54 -07005103 ata_port_resume_async(to_ata_port(dev), PMSG_RESUME);
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005104 pm_runtime_disable(dev);
5105 pm_runtime_set_active(dev);
5106 pm_runtime_enable(dev);
5107 return 0;
Lin Minge90b1e52011-12-22 14:50:48 +08005108}
5109
Aaron Lu7e15e9b2013-01-15 17:21:04 +08005110/*
5111 * For ODDs, the upper layer will poll for media change every few seconds,
5112 * which will make it enter and leave suspend state every few seconds. And
5113 * as each suspend will cause a hard/soft reset, the gain of runtime suspend
5114 * is very little and the ODD may malfunction after constantly being reset.
5115 * So the idle callback here will not proceed to suspend if a non-ZPODD capable
5116 * ODD is attached to the port.
5117 */
Lin Ming9ee4f392011-12-05 09:20:28 +08005118static int ata_port_runtime_idle(struct device *dev)
5119{
Aaron Lu7e15e9b2013-01-15 17:21:04 +08005120 struct ata_port *ap = to_ata_port(dev);
5121 struct ata_link *link;
5122 struct ata_device *adev;
5123
5124 ata_for_each_link(link, ap, HOST_FIRST) {
5125 ata_for_each_dev(adev, link, ENABLED)
5126 if (adev->class == ATA_DEV_ATAPI &&
5127 !zpodd_dev_enabled(adev))
5128 return -EBUSY;
5129 }
5130
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02005131 return 0;
Lin Ming9ee4f392011-12-05 09:20:28 +08005132}
5133
Aaron Lua7ff60d2013-01-25 14:29:35 +08005134static int ata_port_runtime_suspend(struct device *dev)
5135{
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005136 ata_port_suspend(to_ata_port(dev), PMSG_AUTO_SUSPEND);
5137 return 0;
Aaron Lua7ff60d2013-01-25 14:29:35 +08005138}
5139
5140static int ata_port_runtime_resume(struct device *dev)
5141{
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005142 ata_port_resume(to_ata_port(dev), PMSG_AUTO_RESUME);
5143 return 0;
Aaron Lua7ff60d2013-01-25 14:29:35 +08005144}
5145
Lin Ming5ef41082011-12-05 09:20:27 +08005146static const struct dev_pm_ops ata_port_pm_ops = {
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005147 .suspend = ata_port_pm_suspend,
5148 .resume = ata_port_pm_resume,
5149 .freeze = ata_port_pm_freeze,
5150 .thaw = ata_port_pm_resume,
5151 .poweroff = ata_port_pm_poweroff,
5152 .restore = ata_port_pm_resume,
Lin Ming9ee4f392011-12-05 09:20:28 +08005153
Aaron Lua7ff60d2013-01-25 14:29:35 +08005154 .runtime_suspend = ata_port_runtime_suspend,
5155 .runtime_resume = ata_port_runtime_resume,
Lin Ming9ee4f392011-12-05 09:20:28 +08005156 .runtime_idle = ata_port_runtime_idle,
Lin Ming5ef41082011-12-05 09:20:27 +08005157};
5158
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005159/* sas ports don't participate in pm runtime management of ata_ports,
5160 * and need to resume ata devices at the domain level, not the per-port
5161 * level. sas suspend/resume is async to allow parallel port recovery
5162 * since sas has multiple ata_port instances per Scsi_Host.
5163 */
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005164void ata_sas_port_suspend(struct ata_port *ap)
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005165{
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005166 ata_port_suspend_async(ap, PMSG_SUSPEND);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005167}
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005168EXPORT_SYMBOL_GPL(ata_sas_port_suspend);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005169
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005170void ata_sas_port_resume(struct ata_port *ap)
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005171{
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005172 ata_port_resume_async(ap, PMSG_RESUME);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005173}
Dan Williamsbc6e7c42014-03-14 13:52:48 -07005174EXPORT_SYMBOL_GPL(ata_sas_port_resume);
Dan Williams2fcbdcb2012-06-21 23:41:46 -07005175
Tejun Heo500530f2006-07-03 16:07:27 +09005176/**
Jeff Garzikcca39742006-08-24 03:19:22 -04005177 * ata_host_suspend - suspend host
5178 * @host: host to suspend
Tejun Heo500530f2006-07-03 16:07:27 +09005179 * @mesg: PM message
5180 *
Lin Ming5ef41082011-12-05 09:20:27 +08005181 * Suspend @host. Actual operation is performed by port suspend.
Tejun Heo500530f2006-07-03 16:07:27 +09005182 */
Jeff Garzikcca39742006-08-24 03:19:22 -04005183int ata_host_suspend(struct ata_host *host, pm_message_t mesg)
Tejun Heo500530f2006-07-03 16:07:27 +09005184{
Lin Ming5ef41082011-12-05 09:20:27 +08005185 host->dev->power.power_state = mesg;
5186 return 0;
Tejun Heo500530f2006-07-03 16:07:27 +09005187}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005188EXPORT_SYMBOL_GPL(ata_host_suspend);
Tejun Heo500530f2006-07-03 16:07:27 +09005189
5190/**
Jeff Garzikcca39742006-08-24 03:19:22 -04005191 * ata_host_resume - resume host
5192 * @host: host to resume
Tejun Heo500530f2006-07-03 16:07:27 +09005193 *
Lin Ming5ef41082011-12-05 09:20:27 +08005194 * Resume @host. Actual operation is performed by port resume.
Tejun Heo500530f2006-07-03 16:07:27 +09005195 */
Jeff Garzikcca39742006-08-24 03:19:22 -04005196void ata_host_resume(struct ata_host *host)
Tejun Heo500530f2006-07-03 16:07:27 +09005197{
Jeff Garzik72ad6ec2008-02-25 17:31:10 -05005198 host->dev->power.power_state = PMSG_ON;
Tejun Heo500530f2006-07-03 16:07:27 +09005199}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005200EXPORT_SYMBOL_GPL(ata_host_resume);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09005201#endif
Tejun Heo500530f2006-07-03 16:07:27 +09005202
Bhumika Goyal8df82c12017-09-30 22:10:40 +05305203const struct device_type ata_port_type = {
Lin Ming5ef41082011-12-05 09:20:27 +08005204 .name = "ata_port",
5205#ifdef CONFIG_PM
5206 .pm = &ata_port_pm_ops,
5207#endif
5208};
5209
Randy Dunlapc893a3a2006-01-28 13:15:32 -05005210/**
Tejun Heo3ef3b432006-05-31 18:27:30 +09005211 * ata_dev_init - Initialize an ata_device structure
5212 * @dev: Device structure to initialize
5213 *
5214 * Initialize @dev in preparation for probing.
5215 *
5216 * LOCKING:
5217 * Inherited from caller.
5218 */
5219void ata_dev_init(struct ata_device *dev)
5220{
Tejun Heob1c72912008-07-31 17:02:43 +09005221 struct ata_link *link = ata_dev_phys_link(dev);
Tejun Heo9af5c9c2007-08-06 18:36:22 +09005222 struct ata_port *ap = link->ap;
Tejun Heo72fa4b72006-05-31 18:27:32 +09005223 unsigned long flags;
Tejun Heo3ef3b432006-05-31 18:27:30 +09005224
Tejun Heob1c72912008-07-31 17:02:43 +09005225 /* SATA spd limit is bound to the attached device, reset together */
Tejun Heo9af5c9c2007-08-06 18:36:22 +09005226 link->sata_spd_limit = link->hw_sata_spd_limit;
5227 link->sata_spd = 0;
Tejun Heo5a04bf42006-05-31 18:27:38 +09005228
Tejun Heo72fa4b72006-05-31 18:27:32 +09005229 /* High bits of dev->flags are used to record warm plug
5230 * requests which occur asynchronously. Synchronize using
Jeff Garzikcca39742006-08-24 03:19:22 -04005231 * host lock.
Tejun Heo72fa4b72006-05-31 18:27:32 +09005232 */
Jeff Garzikba6a1302006-06-22 23:46:10 -04005233 spin_lock_irqsave(ap->lock, flags);
Tejun Heo72fa4b72006-05-31 18:27:32 +09005234 dev->flags &= ~ATA_DFLAG_INIT_MASK;
Tejun Heo3dcc3232007-09-03 12:20:11 +09005235 dev->horkage = 0;
Jeff Garzikba6a1302006-06-22 23:46:10 -04005236 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo72fa4b72006-05-31 18:27:32 +09005237
Tejun Heo99cf6102009-01-29 20:31:32 +09005238 memset((void *)dev + ATA_DEVICE_CLEAR_BEGIN, 0,
5239 ATA_DEVICE_CLEAR_END - ATA_DEVICE_CLEAR_BEGIN);
Tejun Heo3ef3b432006-05-31 18:27:30 +09005240 dev->pio_mask = UINT_MAX;
5241 dev->mwdma_mask = UINT_MAX;
5242 dev->udma_mask = UINT_MAX;
5243}
5244
5245/**
Tejun Heo4fb37a22007-08-06 18:36:23 +09005246 * ata_link_init - Initialize an ata_link structure
5247 * @ap: ATA port link is attached to
5248 * @link: Link structure to initialize
Tejun Heo89898052007-08-06 18:36:23 +09005249 * @pmp: Port multiplier port number
Tejun Heo4fb37a22007-08-06 18:36:23 +09005250 *
5251 * Initialize @link.
5252 *
5253 * LOCKING:
5254 * Kernel thread context (may sleep)
5255 */
Tejun Heofb7fd612007-09-23 13:14:12 +09005256void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp)
Tejun Heo4fb37a22007-08-06 18:36:23 +09005257{
5258 int i;
5259
5260 /* clear everything except for devices */
Gwendal Grignoud9027472010-05-25 12:31:38 -07005261 memset((void *)link + ATA_LINK_CLEAR_BEGIN, 0,
5262 ATA_LINK_CLEAR_END - ATA_LINK_CLEAR_BEGIN);
Tejun Heo4fb37a22007-08-06 18:36:23 +09005263
5264 link->ap = ap;
Tejun Heo89898052007-08-06 18:36:23 +09005265 link->pmp = pmp;
Tejun Heo4fb37a22007-08-06 18:36:23 +09005266 link->active_tag = ATA_TAG_POISON;
5267 link->hw_sata_spd_limit = UINT_MAX;
5268
5269 /* can't use iterator, ap isn't initialized yet */
5270 for (i = 0; i < ATA_MAX_DEVICES; i++) {
5271 struct ata_device *dev = &link->device[i];
5272
5273 dev->link = link;
5274 dev->devno = dev - link->device;
Tejun Heo110f66d2009-09-16 04:17:28 +09005275#ifdef CONFIG_ATA_ACPI
5276 dev->gtf_filter = ata_acpi_gtf_filter;
5277#endif
Tejun Heo4fb37a22007-08-06 18:36:23 +09005278 ata_dev_init(dev);
5279 }
5280}
5281
5282/**
5283 * sata_link_init_spd - Initialize link->sata_spd_limit
5284 * @link: Link to configure sata_spd_limit for
5285 *
Mauro Carvalho Chehaba31a6992020-04-14 18:48:55 +02005286 * Initialize ``link->[hw_]sata_spd_limit`` to the currently
Tejun Heo4fb37a22007-08-06 18:36:23 +09005287 * configured value.
5288 *
5289 * LOCKING:
5290 * Kernel thread context (may sleep).
5291 *
5292 * RETURNS:
5293 * 0 on success, -errno on failure.
5294 */
Tejun Heofb7fd612007-09-23 13:14:12 +09005295int sata_link_init_spd(struct ata_link *link)
Tejun Heo4fb37a22007-08-06 18:36:23 +09005296{
Tejun Heo33267322008-02-13 09:15:09 +09005297 u8 spd;
Tejun Heo4fb37a22007-08-06 18:36:23 +09005298 int rc;
5299
Tejun Heod127ea72008-07-31 16:09:34 +09005300 rc = sata_scr_read(link, SCR_CONTROL, &link->saved_scontrol);
Tejun Heo4fb37a22007-08-06 18:36:23 +09005301 if (rc)
5302 return rc;
5303
Tejun Heod127ea72008-07-31 16:09:34 +09005304 spd = (link->saved_scontrol >> 4) & 0xf;
Tejun Heo4fb37a22007-08-06 18:36:23 +09005305 if (spd)
5306 link->hw_sata_spd_limit &= (1 << spd) - 1;
5307
Tejun Heo05944bd2008-08-13 20:19:09 +09005308 ata_force_link_limits(link);
Tejun Heo33267322008-02-13 09:15:09 +09005309
Tejun Heo4fb37a22007-08-06 18:36:23 +09005310 link->sata_spd_limit = link->hw_sata_spd_limit;
5311
5312 return 0;
5313}
5314
5315/**
Tejun Heof3187192007-04-17 23:44:07 +09005316 * ata_port_alloc - allocate and initialize basic ATA port resources
5317 * @host: ATA host this allocated port belongs to
Linus Torvalds1da177e2005-04-16 15:20:36 -07005318 *
Tejun Heof3187192007-04-17 23:44:07 +09005319 * Allocate and initialize basic ATA port resources.
5320 *
5321 * RETURNS:
5322 * Allocate ATA port on success, NULL on failure.
Jeff Garzik0cba6322005-05-30 19:49:12 -04005323 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005324 * LOCKING:
Tejun Heof3187192007-04-17 23:44:07 +09005325 * Inherited from calling layer (may sleep).
Linus Torvalds1da177e2005-04-16 15:20:36 -07005326 */
Tejun Heof3187192007-04-17 23:44:07 +09005327struct ata_port *ata_port_alloc(struct ata_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005328{
Tejun Heof3187192007-04-17 23:44:07 +09005329 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005330
Tejun Heof3187192007-04-17 23:44:07 +09005331 ap = kzalloc(sizeof(*ap), GFP_KERNEL);
5332 if (!ap)
5333 return NULL;
Jeff Garzik4fca3772011-02-15 01:13:24 -05005334
Maxime Bizon7b3a24c52011-03-16 14:58:32 +01005335 ap->pflags |= ATA_PFLAG_INITIALIZING | ATA_PFLAG_FROZEN;
Jeff Garzikcca39742006-08-24 03:19:22 -04005336 ap->lock = &host->lock;
Tejun Heof3187192007-04-17 23:44:07 +09005337 ap->print_id = -1;
David Milburne628dc92013-05-14 13:48:40 -05005338 ap->local_port_no = -1;
Jeff Garzikcca39742006-08-24 03:19:22 -04005339 ap->host = host;
Tejun Heof3187192007-04-17 23:44:07 +09005340 ap->dev = host->dev;
Borislav Petkovbd5d8252006-06-11 23:17:01 -04005341
Tejun Heoad72cf92010-07-02 10:03:52 +02005342 mutex_init(&ap->scsi_scan_mutex);
David Howells65f27f32006-11-22 14:55:48 +00005343 INIT_DELAYED_WORK(&ap->hotplug_task, ata_scsi_hotplug);
5344 INIT_WORK(&ap->scsi_rescan_task, ata_scsi_dev_rescan);
Tejun Heoa72ec4c2006-01-23 13:09:37 +09005345 INIT_LIST_HEAD(&ap->eh_done_q);
Tejun Heoc6cf9e92006-05-31 18:27:27 +09005346 init_waitqueue_head(&ap->eh_wait_q);
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02005347 init_completion(&ap->park_req_pending);
Kees Cookb93ab332017-10-16 14:56:42 -07005348 timer_setup(&ap->fastdrain_timer, ata_eh_fastdrain_timerfn,
5349 TIMER_DEFERRABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005350
Tejun Heo838df622006-05-15 20:57:44 +09005351 ap->cbl = ATA_CBL_NONE;
Tejun Heo838df622006-05-15 20:57:44 +09005352
Tejun Heo89898052007-08-06 18:36:23 +09005353 ata_link_init(ap, &ap->link, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005354
5355#ifdef ATA_IRQ_TRAP
5356 ap->stats.unhandled_irq = 1;
5357 ap->stats.idle_irq = 1;
5358#endif
Tejun Heo270390e2010-05-10 21:41:35 +02005359 ata_sff_port_init(ap);
5360
Linus Torvalds1da177e2005-04-16 15:20:36 -07005361 return ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005362}
5363
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005364static void ata_devres_release(struct device *gendev, void *res)
Tejun Heof0d36ef2007-01-20 16:00:28 +09005365{
5366 struct ata_host *host = dev_get_drvdata(gendev);
5367 int i;
5368
5369 for (i = 0; i < host->n_ports; i++) {
5370 struct ata_port *ap = host->ports[i];
5371
Tejun Heoecef7252007-04-17 23:44:06 +09005372 if (!ap)
5373 continue;
5374
Tejun Heo49114872007-04-17 23:44:06 +09005375 if (ap->scsi_host)
Tejun Heo1aa506e42007-03-09 19:36:12 +09005376 scsi_host_put(ap->scsi_host);
5377
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005378 }
5379
5380 dev_set_drvdata(gendev, NULL);
5381 ata_host_put(host);
5382}
5383
5384static void ata_host_release(struct kref *kref)
5385{
5386 struct ata_host *host = container_of(kref, struct ata_host, kref);
5387 int i;
5388
5389 for (i = 0; i < host->n_ports; i++) {
5390 struct ata_port *ap = host->ports[i];
5391
Tejun Heo633273a2007-09-23 13:19:54 +09005392 kfree(ap->pmp_link);
Tejun Heob1c72912008-07-31 17:02:43 +09005393 kfree(ap->slave_link);
Tejun Heo49114872007-04-17 23:44:06 +09005394 kfree(ap);
Tejun Heo1aa506e42007-03-09 19:36:12 +09005395 host->ports[i] = NULL;
5396 }
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005397 kfree(host);
5398}
Tejun Heo1aa506e42007-03-09 19:36:12 +09005399
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005400void ata_host_get(struct ata_host *host)
5401{
5402 kref_get(&host->kref);
5403}
5404
5405void ata_host_put(struct ata_host *host)
5406{
5407 kref_put(&host->kref, ata_host_release);
Tejun Heof0d36ef2007-01-20 16:00:28 +09005408}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005409EXPORT_SYMBOL_GPL(ata_host_put);
Tejun Heof0d36ef2007-01-20 16:00:28 +09005410
Linus Torvalds1da177e2005-04-16 15:20:36 -07005411/**
Tejun Heof3187192007-04-17 23:44:07 +09005412 * ata_host_alloc - allocate and init basic ATA host resources
5413 * @dev: generic device this host is associated with
5414 * @max_ports: maximum number of ATA ports associated with this host
5415 *
5416 * Allocate and initialize basic ATA host resources. LLD calls
5417 * this function to allocate a host, initializes it fully and
5418 * attaches it using ata_host_register().
5419 *
5420 * @max_ports ports are allocated and host->n_ports is
5421 * initialized to @max_ports. The caller is allowed to decrease
5422 * host->n_ports before calling ata_host_register(). The unused
5423 * ports will be automatically freed on registration.
5424 *
5425 * RETURNS:
5426 * Allocate ATA host on success, NULL on failure.
5427 *
5428 * LOCKING:
5429 * Inherited from calling layer (may sleep).
5430 */
5431struct ata_host *ata_host_alloc(struct device *dev, int max_ports)
5432{
5433 struct ata_host *host;
5434 size_t sz;
5435 int i;
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005436 void *dr;
Tejun Heof3187192007-04-17 23:44:07 +09005437
Tejun Heof3187192007-04-17 23:44:07 +09005438 /* alloc a container for our list of ATA ports (buses) */
5439 sz = sizeof(struct ata_host) + (max_ports + 1) * sizeof(void *);
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005440 host = kzalloc(sz, GFP_KERNEL);
Tejun Heof3187192007-04-17 23:44:07 +09005441 if (!host)
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005442 return NULL;
5443
Tejun Heof3187192007-04-17 23:44:07 +09005444 if (!devres_open_group(dev, NULL, GFP_KERNEL))
Colin Ian Kingdafd6c42018-03-27 14:26:01 +01005445 goto err_free;
Tejun Heof3187192007-04-17 23:44:07 +09005446
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005447 dr = devres_alloc(ata_devres_release, 0, GFP_KERNEL);
5448 if (!dr)
Tejun Heof3187192007-04-17 23:44:07 +09005449 goto err_out;
5450
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005451 devres_add(dev, dr);
Tejun Heof3187192007-04-17 23:44:07 +09005452 dev_set_drvdata(dev, host);
5453
5454 spin_lock_init(&host->lock);
Tejun Heoc0c362b2010-09-06 17:57:14 +02005455 mutex_init(&host->eh_mutex);
Tejun Heof3187192007-04-17 23:44:07 +09005456 host->dev = dev;
5457 host->n_ports = max_ports;
Taras Kondratiuk2623c7a2018-03-09 08:34:41 +00005458 kref_init(&host->kref);
Tejun Heof3187192007-04-17 23:44:07 +09005459
5460 /* allocate ports bound to this host */
5461 for (i = 0; i < max_ports; i++) {
5462 struct ata_port *ap;
5463
5464 ap = ata_port_alloc(host);
5465 if (!ap)
5466 goto err_out;
5467
5468 ap->port_no = i;
5469 host->ports[i] = ap;
5470 }
5471
5472 devres_remove_group(dev, NULL);
5473 return host;
5474
5475 err_out:
5476 devres_release_group(dev, NULL);
Colin Ian Kingdafd6c42018-03-27 14:26:01 +01005477 err_free:
5478 kfree(host);
Tejun Heof3187192007-04-17 23:44:07 +09005479 return NULL;
5480}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005481EXPORT_SYMBOL_GPL(ata_host_alloc);
Tejun Heof3187192007-04-17 23:44:07 +09005482
5483/**
Tejun Heof5cda252007-04-17 23:44:07 +09005484 * ata_host_alloc_pinfo - alloc host and init with port_info array
5485 * @dev: generic device this host is associated with
5486 * @ppi: array of ATA port_info to initialize host with
5487 * @n_ports: number of ATA ports attached to this host
5488 *
5489 * Allocate ATA host and initialize with info from @ppi. If NULL
5490 * terminated, @ppi may contain fewer entries than @n_ports. The
5491 * last entry will be used for the remaining ports.
5492 *
5493 * RETURNS:
5494 * Allocate ATA host on success, NULL on failure.
5495 *
5496 * LOCKING:
5497 * Inherited from calling layer (may sleep).
5498 */
5499struct ata_host *ata_host_alloc_pinfo(struct device *dev,
5500 const struct ata_port_info * const * ppi,
5501 int n_ports)
5502{
5503 const struct ata_port_info *pi;
5504 struct ata_host *host;
5505 int i, j;
5506
5507 host = ata_host_alloc(dev, n_ports);
5508 if (!host)
5509 return NULL;
5510
5511 for (i = 0, j = 0, pi = NULL; i < host->n_ports; i++) {
5512 struct ata_port *ap = host->ports[i];
5513
5514 if (ppi[j])
5515 pi = ppi[j++];
5516
5517 ap->pio_mask = pi->pio_mask;
5518 ap->mwdma_mask = pi->mwdma_mask;
5519 ap->udma_mask = pi->udma_mask;
5520 ap->flags |= pi->flags;
Tejun Heo0c887582007-08-06 18:36:23 +09005521 ap->link.flags |= pi->link_flags;
Tejun Heof5cda252007-04-17 23:44:07 +09005522 ap->ops = pi->port_ops;
5523
5524 if (!host->ops && (pi->port_ops != &ata_dummy_port_ops))
5525 host->ops = pi->port_ops;
Tejun Heof5cda252007-04-17 23:44:07 +09005526 }
5527
5528 return host;
5529}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005530EXPORT_SYMBOL_GPL(ata_host_alloc_pinfo);
Tejun Heof5cda252007-04-17 23:44:07 +09005531
Tejun Heo32ebbc02007-11-08 13:09:00 +09005532static void ata_host_stop(struct device *gendev, void *res)
5533{
5534 struct ata_host *host = dev_get_drvdata(gendev);
5535 int i;
5536
5537 WARN_ON(!(host->flags & ATA_HOST_STARTED));
5538
5539 for (i = 0; i < host->n_ports; i++) {
5540 struct ata_port *ap = host->ports[i];
5541
5542 if (ap->ops->port_stop)
5543 ap->ops->port_stop(ap);
5544 }
5545
5546 if (host->ops->host_stop)
5547 host->ops->host_stop(host);
5548}
5549
Tejun Heof5cda252007-04-17 23:44:07 +09005550/**
Tejun Heo029cfd62008-03-25 12:22:49 +09005551 * ata_finalize_port_ops - finalize ata_port_operations
5552 * @ops: ata_port_operations to finalize
5553 *
5554 * An ata_port_operations can inherit from another ops and that
5555 * ops can again inherit from another. This can go on as many
5556 * times as necessary as long as there is no loop in the
5557 * inheritance chain.
5558 *
5559 * Ops tables are finalized when the host is started. NULL or
5560 * unspecified entries are inherited from the closet ancestor
5561 * which has the method and the entry is populated with it.
5562 * After finalization, the ops table directly points to all the
5563 * methods and ->inherits is no longer necessary and cleared.
5564 *
5565 * Using ATA_OP_NULL, inheriting ops can force a method to NULL.
5566 *
5567 * LOCKING:
5568 * None.
5569 */
5570static void ata_finalize_port_ops(struct ata_port_operations *ops)
5571{
Pradeep Singh Rautela2da67652008-05-29 23:28:14 +05305572 static DEFINE_SPINLOCK(lock);
Tejun Heo029cfd62008-03-25 12:22:49 +09005573 const struct ata_port_operations *cur;
5574 void **begin = (void **)ops;
5575 void **end = (void **)&ops->inherits;
5576 void **pp;
5577
5578 if (!ops || !ops->inherits)
5579 return;
5580
5581 spin_lock(&lock);
5582
5583 for (cur = ops->inherits; cur; cur = cur->inherits) {
5584 void **inherit = (void **)cur;
5585
5586 for (pp = begin; pp < end; pp++, inherit++)
5587 if (!*pp)
5588 *pp = *inherit;
5589 }
5590
5591 for (pp = begin; pp < end; pp++)
5592 if (IS_ERR(*pp))
5593 *pp = NULL;
5594
5595 ops->inherits = NULL;
5596
5597 spin_unlock(&lock);
5598}
5599
5600/**
Tejun Heoecef7252007-04-17 23:44:06 +09005601 * ata_host_start - start and freeze ports of an ATA host
5602 * @host: ATA host to start ports for
5603 *
5604 * Start and then freeze ports of @host. Started status is
5605 * recorded in host->flags, so this function can be called
5606 * multiple times. Ports are guaranteed to get started only
Tejun Heof3187192007-04-17 23:44:07 +09005607 * once. If host->ops isn't initialized yet, its set to the
5608 * first non-dummy port ops.
Tejun Heoecef7252007-04-17 23:44:06 +09005609 *
5610 * LOCKING:
5611 * Inherited from calling layer (may sleep).
5612 *
5613 * RETURNS:
5614 * 0 if all ports are started successfully, -errno otherwise.
5615 */
5616int ata_host_start(struct ata_host *host)
5617{
Tejun Heo32ebbc02007-11-08 13:09:00 +09005618 int have_stop = 0;
5619 void *start_dr = NULL;
Tejun Heoecef7252007-04-17 23:44:06 +09005620 int i, rc;
5621
5622 if (host->flags & ATA_HOST_STARTED)
5623 return 0;
5624
Tejun Heo029cfd62008-03-25 12:22:49 +09005625 ata_finalize_port_ops(host->ops);
5626
Tejun Heoecef7252007-04-17 23:44:06 +09005627 for (i = 0; i < host->n_ports; i++) {
5628 struct ata_port *ap = host->ports[i];
5629
Tejun Heo029cfd62008-03-25 12:22:49 +09005630 ata_finalize_port_ops(ap->ops);
5631
Tejun Heof3187192007-04-17 23:44:07 +09005632 if (!host->ops && !ata_port_is_dummy(ap))
5633 host->ops = ap->ops;
5634
Tejun Heo32ebbc02007-11-08 13:09:00 +09005635 if (ap->ops->port_stop)
5636 have_stop = 1;
5637 }
5638
Damien Le Moal355a8032021-08-16 10:44:47 +09005639 if (host->ops && host->ops->host_stop)
Tejun Heo32ebbc02007-11-08 13:09:00 +09005640 have_stop = 1;
5641
5642 if (have_stop) {
5643 start_dr = devres_alloc(ata_host_stop, 0, GFP_KERNEL);
5644 if (!start_dr)
5645 return -ENOMEM;
5646 }
5647
5648 for (i = 0; i < host->n_ports; i++) {
5649 struct ata_port *ap = host->ports[i];
5650
Tejun Heoecef7252007-04-17 23:44:06 +09005651 if (ap->ops->port_start) {
5652 rc = ap->ops->port_start(ap);
5653 if (rc) {
Alan Cox0f9fe9b2007-11-30 15:23:16 +00005654 if (rc != -ENODEV)
Joe Perchesa44fec12011-04-15 15:51:58 -07005655 dev_err(host->dev,
5656 "failed to start port %d (errno=%d)\n",
5657 i, rc);
Tejun Heoecef7252007-04-17 23:44:06 +09005658 goto err_out;
5659 }
5660 }
Tejun Heoecef7252007-04-17 23:44:06 +09005661 ata_eh_freeze_port(ap);
5662 }
5663
Tejun Heo32ebbc02007-11-08 13:09:00 +09005664 if (start_dr)
5665 devres_add(host->dev, start_dr);
Tejun Heoecef7252007-04-17 23:44:06 +09005666 host->flags |= ATA_HOST_STARTED;
5667 return 0;
5668
5669 err_out:
5670 while (--i >= 0) {
5671 struct ata_port *ap = host->ports[i];
5672
5673 if (ap->ops->port_stop)
5674 ap->ops->port_stop(ap);
5675 }
Tejun Heo32ebbc02007-11-08 13:09:00 +09005676 devres_free(start_dr);
Tejun Heoecef7252007-04-17 23:44:06 +09005677 return rc;
5678}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005679EXPORT_SYMBOL_GPL(ata_host_start);
Tejun Heoecef7252007-04-17 23:44:06 +09005680
5681/**
Mauro Carvalho Chehab94bd5712020-10-23 18:32:55 +02005682 * ata_host_init - Initialize a host struct for sas (ipr, libsas)
Jeff Garzikcca39742006-08-24 03:19:22 -04005683 * @host: host to initialize
5684 * @dev: device host is attached to
Jeff Garzikcca39742006-08-24 03:19:22 -04005685 * @ops: port_ops
Brian Kingb03732f2006-08-07 14:27:10 -05005686 *
Brian Kingb03732f2006-08-07 14:27:10 -05005687 */
Jeff Garzikcca39742006-08-24 03:19:22 -04005688void ata_host_init(struct ata_host *host, struct device *dev,
Dan Williams8d8e7d12012-07-09 21:06:08 -07005689 struct ata_port_operations *ops)
Brian Kingb03732f2006-08-07 14:27:10 -05005690{
Jeff Garzikcca39742006-08-24 03:19:22 -04005691 spin_lock_init(&host->lock);
Tejun Heoc0c362b2010-09-06 17:57:14 +02005692 mutex_init(&host->eh_mutex);
Jens Axboe69278f72018-05-11 12:51:10 -06005693 host->n_tags = ATA_MAX_QUEUE;
Jeff Garzikcca39742006-08-24 03:19:22 -04005694 host->dev = dev;
Jeff Garzikcca39742006-08-24 03:19:22 -04005695 host->ops = ops;
Jason Yan2fa4a322018-05-10 11:05:16 +08005696 kref_init(&host->kref);
Brian Kingb03732f2006-08-07 14:27:10 -05005697}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005698EXPORT_SYMBOL_GPL(ata_host_init);
Brian Kingb03732f2006-08-07 14:27:10 -05005699
Dan Williams9508a662012-01-18 20:47:01 -08005700void __ata_port_probe(struct ata_port *ap)
5701{
5702 struct ata_eh_info *ehi = &ap->link.eh_info;
5703 unsigned long flags;
5704
5705 /* kick EH for boot probing */
5706 spin_lock_irqsave(ap->lock, flags);
5707
5708 ehi->probe_mask |= ATA_ALL_DEVICES;
5709 ehi->action |= ATA_EH_RESET;
5710 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
5711
5712 ap->pflags &= ~ATA_PFLAG_INITIALIZING;
5713 ap->pflags |= ATA_PFLAG_LOADING;
5714 ata_port_schedule_eh(ap);
5715
5716 spin_unlock_irqrestore(ap->lock, flags);
5717}
5718
James Bottomley238c9cf2011-01-23 08:28:33 -06005719int ata_port_probe(struct ata_port *ap)
Arjan van de Ven79318052009-01-04 05:32:28 -08005720{
James Bottomley238c9cf2011-01-23 08:28:33 -06005721 int rc = 0;
Arjan van de Ven886ad092009-01-09 15:54:07 -08005722
Arjan van de Ven79318052009-01-04 05:32:28 -08005723 if (ap->ops->error_handler) {
Dan Williams9508a662012-01-18 20:47:01 -08005724 __ata_port_probe(ap);
Arjan van de Ven79318052009-01-04 05:32:28 -08005725 ata_port_wait_eh(ap);
5726 } else {
Arjan van de Ven79318052009-01-04 05:32:28 -08005727 rc = ata_bus_probe(ap);
Arjan van de Ven79318052009-01-04 05:32:28 -08005728 }
James Bottomley238c9cf2011-01-23 08:28:33 -06005729 return rc;
5730}
5731
5732
5733static void async_port_probe(void *data, async_cookie_t cookie)
5734{
5735 struct ata_port *ap = data;
Jeff Garzik4fca3772011-02-15 01:13:24 -05005736
James Bottomley238c9cf2011-01-23 08:28:33 -06005737 /*
5738 * If we're not allowed to scan this host in parallel,
5739 * we need to wait until all previous scans have completed
5740 * before going further.
5741 * Jeff Garzik says this is only within a controller, so we
5742 * don't need to wait for port 0, only for later ports.
5743 */
5744 if (!(ap->host->flags & ATA_HOST_PARALLEL_SCAN) && ap->port_no != 0)
5745 async_synchronize_cookie(cookie);
5746
5747 (void)ata_port_probe(ap);
Arjan van de Venf29d3b22009-01-05 15:07:07 -08005748
5749 /* in order to keep device order, we need to synchronize at this point */
5750 async_synchronize_cookie(cookie);
5751
5752 ata_scsi_scan_host(ap, 1);
Arjan van de Ven79318052009-01-04 05:32:28 -08005753}
James Bottomley238c9cf2011-01-23 08:28:33 -06005754
Brian Kingb03732f2006-08-07 14:27:10 -05005755/**
Tejun Heof3187192007-04-17 23:44:07 +09005756 * ata_host_register - register initialized ATA host
5757 * @host: ATA host to register
5758 * @sht: template for SCSI host
Jeff Garzik0cba6322005-05-30 19:49:12 -04005759 *
Tejun Heof3187192007-04-17 23:44:07 +09005760 * Register initialized ATA host. @host is allocated using
5761 * ata_host_alloc() and fully initialized by LLD. This function
5762 * starts ports, registers @host with ATA and SCSI layers and
5763 * probe registered devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005764 *
5765 * LOCKING:
Tejun Heof3187192007-04-17 23:44:07 +09005766 * Inherited from calling layer (may sleep).
Linus Torvalds1da177e2005-04-16 15:20:36 -07005767 *
5768 * RETURNS:
Tejun Heof3187192007-04-17 23:44:07 +09005769 * 0 on success, -errno otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005770 */
Tejun Heof3187192007-04-17 23:44:07 +09005771int ata_host_register(struct ata_host *host, struct scsi_host_template *sht)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005772{
Tejun Heof3187192007-04-17 23:44:07 +09005773 int i, rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005774
Jens Axboe69278f72018-05-11 12:51:10 -06005775 host->n_tags = clamp(sht->can_queue, 1, ATA_MAX_QUEUE);
Kevin Hao1871ee12014-07-12 12:08:24 +08005776
Tejun Heof3187192007-04-17 23:44:07 +09005777 /* host must have been started */
5778 if (!(host->flags & ATA_HOST_STARTED)) {
Joe Perchesa44fec12011-04-15 15:51:58 -07005779 dev_err(host->dev, "BUG: trying to register unstarted host\n");
Tejun Heof3187192007-04-17 23:44:07 +09005780 WARN_ON(1);
5781 return -EINVAL;
Alan Cox02f076a2006-09-26 17:35:32 +01005782 }
Tejun Heof0d36ef2007-01-20 16:00:28 +09005783
Tejun Heof3187192007-04-17 23:44:07 +09005784 /* Blow away unused ports. This happens when LLD can't
5785 * determine the exact number of ports to allocate at
5786 * allocation time.
5787 */
5788 for (i = host->n_ports; host->ports[i]; i++)
5789 kfree(host->ports[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005790
Tejun Heof3187192007-04-17 23:44:07 +09005791 /* give ports names and add SCSI hosts */
David Milburne628dc92013-05-14 13:48:40 -05005792 for (i = 0; i < host->n_ports; i++) {
Dan Williams85d67252012-03-10 23:28:46 -08005793 host->ports[i]->print_id = atomic_inc_return(&ata_print_id);
David Milburne628dc92013-05-14 13:48:40 -05005794 host->ports[i]->local_port_no = i + 1;
5795 }
Jeff Garzik4fca3772011-02-15 01:13:24 -05005796
Gwendal Grignoud9027472010-05-25 12:31:38 -07005797 /* Create associated sysfs transport objects */
5798 for (i = 0; i < host->n_ports; i++) {
5799 rc = ata_tport_add(host->dev,host->ports[i]);
5800 if (rc) {
5801 goto err_tadd;
5802 }
5803 }
5804
Tejun Heof3187192007-04-17 23:44:07 +09005805 rc = ata_scsi_add_hosts(host, sht);
Tejun Heoecef7252007-04-17 23:44:06 +09005806 if (rc)
Gwendal Grignoud9027472010-05-25 12:31:38 -07005807 goto err_tadd;
Tejun Heoecef7252007-04-17 23:44:06 +09005808
Tejun Heof3187192007-04-17 23:44:07 +09005809 /* set cable, sata_spd_limit and report */
Jeff Garzikcca39742006-08-24 03:19:22 -04005810 for (i = 0; i < host->n_ports; i++) {
5811 struct ata_port *ap = host->ports[i];
Tejun Heof3187192007-04-17 23:44:07 +09005812 unsigned long xfer_mask;
5813
5814 /* set SATA cable type if still unset */
5815 if (ap->cbl == ATA_CBL_NONE && (ap->flags & ATA_FLAG_SATA))
5816 ap->cbl = ATA_CBL_SATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005817
Tejun Heo5a04bf42006-05-31 18:27:38 +09005818 /* init sata_spd_limit to the current value */
Tejun Heo4fb37a22007-08-06 18:36:23 +09005819 sata_link_init_spd(&ap->link);
Tejun Heob1c72912008-07-31 17:02:43 +09005820 if (ap->slave_link)
5821 sata_link_init_spd(ap->slave_link);
Tejun Heo5a04bf42006-05-31 18:27:38 +09005822
Tejun Heocbcdd872007-08-18 13:14:55 +09005823 /* print per-port info to dmesg */
Tejun Heof3187192007-04-17 23:44:07 +09005824 xfer_mask = ata_pack_xfermask(ap->pio_mask, ap->mwdma_mask,
5825 ap->udma_mask);
5826
Tejun Heoabf6e8e2007-10-09 14:57:25 +09005827 if (!ata_port_is_dummy(ap)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -07005828 ata_port_info(ap, "%cATA max %s %s\n",
5829 (ap->flags & ATA_FLAG_SATA) ? 'S' : 'P',
5830 ata_mode_string(xfer_mask),
5831 ap->link.eh_info.desc);
Tejun Heoabf6e8e2007-10-09 14:57:25 +09005832 ata_ehi_clear_desc(&ap->link.eh_info);
5833 } else
Joe Perchesa9a79df2011-04-15 15:51:59 -07005834 ata_port_info(ap, "DUMMY\n");
Tejun Heof3187192007-04-17 23:44:07 +09005835 }
5836
Vegard Nossumf6005352009-04-08 18:19:39 +02005837 /* perform each probe asynchronously */
Tejun Heof3187192007-04-17 23:44:07 +09005838 for (i = 0; i < host->n_ports; i++) {
5839 struct ata_port *ap = host->ports[i];
Kai-Heng Fengb5292112020-06-03 15:48:19 +08005840 ap->cookie = async_schedule(async_port_probe, ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005841 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005842
Tejun Heof3187192007-04-17 23:44:07 +09005843 return 0;
Gwendal Grignoud9027472010-05-25 12:31:38 -07005844
5845 err_tadd:
5846 while (--i >= 0) {
5847 ata_tport_delete(host->ports[i]);
5848 }
5849 return rc;
5850
Tejun Heof3187192007-04-17 23:44:07 +09005851}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005852EXPORT_SYMBOL_GPL(ata_host_register);
Tejun Heof3187192007-04-17 23:44:07 +09005853
5854/**
Tejun Heof5cda252007-04-17 23:44:07 +09005855 * ata_host_activate - start host, request IRQ and register it
5856 * @host: target ATA host
5857 * @irq: IRQ to request
5858 * @irq_handler: irq_handler used when requesting IRQ
5859 * @irq_flags: irq_flags used when requesting IRQ
5860 * @sht: scsi_host_template to use when registering the host
5861 *
5862 * After allocating an ATA host and initializing it, most libata
5863 * LLDs perform three steps to activate the host - start host,
Masanari Iidac9b55602016-04-13 23:36:27 +09005864 * request IRQ and register it. This helper takes necessary
Tejun Heof5cda252007-04-17 23:44:07 +09005865 * arguments and performs the three steps in one go.
5866 *
Paul Mundt3d46b2e2007-11-08 11:14:56 +09005867 * An invalid IRQ skips the IRQ registration and expects the host to
5868 * have set polling mode on the port. In this case, @irq_handler
5869 * should be NULL.
5870 *
Tejun Heof5cda252007-04-17 23:44:07 +09005871 * LOCKING:
5872 * Inherited from calling layer (may sleep).
5873 *
5874 * RETURNS:
5875 * 0 on success, -errno otherwise.
5876 */
5877int ata_host_activate(struct ata_host *host, int irq,
5878 irq_handler_t irq_handler, unsigned long irq_flags,
5879 struct scsi_host_template *sht)
5880{
Tejun Heocbcdd872007-08-18 13:14:55 +09005881 int i, rc;
Heiner Kallweit7e22c002015-12-06 21:56:33 +01005882 char *irq_desc;
Tejun Heof5cda252007-04-17 23:44:07 +09005883
5884 rc = ata_host_start(host);
5885 if (rc)
5886 return rc;
5887
Paul Mundt3d46b2e2007-11-08 11:14:56 +09005888 /* Special case for polling mode */
5889 if (!irq) {
5890 WARN_ON(irq_handler);
5891 return ata_host_register(host, sht);
5892 }
5893
Heiner Kallweit7e22c002015-12-06 21:56:33 +01005894 irq_desc = devm_kasprintf(host->dev, GFP_KERNEL, "%s[%s]",
5895 dev_driver_string(host->dev),
5896 dev_name(host->dev));
5897 if (!irq_desc)
5898 return -ENOMEM;
5899
Tejun Heof5cda252007-04-17 23:44:07 +09005900 rc = devm_request_irq(host->dev, irq, irq_handler, irq_flags,
Heiner Kallweit7e22c002015-12-06 21:56:33 +01005901 irq_desc, host);
Tejun Heof5cda252007-04-17 23:44:07 +09005902 if (rc)
5903 return rc;
5904
Tejun Heocbcdd872007-08-18 13:14:55 +09005905 for (i = 0; i < host->n_ports; i++)
5906 ata_port_desc(host->ports[i], "irq %d", irq);
Tejun Heo40318262007-07-03 01:38:47 +09005907
Tejun Heof5cda252007-04-17 23:44:07 +09005908 rc = ata_host_register(host, sht);
5909 /* if failed, just free the IRQ and leave ports alone */
5910 if (rc)
5911 devm_free_irq(host->dev, irq, host);
5912
5913 return rc;
5914}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005915EXPORT_SYMBOL_GPL(ata_host_activate);
Tejun Heof5cda252007-04-17 23:44:07 +09005916
5917/**
Masanari Iidac9b55602016-04-13 23:36:27 +09005918 * ata_port_detach - Detach ATA port in preparation of device removal
Tejun Heo720ba122006-05-31 18:28:13 +09005919 * @ap: ATA port to be detached
5920 *
5921 * Detach all ATA devices and the associated SCSI devices of @ap;
5922 * then, remove the associated SCSI host. @ap is guaranteed to
5923 * be quiescent on return from this function.
5924 *
5925 * LOCKING:
5926 * Kernel thread context (may sleep).
5927 */
Adrian Bunk741b7762007-10-24 18:23:06 +02005928static void ata_port_detach(struct ata_port *ap)
Tejun Heo720ba122006-05-31 18:28:13 +09005929{
5930 unsigned long flags;
Levente Kurusaa6f9bf42014-05-06 15:57:48 +02005931 struct ata_link *link;
5932 struct ata_device *dev;
Tejun Heo720ba122006-05-31 18:28:13 +09005933
5934 if (!ap->ops->error_handler)
Tejun Heoc3cf30a2006-08-05 03:59:11 +09005935 goto skip_eh;
Tejun Heo720ba122006-05-31 18:28:13 +09005936
5937 /* tell EH we're leaving & flush EH */
Jeff Garzikba6a1302006-06-22 23:46:10 -04005938 spin_lock_irqsave(ap->lock, flags);
Tejun Heob51e9e52006-06-29 01:29:30 +09005939 ap->pflags |= ATA_PFLAG_UNLOADING;
Tejun Heoece180d2008-11-03 20:04:37 +09005940 ata_port_schedule_eh(ap);
Jeff Garzikba6a1302006-06-22 23:46:10 -04005941 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo720ba122006-05-31 18:28:13 +09005942
Tejun Heoece180d2008-11-03 20:04:37 +09005943 /* wait till EH commits suicide */
Tejun Heo720ba122006-05-31 18:28:13 +09005944 ata_port_wait_eh(ap);
5945
Tejun Heoece180d2008-11-03 20:04:37 +09005946 /* it better be dead now */
5947 WARN_ON(!(ap->pflags & ATA_PFLAG_UNLOADED));
Tejun Heo720ba122006-05-31 18:28:13 +09005948
Tejun Heoafe2c512010-12-14 16:21:17 +01005949 cancel_delayed_work_sync(&ap->hotplug_task);
Tejun Heo720ba122006-05-31 18:28:13 +09005950
Tejun Heoc3cf30a2006-08-05 03:59:11 +09005951 skip_eh:
Levente Kurusaa6f9bf42014-05-06 15:57:48 +02005952 /* clean up zpodd on port removal */
5953 ata_for_each_link(link, ap, HOST_FIRST) {
5954 ata_for_each_dev(dev, link, ALL) {
5955 if (zpodd_dev_enabled(dev))
5956 zpodd_exit(dev);
5957 }
5958 }
Gwendal Grignoud9027472010-05-25 12:31:38 -07005959 if (ap->pmp_link) {
5960 int i;
5961 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
5962 ata_tlink_delete(&ap->pmp_link[i]);
5963 }
Tejun Heo720ba122006-05-31 18:28:13 +09005964 /* remove the associated SCSI host */
Jeff Garzikcca39742006-08-24 03:19:22 -04005965 scsi_remove_host(ap->scsi_host);
Rafael J. Wysockic5700762013-11-25 13:19:01 +01005966 ata_tport_delete(ap);
Tejun Heo720ba122006-05-31 18:28:13 +09005967}
5968
5969/**
Tejun Heo0529c1592007-01-20 16:00:26 +09005970 * ata_host_detach - Detach all ports of an ATA host
5971 * @host: Host to detach
5972 *
5973 * Detach all ports of @host.
5974 *
5975 * LOCKING:
5976 * Kernel thread context (may sleep).
5977 */
5978void ata_host_detach(struct ata_host *host)
5979{
5980 int i;
5981
Kai-Heng Fengb5292112020-06-03 15:48:19 +08005982 for (i = 0; i < host->n_ports; i++) {
5983 /* Ensure ata_port probe has completed */
5984 async_synchronize_cookie(host->ports[i]->cookie + 1);
Tejun Heo0529c1592007-01-20 16:00:26 +09005985 ata_port_detach(host->ports[i]);
Kai-Heng Fengb5292112020-06-03 15:48:19 +08005986 }
Tejun Heo562f0c22007-12-15 15:05:01 +09005987
5988 /* the host is dead now, dissociate ACPI */
5989 ata_acpi_dissociate(host);
Tejun Heo0529c1592007-01-20 16:00:26 +09005990}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01005991EXPORT_SYMBOL_GPL(ata_host_detach);
Tejun Heo0529c1592007-01-20 16:00:26 +09005992
Jeff Garzik374b1872005-08-30 05:42:52 -04005993#ifdef CONFIG_PCI
5994
Edward Falk0baab862005-06-02 18:17:13 -04005995/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07005996 * ata_pci_remove_one - PCI layer callback for device removal
5997 * @pdev: PCI device that was removed
5998 *
Tejun Heob878ca52007-01-20 16:00:28 +09005999 * PCI layer indicates to libata via this hook that hot-unplug or
6000 * module unload event has occurred. Detach all ports. Resource
6001 * release is handled via devres.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006002 *
6003 * LOCKING:
6004 * Inherited from PCI layer (may sleep).
6005 */
Tejun Heof0d36ef2007-01-20 16:00:28 +09006006void ata_pci_remove_one(struct pci_dev *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006007{
Brian Norris04a3f5b2012-12-03 10:34:41 -08006008 struct ata_host *host = pci_get_drvdata(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07006009
Tejun Heob878ca52007-01-20 16:00:28 +09006010 ata_host_detach(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -07006011}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006012EXPORT_SYMBOL_GPL(ata_pci_remove_one);
Linus Torvalds1da177e2005-04-16 15:20:36 -07006013
Prabhakar Kushwaha10a663a2020-01-25 03:37:29 +00006014void ata_pci_shutdown_one(struct pci_dev *pdev)
6015{
6016 struct ata_host *host = pci_get_drvdata(pdev);
6017 int i;
6018
6019 for (i = 0; i < host->n_ports; i++) {
6020 struct ata_port *ap = host->ports[i];
6021
6022 ap->pflags |= ATA_PFLAG_FROZEN;
6023
6024 /* Disable port interrupts */
6025 if (ap->ops->freeze)
6026 ap->ops->freeze(ap);
6027
6028 /* Stop the port DMA engines */
6029 if (ap->ops->port_stop)
6030 ap->ops->port_stop(ap);
6031 }
6032}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006033EXPORT_SYMBOL_GPL(ata_pci_shutdown_one);
Prabhakar Kushwaha10a663a2020-01-25 03:37:29 +00006034
Linus Torvalds1da177e2005-04-16 15:20:36 -07006035/* move to PCI subsystem */
Jeff Garzik057ace52005-10-22 14:27:05 -04006036int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006037{
6038 unsigned long tmp = 0;
6039
6040 switch (bits->width) {
6041 case 1: {
6042 u8 tmp8 = 0;
6043 pci_read_config_byte(pdev, bits->reg, &tmp8);
6044 tmp = tmp8;
6045 break;
6046 }
6047 case 2: {
6048 u16 tmp16 = 0;
6049 pci_read_config_word(pdev, bits->reg, &tmp16);
6050 tmp = tmp16;
6051 break;
6052 }
6053 case 4: {
6054 u32 tmp32 = 0;
6055 pci_read_config_dword(pdev, bits->reg, &tmp32);
6056 tmp = tmp32;
6057 break;
6058 }
6059
6060 default:
6061 return -EINVAL;
6062 }
6063
6064 tmp &= bits->mask;
6065
6066 return (tmp == bits->val) ? 1 : 0;
6067}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006068EXPORT_SYMBOL_GPL(pci_test_config_bits);
Jens Axboe9b847542006-01-06 09:28:07 +01006069
Tejun Heo6ffa01d2007-03-02 17:32:47 +09006070#ifdef CONFIG_PM
Tejun Heo3c5100c2006-07-26 16:58:33 +09006071void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg)
Jens Axboe9b847542006-01-06 09:28:07 +01006072{
6073 pci_save_state(pdev);
Tejun Heo4c90d972007-02-20 18:14:48 +09006074 pci_disable_device(pdev);
Tejun Heo500530f2006-07-03 16:07:27 +09006075
Rafael J. Wysocki3a2d5b72008-02-23 19:13:25 +01006076 if (mesg.event & PM_EVENT_SLEEP)
Tejun Heo500530f2006-07-03 16:07:27 +09006077 pci_set_power_state(pdev, PCI_D3hot);
Jens Axboe9b847542006-01-06 09:28:07 +01006078}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006079EXPORT_SYMBOL_GPL(ata_pci_device_do_suspend);
Jens Axboe9b847542006-01-06 09:28:07 +01006080
Tejun Heo553c4aa2006-12-26 19:39:50 +09006081int ata_pci_device_do_resume(struct pci_dev *pdev)
Jens Axboe9b847542006-01-06 09:28:07 +01006082{
Tejun Heo553c4aa2006-12-26 19:39:50 +09006083 int rc;
6084
Jens Axboe9b847542006-01-06 09:28:07 +01006085 pci_set_power_state(pdev, PCI_D0);
6086 pci_restore_state(pdev);
Tejun Heo553c4aa2006-12-26 19:39:50 +09006087
Tejun Heob878ca52007-01-20 16:00:28 +09006088 rc = pcim_enable_device(pdev);
Tejun Heo553c4aa2006-12-26 19:39:50 +09006089 if (rc) {
Joe Perchesa44fec12011-04-15 15:51:58 -07006090 dev_err(&pdev->dev,
6091 "failed to enable device after resume (%d)\n", rc);
Tejun Heo553c4aa2006-12-26 19:39:50 +09006092 return rc;
6093 }
6094
Jens Axboe9b847542006-01-06 09:28:07 +01006095 pci_set_master(pdev);
Tejun Heo553c4aa2006-12-26 19:39:50 +09006096 return 0;
Tejun Heo500530f2006-07-03 16:07:27 +09006097}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006098EXPORT_SYMBOL_GPL(ata_pci_device_do_resume);
Tejun Heo500530f2006-07-03 16:07:27 +09006099
Tejun Heo3c5100c2006-07-26 16:58:33 +09006100int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
Tejun Heo500530f2006-07-03 16:07:27 +09006101{
Brian Norris04a3f5b2012-12-03 10:34:41 -08006102 struct ata_host *host = pci_get_drvdata(pdev);
Tejun Heo500530f2006-07-03 16:07:27 +09006103 int rc = 0;
6104
Jeff Garzikcca39742006-08-24 03:19:22 -04006105 rc = ata_host_suspend(host, mesg);
Tejun Heo500530f2006-07-03 16:07:27 +09006106 if (rc)
6107 return rc;
6108
Tejun Heo3c5100c2006-07-26 16:58:33 +09006109 ata_pci_device_do_suspend(pdev, mesg);
Tejun Heo500530f2006-07-03 16:07:27 +09006110
6111 return 0;
6112}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006113EXPORT_SYMBOL_GPL(ata_pci_device_suspend);
Tejun Heo500530f2006-07-03 16:07:27 +09006114
6115int ata_pci_device_resume(struct pci_dev *pdev)
6116{
Brian Norris04a3f5b2012-12-03 10:34:41 -08006117 struct ata_host *host = pci_get_drvdata(pdev);
Tejun Heo553c4aa2006-12-26 19:39:50 +09006118 int rc;
Tejun Heo500530f2006-07-03 16:07:27 +09006119
Tejun Heo553c4aa2006-12-26 19:39:50 +09006120 rc = ata_pci_device_do_resume(pdev);
6121 if (rc == 0)
6122 ata_host_resume(host);
6123 return rc;
Jens Axboe9b847542006-01-06 09:28:07 +01006124}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006125EXPORT_SYMBOL_GPL(ata_pci_device_resume);
Tejun Heo6ffa01d2007-03-02 17:32:47 +09006126#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -07006127#endif /* CONFIG_PCI */
6128
Brian Norrisb7db04d2012-11-02 12:29:32 -07006129/**
6130 * ata_platform_remove_one - Platform layer callback for device removal
6131 * @pdev: Platform device that was removed
6132 *
6133 * Platform layer indicates to libata via this hook that hot-unplug or
6134 * module unload event has occurred. Detach all ports. Resource
6135 * release is handled via devres.
6136 *
6137 * LOCKING:
6138 * Inherited from platform layer (may sleep).
6139 */
6140int ata_platform_remove_one(struct platform_device *pdev)
6141{
6142 struct ata_host *host = platform_get_drvdata(pdev);
6143
6144 ata_host_detach(host);
6145
6146 return 0;
6147}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006148EXPORT_SYMBOL_GPL(ata_platform_remove_one);
Brian Norrisb7db04d2012-11-02 12:29:32 -07006149
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +01006150#ifdef CONFIG_ATA_FORCE
Tejun Heo33267322008-02-13 09:15:09 +09006151static int __init ata_parse_force_one(char **cur,
6152 struct ata_force_ent *force_ent,
6153 const char **reason)
6154{
Rasmus Villemoes0f5f2642015-06-09 15:33:19 +02006155 static const struct ata_force_param force_tbl[] __initconst = {
Tejun Heo33267322008-02-13 09:15:09 +09006156 { "40c", .cbl = ATA_CBL_PATA40 },
6157 { "80c", .cbl = ATA_CBL_PATA80 },
6158 { "short40c", .cbl = ATA_CBL_PATA40_SHORT },
6159 { "unk", .cbl = ATA_CBL_PATA_UNK },
6160 { "ign", .cbl = ATA_CBL_PATA_IGN },
6161 { "sata", .cbl = ATA_CBL_SATA },
6162 { "1.5Gbps", .spd_limit = 1 },
6163 { "3.0Gbps", .spd_limit = 2 },
6164 { "noncq", .horkage_on = ATA_HORKAGE_NONCQ },
6165 { "ncq", .horkage_off = ATA_HORKAGE_NONCQ },
Martin K. Petersend7b16e42015-05-04 21:54:18 -04006166 { "noncqtrim", .horkage_on = ATA_HORKAGE_NO_NCQ_TRIM },
6167 { "ncqtrim", .horkage_off = ATA_HORKAGE_NO_NCQ_TRIM },
Kate Hsuan7a8526a2021-09-03 17:44:11 +08006168 { "noncqati", .horkage_on = ATA_HORKAGE_NO_NCQ_ON_ATI },
6169 { "ncqati", .horkage_off = ATA_HORKAGE_NO_NCQ_ON_ATI },
Tejun Heo43c9c592010-05-23 12:59:11 +02006170 { "dump_id", .horkage_on = ATA_HORKAGE_DUMP_ID },
Tejun Heo33267322008-02-13 09:15:09 +09006171 { "pio0", .xfer_mask = 1 << (ATA_SHIFT_PIO + 0) },
6172 { "pio1", .xfer_mask = 1 << (ATA_SHIFT_PIO + 1) },
6173 { "pio2", .xfer_mask = 1 << (ATA_SHIFT_PIO + 2) },
6174 { "pio3", .xfer_mask = 1 << (ATA_SHIFT_PIO + 3) },
6175 { "pio4", .xfer_mask = 1 << (ATA_SHIFT_PIO + 4) },
6176 { "pio5", .xfer_mask = 1 << (ATA_SHIFT_PIO + 5) },
6177 { "pio6", .xfer_mask = 1 << (ATA_SHIFT_PIO + 6) },
6178 { "mwdma0", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 0) },
6179 { "mwdma1", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 1) },
6180 { "mwdma2", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 2) },
6181 { "mwdma3", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 3) },
6182 { "mwdma4", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 4) },
6183 { "udma0", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6184 { "udma16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6185 { "udma/16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6186 { "udma1", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6187 { "udma25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6188 { "udma/25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6189 { "udma2", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6190 { "udma33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6191 { "udma/33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6192 { "udma3", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6193 { "udma44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6194 { "udma/44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6195 { "udma4", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6196 { "udma66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6197 { "udma/66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6198 { "udma5", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6199 { "udma100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6200 { "udma/100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6201 { "udma6", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6202 { "udma133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6203 { "udma/133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6204 { "udma7", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 7) },
Tejun Heo05944bd2008-08-13 20:19:09 +09006205 { "nohrst", .lflags = ATA_LFLAG_NO_HRST },
6206 { "nosrst", .lflags = ATA_LFLAG_NO_SRST },
6207 { "norst", .lflags = ATA_LFLAG_NO_HRST | ATA_LFLAG_NO_SRST },
Dan Williamsca6d43b2012-06-21 23:41:41 -07006208 { "rstonce", .lflags = ATA_LFLAG_RST_ONCE },
Vincent Pelletier966fbe12013-05-21 22:30:58 +02006209 { "atapi_dmadir", .horkage_on = ATA_HORKAGE_ATAPI_DMADIR },
Robin H. Johnsonb8bd6dc2013-12-16 09:31:19 -08006210 { "disable", .horkage_on = ATA_HORKAGE_DISABLE },
Tejun Heo33267322008-02-13 09:15:09 +09006211 };
6212 char *start = *cur, *p = *cur;
6213 char *id, *val, *endp;
6214 const struct ata_force_param *match_fp = NULL;
6215 int nr_matches = 0, i;
6216
6217 /* find where this param ends and update *cur */
6218 while (*p != '\0' && *p != ',')
6219 p++;
6220
6221 if (*p == '\0')
6222 *cur = p;
6223 else
6224 *cur = p + 1;
6225
6226 *p = '\0';
6227
6228 /* parse */
6229 p = strchr(start, ':');
6230 if (!p) {
6231 val = strstrip(start);
6232 goto parse_val;
6233 }
6234 *p = '\0';
6235
6236 id = strstrip(start);
6237 val = strstrip(p + 1);
6238
6239 /* parse id */
6240 p = strchr(id, '.');
6241 if (p) {
6242 *p++ = '\0';
6243 force_ent->device = simple_strtoul(p, &endp, 10);
6244 if (p == endp || *endp != '\0') {
6245 *reason = "invalid device";
6246 return -EINVAL;
6247 }
6248 }
6249
6250 force_ent->port = simple_strtoul(id, &endp, 10);
Tejun Heof7cf69a2017-05-31 14:26:26 -04006251 if (id == endp || *endp != '\0') {
Tejun Heo33267322008-02-13 09:15:09 +09006252 *reason = "invalid port/link";
6253 return -EINVAL;
6254 }
6255
6256 parse_val:
6257 /* parse val, allow shortcuts so that both 1.5 and 1.5Gbps work */
6258 for (i = 0; i < ARRAY_SIZE(force_tbl); i++) {
6259 const struct ata_force_param *fp = &force_tbl[i];
6260
6261 if (strncasecmp(val, fp->name, strlen(val)))
6262 continue;
6263
6264 nr_matches++;
6265 match_fp = fp;
6266
6267 if (strcasecmp(val, fp->name) == 0) {
6268 nr_matches = 1;
6269 break;
6270 }
6271 }
6272
6273 if (!nr_matches) {
6274 *reason = "unknown value";
6275 return -EINVAL;
6276 }
6277 if (nr_matches > 1) {
Arvind Yadav9de55352017-10-28 23:51:47 +05306278 *reason = "ambiguous value";
Tejun Heo33267322008-02-13 09:15:09 +09006279 return -EINVAL;
6280 }
6281
6282 force_ent->param = *match_fp;
6283
6284 return 0;
6285}
6286
6287static void __init ata_parse_force_param(void)
6288{
6289 int idx = 0, size = 1;
6290 int last_port = -1, last_device = -1;
6291 char *p, *cur, *next;
6292
6293 /* calculate maximum number of params and allocate force_tbl */
6294 for (p = ata_force_param_buf; *p; p++)
6295 if (*p == ',')
6296 size++;
6297
Kees Cook6396bb22018-06-12 14:03:40 -07006298 ata_force_tbl = kcalloc(size, sizeof(ata_force_tbl[0]), GFP_KERNEL);
Tejun Heo33267322008-02-13 09:15:09 +09006299 if (!ata_force_tbl) {
6300 printk(KERN_WARNING "ata: failed to extend force table, "
6301 "libata.force ignored\n");
6302 return;
6303 }
6304
6305 /* parse and populate the table */
6306 for (cur = ata_force_param_buf; *cur != '\0'; cur = next) {
6307 const char *reason = "";
6308 struct ata_force_ent te = { .port = -1, .device = -1 };
6309
6310 next = cur;
6311 if (ata_parse_force_one(&next, &te, &reason)) {
6312 printk(KERN_WARNING "ata: failed to parse force "
6313 "parameter \"%s\" (%s)\n",
6314 cur, reason);
6315 continue;
6316 }
6317
6318 if (te.port == -1) {
6319 te.port = last_port;
6320 te.device = last_device;
6321 }
6322
6323 ata_force_tbl[idx++] = te;
6324
6325 last_port = te.port;
6326 last_device = te.device;
6327 }
6328
6329 ata_force_tbl_size = idx;
6330}
Linus Torvalds1da177e2005-04-16 15:20:36 -07006331
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +01006332static void ata_free_force_param(void)
6333{
6334 kfree(ata_force_tbl);
6335}
6336#else
6337static inline void ata_parse_force_param(void) { }
6338static inline void ata_free_force_param(void) { }
6339#endif
6340
Linus Torvalds1da177e2005-04-16 15:20:36 -07006341static int __init ata_init(void)
6342{
Gwendal Grignoud9027472010-05-25 12:31:38 -07006343 int rc;
Tejun Heo270390e2010-05-10 21:41:35 +02006344
Tejun Heo33267322008-02-13 09:15:09 +09006345 ata_parse_force_param();
6346
Tejun Heo270390e2010-05-10 21:41:35 +02006347 rc = ata_sff_init();
Tejun Heoad72cf92010-07-02 10:03:52 +02006348 if (rc) {
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +01006349 ata_free_force_param();
Tejun Heoad72cf92010-07-02 10:03:52 +02006350 return rc;
6351 }
Tejun Heo453b07a2006-05-31 18:27:42 +09006352
Gwendal Grignoud9027472010-05-25 12:31:38 -07006353 libata_transport_init();
6354 ata_scsi_transport_template = ata_attach_transport();
6355 if (!ata_scsi_transport_template) {
6356 ata_sff_exit();
6357 rc = -ENOMEM;
6358 goto err_out;
Jeff Garzik4fca3772011-02-15 01:13:24 -05006359 }
Gwendal Grignoud9027472010-05-25 12:31:38 -07006360
Linus Torvalds1da177e2005-04-16 15:20:36 -07006361 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
6362 return 0;
Gwendal Grignoud9027472010-05-25 12:31:38 -07006363
6364err_out:
6365 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07006366}
6367
6368static void __exit ata_exit(void)
6369{
Gwendal Grignoud9027472010-05-25 12:31:38 -07006370 ata_release_transport(ata_scsi_transport_template);
6371 libata_transport_exit();
Tejun Heo270390e2010-05-10 21:41:35 +02006372 ata_sff_exit();
Bartlomiej Zolnierkiewiczbf89b0b2020-03-26 16:58:22 +01006373 ata_free_force_param();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006374}
6375
Brian Kinga4625082006-11-13 16:32:36 -06006376subsys_initcall(ata_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07006377module_exit(ata_exit);
6378
Akinobu Mita9990b6f2010-04-12 21:11:41 +09006379static DEFINE_RATELIMIT_STATE(ratelimit, HZ / 5, 1);
Jeff Garzik67846b32005-10-05 02:58:32 -04006380
6381int ata_ratelimit(void)
6382{
Akinobu Mita9990b6f2010-04-12 21:11:41 +09006383 return __ratelimit(&ratelimit);
Jeff Garzik67846b32005-10-05 02:58:32 -04006384}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006385EXPORT_SYMBOL_GPL(ata_ratelimit);
Jeff Garzik67846b32005-10-05 02:58:32 -04006386
Tejun Heoc0c362b2010-09-06 17:57:14 +02006387/**
6388 * ata_msleep - ATA EH owner aware msleep
6389 * @ap: ATA port to attribute the sleep to
6390 * @msecs: duration to sleep in milliseconds
6391 *
6392 * Sleeps @msecs. If the current task is owner of @ap's EH, the
6393 * ownership is released before going to sleep and reacquired
6394 * after the sleep is complete. IOW, other ports sharing the
6395 * @ap->host will be allowed to own the EH while this task is
6396 * sleeping.
6397 *
6398 * LOCKING:
6399 * Might sleep.
6400 */
Tejun Heo97750ce2010-09-06 17:56:29 +02006401void ata_msleep(struct ata_port *ap, unsigned int msecs)
6402{
Tejun Heoc0c362b2010-09-06 17:57:14 +02006403 bool owns_eh = ap && ap->host->eh_owner == current;
6404
6405 if (owns_eh)
6406 ata_eh_release(ap);
6407
Anil Veliyankara Madam848c3922016-01-07 21:18:52 -08006408 if (msecs < 20) {
6409 unsigned long usecs = msecs * USEC_PER_MSEC;
6410 usleep_range(usecs, usecs + 50);
6411 } else {
6412 msleep(msecs);
6413 }
Tejun Heoc0c362b2010-09-06 17:57:14 +02006414
6415 if (owns_eh)
6416 ata_eh_acquire(ap);
Tejun Heo97750ce2010-09-06 17:56:29 +02006417}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006418EXPORT_SYMBOL_GPL(ata_msleep);
Tejun Heo97750ce2010-09-06 17:56:29 +02006419
Tejun Heoc22daff2006-04-11 22:22:29 +09006420/**
6421 * ata_wait_register - wait until register value changes
Tejun Heo97750ce2010-09-06 17:56:29 +02006422 * @ap: ATA port to wait register for, can be NULL
Tejun Heoc22daff2006-04-11 22:22:29 +09006423 * @reg: IO-mapped register
6424 * @mask: Mask to apply to read register value
6425 * @val: Wait condition
Tejun Heo341c2c92008-05-20 02:17:51 +09006426 * @interval: polling interval in milliseconds
6427 * @timeout: timeout in milliseconds
Tejun Heoc22daff2006-04-11 22:22:29 +09006428 *
6429 * Waiting for some bits of register to change is a common
6430 * operation for ATA controllers. This function reads 32bit LE
6431 * IO-mapped register @reg and tests for the following condition.
6432 *
6433 * (*@reg & mask) != val
6434 *
6435 * If the condition is met, it returns; otherwise, the process is
6436 * repeated after @interval_msec until timeout.
6437 *
6438 * LOCKING:
6439 * Kernel thread context (may sleep)
6440 *
6441 * RETURNS:
6442 * The final register value.
6443 */
Tejun Heo97750ce2010-09-06 17:56:29 +02006444u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask, u32 val,
Tejun Heo341c2c92008-05-20 02:17:51 +09006445 unsigned long interval, unsigned long timeout)
Tejun Heoc22daff2006-04-11 22:22:29 +09006446{
Tejun Heo341c2c92008-05-20 02:17:51 +09006447 unsigned long deadline;
Tejun Heoc22daff2006-04-11 22:22:29 +09006448 u32 tmp;
6449
6450 tmp = ioread32(reg);
6451
6452 /* Calculate timeout _after_ the first read to make sure
6453 * preceding writes reach the controller before starting to
6454 * eat away the timeout.
6455 */
Tejun Heo341c2c92008-05-20 02:17:51 +09006456 deadline = ata_deadline(jiffies, timeout);
Tejun Heoc22daff2006-04-11 22:22:29 +09006457
Tejun Heo341c2c92008-05-20 02:17:51 +09006458 while ((tmp & mask) == val && time_before(jiffies, deadline)) {
Tejun Heo97750ce2010-09-06 17:56:29 +02006459 ata_msleep(ap, interval);
Tejun Heoc22daff2006-04-11 22:22:29 +09006460 tmp = ioread32(reg);
6461 }
6462
6463 return tmp;
6464}
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006465EXPORT_SYMBOL_GPL(ata_wait_register);
Tejun Heoc22daff2006-04-11 22:22:29 +09006466
Linus Torvalds1da177e2005-04-16 15:20:36 -07006467/*
Tejun Heodd5b06c2006-08-10 16:59:12 +09006468 * Dummy port_ops
6469 */
Tejun Heodd5b06c2006-08-10 16:59:12 +09006470static unsigned int ata_dummy_qc_issue(struct ata_queued_cmd *qc)
6471{
6472 return AC_ERR_SYSTEM;
6473}
6474
Tejun Heo182d7bb2008-04-07 22:47:21 +09006475static void ata_dummy_error_handler(struct ata_port *ap)
6476{
6477 /* truly dummy */
6478}
6479
Tejun Heo029cfd62008-03-25 12:22:49 +09006480struct ata_port_operations ata_dummy_port_ops = {
Tejun Heodd5b06c2006-08-10 16:59:12 +09006481 .qc_prep = ata_noop_qc_prep,
6482 .qc_issue = ata_dummy_qc_issue,
Tejun Heo182d7bb2008-04-07 22:47:21 +09006483 .error_handler = ata_dummy_error_handler,
Dan Williamse4a9c372012-06-21 23:25:27 -07006484 .sched_eh = ata_std_sched_eh,
6485 .end_eh = ata_std_end_eh,
Tejun Heodd5b06c2006-08-10 16:59:12 +09006486};
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006487EXPORT_SYMBOL_GPL(ata_dummy_port_ops);
Tejun Heodd5b06c2006-08-10 16:59:12 +09006488
Tejun Heo21b0ad42007-04-17 23:44:07 +09006489const struct ata_port_info ata_dummy_port_info = {
6490 .port_ops = &ata_dummy_port_ops,
6491};
Bartlomiej Zolnierkiewicza52fbcf2020-03-26 16:58:04 +01006492EXPORT_SYMBOL_GPL(ata_dummy_port_info);
Tejun Heo21b0ad42007-04-17 23:44:07 +09006493
Joe Perches06296a12011-04-15 15:52:00 -07006494void ata_print_version(const struct device *dev, const char *version)
6495{
6496 dev_printk(KERN_DEBUG, dev, "version %s\n", version);
6497}
6498EXPORT_SYMBOL(ata_print_version);
Hannes Reineckec206a382021-12-21 08:20:31 +01006499
6500EXPORT_TRACEPOINT_SYMBOL_GPL(ata_tf_load);
6501EXPORT_TRACEPOINT_SYMBOL_GPL(ata_exec_command);
6502EXPORT_TRACEPOINT_SYMBOL_GPL(ata_bmdma_setup);
6503EXPORT_TRACEPOINT_SYMBOL_GPL(ata_bmdma_start);
6504EXPORT_TRACEPOINT_SYMBOL_GPL(ata_bmdma_status);