| 1 | /* ========================================================================== |
| 2 | * $File: //dwh/usb_iip/dev/software/otg/linux/drivers/dwc_otg_pcd.h $ |
| 3 | * $Revision: 1.2 $ |
| 4 | * $Date: 2008-11-21 05:39:15 $ |
| 5 | * $Change: 1103515 $ |
| 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 | #ifndef DWC_HOST_ONLY |
| 34 | #if !defined(__DWC_PCD_H__) |
| 35 | #define __DWC_PCD_H__ |
| 36 | |
| 37 | #include <linux/types.h> |
| 38 | #include <linux/list.h> |
| 39 | #include <linux/errno.h> |
| 40 | #include <linux/device.h> |
| 41 | |
| 42 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,21) |
| 43 | # include <linux/usb/ch9.h> |
| 44 | #else |
| 45 | # include <linux/usb_ch9.h> |
| 46 | #endif |
| 47 | |
| 48 | #include <linux/usb_gadget.h> |
| 49 | #include <linux/interrupt.h> |
| 50 | #include <linux/dma-mapping.h> |
| 51 | |
| 52 | struct dwc_otg_device; |
| 53 | |
| 54 | #include "dwc_otg_cil.h" |
| 55 | |
| 56 | /** |
| 57 | * @file |
| 58 | * |
| 59 | * This file contains the structures, constants, and interfaces for |
| 60 | * the Perpherial Contoller Driver (PCD). |
| 61 | * |
| 62 | * The Peripheral Controller Driver (PCD) for Linux will implement the |
| 63 | * Gadget API, so that the existing Gadget drivers can be used. For |
| 64 | * the Mass Storage Function driver the File-backed USB Storage Gadget |
| 65 | * (FBS) driver will be used. The FBS driver supports the |
| 66 | * Control-Bulk (CB), Control-Bulk-Interrupt (CBI), and Bulk-Only |
| 67 | * transports. |
| 68 | * |
| 69 | */ |
| 70 | |
| 71 | /** Invalid DMA Address */ |
| 72 | #define DMA_ADDR_INVALID (~(dma_addr_t)0) |
| 73 | /** Maxpacket size for EP0 */ |
| 74 | #define MAX_EP0_SIZE 64 |
| 75 | /** Maxpacket size for any EP */ |
| 76 | #define MAX_PACKET_SIZE 1024 |
| 77 | |
| 78 | /** Max Transfer size for any EP */ |
| 79 | #define MAX_TRANSFER_SIZE 65535 |
| 80 | |
| 81 | /** Max DMA Descriptor count for any EP */ |
| 82 | #define MAX_DMA_DESC_CNT 64 |
| 83 | |
| 84 | /** |
| 85 | * Get the pointer to the core_if from the pcd pointer. |
| 86 | */ |
| 87 | #define GET_CORE_IF( _pcd ) (_pcd->otg_dev->core_if) |
| 88 | |
| 89 | /** |
| 90 | * States of EP0. |
| 91 | */ |
| 92 | typedef enum ep0_state |
| 93 | { |
| 94 | EP0_DISCONNECT, /* no host */ |
| 95 | EP0_IDLE, |
| 96 | EP0_IN_DATA_PHASE, |
| 97 | EP0_OUT_DATA_PHASE, |
| 98 | EP0_IN_STATUS_PHASE, |
| 99 | EP0_OUT_STATUS_PHASE, |
| 100 | EP0_STALL, |
| 101 | } ep0state_e; |
| 102 | |
| 103 | /** Fordward declaration.*/ |
| 104 | struct dwc_otg_pcd; |
| 105 | |
| 106 | /** DWC_otg iso request structure. |
| 107 | * |
| 108 | */ |
| 109 | typedef struct usb_iso_request dwc_otg_pcd_iso_request_t; |
| 110 | |
| 111 | /** PCD EP structure. |
| 112 | * This structure describes an EP, there is an array of EPs in the PCD |
| 113 | * structure. |
| 114 | */ |
| 115 | typedef struct dwc_otg_pcd_ep |
| 116 | { |
| 117 | /** USB EP data */ |
| 118 | struct usb_ep ep; |
| 119 | /** USB EP Descriptor */ |
| 120 | const struct usb_endpoint_descriptor *desc; |
| 121 | |
| 122 | /** queue of dwc_otg_pcd_requests. */ |
| 123 | struct list_head queue; |
| 124 | unsigned stopped : 1; |
| 125 | unsigned disabling : 1; |
| 126 | unsigned dma : 1; |
| 127 | unsigned queue_sof : 1; |
| 128 | |
| 129 | #ifdef DWC_EN_ISOC |
| 130 | /** DWC_otg Isochronous Transfer */ |
| 131 | struct usb_iso_request* iso_req; |
| 132 | #endif //DWC_EN_ISOC |
| 133 | |
| 134 | /** DWC_otg ep data. */ |
| 135 | dwc_ep_t dwc_ep; |
| 136 | |
| 137 | /** Pointer to PCD */ |
| 138 | struct dwc_otg_pcd *pcd; |
| 139 | }dwc_otg_pcd_ep_t; |
| 140 | |
| 141 | |
| 142 | |
| 143 | /** DWC_otg PCD Structure. |
| 144 | * This structure encapsulates the data for the dwc_otg PCD. |
| 145 | */ |
| 146 | typedef struct dwc_otg_pcd |
| 147 | { |
| 148 | /** USB gadget */ |
| 149 | struct usb_gadget gadget; |
| 150 | /** USB gadget driver pointer*/ |
| 151 | struct usb_gadget_driver *driver; |
| 152 | /** The DWC otg device pointer. */ |
| 153 | struct dwc_otg_device *otg_dev; |
| 154 | |
| 155 | /** State of EP0 */ |
| 156 | ep0state_e ep0state; |
| 157 | /** EP0 Request is pending */ |
| 158 | unsigned ep0_pending : 1; |
| 159 | /** Indicates when SET CONFIGURATION Request is in process */ |
| 160 | unsigned request_config : 1; |
| 161 | /** The state of the Remote Wakeup Enable. */ |
| 162 | unsigned remote_wakeup_enable : 1; |
| 163 | /** The state of the B-Device HNP Enable. */ |
| 164 | unsigned b_hnp_enable : 1; |
| 165 | /** The state of A-Device HNP Support. */ |
| 166 | unsigned a_hnp_support : 1; |
| 167 | /** The state of the A-Device Alt HNP support. */ |
| 168 | unsigned a_alt_hnp_support : 1; |
| 169 | /** Count of pending Requests */ |
| 170 | unsigned request_pending; |
| 171 | |
| 172 | /** SETUP packet for EP0 |
| 173 | * This structure is allocated as a DMA buffer on PCD initialization |
| 174 | * with enough space for up to 3 setup packets. |
| 175 | */ |
| 176 | union |
| 177 | { |
| 178 | struct usb_ctrlrequest req; |
| 179 | uint32_t d32[2]; |
| 180 | } *setup_pkt; |
| 181 | |
| 182 | dma_addr_t setup_pkt_dma_handle; |
| 183 | |
| 184 | /** 2-byte dma buffer used to return status from GET_STATUS */ |
| 185 | uint16_t *status_buf; |
| 186 | dma_addr_t status_buf_dma_handle; |
| 187 | |
| 188 | /** EP0 */ |
| 189 | dwc_otg_pcd_ep_t ep0; |
| 190 | |
| 191 | /** Array of IN EPs. */ |
| 192 | dwc_otg_pcd_ep_t in_ep[ MAX_EPS_CHANNELS - 1]; |
| 193 | /** Array of OUT EPs. */ |
| 194 | dwc_otg_pcd_ep_t out_ep[ MAX_EPS_CHANNELS - 1]; |
| 195 | /** number of valid EPs in the above array. */ |
| 196 | // unsigned num_eps : 4; |
| 197 | spinlock_t lock; |
| 198 | /** Timer for SRP. If it expires before SRP is successful |
| 199 | * clear the SRP. */ |
| 200 | struct timer_list srp_timer; |
| 201 | |
| 202 | /** Tasklet to defer starting of TEST mode transmissions until |
| 203 | * Status Phase has been completed. |
| 204 | */ |
| 205 | struct tasklet_struct test_mode_tasklet; |
| 206 | |
| 207 | /** Tasklet to delay starting of xfer in DMA mode */ |
| 208 | struct tasklet_struct *start_xfer_tasklet; |
| 209 | |
| 210 | /** The test mode to enter when the tasklet is executed. */ |
| 211 | unsigned test_mode; |
| 212 | |
| 213 | } dwc_otg_pcd_t; |
| 214 | |
| 215 | |
| 216 | /** DWC_otg request structure. |
| 217 | * This structure is a list of requests. |
| 218 | */ |
| 219 | typedef struct |
| 220 | { |
| 221 | struct usb_request req; /**< USB Request. */ |
| 222 | struct list_head queue; /**< queue of these requests. */ |
| 223 | } dwc_otg_pcd_request_t; |
| 224 | |
| 225 | |
| 226 | extern int dwc_otg_pcd_init(struct device *dev); |
| 227 | |
| 228 | //extern void dwc_otg_pcd_remove( struct dwc_otg_device *_otg_dev ); |
| 229 | extern void dwc_otg_pcd_remove( struct device *dev); |
| 230 | extern int32_t dwc_otg_pcd_handle_intr( dwc_otg_pcd_t *pcd ); |
| 231 | extern void dwc_otg_pcd_start_srp_timer(dwc_otg_pcd_t *pcd ); |
| 232 | |
| 233 | extern void dwc_otg_pcd_initiate_srp(dwc_otg_pcd_t *pcd); |
| 234 | extern void dwc_otg_pcd_remote_wakeup(dwc_otg_pcd_t *pcd, int set); |
| 235 | |
| 236 | extern void dwc_otg_iso_buffer_done(dwc_otg_pcd_ep_t *ep, dwc_otg_pcd_iso_request_t *req); |
| 237 | extern void dwc_otg_request_done(dwc_otg_pcd_ep_t *_ep, dwc_otg_pcd_request_t *req, |
| 238 | int status); |
| 239 | extern void dwc_otg_request_nuke(dwc_otg_pcd_ep_t *_ep); |
| 240 | extern void dwc_otg_pcd_update_otg(dwc_otg_pcd_t *_pcd, |
| 241 | const unsigned reset); |
| 242 | |
| 243 | #endif |
| 244 | #endif /* DWC_HOST_ONLY */ |
| 245 | |
