source: mainline/uspace/drv/usbmid/usbmid.h@ b8e9acb

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since b8e9acb was a6add7a, checked in by Vojtech Horky <vojtechhorky@…>, 14 years ago

Comment and documentation fixes

In the process also removed several functions that are no longer
needed.

This commit shall not affect functionality in any way.

  • Property mode set to 100644
File size: 2.4 KB
Line 
1/*
2 * Copyright (c) 2011 Vojtech Horky
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
29/** @addtogroup drvusbmid
30 * @{
31 */
32/** @file
33 * Common definitions.
34 */
35
36#ifndef USBMID_H_
37#define USBMID_H_
38
39#include <ddf/driver.h>
40#include <usb/usb.h>
41#include <usb/pipes.h>
42#include <usb/debug.h>
43
44#define NAME "usbmid"
45
46/** USB MID device container. */
47typedef struct {
48 /** Device container. */
49 ddf_dev_t *dev;
50
51 /** Representation of USB wire. */
52 usb_device_connection_t wire;
53 /** Default control pipe. */
54 usb_endpoint_pipe_t ctrl_pipe;
55} usbmid_device_t;
56
57
58/** Container for single interface in a MID device. */
59typedef struct {
60 /** Function container. */
61 ddf_fun_t *fun;
62
63 /** Interface number. */
64 int interface_no;
65} usbmid_interface_t;
66
67usbmid_device_t *usbmid_device_create(ddf_dev_t *);
68usbmid_interface_t *usbmid_interface_create(ddf_fun_t *, int);
69bool usbmid_explore_device(usbmid_device_t *);
70int usbmid_spawn_interface_child(usbmid_device_t *,
71 const usb_standard_device_descriptor_t *,
72 const usb_standard_interface_descriptor_t *);
73void usbmid_dump_descriptors(uint8_t *, size_t);
74
75#endif
76/**
77 * @}
78 */
Note: See TracBrowser for help on using the repository browser.