summaryrefslogtreecommitdiffstats
path: root/sys/mips/cavium/usb/octusb.h
blob: 31f4fc0835bd2023ec32a33a3a56d3b7517a2b8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/* $FreeBSD$ */

/*-
 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _OCTUSB_H_
#define	_OCTUSB_H_

#define	OCTUSB_MAX_DEVICES MIN(USB_MAX_DEVICES, 64)
/*
 * The second port is on a different IRQ and so we disable it for now.
 */
#if 1
#define	OCTUSB_MAX_PORTS	1	/* hardcoded */
#else
#define	OCTUSB_MAX_PORTS	2	/* hardcoded */
#endif
#define	OCTUSB_MAX_FIXUP	4096	/* bytes */
#define	OCTUSB_INTR_ENDPT	0x01

struct octusb_qh;
struct octusb_td;
struct octusb_softc;

typedef uint8_t (octusb_cmd_t)(struct octusb_td *td);

struct octusb_td {
	struct octusb_qh *qh;
	struct octusb_td *obj_next;
	struct usb_page_cache *pc;
	octusb_cmd_t *func;

	uint32_t remainder;
	uint32_t offset;

	uint8_t	error_any:1;
	uint8_t	error_stall:1;
	uint8_t	short_pkt:1;
	uint8_t	alt_next:1;
	uint8_t	reserved:4;
};

struct octusb_qh {

	uint64_t fixup_phys;

	struct octusb_softc *sc;
	struct usb_page_cache *fixup_pc;
	uint8_t *fixup_buf;

	cvmx_usb_iso_packet_t iso_pkt;

	uint32_t fixup_off;

	uint16_t max_frame_size;
	uint16_t max_packet_size;
	uint16_t fixup_actlen;
	uint16_t fixup_len;
	uint16_t ep_interval;

	uint8_t	dev_addr;
	uint8_t	dev_speed;
	uint8_t	ep_allocated;
	uint8_t	ep_mult;
	uint8_t	ep_num;
	uint8_t	ep_type;
	uint8_t	ep_toggle_next;
	uint8_t	port_index;
	uint8_t	fixup_complete;
	uint8_t	fixup_pending;
	uint8_t	hs_hub_addr;
	uint8_t	hs_hub_port;

	int	fixup_handle;
	int	ep_handle;
};

struct octusb_config_desc {
	struct usb_config_descriptor confd;
	struct usb_interface_descriptor ifcd;
	struct usb_endpoint_descriptor endpd;
} __packed;

union octusb_hub_desc {
	struct usb_status stat;
	struct usb_port_status ps;
	uint8_t	temp[128];
};

struct octusb_port {
	cvmx_usb_state_t state;
	uint8_t	disabled;
};

struct octusb_softc {

	struct usb_bus sc_bus;		/* base device */
	union octusb_hub_desc sc_hub_desc;

	struct usb_device *sc_devices[OCTUSB_MAX_DEVICES];

	struct resource *sc_irq_res;
	void   *sc_intr_hdl;

	struct octusb_port sc_port[OCTUSB_MAX_PORTS];
	device_t sc_dev;

	struct usb_hub_descriptor_min sc_hubd;

	uint8_t	sc_noport;		/* number of ports */
	uint8_t	sc_addr;		/* device address */
	uint8_t	sc_conf;		/* device configuration */
	uint8_t	sc_isreset;		/* set if current port is reset */

	uint8_t	sc_hub_idata[1];
};

usb_bus_mem_cb_t octusb_iterate_hw_softc;
usb_error_t octusb_init(struct octusb_softc *);
usb_error_t octusb_uninit(struct octusb_softc *);
void	octusb_suspend(struct octusb_softc *);
void	octusb_resume(struct octusb_softc *);
void	octusb_interrupt(struct octusb_softc *);

#endif					/* _OCTUSB_H_ */
OpenPOWER on IntegriCloud