fix mismerge in ll_rw_blk.c
[linux-2.6] / drivers / usb / host / uhci-hub.c
1 /*
2  * Universal Host Controller Interface driver for USB.
3  *
4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5  *
6  * (C) Copyright 1999 Linus Torvalds
7  * (C) Copyright 1999-2002 Johannes Erdfelt, johannes@erdfelt.com
8  * (C) Copyright 1999 Randy Dunlap
9  * (C) Copyright 1999 Georg Acher, acher@in.tum.de
10  * (C) Copyright 1999 Deti Fliegl, deti@fliegl.de
11  * (C) Copyright 1999 Thomas Sailer, sailer@ife.ee.ethz.ch
12  * (C) Copyright 2004 Alan Stern, stern@rowland.harvard.edu
13  */
14
15 static __u8 root_hub_hub_des[] =
16 {
17         0x09,                   /*  __u8  bLength; */
18         0x29,                   /*  __u8  bDescriptorType; Hub-descriptor */
19         0x02,                   /*  __u8  bNbrPorts; */
20         0x0a,                   /* __u16  wHubCharacteristics; */
21         0x00,                   /*   (per-port OC, no power switching) */
22         0x01,                   /*  __u8  bPwrOn2pwrGood; 2ms */
23         0x00,                   /*  __u8  bHubContrCurrent; 0 mA */
24         0x00,                   /*  __u8  DeviceRemovable; *** 7 Ports max *** */
25         0xff                    /*  __u8  PortPwrCtrlMask; *** 7 ports max *** */
26 };
27
28 #define UHCI_RH_MAXCHILD        7
29
30 /* must write as zeroes */
31 #define WZ_BITS         (USBPORTSC_RES2 | USBPORTSC_RES3 | USBPORTSC_RES4)
32
33 /* status change bits:  nonzero writes will clear */
34 #define RWC_BITS        (USBPORTSC_OCC | USBPORTSC_PEC | USBPORTSC_CSC)
35
36 /* A port that either is connected or has a changed-bit set will prevent
37  * us from AUTO_STOPPING.
38  */
39 static int any_ports_active(struct uhci_hcd *uhci)
40 {
41         int port;
42
43         for (port = 0; port < uhci->rh_numports; ++port) {
44                 if ((inw(uhci->io_addr + USBPORTSC1 + port * 2) &
45                                 (USBPORTSC_CCS | RWC_BITS)) ||
46                                 test_bit(port, &uhci->port_c_suspend))
47                         return 1;
48         }
49         return 0;
50 }
51
52 static inline int get_hub_status_data(struct uhci_hcd *uhci, char *buf)
53 {
54         int port;
55
56         *buf = 0;
57         for (port = 0; port < uhci->rh_numports; ++port) {
58                 if ((inw(uhci->io_addr + USBPORTSC1 + port * 2) & RWC_BITS) ||
59                                 test_bit(port, &uhci->port_c_suspend))
60                         *buf |= (1 << (port + 1));
61         }
62         return !!*buf;
63 }
64
65 #define OK(x)                   len = (x); break
66
67 #define CLR_RH_PORTSTAT(x) \
68         status = inw(port_addr); \
69         status &= ~(RWC_BITS|WZ_BITS); \
70         status &= ~(x); \
71         status |= RWC_BITS & (x); \
72         outw(status, port_addr)
73
74 #define SET_RH_PORTSTAT(x) \
75         status = inw(port_addr); \
76         status |= (x); \
77         status &= ~(RWC_BITS|WZ_BITS); \
78         outw(status, port_addr)
79
80 /* UHCI controllers don't automatically stop resume signalling after 20 msec,
81  * so we have to poll and check timeouts in order to take care of it.
82  */
83 static void uhci_finish_suspend(struct uhci_hcd *uhci, int port,
84                 unsigned long port_addr)
85 {
86         int status;
87
88         if (test_bit(port, &uhci->suspended_ports)) {
89                 CLR_RH_PORTSTAT(USBPORTSC_SUSP | USBPORTSC_RD);
90                 clear_bit(port, &uhci->suspended_ports);
91                 clear_bit(port, &uhci->resuming_ports);
92                 set_bit(port, &uhci->port_c_suspend);
93
94                 /* The controller won't actually turn off the RD bit until
95                  * it has had a chance to send a low-speed EOP sequence,
96                  * which takes 3 bit times (= 2 microseconds).  We'll delay
97                  * slightly longer for good luck. */
98                 udelay(4);
99         }
100 }
101
102 static void uhci_check_ports(struct uhci_hcd *uhci)
103 {
104         unsigned int port;
105         unsigned long port_addr;
106         int status;
107
108         for (port = 0; port < uhci->rh_numports; ++port) {
109                 port_addr = uhci->io_addr + USBPORTSC1 + 2 * port;
110                 status = inw(port_addr);
111                 if (unlikely(status & USBPORTSC_PR)) {
112                         if (time_after_eq(jiffies, uhci->ports_timeout)) {
113                                 CLR_RH_PORTSTAT(USBPORTSC_PR);
114                                 udelay(10);
115
116                                 /* If the port was enabled before, turning
117                                  * reset on caused a port enable change.
118                                  * Turning reset off causes a port connect
119                                  * status change.  Clear these changes. */
120                                 CLR_RH_PORTSTAT(USBPORTSC_CSC | USBPORTSC_PEC);
121                                 SET_RH_PORTSTAT(USBPORTSC_PE);
122                         }
123                 }
124                 if (unlikely(status & USBPORTSC_RD)) {
125                         if (!test_bit(port, &uhci->resuming_ports)) {
126
127                                 /* Port received a wakeup request */
128                                 set_bit(port, &uhci->resuming_ports);
129                                 uhci->ports_timeout = jiffies +
130                                                 msecs_to_jiffies(20);
131
132                                 /* Make sure we see the port again
133                                  * after the resuming period is over. */
134                                 mod_timer(&uhci_to_hcd(uhci)->rh_timer,
135                                                 uhci->ports_timeout);
136                         } else if (time_after_eq(jiffies,
137                                                 uhci->ports_timeout)) {
138                                 uhci_finish_suspend(uhci, port, port_addr);
139                         }
140                 }
141         }
142 }
143
144 static int uhci_hub_status_data(struct usb_hcd *hcd, char *buf)
145 {
146         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
147         unsigned long flags;
148         int status;
149
150         spin_lock_irqsave(&uhci->lock, flags);
151         if (uhci->hc_inaccessible) {
152                 status = 0;
153                 goto done;
154         }
155
156         uhci_check_ports(uhci);
157         status = get_hub_status_data(uhci, buf);
158
159         switch (uhci->rh_state) {
160             case UHCI_RH_SUSPENDING:
161             case UHCI_RH_SUSPENDED:
162                 /* if port change, ask to be resumed */
163                 if (status)
164                         usb_hcd_resume_root_hub(hcd);
165                 break;
166
167             case UHCI_RH_AUTO_STOPPED:
168                 /* if port change, auto start */
169                 if (status)
170                         wakeup_rh(uhci);
171                 break;
172
173             case UHCI_RH_RUNNING:
174                 /* are any devices attached? */
175                 if (!any_ports_active(uhci)) {
176                         uhci->rh_state = UHCI_RH_RUNNING_NODEVS;
177                         uhci->auto_stop_time = jiffies + HZ;
178                 }
179                 break;
180
181             case UHCI_RH_RUNNING_NODEVS:
182                 /* auto-stop if nothing connected for 1 second */
183                 if (any_ports_active(uhci))
184                         uhci->rh_state = UHCI_RH_RUNNING;
185                 else if (time_after_eq(jiffies, uhci->auto_stop_time))
186                         suspend_rh(uhci, UHCI_RH_AUTO_STOPPED);
187                 break;
188
189             default:
190                 break;
191         }
192
193 done:
194         spin_unlock_irqrestore(&uhci->lock, flags);
195         return status;
196 }
197
198 /* size of returned buffer is part of USB spec */
199 static int uhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
200                         u16 wIndex, char *buf, u16 wLength)
201 {
202         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
203         int status, lstatus, retval = 0, len = 0;
204         unsigned int port = wIndex - 1;
205         unsigned long port_addr = uhci->io_addr + USBPORTSC1 + 2 * port;
206         u16 wPortChange, wPortStatus;
207         unsigned long flags;
208
209         if (uhci->hc_inaccessible)
210                 return -ETIMEDOUT;
211
212         spin_lock_irqsave(&uhci->lock, flags);
213         switch (typeReq) {
214
215         case GetHubStatus:
216                 *(__le32 *)buf = cpu_to_le32(0);
217                 OK(4);          /* hub power */
218         case GetPortStatus:
219                 if (port >= uhci->rh_numports)
220                         goto err;
221
222                 uhci_check_ports(uhci);
223                 status = inw(port_addr);
224
225                 /* Intel controllers report the OverCurrent bit active on.
226                  * VIA controllers report it active off, so we'll adjust the
227                  * bit value.  (It's not standardized in the UHCI spec.)
228                  */
229                 if (to_pci_dev(hcd->self.controller)->vendor ==
230                                 PCI_VENDOR_ID_VIA)
231                         status ^= USBPORTSC_OC;
232
233                 /* UHCI doesn't support C_RESET (always false) */
234                 wPortChange = lstatus = 0;
235                 if (status & USBPORTSC_CSC)
236                         wPortChange |= USB_PORT_STAT_C_CONNECTION;
237                 if (status & USBPORTSC_PEC)
238                         wPortChange |= USB_PORT_STAT_C_ENABLE;
239                 if (status & USBPORTSC_OCC)
240                         wPortChange |= USB_PORT_STAT_C_OVERCURRENT;
241
242                 if (test_bit(port, &uhci->port_c_suspend)) {
243                         wPortChange |= USB_PORT_STAT_C_SUSPEND;
244                         lstatus |= 1;
245                 }
246                 if (test_bit(port, &uhci->suspended_ports))
247                         lstatus |= 2;
248                 if (test_bit(port, &uhci->resuming_ports))
249                         lstatus |= 4;
250
251                 /* UHCI has no power switching (always on) */
252                 wPortStatus = USB_PORT_STAT_POWER;
253                 if (status & USBPORTSC_CCS)
254                         wPortStatus |= USB_PORT_STAT_CONNECTION;
255                 if (status & USBPORTSC_PE) {
256                         wPortStatus |= USB_PORT_STAT_ENABLE;
257                         if (status & (USBPORTSC_SUSP | USBPORTSC_RD))
258                                 wPortStatus |= USB_PORT_STAT_SUSPEND;
259                 }
260                 if (status & USBPORTSC_OC)
261                         wPortStatus |= USB_PORT_STAT_OVERCURRENT;
262                 if (status & USBPORTSC_PR)
263                         wPortStatus |= USB_PORT_STAT_RESET;
264                 if (status & USBPORTSC_LSDA)
265                         wPortStatus |= USB_PORT_STAT_LOW_SPEED;
266
267                 if (wPortChange)
268                         dev_dbg(uhci_dev(uhci), "port %d portsc %04x,%02x\n",
269                                         wIndex, status, lstatus);
270
271                 *(__le16 *)buf = cpu_to_le16(wPortStatus);
272                 *(__le16 *)(buf + 2) = cpu_to_le16(wPortChange);
273                 OK(4);
274         case SetHubFeature:             /* We don't implement these */
275         case ClearHubFeature:
276                 switch (wValue) {
277                 case C_HUB_OVER_CURRENT:
278                 case C_HUB_LOCAL_POWER:
279                         OK(0);
280                 default:
281                         goto err;
282                 }
283                 break;
284         case SetPortFeature:
285                 if (port >= uhci->rh_numports)
286                         goto err;
287
288                 switch (wValue) {
289                 case USB_PORT_FEAT_SUSPEND:
290                         set_bit(port, &uhci->suspended_ports);
291                         SET_RH_PORTSTAT(USBPORTSC_SUSP);
292                         OK(0);
293                 case USB_PORT_FEAT_RESET:
294                         SET_RH_PORTSTAT(USBPORTSC_PR);
295
296                         /* Reset terminates Resume signalling */
297                         uhci_finish_suspend(uhci, port, port_addr);
298
299                         /* USB v2.0 7.1.7.5 */
300                         uhci->ports_timeout = jiffies + msecs_to_jiffies(50);
301                         OK(0);
302                 case USB_PORT_FEAT_POWER:
303                         /* UHCI has no power switching */
304                         OK(0);
305                 default:
306                         goto err;
307                 }
308                 break;
309         case ClearPortFeature:
310                 if (port >= uhci->rh_numports)
311                         goto err;
312
313                 switch (wValue) {
314                 case USB_PORT_FEAT_ENABLE:
315                         CLR_RH_PORTSTAT(USBPORTSC_PE);
316
317                         /* Disable terminates Resume signalling */
318                         uhci_finish_suspend(uhci, port, port_addr);
319                         OK(0);
320                 case USB_PORT_FEAT_C_ENABLE:
321                         CLR_RH_PORTSTAT(USBPORTSC_PEC);
322                         OK(0);
323                 case USB_PORT_FEAT_SUSPEND:
324                         if (test_bit(port, &uhci->suspended_ports) &&
325                                         !test_and_set_bit(port,
326                                                 &uhci->resuming_ports)) {
327                                 SET_RH_PORTSTAT(USBPORTSC_RD);
328
329                                 /* The controller won't allow RD to be set
330                                  * if the port is disabled.  When this happens
331                                  * just skip the Resume signalling.
332                                  */
333                                 if (!(inw(port_addr) & USBPORTSC_RD))
334                                         uhci_finish_suspend(uhci, port,
335                                                         port_addr);
336                                 else
337                                         /* USB v2.0 7.1.7.7 */
338                                         uhci->ports_timeout = jiffies +
339                                                 msecs_to_jiffies(20);
340                         }
341                         OK(0);
342                 case USB_PORT_FEAT_C_SUSPEND:
343                         clear_bit(port, &uhci->port_c_suspend);
344                         OK(0);
345                 case USB_PORT_FEAT_POWER:
346                         /* UHCI has no power switching */
347                         goto err;
348                 case USB_PORT_FEAT_C_CONNECTION:
349                         CLR_RH_PORTSTAT(USBPORTSC_CSC);
350                         OK(0);
351                 case USB_PORT_FEAT_C_OVER_CURRENT:
352                         CLR_RH_PORTSTAT(USBPORTSC_OCC);
353                         OK(0);
354                 case USB_PORT_FEAT_C_RESET:
355                         /* this driver won't report these */
356                         OK(0);
357                 default:
358                         goto err;
359                 }
360                 break;
361         case GetHubDescriptor:
362                 len = min_t(unsigned int, sizeof(root_hub_hub_des), wLength);
363                 memcpy(buf, root_hub_hub_des, len);
364                 if (len > 2)
365                         buf[2] = uhci->rh_numports;
366                 OK(len);
367         default:
368 err:
369                 retval = -EPIPE;
370         }
371         spin_unlock_irqrestore(&uhci->lock, flags);
372
373         return retval;
374 }