staging: PCI bus interface for the DWC2 driver

/*

 * pci.c - DesignWare HS OTG Controller PCI driver

 *

 * Copyright (C) 2004-2013 Synopsys, Inc.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions, and the following disclaimer,

 *    without modification.

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 * 3. The names of the above-listed copyright holders may not be used

 *    to endorse or promote products derived from this software without

 *    specific prior written permission.

 *

 * ALTERNATIVELY, this software may be distributed under the terms of the

 * GNU General Public License ("GPL") as published by the Free Software

 * Foundation; either version 2 of the License, or (at your option) any

 * later version.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

/*

 * Provides the initialization and cleanup entry points for the DWC_otg PCI

 * driver

 */

#include <linux/kernel.h>

#include <linux/module.h>

#include <linux/moduleparam.h>

#include <linux/spinlock.h>

#include <linux/interrupt.h>

#include <linux/io.h>

#include <linux/slab.h>

#include <linux/pci.h>

#include <linux/usb.h>

#include <linux/usb/hcd.h>

#include <linux/usb/ch11.h>

#include "core.h"

#include "hcd.h"

#define PCI_VENDOR_ID_SYNOPSYS		0x16c3

#define PCI_PRODUCT_ID_HAPS_HSOTG	0xabc0

static const char dwc2_driver_name[] = "dwc_otg";

static struct dwc2_core_params dwc2_module_params = {

	.otg_cap			= -1,

	.otg_ver			= -1,

	.dma_enable			= -1,

	.dma_desc_enable		= 0,

	.speed				= -1,

	.enable_dynamic_fifo		= -1,

	.en_multiple_tx_fifo		= -1,

	.host_rx_fifo_size		= 1024,

	.host_nperio_tx_fifo_size	= 256,

	.host_perio_tx_fifo_size	= 1024,

	.max_transfer_size		= 65535,

	.max_packet_count		= 511,

	.host_channels			= -1,

	.phy_type			= -1,

	.phy_utmi_width			= 16,	/* 16 bits - NOT DETECTABLE */

	.phy_ulpi_ddr			= -1,

	.phy_ulpi_ext_vbus		= -1,

	.i2c_enable			= -1,

	.ulpi_fs_ls			= -1,

	.host_support_fs_ls_low_power	= -1,

	.host_ls_low_power_phy_clk	= -1,

	.ts_dline			= -1,

	.reload_ctl			= -1,

	.ahb_single			= -1,

};

/**

 * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the

 * DWC_otg driver

 *

 * @dev: Bus device

 *

 * This routine is called, for example, when the rmmod command is executed. The

 * device may or may not be electrically present. If it is present, the driver

 * stops device processing. Any resources used on behalf of this device are

 * freed.

 */

static void dwc2_driver_remove(struct pci_dev *dev)

{

	struct dwc2_hsotg *hsotg = pci_get_drvdata(dev);

	dev_dbg(&dev->dev, "%s(%p)\n", __func__, dev);

	dwc2_hcd_remove(&dev->dev, hsotg);

	pci_disable_device(dev);

}

/**

 * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg

 * driver

 *

 * @dev: Bus device

 *

 * This routine creates the driver components required to control the device

 * (core, HCD, and PCD) and initializes the device. The driver components are

 * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved

 * in the device private data. This allows the driver to access the dwc2_hsotg

 * structure on subsequent calls to driver methods for this device.

 */

static int dwc2_driver_probe(struct pci_dev *dev,

			     const struct pci_device_id *id)

{

	struct dwc2_hsotg *hsotg;

	int retval;

	dev_dbg(&dev->dev, "%s(%p)\n", __func__, dev);

	hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);

	if (!hsotg)

		return -ENOMEM;

	pci_set_power_state(dev, PCI_D0);

	hsotg->regs = devm_request_and_ioremap(&dev->dev, &dev->resource[0]);

	if (!hsotg->regs)

		return -ENOMEM;

	dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",

		(unsigned long)pci_resource_start(dev, 0), hsotg->regs);

	if (pci_enable_device(dev) < 0)

		return -ENODEV;

	pci_set_master(dev);

	if (dwc2_module_params.dma_enable > 0) {

		if (pci_set_dma_mask(dev, DMA_BIT_MASK(31)) < 0)

			dev_warn(&dev->dev,

				 "can't enable workaround for >2GB RAM\n");

		if (pci_set_consistent_dma_mask(dev, DMA_BIT_MASK(31)) < 0)

			dev_warn(&dev->dev,

				 "can't enable workaround for >2GB RAM\n");

	} else {

		pci_set_dma_mask(dev, 0);

		pci_set_consistent_dma_mask(dev, 0);

	}

	retval = dwc2_hcd_init(&dev->dev, hsotg, dev->irq, &dwc2_module_params);

	if (retval) {

		pci_disable_device(dev);

		return retval;

	}

	pci_set_drvdata(dev, hsotg);

	dev_dbg(&dev->dev, "hsotg=%p\n", hsotg);

	dev_dbg(&dev->dev, "registering common handler for irq%d\n", dev->irq);

	retval = devm_request_irq(&dev->dev, dev->irq, dwc2_handle_common_intr,

				  IRQF_SHARED | IRQ_LEVEL, dev_name(&dev->dev),

				  hsotg);

	if (retval)

		dwc2_hcd_remove(&dev->dev, hsotg);

	return retval;

}

static DEFINE_PCI_DEVICE_TABLE(dwc2_pci_ids) = {

	{

		PCI_DEVICE(PCI_VENDOR_ID_SYNOPSYS, PCI_PRODUCT_ID_HAPS_HSOTG),

	},

	{ /* end: all zeroes */ }

};

MODULE_DEVICE_TABLE(pci, dwc2_pci_ids);

static struct pci_driver dwc2_pci_driver = {

	.name = dwc2_driver_name,

	.id_table = dwc2_pci_ids,

	.probe = dwc2_driver_probe,

	.remove = dwc2_driver_remove,

};

module_pci_driver(dwc2_pci_driver);

MODULE_DESCRIPTION("DESIGNWARE HS OTG PCI Bus Glue");

MODULE_AUTHOR("Synopsys, Inc.");

MODULE_LICENSE("Dual BSD/GPL");