usb/host/xhci.h

4  * xHCI host controller driver
21 /* Code sharing between pci-quirks and xhci hcd */
22 #include	"xhci-ext-caps.h"
28 /* xHCI PCI Configuration Registers */
37  * xHCI register interface.
38  * This corresponds to the eXtensible Host Controller Interface (xHCI)
43  * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
51  * @hcc_params2:	HCCPARAMS2 Capability Parameters 2, xhci 1.1 only
61 	__le32	hcc_params2; /* xhci 1.1 */
158  * struct xhci_op_regs - xHCI Host Controller Operational Registers.
207  * The xHCI driver must reinitialize the xHC after setting this bit.
288 /* bit 8: U3 Entry Enabled, assert PLC when root port enters U3, xhci 1.1 */
290 /* bit 9: Configuration Information Enable, xhci 1.1 */
453  * XHCI 1.0 errata 8/14/12 Table 13 notes:
794 	/* xHCI command response timeout in milliseconds */
843 /* Some Intel xHCI host controllers need software to keep track of the bus
930 	struct xhci_hcd		*xhci;  member
1006 	 * See xhci 1.1 section 4.8.3 for more details
1278 /* xhci 1.1 uses the TD_SIZE field for TBC if Extended TBC is enabled (ETE) */
1283 /* Total burst count field, Rsvdz on xhci 1.1 with Extended TBC enabled (ETE) */
1557  * xHCI command default timeout value in milliseconds.
1616 	unsigned int		num_trbs_free; /* used only by xhci DbC */
1634 	/* xhci->event_ring keeps track of segment dma addresses */
1700  * Intel Lynx Point LP xHCI host.
1814  * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code.  Any code
1817  * they see this status (any time they drop and re-acquire xhci->lock).
1821  * There are no reports of xHCI host controllers that display this issue.
1891 	/* support xHCI 1.0 spec USB2 hardware LPM */
1919 /* Platform specific overrides to generic XHCI hc_driver ops */
1951 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)  in xhci_to_hcd()  argument
1953 	return xhci->main_hcd;  in xhci_to_hcd()
1956 static inline struct usb_hcd *xhci_get_usb3_hcd(struct xhci_hcd *xhci)  in xhci_get_usb3_hcd()  argument
1958 	if (xhci->shared_hcd)  in xhci_get_usb3_hcd()
1959 		return xhci->shared_hcd;  in xhci_get_usb3_hcd()
1961 	if (!xhci->usb2_rhub.num_ports)  in xhci_get_usb3_hcd()
1962 		return xhci->main_hcd;  in xhci_get_usb3_hcd()
1969 	struct xhci_hcd *xhci = hcd_to_xhci(hcd);  in xhci_hcd_is_usb3()  local
1971 	return hcd == xhci_get_usb3_hcd(xhci);  in xhci_hcd_is_usb3()
1974 static inline bool xhci_has_one_roothub(struct xhci_hcd *xhci)  in xhci_has_one_roothub()  argument
1976 	return xhci->allow_single_roothub &&  in xhci_has_one_roothub()
1977 	       (!xhci->usb2_rhub.num_ports || !xhci->usb3_rhub.num_ports);  in xhci_has_one_roothub()
1980 #define xhci_dbg(xhci, fmt, args...) \  argument
1981 	dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1982 #define xhci_err(xhci, fmt, args...) \  argument
1983 	dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1984 #define xhci_warn(xhci, fmt, args...) \  argument
1985 	dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1986 #define xhci_warn_ratelimited(xhci, fmt, args...) \  argument
1987 	dev_warn_ratelimited(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1988 #define xhci_info(xhci, fmt, args...) \  argument
1989 	dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1994  * Some xHCI implementations may support 64-bit address pointers.  Registers
1997  * xHCI implementations that do not support 64-bit address pointers will ignore
2000 static inline u64 xhci_read_64(const struct xhci_hcd *xhci,  in xhci_read_64()  argument
2005 static inline void xhci_write_64(struct xhci_hcd *xhci,  in xhci_write_64()  argument
2011 static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)  in xhci_link_trb_quirk()  argument
2013 	return xhci->quirks & XHCI_LINK_TRB_QUIRK;  in xhci_link_trb_quirk()
2016 /* xHCI debugging */
2017 char *xhci_get_slot_state(struct xhci_hcd *xhci,
2019 void xhci_dbg_trace(struct xhci_hcd *xhci, void (*trace)(struct va_format *),
2022 /* xHCI memory management */
2023 void xhci_mem_cleanup(struct xhci_hcd *xhci);
2024 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
2025 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
2026 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags…
2027 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
2028 void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
2032 void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_e…
2033 void xhci_update_tt_active_eps(struct xhci_hcd *xhci,
2037 void xhci_update_bw_info(struct xhci_hcd *xhci,
2041 void xhci_endpoint_copy(struct xhci_hcd *xhci,
2045 void xhci_slot_copy(struct xhci_hcd *xhci,
2048 int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
2051 struct xhci_ring *xhci_ring_alloc(struct xhci_hcd *xhci,
2054 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
2055 int xhci_ring_expansion(struct xhci_hcd *xhci, struct xhci_ring *ring,
2059 void xhci_free_endpoint_ring(struct xhci_hcd *xhci,
2062 struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
2066 void xhci_free_stream_info(struct xhci_hcd *xhci,
2068 void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
2073 void xhci_free_device_endpoint_resources(struct xhci_hcd *xhci,
2078 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
2080 struct xhci_command *xhci_alloc_command_with_ctx(struct xhci_hcd *xhci,
2083 void xhci_free_command(struct xhci_hcd *xhci,
2085 struct xhci_container_ctx *xhci_alloc_container_ctx(struct xhci_hcd *xhci,
2087 void xhci_free_container_ctx(struct xhci_hcd *xhci,
2094 /* xHCI host controller glue */
2097 int xhci_handshake_check_state(struct xhci_hcd *xhci, void __iomem *ptr,
2099 void xhci_quiesce(struct xhci_hcd *xhci);
2100 int xhci_halt(struct xhci_hcd *xhci);
2101 int xhci_start(struct xhci_hcd *xhci);
2102 int xhci_reset(struct xhci_hcd *xhci, u64 timeout_us);
2117 int xhci_disable_slot(struct xhci_hcd *xhci, u32 slot_id);
2118 int xhci_ext_cap_init(struct xhci_hcd *xhci);
2120 int xhci_suspend(struct xhci_hcd *xhci, bool do_wakeup);
2121 int xhci_resume(struct xhci_hcd *xhci, pm_message_t msg);
2126 int xhci_alloc_tt_info(struct xhci_hcd *xhci,
2131 /* xHCI ring, segment, TRB, and TD functions */
2133 struct xhci_segment *trb_in_td(struct xhci_hcd *xhci,
2136 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
2137 void xhci_ring_cmd_db(struct xhci_hcd *xhci);
2138 int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
2140 int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
2142 int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
2144 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
2146 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
2148 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
2150 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
2152 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
2154 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
2157 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
2159 int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
2162 int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
2164 void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci, unsigned int slot_id,
2170 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
2172 void xhci_ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
2175 void xhci_cleanup_command_queue(struct xhci_hcd *xhci);
2176 void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring);
2179 /* xHCI roothub code */
2180 void xhci_set_link_state(struct xhci_hcd *xhci, struct xhci_port *port,
2182 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, struct xhci_port *port,
2190 void xhci_hc_died(struct xhci_hcd *xhci);
2203 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
2205 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
2207 /* xHCI contexts */
2209 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
2210 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned…
2212 struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
2216 static inline struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,  in xhci_urb_to_transfer_ring()  argument
2219 	return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,  in xhci_urb_to_transfer_ring()