drivers/usb/host/xhci-mtk.h

   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 #define UFRAMES_PER_FRAME       8
  34 #define XHCI_MTK_FRAMES_CNT     (XHCI_MTK_MAX_ESIT / UFRAMES_PER_FRAME)
  35
  36 /**
  37  * @fs_bus_bw_out: save bandwidth used by FS/LS OUT eps in each uframes
  38  * @fs_bus_bw_in: save bandwidth used by FS/LS IN eps in each uframes
  39  * @ls_bus_bw: save bandwidth used by LS eps in each uframes
  40  * @fs_frame_bw: save bandwidth used by FS/LS eps in each FS frames
  41  * @in_ss_cnt: the count of Start-Split for IN eps
  42  * @ep_list: Endpoints using this TT
  43  */
  44 struct mu3h_sch_tt {
  45         u16 fs_bus_bw_out[XHCI_MTK_MAX_ESIT];
  46         u16 fs_bus_bw_in[XHCI_MTK_MAX_ESIT];
  47         u8 ls_bus_bw[XHCI_MTK_MAX_ESIT];
  48         u16 fs_frame_bw[XHCI_MTK_FRAMES_CNT];
  49         u8 in_ss_cnt[XHCI_MTK_MAX_ESIT];
  50         struct list_head ep_list;
  51 };
  52
  53 /**
  54  * struct mu3h_sch_bw_info: schedule information for bandwidth domain
  55  *
  56  * @bus_bw: array to keep track of bandwidth already used at each uframes
  57  *
  58  * treat a HS root port as a bandwidth domain, but treat a SS root port as
  59  * two bandwidth domains, one for IN eps and another for OUT eps.
  60  */
  61 struct mu3h_sch_bw_info {
  62         u32 bus_bw[XHCI_MTK_MAX_ESIT];
  63 };
  64
  65 /**
  66  * struct mu3h_sch_ep_info: schedule information for endpoint
  67  *
  68  * @esit: unit is 125us, equal to 2 << Interval field in ep-context
  69  * @num_esit: number of @esit in a period
  70  * @num_budget_microframes: number of continuous uframes
  71  *              (@repeat==1) scheduled within the interval
  72  * @hentry: hash table entry
  73  * @endpoint: linked into bandwidth domain which it belongs to
  74  * @tt_endpoint: linked into mu3h_sch_tt's list which it belongs to
  75  * @bw_info: bandwidth domain which this endpoint belongs
  76  * @sch_tt: mu3h_sch_tt linked into
  77  * @ep_type: endpoint type
  78  * @maxpkt: max packet size of endpoint
  79  * @ep: address of usb_host_endpoint struct
  80  * @allocated: the bandwidth is aready allocated from bus_bw
  81  * @offset: which uframe of the interval that transfer should be
  82  *              scheduled first time within the interval
  83  * @repeat: the time gap between two uframes that transfers are
  84  *              scheduled within a interval. in the simple algorithm, only
  85  *              assign 0 or 1 to it; 0 means using only one uframe in a
  86  *              interval, and 1 means using @num_budget_microframes
  87  *              continuous uframes
  88  * @pkts: number of packets to be transferred in the scheduled uframes
  89  * @cs_count: number of CS that host will trigger
  90  * @burst_mode: burst mode for scheduling. 0: normal burst mode,
  91  *              distribute the bMaxBurst+1 packets for a single burst
  92  *              according to @pkts and @repeat, repeate the burst multiple
  93  *              times; 1: distribute the (bMaxBurst+1)*(Mult+1) packets
  94  *              according to @pkts and @repeat. normal mode is used by
  95  *              default
  96  * @bw_budget_table: table to record bandwidth budget per microframe
  97  */
  98 struct mu3h_sch_ep_info {
  99         u32 esit;
 100         u32 num_esit;
 101         u32 num_budget_microframes;
 102         struct list_head endpoint;
 103         struct hlist_node hentry;
 104         struct list_head tt_endpoint;
 105         struct mu3h_sch_bw_info *bw_info;
 106         struct mu3h_sch_tt *sch_tt;
 107         u32 ep_type;
 108         u32 maxpkt;
 109         struct usb_host_endpoint *ep;
 110         enum usb_device_speed speed;
 111         bool allocated;
 112         /*
 113          * mtk xHCI scheduling information put into reserved DWs
 114          * in ep context
 115          */
 116         u32 offset;
 117         u32 repeat;
 118         u32 pkts;
 119         u32 cs_count;
 120         u32 burst_mode;
 121         u32 bw_budget_table[];
 122 };
 123
 124 #define MU3C_U3_PORT_MAX 4
 125 #define MU3C_U2_PORT_MAX 5
 126
 127 /**
 128  * struct mu3c_ippc_regs: MTK ssusb ip port control registers
 129  * @ip_pw_ctr0~3: ip power and clock control registers
 130  * @ip_pw_sts1~2: ip power and clock status registers
 131  * @ip_xhci_cap: ip xHCI capability register
 132  * @u3_ctrl_p[x]: ip usb3 port x control register, only low 4bytes are used
 133  * @u2_ctrl_p[x]: ip usb2 port x control register, only low 4bytes are used
 134  * @u2_phy_pll: usb2 phy pll control register
 135  */
 136 struct mu3c_ippc_regs {
 137         __le32 ip_pw_ctr0;
 138         __le32 ip_pw_ctr1;
 139         __le32 ip_pw_ctr2;
 140         __le32 ip_pw_ctr3;
 141         __le32 ip_pw_sts1;
 142         __le32 ip_pw_sts2;
 143         __le32 reserved0[3];
 144         __le32 ip_xhci_cap;
 145         __le32 reserved1[2];
 146         __le64 u3_ctrl_p[MU3C_U3_PORT_MAX];
 147         __le64 u2_ctrl_p[MU3C_U2_PORT_MAX];
 148         __le32 reserved2;
 149         __le32 u2_phy_pll;
 150         __le32 reserved3[33]; /* 0x80 ~ 0xff */
 151 };
 152
 153 struct xhci_hcd_mtk {
 154         struct device *dev;
 155         struct usb_hcd *hcd;
 156         struct mu3h_sch_bw_info *sch_array;
 157         struct list_head bw_ep_chk_list;
 158         DECLARE_HASHTABLE(sch_ep_hash, SCH_EP_HASH_BITS);
 159         struct mu3c_ippc_regs __iomem *ippc_regs;
 160         int num_u2_ports;
 161         int num_u3_ports;
 162         int u2p_dis_msk;
 163         int u3p_dis_msk;
 164         struct clk_bulk_data clks[BULK_CLKS_NUM];
 165         struct regulator_bulk_data supplies[BULK_VREGS_NUM];
 166         unsigned int has_ippc:1;
 167         unsigned int lpm_support:1;
 168         unsigned int u2_lpm_disable:1;
 169         /* usb remote wakeup */
 170         unsigned int uwk_en:1;
 171         struct regmap *uwk;
 172         u32 uwk_reg_base;
 173         u32 uwk_vers;
 174         /* quirk */
 175         u32 rxfifo_depth;
 176 };
 177
 178 static inline struct xhci_hcd_mtk *hcd_to_mtk(struct usb_hcd *hcd)
 179 {
 180         return dev_get_drvdata(hcd->self.controller);
 181 }
 182
 183 int xhci_mtk_sch_init(struct xhci_hcd_mtk *mtk);
 184 void xhci_mtk_sch_exit(struct xhci_hcd_mtk *mtk);
 185 int xhci_mtk_add_ep(struct usb_hcd *hcd, struct usb_device *udev,
 186                     struct usb_host_endpoint *ep);
 187 int xhci_mtk_drop_ep(struct usb_hcd *hcd, struct usb_device *udev,
 188                      struct usb_host_endpoint *ep);
 189 int xhci_mtk_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
 190 void xhci_mtk_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
 191
 192 #endif          /* _XHCI_MTK_H_ */