Merge branch 'topic/asoc' into for-linus
[linux-2.6] / drivers / usb / host / whci / pzl.c
1 /*
2  * Wireless Host Controller (WHC) periodic schedule management.
3  *
4  * Copyright (C) 2007 Cambridge Silicon Radio Ltd.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License version
8  * 2 as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 #include <linux/kernel.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/uwb/umc.h>
21 #include <linux/usb.h>
22
23 #include "../../wusbcore/wusbhc.h"
24
25 #include "whcd.h"
26
27 static void update_pzl_pointers(struct whc *whc, int period, u64 addr)
28 {
29         switch (period) {
30         case 0:
31                 whc_qset_set_link_ptr(&whc->pz_list[0], addr);
32                 whc_qset_set_link_ptr(&whc->pz_list[2], addr);
33                 whc_qset_set_link_ptr(&whc->pz_list[4], addr);
34                 whc_qset_set_link_ptr(&whc->pz_list[6], addr);
35                 whc_qset_set_link_ptr(&whc->pz_list[8], addr);
36                 whc_qset_set_link_ptr(&whc->pz_list[10], addr);
37                 whc_qset_set_link_ptr(&whc->pz_list[12], addr);
38                 whc_qset_set_link_ptr(&whc->pz_list[14], addr);
39                 break;
40         case 1:
41                 whc_qset_set_link_ptr(&whc->pz_list[1], addr);
42                 whc_qset_set_link_ptr(&whc->pz_list[5], addr);
43                 whc_qset_set_link_ptr(&whc->pz_list[9], addr);
44                 whc_qset_set_link_ptr(&whc->pz_list[13], addr);
45                 break;
46         case 2:
47                 whc_qset_set_link_ptr(&whc->pz_list[3], addr);
48                 whc_qset_set_link_ptr(&whc->pz_list[11], addr);
49                 break;
50         case 3:
51                 whc_qset_set_link_ptr(&whc->pz_list[7], addr);
52                 break;
53         case 4:
54                 whc_qset_set_link_ptr(&whc->pz_list[15], addr);
55                 break;
56         }
57 }
58
59 /*
60  * Return the 'period' to use for this qset.  The minimum interval for
61  * the endpoint is used so whatever urbs are submitted the device is
62  * polled often enough.
63  */
64 static int qset_get_period(struct whc *whc, struct whc_qset *qset)
65 {
66         uint8_t bInterval = qset->ep->desc.bInterval;
67
68         if (bInterval < 6)
69                 bInterval = 6;
70         if (bInterval > 10)
71                 bInterval = 10;
72         return bInterval - 6;
73 }
74
75 static void qset_insert_in_sw_list(struct whc *whc, struct whc_qset *qset)
76 {
77         int period;
78
79         period = qset_get_period(whc, qset);
80
81         qset_clear(whc, qset);
82         list_move(&qset->list_node, &whc->periodic_list[period]);
83         qset->in_sw_list = true;
84 }
85
86 static void pzl_qset_remove(struct whc *whc, struct whc_qset *qset)
87 {
88         list_move(&qset->list_node, &whc->periodic_removed_list);
89         qset->in_hw_list = false;
90         qset->in_sw_list = false;
91 }
92
93 /**
94  * pzl_process_qset - process any recently inactivated or halted qTDs
95  * in a qset.
96  *
97  * After inactive qTDs are removed, new qTDs can be added if the
98  * urb queue still contains URBs.
99  *
100  * Returns the schedule updates required.
101  */
102 static enum whc_update pzl_process_qset(struct whc *whc, struct whc_qset *qset)
103 {
104         enum whc_update update = 0;
105         uint32_t status = 0;
106
107         while (qset->ntds) {
108                 struct whc_qtd *td;
109                 int t;
110
111                 t = qset->td_start;
112                 td = &qset->qtd[qset->td_start];
113                 status = le32_to_cpu(td->status);
114
115                 /*
116                  * Nothing to do with a still active qTD.
117                  */
118                 if (status & QTD_STS_ACTIVE)
119                         break;
120
121                 if (status & QTD_STS_HALTED) {
122                         /* Ug, an error. */
123                         process_halted_qtd(whc, qset, td);
124                         goto done;
125                 }
126
127                 /* Mmm, a completed qTD. */
128                 process_inactive_qtd(whc, qset, td);
129         }
130
131         update |= qset_add_qtds(whc, qset);
132
133 done:
134         /*
135          * If there are no qTDs in this qset, remove it from the PZL.
136          */
137         if (qset->remove && qset->ntds == 0) {
138                 pzl_qset_remove(whc, qset);
139                 update |= WHC_UPDATE_REMOVED;
140         }
141
142         return update;
143 }
144
145 /**
146  * pzl_start - start the periodic schedule
147  * @whc: the WHCI host controller
148  *
149  * The PZL must be valid (e.g., all entries in the list should have
150  * the T bit set).
151  */
152 void pzl_start(struct whc *whc)
153 {
154         le_writeq(whc->pz_list_dma, whc->base + WUSBPERIODICLISTBASE);
155
156         whc_write_wusbcmd(whc, WUSBCMD_PERIODIC_EN, WUSBCMD_PERIODIC_EN);
157         whci_wait_for(&whc->umc->dev, whc->base + WUSBSTS,
158                       WUSBSTS_PERIODIC_SCHED, WUSBSTS_PERIODIC_SCHED,
159                       1000, "start PZL");
160 }
161
162 /**
163  * pzl_stop - stop the periodic schedule
164  * @whc: the WHCI host controller
165  */
166 void pzl_stop(struct whc *whc)
167 {
168         whc_write_wusbcmd(whc, WUSBCMD_PERIODIC_EN, 0);
169         whci_wait_for(&whc->umc->dev, whc->base + WUSBSTS,
170                       WUSBSTS_PERIODIC_SCHED, 0,
171                       1000, "stop PZL");
172 }
173
174 /**
175  * pzl_update - request a PZL update and wait for the hardware to be synced
176  * @whc: the WHCI HC
177  * @wusbcmd: WUSBCMD value to start the update.
178  *
179  * If the WUSB HC is inactive (i.e., the PZL is stopped) then the
180  * update must be skipped as the hardware may not respond to update
181  * requests.
182  */
183 void pzl_update(struct whc *whc, uint32_t wusbcmd)
184 {
185         struct wusbhc *wusbhc = &whc->wusbhc;
186         long t;
187
188         mutex_lock(&wusbhc->mutex);
189         if (wusbhc->active) {
190                 whc_write_wusbcmd(whc, wusbcmd, wusbcmd);
191                 t = wait_event_timeout(
192                         whc->periodic_list_wq,
193                         (le_readl(whc->base + WUSBCMD) & WUSBCMD_PERIODIC_UPDATED) == 0,
194                         msecs_to_jiffies(1000));
195                 if (t == 0)
196                         whc_hw_error(whc, "PZL update timeout");
197         }
198         mutex_unlock(&wusbhc->mutex);
199 }
200
201 static void update_pzl_hw_view(struct whc *whc)
202 {
203         struct whc_qset *qset, *t;
204         int period;
205         u64 tmp_qh = 0;
206
207         for (period = 0; period < 5; period++) {
208                 list_for_each_entry_safe(qset, t, &whc->periodic_list[period], list_node) {
209                         whc_qset_set_link_ptr(&qset->qh.link, tmp_qh);
210                         tmp_qh = qset->qset_dma;
211                         qset->in_hw_list = true;
212                 }
213                 update_pzl_pointers(whc, period, tmp_qh);
214         }
215 }
216
217 /**
218  * scan_periodic_work - scan the PZL for qsets to process.
219  *
220  * Process each qset in the PZL in turn and then signal the WHC that
221  * the PZL has been updated.
222  *
223  * Then start, stop or update the periodic schedule as required.
224  */
225 void scan_periodic_work(struct work_struct *work)
226 {
227         struct whc *whc = container_of(work, struct whc, periodic_work);
228         struct whc_qset *qset, *t;
229         enum whc_update update = 0;
230         int period;
231
232         spin_lock_irq(&whc->lock);
233
234         for (period = 4; period >= 0; period--) {
235                 list_for_each_entry_safe(qset, t, &whc->periodic_list[period], list_node) {
236                         if (!qset->in_hw_list)
237                                 update |= WHC_UPDATE_ADDED;
238                         update |= pzl_process_qset(whc, qset);
239                 }
240         }
241
242         if (update & (WHC_UPDATE_ADDED | WHC_UPDATE_REMOVED))
243                 update_pzl_hw_view(whc);
244
245         spin_unlock_irq(&whc->lock);
246
247         if (update) {
248                 uint32_t wusbcmd = WUSBCMD_PERIODIC_UPDATED | WUSBCMD_PERIODIC_SYNCED_DB;
249                 if (update & WHC_UPDATE_REMOVED)
250                         wusbcmd |= WUSBCMD_PERIODIC_QSET_RM;
251                 pzl_update(whc, wusbcmd);
252         }
253
254         /*
255          * Now that the PZL is updated, complete the removal of any
256          * removed qsets.
257          */
258         spin_lock_irq(&whc->lock);
259
260         list_for_each_entry_safe(qset, t, &whc->periodic_removed_list, list_node) {
261                 qset_remove_complete(whc, qset);
262         }
263
264         spin_unlock_irq(&whc->lock);
265 }
266
267 /**
268  * pzl_urb_enqueue - queue an URB onto the periodic list (PZL)
269  * @whc: the WHCI host controller
270  * @urb: the URB to enqueue
271  * @mem_flags: flags for any memory allocations
272  *
273  * The qset for the endpoint is obtained and the urb queued on to it.
274  *
275  * Work is scheduled to update the hardware's view of the PZL.
276  */
277 int pzl_urb_enqueue(struct whc *whc, struct urb *urb, gfp_t mem_flags)
278 {
279         struct whc_qset *qset;
280         int err;
281         unsigned long flags;
282
283         spin_lock_irqsave(&whc->lock, flags);
284
285         qset = get_qset(whc, urb, GFP_ATOMIC);
286         if (qset == NULL)
287                 err = -ENOMEM;
288         else
289                 err = qset_add_urb(whc, qset, urb, GFP_ATOMIC);
290         if (!err) {
291                 usb_hcd_link_urb_to_ep(&whc->wusbhc.usb_hcd, urb);
292                 if (!qset->in_sw_list)
293                         qset_insert_in_sw_list(whc, qset);
294         }
295
296         spin_unlock_irqrestore(&whc->lock, flags);
297
298         if (!err)
299                 queue_work(whc->workqueue, &whc->periodic_work);
300
301         return 0;
302 }
303
304 /**
305  * pzl_urb_dequeue - remove an URB (qset) from the periodic list
306  * @whc: the WHCI host controller
307  * @urb: the URB to dequeue
308  * @status: the current status of the URB
309  *
310  * URBs that do yet have qTDs can simply be removed from the software
311  * queue, otherwise the qset must be removed so the qTDs can be safely
312  * removed.
313  */
314 int pzl_urb_dequeue(struct whc *whc, struct urb *urb, int status)
315 {
316         struct whc_urb *wurb = urb->hcpriv;
317         struct whc_qset *qset = wurb->qset;
318         struct whc_std *std, *t;
319         int ret;
320         unsigned long flags;
321
322         spin_lock_irqsave(&whc->lock, flags);
323
324         ret = usb_hcd_check_unlink_urb(&whc->wusbhc.usb_hcd, urb, status);
325         if (ret < 0)
326                 goto out;
327
328         list_for_each_entry_safe(std, t, &qset->stds, list_node) {
329                 if (std->urb == urb)
330                         qset_free_std(whc, std);
331                 else
332                         std->qtd = NULL; /* so this std is re-added when the qset is */
333         }
334
335         pzl_qset_remove(whc, qset);
336         wurb->status = status;
337         wurb->is_async = false;
338         queue_work(whc->workqueue, &wurb->dequeue_work);
339
340 out:
341         spin_unlock_irqrestore(&whc->lock, flags);
342
343         return ret;
344 }
345
346 /**
347  * pzl_qset_delete - delete a qset from the PZL
348  */
349 void pzl_qset_delete(struct whc *whc, struct whc_qset *qset)
350 {
351         qset->remove = 1;
352         queue_work(whc->workqueue, &whc->periodic_work);
353         qset_delete(whc, qset);
354 }
355
356
357 /**
358  * pzl_init - initialize the periodic zone list
359  * @whc: the WHCI host controller
360  */
361 int pzl_init(struct whc *whc)
362 {
363         int i;
364
365         whc->pz_list = dma_alloc_coherent(&whc->umc->dev, sizeof(u64) * 16,
366                                           &whc->pz_list_dma, GFP_KERNEL);
367         if (whc->pz_list == NULL)
368                 return -ENOMEM;
369
370         /* Set T bit on all elements in PZL. */
371         for (i = 0; i < 16; i++)
372                 whc->pz_list[i] = cpu_to_le64(QH_LINK_NTDS(8) | QH_LINK_T);
373
374         le_writeq(whc->pz_list_dma, whc->base + WUSBPERIODICLISTBASE);
375
376         return 0;
377 }
378
379 /**
380  * pzl_clean_up - free PZL resources
381  * @whc: the WHCI host controller
382  *
383  * The PZL is stopped and empty.
384  */
385 void pzl_clean_up(struct whc *whc)
386 {
387         if (whc->pz_list)
388                 dma_free_coherent(&whc->umc->dev,  sizeof(u64) * 16, whc->pz_list,
389                                   whc->pz_list_dma);
390 }