1/*
 2 * udc.h - ChipIdea UDC structures
 3 *
 4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
 5 *
 6 * Author: David Lopo
 7 *
 8 * This program is free software; you can redistribute it and/or modify
 9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef __DRIVERS_USB_CHIPIDEA_UDC_H
14#define __DRIVERS_USB_CHIPIDEA_UDC_H
15
16#include <linux/list.h>
17
18#define CTRL_PAYLOAD_MAX   64
19#define RX        0  /* similar to USB_DIR_OUT but can be used as an index */
20#define TX        1  /* similar to USB_DIR_IN  but can be used as an index */
21
22/* DMA layout of transfer descriptors */
23struct ci13xxx_td {
24	/* 0 */
25	u32 next;
26#define TD_TERMINATE          BIT(0)
27#define TD_ADDR_MASK          (0xFFFFFFEUL << 5)
28	/* 1 */
29	u32 token;
30#define TD_STATUS             (0x00FFUL <<  0)
31#define TD_STATUS_TR_ERR      BIT(3)
32#define TD_STATUS_DT_ERR      BIT(5)
33#define TD_STATUS_HALTED      BIT(6)
34#define TD_STATUS_ACTIVE      BIT(7)
35#define TD_MULTO              (0x0003UL << 10)
36#define TD_IOC                BIT(15)
37#define TD_TOTAL_BYTES        (0x7FFFUL << 16)
38	/* 2 */
39	u32 page[5];
40#define TD_CURR_OFFSET        (0x0FFFUL <<  0)
41#define TD_FRAME_NUM          (0x07FFUL <<  0)
42#define TD_RESERVED_MASK      (0x0FFFUL <<  0)
43} __attribute__ ((packed));
44
45/* DMA layout of queue heads */
46struct ci13xxx_qh {
47	/* 0 */
48	u32 cap;
49#define QH_IOS                BIT(15)
50#define QH_MAX_PKT            (0x07FFUL << 16)
51#define QH_ZLT                BIT(29)
52#define QH_MULT               (0x0003UL << 30)
53	/* 1 */
54	u32 curr;
55	/* 2 - 8 */
56	struct ci13xxx_td        td;
57	/* 9 */
58	u32 RESERVED;
59	struct usb_ctrlrequest   setup;
60} __attribute__ ((packed));
61
62/**
63 * struct ci13xxx_req - usb request representation
64 * @req: request structure for gadget drivers
65 * @queue: link to QH list
66 * @ptr: transfer descriptor for this request
67 * @dma: dma address for the transfer descriptor
68 * @zptr: transfer descriptor for the zero packet
69 * @zdma: dma address of the zero packet's transfer descriptor
70 */
71struct ci13xxx_req {
72	struct usb_request	req;
73	struct list_head	queue;
74	struct ci13xxx_td	*ptr;
75	dma_addr_t		dma;
76	struct ci13xxx_td	*zptr;
77	dma_addr_t		zdma;
78};
79
80#ifdef CONFIG_USB_CHIPIDEA_UDC
81
82int ci_hdrc_gadget_init(struct ci13xxx *ci);
83
84#else
85
86static inline int ci_hdrc_gadget_init(struct ci13xxx *ci)
87{
88	return -ENXIO;
89}
90
91#endif
92
93#endif /* __DRIVERS_USB_CHIPIDEA_UDC_H */