// SPDX-License-Identifier: GPL-2.0-only /* * Libata based driver for Apple "macio" family of PATA controllers * * Copyright 2008/2009 Benjamin Herrenschmidt, IBM Corp * <benh@kernel.crashing.org> * * Some bits and pieces from drivers/ide/ppc/pmac.c *
*/
/* 133Mhz cell, found in shasta. * See comments about 100 Mhz Uninorth 2... * Note that PIO_MASK and MDMA_MASK seem to overlap, that's just * weird and I don't now why .. at this stage
*/ #define TR_133_PIOREG_PIO_MASK 0xff000fff #define TR_133_PIOREG_MDMA_MASK 0x00fff800 #define TR_133_UDMAREG_UDMA_MASK 0x0003ffff #define TR_133_UDMAREG_UDMA_EN 0x00000001
/* 100Mhz cell, found in Uninorth 2 and K2. It appears as a pci device * (106b/0033) on uninorth or K2 internal PCI bus and it's clock is * controlled like gem or fw. It appears to be an evolution of keylargo * ATA4 with a timing register extended to 2x32bits registers (one * for PIO & MWDMA and one for UDMA, and a similar DBDMA channel. * It has it's own local feature control register as well. * * After scratching my mind over the timing values, at least for PIO * and MDMA, I think I've figured the format of the timing register, * though I use pre-calculated tables for UDMA as usual...
*/ #define TR_100_PIO_ADDRSETUP_MASK 0xff000000 /* Size of field unknown */ #define TR_100_PIO_ADDRSETUP_SHIFT 24 #define TR_100_MDMA_MASK 0x00fff000 #define TR_100_MDMA_RECOVERY_MASK 0x00fc0000 #define TR_100_MDMA_RECOVERY_SHIFT 18 #define TR_100_MDMA_ACCESS_MASK 0x0003f000 #define TR_100_MDMA_ACCESS_SHIFT 12 #define TR_100_PIO_MASK 0xff000fff #define TR_100_PIO_RECOVERY_MASK 0x00000fc0 #define TR_100_PIO_RECOVERY_SHIFT 6 #define TR_100_PIO_ACCESS_MASK 0x0000003f #define TR_100_PIO_ACCESS_SHIFT 0
/* 66Mhz cell, found in KeyLargo. Can do ultra mode 0 to 2 on * 40 connector cable and to 4 on 80 connector one. * Clock unit is 15ns (66Mhz) * * 3 Values can be programmed: * - Write data setup, which appears to match the cycle time. They * also call it DIOW setup. * - Ready to pause time (from spec) * - Address setup. That one is weird. I don't see where exactly * it fits in UDMA cycles, I got it's name from an obscure piece * of commented out code in Darwin. They leave it to 0, we do as * well, despite a comment that would lead to think it has a * min value of 45ns. * Apple also add 60ns to the write data setup (or cycle time ?) on * reads.
*/ #define TR_66_UDMA_MASK 0xfff00000 #define TR_66_UDMA_EN 0x00100000 /* Enable Ultra mode for DMA */ #define TR_66_PIO_ADDRSETUP_MASK 0xe0000000 /* Address setup */ #define TR_66_PIO_ADDRSETUP_SHIFT 29 #define TR_66_UDMA_RDY2PAUS_MASK 0x1e000000 /* Ready 2 pause time */ #define TR_66_UDMA_RDY2PAUS_SHIFT 25 #define TR_66_UDMA_WRDATASETUP_MASK 0x01e00000 /* Write data setup time */ #define TR_66_UDMA_WRDATASETUP_SHIFT 21 #define TR_66_MDMA_MASK 0x000ffc00 #define TR_66_MDMA_RECOVERY_MASK 0x000f8000 #define TR_66_MDMA_RECOVERY_SHIFT 15 #define TR_66_MDMA_ACCESS_MASK 0x00007c00 #define TR_66_MDMA_ACCESS_SHIFT 10 #define TR_66_PIO_MASK 0xe00003ff #define TR_66_PIO_RECOVERY_MASK 0x000003e0 #define TR_66_PIO_RECOVERY_SHIFT 5 #define TR_66_PIO_ACCESS_MASK 0x0000001f #define TR_66_PIO_ACCESS_SHIFT 0
/* 33Mhz cell, found in OHare, Heathrow (& Paddington) and KeyLargo * Can do pio & mdma modes, clock unit is 30ns (33Mhz) * * The access time and recovery time can be programmed. Some older * Darwin code base limit OHare to 150ns cycle time. I decided to do * the same here fore safety against broken old hardware ;) * The HalfTick bit, when set, adds half a clock (15ns) to the access * time and removes one from recovery. It's not supported on KeyLargo * implementation afaik. The E bit appears to be set for PIO mode 0 and * is used to reach long timings used in this mode.
*/ #define TR_33_MDMA_MASK 0x003ff800 #define TR_33_MDMA_RECOVERY_MASK 0x001f0000 #define TR_33_MDMA_RECOVERY_SHIFT 16 #define TR_33_MDMA_ACCESS_MASK 0x0000f800 #define TR_33_MDMA_ACCESS_SHIFT 11 #define TR_33_MDMA_HALFTICK 0x00200000 #define TR_33_PIO_MASK 0x000007ff #define TR_33_PIO_E 0x00000400 #define TR_33_PIO_RECOVERY_MASK 0x000003e0 #define TR_33_PIO_RECOVERY_SHIFT 5 #define TR_33_PIO_ACCESS_MASK 0x0000001f #define TR_33_PIO_ACCESS_SHIFT 0
/* * Interrupt register definitions. Only present on newer cells * (Keylargo and later afaik) so we don't use it.
*/ #define IDE_INTR_DMA 0x80000000 #define IDE_INTR_DEVICE 0x40000000
/* * FCR Register on Kauai. Not sure what bit 0x4 is ...
*/ #define KAUAI_FCR_UATA_MAGIC 0x00000004 #define KAUAI_FCR_UATA_RESET_N 0x00000002 #define KAUAI_FCR_UATA_ENABLE 0x00000001
/* Allow up to 256 DBDMA commands per xfer */ #define MAX_DCMDS 256
/* Don't let a DMA segment go all the way to 64K */ #define MAX_DBDMA_SEG 0xff00
#ifdef CONFIG_PAGE_SIZE_64KB /* * The SCSI core requires the segment size to cover at least a page, so * for 64K page size kernels it must be at least 64K. However the * hardware can't handle 64K, so pata_macio_qc_prep() will split large * requests. To handle the split requests the tablesize must be halved.
*/ #define PATA_MACIO_MAX_SEGMENT_SIZE SZ_64K #define PATA_MACIO_SG_TABLESIZE (MAX_DCMDS / 2) #else #define PATA_MACIO_MAX_SEGMENT_SIZE MAX_DBDMA_SEG #define PATA_MACIO_SG_TABLESIZE MAX_DCMDS #endif
/* * Wait 1s for disk to answer on IDE bus after a hard reset * of the device (via GPIO/FCR). * * Some devices seem to "pollute" the bus even after dropping * the BSY bit (typically some combo drives slave on the UDMA * bus) after a hard reset. Since we hard reset all drives on * KeyLargo ATA66, we have to keep that delay around. I may end * up not hard resetting anymore on these and keep the delay only * for older interfaces instead (we have to reset when coming * from MacOS...) --BenH.
*/ #define IDE_WAKEUP_DELAY_MS 1000
/* Previous variants of this driver used to calculate timings * for various variants of the chip and use tables for others. * * Not only was this confusing, but in addition, it isn't clear * whether our calculation code was correct. It didn't entirely * match the darwin code and whatever documentation I could find * on these cells * * I decided to entirely rely on a table instead for this version * of the driver. Also, because I don't really care about derated * modes and really old HW other than making it work, I'm not going * to calculate / snoop timing values for something else than the * standard modes.
*/ struct pata_macio_timing { int mode;
u32 reg1; /* Bits to set in first timing reg */
u32 reg2; /* Bits to set in second timing reg */
};
/* First clear timings */
priv->treg[adev->devno][0] = priv->treg[adev->devno][1] = 0;
/* Now get the PIO timings */
t = pata_macio_find_timing(priv, adev->pio_mode); if (t == NULL) {
dev_warn(priv->dev, "Invalid PIO timing requested: 0x%x\n",
adev->pio_mode);
t = pata_macio_find_timing(priv, XFER_PIO_0);
}
BUG_ON(t == NULL);
/* PIO timings only ever use the first treg */
priv->treg[adev->devno][0] |= t->reg1;
/* Now get DMA timings */
t = pata_macio_find_timing(priv, adev->dma_mode); if (t == NULL || (t->reg1 == 0 && t->reg2 == 0)) {
dev_dbg(priv->dev, "DMA timing not set yet, using MW_DMA_0\n");
t = pata_macio_find_timing(priv, XFER_MW_DMA_0);
}
BUG_ON(t == NULL);
/* DMA timings can use both tregs */
priv->treg[adev->devno][0] |= t->reg1;
priv->treg[adev->devno][1] |= t->reg2;
/* Apply to hardware */
pata_macio_apply_timings(ap, adev->devno);
}
/* * Blast some well known "safe" values to the timing registers at init or * wakeup from sleep time, before we do real calculation
*/ staticvoid pata_macio_default_timings(struct pata_macio_priv *priv)
{ unsignedint value, value2 = 0;
switch(priv->kind) { case controller_sh_ata6:
value = 0x0a820c97;
value2 = 0x00033031; break; case controller_un_ata6: case controller_k2_ata6:
value = 0x08618a92;
value2 = 0x00002921; break; case controller_kl_ata4:
value = 0x0008438c; break; case controller_kl_ata3:
value = 0x00084526; break; case controller_heathrow: case controller_ohare: default:
value = 0x00074526; break;
}
priv->treg[0][0] = priv->treg[1][0] = value;
priv->treg[0][1] = priv->treg[1][1] = value2;
}
if (cable && !strncmp(cable, "80-", 3)) { /* Some drives fail to detect 80c cable in PowerBook * These machine use proprietary short IDE cable * anyway
*/ if (!strncmp(model, "PowerBook", 9)) return ATA_CBL_PATA40_SHORT; else return ATA_CBL_PATA80;
}
}
/* G5's seem to have incorrect cable type in device-tree. * Let's assume they always have a 80 conductor cable, this seem to * be always the case unless the user mucked around
*/ if (of_device_is_compatible(priv->node, "K2-UATA") ||
of_device_is_compatible(priv->node, "shasta-ata")) return ATA_CBL_PATA80;
/* Anything else is 40 connectors */ return ATA_CBL_PATA40;
}
/* Make sure DMA commands updates are visible */
writel(priv->dma_table_dma, &dma_regs->cmdptr);
/* On KeyLargo 66Mhz cell, we need to add 60ns to wrDataSetup on * UDMA reads
*/ if (priv->kind == controller_kl_ata4 &&
(priv->treg[dev][0] & TR_66_UDMA_EN)) { void __iomem *rbase = ap->ioaddr.cmd_addr;
u32 reg = priv->treg[dev][0];
/* Stop the DMA engine and wait for it to full halt */
writel (((RUN|WAKE|DEAD) << 16), &dma_regs->control); while (--timeout && (readl(&dma_regs->status) & RUN))
udelay(1);
}
/* We have two things to deal with here: * * - The dbdma won't stop if the command was started * but completed with an error without transferring all * datas. This happens when bad blocks are met during * a multi-block transfer. * * - The dbdma fifo hasn't yet finished flushing to * system memory when the disk interrupt occurs.
*/
/* First check for errors */ if ((dstat & (RUN|DEAD)) != RUN)
rstat |= ATA_DMA_ERR;
/* If ACTIVE is cleared, the STOP command has been hit and * the transfer is complete. If not, we have to flush the * channel.
*/ if ((dstat & ACTIVE) == 0) return rstat;
dev_dbgdma(priv->dev, "%s: DMA still active, flushing...\n", __func__);
/* If dbdma didn't execute the STOP command yet, the * active bit is still set. We consider that we aren't * sharing interrupts (which is hopefully the case with * those controllers) and so we just try to flush the * channel for pending data in the fifo
*/
udelay(1);
writel((FLUSH << 16) | FLUSH, &dma_regs->control); for (;;) {
udelay(1);
dstat = readl(&dma_regs->status); if ((dstat & FLUSH) == 0) break; if (++timeout > 1000) {
dev_warn(priv->dev, "timeout flushing DMA\n");
rstat |= ATA_DMA_ERR; break;
}
} return rstat;
}
/* port_start is when we allocate the DMA command list */ staticint pata_macio_port_start(struct ata_port *ap)
{ struct pata_macio_priv *priv = ap->private_data;
if (ap->ioaddr.bmdma_addr == NULL) return 0;
/* Allocate space for the DBDMA commands. * * The +2 is +1 for the stop command and +1 to allow for * aligning the start address to a multiple of 16 bytes.
*/
priv->dma_table_cpu =
dmam_alloc_coherent(priv->dev,
(MAX_DCMDS + 2) * sizeof(struct dbdma_cmd),
&priv->dma_table_dma, GFP_KERNEL); if (priv->dma_table_cpu == NULL) {
dev_err(priv->dev, "Unable to allocate DMA command list\n");
ap->ioaddr.bmdma_addr = NULL;
ap->mwdma_mask = 0;
ap->udma_mask = 0;
} return 0;
}
if (priv->kind == controller_ohare && !resume) { /* The code below is having trouble on some ohare machines * (timing related ?). Until I can put my hand on one of these * units, I keep the old way
*/
ppc_md.feature_call(PMAC_FTR_IDE_ENABLE, priv->node, 0, 1);
} else { int rc;
/* Reset and enable controller */
rc = ppc_md.feature_call(PMAC_FTR_IDE_RESET,
priv->node, priv->aapl_bus_id, 1);
ppc_md.feature_call(PMAC_FTR_IDE_ENABLE,
priv->node, priv->aapl_bus_id, 1);
msleep(10); /* Only bother waiting if there's a reset control */ if (rc == 0) {
ppc_md.feature_call(PMAC_FTR_IDE_RESET,
priv->node, priv->aapl_bus_id, 0);
msleep(IDE_WAKEUP_DELAY_MS);
}
}
/* If resuming a PCI device, restore the config space here */ if (priv->pdev && resume) { int rc;
pci_restore_state(priv->pdev);
rc = pcim_enable_device(priv->pdev); if (rc)
dev_err(&priv->pdev->dev, "Failed to enable device after resume (%d)\n",
rc); else
pci_set_master(priv->pdev);
}
/* On Kauai, initialize the FCR. We don't perform a reset, doesn't really * seem necessary and speeds up the boot process
*/ if (priv->kauai_fcr)
writel(KAUAI_FCR_UATA_MAGIC |
KAUAI_FCR_UATA_RESET_N |
KAUAI_FCR_UATA_ENABLE, priv->kauai_fcr);
}
/* Hook the standard slave config to fixup some HW related alignment * restrictions
*/ staticint pata_macio_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim)
{ struct ata_port *ap = ata_shost_to_port(sdev->host); struct pata_macio_priv *priv = ap->private_data; struct ata_device *dev;
u16 cmd; int rc;
/* First call original */
rc = ata_scsi_sdev_configure(sdev, lim); if (rc) return rc;
/* This is lifted from sata_nv */
dev = &ap->link.device[sdev->id];
/* OHare has issues with non cache aligned DMA on some chipsets */ if (priv->kind == controller_ohare) {
lim->dma_alignment = 31;
lim->dma_pad_mask = 31;
/* Tell the world about it */
ata_dev_info(dev, "OHare alignment limits applied\n"); return 0;
}
/* We only have issues with ATAPI */ if (dev->class != ATA_DEV_ATAPI) return 0;
/* Shasta and K2 seem to have "issues" with reads ... */ if (priv->kind == controller_sh_ata6 || priv->kind == controller_k2_ata6) { /* Allright these are bad, apply restrictions */
lim->dma_alignment = 15;
lim->dma_pad_mask = 15;
/* We enable MWI and hack cache line size directly here, this * is specific to this chipset and not normal values, we happen * to somewhat know what we are doing here (which is basically * to do the same Apple does and pray they did not get it wrong :-)
*/
BUG_ON(!priv->pdev);
pci_write_config_byte(priv->pdev, PCI_CACHE_LINE_SIZE, 0x08);
pci_read_config_word(priv->pdev, PCI_COMMAND, &cmd);
pci_write_config_word(priv->pdev, PCI_COMMAND,
cmd | PCI_COMMAND_INVALIDATE);
/* Tell the world about it */
ata_dev_info(dev, "K2/Shasta alignment limits applied\n");
}
return 0;
}
#ifdef CONFIG_PM_SLEEP staticint pata_macio_do_suspend(struct pata_macio_priv *priv, pm_message_t mesg)
{ /* First, core libata suspend to do most of the work */
ata_host_suspend(priv->host, mesg);
/* Restore to default timings */
pata_macio_default_timings(priv);
/* Mask interrupt. Not strictly necessary but old driver did
* it and I'd rather not change that here */
disable_irq(priv->irq);
/* The media bay will handle itself just fine */ if (priv->mediabay) return 0;
/* Kauai has bus control FCRs directly here */ if (priv->kauai_fcr) {
u32 fcr = readl(priv->kauai_fcr);
fcr &= ~(KAUAI_FCR_UATA_RESET_N | KAUAI_FCR_UATA_ENABLE);
writel(fcr, priv->kauai_fcr);
}
/* For PCI, save state and disable DMA. No need to call * pci_set_power_state(), the HW doesn't do D states that * way, the platform code will take care of suspending the * ASIC properly
*/ if (priv->pdev) {
pci_save_state(priv->pdev);
pci_disable_device(priv->pdev);
}
/* Disable the bus on older machines and the cell on kauai */
ppc_md.feature_call(PMAC_FTR_IDE_ENABLE, priv->node,
priv->aapl_bus_id, 0);
return 0;
}
staticint pata_macio_do_resume(struct pata_macio_priv *priv)
{ /* Reset and re-enable the HW */
pata_macio_reset_hw(priv, 1);
/* Get Apple bus ID (for clock and ASIC control) */
bidp = of_get_property(priv->node, "AAPL,bus-id", NULL);
priv->aapl_bus_id = bidp ? *bidp : 0;
/* Fixup missing Apple bus ID in case of media-bay */ if (priv->mediabay && !bidp)
priv->aapl_bus_id = 1;
}
staticvoid pata_macio_setup_ios(struct ata_ioports *ioaddr, void __iomem * base, void __iomem * dma)
{ /* cmd_addr is the base of regs for that port */
ioaddr->cmd_addr = base;
/* taskfile registers */
ioaddr->data_addr = base + (ATA_REG_DATA << 4);
ioaddr->error_addr = base + (ATA_REG_ERR << 4);
ioaddr->feature_addr = base + (ATA_REG_FEATURE << 4);
ioaddr->nsect_addr = base + (ATA_REG_NSECT << 4);
ioaddr->lbal_addr = base + (ATA_REG_LBAL << 4);
ioaddr->lbam_addr = base + (ATA_REG_LBAM << 4);
ioaddr->lbah_addr = base + (ATA_REG_LBAH << 4);
ioaddr->device_addr = base + (ATA_REG_DEVICE << 4);
ioaddr->status_addr = base + (ATA_REG_STATUS << 4);
ioaddr->command_addr = base + (ATA_REG_CMD << 4);
ioaddr->altstatus_addr = base + 0x160;
ioaddr->ctl_addr = base + 0x160;
ioaddr->bmdma_addr = dma;
}
staticvoid pmac_macio_calc_timing_masks(struct pata_macio_priv *priv, struct ata_port_info *pinfo)
{ int i = 0;
priv->host = ata_host_alloc_pinfo(priv->dev, ppi, 1); if (priv->host == NULL) {
dev_err(priv->dev, "Failed to allocate ATA port structure\n"); return -ENOMEM;
}
/* Setup the private data in host too */
priv->host->private_data = priv;
/* Map base registers */
priv->tfregs = devm_ioremap(priv->dev, tfregs, 0x100); if (priv->tfregs == NULL) {
dev_err(priv->dev, "Failed to map ATA ports\n"); return -ENOMEM;
}
priv->host->iomap = &priv->tfregs;
/* Map DMA regs */ if (dmaregs != 0) {
dma_regs = devm_ioremap(priv->dev, dmaregs, sizeof(struct dbdma_regs)); if (dma_regs == NULL)
dev_warn(priv->dev, "Failed to map ATA DMA registers\n");
}
/* If chip has local feature control, map those regs too */ if (fcregs != 0) {
priv->kauai_fcr = devm_ioremap(priv->dev, fcregs, 4); if (priv->kauai_fcr == NULL) {
dev_err(priv->dev, "Failed to map ATA FCR register\n"); return -ENOMEM;
}
}
/* Setup port data structure */
pata_macio_setup_ios(&priv->host->ports[0]->ioaddr,
priv->tfregs, dma_regs);
priv->host->ports[0]->private_data = priv;
/* hard-reset the controller */
pata_macio_reset_hw(priv, 0);
pata_macio_apply_timings(priv->host->ports[0], 0);
/* Enable bus master if necessary */ if (priv->pdev && dma_regs)
pci_set_master(priv->pdev);
dev_info(priv->dev, "Activating pata-macio chipset %s, Apple bus ID %d\n",
macio_ata_names[priv->kind], priv->aapl_bus_id);
/* Start it up */
priv->irq = irq; return ata_host_activate(priv->host, irq, ata_bmdma_interrupt, 0,
&pata_macio_sht);
}
/* Check for broken device-trees */ if (macio_resource_count(mdev) == 0) {
dev_err(&mdev->ofdev.dev, "No addresses for controller\n"); return -ENXIO;
}
/* Request resources for DMA registers if any */ if (macio_resource_count(mdev) >= 2) { if (macio_request_resource(mdev, 1, "pata-macio-dma"))
dev_err(&mdev->ofdev.dev, "Cannot obtain DMA resource\n"); else
dmaregs = macio_resource_start(mdev, 1);
}
/* * Fixup missing IRQ for some old implementations with broken * device-trees. * * This is a bit bogus, it should be fixed in the device-tree itself, * via the existing macio fixups, based on the type of interrupt * controller in the machine. However, I have no test HW for this case, * and this trick works well enough on those old machines...
*/ if (macio_irq_count(mdev) == 0) {
dev_warn(&mdev->ofdev.dev, "No interrupts for controller, using 13\n");
irq = irq_create_mapping(NULL, 13);
} else
irq = macio_irq(mdev, 0);
/* Prevvent media bay callbacks until fully registered */
lock_media_bay(priv->mdev->media_bay);
/* Get register addresses and call common initialization */
rc = pata_macio_common_init(priv,
tfregs, /* Taskfile regs */
dmaregs, /* DBDMA regs */
0, /* Feature control */
irq);
unlock_media_bay(priv->mdev->media_bay);
/* We cannot use a MacIO controller without its OF device node */
np = pci_device_to_OF_node(pdev); if (np == NULL) {
dev_err(&pdev->dev, "Cannot find OF device node for controller\n"); return -ENODEV;
}
/* Check that it can be enabled */ if (pcim_enable_device(pdev)) {
dev_err(&pdev->dev, "Cannot enable controller PCI device\n"); return -ENXIO;
}
/* Allocate and init private data structure */
priv = devm_kzalloc(&pdev->dev, sizeof(struct pata_macio_priv), GFP_KERNEL); if (!priv) return -ENOMEM;
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.