source: mainline/uspace/lib/usbhid/include/usb/hid/hidreport.h

Last change on this file was 1b20da0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 7 years ago

style: Remove trailing whitespace on non-empty lines, in certain file types.

Command used: tools/srepl '\([^[:space:]]\)\s\+$' '\1' -- *.c *.h *.py *.sh *.s *.S *.ag

  • Property mode set to 100644
File size: 2.6 KB
Line 
1/*
2 * Copyright (c) 2011 Lubos Slovak
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 libusbhid
30 * @{
31 */
32/** @file
33 * USB HID report parser initialization from descriptors.
34 */
35
36#ifndef LIBUSBHID_HIDREPORT_H_
37#define LIBUSBHID_HIDREPORT_H_
38
39#include <usb/dev/driver.h>
40#include <usb/hid/hidparser.h>
41
42/**
43 * Retrieves the Report descriptor from the USB device and initializes the
44 * report parser.
45 *
46 * \param[in] dev USB device representing a HID device.
47 * \param[in/out] parser HID Report parser.
48 * \param[out] report_desc Place to save report descriptor into.
49 * \param[out] report_size
50 *
51 * \retval EOK if successful.
52 * \retval EINVAL if one of the parameters is not given (is NULL).
53 * \retval ENOENT if there are some descriptors missing.
54 * \retval ENOMEM if an error with allocation occured.
55 * \retval EINVAL if the Report descriptor's size does not match the size
56 * from the interface descriptor.
57 * \return Other value inherited from function usb_pipe_start_session(),
58 * usb_pipe_end_session() or usb_request_get_descriptor().
59 */
60errno_t usb_hid_process_report_descriptor(usb_device_t *dev,
61 usb_hid_report_t *report, uint8_t **report_desc, size_t *report_size);
62
63#endif /* LIBUSB_HIDREPORT_H_ */
64
65/**
66 * @}
67 */
Note: See TracBrowser for help on using the repository browser.