dev-network.c 43 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426
  1. /*
  2. * QEMU USB Net devices
  3. *
  4. * Copyright (c) 2006 Thomas Sailer
  5. * Copyright (c) 2008 Andrzej Zaborowski
  6. *
  7. * Permission is hereby granted, free of charge, to any person obtaining a copy
  8. * of this software and associated documentation files (the "Software"), to deal
  9. * in the Software without restriction, including without limitation the rights
  10. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. * copies of the Software, and to permit persons to whom the Software is
  12. * furnished to do so, subject to the following conditions:
  13. *
  14. * The above copyright notice and this permission notice shall be included in
  15. * all copies or substantial portions of the Software.
  16. *
  17. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20. * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23. * THE SOFTWARE.
  24. */
  25. #include "qemu/osdep.h"
  26. #include "qapi/error.h"
  27. #include "qemu-common.h"
  28. #include "hw/usb.h"
  29. #include "desc.h"
  30. #include "net/net.h"
  31. #include "qemu/error-report.h"
  32. #include "qemu/queue.h"
  33. #include "qemu/config-file.h"
  34. #include "sysemu/sysemu.h"
  35. #include "qemu/iov.h"
  36. #include "qemu/cutils.h"
  37. /*#define TRAFFIC_DEBUG*/
  38. /* Thanks to NetChip Technologies for donating this product ID.
  39. * It's for devices with only CDC Ethernet configurations.
  40. */
  41. #define CDC_VENDOR_NUM 0x0525 /* NetChip */
  42. #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
  43. /* For hardware that can talk RNDIS and either of the above protocols,
  44. * use this ID ... the windows INF files will know it.
  45. */
  46. #define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
  47. #define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
  48. enum usbstring_idx {
  49. STRING_MANUFACTURER = 1,
  50. STRING_PRODUCT,
  51. STRING_ETHADDR,
  52. STRING_DATA,
  53. STRING_CONTROL,
  54. STRING_RNDIS_CONTROL,
  55. STRING_CDC,
  56. STRING_SUBSET,
  57. STRING_RNDIS,
  58. STRING_SERIALNUMBER,
  59. };
  60. #define DEV_CONFIG_VALUE 1 /* CDC or a subset */
  61. #define DEV_RNDIS_CONFIG_VALUE 2 /* RNDIS; optional */
  62. #define USB_CDC_SUBCLASS_ACM 0x02
  63. #define USB_CDC_SUBCLASS_ETHERNET 0x06
  64. #define USB_CDC_PROTO_NONE 0
  65. #define USB_CDC_ACM_PROTO_VENDOR 0xff
  66. #define USB_CDC_HEADER_TYPE 0x00 /* header_desc */
  67. #define USB_CDC_CALL_MANAGEMENT_TYPE 0x01 /* call_mgmt_descriptor */
  68. #define USB_CDC_ACM_TYPE 0x02 /* acm_descriptor */
  69. #define USB_CDC_UNION_TYPE 0x06 /* union_desc */
  70. #define USB_CDC_ETHERNET_TYPE 0x0f /* ether_desc */
  71. #define USB_CDC_SEND_ENCAPSULATED_COMMAND 0x00
  72. #define USB_CDC_GET_ENCAPSULATED_RESPONSE 0x01
  73. #define USB_CDC_REQ_SET_LINE_CODING 0x20
  74. #define USB_CDC_REQ_GET_LINE_CODING 0x21
  75. #define USB_CDC_REQ_SET_CONTROL_LINE_STATE 0x22
  76. #define USB_CDC_REQ_SEND_BREAK 0x23
  77. #define USB_CDC_SET_ETHERNET_MULTICAST_FILTERS 0x40
  78. #define USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER 0x41
  79. #define USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER 0x42
  80. #define USB_CDC_SET_ETHERNET_PACKET_FILTER 0x43
  81. #define USB_CDC_GET_ETHERNET_STATISTIC 0x44
  82. #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
  83. #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
  84. #define ETH_FRAME_LEN 1514 /* Max. octets in frame sans FCS */
  85. static const USBDescStrings usb_net_stringtable = {
  86. [STRING_MANUFACTURER] = "QEMU",
  87. [STRING_PRODUCT] = "RNDIS/QEMU USB Network Device",
  88. [STRING_ETHADDR] = "400102030405",
  89. [STRING_DATA] = "QEMU USB Net Data Interface",
  90. [STRING_CONTROL] = "QEMU USB Net Control Interface",
  91. [STRING_RNDIS_CONTROL] = "QEMU USB Net RNDIS Control Interface",
  92. [STRING_CDC] = "QEMU USB Net CDC",
  93. [STRING_SUBSET] = "QEMU USB Net Subset",
  94. [STRING_RNDIS] = "QEMU USB Net RNDIS",
  95. [STRING_SERIALNUMBER] = "1",
  96. };
  97. static const USBDescIface desc_iface_rndis[] = {
  98. {
  99. /* RNDIS Control Interface */
  100. .bInterfaceNumber = 0,
  101. .bNumEndpoints = 1,
  102. .bInterfaceClass = USB_CLASS_COMM,
  103. .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
  104. .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR,
  105. .iInterface = STRING_RNDIS_CONTROL,
  106. .ndesc = 4,
  107. .descs = (USBDescOther[]) {
  108. {
  109. /* Header Descriptor */
  110. .data = (uint8_t[]) {
  111. 0x05, /* u8 bLength */
  112. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  113. USB_CDC_HEADER_TYPE, /* u8 bDescriptorSubType */
  114. 0x10, 0x01, /* le16 bcdCDC */
  115. },
  116. },{
  117. /* Call Management Descriptor */
  118. .data = (uint8_t[]) {
  119. 0x05, /* u8 bLength */
  120. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  121. USB_CDC_CALL_MANAGEMENT_TYPE, /* u8 bDescriptorSubType */
  122. 0x00, /* u8 bmCapabilities */
  123. 0x01, /* u8 bDataInterface */
  124. },
  125. },{
  126. /* ACM Descriptor */
  127. .data = (uint8_t[]) {
  128. 0x04, /* u8 bLength */
  129. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  130. USB_CDC_ACM_TYPE, /* u8 bDescriptorSubType */
  131. 0x00, /* u8 bmCapabilities */
  132. },
  133. },{
  134. /* Union Descriptor */
  135. .data = (uint8_t[]) {
  136. 0x05, /* u8 bLength */
  137. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  138. USB_CDC_UNION_TYPE, /* u8 bDescriptorSubType */
  139. 0x00, /* u8 bMasterInterface0 */
  140. 0x01, /* u8 bSlaveInterface0 */
  141. },
  142. },
  143. },
  144. .eps = (USBDescEndpoint[]) {
  145. {
  146. .bEndpointAddress = USB_DIR_IN | 0x01,
  147. .bmAttributes = USB_ENDPOINT_XFER_INT,
  148. .wMaxPacketSize = STATUS_BYTECOUNT,
  149. .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
  150. },
  151. }
  152. },{
  153. /* RNDIS Data Interface */
  154. .bInterfaceNumber = 1,
  155. .bNumEndpoints = 2,
  156. .bInterfaceClass = USB_CLASS_CDC_DATA,
  157. .iInterface = STRING_DATA,
  158. .eps = (USBDescEndpoint[]) {
  159. {
  160. .bEndpointAddress = USB_DIR_IN | 0x02,
  161. .bmAttributes = USB_ENDPOINT_XFER_BULK,
  162. .wMaxPacketSize = 0x40,
  163. },{
  164. .bEndpointAddress = USB_DIR_OUT | 0x02,
  165. .bmAttributes = USB_ENDPOINT_XFER_BULK,
  166. .wMaxPacketSize = 0x40,
  167. }
  168. }
  169. }
  170. };
  171. static const USBDescIface desc_iface_cdc[] = {
  172. {
  173. /* CDC Control Interface */
  174. .bInterfaceNumber = 0,
  175. .bNumEndpoints = 1,
  176. .bInterfaceClass = USB_CLASS_COMM,
  177. .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
  178. .bInterfaceProtocol = USB_CDC_PROTO_NONE,
  179. .iInterface = STRING_CONTROL,
  180. .ndesc = 3,
  181. .descs = (USBDescOther[]) {
  182. {
  183. /* Header Descriptor */
  184. .data = (uint8_t[]) {
  185. 0x05, /* u8 bLength */
  186. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  187. USB_CDC_HEADER_TYPE, /* u8 bDescriptorSubType */
  188. 0x10, 0x01, /* le16 bcdCDC */
  189. },
  190. },{
  191. /* Union Descriptor */
  192. .data = (uint8_t[]) {
  193. 0x05, /* u8 bLength */
  194. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  195. USB_CDC_UNION_TYPE, /* u8 bDescriptorSubType */
  196. 0x00, /* u8 bMasterInterface0 */
  197. 0x01, /* u8 bSlaveInterface0 */
  198. },
  199. },{
  200. /* Ethernet Descriptor */
  201. .data = (uint8_t[]) {
  202. 0x0d, /* u8 bLength */
  203. USB_DT_CS_INTERFACE, /* u8 bDescriptorType */
  204. USB_CDC_ETHERNET_TYPE, /* u8 bDescriptorSubType */
  205. STRING_ETHADDR, /* u8 iMACAddress */
  206. 0x00, 0x00, 0x00, 0x00, /* le32 bmEthernetStatistics */
  207. ETH_FRAME_LEN & 0xff,
  208. ETH_FRAME_LEN >> 8, /* le16 wMaxSegmentSize */
  209. 0x00, 0x00, /* le16 wNumberMCFilters */
  210. 0x00, /* u8 bNumberPowerFilters */
  211. },
  212. },
  213. },
  214. .eps = (USBDescEndpoint[]) {
  215. {
  216. .bEndpointAddress = USB_DIR_IN | 0x01,
  217. .bmAttributes = USB_ENDPOINT_XFER_INT,
  218. .wMaxPacketSize = STATUS_BYTECOUNT,
  219. .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
  220. },
  221. }
  222. },{
  223. /* CDC Data Interface (off) */
  224. .bInterfaceNumber = 1,
  225. .bAlternateSetting = 0,
  226. .bNumEndpoints = 0,
  227. .bInterfaceClass = USB_CLASS_CDC_DATA,
  228. },{
  229. /* CDC Data Interface */
  230. .bInterfaceNumber = 1,
  231. .bAlternateSetting = 1,
  232. .bNumEndpoints = 2,
  233. .bInterfaceClass = USB_CLASS_CDC_DATA,
  234. .iInterface = STRING_DATA,
  235. .eps = (USBDescEndpoint[]) {
  236. {
  237. .bEndpointAddress = USB_DIR_IN | 0x02,
  238. .bmAttributes = USB_ENDPOINT_XFER_BULK,
  239. .wMaxPacketSize = 0x40,
  240. },{
  241. .bEndpointAddress = USB_DIR_OUT | 0x02,
  242. .bmAttributes = USB_ENDPOINT_XFER_BULK,
  243. .wMaxPacketSize = 0x40,
  244. }
  245. }
  246. }
  247. };
  248. static const USBDescDevice desc_device_net = {
  249. .bcdUSB = 0x0200,
  250. .bDeviceClass = USB_CLASS_COMM,
  251. .bMaxPacketSize0 = 0x40,
  252. .bNumConfigurations = 2,
  253. .confs = (USBDescConfig[]) {
  254. {
  255. .bNumInterfaces = 2,
  256. .bConfigurationValue = DEV_RNDIS_CONFIG_VALUE,
  257. .iConfiguration = STRING_RNDIS,
  258. .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
  259. .bMaxPower = 0x32,
  260. .nif = ARRAY_SIZE(desc_iface_rndis),
  261. .ifs = desc_iface_rndis,
  262. },{
  263. .bNumInterfaces = 2,
  264. .bConfigurationValue = DEV_CONFIG_VALUE,
  265. .iConfiguration = STRING_CDC,
  266. .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
  267. .bMaxPower = 0x32,
  268. .nif = ARRAY_SIZE(desc_iface_cdc),
  269. .ifs = desc_iface_cdc,
  270. }
  271. },
  272. };
  273. static const USBDesc desc_net = {
  274. .id = {
  275. .idVendor = RNDIS_VENDOR_NUM,
  276. .idProduct = RNDIS_PRODUCT_NUM,
  277. .bcdDevice = 0,
  278. .iManufacturer = STRING_MANUFACTURER,
  279. .iProduct = STRING_PRODUCT,
  280. .iSerialNumber = STRING_SERIALNUMBER,
  281. },
  282. .full = &desc_device_net,
  283. .str = usb_net_stringtable,
  284. };
  285. /*
  286. * RNDIS Definitions - in theory not specific to USB.
  287. */
  288. #define RNDIS_MAXIMUM_FRAME_SIZE 1518
  289. #define RNDIS_MAX_TOTAL_SIZE 1558
  290. /* Remote NDIS Versions */
  291. #define RNDIS_MAJOR_VERSION 1
  292. #define RNDIS_MINOR_VERSION 0
  293. /* Status Values */
  294. #define RNDIS_STATUS_SUCCESS 0x00000000U /* Success */
  295. #define RNDIS_STATUS_FAILURE 0xc0000001U /* Unspecified error */
  296. #define RNDIS_STATUS_INVALID_DATA 0xc0010015U /* Invalid data */
  297. #define RNDIS_STATUS_NOT_SUPPORTED 0xc00000bbU /* Unsupported request */
  298. #define RNDIS_STATUS_MEDIA_CONNECT 0x4001000bU /* Device connected */
  299. #define RNDIS_STATUS_MEDIA_DISCONNECT 0x4001000cU /* Device disconnected */
  300. /* Message Set for Connectionless (802.3) Devices */
  301. enum {
  302. RNDIS_PACKET_MSG = 1,
  303. RNDIS_INITIALIZE_MSG = 2, /* Initialize device */
  304. RNDIS_HALT_MSG = 3,
  305. RNDIS_QUERY_MSG = 4,
  306. RNDIS_SET_MSG = 5,
  307. RNDIS_RESET_MSG = 6,
  308. RNDIS_INDICATE_STATUS_MSG = 7,
  309. RNDIS_KEEPALIVE_MSG = 8,
  310. };
  311. /* Message completion */
  312. enum {
  313. RNDIS_INITIALIZE_CMPLT = 0x80000002U,
  314. RNDIS_QUERY_CMPLT = 0x80000004U,
  315. RNDIS_SET_CMPLT = 0x80000005U,
  316. RNDIS_RESET_CMPLT = 0x80000006U,
  317. RNDIS_KEEPALIVE_CMPLT = 0x80000008U,
  318. };
  319. /* Device Flags */
  320. enum {
  321. RNDIS_DF_CONNECTIONLESS = 1,
  322. RNDIS_DF_CONNECTIONORIENTED = 2,
  323. };
  324. #define RNDIS_MEDIUM_802_3 0x00000000U
  325. /* from drivers/net/sk98lin/h/skgepnmi.h */
  326. #define OID_PNP_CAPABILITIES 0xfd010100
  327. #define OID_PNP_SET_POWER 0xfd010101
  328. #define OID_PNP_QUERY_POWER 0xfd010102
  329. #define OID_PNP_ADD_WAKE_UP_PATTERN 0xfd010103
  330. #define OID_PNP_REMOVE_WAKE_UP_PATTERN 0xfd010104
  331. #define OID_PNP_ENABLE_WAKE_UP 0xfd010106
  332. typedef uint32_t le32;
  333. typedef struct rndis_init_msg_type {
  334. le32 MessageType;
  335. le32 MessageLength;
  336. le32 RequestID;
  337. le32 MajorVersion;
  338. le32 MinorVersion;
  339. le32 MaxTransferSize;
  340. } rndis_init_msg_type;
  341. typedef struct rndis_init_cmplt_type {
  342. le32 MessageType;
  343. le32 MessageLength;
  344. le32 RequestID;
  345. le32 Status;
  346. le32 MajorVersion;
  347. le32 MinorVersion;
  348. le32 DeviceFlags;
  349. le32 Medium;
  350. le32 MaxPacketsPerTransfer;
  351. le32 MaxTransferSize;
  352. le32 PacketAlignmentFactor;
  353. le32 AFListOffset;
  354. le32 AFListSize;
  355. } rndis_init_cmplt_type;
  356. typedef struct rndis_halt_msg_type {
  357. le32 MessageType;
  358. le32 MessageLength;
  359. le32 RequestID;
  360. } rndis_halt_msg_type;
  361. typedef struct rndis_query_msg_type {
  362. le32 MessageType;
  363. le32 MessageLength;
  364. le32 RequestID;
  365. le32 OID;
  366. le32 InformationBufferLength;
  367. le32 InformationBufferOffset;
  368. le32 DeviceVcHandle;
  369. } rndis_query_msg_type;
  370. typedef struct rndis_query_cmplt_type {
  371. le32 MessageType;
  372. le32 MessageLength;
  373. le32 RequestID;
  374. le32 Status;
  375. le32 InformationBufferLength;
  376. le32 InformationBufferOffset;
  377. } rndis_query_cmplt_type;
  378. typedef struct rndis_set_msg_type {
  379. le32 MessageType;
  380. le32 MessageLength;
  381. le32 RequestID;
  382. le32 OID;
  383. le32 InformationBufferLength;
  384. le32 InformationBufferOffset;
  385. le32 DeviceVcHandle;
  386. } rndis_set_msg_type;
  387. typedef struct rndis_set_cmplt_type {
  388. le32 MessageType;
  389. le32 MessageLength;
  390. le32 RequestID;
  391. le32 Status;
  392. } rndis_set_cmplt_type;
  393. typedef struct rndis_reset_msg_type {
  394. le32 MessageType;
  395. le32 MessageLength;
  396. le32 Reserved;
  397. } rndis_reset_msg_type;
  398. typedef struct rndis_reset_cmplt_type {
  399. le32 MessageType;
  400. le32 MessageLength;
  401. le32 Status;
  402. le32 AddressingReset;
  403. } rndis_reset_cmplt_type;
  404. typedef struct rndis_indicate_status_msg_type {
  405. le32 MessageType;
  406. le32 MessageLength;
  407. le32 Status;
  408. le32 StatusBufferLength;
  409. le32 StatusBufferOffset;
  410. } rndis_indicate_status_msg_type;
  411. typedef struct rndis_keepalive_msg_type {
  412. le32 MessageType;
  413. le32 MessageLength;
  414. le32 RequestID;
  415. } rndis_keepalive_msg_type;
  416. typedef struct rndis_keepalive_cmplt_type {
  417. le32 MessageType;
  418. le32 MessageLength;
  419. le32 RequestID;
  420. le32 Status;
  421. } rndis_keepalive_cmplt_type;
  422. struct rndis_packet_msg_type {
  423. le32 MessageType;
  424. le32 MessageLength;
  425. le32 DataOffset;
  426. le32 DataLength;
  427. le32 OOBDataOffset;
  428. le32 OOBDataLength;
  429. le32 NumOOBDataElements;
  430. le32 PerPacketInfoOffset;
  431. le32 PerPacketInfoLength;
  432. le32 VcHandle;
  433. le32 Reserved;
  434. };
  435. struct rndis_config_parameter {
  436. le32 ParameterNameOffset;
  437. le32 ParameterNameLength;
  438. le32 ParameterType;
  439. le32 ParameterValueOffset;
  440. le32 ParameterValueLength;
  441. };
  442. /* implementation specific */
  443. enum rndis_state
  444. {
  445. RNDIS_UNINITIALIZED,
  446. RNDIS_INITIALIZED,
  447. RNDIS_DATA_INITIALIZED,
  448. };
  449. /* from ndis.h */
  450. enum ndis_oid {
  451. /* Required Object IDs (OIDs) */
  452. OID_GEN_SUPPORTED_LIST = 0x00010101,
  453. OID_GEN_HARDWARE_STATUS = 0x00010102,
  454. OID_GEN_MEDIA_SUPPORTED = 0x00010103,
  455. OID_GEN_MEDIA_IN_USE = 0x00010104,
  456. OID_GEN_MAXIMUM_LOOKAHEAD = 0x00010105,
  457. OID_GEN_MAXIMUM_FRAME_SIZE = 0x00010106,
  458. OID_GEN_LINK_SPEED = 0x00010107,
  459. OID_GEN_TRANSMIT_BUFFER_SPACE = 0x00010108,
  460. OID_GEN_RECEIVE_BUFFER_SPACE = 0x00010109,
  461. OID_GEN_TRANSMIT_BLOCK_SIZE = 0x0001010a,
  462. OID_GEN_RECEIVE_BLOCK_SIZE = 0x0001010b,
  463. OID_GEN_VENDOR_ID = 0x0001010c,
  464. OID_GEN_VENDOR_DESCRIPTION = 0x0001010d,
  465. OID_GEN_CURRENT_PACKET_FILTER = 0x0001010e,
  466. OID_GEN_CURRENT_LOOKAHEAD = 0x0001010f,
  467. OID_GEN_DRIVER_VERSION = 0x00010110,
  468. OID_GEN_MAXIMUM_TOTAL_SIZE = 0x00010111,
  469. OID_GEN_PROTOCOL_OPTIONS = 0x00010112,
  470. OID_GEN_MAC_OPTIONS = 0x00010113,
  471. OID_GEN_MEDIA_CONNECT_STATUS = 0x00010114,
  472. OID_GEN_MAXIMUM_SEND_PACKETS = 0x00010115,
  473. OID_GEN_VENDOR_DRIVER_VERSION = 0x00010116,
  474. OID_GEN_SUPPORTED_GUIDS = 0x00010117,
  475. OID_GEN_NETWORK_LAYER_ADDRESSES = 0x00010118,
  476. OID_GEN_TRANSPORT_HEADER_OFFSET = 0x00010119,
  477. OID_GEN_MACHINE_NAME = 0x0001021a,
  478. OID_GEN_RNDIS_CONFIG_PARAMETER = 0x0001021b,
  479. OID_GEN_VLAN_ID = 0x0001021c,
  480. /* Optional OIDs */
  481. OID_GEN_MEDIA_CAPABILITIES = 0x00010201,
  482. OID_GEN_PHYSICAL_MEDIUM = 0x00010202,
  483. /* Required statistics OIDs */
  484. OID_GEN_XMIT_OK = 0x00020101,
  485. OID_GEN_RCV_OK = 0x00020102,
  486. OID_GEN_XMIT_ERROR = 0x00020103,
  487. OID_GEN_RCV_ERROR = 0x00020104,
  488. OID_GEN_RCV_NO_BUFFER = 0x00020105,
  489. /* Optional statistics OIDs */
  490. OID_GEN_DIRECTED_BYTES_XMIT = 0x00020201,
  491. OID_GEN_DIRECTED_FRAMES_XMIT = 0x00020202,
  492. OID_GEN_MULTICAST_BYTES_XMIT = 0x00020203,
  493. OID_GEN_MULTICAST_FRAMES_XMIT = 0x00020204,
  494. OID_GEN_BROADCAST_BYTES_XMIT = 0x00020205,
  495. OID_GEN_BROADCAST_FRAMES_XMIT = 0x00020206,
  496. OID_GEN_DIRECTED_BYTES_RCV = 0x00020207,
  497. OID_GEN_DIRECTED_FRAMES_RCV = 0x00020208,
  498. OID_GEN_MULTICAST_BYTES_RCV = 0x00020209,
  499. OID_GEN_MULTICAST_FRAMES_RCV = 0x0002020a,
  500. OID_GEN_BROADCAST_BYTES_RCV = 0x0002020b,
  501. OID_GEN_BROADCAST_FRAMES_RCV = 0x0002020c,
  502. OID_GEN_RCV_CRC_ERROR = 0x0002020d,
  503. OID_GEN_TRANSMIT_QUEUE_LENGTH = 0x0002020e,
  504. OID_GEN_GET_TIME_CAPS = 0x0002020f,
  505. OID_GEN_GET_NETCARD_TIME = 0x00020210,
  506. OID_GEN_NETCARD_LOAD = 0x00020211,
  507. OID_GEN_DEVICE_PROFILE = 0x00020212,
  508. OID_GEN_INIT_TIME_MS = 0x00020213,
  509. OID_GEN_RESET_COUNTS = 0x00020214,
  510. OID_GEN_MEDIA_SENSE_COUNTS = 0x00020215,
  511. OID_GEN_FRIENDLY_NAME = 0x00020216,
  512. OID_GEN_MINIPORT_INFO = 0x00020217,
  513. OID_GEN_RESET_VERIFY_PARAMETERS = 0x00020218,
  514. /* IEEE 802.3 (Ethernet) OIDs */
  515. OID_802_3_PERMANENT_ADDRESS = 0x01010101,
  516. OID_802_3_CURRENT_ADDRESS = 0x01010102,
  517. OID_802_3_MULTICAST_LIST = 0x01010103,
  518. OID_802_3_MAXIMUM_LIST_SIZE = 0x01010104,
  519. OID_802_3_MAC_OPTIONS = 0x01010105,
  520. OID_802_3_RCV_ERROR_ALIGNMENT = 0x01020101,
  521. OID_802_3_XMIT_ONE_COLLISION = 0x01020102,
  522. OID_802_3_XMIT_MORE_COLLISIONS = 0x01020103,
  523. OID_802_3_XMIT_DEFERRED = 0x01020201,
  524. OID_802_3_XMIT_MAX_COLLISIONS = 0x01020202,
  525. OID_802_3_RCV_OVERRUN = 0x01020203,
  526. OID_802_3_XMIT_UNDERRUN = 0x01020204,
  527. OID_802_3_XMIT_HEARTBEAT_FAILURE = 0x01020205,
  528. OID_802_3_XMIT_TIMES_CRS_LOST = 0x01020206,
  529. OID_802_3_XMIT_LATE_COLLISIONS = 0x01020207,
  530. };
  531. static const uint32_t oid_supported_list[] =
  532. {
  533. /* the general stuff */
  534. OID_GEN_SUPPORTED_LIST,
  535. OID_GEN_HARDWARE_STATUS,
  536. OID_GEN_MEDIA_SUPPORTED,
  537. OID_GEN_MEDIA_IN_USE,
  538. OID_GEN_MAXIMUM_FRAME_SIZE,
  539. OID_GEN_LINK_SPEED,
  540. OID_GEN_TRANSMIT_BLOCK_SIZE,
  541. OID_GEN_RECEIVE_BLOCK_SIZE,
  542. OID_GEN_VENDOR_ID,
  543. OID_GEN_VENDOR_DESCRIPTION,
  544. OID_GEN_VENDOR_DRIVER_VERSION,
  545. OID_GEN_CURRENT_PACKET_FILTER,
  546. OID_GEN_MAXIMUM_TOTAL_SIZE,
  547. OID_GEN_MEDIA_CONNECT_STATUS,
  548. OID_GEN_PHYSICAL_MEDIUM,
  549. /* the statistical stuff */
  550. OID_GEN_XMIT_OK,
  551. OID_GEN_RCV_OK,
  552. OID_GEN_XMIT_ERROR,
  553. OID_GEN_RCV_ERROR,
  554. OID_GEN_RCV_NO_BUFFER,
  555. /* IEEE 802.3 */
  556. /* the general stuff */
  557. OID_802_3_PERMANENT_ADDRESS,
  558. OID_802_3_CURRENT_ADDRESS,
  559. OID_802_3_MULTICAST_LIST,
  560. OID_802_3_MAC_OPTIONS,
  561. OID_802_3_MAXIMUM_LIST_SIZE,
  562. /* the statistical stuff */
  563. OID_802_3_RCV_ERROR_ALIGNMENT,
  564. OID_802_3_XMIT_ONE_COLLISION,
  565. OID_802_3_XMIT_MORE_COLLISIONS,
  566. };
  567. #define NDIS_MAC_OPTION_COPY_LOOKAHEAD_DATA (1 << 0)
  568. #define NDIS_MAC_OPTION_RECEIVE_SERIALIZED (1 << 1)
  569. #define NDIS_MAC_OPTION_TRANSFERS_NOT_PEND (1 << 2)
  570. #define NDIS_MAC_OPTION_NO_LOOPBACK (1 << 3)
  571. #define NDIS_MAC_OPTION_FULL_DUPLEX (1 << 4)
  572. #define NDIS_MAC_OPTION_EOTX_INDICATION (1 << 5)
  573. #define NDIS_MAC_OPTION_8021P_PRIORITY (1 << 6)
  574. struct rndis_response {
  575. QTAILQ_ENTRY(rndis_response) entries;
  576. uint32_t length;
  577. uint8_t buf[0];
  578. };
  579. typedef struct USBNetState {
  580. USBDevice dev;
  581. enum rndis_state rndis_state;
  582. uint32_t medium;
  583. uint32_t speed;
  584. uint32_t media_state;
  585. uint16_t filter;
  586. uint32_t vendorid;
  587. unsigned int out_ptr;
  588. uint8_t out_buf[2048];
  589. unsigned int in_ptr, in_len;
  590. uint8_t in_buf[2048];
  591. USBEndpoint *intr;
  592. char usbstring_mac[13];
  593. NICState *nic;
  594. NICConf conf;
  595. QTAILQ_HEAD(, rndis_response) rndis_resp;
  596. } USBNetState;
  597. #define TYPE_USB_NET "usb-net"
  598. #define USB_NET(obj) OBJECT_CHECK(USBNetState, (obj), TYPE_USB_NET)
  599. static int is_rndis(USBNetState *s)
  600. {
  601. return s->dev.config ?
  602. s->dev.config->bConfigurationValue == DEV_RNDIS_CONFIG_VALUE : 0;
  603. }
  604. static int ndis_query(USBNetState *s, uint32_t oid,
  605. uint8_t *inbuf, unsigned int inlen, uint8_t *outbuf,
  606. size_t outlen)
  607. {
  608. unsigned int i;
  609. switch (oid) {
  610. /* general oids (table 4-1) */
  611. /* mandatory */
  612. case OID_GEN_SUPPORTED_LIST:
  613. for (i = 0; i < ARRAY_SIZE(oid_supported_list); i++) {
  614. stl_le_p(outbuf + (i * sizeof(le32)), oid_supported_list[i]);
  615. }
  616. return sizeof(oid_supported_list);
  617. /* mandatory */
  618. case OID_GEN_HARDWARE_STATUS:
  619. stl_le_p(outbuf, 0);
  620. return sizeof(le32);
  621. /* mandatory */
  622. case OID_GEN_MEDIA_SUPPORTED:
  623. stl_le_p(outbuf, s->medium);
  624. return sizeof(le32);
  625. /* mandatory */
  626. case OID_GEN_MEDIA_IN_USE:
  627. stl_le_p(outbuf, s->medium);
  628. return sizeof(le32);
  629. /* mandatory */
  630. case OID_GEN_MAXIMUM_FRAME_SIZE:
  631. stl_le_p(outbuf, ETH_FRAME_LEN);
  632. return sizeof(le32);
  633. /* mandatory */
  634. case OID_GEN_LINK_SPEED:
  635. stl_le_p(outbuf, s->speed);
  636. return sizeof(le32);
  637. /* mandatory */
  638. case OID_GEN_TRANSMIT_BLOCK_SIZE:
  639. stl_le_p(outbuf, ETH_FRAME_LEN);
  640. return sizeof(le32);
  641. /* mandatory */
  642. case OID_GEN_RECEIVE_BLOCK_SIZE:
  643. stl_le_p(outbuf, ETH_FRAME_LEN);
  644. return sizeof(le32);
  645. /* mandatory */
  646. case OID_GEN_VENDOR_ID:
  647. stl_le_p(outbuf, s->vendorid);
  648. return sizeof(le32);
  649. /* mandatory */
  650. case OID_GEN_VENDOR_DESCRIPTION:
  651. pstrcpy((char *)outbuf, outlen, "QEMU USB RNDIS Net");
  652. return strlen((char *)outbuf) + 1;
  653. case OID_GEN_VENDOR_DRIVER_VERSION:
  654. stl_le_p(outbuf, 1);
  655. return sizeof(le32);
  656. /* mandatory */
  657. case OID_GEN_CURRENT_PACKET_FILTER:
  658. stl_le_p(outbuf, s->filter);
  659. return sizeof(le32);
  660. /* mandatory */
  661. case OID_GEN_MAXIMUM_TOTAL_SIZE:
  662. stl_le_p(outbuf, RNDIS_MAX_TOTAL_SIZE);
  663. return sizeof(le32);
  664. /* mandatory */
  665. case OID_GEN_MEDIA_CONNECT_STATUS:
  666. stl_le_p(outbuf, s->media_state);
  667. return sizeof(le32);
  668. case OID_GEN_PHYSICAL_MEDIUM:
  669. stl_le_p(outbuf, 0);
  670. return sizeof(le32);
  671. case OID_GEN_MAC_OPTIONS:
  672. stl_le_p(outbuf, NDIS_MAC_OPTION_RECEIVE_SERIALIZED |
  673. NDIS_MAC_OPTION_FULL_DUPLEX);
  674. return sizeof(le32);
  675. /* statistics OIDs (table 4-2) */
  676. /* mandatory */
  677. case OID_GEN_XMIT_OK:
  678. stl_le_p(outbuf, 0);
  679. return sizeof(le32);
  680. /* mandatory */
  681. case OID_GEN_RCV_OK:
  682. stl_le_p(outbuf, 0);
  683. return sizeof(le32);
  684. /* mandatory */
  685. case OID_GEN_XMIT_ERROR:
  686. stl_le_p(outbuf, 0);
  687. return sizeof(le32);
  688. /* mandatory */
  689. case OID_GEN_RCV_ERROR:
  690. stl_le_p(outbuf, 0);
  691. return sizeof(le32);
  692. /* mandatory */
  693. case OID_GEN_RCV_NO_BUFFER:
  694. stl_le_p(outbuf, 0);
  695. return sizeof(le32);
  696. /* ieee802.3 OIDs (table 4-3) */
  697. /* mandatory */
  698. case OID_802_3_PERMANENT_ADDRESS:
  699. memcpy(outbuf, s->conf.macaddr.a, 6);
  700. return 6;
  701. /* mandatory */
  702. case OID_802_3_CURRENT_ADDRESS:
  703. memcpy(outbuf, s->conf.macaddr.a, 6);
  704. return 6;
  705. /* mandatory */
  706. case OID_802_3_MULTICAST_LIST:
  707. stl_le_p(outbuf, 0xe0000000);
  708. return sizeof(le32);
  709. /* mandatory */
  710. case OID_802_3_MAXIMUM_LIST_SIZE:
  711. stl_le_p(outbuf, 1);
  712. return sizeof(le32);
  713. case OID_802_3_MAC_OPTIONS:
  714. return 0;
  715. /* ieee802.3 statistics OIDs (table 4-4) */
  716. /* mandatory */
  717. case OID_802_3_RCV_ERROR_ALIGNMENT:
  718. stl_le_p(outbuf, 0);
  719. return sizeof(le32);
  720. /* mandatory */
  721. case OID_802_3_XMIT_ONE_COLLISION:
  722. stl_le_p(outbuf, 0);
  723. return sizeof(le32);
  724. /* mandatory */
  725. case OID_802_3_XMIT_MORE_COLLISIONS:
  726. stl_le_p(outbuf, 0);
  727. return sizeof(le32);
  728. default:
  729. fprintf(stderr, "usbnet: unknown OID 0x%08x\n", oid);
  730. return 0;
  731. }
  732. return -1;
  733. }
  734. static int ndis_set(USBNetState *s, uint32_t oid,
  735. uint8_t *inbuf, unsigned int inlen)
  736. {
  737. switch (oid) {
  738. case OID_GEN_CURRENT_PACKET_FILTER:
  739. s->filter = ldl_le_p(inbuf);
  740. if (s->filter) {
  741. s->rndis_state = RNDIS_DATA_INITIALIZED;
  742. } else {
  743. s->rndis_state = RNDIS_INITIALIZED;
  744. }
  745. return 0;
  746. case OID_802_3_MULTICAST_LIST:
  747. return 0;
  748. }
  749. return -1;
  750. }
  751. static int rndis_get_response(USBNetState *s, uint8_t *buf)
  752. {
  753. int ret = 0;
  754. struct rndis_response *r = s->rndis_resp.tqh_first;
  755. if (!r)
  756. return ret;
  757. QTAILQ_REMOVE(&s->rndis_resp, r, entries);
  758. ret = r->length;
  759. memcpy(buf, r->buf, r->length);
  760. g_free(r);
  761. return ret;
  762. }
  763. static void *rndis_queue_response(USBNetState *s, unsigned int length)
  764. {
  765. struct rndis_response *r =
  766. g_malloc0(sizeof(struct rndis_response) + length);
  767. if (QTAILQ_EMPTY(&s->rndis_resp)) {
  768. usb_wakeup(s->intr, 0);
  769. }
  770. QTAILQ_INSERT_TAIL(&s->rndis_resp, r, entries);
  771. r->length = length;
  772. return &r->buf[0];
  773. }
  774. static void rndis_clear_responsequeue(USBNetState *s)
  775. {
  776. struct rndis_response *r;
  777. while ((r = s->rndis_resp.tqh_first)) {
  778. QTAILQ_REMOVE(&s->rndis_resp, r, entries);
  779. g_free(r);
  780. }
  781. }
  782. static int rndis_init_response(USBNetState *s, rndis_init_msg_type *buf)
  783. {
  784. rndis_init_cmplt_type *resp =
  785. rndis_queue_response(s, sizeof(rndis_init_cmplt_type));
  786. if (!resp)
  787. return USB_RET_STALL;
  788. resp->MessageType = cpu_to_le32(RNDIS_INITIALIZE_CMPLT);
  789. resp->MessageLength = cpu_to_le32(sizeof(rndis_init_cmplt_type));
  790. resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
  791. resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
  792. resp->MajorVersion = cpu_to_le32(RNDIS_MAJOR_VERSION);
  793. resp->MinorVersion = cpu_to_le32(RNDIS_MINOR_VERSION);
  794. resp->DeviceFlags = cpu_to_le32(RNDIS_DF_CONNECTIONLESS);
  795. resp->Medium = cpu_to_le32(RNDIS_MEDIUM_802_3);
  796. resp->MaxPacketsPerTransfer = cpu_to_le32(1);
  797. resp->MaxTransferSize = cpu_to_le32(ETH_FRAME_LEN +
  798. sizeof(struct rndis_packet_msg_type) + 22);
  799. resp->PacketAlignmentFactor = cpu_to_le32(0);
  800. resp->AFListOffset = cpu_to_le32(0);
  801. resp->AFListSize = cpu_to_le32(0);
  802. return 0;
  803. }
  804. static int rndis_query_response(USBNetState *s,
  805. rndis_query_msg_type *buf, unsigned int length)
  806. {
  807. rndis_query_cmplt_type *resp;
  808. /* oid_supported_list is the largest data reply */
  809. uint8_t infobuf[sizeof(oid_supported_list)];
  810. uint32_t bufoffs, buflen;
  811. int infobuflen;
  812. unsigned int resplen;
  813. bufoffs = le32_to_cpu(buf->InformationBufferOffset) + 8;
  814. buflen = le32_to_cpu(buf->InformationBufferLength);
  815. if (buflen > length || bufoffs >= length || bufoffs + buflen > length) {
  816. return USB_RET_STALL;
  817. }
  818. infobuflen = ndis_query(s, le32_to_cpu(buf->OID),
  819. bufoffs + (uint8_t *) buf, buflen, infobuf,
  820. sizeof(infobuf));
  821. resplen = sizeof(rndis_query_cmplt_type) +
  822. ((infobuflen < 0) ? 0 : infobuflen);
  823. resp = rndis_queue_response(s, resplen);
  824. if (!resp)
  825. return USB_RET_STALL;
  826. resp->MessageType = cpu_to_le32(RNDIS_QUERY_CMPLT);
  827. resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
  828. resp->MessageLength = cpu_to_le32(resplen);
  829. if (infobuflen < 0) {
  830. /* OID not supported */
  831. resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
  832. resp->InformationBufferLength = cpu_to_le32(0);
  833. resp->InformationBufferOffset = cpu_to_le32(0);
  834. return 0;
  835. }
  836. resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
  837. resp->InformationBufferOffset =
  838. cpu_to_le32(infobuflen ? sizeof(rndis_query_cmplt_type) - 8 : 0);
  839. resp->InformationBufferLength = cpu_to_le32(infobuflen);
  840. memcpy(resp + 1, infobuf, infobuflen);
  841. return 0;
  842. }
  843. static int rndis_set_response(USBNetState *s,
  844. rndis_set_msg_type *buf, unsigned int length)
  845. {
  846. rndis_set_cmplt_type *resp =
  847. rndis_queue_response(s, sizeof(rndis_set_cmplt_type));
  848. uint32_t bufoffs, buflen;
  849. int ret;
  850. if (!resp)
  851. return USB_RET_STALL;
  852. bufoffs = le32_to_cpu(buf->InformationBufferOffset) + 8;
  853. buflen = le32_to_cpu(buf->InformationBufferLength);
  854. if (buflen > length || bufoffs >= length || bufoffs + buflen > length) {
  855. return USB_RET_STALL;
  856. }
  857. ret = ndis_set(s, le32_to_cpu(buf->OID),
  858. bufoffs + (uint8_t *) buf, buflen);
  859. resp->MessageType = cpu_to_le32(RNDIS_SET_CMPLT);
  860. resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
  861. resp->MessageLength = cpu_to_le32(sizeof(rndis_set_cmplt_type));
  862. if (ret < 0) {
  863. /* OID not supported */
  864. resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
  865. return 0;
  866. }
  867. resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
  868. return 0;
  869. }
  870. static int rndis_reset_response(USBNetState *s, rndis_reset_msg_type *buf)
  871. {
  872. rndis_reset_cmplt_type *resp =
  873. rndis_queue_response(s, sizeof(rndis_reset_cmplt_type));
  874. if (!resp)
  875. return USB_RET_STALL;
  876. resp->MessageType = cpu_to_le32(RNDIS_RESET_CMPLT);
  877. resp->MessageLength = cpu_to_le32(sizeof(rndis_reset_cmplt_type));
  878. resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
  879. resp->AddressingReset = cpu_to_le32(1); /* reset information */
  880. return 0;
  881. }
  882. static int rndis_keepalive_response(USBNetState *s,
  883. rndis_keepalive_msg_type *buf)
  884. {
  885. rndis_keepalive_cmplt_type *resp =
  886. rndis_queue_response(s, sizeof(rndis_keepalive_cmplt_type));
  887. if (!resp)
  888. return USB_RET_STALL;
  889. resp->MessageType = cpu_to_le32(RNDIS_KEEPALIVE_CMPLT);
  890. resp->MessageLength = cpu_to_le32(sizeof(rndis_keepalive_cmplt_type));
  891. resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
  892. resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
  893. return 0;
  894. }
  895. /* Prepare to receive the next packet */
  896. static void usb_net_reset_in_buf(USBNetState *s)
  897. {
  898. s->in_ptr = s->in_len = 0;
  899. qemu_flush_queued_packets(qemu_get_queue(s->nic));
  900. }
  901. static int rndis_parse(USBNetState *s, uint8_t *data, int length)
  902. {
  903. uint32_t msg_type = ldl_le_p(data);
  904. switch (msg_type) {
  905. case RNDIS_INITIALIZE_MSG:
  906. s->rndis_state = RNDIS_INITIALIZED;
  907. return rndis_init_response(s, (rndis_init_msg_type *) data);
  908. case RNDIS_HALT_MSG:
  909. s->rndis_state = RNDIS_UNINITIALIZED;
  910. return 0;
  911. case RNDIS_QUERY_MSG:
  912. return rndis_query_response(s, (rndis_query_msg_type *) data, length);
  913. case RNDIS_SET_MSG:
  914. return rndis_set_response(s, (rndis_set_msg_type *) data, length);
  915. case RNDIS_RESET_MSG:
  916. rndis_clear_responsequeue(s);
  917. s->out_ptr = 0;
  918. usb_net_reset_in_buf(s);
  919. return rndis_reset_response(s, (rndis_reset_msg_type *) data);
  920. case RNDIS_KEEPALIVE_MSG:
  921. /* For USB: host does this every 5 seconds */
  922. return rndis_keepalive_response(s, (rndis_keepalive_msg_type *) data);
  923. }
  924. return USB_RET_STALL;
  925. }
  926. static void usb_net_handle_reset(USBDevice *dev)
  927. {
  928. }
  929. static void usb_net_handle_control(USBDevice *dev, USBPacket *p,
  930. int request, int value, int index, int length, uint8_t *data)
  931. {
  932. USBNetState *s = (USBNetState *) dev;
  933. int ret;
  934. ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
  935. if (ret >= 0) {
  936. return;
  937. }
  938. switch(request) {
  939. case ClassInterfaceOutRequest | USB_CDC_SEND_ENCAPSULATED_COMMAND:
  940. if (!is_rndis(s) || value || index != 0) {
  941. goto fail;
  942. }
  943. #ifdef TRAFFIC_DEBUG
  944. {
  945. unsigned int i;
  946. fprintf(stderr, "SEND_ENCAPSULATED_COMMAND:");
  947. for (i = 0; i < length; i++) {
  948. if (!(i & 15))
  949. fprintf(stderr, "\n%04x:", i);
  950. fprintf(stderr, " %02x", data[i]);
  951. }
  952. fprintf(stderr, "\n\n");
  953. }
  954. #endif
  955. ret = rndis_parse(s, data, length);
  956. if (ret < 0) {
  957. p->status = ret;
  958. }
  959. break;
  960. case ClassInterfaceRequest | USB_CDC_GET_ENCAPSULATED_RESPONSE:
  961. if (!is_rndis(s) || value || index != 0) {
  962. goto fail;
  963. }
  964. p->actual_length = rndis_get_response(s, data);
  965. if (p->actual_length == 0) {
  966. data[0] = 0;
  967. p->actual_length = 1;
  968. }
  969. #ifdef TRAFFIC_DEBUG
  970. {
  971. unsigned int i;
  972. fprintf(stderr, "GET_ENCAPSULATED_RESPONSE:");
  973. for (i = 0; i < p->actual_length; i++) {
  974. if (!(i & 15))
  975. fprintf(stderr, "\n%04x:", i);
  976. fprintf(stderr, " %02x", data[i]);
  977. }
  978. fprintf(stderr, "\n\n");
  979. }
  980. #endif
  981. break;
  982. default:
  983. fail:
  984. fprintf(stderr, "usbnet: failed control transaction: "
  985. "request 0x%x value 0x%x index 0x%x length 0x%x\n",
  986. request, value, index, length);
  987. p->status = USB_RET_STALL;
  988. break;
  989. }
  990. }
  991. static void usb_net_handle_statusin(USBNetState *s, USBPacket *p)
  992. {
  993. le32 buf[2];
  994. if (p->iov.size < 8) {
  995. p->status = USB_RET_STALL;
  996. return;
  997. }
  998. buf[0] = cpu_to_le32(1);
  999. buf[1] = cpu_to_le32(0);
  1000. usb_packet_copy(p, buf, 8);
  1001. if (!s->rndis_resp.tqh_first) {
  1002. p->status = USB_RET_NAK;
  1003. }
  1004. #ifdef TRAFFIC_DEBUG
  1005. fprintf(stderr, "usbnet: interrupt poll len %zu return %d",
  1006. p->iov.size, p->status);
  1007. iov_hexdump(p->iov.iov, p->iov.niov, stderr, "usbnet", p->status);
  1008. #endif
  1009. }
  1010. static void usb_net_handle_datain(USBNetState *s, USBPacket *p)
  1011. {
  1012. int len;
  1013. if (s->in_ptr > s->in_len) {
  1014. usb_net_reset_in_buf(s);
  1015. p->status = USB_RET_NAK;
  1016. return;
  1017. }
  1018. if (!s->in_len) {
  1019. p->status = USB_RET_NAK;
  1020. return;
  1021. }
  1022. len = s->in_len - s->in_ptr;
  1023. if (len > p->iov.size) {
  1024. len = p->iov.size;
  1025. }
  1026. usb_packet_copy(p, &s->in_buf[s->in_ptr], len);
  1027. s->in_ptr += len;
  1028. if (s->in_ptr >= s->in_len &&
  1029. (is_rndis(s) || (s->in_len & (64 - 1)) || !len)) {
  1030. /* no short packet necessary */
  1031. usb_net_reset_in_buf(s);
  1032. }
  1033. #ifdef TRAFFIC_DEBUG
  1034. fprintf(stderr, "usbnet: data in len %zu return %d", p->iov.size, len);
  1035. iov_hexdump(p->iov.iov, p->iov.niov, stderr, "usbnet", len);
  1036. #endif
  1037. }
  1038. static void usb_net_handle_dataout(USBNetState *s, USBPacket *p)
  1039. {
  1040. int sz = sizeof(s->out_buf) - s->out_ptr;
  1041. struct rndis_packet_msg_type *msg =
  1042. (struct rndis_packet_msg_type *) s->out_buf;
  1043. uint32_t len;
  1044. #ifdef TRAFFIC_DEBUG
  1045. fprintf(stderr, "usbnet: data out len %zu\n", p->iov.size);
  1046. iov_hexdump(p->iov.iov, p->iov.niov, stderr, "usbnet", p->iov.size);
  1047. #endif
  1048. if (sz > p->iov.size) {
  1049. sz = p->iov.size;
  1050. }
  1051. usb_packet_copy(p, &s->out_buf[s->out_ptr], sz);
  1052. s->out_ptr += sz;
  1053. if (!is_rndis(s)) {
  1054. if (p->iov.size < 64) {
  1055. qemu_send_packet(qemu_get_queue(s->nic), s->out_buf, s->out_ptr);
  1056. s->out_ptr = 0;
  1057. }
  1058. return;
  1059. }
  1060. len = le32_to_cpu(msg->MessageLength);
  1061. if (s->out_ptr < 8 || s->out_ptr < len) {
  1062. return;
  1063. }
  1064. if (le32_to_cpu(msg->MessageType) == RNDIS_PACKET_MSG) {
  1065. uint32_t offs = 8 + le32_to_cpu(msg->DataOffset);
  1066. uint32_t size = le32_to_cpu(msg->DataLength);
  1067. if (offs < len && size < len && offs + size <= len) {
  1068. qemu_send_packet(qemu_get_queue(s->nic), s->out_buf + offs, size);
  1069. }
  1070. }
  1071. s->out_ptr -= len;
  1072. memmove(s->out_buf, &s->out_buf[len], s->out_ptr);
  1073. }
  1074. static void usb_net_handle_data(USBDevice *dev, USBPacket *p)
  1075. {
  1076. USBNetState *s = (USBNetState *) dev;
  1077. switch(p->pid) {
  1078. case USB_TOKEN_IN:
  1079. switch (p->ep->nr) {
  1080. case 1:
  1081. usb_net_handle_statusin(s, p);
  1082. break;
  1083. case 2:
  1084. usb_net_handle_datain(s, p);
  1085. break;
  1086. default:
  1087. goto fail;
  1088. }
  1089. break;
  1090. case USB_TOKEN_OUT:
  1091. switch (p->ep->nr) {
  1092. case 2:
  1093. usb_net_handle_dataout(s, p);
  1094. break;
  1095. default:
  1096. goto fail;
  1097. }
  1098. break;
  1099. default:
  1100. fail:
  1101. p->status = USB_RET_STALL;
  1102. break;
  1103. }
  1104. if (p->status == USB_RET_STALL) {
  1105. fprintf(stderr, "usbnet: failed data transaction: "
  1106. "pid 0x%x ep 0x%x len 0x%zx\n",
  1107. p->pid, p->ep->nr, p->iov.size);
  1108. }
  1109. }
  1110. static ssize_t usbnet_receive(NetClientState *nc, const uint8_t *buf, size_t size)
  1111. {
  1112. USBNetState *s = qemu_get_nic_opaque(nc);
  1113. uint8_t *in_buf = s->in_buf;
  1114. size_t total_size = size;
  1115. if (!s->dev.config) {
  1116. return -1;
  1117. }
  1118. if (is_rndis(s)) {
  1119. if (s->rndis_state != RNDIS_DATA_INITIALIZED) {
  1120. return -1;
  1121. }
  1122. total_size += sizeof(struct rndis_packet_msg_type);
  1123. }
  1124. if (total_size > sizeof(s->in_buf)) {
  1125. return -1;
  1126. }
  1127. /* Only accept packet if input buffer is empty */
  1128. if (s->in_len > 0) {
  1129. return 0;
  1130. }
  1131. if (is_rndis(s)) {
  1132. struct rndis_packet_msg_type *msg;
  1133. msg = (struct rndis_packet_msg_type *)in_buf;
  1134. memset(msg, 0, sizeof(struct rndis_packet_msg_type));
  1135. msg->MessageType = cpu_to_le32(RNDIS_PACKET_MSG);
  1136. msg->MessageLength = cpu_to_le32(size + sizeof(*msg));
  1137. msg->DataOffset = cpu_to_le32(sizeof(*msg) - 8);
  1138. msg->DataLength = cpu_to_le32(size);
  1139. /* msg->OOBDataOffset;
  1140. * msg->OOBDataLength;
  1141. * msg->NumOOBDataElements;
  1142. * msg->PerPacketInfoOffset;
  1143. * msg->PerPacketInfoLength;
  1144. * msg->VcHandle;
  1145. * msg->Reserved;
  1146. */
  1147. in_buf += sizeof(*msg);
  1148. }
  1149. memcpy(in_buf, buf, size);
  1150. s->in_len = total_size;
  1151. s->in_ptr = 0;
  1152. return size;
  1153. }
  1154. static void usbnet_cleanup(NetClientState *nc)
  1155. {
  1156. USBNetState *s = qemu_get_nic_opaque(nc);
  1157. s->nic = NULL;
  1158. }
  1159. static void usb_net_unrealize(USBDevice *dev, Error **errp)
  1160. {
  1161. USBNetState *s = (USBNetState *) dev;
  1162. /* TODO: remove the nd_table[] entry */
  1163. rndis_clear_responsequeue(s);
  1164. qemu_del_nic(s->nic);
  1165. }
  1166. static NetClientInfo net_usbnet_info = {
  1167. .type = NET_CLIENT_DRIVER_NIC,
  1168. .size = sizeof(NICState),
  1169. .receive = usbnet_receive,
  1170. .cleanup = usbnet_cleanup,
  1171. };
  1172. static void usb_net_realize(USBDevice *dev, Error **errrp)
  1173. {
  1174. USBNetState *s = USB_NET(dev);
  1175. usb_desc_create_serial(dev);
  1176. usb_desc_init(dev);
  1177. s->rndis_state = RNDIS_UNINITIALIZED;
  1178. QTAILQ_INIT(&s->rndis_resp);
  1179. s->medium = 0; /* NDIS_MEDIUM_802_3 */
  1180. s->speed = 1000000; /* 100MBps, in 100Bps units */
  1181. s->media_state = 0; /* NDIS_MEDIA_STATE_CONNECTED */;
  1182. s->filter = 0;
  1183. s->vendorid = 0x1234;
  1184. s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
  1185. qemu_macaddr_default_if_unset(&s->conf.macaddr);
  1186. s->nic = qemu_new_nic(&net_usbnet_info, &s->conf,
  1187. object_get_typename(OBJECT(s)), s->dev.qdev.id, s);
  1188. qemu_format_nic_info_str(qemu_get_queue(s->nic), s->conf.macaddr.a);
  1189. snprintf(s->usbstring_mac, sizeof(s->usbstring_mac),
  1190. "%02x%02x%02x%02x%02x%02x",
  1191. 0x40,
  1192. s->conf.macaddr.a[1],
  1193. s->conf.macaddr.a[2],
  1194. s->conf.macaddr.a[3],
  1195. s->conf.macaddr.a[4],
  1196. s->conf.macaddr.a[5]);
  1197. usb_desc_set_string(dev, STRING_ETHADDR, s->usbstring_mac);
  1198. }
  1199. static void usb_net_instance_init(Object *obj)
  1200. {
  1201. USBDevice *dev = USB_DEVICE(obj);
  1202. USBNetState *s = USB_NET(dev);
  1203. device_add_bootindex_property(obj, &s->conf.bootindex,
  1204. "bootindex", "/ethernet-phy@0",
  1205. &dev->qdev, NULL);
  1206. }
  1207. static const VMStateDescription vmstate_usb_net = {
  1208. .name = "usb-net",
  1209. .unmigratable = 1,
  1210. };
  1211. static Property net_properties[] = {
  1212. DEFINE_NIC_PROPERTIES(USBNetState, conf),
  1213. DEFINE_PROP_END_OF_LIST(),
  1214. };
  1215. static void usb_net_class_initfn(ObjectClass *klass, void *data)
  1216. {
  1217. DeviceClass *dc = DEVICE_CLASS(klass);
  1218. USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
  1219. uc->realize = usb_net_realize;
  1220. uc->product_desc = "QEMU USB Network Interface";
  1221. uc->usb_desc = &desc_net;
  1222. uc->handle_reset = usb_net_handle_reset;
  1223. uc->handle_control = usb_net_handle_control;
  1224. uc->handle_data = usb_net_handle_data;
  1225. uc->unrealize = usb_net_unrealize;
  1226. set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
  1227. dc->fw_name = "network";
  1228. dc->vmsd = &vmstate_usb_net;
  1229. dc->props = net_properties;
  1230. }
  1231. static const TypeInfo net_info = {
  1232. .name = TYPE_USB_NET,
  1233. .parent = TYPE_USB_DEVICE,
  1234. .instance_size = sizeof(USBNetState),
  1235. .class_init = usb_net_class_initfn,
  1236. .instance_init = usb_net_instance_init,
  1237. };
  1238. static void usb_net_register_types(void)
  1239. {
  1240. type_register_static(&net_info);
  1241. }
  1242. type_init(usb_net_register_types)