phy/broadcom/phy-brcm-usb-init.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright (C) 2014-2017 Broadcom
0004  */
0005
0006 #ifndef _USB_BRCM_COMMON_INIT_H
0007 #define _USB_BRCM_COMMON_INIT_H
0008
0009 #include <linux/regmap.h>
0010
0011 #define USB_CTLR_MODE_HOST 0
0012 #define USB_CTLR_MODE_DEVICE 1
0013 #define USB_CTLR_MODE_DRD 2
0014 #define USB_CTLR_MODE_TYPEC_PD 3
0015
0016 enum brcmusb_reg_sel {
0017     BRCM_REGS_CTRL = 0,
0018     BRCM_REGS_XHCI_EC,
0019     BRCM_REGS_XHCI_GBL,
0020     BRCM_REGS_USB_PHY,
0021     BRCM_REGS_USB_MDIO,
0022     BRCM_REGS_BDC_EC,
0023     BRCM_REGS_MAX
0024 };
0025
0026 #define USB_CTRL_REG(base, reg) ((void __iomem *)base + USB_CTRL_##reg)
0027 #define USB_XHCI_EC_REG(base, reg) ((void __iomem *)base + USB_XHCI_EC_##reg)
0028 #define USB_CTRL_MASK(reg, field) \
0029     USB_CTRL_##reg##_##field##_MASK
0030 #define USB_CTRL_SET(base, reg, field)  \
0031     brcm_usb_ctrl_set(USB_CTRL_REG(base, reg),  \
0032               USB_CTRL_##reg##_##field##_MASK)
0033 #define USB_CTRL_UNSET(base, reg, field)    \
0034     brcm_usb_ctrl_unset(USB_CTRL_REG(base, reg),        \
0035                 USB_CTRL_##reg##_##field##_MASK)
0036
0037 struct  brcm_usb_init_params;
0038
0039 struct brcm_usb_init_ops {
0040     void (*init_ipp)(struct brcm_usb_init_params *params);
0041     void (*init_common)(struct brcm_usb_init_params *params);
0042     void (*init_eohci)(struct brcm_usb_init_params *params);
0043     void (*init_xhci)(struct brcm_usb_init_params *params);
0044     void (*uninit_common)(struct brcm_usb_init_params *params);
0045     void (*uninit_eohci)(struct brcm_usb_init_params *params);
0046     void (*uninit_xhci)(struct brcm_usb_init_params *params);
0047     int  (*get_dual_select)(struct brcm_usb_init_params *params);
0048     void (*set_dual_select)(struct brcm_usb_init_params *params, int mode);
0049 };
0050
0051 struct  brcm_usb_init_params {
0052     void __iomem *regs[BRCM_REGS_MAX];
0053     int ioc;
0054     int ipp;
0055     int mode;
0056     u32 family_id;
0057     u32 product_id;
0058     int selected_family;
0059     const char *family_name;
0060     const u32 *usb_reg_bits_map;
0061     const struct brcm_usb_init_ops *ops;
0062     struct regmap *syscon_piarbctl;
0063     bool wake_enabled;
0064     bool suspend_with_clocks;
0065 };
0066
0067 void brcm_usb_dvr_init_4908(struct brcm_usb_init_params *params);
0068 void brcm_usb_dvr_init_7445(struct brcm_usb_init_params *params);
0069 void brcm_usb_dvr_init_7216(struct brcm_usb_init_params *params);
0070 void brcm_usb_dvr_init_7211b0(struct brcm_usb_init_params *params);
0071
0072 static inline u32 brcm_usb_readl(void __iomem *addr)
0073 {
0074     /*
0075      * MIPS endianness is configured by boot strap, which also reverses all
0076      * bus endianness (i.e., big-endian CPU + big endian bus ==> native
0077      * endian I/O).
0078      *
0079      * Other architectures (e.g., ARM) either do not support big endian, or
0080      * else leave I/O in little endian mode.
0081      */
0082     if (IS_ENABLED(CONFIG_MIPS) && IS_ENABLED(CONFIG_CPU_BIG_ENDIAN))
0083         return __raw_readl(addr);
0084     else
0085         return readl_relaxed(addr);
0086 }
0087
0088 static inline void brcm_usb_writel(u32 val, void __iomem *addr)
0089 {
0090     /* See brcmnand_readl() comments */
0091     if (IS_ENABLED(CONFIG_MIPS) && IS_ENABLED(CONFIG_CPU_BIG_ENDIAN))
0092         __raw_writel(val, addr);
0093     else
0094         writel_relaxed(val, addr);
0095 }
0096
0097 static inline void brcm_usb_ctrl_unset(void __iomem *reg, u32 mask)
0098 {
0099     brcm_usb_writel(brcm_usb_readl(reg) & ~(mask), reg);
0100 };
0101
0102 static inline void brcm_usb_ctrl_set(void __iomem *reg, u32 mask)
0103 {
0104     brcm_usb_writel(brcm_usb_readl(reg) | (mask), reg);
0105 };
0106
0107 static inline void brcm_usb_init_ipp(struct brcm_usb_init_params *ini)
0108 {
0109     if (ini->ops->init_ipp)
0110         ini->ops->init_ipp(ini);
0111 }
0112
0113 static inline void brcm_usb_init_common(struct brcm_usb_init_params *ini)
0114 {
0115     if (ini->ops->init_common)
0116         ini->ops->init_common(ini);
0117 }
0118
0119 static inline void brcm_usb_init_eohci(struct brcm_usb_init_params *ini)
0120 {
0121     if (ini->ops->init_eohci)
0122         ini->ops->init_eohci(ini);
0123 }
0124
0125 static inline void brcm_usb_init_xhci(struct brcm_usb_init_params *ini)
0126 {
0127     if (ini->ops->init_xhci)
0128         ini->ops->init_xhci(ini);
0129 }
0130
0131 static inline void brcm_usb_uninit_common(struct brcm_usb_init_params *ini)
0132 {
0133     if (ini->ops->uninit_common)
0134         ini->ops->uninit_common(ini);
0135 }
0136
0137 static inline void brcm_usb_uninit_eohci(struct brcm_usb_init_params *ini)
0138 {
0139     if (ini->ops->uninit_eohci)
0140         ini->ops->uninit_eohci(ini);
0141 }
0142
0143 static inline void brcm_usb_uninit_xhci(struct brcm_usb_init_params *ini)
0144 {
0145     if (ini->ops->uninit_xhci)
0146         ini->ops->uninit_xhci(ini);
0147 }
0148
0149 static inline int brcm_usb_get_dual_select(struct brcm_usb_init_params *ini)
0150 {
0151     if (ini->ops->get_dual_select)
0152         return ini->ops->get_dual_select(ini);
0153     return 0;
0154 }
0155
0156 static inline void brcm_usb_set_dual_select(struct brcm_usb_init_params *ini,
0157     int mode)
0158 {
0159     if (ini->ops->set_dual_select)
0160         ini->ops->set_dual_select(ini, mode);
0161 }
0162
0163 #endif /* _USB_BRCM_COMMON_INIT_H */