/* * MUSB OTG driver host defines * * Copyright 2005 Mentor Graphics Corporation * Copyright (C) 2005-2006 by Texas Instruments * Copyright (C) 2006-2007 Nokia 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., 51 Franklin St, Fifth Floor, Boston, MA * 02110-1301 USA * * THIS SOFTWARE IS PROVIDED "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 AUTHORS 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. * */ #ifndef _MUSB_HOST_H #define _MUSB_HOST_H //#include #include #include #include /* * urb->transfer_flags: * * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb(). */ #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors. */ #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */ #define usb_hcd_link_urb_to_ep(hcd, urb) ({ \ int ret = 0; \ list_add_tail(&urb->urb_list, &urb->ep->urb_list); \ ret; }) #define usb_hcd_unlink_urb_from_ep(hcd, urb) list_del_init(&urb->urb_list) struct ep_device; struct urb; typedef void (*usb_complete_t)(struct urb *urb); struct urb { void *hcpriv; /* private data for host controller */ struct list_head urb_list; /* list head for use by the urb's * current owner */ struct usb_device *dev; /* (in) pointer to associated device */ struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */ unsigned int pipe; /* (in) pipe information */ int status; /* (return) non-ISO status */ unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/ void *transfer_buffer; /* (in) associated data buffer */ dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */ u32 transfer_buffer_length; /* (in) data buffer length */ u32 actual_length; /* (return) actual transfer length */ unsigned char *setup_packet; /* (in) setup packet (control only) */ int start_frame; /* (modify) start frame (ISO) */ int error_count; /* (return) number of ISO errors */ usb_complete_t complete; /* (in) completion routine */ }; #define USB_DT_SS_EP_COMP_SIZE 6 /** * struct usb_host_endpoint - host-side endpoint descriptor and queue * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint * @urb_list: urbs queued to this endpoint; maintained by usbcore * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH) * with one or more transfer descriptors (TDs) per urb * @ep_dev: ep_device for sysfs info * @extra: descriptors following this endpoint in the configuration * @extralen: how many bytes of "extra" are valid * @enabled: URBs may be submitted to this endpoint * * USB requests are always queued to a given endpoint, identified by a * descriptor within an active interface in a given USB configuration. */ struct usb_host_endpoint { struct usb_endpoint_descriptor desc; struct usb_ss_ep_comp_descriptor ss_ep_comp; struct list_head urb_list; void *hcpriv; //struct ep_device *ep_dev; /* For sysfs info */ unsigned char *extra; /* Extra descriptors */ int extralen; int enabled; }; /* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints */ struct musb_qh { struct usb_host_endpoint *hep; /* usbcore info */ struct usb_device *dev; struct musb_hw_ep *hw_ep; /* current binding */ struct list_head ring; /* of musb_qh */ /* struct musb_qh *next; */ /* for periodic tree */ u8 mux; /* qh multiplexed to hw_ep */ unsigned offset; /* in urb->transfer_buffer */ unsigned segsize; /* current xfer fragment */ u8 type_reg; /* {rx,tx} type register */ u8 intv_reg; /* {rx,tx} interval register */ u8 addr_reg; /* device address register */ u8 h_addr_reg; /* hub address register */ u8 h_port_reg; /* hub port register */ u8 is_ready; /* safe to modify hw_ep */ u8 type; /* XFERTYPE_* */ u8 epnum; u8 hb_mult; /* high bandwidth pkts per uf */ u16 maxpacket; u16 frame; /* for periodic schedule */ unsigned iso_idx; /* in urb->iso_frame_desc[] */ //struct sg_mapping_iter sg_miter; /* for highmem in PIO mode */ //bool use_sg; /* to track urb using sglist */ }; /* map from control or bulk queue head to the first qh on that ring */ static inline struct musb_qh *first_qh(struct list_head *q) { if (list_empty(q)) return NULL; return list_entry(q->next, struct musb_qh, ring); } struct usb_hcd; #if IS_ENABLED(CONFIG_USB_MUSB_HOST) extern struct musb *hcd_to_musb(struct usb_hcd *); extern irqreturn_t musb_h_ep0_irq(struct musb *); extern int musb_host_alloc(struct musb *); extern int musb_host_setup(struct musb *, int); extern void musb_root_disconnect(struct musb *musb); extern void musb_host_free(struct musb *); extern void musb_host_cleanup(struct musb *); extern void musb_host_tx(struct musb *, u8); extern void musb_host_rx(struct musb *, u8); extern void musb_host_resume_root_hub(struct musb *musb); extern void musb_host_poke_root_hub(struct musb *musb); extern void musb_port_reset(struct musb *musb, bool do_reset); #else static inline struct musb *hcd_to_musb(struct usb_hcd *hcd) { return NULL; } static inline irqreturn_t musb_h_ep0_irq(struct musb *musb) { return 0; } static inline int musb_host_alloc(struct musb *musb) { return 0; } static inline int musb_host_setup(struct musb *musb, int power_budget) { return 0; } static inline void musb_host_cleanup(struct musb *musb) {} static inline void musb_host_free(struct musb *musb) {} static inline void musb_host_tx(struct musb *musb, u8 epnum) {} static inline void musb_host_rx(struct musb *musb, u8 epnum) {} static inline void musb_root_disconnect(struct musb *musb) {} static inline void musb_host_resume_root_hub(struct musb *musb) {} static inline void musb_host_poll_rh_status(struct musb *musb) {} static inline void musb_host_poke_root_hub(struct musb *musb) {} static inline void musb_port_reset(struct musb *musb, bool do_reset) {} #endif struct usb_hcd; extern int musb_hub_status_data(struct usb_hcd *hcd, char *buf); extern int musb_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex, char *buf, u16 wLength); static inline struct urb *next_urb(struct musb_qh *qh) { struct list_head *queue; if (!qh) return NULL; queue = &qh->hep->urb_list; if (list_empty(queue)) return NULL; return list_entry(queue->next, struct urb, urb_list); } /* * Endpoints */ #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ static inline u16 find_tt(struct usb_device *dev) { u8 chid; u8 hub; /* Find out the nearest parent which is high speed */ while (dev->parent->parent != NULL) if (dev->parent->speed != USB_SPEED_HIGH) dev = dev->parent; else break; /* determine the port address at that hub */ hub = dev->parent->devnum; for (chid = 0; chid < USB_MAXCHILDREN; chid++) if (dev->parent->children[chid] == dev) break; return (hub << 8) | chid; } int musb_urb_enqueue( struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags); int musb_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status); static inline void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status) { urb->status = status; if (urb->complete) urb->complete(urb); } #endif /* _MUSB_HOST_H */