FreeBSD kernel usb device Code
usbdi_util.h
Go to the documentation of this file.
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2009 Andrew Thompson
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. 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 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28#ifndef _USB_USBDI_UTIL_H_
29#define _USB_USBDI_UTIL_H_
30
31struct cv;
32
33/* structures */
34
37 uint8_t iface_index; /* current interface index */
39 uint8_t iface_index_alt; /* current alternate setting */
40};
41
42/* prototypes */
43
44usb_error_t usbd_do_request_proc(struct usb_device *udev, struct usb_process *pproc,
45 struct usb_device_request *req, void *data, uint16_t flags,
46 uint16_t *actlen, usb_timeout_t timeout);
47
49 struct usb_descriptor *desc);
51 struct usb_config_descriptor *cd,
52 struct usb_idesc_parse_state *ps);
54 struct usb_config_descriptor *cd,
55 struct usb_endpoint_descriptor *ped);
57 struct usb_config_descriptor *cd,
60 uint8_t type);
62 struct usb_interface_descriptor *id);
63
64usb_error_t usbd_req_get_report(struct usb_device *udev, struct mtx *mtx,
65 void *data, uint16_t len, uint8_t iface_index, uint8_t type,
66 uint8_t id);
68 struct mtx *mtx, void *d, uint16_t size,
69 uint8_t iface_index);
70usb_error_t usbd_req_get_string_any(struct usb_device *udev, struct mtx *mtx,
71 char *buf, uint16_t len, uint8_t string_index);
72usb_error_t usbd_req_get_string_desc(struct usb_device *udev, struct mtx *mtx,
73 void *sdesc, uint16_t max_len, uint16_t lang_id,
74 uint8_t string_index);
75usb_error_t usbd_req_set_config(struct usb_device *udev, struct mtx *mtx,
76 uint8_t conf);
78 struct mtx *mtx, uint8_t iface_index, uint8_t alt_no);
79usb_error_t usbd_req_set_idle(struct usb_device *udev, struct mtx *mtx,
80 uint8_t iface_index, uint8_t duration, uint8_t id);
81usb_error_t usbd_req_set_protocol(struct usb_device *udev, struct mtx *mtx,
82 uint8_t iface_index, uint16_t report);
83usb_error_t usbd_req_set_report(struct usb_device *udev, struct mtx *mtx,
84 void *data, uint16_t len, uint8_t iface_index,
85 uint8_t type, uint8_t id);
86
87/* The following functions will not return NULL strings. */
88
89const char *usb_get_manufacturer(struct usb_device *);
90const char *usb_get_product(struct usb_device *);
91const char *usb_get_serial(struct usb_device *);
92
93#endif /* _USB_USBDI_UTIL_H_ */
uint16_t len
Definition: ehci.h:41
uint8_t size
Definition: if_axge.c:89
struct usb_descriptor * desc
Definition: usbdi_util.h:36
struct usb_endpoint_descriptor desc
Definition: usb_device.h:0
uint32_t usb_timeout_t
Definition: usb_freebsd.h:99
const void * req
Definition: usb_if.m:51
usb_error_t
Definition: usbdi.h:45
const char * usb_get_serial(struct usb_device *)
Definition: usb_device.c:293
struct usb_descriptor * usb_desc_foreach(struct usb_config_descriptor *cd, struct usb_descriptor *desc)
Definition: usb_parse.c:74
const char * usb_get_manufacturer(struct usb_device *)
Definition: usb_device.c:281
struct usb_endpoint_ss_comp_descriptor * usb_ed_comp_foreach(struct usb_config_descriptor *cd, struct usb_endpoint_ss_comp_descriptor *ped)
Definition: usb_parse.c:234
usb_error_t usbd_req_set_config(struct usb_device *udev, struct mtx *mtx, uint8_t conf)
Definition: usb_request.c:1920
usb_error_t usbd_req_set_alt_interface_no(struct usb_device *udev, struct mtx *mtx, uint8_t iface_index, uint8_t alt_no)
Definition: usb_request.c:1434
usb_error_t usbd_req_get_report_descriptor(struct usb_device *udev, struct mtx *mtx, void *d, uint16_t size, uint8_t iface_index)
Definition: usb_request.c:1890
struct usb_endpoint_descriptor * usb_edesc_foreach(struct usb_config_descriptor *cd, struct usb_endpoint_descriptor *ped)
Definition: usb_parse.c:199
usb_error_t usbd_req_get_string_desc(struct usb_device *udev, struct mtx *mtx, void *sdesc, uint16_t max_len, uint16_t lang_id, uint8_t string_index)
Definition: usb_request.c:1206
usb_error_t usbd_do_request_proc(struct usb_device *udev, struct usb_process *pproc, struct usb_device_request *req, void *data, uint16_t flags, uint16_t *actlen, usb_timeout_t timeout)
Definition: usb_request.c:742
usb_error_t usbd_req_get_string_any(struct usb_device *udev, struct mtx *mtx, char *buf, uint16_t len, uint8_t string_index)
Definition: usb_request.c:1100
uint8_t usbd_get_no_descriptors(struct usb_config_descriptor *cd, uint8_t type)
Definition: usb_parse.c:264
usb_error_t usbd_req_set_report(struct usb_device *udev, struct mtx *mtx, void *data, uint16_t len, uint8_t iface_index, uint8_t type, uint8_t id)
Definition: usb_request.c:1806
const char * usb_get_product(struct usb_device *)
Definition: usb_device.c:287
usb_error_t usbd_req_get_report(struct usb_device *udev, struct mtx *mtx, void *data, uint16_t len, uint8_t iface_index, uint8_t type, uint8_t id)
Definition: usb_request.c:1834
usb_error_t usbd_req_set_idle(struct usb_device *udev, struct mtx *mtx, uint8_t iface_index, uint8_t duration, uint8_t id)
Definition: usb_request.c:1862
usb_error_t usbd_req_set_protocol(struct usb_device *udev, struct mtx *mtx, uint8_t iface_index, uint16_t report)
Definition: usb_request.c:1777
struct usb_interface_descriptor * usb_idesc_foreach(struct usb_config_descriptor *cd, struct usb_idesc_parse_state *ps)
Definition: usb_parse.c:126
uint8_t usbd_get_no_alts(struct usb_config_descriptor *cd, struct usb_interface_descriptor *id)
Definition: usb_parse.c:288