/*
 * sdhci-pltfm.c Support for SDHCI platform devices
 * Copyright (c) 2009 Intel Corporation
 *
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/* Supports:
 * SDHCI platform devices
 *
 * Inspired by sdhci-pci.c, by Pierre Ossman
 */
/* 
 * Includes Intel Corporation's changes/modifications dated: 2012. 
 * Changed/modified portions - Copyright © 2012 , Intel Corporation.
 */ 

#include <linux/delay.h>
#include <linux/highmem.h>
#include <linux/mod_devicetable.h>
#include <linux/platform_device.h>

#include <linux/mmc/host.h>

#include <linux/io.h>
#include <linux/mmc/sdhci-pltfm.h>

#include "sdhci.h"
#include "sdhci-pltfm.h"

#if defined(CONFIG_ARCH_GEN3_MMC)
#include <arch-avalanche/puma6/hw_mutex_ctrl.h>
#include <arch-avalanche/puma6/arm_atom_mbx.h>
#include <arch-avalanche/puma6/puma6_aep.h>
#include <arch-avalanche/puma6/sram_api.h>
#include <arch-avalanche/puma6/docsis_ip_boot_params.h>
#endif

/*****************************************************************************\
 *                                                                           *
 * SDHCI core callbacks                                                      *
 *                                                                           *
\*****************************************************************************/

static struct sdhci_ops sdhci_pltfm_ops = {
};

/*****************************************************************************\
 *                                                                           *
 * Device probing/removal                                                    *
 *                                                                           *
\*****************************************************************************/

