1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * This is used to for host and peripheral modes of the driver for 4 * Inventra (Multidrop) Highspeed Dual-Role Controllers: (M)HDRC. 5 * 6 * Board initialization should put one of these into dev->platform_data, 7 * probably on some platform_device named "musb-hdrc". It encapsulates 8 * key configuration differences between boards. 9 */ 10 11 #ifndef __LINUX_USB_MUSB_H 12 #define __LINUX_USB_MUSB_H 13 14 /* The USB role is defined by the connector used on the board, so long as 15 * standards are being followed. (Developer boards sometimes won't.) 16 */ 17 enum musb_mode { 18 MUSB_UNDEFINED = 0, 19 MUSB_HOST, /* A or Mini-A connector */ 20 MUSB_PERIPHERAL, /* B or Mini-B connector */ 21 MUSB_OTG /* Mini-AB connector */ 22 }; 23 24 struct clk; 25 26 enum musb_fifo_style { 27 FIFO_RXTX, 28 FIFO_TX, 29 FIFO_RX 30 } __attribute__ ((packed)); 31 32 enum musb_buf_mode { 33 BUF_SINGLE, 34 BUF_DOUBLE 35 } __attribute__ ((packed)); 36 37 struct musb_fifo_cfg { 38 u8 hw_ep_num; 39 enum musb_fifo_style style; 40 enum musb_buf_mode mode; 41 u16 maxpacket; 42 }; 43 44 #define MUSB_EP_FIFO(ep, st, m, pkt) \ 45 { \ 46 .hw_ep_num = ep, \ 47 .style = st, \ 48 .mode = m, \ 49 .maxpacket = pkt, \ 50 } 51 52 #define MUSB_EP_FIFO_SINGLE(ep, st, pkt) \ 53 MUSB_EP_FIFO(ep, st, BUF_SINGLE, pkt) 54 55 #define MUSB_EP_FIFO_DOUBLE(ep, st, pkt) \ 56 MUSB_EP_FIFO(ep, st, BUF_DOUBLE, pkt) 57 58 struct musb_hdrc_eps_bits { 59 const char name[16]; 60 u8 bits; 61 }; 62 63 struct musb_hdrc_config { 64 struct musb_fifo_cfg *fifo_cfg; /* board fifo configuration */ 65 unsigned fifo_cfg_size; /* size of the fifo configuration */ 66 67 /* MUSB configuration-specific details */ 68 unsigned multipoint:1; /* multipoint device */ 69 unsigned dyn_fifo:1 __deprecated; /* supports dynamic fifo sizing */ 70 unsigned soft_con:1 __deprecated; /* soft connect required */ 71 unsigned utm_16:1 __deprecated; /* utm data witdh is 16 bits */ 72 unsigned big_endian:1; /* true if CPU uses big-endian */ 73 unsigned mult_bulk_tx:1; /* Tx ep required for multbulk pkts */ 74 unsigned mult_bulk_rx:1; /* Rx ep required for multbulk pkts */ 75 unsigned high_iso_tx:1; /* Tx ep required for HB iso */ 76 unsigned high_iso_rx:1; /* Rx ep required for HD iso */ 77 unsigned dma:1 __deprecated; /* supports DMA */ 78 unsigned vendor_req:1 __deprecated; /* vendor registers required */ 79 80 /* need to explicitly de-assert the port reset after resume? */ 81 unsigned host_port_deassert_reset_at_resume:1; 82 83 u8 num_eps; /* number of endpoints _with_ ep0 */ 84 u8 dma_channels __deprecated; /* number of dma channels */ 85 u8 dyn_fifo_size; /* dynamic size in bytes */ 86 u8 vendor_ctrl __deprecated; /* vendor control reg width */ 87 u8 vendor_stat __deprecated; /* vendor status reg witdh */ 88 u8 dma_req_chan __deprecated; /* bitmask for required dma channels */ 89 u8 ram_bits; /* ram address size */ 90 91 struct musb_hdrc_eps_bits *eps_bits __deprecated; 92 #ifdef CONFIG_BLACKFIN 93 /* A GPIO controlling VRSEL in Blackfin */ 94 unsigned int gpio_vrsel; 95 unsigned int gpio_vrsel_active; 96 /* musb CLKIN in Blackfin in MHZ */ 97 unsigned char clkin; 98 #endif 99 u32 maximum_speed; 100 }; 101 102 struct musb_hdrc_platform_data { 103 /* MUSB_HOST, MUSB_PERIPHERAL, or MUSB_OTG */ 104 u8 mode; 105 106 /* for clk_get() */ 107 const char *clock; 108 109 /* (HOST or OTG) switch VBUS on/off */ 110 int (*set_vbus)(struct device *dev, int is_on); 111 112 /* (HOST or OTG) mA/2 power supplied on (default = 8mA) */ 113 u8 power; 114 115 /* (PERIPHERAL) mA/2 max power consumed (default = 100mA) */ 116 u8 min_power; 117 118 /* (HOST or OTG) msec/2 after VBUS on till power good */ 119 u8 potpgt; 120 121 /* (HOST or OTG) program PHY for external Vbus */ 122 unsigned extvbus:1; 123 124 /* Power the device on or off */ 125 int (*set_power)(int state); 126 127 /* MUSB configuration-specific details */ 128 const struct musb_hdrc_config *config; 129 130 /* Architecture specific board data */ 131 void *board_data; 132 133 /* Platform specific struct musb_ops pointer */ 134 const void *platform_ops; 135 }; 136 137 enum musb_vbus_id_status { 138 MUSB_UNKNOWN = 0, 139 MUSB_ID_GROUND, 140 MUSB_ID_FLOAT, 141 MUSB_VBUS_VALID, 142 MUSB_VBUS_OFF, 143 }; 144 145 #if IS_ENABLED(CONFIG_USB_MUSB_HDRC) 146 int musb_mailbox(enum musb_vbus_id_status status); 147 #else 148 static inline int musb_mailbox(enum musb_vbus_id_status status) 149 { 150 return 0; 151 } 152 #endif 153 154 /* TUSB 6010 support */ 155 156 #define TUSB6010_OSCCLK_60 16667 /* psec/clk @ 60.0 MHz */ 157 #define TUSB6010_REFCLK_24 41667 /* psec/clk @ 24.0 MHz XI */ 158 #define TUSB6010_REFCLK_19 52083 /* psec/clk @ 19.2 MHz CLKIN */ 159 160 #ifdef CONFIG_ARCH_OMAP2 161 162 extern int __init tusb6010_setup_interface( 163 struct musb_hdrc_platform_data *data, 164 unsigned ps_refclk, unsigned waitpin, 165 unsigned async_cs, unsigned sync_cs, 166 unsigned irq, unsigned dmachan); 167 168 extern int tusb6010_platform_retime(unsigned is_refclk); 169 170 #endif /* OMAP2 */ 171 172 #endif /* __LINUX_USB_MUSB_H */ 173