2006-08-30 02:12:40 +04:00
/*
* pata_triflex . c - Compaq PATA for new ATA layer
* ( C ) 2005 Red Hat Inc
2008-10-27 18:09:10 +03:00
* Alan Cox < alan @ lxorguk . ukuu . org . uk >
2006-08-30 02:12:40 +04:00
*
* based upon
*
* triflex . c
*
* IDE Chipset driver for the Compaq TriFlex IDE controller .
*
* Known to work with the Compaq Workstation 5 x00 series .
*
* Copyright ( C ) 2002 Hewlett - Packard Development Group , L . P .
* Author : Torben Mathiasen < torben . mathiasen @ hp . com >
*
* This program is free software ; you can redistribute it and / or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License
* along with this program ; if not , write to the Free Software
* Foundation , Inc . , 59 Temple Place , Suite 330 , Boston , MA 02111 - 1307 USA
*
* Loosely based on the piix & svwks drivers .
*
* Documentation :
2011-03-31 05:57:33 +04:00
* Not publicly available .
2006-08-30 02:12:40 +04:00
*/
# 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_triflex"
2007-03-09 15:24:15 +03:00
# define DRV_VERSION "0.2.8"
2006-08-30 02:12:40 +04:00
/**
2006-09-26 20:53:38 +04:00
* triflex_prereset - probe begin
2007-08-06 13:36:23 +04: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 10:50:52 +03:00
* @ deadline : deadline jiffies for the operation
2006-08-30 02:12:40 +04:00
*
* Set up cable type and use generic probe init
*/
2007-08-06 13:36:23 +04:00
static int triflex_prereset ( struct ata_link * link , unsigned long deadline )
2006-08-30 02:12:40 +04:00
{
static const struct pci_bits triflex_enable_bits [ ] = {
{ 0x80 , 1 , 0x01 , 0x01 } ,
{ 0x80 , 1 , 0x02 , 0x02 }
} ;
2007-08-06 13:36:23 +04:00
struct ata_port * ap = link - > ap ;
2006-08-30 02:12:40 +04:00
struct pci_dev * pdev = to_pci_dev ( ap - > host - > dev ) ;
2006-08-31 08:03:49 +04:00
2006-09-26 20:53:38 +04:00
if ( ! pci_test_config_bits ( pdev , & triflex_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 10:50:52 +03:00
2008-04-07 17:47:16 +04:00
return ata_sff_prereset ( link , deadline ) ;
2006-08-30 02:12:40 +04:00
}
/**
* triflex_load_timing - timing configuration
* @ ap : ATA interface
* @ adev : Device on the bus
* @ speed : speed to configure
*
* The Triflex has one set of timings per device per channel . This
* means we must do some switching . As the PIO and DMA timings don ' t
* match we have to do some reloading unlike PIIX devices where tuning
* tricks can avoid it .
*/
static void triflex_load_timing ( struct ata_port * ap , struct ata_device * adev , int speed )
{
struct pci_dev * pdev = to_pci_dev ( ap - > host - > dev ) ;
u32 timing = 0 ;
u32 triflex_timing , old_triflex_timing ;
int channel_offset = ap - > port_no ? 0x74 : 0x70 ;
unsigned int is_slave = ( adev - > devno ! = 0 ) ;
pci_read_config_dword ( pdev , channel_offset , & old_triflex_timing ) ;
triflex_timing = old_triflex_timing ;
switch ( speed )
{
case XFER_MW_DMA_2 :
timing = 0x0103 ; break ;
case XFER_MW_DMA_1 :
timing = 0x0203 ; break ;
case XFER_MW_DMA_0 :
timing = 0x0808 ; break ;
case XFER_SW_DMA_2 :
case XFER_SW_DMA_1 :
case XFER_SW_DMA_0 :
timing = 0x0F0F ; break ;
case XFER_PIO_4 :
timing = 0x0202 ; break ;
case XFER_PIO_3 :
timing = 0x0204 ; break ;
case XFER_PIO_2 :
timing = 0x0404 ; break ;
case XFER_PIO_1 :
timing = 0x0508 ; break ;
case XFER_PIO_0 :
timing = 0x0808 ; break ;
default :
BUG ( ) ;
}
triflex_timing & = ~ ( 0xFFFF < < ( 16 * is_slave ) ) ;
triflex_timing | = ( timing < < ( 16 * is_slave ) ) ;
if ( triflex_timing ! = old_triflex_timing )
pci_write_config_dword ( pdev , channel_offset , triflex_timing ) ;
}
/**
* triflex_set_piomode - set initial PIO mode data
* @ ap : ATA interface
* @ adev : ATA device
*
* Use the timing loader to set up the PIO mode . We have to do this
* because DMA start / stop will only be called once DMA occurs . If there
* has been no DMA then the PIO timings are still needed .
*/
static void triflex_set_piomode ( struct ata_port * ap , struct ata_device * adev )
{
triflex_load_timing ( ap , adev , adev - > pio_mode ) ;
}
/**
* triflex_dma_start - DMA start callback
* @ qc : Command in progress
*
* Usually drivers set the DMA timing at the point the set_dmamode call
* is made . Triflex however requires we load new timings on the
* transition or keep matching PIO / DMA pairs ( ie MWDMA2 / PIO4 etc ) .
* We load the DMA timings just before starting DMA and then restore
* the PIO timing when the DMA is finished .
*/
static void triflex_bmdma_start ( struct ata_queued_cmd * qc )
{
triflex_load_timing ( qc - > ap , qc - > dev , qc - > dev - > dma_mode ) ;
ata_bmdma_start ( qc ) ;
}
/**
* triflex_dma_stop - DMA stop callback
* @ ap : ATA interface
* @ adev : ATA device
*
* We loaded new timings in dma_start , as a result we need to restore
* the PIO timings in dma_stop so that the next command issue gets the
* right clock values .
*/
static void triflex_bmdma_stop ( struct ata_queued_cmd * qc )
{
ata_bmdma_stop ( qc ) ;
triflex_load_timing ( qc - > ap , qc - > dev , qc - > dev - > pio_mode ) ;
}
static struct scsi_host_template triflex_sht = {
2008-03-25 06:22:49 +03:00
ATA_BMDMA_SHT ( DRV_NAME ) ,
2006-08-30 02:12:40 +04:00
} ;
static struct ata_port_operations triflex_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 06:22:49 +03:00
. inherits = & ata_bmdma_port_ops ,
2006-08-30 02:12:40 +04:00
. bmdma_start = triflex_bmdma_start ,
. bmdma_stop = triflex_bmdma_stop ,
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 06:22:49 +03:00
. cable_detect = ata_cable_40wire ,
. set_piomode = triflex_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 06:22:50 +03:00
. prereset = triflex_prereset ,
2006-08-30 02:12:40 +04:00
} ;
static int triflex_init_one ( struct pci_dev * dev , const struct pci_device_id * id )
{
2007-05-04 14:43:58 +04:00
static const struct ata_port_info info = {
2007-05-28 14:59:48 +04:00
. flags = ATA_FLAG_SLAVE_POSS ,
2009-03-14 23:38:24 +03:00
. pio_mask = ATA_PIO4 ,
. mwdma_mask = ATA_MWDMA2 ,
2006-08-30 02:12:40 +04:00
. port_ops = & triflex_port_ops
} ;
2007-05-04 14:43:58 +04:00
const struct ata_port_info * ppi [ ] = { & info , NULL } ;
2006-08-30 02:12:40 +04:00
2011-04-16 02:52:00 +04:00
ata_print_version_once ( & dev - > dev , DRV_VERSION ) ;
2006-08-30 02:12:40 +04:00
2010-05-20 00:10:22 +04:00
return ata_pci_bmdma_init_one ( dev , ppi , & triflex_sht , NULL , 0 ) ;
2006-08-30 02:12:40 +04:00
}
static const struct pci_device_id triflex [ ] = {
2006-09-29 04:21:59 +04:00
{ PCI_VDEVICE ( COMPAQ , PCI_DEVICE_ID_COMPAQ_TRIFLEX_IDE ) , } ,
{ } ,
2006-08-30 02:12:40 +04:00
} ;
2014-05-07 19:17:44 +04:00
# ifdef CONFIG_PM_SLEEP
2011-05-16 00:33:19 +04:00
static int triflex_ata_pci_device_suspend ( struct pci_dev * pdev , pm_message_t mesg )
{
2013-06-03 09:05:36 +04:00
struct ata_host * host = pci_get_drvdata ( pdev ) ;
2011-05-16 00:33:19 +04:00
int rc = 0 ;
rc = ata_host_suspend ( host , mesg ) ;
if ( rc )
return rc ;
/*
* We must not disable or powerdown the device .
* APM bios refuses to suspend if IDE is not accessible .
*/
pci_save_state ( pdev ) ;
return 0 ;
}
# endif
2006-08-30 02:12:40 +04:00
static struct pci_driver triflex_pci_driver = {
2006-09-29 04:21:59 +04:00
. name = DRV_NAME ,
2006-08-30 02:12:40 +04:00
. id_table = triflex ,
. probe = triflex_init_one ,
2006-11-22 19:57:36 +03:00
. remove = ata_pci_remove_one ,
2014-05-07 19:17:44 +04:00
# ifdef CONFIG_PM_SLEEP
2011-05-16 00:33:19 +04:00
. suspend = triflex_ata_pci_device_suspend ,
2006-11-22 19:57:36 +03:00
. resume = ata_pci_device_resume ,
2007-03-02 11:31:26 +03:00
# endif
2006-08-30 02:12:40 +04:00
} ;
2012-04-19 09:43:05 +04:00
module_pci_driver ( triflex_pci_driver ) ;
2006-08-30 02:12:40 +04:00
MODULE_AUTHOR ( " Alan Cox " ) ;
MODULE_DESCRIPTION ( " low-level driver for Compaq Triflex " ) ;
MODULE_LICENSE ( " GPL " ) ;
MODULE_DEVICE_TABLE ( pci , triflex ) ;
MODULE_VERSION ( DRV_VERSION ) ;