source: mainline/uspace/lib/usb/include/usb/host/bandwidth.h@ da9ebca

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

Add USB bandwidth manager

  • Property mode set to 100644
File size: 2.8 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 libusb
29 * @{
30 */
31/** @file
32 * Device keeper structure and functions.
33 *
34 * Typical USB host controller needs to keep track of various settings for
35 * each device that is connected to it.
36 * State of toggle bit, device speed etc. etc.
37 * This structure shall simplify the management.
38 */
39#ifndef LIBUSB_HOST_BANDWIDTH_H
40#define LIBUSB_HOST_BANDWIDTH_H
41
42#include <adt/hash_table.h>
43#include <fibril_synch.h>
44#include <usb/usb.h>
45
46typedef struct bandwidth {
47 hash_table_t reserved;
48 fibril_mutex_t guard;
49 size_t free;
50} bandwidth_t;
51
52int bandwidth_init(bandwidth_t *instance);
53
54void bandwidth_destroy(bandwidth_t *instance);
55
56int bandwidth_reserve(bandwidth_t *instance, usb_address_t address,
57 usb_endpoint_t endpoint, usb_transfer_type_t transfer_type,
58 size_t max_packet_size, size_t size, unsigned interval);
59
60int bandwidth_release(bandwidth_t *instance, usb_address_t address,
61 usb_endpoint_t endpoint, usb_transfer_type_t transfer_type,
62 size_t max_packet_size, size_t size, unsigned interval);
63
64int bandwidth_use(bandwidth_t *instance, usb_address_t address,
65 usb_endpoint_t endpoint, usb_transfer_type_t transfer_type,
66 size_t max_packet_size, size_t size, unsigned interval);
67
68int bandwidth_free(bandwidth_t *instance, usb_address_t address,
69 usb_endpoint_t endpoint, usb_transfer_type_t transfer_type,
70 size_t max_packet_size, size_t size, unsigned interval);
71
72#endif
73/**
74 * @}
75 */
Note: See TracBrowser for help on using the repository browser.