source: mainline/uspace/drv/usbmouse/mouse.h@ a9f91cd

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since a9f91cd 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.3 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 drvusbmouse
30 * @{
31 */
32/**
33 * @file
34 * Common definitions for USB mouse driver.
35 */
36#ifndef USBMOUSE_MOUSE_H_
37#define USBMOUSE_MOUSE_H_
38
39#include <ddf/driver.h>
40#include <usb/pipes.h>
41#include <time.h>
42
43#define NAME "usbmouse"
44
45/** Container for USB mouse device. */
46typedef struct {
47 /** Generic device container. */
48 ddf_dev_t *device;
49 /** Function representing the device. */
50 ddf_fun_t *mouse_fun;
51 /** Representation of connection to the device. */
52 usb_device_connection_t wire;
53 /** Default (zero) control pipe. */
54 usb_endpoint_pipe_t ctrl_pipe;
55 /** Polling (in) pipe. */
56 usb_endpoint_pipe_t poll_pipe;
57 /** Polling interval in microseconds. */
58 suseconds_t poll_interval_us;
59 /** IPC phone to console (consumer). */
60 int console_phone;
61} usb_mouse_t;
62
63int usb_mouse_create(ddf_dev_t *);
64
65int usb_mouse_polling_fibril(void *);
66
67#endif
68/**
69 * @}
70 */
Note: See TracBrowser for help on using the repository browser.