source: mainline/uspace/drv/bus/usb/uhci/uhci_batch.h@ 6bba41d

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 6bba41d was 6bba41d, checked in by Jan Vesely <jano.vesely@…>, 14 years ago

uhci: Add and use uhci_batch_abort. Rename uhci_batch_call_dispose ⇒ uhci_batch finish_dispose

  • Property mode set to 100644
File size: 3.7 KB
Line 
1/*
2 * Copyright (c) 2011 Jan Vesely
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28/** @addtogroup drvusbuhcihc
29 * @{
30 */
31/** @file
32 * @brief UHCI driver USB tranfer helper functions
33 */
34#ifndef DRV_UHCI_BATCH_H
35#define DRV_UHCI_BATCH_H
36
37#include <usb/host/usb_transfer_batch.h>
38#include <adt/list.h>
39
40#include "hw_struct/queue_head.h"
41#include "hw_struct/transfer_descriptor.h"
42
43/** UHCI specific data required for USB transfer */
44typedef struct uhci_transfer_batch {
45 /** Queue head
46 * This QH is used to maintain UHCI schedule structure and the element
47 * pointer points to the first TD of this batch.
48 */
49 qh_t *qh;
50 /** List of TDs needed for the transfer */
51 td_t *tds;
52 /** Number of TDs used by the transfer */
53 size_t td_count;
54 /** Data buffer, must be accessible by the UHCI hw */
55 void *device_buffer;
56 /** Generic transfer data */
57 usb_transfer_batch_t *usb_batch;
58 /** List element */
59 link_t link;
60} uhci_transfer_batch_t;
61
62uhci_transfer_batch_t * uhci_transfer_batch_get(usb_transfer_batch_t *batch);
63void uhci_transfer_batch_finish_dispose(uhci_transfer_batch_t *uhci_batch);
64bool uhci_transfer_batch_is_complete(uhci_transfer_batch_t *uhci_batch);
65
66static inline void * uhci_transfer_batch_setup_buffer(
67 const uhci_transfer_batch_t *uhci_batch)
68{
69 assert(uhci_batch);
70 assert(uhci_batch->device_buffer);
71 return uhci_batch->device_buffer + sizeof(qh_t) +
72 uhci_batch->td_count * sizeof(td_t);
73}
74/*----------------------------------------------------------------------------*/
75static inline void * uhci_transfer_batch_data_buffer(
76 const uhci_transfer_batch_t *uhci_batch)
77{
78 assert(uhci_batch);
79 assert(uhci_batch->usb_batch);
80 return uhci_transfer_batch_setup_buffer(uhci_batch) +
81 uhci_batch->usb_batch->setup_size;
82}
83/*----------------------------------------------------------------------------*/
84static inline void uhci_transfer_batch_abort(
85 uhci_transfer_batch_t *uhci_batch)
86{
87 assert(uhci_batch);
88 assert(uhci_batch->usb_batch);
89 uhci_batch->usb_batch->error = EINTR;
90 uhci_batch->usb_batch->transfered_size = 0;
91 uhci_transfer_batch_finish_dispose(uhci_batch);
92}
93/*----------------------------------------------------------------------------*/
94static inline uhci_transfer_batch_t *uhci_transfer_batch_from_link(link_t *l)
95{
96 assert(l);
97 return list_get_instance(l, uhci_transfer_batch_t, link);
98}
99
100#endif
101/**
102 * @}
103 */
Note: See TracBrowser for help on using the repository browser.