xref: /openbmc/linux/drivers/usb/musb/musb_host.h (revision 63705da3)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * MUSB OTG driver host defines
4  *
5  * Copyright 2005 Mentor Graphics Corporation
6  * Copyright (C) 2005-2006 by Texas Instruments
7  * Copyright (C) 2006-2007 Nokia Corporation
8  */
9 
10 #ifndef _MUSB_HOST_H
11 #define _MUSB_HOST_H
12 
13 #include <linux/scatterlist.h>
14 
15 /* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints */
16 struct musb_qh {
17 	struct usb_host_endpoint *hep;		/* usbcore info */
18 	struct usb_device	*dev;
19 	struct musb_hw_ep	*hw_ep;		/* current binding */
20 
21 	struct list_head	ring;		/* of musb_qh */
22 	/* struct musb_qh		*next; */	/* for periodic tree */
23 	u8			mux;		/* qh multiplexed to hw_ep */
24 
25 	unsigned		offset;		/* in urb->transfer_buffer */
26 	unsigned		segsize;	/* current xfer fragment */
27 
28 	u8			type_reg;	/* {rx,tx} type register */
29 	u8			intv_reg;	/* {rx,tx} interval register */
30 	u8			addr_reg;	/* device address register */
31 	u8			h_addr_reg;	/* hub address register */
32 	u8			h_port_reg;	/* hub port register */
33 
34 	u8			is_ready;	/* safe to modify hw_ep */
35 	u8			type;		/* XFERTYPE_* */
36 	u8			epnum;
37 	u8			hb_mult;	/* high bandwidth pkts per uf */
38 	u16			maxpacket;
39 	u16			frame;		/* for periodic schedule */
40 	unsigned		iso_idx;	/* in urb->iso_frame_desc[] */
41 	struct sg_mapping_iter sg_miter;	/* for highmem in PIO mode */
42 	bool			use_sg;		/* to track urb using sglist */
43 };
44 
45 /* map from control or bulk queue head to the first qh on that ring */
46 static inline struct musb_qh *first_qh(struct list_head *q)
47 {
48 	if (list_empty(q))
49 		return NULL;
50 	return list_entry(q->next, struct musb_qh, ring);
51 }
52 
53 
54 #if IS_ENABLED(CONFIG_USB_MUSB_HOST) || IS_ENABLED(CONFIG_USB_MUSB_DUAL_ROLE)
55 extern struct musb *hcd_to_musb(struct usb_hcd *);
56 extern irqreturn_t musb_h_ep0_irq(struct musb *);
57 extern int musb_host_alloc(struct musb *);
58 extern int musb_host_setup(struct musb *, int);
59 extern void musb_host_cleanup(struct musb *);
60 extern void musb_host_tx(struct musb *, u8);
61 extern void musb_host_rx(struct musb *, u8);
62 extern void musb_root_disconnect(struct musb *musb);
63 extern void musb_host_free(struct musb *);
64 extern void musb_host_resume_root_hub(struct musb *musb);
65 extern void musb_host_poke_root_hub(struct musb *musb);
66 extern int musb_port_suspend(struct musb *musb, bool do_suspend);
67 extern void musb_port_reset(struct musb *musb, bool do_reset);
68 extern void musb_host_finish_resume(struct work_struct *work);
69 #else
70 static inline struct musb *hcd_to_musb(struct usb_hcd *hcd)
71 {
72 	return NULL;
73 }
74 
75 static inline irqreturn_t musb_h_ep0_irq(struct musb *musb)
76 {
77 	return 0;
78 }
79 
80 static inline int musb_host_alloc(struct musb *musb)
81 {
82 	return 0;
83 }
84 
85 static inline int musb_host_setup(struct musb *musb, int power_budget)
86 {
87 	return 0;
88 }
89 
90 static inline void musb_host_cleanup(struct musb *musb)		{}
91 static inline void musb_host_free(struct musb *musb)		{}
92 static inline void musb_host_tx(struct musb *musb, u8 epnum)	{}
93 static inline void musb_host_rx(struct musb *musb, u8 epnum)	{}
94 static inline void musb_root_disconnect(struct musb *musb)	{}
95 static inline void musb_host_resume_root_hub(struct musb *musb)	{}
96 static inline void musb_host_poke_root_hub(struct musb *musb)	{}
97 static inline int musb_port_suspend(struct musb *musb, bool do_suspend)
98 {
99 	return 0;
100 }
101 static inline void musb_port_reset(struct musb *musb, bool do_reset) {}
102 static inline void musb_host_finish_resume(struct work_struct *work) {}
103 #endif
104 
105 struct usb_hcd;
106 
107 extern int musb_hub_status_data(struct usb_hcd *hcd, char *buf);
108 extern int musb_hub_control(struct usb_hcd *hcd,
109 			u16 typeReq, u16 wValue, u16 wIndex,
110 			char *buf, u16 wLength);
111 
112 static inline struct urb *next_urb(struct musb_qh *qh)
113 {
114 	struct list_head	*queue;
115 
116 	if (!qh)
117 		return NULL;
118 	queue = &qh->hep->urb_list;
119 	if (list_empty(queue))
120 		return NULL;
121 	return list_entry(queue->next, struct urb, urb_list);
122 }
123 
124 #endif				/* _MUSB_HOST_H */
125