Home | History | Annotate | Line # | Download | only in usb
usbdi_util.h revision 1.47.16.1 
      1 /*	$NetBSD: usbdi_util.h,v 1.47.16.1 2018/11/26 01:52:49 pgoyette Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Lennart Augustsson (lennart (at) augustsson.net) at
      9  * Carlstedt Research & Technology.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30  * POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 #ifndef _USBDI_UTIL_H_
     34 #define _USBDI_UTIL_H_
     35 
     36 #include <dev/usb/usbhid.h>
     37 
     38 usbd_status	usbd_get_desc(struct usbd_device *, int,
     39 			      int, int, void *);
     40 usbd_status	usbd_get_config_desc(struct usbd_device *, int,
     41 				     usb_config_descriptor_t *);
     42 usbd_status	usbd_get_config_desc_full(struct usbd_device *, int, void *, int);
     43 usbd_status	usbd_get_bos_desc(struct usbd_device *, int,
     44 				     usb_bos_descriptor_t *);
     45 usbd_status	usbd_get_bos_desc_full(struct usbd_device *, int, void *, int);
     46 usbd_status	usbd_get_device_desc(struct usbd_device *,
     47 				     usb_device_descriptor_t *);
     48 usbd_status	usbd_get_desc_fake(struct usbd_device *, int,
     49 				   int, int, void *);
     50 usbd_status	usbd_set_address(struct usbd_device *, int);
     51 usbd_status	usbd_get_port_status(struct usbd_device *,
     52 				     int, usb_port_status_t *);
     53 usbd_status	usbd_get_port_status_ext(struct usbd_device *,
     54 				     int, usb_port_status_ext_t *);
     55 usbd_status	usbd_set_hub_feature(struct usbd_device *, int);
     56 usbd_status	usbd_clear_hub_feature(struct usbd_device *, int);
     57 usbd_status	usbd_set_port_feature(struct usbd_device *, int, int);
     58 usbd_status	usbd_clear_port_feature(struct usbd_device *, int, int);
     59 usbd_status	usbd_set_port_u1_timeout(struct usbd_device *, int, int);
     60 usbd_status	usbd_set_port_u2_timeout(struct usbd_device *, int, int);
     61 usbd_status	usbd_get_device_status(struct usbd_device *, usb_status_t *);
     62 usbd_status	usbd_get_hub_status(struct usbd_device *, usb_hub_status_t *);
     63 usbd_status	usbd_get_protocol(struct usbd_interface *, uint8_t *);
     64 usbd_status	usbd_set_protocol(struct usbd_interface *, int);
     65 usbd_status	usbd_get_report_descriptor(struct usbd_device *, int,
     66 					   int, void *);
     67 usb_hid_descriptor_t *usbd_get_hid_descriptor(struct usbd_interface *);
     68 usbd_status	usbd_set_report(struct usbd_interface *, int, int,
     69 				void *, int);
     70 usbd_status	usbd_get_report(struct usbd_interface *, int, int,
     71 				void *, int);
     72 usbd_status	usbd_set_idle(struct usbd_interface *, int, int);
     73 usbd_status	usbd_read_report_desc(struct usbd_interface *, void **,
     74 				      int *);
     75 usbd_status	usbd_get_config(struct usbd_device *, uint8_t *);
     76 usbd_status	usbd_get_string_desc(struct usbd_device *, int,
     77 				     int, usb_string_descriptor_t *,
     78 				     int *);
     79 
     80 
     81 usbd_status	usbd_set_config_no(struct usbd_device *, int, int);
     82 usbd_status	usbd_set_config_index(struct usbd_device *, int, int);
     83 
     84 usbd_status	usbd_bulk_transfer(struct usbd_xfer *, struct usbd_pipe *,
     85 		uint16_t, uint32_t, void *, uint32_t *);
     86 
     87 usbd_status	usbd_intr_transfer(struct usbd_xfer *, struct usbd_pipe *,
     88 		    uint16_t, uint32_t, void *, uint32_t *);
     89 
     90 void usb_detach_waitold(device_t);
     91 void usb_detach_wakeupold(device_t);
     92 
     93 /*
     94  * MPSAFE versions - mutex must be at IPL_USB.
     95  */
     96 void usb_detach_wait(device_t dv, kcondvar_t *, kmutex_t *);
     97 void usb_detach_broadcast(device_t, kcondvar_t *);
     98 
     99 
    100 typedef struct {
    101 	uByte		bLength;
    102 	uByte		bDescriptorType;
    103 	uByte		bDescriptorSubtype;
    104 } UPACKED usb_cdc_descriptor_t;
    105 
    106 const usb_cdc_descriptor_t *usb_find_desc(struct usbd_device *, int,
    107 				      int);
    108 const usb_cdc_descriptor_t *usb_find_desc_if(struct usbd_device *, int,
    109 					 int,
    110 					 usb_interface_descriptor_t *);
    111 #define USBD_CDCSUBTYPE_ANY (~0)
    112 
    113 #endif /* _USBDI_UTIL_H_ */
    114