1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2015 MediaTek Inc. 4 * Author: 5 * Zhigang.Wei <zhigang.wei@mediatek.com> 6 * Chunfeng.Yun <chunfeng.yun@mediatek.com> 7 */ 8 9 #ifndef _XHCI_MTK_H_ 10 #define _XHCI_MTK_H_ 11 12 #include <linux/clk.h> 13 #include <linux/hashtable.h> 14 #include <linux/regulator/consumer.h> 15 16 #include "xhci.h" 17 18 #define BULK_CLKS_NUM 6 19 #define BULK_VREGS_NUM 2 20 21 /* support at most 64 ep, use 32 size hash table */ 22 #define SCH_EP_HASH_BITS 5 23 24 /** 25 * To simplify scheduler algorithm, set a upper limit for ESIT, 26 * if a synchromous ep's ESIT is larger than @XHCI_MTK_MAX_ESIT, 27 * round down to the limit value, that means allocating more 28 * bandwidth to it. 29 */ 30 #define XHCI_MTK_MAX_ESIT (1 << 6) 31 #define XHCI_MTK_BW_INDEX(x) ((x) & (XHCI_MTK_MAX_ESIT - 1)) 32 33 /** 34 * @fs_bus_bw: array to keep track of bandwidth already used for FS 35 * @ep_list: Endpoints using this TT 36 */ 37 struct mu3h_sch_tt { 38 u32 fs_bus_bw[XHCI_MTK_MAX_ESIT]; 39 struct list_head ep_list; 40 }; 41 42 /** 43 * struct mu3h_sch_bw_info: schedule information for bandwidth domain 44 * 45 * @bus_bw: array to keep track of bandwidth already used at each uframes 46 * 47 * treat a HS root port as a bandwidth domain, but treat a SS root port as 48 * two bandwidth domains, one for IN eps and another for OUT eps. 49 */ 50 struct mu3h_sch_bw_info { 51 u32 bus_bw[XHCI_MTK_MAX_ESIT]; 52 }; 53 54 /** 55 * struct mu3h_sch_ep_info: schedule information for endpoint 56 * 57 * @esit: unit is 125us, equal to 2 << Interval field in ep-context 58 * @num_esit: number of @esit in a period 59 * @num_budget_microframes: number of continuous uframes 60 * (@repeat==1) scheduled within the interval 61 * @bw_cost_per_microframe: bandwidth cost per microframe 62 * @hentry: hash table entry 63 * @endpoint: linked into bandwidth domain which it belongs to 64 * @tt_endpoint: linked into mu3h_sch_tt's list which it belongs to 65 * @bw_info: bandwidth domain which this endpoint belongs 66 * @sch_tt: mu3h_sch_tt linked into 67 * @ep_type: endpoint type 68 * @maxpkt: max packet size of endpoint 69 * @ep: address of usb_host_endpoint struct 70 * @allocated: the bandwidth is aready allocated from bus_bw 71 * @offset: which uframe of the interval that transfer should be 72 * scheduled first time within the interval 73 * @repeat: the time gap between two uframes that transfers are 74 * scheduled within a interval. in the simple algorithm, only 75 * assign 0 or 1 to it; 0 means using only one uframe in a 76 * interval, and 1 means using @num_budget_microframes 77 * continuous uframes 78 * @pkts: number of packets to be transferred in the scheduled uframes 79 * @cs_count: number of CS that host will trigger 80 * @burst_mode: burst mode for scheduling. 0: normal burst mode, 81 * distribute the bMaxBurst+1 packets for a single burst 82 * according to @pkts and @repeat, repeate the burst multiple 83 * times; 1: distribute the (bMaxBurst+1)*(Mult+1) packets 84 * according to @pkts and @repeat. normal mode is used by 85 * default 86 */ 87 struct mu3h_sch_ep_info { 88 u32 esit; 89 u32 num_esit; 90 u32 num_budget_microframes; 91 u32 bw_cost_per_microframe; 92 struct list_head endpoint; 93 struct hlist_node hentry; 94 struct list_head tt_endpoint; 95 struct mu3h_sch_bw_info *bw_info; 96 struct mu3h_sch_tt *sch_tt; 97 u32 ep_type; 98 u32 maxpkt; 99 struct usb_host_endpoint *ep; 100 enum usb_device_speed speed; 101 bool allocated; 102 /* 103 * mtk xHCI scheduling information put into reserved DWs 104 * in ep context 105 */ 106 u32 offset; 107 u32 repeat; 108 u32 pkts; 109 u32 cs_count; 110 u32 burst_mode; 111 }; 112 113 #define MU3C_U3_PORT_MAX 4 114 #define MU3C_U2_PORT_MAX 5 115 116 /** 117 * struct mu3c_ippc_regs: MTK ssusb ip port control registers 118 * @ip_pw_ctr0~3: ip power and clock control registers 119 * @ip_pw_sts1~2: ip power and clock status registers 120 * @ip_xhci_cap: ip xHCI capability register 121 * @u3_ctrl_p[x]: ip usb3 port x control register, only low 4bytes are used 122 * @u2_ctrl_p[x]: ip usb2 port x control register, only low 4bytes are used 123 * @u2_phy_pll: usb2 phy pll control register 124 */ 125 struct mu3c_ippc_regs { 126 __le32 ip_pw_ctr0; 127 __le32 ip_pw_ctr1; 128 __le32 ip_pw_ctr2; 129 __le32 ip_pw_ctr3; 130 __le32 ip_pw_sts1; 131 __le32 ip_pw_sts2; 132 __le32 reserved0[3]; 133 __le32 ip_xhci_cap; 134 __le32 reserved1[2]; 135 __le64 u3_ctrl_p[MU3C_U3_PORT_MAX]; 136 __le64 u2_ctrl_p[MU3C_U2_PORT_MAX]; 137 __le32 reserved2; 138 __le32 u2_phy_pll; 139 __le32 reserved3[33]; /* 0x80 ~ 0xff */ 140 }; 141 142 struct xhci_hcd_mtk { 143 struct device *dev; 144 struct usb_hcd *hcd; 145 struct mu3h_sch_bw_info *sch_array; 146 struct list_head bw_ep_chk_list; 147 DECLARE_HASHTABLE(sch_ep_hash, SCH_EP_HASH_BITS); 148 struct mu3c_ippc_regs __iomem *ippc_regs; 149 int num_u2_ports; 150 int num_u3_ports; 151 int u2p_dis_msk; 152 int u3p_dis_msk; 153 struct clk_bulk_data clks[BULK_CLKS_NUM]; 154 struct regulator_bulk_data supplies[BULK_VREGS_NUM]; 155 unsigned int has_ippc:1; 156 unsigned int lpm_support:1; 157 unsigned int u2_lpm_disable:1; 158 /* usb remote wakeup */ 159 unsigned int uwk_en:1; 160 struct regmap *uwk; 161 u32 uwk_reg_base; 162 u32 uwk_vers; 163 }; 164 165 static inline struct xhci_hcd_mtk *hcd_to_mtk(struct usb_hcd *hcd) 166 { 167 return dev_get_drvdata(hcd->self.controller); 168 } 169 170 int xhci_mtk_sch_init(struct xhci_hcd_mtk *mtk); 171 void xhci_mtk_sch_exit(struct xhci_hcd_mtk *mtk); 172 int xhci_mtk_add_ep(struct usb_hcd *hcd, struct usb_device *udev, 173 struct usb_host_endpoint *ep); 174 int xhci_mtk_drop_ep(struct usb_hcd *hcd, struct usb_device *udev, 175 struct usb_host_endpoint *ep); 176 int xhci_mtk_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev); 177 void xhci_mtk_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev); 178 179 #endif /* _XHCI_MTK_H_ */ 180