/*- * Copyright (c) 2015 Ruslan Bukin * All rights reserved. * * This software was developed by SRI International and the University of * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237) * ("CTSRD"), as part of the DARPA CRASH research programme. * * 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. */ /* * This file contains the USB template for USB Networking and Serial */ #include __FBSDID("$FreeBSD$"); #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ #define MODEM_IFACE_0 0 #define MODEM_IFACE_1 1 enum { STRING_LANG_INDEX, STRING_MODEM_INDEX, STRING_ETH_MAC_INDEX, STRING_ETH_CONTROL_INDEX, STRING_ETH_DATA_INDEX, STRING_ETH_CONFIG_INDEX, STRING_CONFIG_INDEX, STRING_VENDOR_INDEX, STRING_PRODUCT_INDEX, STRING_SERIAL_INDEX, STRING_MAX, }; #define STRING_MODEM \ "U\0S\0B\0 \0M\0o\0d\0e\0m\0 \0I\0n\0t\0e\0r\0f\0a\0c\0e" #define STRING_ETH_MAC \ "2\0A\0002\0003\0004\0005\0006\0007\08\09\0A\0B" #define STRING_ETH_CONTROL \ "U\0S\0B\0 \0E\0t\0h\0e\0r\0n\0e\0t\0 " \ "\0C\0o\0m\0m\0 \0I\0n\0t\0e\0r\0f\0a\0c\0e" #define STRING_ETH_DATA \ "U\0S\0B\0 \0E\0t\0h\0e\0r\0n\0e\0t\0 \0D\0a\0t\0a\0 " \ "\0I\0n\0t\0e\0r\0f\0a\0c\0e" #define STRING_CONFIG \ "D\0e\0f\0a\0u\0l\0t\0 \0c\0o\0n\0f\0i\0g\0u\0r\0a\0t\0i\0o\0n" #define STRING_VENDOR \ "T\0h\0e\0 \0F\0r\0e\0e\0B\0S\0D\0 \0P\0r\0o\0j\0e\0c\0t" #define STRING_PRODUCT \ "S\0E\0R\0I\0A\0L\0N\0E\0T" #define STRING_SERIAL \ "J\0a\0n\0u\0a\0r\0y\0 \0002\0000\0001\0005" /* make the real string descriptors */ USB_MAKE_STRING_DESC(STRING_MODEM, string_modem); USB_MAKE_STRING_DESC(STRING_ETH_MAC, string_eth_mac); USB_MAKE_STRING_DESC(STRING_ETH_CONTROL, string_eth_control); USB_MAKE_STRING_DESC(STRING_ETH_DATA, string_eth_data); USB_MAKE_STRING_DESC(STRING_CONFIG, string_serialnet_config); USB_MAKE_STRING_DESC(STRING_VENDOR, string_serialnet_vendor); USB_MAKE_STRING_DESC(STRING_PRODUCT, string_serialnet_product); USB_MAKE_STRING_DESC(STRING_SERIAL, string_serialnet_serial); /* prototypes */ static usb_temp_get_string_desc_t serialnet_get_string_desc; static const struct usb_cdc_union_descriptor eth_union_desc = { .bLength = sizeof(eth_union_desc), .bDescriptorType = UDESC_CS_INTERFACE, .bDescriptorSubtype = UDESCSUB_CDC_UNION, .bMasterInterface = 0, /* this is automatically updated */ .bSlaveInterface[0] = 1, /* this is automatically updated */ }; static const struct usb_cdc_header_descriptor eth_header_desc = { .bLength = sizeof(eth_header_desc), .bDescriptorType = UDESC_CS_INTERFACE, .bDescriptorSubtype = UDESCSUB_CDC_HEADER, .bcdCDC[0] = 0x10, .bcdCDC[1] = 0x01, }; static const struct usb_cdc_ethernet_descriptor eth_enf_desc = { .bLength = sizeof(eth_enf_desc), .bDescriptorType = UDESC_CS_INTERFACE, .bDescriptorSubtype = UDESCSUB_CDC_ENF, .iMacAddress = STRING_ETH_MAC_INDEX, .bmEthernetStatistics = {0, 0, 0, 0}, .wMaxSegmentSize = {0xEA, 0x05},/* 1514 bytes */ .wNumberMCFilters = {0, 0}, .bNumberPowerFilters = 0, }; static const void *eth_control_if_desc[] = { ð_union_desc, ð_header_desc, ð_enf_desc, NULL, }; static const struct usb_temp_packet_size bulk_mps = { .mps[USB_SPEED_FULL] = 64, .mps[USB_SPEED_HIGH] = 512, }; static const struct usb_temp_packet_size intr_mps = { .mps[USB_SPEED_FULL] = 8, .mps[USB_SPEED_HIGH] = 8, }; static const struct usb_temp_endpoint_desc bulk_in_ep = { .pPacketSize = &bulk_mps, #ifdef USB_HIP_IN_EP_0 .bEndpointAddress = USB_HIP_IN_EP_0, #else .bEndpointAddress = UE_DIR_IN, #endif .bmAttributes = UE_BULK, }; static const struct usb_temp_endpoint_desc bulk_out_ep = { .pPacketSize = &bulk_mps, #ifdef USB_HIP_OUT_EP_0 .bEndpointAddress = USB_HIP_OUT_EP_0, #else .bEndpointAddress = UE_DIR_OUT, #endif .bmAttributes = UE_BULK, }; static const struct usb_temp_endpoint_desc intr_in_ep = { .pPacketSize = &intr_mps, .bEndpointAddress = UE_DIR_IN, .bmAttributes = UE_INTERRUPT, }; static const struct usb_temp_endpoint_desc *eth_intr_endpoints[] = { &intr_in_ep, NULL, }; static const struct usb_temp_interface_desc eth_control_interface = { .ppEndpoints = eth_intr_endpoints, .ppRawDesc = eth_control_if_desc, .bInterfaceClass = UICLASS_CDC, .bInterfaceSubClass = UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL, .bInterfaceProtocol = 0, .iInterface = STRING_ETH_CONTROL_INDEX, }; static const struct usb_temp_endpoint_desc *eth_data_endpoints[] = { &bulk_in_ep, &bulk_out_ep, NULL, }; static const struct usb_temp_interface_desc eth_data_null_interface = { .ppEndpoints = NULL, /* no endpoints */ .bInterfaceClass = UICLASS_CDC_DATA, .bInterfaceSubClass = 0, .bInterfaceProtocol = 0, .iInterface = STRING_ETH_DATA_INDEX, }; static const struct usb_temp_interface_desc eth_data_interface = { .ppEndpoints = eth_data_endpoints, .bInterfaceClass = UICLASS_CDC_DATA, .bInterfaceSubClass = UISUBCLASS_DATA, .bInterfaceProtocol = 0, .iInterface = STRING_ETH_DATA_INDEX, .isAltInterface = 1, /* this is an alternate setting */ }; static const struct usb_temp_packet_size modem_bulk_mps = { .mps[USB_SPEED_LOW] = 8, .mps[USB_SPEED_FULL] = 64, .mps[USB_SPEED_HIGH] = 512, }; static const struct usb_temp_packet_size modem_intr_mps = { .mps[USB_SPEED_LOW] = 8, .mps[USB_SPEED_FULL] = 8, .mps[USB_SPEED_HIGH] = 8, }; static const struct usb_temp_interval modem_intr_interval = { .bInterval[USB_SPEED_LOW] = 8, /* 8ms */ .bInterval[USB_SPEED_FULL] = 8, /* 8ms */ .bInterval[USB_SPEED_HIGH] = 7, /* 8ms */ }; static const struct usb_temp_endpoint_desc modem_ep_0 = { .pPacketSize = &modem_intr_mps, .pIntervals = &modem_intr_interval, .bEndpointAddress = UE_DIR_IN, .bmAttributes = UE_INTERRUPT, }; static const struct usb_temp_endpoint_desc modem_ep_1 = { .pPacketSize = &modem_bulk_mps, .bEndpointAddress = UE_DIR_OUT, .bmAttributes = UE_BULK, }; static const struct usb_temp_endpoint_desc modem_ep_2 = { .pPacketSize = &modem_bulk_mps, .bEndpointAddress = UE_DIR_IN, .bmAttributes = UE_BULK, }; static const struct usb_temp_endpoint_desc *modem_iface_0_ep[] = { &modem_ep_0, NULL, }; static const struct usb_temp_endpoint_desc *modem_iface_1_ep[] = { &modem_ep_1, &modem_ep_2, NULL, }; static const uint8_t modem_raw_desc_0[] = { 0x05, 0x24, 0x00, 0x10, 0x01 }; static const uint8_t modem_raw_desc_1[] = { 0x05, 0x24, 0x06, MODEM_IFACE_0, MODEM_IFACE_1 }; static const uint8_t modem_raw_desc_2[] = { 0x05, 0x24, 0x01, 0x03, MODEM_IFACE_1 }; static const uint8_t modem_raw_desc_3[] = { 0x04, 0x24, 0x02, 0x07 }; static const void *modem_iface_0_desc[] = { &modem_raw_desc_0, &modem_raw_desc_1, &modem_raw_desc_2, &modem_raw_desc_3, NULL, }; static const struct usb_temp_interface_desc modem_iface_0 = { .ppRawDesc = modem_iface_0_desc, .ppEndpoints = modem_iface_0_ep, .bInterfaceClass = 2, .bInterfaceSubClass = 2, .bInterfaceProtocol = 1, .iInterface = STRING_MODEM_INDEX, }; static const struct usb_temp_interface_desc modem_iface_1 = { .ppEndpoints = modem_iface_1_ep, .bInterfaceClass = 10, .bInterfaceSubClass = 0, .bInterfaceProtocol = 0, .iInterface = STRING_MODEM_INDEX, }; static const struct usb_temp_interface_desc *serialnet_interfaces[] = { &modem_iface_0, &modem_iface_1, ð_control_interface, ð_data_null_interface, ð_data_interface, NULL, }; static const struct usb_temp_config_desc serialnet_config_desc = { .ppIfaceDesc = serialnet_interfaces, .bmAttributes = UC_BUS_POWERED, .bMaxPower = 25, /* 50 mA */ .iConfiguration = STRING_CONFIG_INDEX, }; static const struct usb_temp_config_desc *serialnet_configs[] = { &serialnet_config_desc, NULL, }; const struct usb_temp_device_desc usb_template_serialnet = { .getStringDesc = &serialnet_get_string_desc, .ppConfigDesc = serialnet_configs, .idVendor = USB_TEMPLATE_VENDOR, .idProduct = 0x0001, .bcdDevice = 0x0100, .bDeviceClass = UDCLASS_COMM, .bDeviceSubClass = 0, .bDeviceProtocol = 0, .iManufacturer = STRING_VENDOR_INDEX, .iProduct = STRING_PRODUCT_INDEX, .iSerialNumber = STRING_SERIAL_INDEX, }; /*------------------------------------------------------------------------* * serialnet_get_string_desc * * Return values: * NULL: Failure. No such string. * Else: Success. Pointer to string descriptor is returned. *------------------------------------------------------------------------*/ static const void * serialnet_get_string_desc(uint16_t lang_id, uint8_t string_index) { static const void *ptr[STRING_MAX] = { [STRING_LANG_INDEX] = &usb_string_lang_en, [STRING_MODEM_INDEX] = &string_modem, [STRING_ETH_MAC_INDEX] = &string_eth_mac, [STRING_ETH_CONTROL_INDEX] = &string_eth_control, [STRING_ETH_DATA_INDEX] = &string_eth_data, [STRING_CONFIG_INDEX] = &string_serialnet_config, [STRING_VENDOR_INDEX] = &string_serialnet_vendor, [STRING_PRODUCT_INDEX] = &string_serialnet_product, [STRING_SERIAL_INDEX] = &string_serialnet_serial, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < STRING_MAX) { return (ptr[string_index]); } return (NULL); }