2019-05-19 13:51:48 +00:00
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2006-08-29 22:12:40 +00:00
|
|
|
/*
|
|
|
|
* pata_ns87410.c - National Semiconductor 87410 PATA for new ATA layer
|
|
|
|
* (C) 2006 Red Hat Inc
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/kernel.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/pci.h>
|
|
|
|
#include <linux/blkdev.h>
|
|
|
|
#include <linux/delay.h>
|
|
|
|
#include <scsi/scsi_host.h>
|
|
|
|
#include <linux/libata.h>
|
|
|
|
|
|
|
|
#define DRV_NAME "pata_ns87410"
|
2007-03-09 12:24:15 +00:00
|
|
|
#define DRV_VERSION "0.4.6"
|
2006-08-29 22:12:40 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ns87410_pre_reset - probe begin
|
2007-08-06 09:36:23 +00:00
|
|
|
* @link: ATA link
|
libata: add deadline support to prereset and reset methods
Add @deadline to prereset and reset methods and make them honor it.
ata_wait_ready() which directly takes @deadline is implemented to be
used as the wait function. This patch is in preparation for EH timing
improvements.
* ata_wait_ready() never does busy sleep. It's only used from EH and
no wait in EH is that urgent. This function also prints 'be
patient' message automatically after 5 secs of waiting if more than
3 secs is remaining till deadline.
* ata_bus_post_reset() now fails with error code if any of its wait
fails. This is important because earlier reset tries will have
shorter timeout than the spec requires. If a device fails to
respond before the short timeout, reset should be retried with
longer timeout rather than silently ignoring the device.
There are three behavior differences.
1. Timeout is applied to both devices at once, not separately. This
is more consistent with what the spec says.
2. When a device passes devchk but fails to become ready before
deadline. Previouly, post_reset would just succeed and let
device classification remove the device. New code fails the
reset thus causing reset retry. After a few times, EH will give
up disabling the port.
3. When slave device passes devchk but fails to become accessible
(TF-wise) after reset. Original code disables dev1 after 30s
timeout and continues as if the device doesn't exist, while the
patched code fails reset. When this happens, new code fails
reset on whole port rather than proceeding with only the primary
device.
If the failing device is suffering transient problems, new code
retries reset which is a better behavior. If the failing device is
actually broken, the net effect is identical to it, but not to the
other device sharing the channel. In the previous code, reset would
have succeeded after 30s thus detecting the working one. In the new
code, reset fails and whole port gets disabled. IMO, it's a
pathological case anyway (broken device sharing bus with working
one) and doesn't really matter.
* ata_bus_softreset() is changed to return error code from
ata_bus_post_reset(). It used to return 0 unconditionally.
* Spin up waiting is to be removed and not converted to honor
deadline.
* To be on the safe side, deadline is set to 40s for the time being.
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-02-02 07:50:52 +00:00
|
|
|
* @deadline: deadline jiffies for the operation
|
2006-08-29 22:12:40 +00:00
|
|
|
*
|
2007-03-09 12:24:15 +00:00
|
|
|
* Check enabled ports
|
2006-08-29 22:12:40 +00:00
|
|
|
*/
|
|
|
|
|
2007-08-06 09:36:23 +00:00
|
|
|
static int ns87410_pre_reset(struct ata_link *link, unsigned long deadline)
|
2006-08-29 22:12:40 +00:00
|
|
|
{
|
2007-08-06 09:36:23 +00:00
|
|
|
struct ata_port *ap = link->ap;
|
2006-08-29 22:12:40 +00:00
|
|
|
struct pci_dev *pdev = to_pci_dev(ap->host->dev);
|
|
|
|
static const struct pci_bits ns87410_enable_bits[] = {
|
|
|
|
{ 0x43, 1, 0x08, 0x08 },
|
|
|
|
{ 0x47, 1, 0x08, 0x08 }
|
|
|
|
};
|
|
|
|
|
2006-09-26 16:53:38 +00:00
|
|
|
if (!pci_test_config_bits(pdev, &ns87410_enable_bits[ap->port_no]))
|
|
|
|
return -ENOENT;
|
libata: add deadline support to prereset and reset methods
Add @deadline to prereset and reset methods and make them honor it.
ata_wait_ready() which directly takes @deadline is implemented to be
used as the wait function. This patch is in preparation for EH timing
improvements.
* ata_wait_ready() never does busy sleep. It's only used from EH and
no wait in EH is that urgent. This function also prints 'be
patient' message automatically after 5 secs of waiting if more than
3 secs is remaining till deadline.
* ata_bus_post_reset() now fails with error code if any of its wait
fails. This is important because earlier reset tries will have
shorter timeout than the spec requires. If a device fails to
respond before the short timeout, reset should be retried with
longer timeout rather than silently ignoring the device.
There are three behavior differences.
1. Timeout is applied to both devices at once, not separately. This
is more consistent with what the spec says.
2. When a device passes devchk but fails to become ready before
deadline. Previouly, post_reset would just succeed and let
device classification remove the device. New code fails the
reset thus causing reset retry. After a few times, EH will give
up disabling the port.
3. When slave device passes devchk but fails to become accessible
(TF-wise) after reset. Original code disables dev1 after 30s
timeout and continues as if the device doesn't exist, while the
patched code fails reset. When this happens, new code fails
reset on whole port rather than proceeding with only the primary
device.
If the failing device is suffering transient problems, new code
retries reset which is a better behavior. If the failing device is
actually broken, the net effect is identical to it, but not to the
other device sharing the channel. In the previous code, reset would
have succeeded after 30s thus detecting the working one. In the new
code, reset fails and whole port gets disabled. IMO, it's a
pathological case anyway (broken device sharing bus with working
one) and doesn't really matter.
* ata_bus_softreset() is changed to return error code from
ata_bus_post_reset(). It used to return 0 unconditionally.
* Spin up waiting is to be removed and not converted to honor
deadline.
* To be on the safe side, deadline is set to 40s for the time being.
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-02-02 07:50:52 +00:00
|
|
|
|
2008-04-07 13:47:16 +00:00
|
|
|
return ata_sff_prereset(link, deadline);
|
2006-08-29 22:12:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ns87410_set_piomode - set initial PIO mode data
|
|
|
|
* @ap: ATA interface
|
|
|
|
* @adev: ATA device
|
|
|
|
*
|
|
|
|
* Program timing data. This is kept per channel not per device,
|
|
|
|
* and only affects the data port.
|
|
|
|
*/
|
|
|
|
|
|
|
|
static void ns87410_set_piomode(struct ata_port *ap, struct ata_device *adev)
|
|
|
|
{
|
|
|
|
struct pci_dev *pdev = to_pci_dev(ap->host->dev);
|
|
|
|
int port = 0x40 + 4 * ap->port_no;
|
|
|
|
u8 idetcr, idefr;
|
|
|
|
struct ata_timing at;
|
|
|
|
|
|
|
|
static const u8 activebits[15] = {
|
|
|
|
0, 1, 2, 3, 4,
|
|
|
|
5, 5, 6, 6, 6,
|
|
|
|
6, 7, 7, 7, 7
|
|
|
|
};
|
|
|
|
|
|
|
|
static const u8 recoverbits[12] = {
|
|
|
|
0, 1, 2, 3, 4, 5, 6, 6, 7, 7, 7, 7
|
|
|
|
};
|
|
|
|
|
|
|
|
pci_read_config_byte(pdev, port + 3, &idefr);
|
|
|
|
|
|
|
|
if (ata_pio_need_iordy(adev))
|
|
|
|
idefr |= 0x04; /* IORDY enable */
|
|
|
|
else
|
|
|
|
idefr &= ~0x04;
|
|
|
|
|
|
|
|
if (ata_timing_compute(adev, adev->pio_mode, &at, 30303, 1) < 0) {
|
2011-04-15 22:51:58 +00:00
|
|
|
dev_err(&pdev->dev, "unknown mode %d\n", adev->pio_mode);
|
2006-08-29 22:12:40 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2008-05-14 23:17:00 +00:00
|
|
|
at.active = clamp_val(at.active, 2, 16) - 2;
|
|
|
|
at.setup = clamp_val(at.setup, 1, 4) - 1;
|
|
|
|
at.recover = clamp_val(at.recover, 1, 12) - 1;
|
2006-08-29 22:12:40 +00:00
|
|
|
|
|
|
|
idetcr = (at.setup << 6) | (recoverbits[at.recover] << 3) | activebits[at.active];
|
|
|
|
|
|
|
|
pci_write_config_byte(pdev, port, idetcr);
|
|
|
|
pci_write_config_byte(pdev, port + 3, idefr);
|
|
|
|
/* We use ap->private_data as a pointer to the device currently
|
|
|
|
loaded for timing */
|
|
|
|
ap->private_data = adev;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2008-04-07 13:47:16 +00:00
|
|
|
* ns87410_qc_issue - command issue
|
2006-08-29 22:12:40 +00:00
|
|
|
* @qc: command pending
|
|
|
|
*
|
|
|
|
* Called when the libata layer is about to issue a command. We wrap
|
|
|
|
* this interface so that we can load the correct ATA timings if
|
2007-10-19 21:10:43 +00:00
|
|
|
* necessary.
|
2006-08-29 22:12:40 +00:00
|
|
|
*/
|
|
|
|
|
2008-04-07 13:47:16 +00:00
|
|
|
static unsigned int ns87410_qc_issue(struct ata_queued_cmd *qc)
|
2006-08-29 22:12:40 +00:00
|
|
|
{
|
|
|
|
struct ata_port *ap = qc->ap;
|
|
|
|
struct ata_device *adev = qc->dev;
|
|
|
|
|
|
|
|
/* If modes have been configured and the channel data is not loaded
|
|
|
|
then load it. We have to check if pio_mode is set as the core code
|
|
|
|
does not set adev->pio_mode to XFER_PIO_0 while probing as would be
|
|
|
|
logical */
|
|
|
|
|
|
|
|
if (adev->pio_mode && adev != ap->private_data)
|
|
|
|
ns87410_set_piomode(ap, adev);
|
|
|
|
|
2008-04-07 13:47:16 +00:00
|
|
|
return ata_sff_qc_issue(qc);
|
2006-08-29 22:12:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static struct scsi_host_template ns87410_sht = {
|
2008-03-25 03:22:49 +00:00
|
|
|
ATA_PIO_SHT(DRV_NAME),
|
2006-08-29 22:12:40 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
static struct ata_port_operations ns87410_port_ops = {
|
libata: implement and use ops inheritance
libata lets low level drivers build ata_port_operations table and
register it with libata core layer. This allows low level drivers
high level of flexibility but also burdens them with lots of
boilerplate entries.
This becomes worse for drivers which support related similar
controllers which differ slightly. They share most of the operations
except for a few. However, the driver still needs to list all
operations for each variant. This results in large number of
duplicate entries, which is not only inefficient but also error-prone
as it becomes very difficult to tell what the actual differences are.
This duplicate boilerplates all over the low level drivers also make
updating the core layer exteremely difficult and error-prone. When
compounded with multi-branched development model, it ends up
accumulating inconsistencies over time. Some of those inconsistencies
cause immediate problems and fixed. Others just remain there dormant
making maintenance increasingly difficult.
To rectify the problem, this patch implements ata_port_operations
inheritance. To allow LLDs to easily re-use their own ops tables
overriding only specific methods, this patch implements poor man's
class inheritance. An ops table has ->inherits field which can be set
to any ops table as long as it doesn't create a loop. When the host
is started, the inheritance chain is followed and any operation which
isn't specified is taken from the nearest ancestor which has it
specified. This operation is called finalization and done only once
per an ops table and the LLD doesn't have to do anything special about
it other than making the ops table non-const such that libata can
update it.
libata provides four base ops tables lower drivers can inherit from -
base, sata, pmp, sff and bmdma. To avoid overriding these ops
accidentaly, these ops are declared const and LLDs should always
inherit these instead of using them directly.
After finalization, all the ops table are identical before and after
the patch except for setting .irq_handler to ata_interrupt in drivers
which didn't use to. The .irq_handler doesn't have any actual effect
and the field will soon be removed by later patch.
* sata_sx4 is still using old style EH and currently doesn't take
advantage of ops inheritance.
Signed-off-by: Tejun Heo <htejun@gmail.com>
2008-03-25 03:22:49 +00:00
|
|
|
.inherits = &ata_sff_port_ops,
|
2008-04-07 13:47:16 +00:00
|
|
|
.qc_issue = ns87410_qc_issue,
|
libata: implement and use ops inheritance
libata lets low level drivers build ata_port_operations table and
register it with libata core layer. This allows low level drivers
high level of flexibility but also burdens them with lots of
boilerplate entries.
This becomes worse for drivers which support related similar
controllers which differ slightly. They share most of the operations
except for a few. However, the driver still needs to list all
operations for each variant. This results in large number of
duplicate entries, which is not only inefficient but also error-prone
as it becomes very difficult to tell what the actual differences are.
This duplicate boilerplates all over the low level drivers also make
updating the core layer exteremely difficult and error-prone. When
compounded with multi-branched development model, it ends up
accumulating inconsistencies over time. Some of those inconsistencies
cause immediate problems and fixed. Others just remain there dormant
making maintenance increasingly difficult.
To rectify the problem, this patch implements ata_port_operations
inheritance. To allow LLDs to easily re-use their own ops tables
overriding only specific methods, this patch implements poor man's
class inheritance. An ops table has ->inherits field which can be set
to any ops table as long as it doesn't create a loop. When the host
is started, the inheritance chain is followed and any operation which
isn't specified is taken from the nearest ancestor which has it
specified. This operation is called finalization and done only once
per an ops table and the LLD doesn't have to do anything special about
it other than making the ops table non-const such that libata can
update it.
libata provides four base ops tables lower drivers can inherit from -
base, sata, pmp, sff and bmdma. To avoid overriding these ops
accidentaly, these ops are declared const and LLDs should always
inherit these instead of using them directly.
After finalization, all the ops table are identical before and after
the patch except for setting .irq_handler to ata_interrupt in drivers
which didn't use to. The .irq_handler doesn't have any actual effect
and the field will soon be removed by later patch.
* sata_sx4 is still using old style EH and currently doesn't take
advantage of ops inheritance.
Signed-off-by: Tejun Heo <htejun@gmail.com>
2008-03-25 03:22:49 +00:00
|
|
|
.cable_detect = ata_cable_40wire,
|
2006-08-29 22:12:40 +00:00
|
|
|
.set_piomode = ns87410_set_piomode,
|
libata: make reset related methods proper port operations
Currently reset methods are not specified directly in the
ata_port_operations table. If a LLD wants to use custom reset
methods, it should construct and use a error_handler which uses those
reset methods. It's done this way for two reasons.
First, the ops table already contained too many methods and adding
four more of them would noticeably increase the amount of necessary
boilerplate code all over low level drivers.
Second, as ->error_handler uses those reset methods, it can get
confusing. ie. By overriding ->error_handler, those reset ops can be
made useless making layering a bit hazy.
Now that ops table uses inheritance, the first problem doesn't exist
anymore. The second isn't completely solved but is relieved by
providing default values - most drivers can just override what it has
implemented and don't have to concern itself about higher level
callbacks. In fact, there currently is no driver which actually
modifies error handling behavior. Drivers which override
->error_handler just wraps the standard error handler only to prepare
the controller for EH. I don't think making ops layering strict has
any noticeable benefit.
This patch makes ->prereset, ->softreset, ->hardreset, ->postreset and
their PMP counterparts propoer ops. Default ops are provided in the
base ops tables and drivers are converted to override individual reset
methods instead of creating custom error_handler.
* ata_std_error_handler() doesn't use sata_std_hardreset() if SCRs
aren't accessible. sata_promise doesn't need to use separate
error_handlers for PATA and SATA anymore.
* softreset is broken for sata_inic162x and sata_sx4. As libata now
always prefers hardreset, this doesn't really matter but the ops are
forced to NULL using ATA_OP_NULL for documentation purpose.
* pata_hpt374 needs to use different prereset for the first and second
PCI functions. This used to be done by branching from
hpt374_error_handler(). The proper way to do this is to use
separate ops and port_info tables for each function. Converted.
Signed-off-by: Tejun Heo <htejun@gmail.com>
2008-03-25 03:22:50 +00:00
|
|
|
.prereset = ns87410_pre_reset,
|
2006-08-29 22:12:40 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
static int ns87410_init_one(struct pci_dev *dev, const struct pci_device_id *id)
|
|
|
|
{
|
2007-05-04 10:43:58 +00:00
|
|
|
static const struct ata_port_info info = {
|
2007-05-28 10:59:48 +00:00
|
|
|
.flags = ATA_FLAG_SLAVE_POSS,
|
2009-03-14 20:38:24 +00:00
|
|
|
.pio_mask = ATA_PIO3,
|
2006-08-29 22:12:40 +00:00
|
|
|
.port_ops = &ns87410_port_ops
|
|
|
|
};
|
2007-05-04 10:43:58 +00:00
|
|
|
const struct ata_port_info *ppi[] = { &info, NULL };
|
2010-02-23 07:26:06 +00:00
|
|
|
return ata_pci_sff_init_one(dev, ppi, &ns87410_sht, NULL, 0);
|
2006-08-29 22:12:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static const struct pci_device_id ns87410[] = {
|
2006-09-29 00:21:59 +00:00
|
|
|
{ PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87410), },
|
|
|
|
|
|
|
|
{ },
|
2006-08-29 22:12:40 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
static struct pci_driver ns87410_pci_driver = {
|
2006-09-29 00:21:59 +00:00
|
|
|
.name = DRV_NAME,
|
2006-08-29 22:12:40 +00:00
|
|
|
.id_table = ns87410,
|
|
|
|
.probe = ns87410_init_one,
|
2006-11-22 16:57:36 +00:00
|
|
|
.remove = ata_pci_remove_one,
|
2014-05-07 15:17:44 +00:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2006-11-22 16:57:36 +00:00
|
|
|
.suspend = ata_pci_device_suspend,
|
|
|
|
.resume = ata_pci_device_resume,
|
2007-03-02 08:31:26 +00:00
|
|
|
#endif
|
2006-08-29 22:12:40 +00:00
|
|
|
};
|
|
|
|
|
2012-04-19 05:43:05 +00:00
|
|
|
module_pci_driver(ns87410_pci_driver);
|
2006-08-29 22:12:40 +00:00
|
|
|
|
|
|
|
MODULE_AUTHOR("Alan Cox");
|
|
|
|
MODULE_DESCRIPTION("low-level driver for Nat Semi 87410");
|
|
|
|
MODULE_LICENSE("GPL");
|
|
|
|
MODULE_DEVICE_TABLE(pci, ns87410);
|
|
|
|
MODULE_VERSION(DRV_VERSION);
|