static int __devinit sdhci_pltfm_probe(struct platform_device *pdev)
{
	const struct platform_device_id *platid = platform_get_device_id(pdev);
	struct sdhci_pltfm_data *pdata;
	struct sdhci_host *host;
	struct sdhci_pltfm_host *pltfm_host;
	struct resource *iomem;
	int ret;
#if defined(CONFIG_ARCH_GEN3_MMC)
	int res = 0;
	int loops = 5;
#endif

#ifdef CONFIG_ARCH_GEN3
    unsigned int np_only_mode = 0;
#endif

	if (platid && platid->driver_data)
		pdata = (void *)platid->driver_data;
	else
		pdata = pdev->dev.platform_data;

#ifdef CONFIG_ARCH_GEN3_MMC
	/* Select Host controller base address to use Phisical or Virtual AEP*/
    if (aep_is_active() != 0)
	{
		// Use AEP virtual host controller
		// printk("[PowerOn] sdhci_alloc_host() Use AEP virtual host controller. \n");
		iomem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	}
    else
	{
#endif
		// Use physical host controller
		// printk("[PowerOn] sdhci_alloc_host() Use physical host controller. \n");
	iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
#ifdef CONFIG_ARCH_GEN3_MMC
	}
#endif

    
	if (!iomem) {
		ret = -ENOMEM;
		goto err;
	}
    // printk("[PowerOn] sdhci_pltfm_probe iomem->start = %p\n",iomem->start); 

	if (resource_size(iomem) < 0x100)
		dev_err(&pdev->dev, "Invalid iomem size. You may "
			"experience problems.\n");

	/* Some PCI-based MFD need the parent here */
	if (pdev->dev.parent != &platform_bus)
    {
 		host = sdhci_alloc_host(pdev->dev.parent, sizeof(*pltfm_host));
    }
	else
    {
		host = sdhci_alloc_host(&pdev->dev, sizeof(*pltfm_host));
    }
#ifdef CONFIG_ARCH_GEN3_MMC
	if (aep_is_active() != 0)
		host->flags |= SDHCI_USE_AEP;
#endif


	if (IS_ERR(host)) {
		ret = PTR_ERR(host);
		goto err;
	}

	pltfm_host = sdhci_priv(host);

	host->hw_name = "platform";
	if (pdata && pdata->ops)
		host->ops = pdata->ops;
	else
		host->ops = &sdhci_pltfm_ops;
	if (pdata)
		host->quirks = pdata->quirks;
	host->irq = platform_get_irq(pdev, 0);

#if defined(CONFIG_MACH_PUMA6)
	/*
      in Puma6 we do not use ioremap, ioumap, request_mem_region and release_mem_region - virtual addresses are
      predefined.
     */

	/* Get virtual address */
    host->ioaddr = (unsigned int __iomem *)(iomem->start);
	if (!host->ioaddr) {
		dev_err(&pdev->dev, "failed to map registers\n");
		ret = -ENOMEM;
		goto err_remap;
	}
#else
	if (!request_mem_region(iomem->start, resource_size(iomem),
		mmc_hostname(host->mmc))) {
		dev_err(&pdev->dev, "cannot request region\n");
		ret = -EBUSY;
		goto err_request;
	}

	host->ioaddr = ioremap(iomem->start, resource_size(iomem));
	if (!host->ioaddr) {
		dev_err(&pdev->dev, "failed to remap registers\n");
		ret = -ENOMEM;
		goto err_remap;
	}
#endif

#if defined(CONFIG_MACH_PUMA6)
#if defined(CONFIG_ARCH_GEN3_MMC)
    // TEMP REMOVED    host->flags |= SDHCI_SUPPORT_DDR;       /* Support Dual Data Rate - eMMC 4.4 only*/
    host->flags |= SDHCI_SUPPORT_HW_MUTEX;  /* Support HW Mutex       */
#endif

    /* OMER - Copy from sdhci-pci.c - not sure if necessary */
    host->mmc->pm_caps = MMC_PM_KEEP_POWER | MMC_PM_WAKE_SDIO_IRQ;
#endif

	if (pdata && pdata->init) {
		ret = pdata->init(host, pdata);
		if (ret)
			goto err_plat_init;
	}

#if defined(CONFIG_ARCH_GEN3_MMC)
    printk(KERN_INFO"NP-CPU MBX waits for 'eMMC advance mode ready' notification from APP-CPU ...\n");
	do
	{
		res = arm_atom_mbx_receive_event_notification(ATOM_EVENT_EMMC_ADVANCE_EXIT,NULL);
		if (res)
			printk(KERN_INFO"[%s] NP-CPU MBOX  -  did not get event 'eMMC advance mode ready' notification from APP-CPU, retrying ... \n", __FUNCTION__);
		loops--;
	}while ((res != 0) && loops);

	if (res != 0)
	{
		printk(KERN_ERR" NP-CPU MBOX error  -  did not get event 'eMMC advance mode ready' notification from APP-CPU \n\n");
		printk(KERN_INFO"  +----------------------------------------------------------------------------+  \n");
		printk(KERN_INFO"  | Detected ARM only boot - waited 15 seconds for Atom, boot continued ...    |  \n");
		printk(KERN_INFO"  +----------------------------------------------------------------------------+  \n\n");
	}
	else
	{
		printk(KERN_INFO"NP-CPU MBX received 'eMMC advance mode ready' notification from APP-CPU.\n");
	}
    //printk("[PowerOn] sdhci_pltfm_probe: Taking HW-MUTEX...\n");
	LOCK_EMMC_HW_MUTEX(host->mmc);
    //printk("[PowerOn] sdhci_pltfm_probe: Got HW-MUTEX\n");

	ret = sdhci_add_host(host);

    // printk("[PowerOn] sdhci_pltfm_probe: Release HW-MUTEX\n");
    UNLOCK_EMMC_HW_MUTEX(host->mmc);
#else // defined(CONFIG_ARCH_GEN3_MMC)
    ret = sdhci_add_host(host);
#endif

	if (ret)
		goto err_add_host;

	platform_set_drvdata(pdev, host);

	// FIXME: find another way to make sure the eMMC has been detected
	mdelay(300);

	return 0;

err_add_host:
	if (pdata && pdata->exit)
		pdata->exit(host);

err_plat_init:
#if !defined(CONFIG_MACH_PUMA6)
	iounmap(host->ioaddr);
#endif

err_remap:
#if !defined(CONFIG_MACH_PUMA6)
	release_mem_region(iomem->start, resource_size(iomem));
#endif

err_request:
	sdhci_free_host(host);

err:
	printk(KERN_ERR"Probing of sdhci-pltfm failed: %d\n", ret);
	return ret;
}

