1 #include <sys/cdefs.h> 2 __FBSDID("$FreeBSD$"); 3 4 /*- 5 * Copyright (c) 2007 Hans Petter Selasky <hselasky@FreeBSD.org> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 /* 31 * This file contains the USB templates for a CDC USB ethernet device. 32 */ 33 34 #include <dev/usb/usb.h> 35 #include <dev/usb/usb_cdc.h> 36 #include <dev/usb/usb_mfunc.h> 37 38 #include <dev/usb/usb_core.h> 39 40 #include <dev/usb/template/usb_template.h> 41 42 enum { 43 STRING_LANG_INDEX, 44 STRING_MAC_INDEX, 45 STRING_ETH_CONTROL_INDEX, 46 STRING_ETH_DATA_INDEX, 47 STRING_ETH_CONFIG_INDEX, 48 STRING_ETH_VENDOR_INDEX, 49 STRING_ETH_PRODUCT_INDEX, 50 STRING_ETH_SERIAL_INDEX, 51 STRING_ETH_MAX, 52 }; 53 54 #define STRING_LANG \ 55 0x09, 0x04, /* American English */ 56 57 #define STRING_MAC \ 58 '2', 0, 'A', 0, '2', 0, '3', 0, \ 59 '4', 0, '5', 0, '6', 0, '7', 0, \ 60 '8', 0, '9', 0, 'A', 0, 'B', 0, 61 62 #define STRING_ETH_CONTROL \ 63 'U', 0, 'S', 0, 'B', 0, ' ', 0, \ 64 'E', 0, 't', 0, 'h', 0, 'e', 0, \ 65 'r', 0, 'n', 0, 'e', 0, 't', 0, \ 66 ' ', 0, 'C', 0, 'o', 0, 'm', 0, \ 67 'm', 0, ' ', 0, 'i', 0, 'n', 0, \ 68 't', 0, 'e', 0, 'r', 0, 'f', 0, \ 69 'a', 0, 'c', 0, 'e', 0, 70 71 #define STRING_ETH_DATA \ 72 'U', 0, 'S', 0, 'B', 0, ' ', 0, \ 73 'E', 0, 't', 0, 'h', 0, 'e', 0, \ 74 'r', 0, 'n', 0, 'e', 0, 't', 0, \ 75 ' ', 0, 'D', 0, 'a', 0, 't', 0, \ 76 'a', 0, ' ', 0, 'i', 0, 'n', 0, \ 77 't', 0, 'e', 0, 'r', 0, 'f', 0, \ 78 'a', 0, 'c', 0, 'e', 0, 79 80 #define STRING_ETH_CONFIG \ 81 'D', 0, 'e', 0, 'f', 0, 'a', 0, \ 82 'u', 0, 'l', 0, 't', 0, ' ', 0, \ 83 'c', 0, 'o', 0, 'n', 0, 'f', 0, \ 84 'i', 0, 'g', 0, 85 86 #define STRING_ETH_VENDOR \ 87 'F', 0, 'r', 0, 'e', 0, 'e', 0, \ 88 'B', 0, 'S', 0, 'D', 0, ' ', 0, \ 89 'f', 0, 'o', 0, 'u', 0, 'n', 0, \ 90 'd', 0, 'a', 0, 't', 0, 'i', 0, \ 91 'o', 0, 'n', 0, 92 93 #define STRING_ETH_PRODUCT \ 94 'U', 0, 'S', 0, 'B', 0, ' ', 0, \ 95 'E', 0, 't', 0, 'h', 0, 'e', 0, \ 96 'r', 0, 'n', 0, 'e', 0, 't', 0, \ 97 ' ', 0, 'A', 0, 'd', 0, 'a', 0, \ 98 'p', 0, 't', 0, 'e', 0, 'r', 0, 99 100 #define STRING_ETH_SERIAL \ 101 'D', 0, 'e', 0, 'c', 0, 'e', 0, \ 102 'm', 0, 'b', 0, 'e', 0, 'r', 0, \ 103 ' ', 0, '2', 0, '0', 0, '0', 0, \ 104 '7', 0, 105 106 /* make the real string descriptors */ 107 108 USB_MAKE_STRING_DESC(STRING_LANG, string_lang); 109 USB_MAKE_STRING_DESC(STRING_MAC, string_mac); 110 USB_MAKE_STRING_DESC(STRING_ETH_CONTROL, string_eth_control); 111 USB_MAKE_STRING_DESC(STRING_ETH_DATA, string_eth_data); 112 USB_MAKE_STRING_DESC(STRING_ETH_CONFIG, string_eth_config); 113 USB_MAKE_STRING_DESC(STRING_ETH_VENDOR, string_eth_vendor); 114 USB_MAKE_STRING_DESC(STRING_ETH_PRODUCT, string_eth_product); 115 USB_MAKE_STRING_DESC(STRING_ETH_SERIAL, string_eth_serial); 116 117 /* prototypes */ 118 119 static usb2_temp_get_string_desc_t eth_get_string_desc; 120 121 static const struct usb2_cdc_union_descriptor eth_union_desc = { 122 .bLength = sizeof(eth_union_desc), 123 .bDescriptorType = UDESC_CS_INTERFACE, 124 .bDescriptorSubtype = UDESCSUB_CDC_UNION, 125 .bMasterInterface = 0, /* this is automatically updated */ 126 .bSlaveInterface[0] = 1, /* this is automatically updated */ 127 }; 128 129 static const struct usb2_cdc_header_descriptor eth_header_desc = { 130 .bLength = sizeof(eth_header_desc), 131 .bDescriptorType = UDESC_CS_INTERFACE, 132 .bDescriptorSubtype = UDESCSUB_CDC_HEADER, 133 .bcdCDC[0] = 0x10, 134 .bcdCDC[1] = 0x01, 135 }; 136 137 static const struct usb2_cdc_ethernet_descriptor eth_enf_desc = { 138 .bLength = sizeof(eth_enf_desc), 139 .bDescriptorType = UDESC_CS_INTERFACE, 140 .bDescriptorSubtype = UDESCSUB_CDC_ENF, 141 .iMacAddress = STRING_MAC_INDEX, 142 .bmEthernetStatistics = {0, 0, 0, 0}, 143 .wMaxSegmentSize = {0xEA, 0x05},/* 1514 bytes */ 144 .wNumberMCFilters = {0, 0}, 145 .bNumberPowerFilters = 0, 146 }; 147 148 static const void *eth_control_if_desc[] = { 149 ð_union_desc, 150 ð_header_desc, 151 ð_enf_desc, 152 NULL, 153 }; 154 155 static const struct usb2_temp_packet_size bulk_mps = { 156 .mps[USB_SPEED_FULL] = 64, 157 .mps[USB_SPEED_HIGH] = 512, 158 }; 159 160 static const struct usb2_temp_packet_size intr_mps = { 161 .mps[USB_SPEED_FULL] = 8, 162 .mps[USB_SPEED_HIGH] = 8, 163 }; 164 165 static const struct usb2_temp_endpoint_desc bulk_in_ep = { 166 .pPacketSize = &bulk_mps, 167 #ifdef USB_HIP_IN_EP_0 168 .bEndpointAddress = USB_HIP_IN_EP_0, 169 #else 170 .bEndpointAddress = UE_DIR_IN, 171 #endif 172 .bmAttributes = UE_BULK, 173 }; 174 175 static const struct usb2_temp_endpoint_desc bulk_out_ep = { 176 .pPacketSize = &bulk_mps, 177 #ifdef USB_HIP_OUT_EP_0 178 .bEndpointAddress = USB_HIP_OUT_EP_0, 179 #else 180 .bEndpointAddress = UE_DIR_OUT, 181 #endif 182 .bmAttributes = UE_BULK, 183 }; 184 185 static const struct usb2_temp_endpoint_desc intr_in_ep = { 186 .pPacketSize = &intr_mps, 187 .bEndpointAddress = UE_DIR_IN, 188 .bmAttributes = UE_INTERRUPT, 189 }; 190 191 static const struct usb2_temp_endpoint_desc *eth_intr_endpoints[] = { 192 &intr_in_ep, 193 NULL, 194 }; 195 196 static const struct usb2_temp_interface_desc eth_control_interface = { 197 .ppEndpoints = eth_intr_endpoints, 198 .ppRawDesc = eth_control_if_desc, 199 .bInterfaceClass = UICLASS_CDC, 200 .bInterfaceSubClass = UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL, 201 .bInterfaceProtocol = 0, 202 .iInterface = STRING_ETH_CONTROL_INDEX, 203 }; 204 205 static const struct usb2_temp_endpoint_desc *eth_data_endpoints[] = { 206 &bulk_in_ep, 207 &bulk_out_ep, 208 NULL, 209 }; 210 211 static const struct usb2_temp_interface_desc eth_data_null_interface = { 212 .ppEndpoints = NULL, /* no endpoints */ 213 .bInterfaceClass = UICLASS_CDC_DATA, 214 .bInterfaceSubClass = 0, 215 .bInterfaceProtocol = 0, 216 .iInterface = STRING_ETH_DATA_INDEX, 217 }; 218 219 static const struct usb2_temp_interface_desc eth_data_interface = { 220 .ppEndpoints = eth_data_endpoints, 221 .bInterfaceClass = UICLASS_CDC_DATA, 222 .bInterfaceSubClass = UISUBCLASS_DATA, 223 .bInterfaceProtocol = 0, 224 .iInterface = STRING_ETH_DATA_INDEX, 225 .isAltInterface = 1, /* this is an alternate setting */ 226 }; 227 228 static const struct usb2_temp_interface_desc *eth_interfaces[] = { 229 ð_control_interface, 230 ð_data_null_interface, 231 ð_data_interface, 232 NULL, 233 }; 234 235 static const struct usb2_temp_config_desc eth_config_desc = { 236 .ppIfaceDesc = eth_interfaces, 237 .bmAttributes = UC_BUS_POWERED, 238 .bMaxPower = 25, /* 50 mA */ 239 .iConfiguration = STRING_ETH_CONFIG_INDEX, 240 }; 241 242 static const struct usb2_temp_config_desc *eth_configs[] = { 243 ð_config_desc, 244 NULL, 245 }; 246 247 const struct usb2_temp_device_desc usb2_template_cdce = { 248 .getStringDesc = ð_get_string_desc, 249 .ppConfigDesc = eth_configs, 250 .idVendor = 0x0001, 251 .idProduct = 0x0001, 252 .bcdDevice = 0x0100, 253 .bDeviceClass = UDCLASS_COMM, 254 .bDeviceSubClass = 0, 255 .bDeviceProtocol = 0, 256 .iManufacturer = STRING_ETH_VENDOR_INDEX, 257 .iProduct = STRING_ETH_PRODUCT_INDEX, 258 .iSerialNumber = STRING_ETH_SERIAL_INDEX, 259 }; 260 261 /*------------------------------------------------------------------------* 262 * eth_get_string_desc 263 * 264 * Return values: 265 * NULL: Failure. No such string. 266 * Else: Success. Pointer to string descriptor is returned. 267 *------------------------------------------------------------------------*/ 268 static const void * 269 eth_get_string_desc(uint16_t lang_id, uint8_t string_index) 270 { 271 static const void *ptr[STRING_ETH_MAX] = { 272 [STRING_LANG_INDEX] = &string_lang, 273 [STRING_MAC_INDEX] = &string_mac, 274 [STRING_ETH_CONTROL_INDEX] = &string_eth_control, 275 [STRING_ETH_DATA_INDEX] = &string_eth_data, 276 [STRING_ETH_CONFIG_INDEX] = &string_eth_config, 277 [STRING_ETH_VENDOR_INDEX] = &string_eth_vendor, 278 [STRING_ETH_PRODUCT_INDEX] = &string_eth_product, 279 [STRING_ETH_SERIAL_INDEX] = &string_eth_serial, 280 }; 281 282 if (string_index == 0) { 283 return (&string_lang); 284 } 285 if (lang_id != 0x0409) { 286 return (NULL); 287 } 288 if (string_index < STRING_ETH_MAX) { 289 return (ptr[string_index]); 290 } 291 return (NULL); 292 } 293