22ccdbf37c
with Communication Device Class Ethernet Emulation Model (CDC EEM). The driver supports both the device, and host side operation; there is a new USB template (#11) for the former. This enables communication with virtual USB NIC provided by iLO 5, as found in new HPE Proliant servers. Reviewed by: hselasky MFC after: 2 weeks Relnotes: yes Sponsored by: Hewlett Packard Enterprise
131 lines
4.4 KiB
C
131 lines
4.4 KiB
C
/* $FreeBSD$ */
|
|
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* Copyright (c) 2007 Hans Petter Selasky <hselasky@FreeBSD.org>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
/* USB templates are used to build up real USB descriptors */
|
|
|
|
#ifndef _USB_TEMPLATE_H_
|
|
#define _USB_TEMPLATE_H_
|
|
|
|
#ifndef USB_TEMPLATE_VENDOR
|
|
/*
|
|
* https://github.com/obdev/v-usb/blob/master/usbdrv/USB-IDs-for-free.txt
|
|
*/
|
|
#define USB_TEMPLATE_VENDOR 0x16c0
|
|
#define USB_TEMPLATE_MANUFACTURER \
|
|
"The FreeBSD Project (https://www.FreeBSD.org)"
|
|
#endif
|
|
|
|
typedef const void *(usb_temp_get_string_desc_t)(uint16_t lang_id, uint8_t string_index);
|
|
typedef const void *(usb_temp_get_vendor_desc_t)(const struct usb_device_request *req, uint16_t *plen);
|
|
|
|
struct usb_temp_packet_size {
|
|
uint16_t mps[USB_SPEED_MAX];
|
|
};
|
|
|
|
struct usb_temp_interval {
|
|
uint8_t bInterval[USB_SPEED_MAX];
|
|
};
|
|
|
|
struct usb_temp_endpoint_desc {
|
|
const void **ppRawDesc;
|
|
const struct usb_temp_packet_size *pPacketSize;
|
|
const struct usb_temp_interval *pIntervals;
|
|
/*
|
|
* If (bEndpointAddress & UE_ADDR) is non-zero the endpoint number
|
|
* is pre-selected for this endpoint descriptor. Else an endpoint
|
|
* number is automatically chosen.
|
|
*/
|
|
uint8_t bEndpointAddress; /* UE_DIR_IN or UE_DIR_OUT */
|
|
uint8_t bmAttributes;
|
|
};
|
|
|
|
struct usb_temp_interface_desc {
|
|
const void **ppRawDesc;
|
|
const struct usb_temp_endpoint_desc **ppEndpoints;
|
|
uint8_t bInterfaceClass;
|
|
uint8_t bInterfaceSubClass;
|
|
uint8_t bInterfaceProtocol;
|
|
uint8_t iInterface;
|
|
uint8_t isAltInterface;
|
|
};
|
|
|
|
struct usb_temp_config_desc {
|
|
const struct usb_temp_interface_desc **ppIfaceDesc;
|
|
uint8_t bmAttributes;
|
|
uint8_t bMaxPower;
|
|
uint8_t iConfiguration;
|
|
};
|
|
|
|
struct usb_temp_device_desc {
|
|
usb_temp_get_string_desc_t *getStringDesc;
|
|
usb_temp_get_vendor_desc_t *getVendorDesc;
|
|
const struct usb_temp_config_desc **ppConfigDesc;
|
|
uint16_t idVendor;
|
|
uint16_t idProduct;
|
|
uint16_t bcdDevice;
|
|
uint8_t bDeviceClass;
|
|
uint8_t bDeviceSubClass;
|
|
uint8_t bDeviceProtocol;
|
|
uint8_t iManufacturer;
|
|
uint8_t iProduct;
|
|
uint8_t iSerialNumber;
|
|
};
|
|
|
|
struct usb_temp_data {
|
|
const struct usb_temp_device_desc *tdd;
|
|
struct usb_device_descriptor udd; /* device descriptor */
|
|
struct usb_device_qualifier udq; /* device qualifier */
|
|
};
|
|
|
|
/* prototypes */
|
|
|
|
extern struct usb_temp_device_desc usb_template_audio;
|
|
extern struct usb_temp_device_desc usb_template_cdce;
|
|
extern struct usb_temp_device_desc usb_template_kbd;
|
|
extern struct usb_temp_device_desc usb_template_modem;
|
|
extern struct usb_temp_device_desc usb_template_mouse;
|
|
extern struct usb_temp_device_desc usb_template_msc;
|
|
extern struct usb_temp_device_desc usb_template_mtp;
|
|
extern struct usb_temp_device_desc usb_template_phone;
|
|
extern struct usb_temp_device_desc usb_template_serialnet;
|
|
extern struct usb_temp_device_desc usb_template_midi;
|
|
extern struct usb_temp_device_desc usb_template_multi;
|
|
extern struct usb_temp_device_desc usb_template_cdceem;
|
|
|
|
void usb_decode_str_desc(struct usb_string_descriptor *sd,
|
|
char *buf, size_t buflen);
|
|
usb_error_t usb_temp_setup(struct usb_device *,
|
|
const struct usb_temp_device_desc *);
|
|
void usb_temp_unsetup(struct usb_device *);
|
|
int usb_temp_sysctl(SYSCTL_HANDLER_ARGS);
|
|
|
|
SYSCTL_DECL(_hw_usb_templates);
|
|
|
|
#endif /* _USB_TEMPLATE_H_ */
|