drivers/usb/dwc_otg_310/dwc_otg_driver.h

   1 /* ==========================================================================
   2  * $File: //dwh/usb_iip/dev/software/otg/linux/drivers/dwc_otg_driver.h $
   3  * $Revision: #19 $
   4  * $Date: 2010/11/15 $
   5  * $Change: 1627671 $
   6  *
   7  * Synopsys HS OTG Linux Software Driver and documentation (hereinafter,
   8  * "Software") is an Unsupported proprietary work of Synopsys, Inc. unless
   9  * otherwise expressly agreed to in writing between Synopsys and you.
  10  *
  11  * The Software IS NOT an item of Licensed Software or Licensed Product under
  12  * any End User Software License Agreement or Agreement for Licensed Product
  13  * with Synopsys or any supplement thereto. You are permitted to use and
  14  * redistribute this Software in source and binary forms, with or without
  15  * modification, provided that redistributions of source code must retain this
  16  * notice. You may not view, use, disclose, copy or distribute this file or
  17  * any information contained herein except pursuant to this license grant from
  18  * Synopsys. If you do not agree with this notice, including the disclaimer
  19  * below, then you are not authorized to use the Software.
  20  *
  21  * THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS" BASIS
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  31  * DAMAGE.
  32  * ========================================================================== */
  33
  34 #ifndef __DWC_OTG_DRIVER_H__
  35 #define __DWC_OTG_DRIVER_H__
  36
  37 /** @file
  38  * This file contains the interface to the Linux driver.
  39  */
  40 #include "dwc_otg_os_dep.h"
  41 #include "dwc_otg_core_if.h"
  42
  43 /* Type declarations */
  44 struct dwc_otg_pcd;
  45 struct dwc_otg_hcd;
  46
  47 /**
  48  * This structure is a wrapper that encapsulates the driver components used to
  49  * manage a single DWC_otg controller.
  50  */
  51 typedef struct dwc_otg_device {
  52         /** Structure containing OS-dependent stuff. KEEP THIS STRUCT AT THE
  53          * VERY BEGINNING OF THE DEVICE STRUCT. OSes such as FreeBSD and NetBSD
  54          * require this. */
  55         struct os_dependent os_dep;
  56
  57         /** Pointer to the core interface structure. */
  58         dwc_otg_core_if_t *core_if;
  59
  60         /** Pointer to the PCD structure. */
  61         struct dwc_otg_pcd *pcd;
  62
  63         /** Pointer to the HCD structure. */
  64         struct dwc_otg_hcd *hcd;
  65
  66     /** Pointer to platform device structure. */
  67         struct dwc_otg_platform_data *pldata;
  68
  69         /** Flag to indicate whether the common IRQ handler is installed. */
  70         uint8_t common_irq_installed;
  71
  72 } dwc_otg_device_t;
  73
  74 /*We must clear S3C24XX_EINTPEND external interrupt register
  75  * because after clearing in this register trigerred IRQ from
  76  * H/W core in kernel interrupt can be occured again before OTG
  77  * handlers clear all IRQ sources of Core registers because of
  78  * timing latencies and Low Level IRQ Type.
  79  */
  80
  81 #endif