libata: convert the remaining PATA drivers to new init model
[linux-2.6.git] / drivers / ata / pata_mpiix.c
1 /*
2  * pata_mpiix.c         - Intel MPIIX PATA for new ATA layer
3  *                        (C) 2005-2006 Red Hat Inc
4  *                        Alan Cox <alan@redhat.com>
5  *
6  * The MPIIX is different enough to the PIIX4 and friends that we give it
7  * a separate driver. The old ide/pci code handles this by just not tuning
8  * MPIIX at all.
9  *
10  * The MPIIX also differs in another important way from the majority of PIIX
11  * devices. The chip is a bridge (pardon the pun) between the old world of
12  * ISA IDE and PCI IDE. Although the ATA timings are PCI configured the actual
13  * IDE controller is not decoded in PCI space and the chip does not claim to
14  * be IDE class PCI. This requires slightly non-standard probe logic compared
15  * with PCI IDE and also that we do not disable the device when our driver is
16  * unloaded (as it has many other functions).
17  *
18  * The driver conciously keeps this logic internally to avoid pushing quirky
19  * PATA history into the clean libata layer.
20  *
21  * Thinkpad specific note: If you boot an MPIIX using a thinkpad with a PCMCIA
22  * hard disk present this driver will not detect it. This is not a bug. In this
23  * configuration the secondary port of the MPIIX is disabled and the addresses
24  * are decoded by the PCMCIA bridge and therefore are for a generic IDE driver
25  * to operate.
26  */
27
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/pci.h>
31 #include <linux/init.h>
32 #include <linux/blkdev.h>
33 #include <linux/delay.h>
34 #include <scsi/scsi_host.h>
35 #include <linux/libata.h>
36
37 #define DRV_NAME "pata_mpiix"
38 #define DRV_VERSION "0.7.6"
39
40 enum {
41         IDETIM = 0x6C,          /* IDE control register */
42         IORDY = (1 << 1),
43         PPE = (1 << 2),
44         FTIM = (1 << 0),
45         ENABLED = (1 << 15),
46         SECONDARY = (1 << 14)
47 };
48
49 static int mpiix_pre_reset(struct ata_port *ap)
50 {
51         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
52         static const struct pci_bits mpiix_enable_bits = { 0x6D, 1, 0x80, 0x80 };
53
54         if (!pci_test_config_bits(pdev, &mpiix_enable_bits))
55                 return -ENOENT;
56         return ata_std_prereset(ap);
57 }
58
59 /**
60  *      mpiix_error_handler             -       probe reset
61  *      @ap: ATA port
62  *
63  *      Perform the ATA probe and bus reset sequence plus specific handling
64  *      for this hardware. The MPIIX has the enable bits in a different place
65  *      to PIIX4 and friends. As a pure PIO device it has no cable detect
66  */
67
68 static void mpiix_error_handler(struct ata_port *ap)
69 {
70         ata_bmdma_drive_eh(ap, mpiix_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
71 }
72
73 /**
74  *      mpiix_set_piomode       -       set initial PIO mode data
75  *      @ap: ATA interface
76  *      @adev: ATA device
77  *
78  *      Called to do the PIO mode setup. The MPIIX allows us to program the
79  *      IORDY sample point (2-5 clocks), recovery (1-4 clocks) and whether
80  *      prefetching or IORDY are used.
81  *
82  *      This would get very ugly because we can only program timing for one
83  *      device at a time, the other gets PIO0. Fortunately libata calls
84  *      our qc_issue_prot command before a command is issued so we can
85  *      flip the timings back and forth to reduce the pain.
86  */
87
88 static void mpiix_set_piomode(struct ata_port *ap, struct ata_device *adev)
89 {
90         int control = 0;
91         int pio = adev->pio_mode - XFER_PIO_0;
92         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
93         u16 idetim;
94         static const     /* ISP  RTC */
95         u8 timings[][2] = { { 0, 0 },
96                             { 0, 0 },
97                             { 1, 0 },
98                             { 2, 1 },
99                             { 2, 3 }, };
100
101         pci_read_config_word(pdev, IDETIM, &idetim);
102
103         /* Mask the IORDY/TIME/PPE for this device */
104         if (adev->class == ATA_DEV_ATA)
105                 control |= PPE;         /* Enable prefetch/posting for disk */
106         if (ata_pio_need_iordy(adev))
107                 control |= IORDY;
108         if (pio > 1)
109                 control |= FTIM;        /* This drive is on the fast timing bank */
110
111         /* Mask out timing and clear both TIME bank selects */
112         idetim &= 0xCCEE;
113         idetim &= ~(0x07  << (4 * adev->devno));
114         idetim |= control << (4 * adev->devno);
115
116         idetim |= (timings[pio][0] << 12) | (timings[pio][1] << 8);
117         pci_write_config_word(pdev, IDETIM, idetim);
118
119         /* We use ap->private_data as a pointer to the device currently
120            loaded for timing */
121         ap->private_data = adev;
122 }
123
124 /**
125  *      mpiix_qc_issue_prot     -       command issue
126  *      @qc: command pending
127  *
128  *      Called when the libata layer is about to issue a command. We wrap
129  *      this interface so that we can load the correct ATA timings if
130  *      neccessary. Our logic also clears TIME0/TIME1 for the other device so
131  *      that, even if we get this wrong, cycles to the other device will
132  *      be made PIO0.
133  */
134
135 static unsigned int mpiix_qc_issue_prot(struct ata_queued_cmd *qc)
136 {
137         struct ata_port *ap = qc->ap;
138         struct ata_device *adev = qc->dev;
139
140         /* If modes have been configured and the channel data is not loaded
141            then load it. We have to check if pio_mode is set as the core code
142            does not set adev->pio_mode to XFER_PIO_0 while probing as would be
143            logical */
144
145         if (adev->pio_mode && adev != ap->private_data)
146                 mpiix_set_piomode(ap, adev);
147
148         return ata_qc_issue_prot(qc);
149 }
150
151 static struct scsi_host_template mpiix_sht = {
152         .module                 = THIS_MODULE,
153         .name                   = DRV_NAME,
154         .ioctl                  = ata_scsi_ioctl,
155         .queuecommand           = ata_scsi_queuecmd,
156         .can_queue              = ATA_DEF_QUEUE,
157         .this_id                = ATA_SHT_THIS_ID,
158         .sg_tablesize           = LIBATA_MAX_PRD,
159         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
160         .emulated               = ATA_SHT_EMULATED,
161         .use_clustering         = ATA_SHT_USE_CLUSTERING,
162         .proc_name              = DRV_NAME,
163         .dma_boundary           = ATA_DMA_BOUNDARY,
164         .slave_configure        = ata_scsi_slave_config,
165         .slave_destroy          = ata_scsi_slave_destroy,
166         .bios_param             = ata_std_bios_param,
167 #ifdef CONFIG_PM
168         .resume                 = ata_scsi_device_resume,
169         .suspend                = ata_scsi_device_suspend,
170 #endif
171 };
172
173 static struct ata_port_operations mpiix_port_ops = {
174         .port_disable   = ata_port_disable,
175         .set_piomode    = mpiix_set_piomode,
176
177         .tf_load        = ata_tf_load,
178         .tf_read        = ata_tf_read,
179         .check_status   = ata_check_status,
180         .exec_command   = ata_exec_command,
181         .dev_select     = ata_std_dev_select,
182
183         .freeze         = ata_bmdma_freeze,
184         .thaw           = ata_bmdma_thaw,
185         .error_handler  = mpiix_error_handler,
186         .post_internal_cmd = ata_bmdma_post_internal_cmd,
187         .cable_detect   = ata_cable_40wire,
188
189         .qc_prep        = ata_qc_prep,
190         .qc_issue       = mpiix_qc_issue_prot,
191         .data_xfer      = ata_data_xfer,
192
193         .irq_clear      = ata_bmdma_irq_clear,
194         .irq_on         = ata_irq_on,
195         .irq_ack        = ata_irq_ack,
196
197         .port_start     = ata_port_start,
198 };
199
200 static int mpiix_init_one(struct pci_dev *dev, const struct pci_device_id *id)
201 {
202         /* Single threaded by the PCI probe logic */
203         static int printed_version;
204         struct ata_host *host;
205         struct ata_port *ap;
206         void __iomem *cmd_addr, *ctl_addr;
207         u16 idetim;
208         int irq;
209
210         if (!printed_version++)
211                 dev_printk(KERN_DEBUG, &dev->dev, "version " DRV_VERSION "\n");
212
213         host = ata_host_alloc(&dev->dev, 1);
214         if (!host)
215                 return -ENOMEM;
216
217         /* MPIIX has many functions which can be turned on or off according
218            to other devices present. Make sure IDE is enabled before we try
219            and use it */
220
221         pci_read_config_word(dev, IDETIM, &idetim);
222         if (!(idetim & ENABLED))
223                 return -ENODEV;
224
225         /* See if it's primary or secondary channel... */
226         if (!(idetim & SECONDARY)) {
227                 irq = 14;
228                 cmd_addr = devm_ioport_map(&dev->dev, 0x1F0, 8);
229                 ctl_addr = devm_ioport_map(&dev->dev, 0x3F6, 1);
230         } else {
231                 irq = 15;
232                 cmd_addr = devm_ioport_map(&dev->dev, 0x170, 8);
233                 ctl_addr = devm_ioport_map(&dev->dev, 0x376, 1);
234         }
235
236         if (!cmd_addr || !ctl_addr)
237                 return -ENOMEM;
238
239         /* We do our own plumbing to avoid leaking special cases for whacko
240            ancient hardware into the core code. There are two issues to
241            worry about.  #1 The chip is a bridge so if in legacy mode and
242            without BARs set fools the setup.  #2 If you pci_disable_device
243            the MPIIX your box goes castors up */
244
245         ap = host->ports[0];
246         ap->ops = &mpiix_port_ops;
247         ap->pio_mask = 0x1F;
248         ap->flags |= ATA_FLAG_SLAVE_POSS;
249
250         ap->ioaddr.cmd_addr = cmd_addr;
251         ap->ioaddr.ctl_addr = ctl_addr;
252         ap->ioaddr.altstatus_addr = ctl_addr;
253
254         /* Let libata fill in the port details */
255         ata_std_ports(&ap->ioaddr);
256
257         /* activate host */
258         return ata_host_activate(host, irq, ata_interrupt, IRQF_SHARED,
259                                  &mpiix_sht);
260 }
261
262 static const struct pci_device_id mpiix[] = {
263         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371MX), },
264
265         { },
266 };
267
268 static struct pci_driver mpiix_pci_driver = {
269         .name           = DRV_NAME,
270         .id_table       = mpiix,
271         .probe          = mpiix_init_one,
272         .remove         = ata_pci_remove_one,
273 #ifdef CONFIG_PM
274         .suspend        = ata_pci_device_suspend,
275         .resume         = ata_pci_device_resume,
276 #endif
277 };
278
279 static int __init mpiix_init(void)
280 {
281         return pci_register_driver(&mpiix_pci_driver);
282 }
283
284 static void __exit mpiix_exit(void)
285 {
286         pci_unregister_driver(&mpiix_pci_driver);
287 }
288
289 MODULE_AUTHOR("Alan Cox");
290 MODULE_DESCRIPTION("low-level driver for Intel MPIIX");
291 MODULE_LICENSE("GPL");
292 MODULE_DEVICE_TABLE(pci, mpiix);
293 MODULE_VERSION(DRV_VERSION);
294
295 module_init(mpiix_init);
296 module_exit(mpiix_exit);