kerneldoc fix in libata
[linux-2.6] / drivers / ata / pata_rz1000.c
1 /*
2  *  RZ1000/1001 driver based upon
3  *
4  *  linux/drivers/ide/pci/rz1000.c      Version 0.06    January 12, 2003
5  *  Copyright (C) 1995-1998  Linus Torvalds & author (see below)
6  *  Principal Author:  mlord@pobox.com (Mark Lord)
7  *
8  *  See linux/MAINTAINERS for address of current maintainer.
9  *
10  *  This file provides support for disabling the buggy read-ahead
11  *  mode of the RZ1000 IDE chipset, commonly used on Intel motherboards.
12  */
13
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/pci.h>
17 #include <linux/init.h>
18 #include <linux/blkdev.h>
19 #include <linux/delay.h>
20 #include <scsi/scsi_host.h>
21 #include <linux/libata.h>
22
23 #define DRV_NAME        "pata_rz1000"
24 #define DRV_VERSION     "0.2.4"
25
26
27 /**
28  *      rz1000_set_mode         -       mode setting function
29  *      @ap: ATA interface
30  *      @unused: returned device on set_mode failure
31  *
32  *      Use a non standard set_mode function. We don't want to be tuned. We
33  *      would prefer to be BIOS generic but for the fact our hardware is
34  *      whacked out.
35  */
36
37 static int rz1000_set_mode(struct ata_port *ap, struct ata_device **unused)
38 {
39         int i;
40
41         for (i = 0; i < ATA_MAX_DEVICES; i++) {
42                 struct ata_device *dev = &ap->device[i];
43                 if (ata_dev_enabled(dev)) {
44                         /* We don't really care */
45                         dev->pio_mode = XFER_PIO_0;
46                         dev->xfer_mode = XFER_PIO_0;
47                         dev->xfer_shift = ATA_SHIFT_PIO;
48                         dev->flags |= ATA_DFLAG_PIO;
49                         ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
50                 }
51         }
52         return 0;
53 }
54
55
56 static struct scsi_host_template rz1000_sht = {
57         .module                 = THIS_MODULE,
58         .name                   = DRV_NAME,
59         .ioctl                  = ata_scsi_ioctl,
60         .queuecommand           = ata_scsi_queuecmd,
61         .can_queue              = ATA_DEF_QUEUE,
62         .this_id                = ATA_SHT_THIS_ID,
63         .sg_tablesize           = LIBATA_MAX_PRD,
64         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
65         .emulated               = ATA_SHT_EMULATED,
66         .use_clustering         = ATA_SHT_USE_CLUSTERING,
67         .proc_name              = DRV_NAME,
68         .dma_boundary           = ATA_DMA_BOUNDARY,
69         .slave_configure        = ata_scsi_slave_config,
70         .slave_destroy          = ata_scsi_slave_destroy,
71         .bios_param             = ata_std_bios_param,
72 };
73
74 static struct ata_port_operations rz1000_port_ops = {
75         .set_mode       = rz1000_set_mode,
76
77         .port_disable   = ata_port_disable,
78         .tf_load        = ata_tf_load,
79         .tf_read        = ata_tf_read,
80         .check_status   = ata_check_status,
81         .exec_command   = ata_exec_command,
82         .dev_select     = ata_std_dev_select,
83
84         .bmdma_setup    = ata_bmdma_setup,
85         .bmdma_start    = ata_bmdma_start,
86         .bmdma_stop     = ata_bmdma_stop,
87         .bmdma_status   = ata_bmdma_status,
88
89         .qc_prep        = ata_qc_prep,
90         .qc_issue       = ata_qc_issue_prot,
91
92         .data_xfer      = ata_data_xfer,
93
94         .freeze         = ata_bmdma_freeze,
95         .thaw           = ata_bmdma_thaw,
96         .error_handler  = ata_bmdma_error_handler,
97         .post_internal_cmd = ata_bmdma_post_internal_cmd,
98         .cable_detect   = ata_cable_40wire,
99
100         .irq_handler    = ata_interrupt,
101         .irq_clear      = ata_bmdma_irq_clear,
102         .irq_on         = ata_irq_on,
103         .irq_ack        = ata_irq_ack,
104
105         .port_start     = ata_port_start,
106 };
107
108 static int rz1000_fifo_disable(struct pci_dev *pdev)
109 {
110         u16 reg;
111         /* Be exceptionally paranoid as we must be sure to apply the fix */
112         if (pci_read_config_word(pdev, 0x40, &reg) != 0)
113                 return -1;
114         reg &= 0xDFFF;
115         if (pci_write_config_word(pdev, 0x40, reg) != 0)
116                 return -1;
117         printk(KERN_INFO DRV_NAME ": disabled chipset readahead.\n");
118         return 0;
119 }
120
121 /**
122  *      rz1000_init_one - Register RZ1000 ATA PCI device with kernel services
123  *      @pdev: PCI device to register
124  *      @ent: Entry in rz1000_pci_tbl matching with @pdev
125  *
126  *      Configure an RZ1000 interface. This doesn't require much special
127  *      handling except that we *MUST* kill the chipset readahead or the
128  *      user may experience data corruption.
129  */
130
131 static int rz1000_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
132 {
133         static int printed_version;
134         static const struct ata_port_info info = {
135                 .sht = &rz1000_sht,
136                 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
137                 .pio_mask = 0x1f,
138                 .port_ops = &rz1000_port_ops
139         };
140         const struct ata_port_info *ppi[] = { &info, NULL };
141
142         if (!printed_version++)
143                 printk(KERN_DEBUG DRV_NAME " version " DRV_VERSION "\n");
144
145         if (rz1000_fifo_disable(pdev) == 0)
146                 return ata_pci_init_one(pdev, ppi);
147
148         printk(KERN_ERR DRV_NAME ": failed to disable read-ahead on chipset..\n");
149         /* Not safe to use so skip */
150         return -ENODEV;
151 }
152
153 #ifdef CONFIG_PM
154 static int rz1000_reinit_one(struct pci_dev *pdev)
155 {
156         /* If this fails on resume (which is a "cant happen" case), we
157            must stop as any progress risks data loss */
158         if (rz1000_fifo_disable(pdev))
159                 panic("rz1000 fifo");
160         return ata_pci_device_resume(pdev);
161 }
162 #endif
163
164 static const struct pci_device_id pata_rz1000[] = {
165         { PCI_VDEVICE(PCTECH, PCI_DEVICE_ID_PCTECH_RZ1000), },
166         { PCI_VDEVICE(PCTECH, PCI_DEVICE_ID_PCTECH_RZ1001), },
167
168         { },
169 };
170
171 static struct pci_driver rz1000_pci_driver = {
172         .name           = DRV_NAME,
173         .id_table       = pata_rz1000,
174         .probe          = rz1000_init_one,
175         .remove         = ata_pci_remove_one,
176 #ifdef CONFIG_PM
177         .suspend        = ata_pci_device_suspend,
178         .resume         = rz1000_reinit_one,
179 #endif
180 };
181
182 static int __init rz1000_init(void)
183 {
184         return pci_register_driver(&rz1000_pci_driver);
185 }
186
187 static void __exit rz1000_exit(void)
188 {
189         pci_unregister_driver(&rz1000_pci_driver);
190 }
191
192 MODULE_AUTHOR("Alan Cox");
193 MODULE_DESCRIPTION("low-level driver for RZ1000 PCI ATA");
194 MODULE_LICENSE("GPL");
195 MODULE_DEVICE_TABLE(pci, pata_rz1000);
196 MODULE_VERSION(DRV_VERSION);
197
198 module_init(rz1000_init);
199 module_exit(rz1000_exit);
200