1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Freescale QUICC Engine USB Host Controller Driver
5 * Copyright (c) Freescale Semicondutor, Inc. 2006.
6 * Shlomi Gridish <gridish@freescale.com>
7 * Jerry Huang <Chang-Ming.Huang@freescale.com>
8 * Copyright (c) Logic Product Development, Inc. 2007
9 * Peter Barada <peterb@logicpd.com>
10 * Copyright (c) MontaVista Software, Inc. 2008.
11 * Anton Vorontsov <avorontsov@ru.mvista.com>
17 #include <linux/kernel.h>
18 #include <linux/types.h>
19 #include <linux/bug.h>
20 #include <linux/spinlock.h>
21 #include <linux/interrupt.h>
22 #include <linux/kfifo.h>
24 #include <linux/usb.h>
25 #include <linux/usb/hcd.h>
26 #include <linux/gpio/consumer.h>
27 #include <soc/fsl/qe/qe.h>
28 #include <soc/fsl/qe/immap_qe.h>
30 #define USB_CLOCK 48000000
32 #define FHCI_PRAM_SIZE 0x100
38 /* CRC16 field size */
41 /* USB protocol overhead for each frame transmitted from the host */
42 #define PROTOCOL_OVERHEAD 7
44 /* Packet structure, info field */
45 #define PKT_PID_DATA0 0x80000000 /* PID - Data toggle zero */
46 #define PKT_PID_DATA1 0x40000000 /* PID - Data toggle one */
47 #define PKT_PID_SETUP 0x20000000 /* PID - Setup bit */
48 #define PKT_SETUP_STATUS 0x10000000 /* Setup status bit */
49 #define PKT_SETADDR_STATUS 0x08000000 /* Set address status bit */
50 #define PKT_SET_HOST_LAST 0x04000000 /* Last data packet */
51 #define PKT_HOST_DATA 0x02000000 /* Data packet */
52 #define PKT_FIRST_IN_FRAME 0x01000000 /* First packet in the frame */
53 #define PKT_TOKEN_FRAME 0x00800000 /* Token packet */
54 #define PKT_ZLP 0x00400000 /* Zero length packet */
55 #define PKT_IN_TOKEN_FRAME 0x00200000 /* IN token packet */
56 #define PKT_OUT_TOKEN_FRAME 0x00100000 /* OUT token packet */
57 #define PKT_SETUP_TOKEN_FRAME 0x00080000 /* SETUP token packet */
58 #define PKT_STALL_FRAME 0x00040000 /* STALL packet */
59 #define PKT_NACK_FRAME 0x00020000 /* NACK packet */
60 #define PKT_NO_PID 0x00010000 /* No PID */
61 #define PKT_NO_CRC 0x00008000 /* don't append CRC */
62 #define PKT_HOST_COMMAND 0x00004000 /* Host command packet */
63 #define PKT_DUMMY_PACKET 0x00002000 /* Dummy packet, used for mmm */
64 #define PKT_LOW_SPEED_PACKET 0x00001000 /* Low-Speed packet */
67 #define TRANS_INPROGRESS (-1)
68 #define TRANS_DISCARD (-2)
69 #define TRANS_FAIL (-3)
72 #define PS_DISCONNECTED 1
73 #define PS_CONNECTED 2
77 /* Transfer Descriptor status field */
78 #define USB_TD_OK 0x00000000 /* TD transmited or received ok */
79 #define USB_TD_INPROGRESS 0x80000000 /* TD is being transmitted */
80 #define USB_TD_RX_ER_NONOCT 0x40000000 /* Tx Non Octet Aligned Packet */
81 #define USB_TD_RX_ER_BITSTUFF 0x20000000 /* Frame Aborted-Received pkt */
82 #define USB_TD_RX_ER_CRC 0x10000000 /* CRC error */
83 #define USB_TD_RX_ER_OVERUN 0x08000000 /* Over - run occurred */
84 #define USB_TD_RX_ER_PID 0x04000000 /* wrong PID received */
85 #define USB_TD_RX_DATA_UNDERUN 0x02000000 /* shorter than expected */
86 #define USB_TD_RX_DATA_OVERUN 0x01000000 /* longer than expected */
87 #define USB_TD_TX_ER_NAK 0x00800000 /* NAK handshake */
88 #define USB_TD_TX_ER_STALL 0x00400000 /* STALL handshake */
89 #define USB_TD_TX_ER_TIMEOUT 0x00200000 /* transmit time out */
90 #define USB_TD_TX_ER_UNDERUN 0x00100000 /* transmit underrun */
92 #define USB_TD_ERROR (USB_TD_RX_ER_NONOCT | USB_TD_RX_ER_BITSTUFF | \
93 USB_TD_RX_ER_CRC | USB_TD_RX_ER_OVERUN | USB_TD_RX_ER_PID | \
94 USB_TD_RX_DATA_UNDERUN | USB_TD_RX_DATA_OVERUN | \
95 USB_TD_TX_ER_NAK | USB_TD_TX_ER_STALL | \
96 USB_TD_TX_ER_TIMEOUT | USB_TD_TX_ER_UNDERUN)
98 /* Transfer Descriptor toggle field */
99 #define USB_TD_TOGGLE_DATA0 0
100 #define USB_TD_TOGGLE_DATA1 1
101 #define USB_TD_TOGGLE_CARRY 2
103 /* #define MULTI_DATA_BUS */
105 /* Bus mode register RBMR/TBMR */
106 #define BUS_MODE_GBL 0x20 /* Global snooping */
107 #define BUS_MODE_BO 0x18 /* Byte ordering */
108 #define BUS_MODE_BO_BE 0x10 /* Byte ordering - Big-endian */
109 #define BUS_MODE_DTB 0x02 /* Data bus */
111 /* FHCI QE USB Register Description */
113 /* USB Mode Register bit define */
114 #define USB_MODE_EN 0x01
115 #define USB_MODE_HOST 0x02
116 #define USB_MODE_TEST 0x04
117 #define USB_MODE_SFTE 0x08
118 #define USB_MODE_RESUME 0x40
119 #define USB_MODE_LSS 0x80
121 /* USB Slave Address Register Mask */
122 #define USB_SLVADDR_MASK 0x7F
124 /* USB Endpoint register define */
125 #define USB_EPNUM_MASK 0xF000
126 #define USB_EPNUM_SHIFT 12
128 #define USB_TRANS_MODE_SHIFT 8
129 #define USB_TRANS_CTR 0x0000
130 #define USB_TRANS_INT 0x0100
131 #define USB_TRANS_BULK 0x0200
132 #define USB_TRANS_ISO 0x0300
134 #define USB_EP_MF 0x0020
135 #define USB_EP_RTE 0x0010
137 #define USB_THS_SHIFT 2
138 #define USB_THS_MASK 0x000c
139 #define USB_THS_NORMAL 0x0
140 #define USB_THS_IGNORE_IN 0x0004
141 #define USB_THS_NACK 0x0008
142 #define USB_THS_STALL 0x000c
144 #define USB_RHS_SHIFT 0
145 #define USB_RHS_MASK 0x0003
146 #define USB_RHS_NORMAL 0x0
147 #define USB_RHS_IGNORE_OUT 0x0001
148 #define USB_RHS_NACK 0x0002
149 #define USB_RHS_STALL 0x0003
151 #define USB_RTHS_MASK 0x000f
153 /* USB Command Register define */
154 #define USB_CMD_STR_FIFO 0x80
155 #define USB_CMD_FLUSH_FIFO 0x40
156 #define USB_CMD_ISFT 0x20
157 #define USB_CMD_DSFT 0x10
158 #define USB_CMD_EP_MASK 0x03
160 /* USB Event and Mask Register define */
161 #define USB_E_MSF_MASK 0x0800
162 #define USB_E_SFT_MASK 0x0400
163 #define USB_E_RESET_MASK 0x0200
164 #define USB_E_IDLE_MASK 0x0100
165 #define USB_E_TXE4_MASK 0x0080
166 #define USB_E_TXE3_MASK 0x0040
167 #define USB_E_TXE2_MASK 0x0020
168 #define USB_E_TXE1_MASK 0x0010
169 #define USB_E_SOF_MASK 0x0008
170 #define USB_E_BSY_MASK 0x0004
171 #define USB_E_TXB_MASK 0x0002
172 #define USB_E_RXB_MASK 0x0001
174 /* Freescale USB HOST */
176 __be16 ep_ptr[4]; /* Endpoint porter reg */
177 __be32 rx_state; /* Rx internal state */
178 __be32 rx_ptr; /* Rx internal data pointer */
179 __be16 frame_num; /* Frame number */
180 __be16 rx_cnt; /* Rx byte count */
181 __be32 rx_temp; /* Rx temp */
182 __be32 rx_data_temp; /* Rx data temp */
183 __be16 rx_u_ptr; /* Rx microcode return address temp */
184 u8 reserved1[2]; /* reserved area */
185 __be32 sof_tbl; /* SOF lookup table pointer */
186 u8 sof_u_crc_temp; /* SOF micorcode CRC5 temp reg */
190 /* Freescale USB Endpoint*/
191 struct fhci_ep_pram {
192 __be16 rx_base; /* Rx BD base address */
193 __be16 tx_base; /* Tx BD base address */
194 u8 rx_func_code; /* Rx function code */
195 u8 tx_func_code; /* Tx function code */
196 __be16 rx_buff_len; /* Rx buffer length */
197 __be16 rx_bd_ptr; /* Rx BD pointer */
198 __be16 tx_bd_ptr; /* Tx BD pointer */
199 __be32 tx_state; /* Tx internal state */
200 __be32 tx_ptr; /* Tx internal data pointer */
201 __be16 tx_crc; /* temp transmit CRC */
202 __be16 tx_cnt; /* Tx byte count */
203 __be32 tx_temp; /* Tx temp */
204 __be16 tx_u_ptr; /* Tx microcode return address temp */
208 struct fhci_controller_list {
209 struct list_head ctrl_list; /* control endpoints */
210 struct list_head bulk_list; /* bulk endpoints */
211 struct list_head iso_list; /* isochronous endpoints */
212 struct list_head intr_list; /* interruput endpoints */
213 struct list_head done_list; /* done transfers */
216 struct virtual_root_hub {
217 int dev_num; /* USB address of the root hub */
218 u32 feature; /* indicates what feature has been set */
219 struct usb_hub_status hub;
220 struct usb_port_status port;
229 /* these are optional */
243 enum qe_clock fullspeed_clk;
244 enum qe_clock lowspeed_clk;
245 struct qe_pin *pins[NUM_PINS];
246 struct gpio_desc *gpiods[NUM_GPIOS];
248 struct qe_usb_ctlr __iomem *regs; /* I/O memory used to communicate */
249 struct fhci_pram __iomem *pram; /* Parameter RAM */
250 struct gtm_timer *timer;
253 struct fhci_usb *usb_lld; /* Low-level driver */
254 struct virtual_root_hub *vroot_hub; /* the virtual root hub */
256 struct fhci_controller_list *hc_list;
257 struct tasklet_struct *process_done_task; /* tasklet for done list */
259 struct list_head empty_eds;
260 struct list_head empty_tds;
262 #ifdef CONFIG_FHCI_DEBUG
263 int usb_irq_stat[13];
264 struct dentry *dfs_root;
268 #define USB_FRAME_USAGE 90
269 #define FRAME_TIME_USAGE (USB_FRAME_USAGE*10) /* frame time usage */
270 #define SW_FIX_TIME_BETWEEN_TRANSACTION 150 /* SW */
271 #define MAX_BYTES_PER_FRAME (USB_FRAME_USAGE*15)
272 #define MAX_PERIODIC_FRAME_USAGE 90
274 /* transaction type */
276 FHCI_TA_IN = 0, /* input transaction */
277 FHCI_TA_OUT, /* output transaction */
278 FHCI_TA_SETUP, /* setup transaction */
296 FHCI_ED_NEW = 0, /* pipe is new */
297 FHCI_ED_OPER, /* pipe is operating */
298 FHCI_ED_URB_DEL, /* pipe is in hold because urb is being deleted */
299 FHCI_ED_SKIP, /* skip this pipe */
300 FHCI_ED_HALTED, /* pipe is halted */
303 enum fhci_port_status {
304 FHCI_PORT_POWER_OFF = 0,
306 FHCI_PORT_DISCONNECTING,
307 FHCI_PORT_WAITING, /* waiting for connection */
308 FHCI_PORT_FULL, /* full speed connected */
309 FHCI_PORT_LOW, /* low speed connected */
312 enum fhci_mem_alloc {
313 MEM_CACHABLE_SYS = 0x00000001, /* primary DDR,cachable */
314 MEM_NOCACHE_SYS = 0x00000004, /* primary DDR,non-cachable */
315 MEM_SECONDARY = 0x00000002, /* either secondary DDR or SDRAM */
316 MEM_PRAM = 0x00000008, /* multi-user RAM identifier */
319 /* USB default parameters*/
320 #define DEFAULT_RING_LEN 8
321 #define DEFAULT_DATA_MEM MEM_CACHABLE_SYS
324 u8 dev_addr; /* device address */
325 u8 ep_addr; /* endpoint address */
326 enum fhci_tf_mode mode; /* USB transfer mode */
327 enum fhci_speed speed;
328 unsigned int max_pkt_size;
329 enum fhci_ed_state state;
330 struct list_head td_list; /* a list of all queued TD to this pipe */
331 struct list_head node;
333 /* read only parameters, should be cleared upon initialization */
334 u8 toggle_carry; /* toggle carry from the last TD submitted */
335 u16 next_iso; /* time stamp of next queued ISO transfer */
336 struct td *td_head; /* a pointer to the current TD handled */
340 void *data; /* a pointer to the data buffer */
341 unsigned int len; /* length of the data to be submitted */
342 unsigned int actual_len; /* actual bytes transferred on this td */
343 enum fhci_ta_type type; /* transaction type */
344 u8 toggle; /* toggle for next trans. within this TD */
345 u16 iso_index; /* ISO transaction index */
346 u16 start_frame; /* start frame time stamp */
347 u16 interval; /* interval between trans. (for ISO/Intr) */
348 u32 status; /* status of the TD */
349 struct ed *ed; /* a handle to the corresponding ED */
350 struct urb *urb; /* a handle to the corresponding URB */
351 bool ioc; /* Inform On Completion */
352 struct list_head node;
354 /* read only parameters should be cleared upon initialization */
358 struct list_head frame_lh;
362 u8 *data; /* packet data */
363 u32 len; /* packet length */
364 u32 status; /* status of the packet - equivalent to the status
365 * field for the corresponding structure td */
366 u32 info; /* packet information */
367 void __iomem *priv_data; /* private data of the driver (TDs or BDs) */
370 /* struct for each URB */
371 #define URB_INPROGRESS 0
374 /* URB states (state field) */
378 /* three setup states */
379 #define US_CTRL_SETUP 2
380 #define US_CTRL_DATA 1
381 #define US_CTRL_ACK 0
392 struct timer_list time_out;
396 /* Pointer to ep parameter RAM */
397 struct fhci_ep_pram __iomem *ep_pram_ptr;
399 /* Host transactions */
400 struct usb_td __iomem *td_base; /* first TD in the ring */
401 struct usb_td __iomem *conf_td; /* next TD for confirm after transac */
402 struct usb_td __iomem *empty_td;/* next TD for new transaction req. */
403 struct kfifo empty_frame_Q; /* Empty frames list to use */
404 struct kfifo conf_frame_Q; /* frames passed to TDs,waiting for tx */
405 struct kfifo dummy_packets_Q;/* dummy packets for the CRC overun */
407 bool already_pushed_dummy_bd;
410 /* struct for each 1mSec frame time */
411 #define FRAME_IS_TRANSMITTED 0x00
412 #define FRAME_TIMER_END_TRANSMISSION 0x01
413 #define FRAME_DATA_END_TRANSMISSION 0x02
414 #define FRAME_END_TRANSMISSION 0x03
415 #define FRAME_IS_PREPARED 0x04
417 struct fhci_time_frame {
418 u16 frame_num; /* frame number */
419 u16 total_bytes; /* total bytes submitted within this frame */
420 u8 frame_status; /* flag that indicates to stop fill this frame */
421 struct list_head tds_list; /* all tds of this frame */
424 /* internal driver structure*/
426 u16 saved_msk; /* saving of the USB mask register */
427 struct endpoint *ep0; /* pointer for endpoint0 structure */
428 int intr_nesting_cnt; /* interrupt nesting counter */
429 u16 max_frame_usage; /* max frame time usage,in micro-sec */
430 u16 max_bytes_per_frame; /* max byte can be tx in one time frame */
431 u32 sw_transaction_time; /* sw complete trans time,in micro-sec */
432 struct fhci_time_frame *actual_frame;
433 struct fhci_controller_list *hc_list; /* main structure for hc */
434 struct virtual_root_hub *vroot_hub;
435 enum fhci_port_status port_status; /* v_rh port status */
437 u32 (*transfer_confirm)(struct fhci_hcd *fhci);
439 struct fhci_hcd *fhci;
443 * Various helpers and prototypes below.
446 static inline u16 get_frame_num(struct fhci_hcd *fhci)
448 return in_be16(&fhci->pram->frame_num) & 0x07ff;
451 #define fhci_dbg(fhci, fmt, args...) \
452 dev_dbg(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
453 #define fhci_vdbg(fhci, fmt, args...) \
454 dev_vdbg(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
455 #define fhci_err(fhci, fmt, args...) \
456 dev_err(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
457 #define fhci_info(fhci, fmt, args...) \
458 dev_info(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
459 #define fhci_warn(fhci, fmt, args...) \
460 dev_warn(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
462 static inline struct fhci_hcd *hcd_to_fhci(struct usb_hcd *hcd)
464 return (struct fhci_hcd *)hcd->hcd_priv;
467 static inline struct usb_hcd *fhci_to_hcd(struct fhci_hcd *fhci)
469 return container_of((void *)fhci, struct usb_hcd, hcd_priv);
472 /* fifo of pointers */
473 static inline int cq_new(struct kfifo *fifo, int size)
475 return kfifo_alloc(fifo, size * sizeof(void *), GFP_KERNEL);
478 static inline void cq_delete(struct kfifo *kfifo)
483 static inline unsigned int cq_howmany(struct kfifo *kfifo)
485 return kfifo_len(kfifo) / sizeof(void *);
488 static inline int cq_put(struct kfifo *kfifo, void *p)
490 return kfifo_in(kfifo, (void *)&p, sizeof(p));
493 static inline void *cq_get(struct kfifo *kfifo)
498 sz = kfifo_out(kfifo, (void *)&p, sizeof(p));
506 void fhci_start_sof_timer(struct fhci_hcd *fhci);
507 void fhci_stop_sof_timer(struct fhci_hcd *fhci);
508 u16 fhci_get_sof_timer_count(struct fhci_usb *usb);
509 void fhci_usb_enable_interrupt(struct fhci_usb *usb);
510 void fhci_usb_disable_interrupt(struct fhci_usb *usb);
511 int fhci_ioports_check_bus_state(struct fhci_hcd *fhci);
514 void fhci_recycle_empty_td(struct fhci_hcd *fhci, struct td *td);
515 void fhci_recycle_empty_ed(struct fhci_hcd *fhci, struct ed *ed);
516 struct ed *fhci_get_empty_ed(struct fhci_hcd *fhci);
517 struct td *fhci_td_fill(struct fhci_hcd *fhci, struct urb *urb,
518 struct urb_priv *urb_priv, struct ed *ed, u16 index,
519 enum fhci_ta_type type, int toggle, u8 *data, u32 len,
520 u16 interval, u16 start_frame, bool ioc);
521 void fhci_add_tds_to_ed(struct ed *ed, struct td **td_list, int number);
524 void fhci_config_transceiver(struct fhci_hcd *fhci,
525 enum fhci_port_status status);
526 void fhci_port_disable(struct fhci_hcd *fhci);
527 void fhci_port_enable(void *lld);
528 void fhci_io_port_generate_reset(struct fhci_hcd *fhci);
529 void fhci_port_reset(void *lld);
530 int fhci_hub_status_data(struct usb_hcd *hcd, char *buf);
531 int fhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
532 u16 wIndex, char *buf, u16 wLength);
535 void fhci_flush_bds(struct fhci_usb *usb);
536 void fhci_flush_actual_frame(struct fhci_usb *usb);
537 u32 fhci_host_transaction(struct fhci_usb *usb, struct packet *pkt,
538 enum fhci_ta_type trans_type, u8 dest_addr,
539 u8 dest_ep, enum fhci_tf_mode trans_mode,
540 enum fhci_speed dest_speed, u8 data_toggle);
541 void fhci_host_transmit_actual_frame(struct fhci_usb *usb);
542 void fhci_tx_conf_interrupt(struct fhci_usb *usb);
543 void fhci_push_dummy_bd(struct endpoint *ep);
544 u32 fhci_create_ep(struct fhci_usb *usb, enum fhci_mem_alloc data_mem,
546 void fhci_init_ep_registers(struct fhci_usb *usb,
548 enum fhci_mem_alloc data_mem);
549 void fhci_ep0_free(struct fhci_usb *usb);
552 extern struct tasklet_struct fhci_tasklet;
553 void fhci_transaction_confirm(struct fhci_usb *usb, struct packet *pkt);
554 void fhci_flush_all_transmissions(struct fhci_usb *usb);
555 void fhci_schedule_transactions(struct fhci_usb *usb);
556 void fhci_device_connected_interrupt(struct fhci_hcd *fhci);
557 void fhci_device_disconnected_interrupt(struct fhci_hcd *fhci);
558 void fhci_queue_urb(struct fhci_hcd *fhci, struct urb *urb);
559 u32 fhci_transfer_confirm_callback(struct fhci_hcd *fhci);
560 irqreturn_t fhci_irq(struct usb_hcd *hcd);
561 irqreturn_t fhci_frame_limit_timer_irq(int irq, void *_hcd);
564 void fhci_urb_complete_free(struct fhci_hcd *fhci, struct urb *urb);
565 struct td *fhci_remove_td_from_ed(struct ed *ed);
566 struct td *fhci_remove_td_from_frame(struct fhci_time_frame *frame);
567 void fhci_move_td_from_ed_to_done_list(struct fhci_usb *usb, struct ed *ed);
568 struct td *fhci_peek_td_from_frame(struct fhci_time_frame *frame);
569 void fhci_add_td_to_frame(struct fhci_time_frame *frame, struct td *td);
570 struct td *fhci_remove_td_from_done_list(struct fhci_controller_list *p_list);
571 void fhci_done_td(struct urb *urb, struct td *td);
572 void fhci_del_ed_list(struct fhci_hcd *fhci, struct ed *ed);
574 #ifdef CONFIG_FHCI_DEBUG
576 void fhci_dbg_isr(struct fhci_hcd *fhci, int usb_er);
577 void fhci_dfs_destroy(struct fhci_hcd *fhci);
578 void fhci_dfs_create(struct fhci_hcd *fhci);
582 static inline void fhci_dbg_isr(struct fhci_hcd *fhci, int usb_er) {}
583 static inline void fhci_dfs_destroy(struct fhci_hcd *fhci) {}
584 static inline void fhci_dfs_create(struct fhci_hcd *fhci) {}
586 #endif /* CONFIG_FHCI_DEBUG */
588 #endif /* __FHCI_H */