static int __devexit sdhci_pltfm_remove(struct platform_device *pdev)
{
	struct sdhci_pltfm_data *pdata = pdev->dev.platform_data;
	struct sdhci_host *host = platform_get_drvdata(pdev);
	int dead;
	u32 scratch;
#if !defined(CONFIG_MACH_PUMA6)
	struct resource *iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
#endif

	dead = 0;
	scratch = readl(host->ioaddr + SDHCI_INT_STATUS);
	if (scratch == (u32)-1)
		dead = 1;

	sdhci_remove_host(host, dead);
	if (pdata && pdata->exit)
		pdata->exit(host);
#if !defined(CONFIG_MACH_PUMA6)
	iounmap(host->ioaddr);
	release_mem_region(iomem->start, resource_size(iomem));
#endif
	sdhci_free_host(host);
	platform_set_drvdata(pdev, NULL);

	return 0;
}

static const struct platform_device_id sdhci_pltfm_ids[] = {
	{ "sdhci", },
#ifdef CONFIG_MMC_SDHCI_CNS3XXX
	{ "sdhci-cns3xxx", (kernel_ulong_t)&sdhci_cns3xxx_pdata },
#endif
#ifdef CONFIG_MMC_SDHCI_ESDHC_IMX
	{ "sdhci-esdhc-imx", (kernel_ulong_t)&sdhci_esdhc_imx_pdata },
#endif
#ifdef CONFIG_MMC_SDHCI_DOVE
	{ "sdhci-dove", (kernel_ulong_t)&sdhci_dove_pdata },
#endif
#ifdef CONFIG_MMC_SDHCI_TEGRA
	{ "sdhci-tegra", (kernel_ulong_t)&sdhci_tegra_pdata },
#endif
#ifdef CONFIG_MMC_SDHCI_PUMA6
	{ "sdhci-puma6", (kernel_ulong_t)&sdhci_puma6_pdata },
#endif
	{ },
};
MODULE_DEVICE_TABLE(platform, sdhci_pltfm_ids);

#ifdef CONFIG_PM
static int sdhci_pltfm_suspend(struct platform_device *dev, pm_message_t state)
{
	struct sdhci_host *host = platform_get_drvdata(dev);

	return sdhci_suspend_host(host, state);
}

static int sdhci_pltfm_resume(struct platform_device *dev)
{
	struct sdhci_host *host = platform_get_drvdata(dev);

	return sdhci_resume_host(host);
}
#else
#define sdhci_pltfm_suspend	NULL
#define sdhci_pltfm_resume	NULL
#endif	/* CONFIG_PM */

static struct platform_driver sdhci_pltfm_driver = {
	.driver = {
		.name	= "sdhci",
		.owner	= THIS_MODULE,
	},
	.probe		= sdhci_pltfm_probe,
	.remove		= __devexit_p(sdhci_pltfm_remove),
	.id_table	= sdhci_pltfm_ids,
	.suspend	= sdhci_pltfm_suspend,
	.resume		= sdhci_pltfm_resume,
};

/*****************************************************************************\
 *                                                                           *
 * Driver init/exit                                                          *
 *                                                                           *
\*****************************************************************************/

static int __init sdhci_drv_init(void)
{
	return platform_driver_register(&sdhci_pltfm_driver);
}

static void __exit sdhci_drv_exit(void)
{
	platform_driver_unregister(&sdhci_pltfm_driver);
}

module_init(sdhci_drv_init);
module_exit(sdhci_drv_exit);

MODULE_DESCRIPTION("Secure Digital Host Controller Interface platform driver");
MODULE_AUTHOR("Mocean Laboratories <info@mocean-labs.com>");
MODULE_LICENSE("GPL v2");