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 <sys/stdint.h> 35 #include <sys/stddef.h> 36 #include <sys/param.h> 37 #include <sys/queue.h> 38 #include <sys/types.h> 39 #include <sys/systm.h> 40 #include <sys/kernel.h> 41 #include <sys/bus.h> 42 #include <sys/module.h> 43 #include <sys/lock.h> 44 #include <sys/mutex.h> 45 #include <sys/condvar.h> 46 #include <sys/sysctl.h> 47 #include <sys/sx.h> 48 #include <sys/unistd.h> 49 #include <sys/callout.h> 50 #include <sys/malloc.h> 51 #include <sys/priv.h> 52 53 #include <dev/usb/usb.h> 54 #include <dev/usb/usbdi.h> 55 #include <dev/usb/usb_cdc.h> 56 57 #include <dev/usb/template/usb_template.h> 58 59 enum { 60 STRING_LANG_INDEX, 61 STRING_MAC_INDEX, 62 STRING_ETH_CONTROL_INDEX, 63 STRING_ETH_DATA_INDEX, 64 STRING_ETH_CONFIG_INDEX, 65 STRING_ETH_VENDOR_INDEX, 66 STRING_ETH_PRODUCT_INDEX, 67 STRING_ETH_SERIAL_INDEX, 68 STRING_ETH_MAX, 69 }; 70 71 #define STRING_LANG \ 72 0x09, 0x04, /* American English */ 73 74 #define STRING_MAC \ 75 '2', 0, 'A', 0, '2', 0, '3', 0, \ 76 '4', 0, '5', 0, '6', 0, '7', 0, \ 77 '8', 0, '9', 0, 'A', 0, 'B', 0, 78 79 #define STRING_ETH_CONTROL \ 80 'U', 0, 'S', 0, 'B', 0, ' ', 0, \ 81 'E', 0, 't', 0, 'h', 0, 'e', 0, \ 82 'r', 0, 'n', 0, 'e', 0, 't', 0, \ 83 ' ', 0, 'C', 0, 'o', 0, 'm', 0, \ 84 'm', 0, ' ', 0, 'i', 0, 'n', 0, \ 85 't', 0, 'e', 0, 'r', 0, 'f', 0, \ 86 'a', 0, 'c', 0, 'e', 0, 87 88 #define STRING_ETH_DATA \ 89 'U', 0, 'S', 0, 'B', 0, ' ', 0, \ 90 'E', 0, 't', 0, 'h', 0, 'e', 0, \ 91 'r', 0, 'n', 0, 'e', 0, 't', 0, \ 92 ' ', 0, 'D', 0, 'a', 0, 't', 0, \ 93 'a', 0, ' ', 0, 'i', 0, 'n', 0, \ 94 't', 0, 'e', 0, 'r', 0, 'f', 0, \ 95 'a', 0, 'c', 0, 'e', 0, 96 97 #define STRING_ETH_CONFIG \ 98 'D', 0, 'e', 0, 'f', 0, 'a', 0, \ 99 'u', 0, 'l', 0, 't', 0, ' ', 0, \ 100 'c', 0, 'o', 0, 'n', 0, 'f', 0, \ 101 'i', 0, 'g', 0, 102 103 #define STRING_ETH_VENDOR \ 104 'F', 0, 'r', 0, 'e', 0, 'e', 0, \ 105 'B', 0, 'S', 0, 'D', 0, ' ', 0, \ 106 'f', 0, 'o', 0, 'u', 0, 'n', 0, \ 107 'd', 0, 'a', 0, 't', 0, 'i', 0, \ 108 'o', 0, 'n', 0, 109 110 #define STRING_ETH_PRODUCT \ 111 'U', 0, 'S', 0, 'B', 0, ' ', 0, \ 112 'E', 0, 't', 0, 'h', 0, 'e', 0, \ 113 'r', 0, 'n', 0, 'e', 0, 't', 0, \ 114 ' ', 0, 'A', 0, 'd', 0, 'a', 0, \ 115 'p', 0, 't', 0, 'e', 0, 'r', 0, 116 117 #define STRING_ETH_SERIAL \ 118 'D', 0, 'e', 0, 'c', 0, 'e', 0, \ 119 'm', 0, 'b', 0, 'e', 0, 'r', 0, \ 120 ' ', 0, '2', 0, '0', 0, '0', 0, \ 121 '7', 0, 122 123 /* make the real string descriptors */ 124 125 USB_MAKE_STRING_DESC(STRING_LANG, string_lang); 126 USB_MAKE_STRING_DESC(STRING_MAC, string_mac); 127 USB_MAKE_STRING_DESC(STRING_ETH_CONTROL, string_eth_control); 128 USB_MAKE_STRING_DESC(STRING_ETH_DATA, string_eth_data); 129 USB_MAKE_STRING_DESC(STRING_ETH_CONFIG, string_eth_config); 130 USB_MAKE_STRING_DESC(STRING_ETH_VENDOR, string_eth_vendor); 131 USB_MAKE_STRING_DESC(STRING_ETH_PRODUCT, string_eth_product); 132 USB_MAKE_STRING_DESC(STRING_ETH_SERIAL, string_eth_serial); 133 134 /* prototypes */ 135 136 static usb_temp_get_string_desc_t eth_get_string_desc; 137 138 static const struct usb_cdc_union_descriptor eth_union_desc = { 139 .bLength = sizeof(eth_union_desc), 140 .bDescriptorType = UDESC_CS_INTERFACE, 141 .bDescriptorSubtype = UDESCSUB_CDC_UNION, 142 .bMasterInterface = 0, /* this is automatically updated */ 143 .bSlaveInterface[0] = 1, /* this is automatically updated */ 144 }; 145 146 static const struct usb_cdc_header_descriptor eth_header_desc = { 147 .bLength = sizeof(eth_header_desc), 148 .bDescriptorType = UDESC_CS_INTERFACE, 149 .bDescriptorSubtype = UDESCSUB_CDC_HEADER, 150 .bcdCDC[0] = 0x10, 151 .bcdCDC[1] = 0x01, 152 }; 153 154 static const struct usb_cdc_ethernet_descriptor eth_enf_desc = { 155 .bLength = sizeof(eth_enf_desc), 156 .bDescriptorType = UDESC_CS_INTERFACE, 157 .bDescriptorSubtype = UDESCSUB_CDC_ENF, 158 .iMacAddress = STRING_MAC_INDEX, 159 .bmEthernetStatistics = {0, 0, 0, 0}, 160 .wMaxSegmentSize = {0xEA, 0x05},/* 1514 bytes */ 161 .wNumberMCFilters = {0, 0}, 162 .bNumberPowerFilters = 0, 163 }; 164 165 static const void *eth_control_if_desc[] = { 166 ð_union_desc, 167 ð_header_desc, 168 ð_enf_desc, 169 NULL, 170 }; 171 172 static const struct usb_temp_packet_size bulk_mps = { 173 .mps[USB_SPEED_FULL] = 64, 174 .mps[USB_SPEED_HIGH] = 512, 175 }; 176 177 static const struct usb_temp_packet_size intr_mps = { 178 .mps[USB_SPEED_FULL] = 8, 179 .mps[USB_SPEED_HIGH] = 8, 180 }; 181 182 static const struct usb_temp_endpoint_desc bulk_in_ep = { 183 .pPacketSize = &bulk_mps, 184 #ifdef USB_HIP_IN_EP_0 185 .bEndpointAddress = USB_HIP_IN_EP_0, 186 #else 187 .bEndpointAddress = UE_DIR_IN, 188 #endif 189 .bmAttributes = UE_BULK, 190 }; 191 192 static const struct usb_temp_endpoint_desc bulk_out_ep = { 193 .pPacketSize = &bulk_mps, 194 #ifdef USB_HIP_OUT_EP_0 195 .bEndpointAddress = USB_HIP_OUT_EP_0, 196 #else 197 .bEndpointAddress = UE_DIR_OUT, 198 #endif 199 .bmAttributes = UE_BULK, 200 }; 201 202 static const struct usb_temp_endpoint_desc intr_in_ep = { 203 .pPacketSize = &intr_mps, 204 .bEndpointAddress = UE_DIR_IN, 205 .bmAttributes = UE_INTERRUPT, 206 }; 207 208 static const struct usb_temp_endpoint_desc *eth_intr_endpoints[] = { 209 &intr_in_ep, 210 NULL, 211 }; 212 213 static const struct usb_temp_interface_desc eth_control_interface = { 214 .ppEndpoints = eth_intr_endpoints, 215 .ppRawDesc = eth_control_if_desc, 216 .bInterfaceClass = UICLASS_CDC, 217 .bInterfaceSubClass = UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL, 218 .bInterfaceProtocol = 0, 219 .iInterface = STRING_ETH_CONTROL_INDEX, 220 }; 221 222 static const struct usb_temp_endpoint_desc *eth_data_endpoints[] = { 223 &bulk_in_ep, 224 &bulk_out_ep, 225 NULL, 226 }; 227 228 static const struct usb_temp_interface_desc eth_data_null_interface = { 229 .ppEndpoints = NULL, /* no endpoints */ 230 .bInterfaceClass = UICLASS_CDC_DATA, 231 .bInterfaceSubClass = 0, 232 .bInterfaceProtocol = 0, 233 .iInterface = STRING_ETH_DATA_INDEX, 234 }; 235 236 static const struct usb_temp_interface_desc eth_data_interface = { 237 .ppEndpoints = eth_data_endpoints, 238 .bInterfaceClass = UICLASS_CDC_DATA, 239 .bInterfaceSubClass = UISUBCLASS_DATA, 240 .bInterfaceProtocol = 0, 241 .iInterface = STRING_ETH_DATA_INDEX, 242 .isAltInterface = 1, /* this is an alternate setting */ 243 }; 244 245 static const struct usb_temp_interface_desc *eth_interfaces[] = { 246 ð_control_interface, 247 ð_data_null_interface, 248 ð_data_interface, 249 NULL, 250 }; 251 252 static const struct usb_temp_config_desc eth_config_desc = { 253 .ppIfaceDesc = eth_interfaces, 254 .bmAttributes = UC_BUS_POWERED, 255 .bMaxPower = 25, /* 50 mA */ 256 .iConfiguration = STRING_ETH_CONFIG_INDEX, 257 }; 258 259 static const struct usb_temp_config_desc *eth_configs[] = { 260 ð_config_desc, 261 NULL, 262 }; 263 264 const struct usb_temp_device_desc usb_template_cdce = { 265 .getStringDesc = ð_get_string_desc, 266 .ppConfigDesc = eth_configs, 267 .idVendor = USB_TEMPLATE_VENDOR, 268 .idProduct = 0x0001, 269 .bcdDevice = 0x0100, 270 .bDeviceClass = UDCLASS_COMM, 271 .bDeviceSubClass = 0, 272 .bDeviceProtocol = 0, 273 .iManufacturer = STRING_ETH_VENDOR_INDEX, 274 .iProduct = STRING_ETH_PRODUCT_INDEX, 275 .iSerialNumber = STRING_ETH_SERIAL_INDEX, 276 }; 277 278 /*------------------------------------------------------------------------* 279 * eth_get_string_desc 280 * 281 * Return values: 282 * NULL: Failure. No such string. 283 * Else: Success. Pointer to string descriptor is returned. 284 *------------------------------------------------------------------------*/ 285 static const void * 286 eth_get_string_desc(uint16_t lang_id, uint8_t string_index) 287 { 288 static const void *ptr[STRING_ETH_MAX] = { 289 [STRING_LANG_INDEX] = &string_lang, 290 [STRING_MAC_INDEX] = &string_mac, 291 [STRING_ETH_CONTROL_INDEX] = &string_eth_control, 292 [STRING_ETH_DATA_INDEX] = &string_eth_data, 293 [STRING_ETH_CONFIG_INDEX] = &string_eth_config, 294 [STRING_ETH_VENDOR_INDEX] = &string_eth_vendor, 295 [STRING_ETH_PRODUCT_INDEX] = &string_eth_product, 296 [STRING_ETH_SERIAL_INDEX] = &string_eth_serial, 297 }; 298 299 if (string_index == 0) { 300 return (&string_lang); 301 } 302 if (lang_id != 0x0409) { 303 return (NULL); 304 } 305 if (string_index < STRING_ETH_MAX) { 306 return (ptr[string_index]); 307 } 308 return (NULL); 309 } 310