// SPDX-License-Identifier: GPL-2.0-only
/*
 *      Marvell PATA driver.
 *
 *      For the moment we drive the PATA port in legacy mode. That
 *      isn't making full use of the device functionality but it is
 *      easy to get working.
 *
 *      (c) 2006 Red Hat
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <scsi/scsi_host.h>
#include <linux/libata.h>
#include <linux/ata.h>

#define DRV_NAME        "pata_marvell"
#define DRV_VERSION     "0.1.6"

/**
 *      marvell_pata_active     -       check if PATA is active
 *      @pdev: PCI device
 *
 *      Returns 1 if the PATA port may be active. We know how to check this
 *      for the 6145 but not the other devices
 */

static int marvell_pata_active(struct pci_dev *pdev)
{
        u32 devices;
        void __iomem *barp;

        /* We don't yet know how to do this for other devices */
        if (pdev->device != 0x6145)
                return 1;

        barp = pci_iomap(pdev, 5, 0x10);
        if (barp == NULL)
                return -ENOMEM;

        devices = ioread32(barp + 0x0C);
        pci_iounmap(pdev, barp);

        if (devices & 0x10)
                return 1;
        return 0;
}

/**
 *      marvell_pre_reset       -       probe begin
 *      @link: link
 *      @deadline: deadline jiffies for the operation
 *
 *      Perform the PATA port setup we need.
 */

static int marvell_pre_reset(struct ata_link *link, unsigned long deadline)
{
        struct ata_port *ap = link->ap;
        struct pci_dev *pdev = to_pci_dev(ap->host->dev);

        if (pdev->device == 0x6145 && ap->port_no == 0 &&
                !marvell_pata_active(pdev))     /* PATA enable ? */
                        return -ENOENT;

        return ata_sff_prereset(link, deadline);
}

static int marvell_cable_detect(struct ata_port *ap)
{
        /* Cable type */
        switch(ap->port_no)
        {
        case 0:
                if (!ap->ioaddr.bmdma_addr)
                        return ATA_CBL_PATA_UNK;
                if (ioread8(ap->ioaddr.bmdma_addr + 1) & 1)
                        return ATA_CBL_PATA40;
                return ATA_CBL_PATA80;
        case 1: /* Legacy SATA port */
                return ATA_CBL_SATA;
        }

        BUG();
        return 0;       /* Our BUG macro needs the right markup */
}

/* No PIO or DMA methods needed for this device */

static const struct scsi_host_template marvell_sht = {
        ATA_BMDMA_SHT(DRV_NAME),
};

static struct ata_port_operations marvell_ops = {
        .inherits               = &ata_bmdma_port_ops,
        .cable_detect           = marvell_cable_detect,
        .reset.prereset         = marvell_pre_reset,
};


/**
 *      marvell_init_one - Register Marvell ATA PCI device with kernel services
 *      @pdev: PCI device to register
 *      @id: PCI device ID
 *
 *      Called from kernel PCI layer.
 *
 *      LOCKING:
 *      Inherited from PCI layer (may sleep).
 *
 *      RETURNS:
 *      Zero on success, or -ERRNO value.
 */

static int marvell_init_one (struct pci_dev *pdev, const struct pci_device_id *id)
{
        static const struct ata_port_info info = {
                .flags          = ATA_FLAG_SLAVE_POSS,

                .pio_mask       = ATA_PIO4,
                .mwdma_mask     = ATA_MWDMA2,
                .udma_mask      = ATA_UDMA5,

                .port_ops       = &marvell_ops,
        };
        static const struct ata_port_info info_sata = {
                /* Slave possible as its magically mapped not real */
                .flags          = ATA_FLAG_SLAVE_POSS,

                .pio_mask       = ATA_PIO4,
                .mwdma_mask     = ATA_MWDMA2,
                .udma_mask      = ATA_UDMA6,

                .port_ops       = &marvell_ops,
        };
        const struct ata_port_info *ppi[] = { &info, &info_sata };

        if (pdev->device == 0x6101)
                ppi[1] = &ata_dummy_port_info;

#if IS_ENABLED(CONFIG_SATA_AHCI)
        if (!marvell_pata_active(pdev)) {
                dev_info(&pdev->dev,
                         "PATA port not active, deferring to AHCI driver.\n");
                return -ENODEV;
        }
#endif
        return ata_pci_bmdma_init_one(pdev, ppi, &marvell_sht, NULL, 0);
}

static const struct pci_device_id marvell_pci_tbl[] = {
        { PCI_DEVICE(0x11AB, 0x6101), },
        { PCI_DEVICE(0x11AB, 0x6121), },
        { PCI_DEVICE(0x11AB, 0x6123), },
        { PCI_DEVICE(0x11AB, 0x6145), },
        { PCI_DEVICE(0x1B4B, 0x91A0), },
        { PCI_DEVICE(0x1B4B, 0x91A4), },

        { }     /* terminate list */
};

static struct pci_driver marvell_pci_driver = {
        .name                   = DRV_NAME,
        .id_table               = marvell_pci_tbl,
        .probe                  = marvell_init_one,
        .remove                 = ata_pci_remove_one,
#ifdef CONFIG_PM_SLEEP
        .suspend                = ata_pci_device_suspend,
        .resume                 = ata_pci_device_resume,
#endif
};

module_pci_driver(marvell_pci_driver);

MODULE_AUTHOR("Alan Cox");
MODULE_DESCRIPTION("SCSI low-level driver for Marvell ATA in legacy mode");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, marvell_pci_tbl);
MODULE_VERSION(DRV_VERSION);