summaryrefslogtreecommitdiff
path: root/payloads/libpayload/drivers/usb/uhci_rh.c
blob: 5f3d184cfddee5622ae5c6a461092b60454cc40a (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
148
149
150
/*
 *
 * Copyright (C) 2013 secunet Security Networks AG
 *
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * 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.
 */

//#define USB_DEBUG

#include <stdint.h>
#include <stdbool.h>
#include <usb/usb.h>

#include "generic_hub.h"
#include "uhci_private.h"
#include "uhci.h"

#define PORTSC(p) (PORTSC1 + ((p) - 1) * sizeof(uint16_t))
#define  PORTSC_CCS	(1 << 0)
#define  PORTSC_CSC	(1 << 1)
#define  PORTSC_PED	(1 << 2)
#define  PORTSC_PEDC	(1 << 3)
#define  PORTSC_LSDA	(1 << 8)
#define  PORTSC_PR	(1 << 9)
#define  PORTSC_SUSP	(1 << 12)
#define  PORTSC_SC_BITS (PORTSC_CSC | PORTSC_PEDC)

static int
uhci_rh_port_status_changed(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port));
	const bool changed = portsc & (PORTSC_CSC | PORTSC_PEDC);

	/* always clear all the status change bits */
	uhci_reg_write16(dev->controller, PORTSC(port), portsc);

	return changed;
}

static int
uhci_rh_port_connected(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port));
	return !!(portsc & PORTSC_CCS);
}

static int
uhci_rh_port_enabled(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port));
	return !(portsc & PORTSC_SUSP) && (portsc & PORTSC_PED);
}

static usb_speed
uhci_rh_port_speed(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port));
	const bool low_speed = portsc & PORTSC_LSDA;

	return low_speed ? LOW_SPEED : FULL_SPEED;
}

static int
uhci_rh_enable_port(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port)) & ~PORTSC_SUSP;
	uhci_reg_write16(dev->controller, PORTSC(port), portsc & ~(PORTSC_SC_BITS | PORTSC_SUSP));
	uhci_reg_write16(dev->controller, PORTSC(port), (portsc & ~PORTSC_SC_BITS) | PORTSC_PED);
	return 0;
}

static int
uhci_rh_disable_port(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port));
	uhci_reg_write16(dev->controller, PORTSC(port), portsc & ~(PORTSC_SC_BITS | PORTSC_PED));
	return 0;
}

static int
uhci_rh_reset_port(usbdev_t *const dev, const int port)
{
	const u16 portsc = uhci_reg_read16(dev->controller, PORTSC(port)) & ~PORTSC_PR;

	/* Trigger port reset. */
	uhci_reg_write16(dev->controller, PORTSC(port), portsc | PORTSC_PR);

	/* Wait for 15ms (usb20 spec 11.5.1.5: reset should take 10 to 20ms). */
	mdelay(15);

	/* Clear port reset. */
	uhci_reg_write16(dev->controller, PORTSC(port), portsc & ~PORTSC_PR);

	udelay(10); /* Linux waits this long. */

	/* Enable port. */
	uhci_reg_write16(dev->controller, PORTSC(port), portsc | PORTSC_PED);

	/* Clear status-change bits one last time. */
	uhci_reg_write16(dev->controller, PORTSC(port), portsc | PORTSC_PED | PORTSC_SC_BITS);

	return 0;
}

static const generic_hub_ops_t uhci_rh_ops = {
	.hub_status_changed	= NULL,
	.port_status_changed	= uhci_rh_port_status_changed,
	.port_connected		= uhci_rh_port_connected,
	.port_in_reset		= NULL,
	.port_enabled		= uhci_rh_port_enabled,
	.port_speed		= uhci_rh_port_speed,
	.enable_port		= uhci_rh_enable_port,
	.disable_port		= uhci_rh_disable_port,
	.start_port_reset	= NULL,
	.reset_port		= uhci_rh_reset_port,
};

void
uhci_rh_init(usbdev_t *dev)
{
	/* we can set them here because a root hub _really_ shouldn't appear elsewhere */
	dev->address = 0;
	dev->hub = -1;
	dev->port = -1;

	generic_hub_init(dev, 2, &uhci_rh_ops);

	usb_debug("UHCI: root hub init done\n");
}