0001
0002
0003
0004
0005
0006
0007
0008
0009
0010
0011
0012
0013
0014 #ifndef __FHCI_H
0015 #define __FHCI_H
0016
0017 #include <linux/kernel.h>
0018 #include <linux/types.h>
0019 #include <linux/bug.h>
0020 #include <linux/spinlock.h>
0021 #include <linux/interrupt.h>
0022 #include <linux/kfifo.h>
0023 #include <linux/io.h>
0024 #include <linux/usb.h>
0025 #include <linux/usb/hcd.h>
0026 #include <soc/fsl/qe/qe.h>
0027 #include <soc/fsl/qe/immap_qe.h>
0028
0029 #define USB_CLOCK 48000000
0030
0031 #define FHCI_PRAM_SIZE 0x100
0032
0033 #define MAX_EDS 32
0034 #define MAX_TDS 32
0035
0036
0037
0038 #define CRC_SIZE 2
0039
0040
0041 #define PROTOCOL_OVERHEAD 7
0042
0043
0044 #define PKT_PID_DATA0 0x80000000
0045 #define PKT_PID_DATA1 0x40000000
0046 #define PKT_PID_SETUP 0x20000000
0047 #define PKT_SETUP_STATUS 0x10000000
0048 #define PKT_SETADDR_STATUS 0x08000000
0049 #define PKT_SET_HOST_LAST 0x04000000
0050 #define PKT_HOST_DATA 0x02000000
0051 #define PKT_FIRST_IN_FRAME 0x01000000
0052 #define PKT_TOKEN_FRAME 0x00800000
0053 #define PKT_ZLP 0x00400000
0054 #define PKT_IN_TOKEN_FRAME 0x00200000
0055 #define PKT_OUT_TOKEN_FRAME 0x00100000
0056 #define PKT_SETUP_TOKEN_FRAME 0x00080000
0057 #define PKT_STALL_FRAME 0x00040000
0058 #define PKT_NACK_FRAME 0x00020000
0059 #define PKT_NO_PID 0x00010000
0060 #define PKT_NO_CRC 0x00008000
0061 #define PKT_HOST_COMMAND 0x00004000
0062 #define PKT_DUMMY_PACKET 0x00002000
0063 #define PKT_LOW_SPEED_PACKET 0x00001000
0064
0065 #define TRANS_OK (0)
0066 #define TRANS_INPROGRESS (-1)
0067 #define TRANS_DISCARD (-2)
0068 #define TRANS_FAIL (-3)
0069
0070 #define PS_INT 0
0071 #define PS_DISCONNECTED 1
0072 #define PS_CONNECTED 2
0073 #define PS_READY 3
0074 #define PS_MISSING 4
0075
0076
0077 #define USB_TD_OK 0x00000000
0078 #define USB_TD_INPROGRESS 0x80000000
0079 #define USB_TD_RX_ER_NONOCT 0x40000000
0080 #define USB_TD_RX_ER_BITSTUFF 0x20000000
0081 #define USB_TD_RX_ER_CRC 0x10000000
0082 #define USB_TD_RX_ER_OVERUN 0x08000000
0083 #define USB_TD_RX_ER_PID 0x04000000
0084 #define USB_TD_RX_DATA_UNDERUN 0x02000000
0085 #define USB_TD_RX_DATA_OVERUN 0x01000000
0086 #define USB_TD_TX_ER_NAK 0x00800000
0087 #define USB_TD_TX_ER_STALL 0x00400000
0088 #define USB_TD_TX_ER_TIMEOUT 0x00200000
0089 #define USB_TD_TX_ER_UNDERUN 0x00100000
0090
0091 #define USB_TD_ERROR (USB_TD_RX_ER_NONOCT | USB_TD_RX_ER_BITSTUFF | \
0092 USB_TD_RX_ER_CRC | USB_TD_RX_ER_OVERUN | USB_TD_RX_ER_PID | \
0093 USB_TD_RX_DATA_UNDERUN | USB_TD_RX_DATA_OVERUN | \
0094 USB_TD_TX_ER_NAK | USB_TD_TX_ER_STALL | \
0095 USB_TD_TX_ER_TIMEOUT | USB_TD_TX_ER_UNDERUN)
0096
0097
0098 #define USB_TD_TOGGLE_DATA0 0
0099 #define USB_TD_TOGGLE_DATA1 1
0100 #define USB_TD_TOGGLE_CARRY 2
0101
0102
0103
0104
0105 #define BUS_MODE_GBL 0x20
0106 #define BUS_MODE_BO 0x18
0107 #define BUS_MODE_BO_BE 0x10
0108 #define BUS_MODE_DTB 0x02
0109
0110
0111
0112
0113 #define USB_MODE_EN 0x01
0114 #define USB_MODE_HOST 0x02
0115 #define USB_MODE_TEST 0x04
0116 #define USB_MODE_SFTE 0x08
0117 #define USB_MODE_RESUME 0x40
0118 #define USB_MODE_LSS 0x80
0119
0120
0121 #define USB_SLVADDR_MASK 0x7F
0122
0123
0124 #define USB_EPNUM_MASK 0xF000
0125 #define USB_EPNUM_SHIFT 12
0126
0127 #define USB_TRANS_MODE_SHIFT 8
0128 #define USB_TRANS_CTR 0x0000
0129 #define USB_TRANS_INT 0x0100
0130 #define USB_TRANS_BULK 0x0200
0131 #define USB_TRANS_ISO 0x0300
0132
0133 #define USB_EP_MF 0x0020
0134 #define USB_EP_RTE 0x0010
0135
0136 #define USB_THS_SHIFT 2
0137 #define USB_THS_MASK 0x000c
0138 #define USB_THS_NORMAL 0x0
0139 #define USB_THS_IGNORE_IN 0x0004
0140 #define USB_THS_NACK 0x0008
0141 #define USB_THS_STALL 0x000c
0142
0143 #define USB_RHS_SHIFT 0
0144 #define USB_RHS_MASK 0x0003
0145 #define USB_RHS_NORMAL 0x0
0146 #define USB_RHS_IGNORE_OUT 0x0001
0147 #define USB_RHS_NACK 0x0002
0148 #define USB_RHS_STALL 0x0003
0149
0150 #define USB_RTHS_MASK 0x000f
0151
0152
0153 #define USB_CMD_STR_FIFO 0x80
0154 #define USB_CMD_FLUSH_FIFO 0x40
0155 #define USB_CMD_ISFT 0x20
0156 #define USB_CMD_DSFT 0x10
0157 #define USB_CMD_EP_MASK 0x03
0158
0159
0160 #define USB_E_MSF_MASK 0x0800
0161 #define USB_E_SFT_MASK 0x0400
0162 #define USB_E_RESET_MASK 0x0200
0163 #define USB_E_IDLE_MASK 0x0100
0164 #define USB_E_TXE4_MASK 0x0080
0165 #define USB_E_TXE3_MASK 0x0040
0166 #define USB_E_TXE2_MASK 0x0020
0167 #define USB_E_TXE1_MASK 0x0010
0168 #define USB_E_SOF_MASK 0x0008
0169 #define USB_E_BSY_MASK 0x0004
0170 #define USB_E_TXB_MASK 0x0002
0171 #define USB_E_RXB_MASK 0x0001
0172
0173
0174 struct fhci_pram {
0175 __be16 ep_ptr[4];
0176 __be32 rx_state;
0177 __be32 rx_ptr;
0178 __be16 frame_num;
0179 __be16 rx_cnt;
0180 __be32 rx_temp;
0181 __be32 rx_data_temp;
0182 __be16 rx_u_ptr;
0183 u8 reserved1[2];
0184 __be32 sof_tbl;
0185 u8 sof_u_crc_temp;
0186 u8 reserved2[0xdb];
0187 };
0188
0189
0190 struct fhci_ep_pram {
0191 __be16 rx_base;
0192 __be16 tx_base;
0193 u8 rx_func_code;
0194 u8 tx_func_code;
0195 __be16 rx_buff_len;
0196 __be16 rx_bd_ptr;
0197 __be16 tx_bd_ptr;
0198 __be32 tx_state;
0199 __be32 tx_ptr;
0200 __be16 tx_crc;
0201 __be16 tx_cnt;
0202 __be32 tx_temp;
0203 __be16 tx_u_ptr;
0204 __be16 reserved;
0205 };
0206
0207 struct fhci_controller_list {
0208 struct list_head ctrl_list;
0209 struct list_head bulk_list;
0210 struct list_head iso_list;
0211 struct list_head intr_list;
0212 struct list_head done_list;
0213 };
0214
0215 struct virtual_root_hub {
0216 int dev_num;
0217 u32 feature;
0218 struct usb_hub_status hub;
0219 struct usb_port_status port;
0220 };
0221
0222 enum fhci_gpios {
0223 GPIO_USBOE = 0,
0224 GPIO_USBTP,
0225 GPIO_USBTN,
0226 GPIO_USBRP,
0227 GPIO_USBRN,
0228
0229 GPIO_SPEED,
0230 GPIO_POWER,
0231 NUM_GPIOS,
0232 };
0233
0234 enum fhci_pins {
0235 PIN_USBOE = 0,
0236 PIN_USBTP,
0237 PIN_USBTN,
0238 NUM_PINS,
0239 };
0240
0241 struct fhci_hcd {
0242 enum qe_clock fullspeed_clk;
0243 enum qe_clock lowspeed_clk;
0244 struct qe_pin *pins[NUM_PINS];
0245 int gpios[NUM_GPIOS];
0246 bool alow_gpios[NUM_GPIOS];
0247
0248 struct qe_usb_ctlr __iomem *regs;
0249 struct fhci_pram __iomem *pram;
0250 struct gtm_timer *timer;
0251
0252 spinlock_t lock;
0253 struct fhci_usb *usb_lld;
0254 struct virtual_root_hub *vroot_hub;
0255 int active_urbs;
0256 struct fhci_controller_list *hc_list;
0257 struct tasklet_struct *process_done_task;
0258
0259 struct list_head empty_eds;
0260 struct list_head empty_tds;
0261
0262 #ifdef CONFIG_FHCI_DEBUG
0263 int usb_irq_stat[13];
0264 struct dentry *dfs_root;
0265 #endif
0266 };
0267
0268 #define USB_FRAME_USAGE 90
0269 #define FRAME_TIME_USAGE (USB_FRAME_USAGE*10)
0270 #define SW_FIX_TIME_BETWEEN_TRANSACTION 150
0271 #define MAX_BYTES_PER_FRAME (USB_FRAME_USAGE*15)
0272 #define MAX_PERIODIC_FRAME_USAGE 90
0273
0274
0275 enum fhci_ta_type {
0276 FHCI_TA_IN = 0,
0277 FHCI_TA_OUT,
0278 FHCI_TA_SETUP,
0279 };
0280
0281
0282 enum fhci_tf_mode {
0283 FHCI_TF_CTRL = 0,
0284 FHCI_TF_ISO,
0285 FHCI_TF_BULK,
0286 FHCI_TF_INTR,
0287 };
0288
0289 enum fhci_speed {
0290 FHCI_FULL_SPEED,
0291 FHCI_LOW_SPEED,
0292 };
0293
0294
0295 enum fhci_ed_state {
0296 FHCI_ED_NEW = 0,
0297 FHCI_ED_OPER,
0298 FHCI_ED_URB_DEL,
0299 FHCI_ED_SKIP,
0300 FHCI_ED_HALTED,
0301 };
0302
0303 enum fhci_port_status {
0304 FHCI_PORT_POWER_OFF = 0,
0305 FHCI_PORT_DISABLED,
0306 FHCI_PORT_DISCONNECTING,
0307 FHCI_PORT_WAITING,
0308 FHCI_PORT_FULL,
0309 FHCI_PORT_LOW,
0310 };
0311
0312 enum fhci_mem_alloc {
0313 MEM_CACHABLE_SYS = 0x00000001,
0314 MEM_NOCACHE_SYS = 0x00000004,
0315 MEM_SECONDARY = 0x00000002,
0316 MEM_PRAM = 0x00000008,
0317 };
0318
0319
0320 #define DEFAULT_RING_LEN 8
0321 #define DEFAULT_DATA_MEM MEM_CACHABLE_SYS
0322
0323 struct ed {
0324 u8 dev_addr;
0325 u8 ep_addr;
0326 enum fhci_tf_mode mode;
0327 enum fhci_speed speed;
0328 unsigned int max_pkt_size;
0329 enum fhci_ed_state state;
0330 struct list_head td_list;
0331 struct list_head node;
0332
0333
0334 u8 toggle_carry;
0335 u16 next_iso;
0336 struct td *td_head;
0337 };
0338
0339 struct td {
0340 void *data;
0341 unsigned int len;
0342 unsigned int actual_len;
0343 enum fhci_ta_type type;
0344 u8 toggle;
0345 u16 iso_index;
0346 u16 start_frame;
0347 u16 interval;
0348 u32 status;
0349 struct ed *ed;
0350 struct urb *urb;
0351 bool ioc;
0352 struct list_head node;
0353
0354
0355 struct packet *pkt;
0356 int nak_cnt;
0357 int error_cnt;
0358 struct list_head frame_lh;
0359 };
0360
0361 struct packet {
0362 u8 *data;
0363 u32 len;
0364 u32 status;
0365
0366 u32 info;
0367 void __iomem *priv_data;
0368 };
0369
0370
0371 #define URB_INPROGRESS 0
0372 #define URB_DEL 1
0373
0374
0375 #define US_BULK 0
0376 #define US_BULK0 1
0377
0378
0379 #define US_CTRL_SETUP 2
0380 #define US_CTRL_DATA 1
0381 #define US_CTRL_ACK 0
0382
0383 #define EP_ZERO 0
0384
0385 struct urb_priv {
0386 int num_of_tds;
0387 int tds_cnt;
0388 int state;
0389
0390 struct td **tds;
0391 struct ed *ed;
0392 struct timer_list time_out;
0393 };
0394
0395 struct endpoint {
0396
0397 struct fhci_ep_pram __iomem *ep_pram_ptr;
0398
0399
0400 struct usb_td __iomem *td_base;
0401 struct usb_td __iomem *conf_td;
0402 struct usb_td __iomem *empty_td;
0403 struct kfifo empty_frame_Q;
0404 struct kfifo conf_frame_Q;
0405 struct kfifo dummy_packets_Q;
0406
0407 bool already_pushed_dummy_bd;
0408 };
0409
0410
0411 #define FRAME_IS_TRANSMITTED 0x00
0412 #define FRAME_TIMER_END_TRANSMISSION 0x01
0413 #define FRAME_DATA_END_TRANSMISSION 0x02
0414 #define FRAME_END_TRANSMISSION 0x03
0415 #define FRAME_IS_PREPARED 0x04
0416
0417 struct fhci_time_frame {
0418 u16 frame_num;
0419 u16 total_bytes;
0420 u8 frame_status;
0421 struct list_head tds_list;
0422 };
0423
0424
0425 struct fhci_usb {
0426 u16 saved_msk;
0427 struct endpoint *ep0;
0428 int intr_nesting_cnt;
0429 u16 max_frame_usage;
0430 u16 max_bytes_per_frame;
0431 u32 sw_transaction_time;
0432 struct fhci_time_frame *actual_frame;
0433 struct fhci_controller_list *hc_list;
0434 struct virtual_root_hub *vroot_hub;
0435 enum fhci_port_status port_status;
0436
0437 u32 (*transfer_confirm)(struct fhci_hcd *fhci);
0438
0439 struct fhci_hcd *fhci;
0440 };
0441
0442
0443
0444
0445
0446 static inline u16 get_frame_num(struct fhci_hcd *fhci)
0447 {
0448 return in_be16(&fhci->pram->frame_num) & 0x07ff;
0449 }
0450
0451 #define fhci_dbg(fhci, fmt, args...) \
0452 dev_dbg(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
0453 #define fhci_vdbg(fhci, fmt, args...) \
0454 dev_vdbg(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
0455 #define fhci_err(fhci, fmt, args...) \
0456 dev_err(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
0457 #define fhci_info(fhci, fmt, args...) \
0458 dev_info(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
0459 #define fhci_warn(fhci, fmt, args...) \
0460 dev_warn(fhci_to_hcd(fhci)->self.controller, fmt, ##args)
0461
0462 static inline struct fhci_hcd *hcd_to_fhci(struct usb_hcd *hcd)
0463 {
0464 return (struct fhci_hcd *)hcd->hcd_priv;
0465 }
0466
0467 static inline struct usb_hcd *fhci_to_hcd(struct fhci_hcd *fhci)
0468 {
0469 return container_of((void *)fhci, struct usb_hcd, hcd_priv);
0470 }
0471
0472
0473 static inline int cq_new(struct kfifo *fifo, int size)
0474 {
0475 return kfifo_alloc(fifo, size * sizeof(void *), GFP_KERNEL);
0476 }
0477
0478 static inline void cq_delete(struct kfifo *kfifo)
0479 {
0480 kfifo_free(kfifo);
0481 }
0482
0483 static inline unsigned int cq_howmany(struct kfifo *kfifo)
0484 {
0485 return kfifo_len(kfifo) / sizeof(void *);
0486 }
0487
0488 static inline int cq_put(struct kfifo *kfifo, void *p)
0489 {
0490 return kfifo_in(kfifo, (void *)&p, sizeof(p));
0491 }
0492
0493 static inline void *cq_get(struct kfifo *kfifo)
0494 {
0495 unsigned int sz;
0496 void *p;
0497
0498 sz = kfifo_out(kfifo, (void *)&p, sizeof(p));
0499 if (sz != sizeof(p))
0500 return NULL;
0501
0502 return p;
0503 }
0504
0505
0506 void fhci_start_sof_timer(struct fhci_hcd *fhci);
0507 void fhci_stop_sof_timer(struct fhci_hcd *fhci);
0508 u16 fhci_get_sof_timer_count(struct fhci_usb *usb);
0509 void fhci_usb_enable_interrupt(struct fhci_usb *usb);
0510 void fhci_usb_disable_interrupt(struct fhci_usb *usb);
0511 int fhci_ioports_check_bus_state(struct fhci_hcd *fhci);
0512
0513
0514 void fhci_recycle_empty_td(struct fhci_hcd *fhci, struct td *td);
0515 void fhci_recycle_empty_ed(struct fhci_hcd *fhci, struct ed *ed);
0516 struct ed *fhci_get_empty_ed(struct fhci_hcd *fhci);
0517 struct td *fhci_td_fill(struct fhci_hcd *fhci, struct urb *urb,
0518 struct urb_priv *urb_priv, struct ed *ed, u16 index,
0519 enum fhci_ta_type type, int toggle, u8 *data, u32 len,
0520 u16 interval, u16 start_frame, bool ioc);
0521 void fhci_add_tds_to_ed(struct ed *ed, struct td **td_list, int number);
0522
0523
0524 void fhci_config_transceiver(struct fhci_hcd *fhci,
0525 enum fhci_port_status status);
0526 void fhci_port_disable(struct fhci_hcd *fhci);
0527 void fhci_port_enable(void *lld);
0528 void fhci_io_port_generate_reset(struct fhci_hcd *fhci);
0529 void fhci_port_reset(void *lld);
0530 int fhci_hub_status_data(struct usb_hcd *hcd, char *buf);
0531 int fhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
0532 u16 wIndex, char *buf, u16 wLength);
0533
0534
0535 void fhci_flush_bds(struct fhci_usb *usb);
0536 void fhci_flush_actual_frame(struct fhci_usb *usb);
0537 u32 fhci_host_transaction(struct fhci_usb *usb, struct packet *pkt,
0538 enum fhci_ta_type trans_type, u8 dest_addr,
0539 u8 dest_ep, enum fhci_tf_mode trans_mode,
0540 enum fhci_speed dest_speed, u8 data_toggle);
0541 void fhci_host_transmit_actual_frame(struct fhci_usb *usb);
0542 void fhci_tx_conf_interrupt(struct fhci_usb *usb);
0543 void fhci_push_dummy_bd(struct endpoint *ep);
0544 u32 fhci_create_ep(struct fhci_usb *usb, enum fhci_mem_alloc data_mem,
0545 u32 ring_len);
0546 void fhci_init_ep_registers(struct fhci_usb *usb,
0547 struct endpoint *ep,
0548 enum fhci_mem_alloc data_mem);
0549 void fhci_ep0_free(struct fhci_usb *usb);
0550
0551
0552 extern struct tasklet_struct fhci_tasklet;
0553 void fhci_transaction_confirm(struct fhci_usb *usb, struct packet *pkt);
0554 void fhci_flush_all_transmissions(struct fhci_usb *usb);
0555 void fhci_schedule_transactions(struct fhci_usb *usb);
0556 void fhci_device_connected_interrupt(struct fhci_hcd *fhci);
0557 void fhci_device_disconnected_interrupt(struct fhci_hcd *fhci);
0558 void fhci_queue_urb(struct fhci_hcd *fhci, struct urb *urb);
0559 u32 fhci_transfer_confirm_callback(struct fhci_hcd *fhci);
0560 irqreturn_t fhci_irq(struct usb_hcd *hcd);
0561 irqreturn_t fhci_frame_limit_timer_irq(int irq, void *_hcd);
0562
0563
0564 void fhci_urb_complete_free(struct fhci_hcd *fhci, struct urb *urb);
0565 struct td *fhci_remove_td_from_ed(struct ed *ed);
0566 struct td *fhci_remove_td_from_frame(struct fhci_time_frame *frame);
0567 void fhci_move_td_from_ed_to_done_list(struct fhci_usb *usb, struct ed *ed);
0568 struct td *fhci_peek_td_from_frame(struct fhci_time_frame *frame);
0569 void fhci_add_td_to_frame(struct fhci_time_frame *frame, struct td *td);
0570 struct td *fhci_remove_td_from_done_list(struct fhci_controller_list *p_list);
0571 void fhci_done_td(struct urb *urb, struct td *td);
0572 void fhci_del_ed_list(struct fhci_hcd *fhci, struct ed *ed);
0573
0574 #ifdef CONFIG_FHCI_DEBUG
0575
0576 void fhci_dbg_isr(struct fhci_hcd *fhci, int usb_er);
0577 void fhci_dfs_destroy(struct fhci_hcd *fhci);
0578 void fhci_dfs_create(struct fhci_hcd *fhci);
0579
0580 #else
0581
0582 static inline void fhci_dbg_isr(struct fhci_hcd *fhci, int usb_er) {}
0583 static inline void fhci_dfs_destroy(struct fhci_hcd *fhci) {}
0584 static inline void fhci_dfs_create(struct fhci_hcd *fhci) {}
0585
0586 #endif
0587
0588 #endif