xref: /openbmc/linux/Documentation/usb/linux.inf (revision 1da177e4)
11da177e4SLinus Torvalds; MS-Windows driver config matching some basic modes of the
21da177e4SLinus Torvalds; Linux-USB Ethernet/RNDIS gadget firmware:
31da177e4SLinus Torvalds;
41da177e4SLinus Torvalds;  - RNDIS plus CDC Ethernet ... this may be familiar as a DOCSIS
51da177e4SLinus Torvalds;    cable modem profile, and supports most non-Microsoft USB hosts
61da177e4SLinus Torvalds;
71da177e4SLinus Torvalds;  - RNDIS plus CDC Subset ... used by hardware that incapable of
81da177e4SLinus Torvalds;    full CDC Ethernet support.
91da177e4SLinus Torvalds;
101da177e4SLinus Torvalds; Microsoft only directly supports RNDIS drivers, and bundled them into XP.
111da177e4SLinus Torvalds; The Microsoft "Remote NDIS USB Driver Kit" is currently found at:
121da177e4SLinus Torvalds;   http://www.microsoft.com/whdc/hwdev/resources/HWservices/rndis.mspx
131da177e4SLinus Torvalds
141da177e4SLinus Torvalds
151da177e4SLinus Torvalds[Version]
161da177e4SLinus TorvaldsSignature           = "$CHICAGO$"
171da177e4SLinus TorvaldsClass               = Net
181da177e4SLinus TorvaldsClassGUID           = {4d36e972-e325-11ce-bfc1-08002be10318}
191da177e4SLinus TorvaldsProvider            = %Linux%
201da177e4SLinus TorvaldsCompatible          = 1
211da177e4SLinus TorvaldsMillenniumPreferred = .ME
221da177e4SLinus TorvaldsDriverVer           = 03/30/2004,0.0.0.0
231da177e4SLinus Torvalds; catalog file would be used by WHQL
241da177e4SLinus Torvalds;CatalogFile         = Linux.cat
251da177e4SLinus Torvalds
261da177e4SLinus Torvalds[Manufacturer]
271da177e4SLinus Torvalds%Linux%          = LinuxDevices,NT.5.1
281da177e4SLinus Torvalds
291da177e4SLinus Torvalds[LinuxDevices]
301da177e4SLinus Torvalds; NetChip IDs, used by both firmware modes
311da177e4SLinus Torvalds%LinuxDevice%    = RNDIS, USB\VID_0525&PID_a4a2
321da177e4SLinus Torvalds
331da177e4SLinus Torvalds[LinuxDevices.NT.5.1]
341da177e4SLinus Torvalds%LinuxDevice%    = RNDIS.NT.5.1, USB\VID_0525&PID_a4a2
351da177e4SLinus Torvalds
361da177e4SLinus Torvalds[ControlFlags]
371da177e4SLinus TorvaldsExcludeFromSelect=*
381da177e4SLinus Torvalds
391da177e4SLinus Torvalds; Windows 98, Windows 98 Second Edition specific sections --------
401da177e4SLinus Torvalds
411da177e4SLinus Torvalds[RNDIS]
421da177e4SLinus TorvaldsDeviceID        = usb8023
431da177e4SLinus TorvaldsMaxInstance     = 512
441da177e4SLinus TorvaldsDriverVer           = 03/30/2004,0.0.0.0
451da177e4SLinus TorvaldsAddReg          = RNDIS_AddReg_98, RNDIS_AddReg_Common
461da177e4SLinus Torvalds
471da177e4SLinus Torvalds[RNDIS_AddReg_98]
481da177e4SLinus TorvaldsHKR, ,               DevLoader,        0, *ndis
491da177e4SLinus TorvaldsHKR, ,               DeviceVxDs,       0, usb8023.sys
501da177e4SLinus TorvaldsHKR, NDIS,           LogDriverName,    0, "usb8023"
511da177e4SLinus TorvaldsHKR, NDIS,           MajorNdisVersion, 1, 5
521da177e4SLinus TorvaldsHKR, NDIS,           MinorNdisVersion, 1, 0
531da177e4SLinus TorvaldsHKR, Ndi\Interfaces, DefUpper,         0, "ndis3,ndis4,ndis5"
541da177e4SLinus TorvaldsHKR, Ndi\Interfaces, DefLower,         0, "ethernet"
551da177e4SLinus TorvaldsHKR, Ndi\Interfaces, UpperRange,       0, "ndis3,ndis4,ndis5"
561da177e4SLinus TorvaldsHKR, Ndi\Interfaces, LowerRange,       0, "ethernet"
571da177e4SLinus TorvaldsHKR, Ndi\Install,    ndis3,            0, "RNDIS_Install_98"
581da177e4SLinus TorvaldsHKR, Ndi\Install,    ndis4,            0, "RNDIS_Install_98"
591da177e4SLinus TorvaldsHKR, Ndi\Install,    ndis5,            0, "RNDIS_Install_98"
601da177e4SLinus TorvaldsHKR, Ndi,            DeviceId,         0, "USB\VID_0525&PID_a4a2"
611da177e4SLinus Torvalds
621da177e4SLinus Torvalds[RNDIS_Install_98]
631da177e4SLinus TorvaldsCopyFiles=RNDIS_CopyFiles_98
641da177e4SLinus Torvalds
651da177e4SLinus Torvalds[RNDIS_CopyFiles_98]
661da177e4SLinus Torvaldsusb8023.sys, usb8023w.sys, , 0
671da177e4SLinus Torvaldsrndismp.sys, rndismpw.sys, , 0
681da177e4SLinus Torvalds
691da177e4SLinus Torvalds; Windows Millennium Edition specific sections --------------------
701da177e4SLinus Torvalds
711da177e4SLinus Torvalds[RNDIS.ME]
721da177e4SLinus TorvaldsDeviceID        = usb8023
731da177e4SLinus TorvaldsMaxInstance     = 512
741da177e4SLinus TorvaldsDriverVer           = 03/30/2004,0.0.0.0
751da177e4SLinus TorvaldsAddReg          = RNDIS_AddReg_ME, RNDIS_AddReg_Common
761da177e4SLinus TorvaldsCharacteristics = 0x84   ; NCF_PHYSICAL + NCF_HAS_UI
771da177e4SLinus TorvaldsBusType         = 15
781da177e4SLinus Torvalds
791da177e4SLinus Torvalds[RNDIS_AddReg_ME]
801da177e4SLinus TorvaldsHKR, ,               DevLoader,        0, *ndis
811da177e4SLinus TorvaldsHKR, ,               DeviceVxDs,       0, usb8023.sys
821da177e4SLinus TorvaldsHKR, NDIS,           LogDriverName,    0, "usb8023"
831da177e4SLinus TorvaldsHKR, NDIS,           MajorNdisVersion, 1, 5
841da177e4SLinus TorvaldsHKR, NDIS,           MinorNdisVersion, 1, 0
851da177e4SLinus TorvaldsHKR, Ndi\Interfaces, DefUpper,         0, "ndis3,ndis4,ndis5"
861da177e4SLinus TorvaldsHKR, Ndi\Interfaces, DefLower,         0, "ethernet"
871da177e4SLinus TorvaldsHKR, Ndi\Interfaces, UpperRange,       0, "ndis3,ndis4,ndis5"
881da177e4SLinus TorvaldsHKR, Ndi\Interfaces, LowerRange,       0, "ethernet"
891da177e4SLinus TorvaldsHKR, Ndi\Install,    ndis3,            0, "RNDIS_Install_ME"
901da177e4SLinus TorvaldsHKR, Ndi\Install,    ndis4,            0, "RNDIS_Install_ME"
911da177e4SLinus TorvaldsHKR, Ndi\Install,    ndis5,            0, "RNDIS_Install_ME"
921da177e4SLinus TorvaldsHKR, Ndi,            DeviceId,         0, "USB\VID_0525&PID_a4a2"
931da177e4SLinus Torvalds
941da177e4SLinus Torvalds[RNDIS_Install_ME]
951da177e4SLinus TorvaldsCopyFiles=RNDIS_CopyFiles_ME
961da177e4SLinus Torvalds
971da177e4SLinus Torvalds[RNDIS_CopyFiles_ME]
981da177e4SLinus Torvaldsusb8023.sys, usb8023m.sys, , 0
991da177e4SLinus Torvaldsrndismp.sys, rndismpm.sys, , 0
1001da177e4SLinus Torvalds
1011da177e4SLinus Torvalds; Windows 2000 specific sections ---------------------------------
1021da177e4SLinus Torvalds
1031da177e4SLinus Torvalds[RNDIS.NT]
1041da177e4SLinus TorvaldsCharacteristics = 0x84   ; NCF_PHYSICAL + NCF_HAS_UI
1051da177e4SLinus TorvaldsBusType         = 15
1061da177e4SLinus TorvaldsDriverVer           = 03/30/2004,0.0.0.0
1071da177e4SLinus TorvaldsAddReg          = RNDIS_AddReg_NT, RNDIS_AddReg_Common
1081da177e4SLinus TorvaldsCopyFiles       = RNDIS_CopyFiles_NT
1091da177e4SLinus Torvalds
1101da177e4SLinus Torvalds[RNDIS.NT.Services]
1111da177e4SLinus TorvaldsAddService = USB_RNDIS, 2, RNDIS_ServiceInst_NT, RNDIS_EventLog
1121da177e4SLinus Torvalds
1131da177e4SLinus Torvalds[RNDIS_CopyFiles_NT]
1141da177e4SLinus Torvalds; no rename of files on Windows 2000, use the 'k' names as is
1151da177e4SLinus Torvaldsusb8023k.sys, , , 0
1161da177e4SLinus Torvaldsrndismpk.sys, , , 0
1171da177e4SLinus Torvalds
1181da177e4SLinus Torvalds[RNDIS_ServiceInst_NT]
1191da177e4SLinus TorvaldsDisplayName     = %ServiceDisplayName%
1201da177e4SLinus TorvaldsServiceType     = 1
1211da177e4SLinus TorvaldsStartType       = 3
1221da177e4SLinus TorvaldsErrorControl    = 1
1231da177e4SLinus TorvaldsServiceBinary   = %12%\usb8023k.sys
1241da177e4SLinus TorvaldsLoadOrderGroup  = NDIS
1251da177e4SLinus TorvaldsAddReg          = RNDIS_WMI_AddReg_NT
1261da177e4SLinus Torvalds
1271da177e4SLinus Torvalds[RNDIS_WMI_AddReg_NT]
1281da177e4SLinus TorvaldsHKR, , MofImagePath, 0x00020000, "System32\drivers\rndismpk.sys"
1291da177e4SLinus Torvalds
1301da177e4SLinus Torvalds; Windows XP specific sections -----------------------------------
1311da177e4SLinus Torvalds
1321da177e4SLinus Torvalds[RNDIS.NT.5.1]
1331da177e4SLinus TorvaldsCharacteristics = 0x84   ; NCF_PHYSICAL + NCF_HAS_UI
1341da177e4SLinus TorvaldsBusType         = 15
1351da177e4SLinus TorvaldsDriverVer           = 03/30/2004,0.0.0.0
1361da177e4SLinus TorvaldsAddReg          = RNDIS_AddReg_NT, RNDIS_AddReg_Common
1371da177e4SLinus Torvalds; no copyfiles - the files are already in place
1381da177e4SLinus Torvalds
1391da177e4SLinus Torvalds[RNDIS.NT.5.1.Services]
1401da177e4SLinus TorvaldsAddService      = USB_RNDIS, 2, RNDIS_ServiceInst_51, RNDIS_EventLog
1411da177e4SLinus Torvalds
1421da177e4SLinus Torvalds[RNDIS_ServiceInst_51]
1431da177e4SLinus TorvaldsDisplayName     = %ServiceDisplayName%
1441da177e4SLinus TorvaldsServiceType     = 1
1451da177e4SLinus TorvaldsStartType       = 3
1461da177e4SLinus TorvaldsErrorControl    = 1
1471da177e4SLinus TorvaldsServiceBinary   = %12%\usb8023.sys
1481da177e4SLinus TorvaldsLoadOrderGroup  = NDIS
1491da177e4SLinus TorvaldsAddReg          = RNDIS_WMI_AddReg_51
1501da177e4SLinus Torvalds
1511da177e4SLinus Torvalds[RNDIS_WMI_AddReg_51]
1521da177e4SLinus TorvaldsHKR, , MofImagePath, 0x00020000, "System32\drivers\rndismp.sys"
1531da177e4SLinus Torvalds
1541da177e4SLinus Torvalds; Windows 2000 and Windows XP common sections --------------------
1551da177e4SLinus Torvalds
1561da177e4SLinus Torvalds[RNDIS_AddReg_NT]
1571da177e4SLinus TorvaldsHKR, Ndi,               Service,        0, "USB_RNDIS"
1581da177e4SLinus TorvaldsHKR, Ndi\Interfaces,    UpperRange,     0, "ndis5"
1591da177e4SLinus TorvaldsHKR, Ndi\Interfaces,    LowerRange,     0, "ethernet"
1601da177e4SLinus Torvalds
1611da177e4SLinus Torvalds[RNDIS_EventLog]
1621da177e4SLinus TorvaldsAddReg = RNDIS_EventLog_AddReg
1631da177e4SLinus Torvalds
1641da177e4SLinus Torvalds[RNDIS_EventLog_AddReg]
1651da177e4SLinus TorvaldsHKR, , EventMessageFile, 0x00020000, "%%SystemRoot%%\System32\netevent.dll"
1661da177e4SLinus TorvaldsHKR, , TypesSupported,   0x00010001, 7
1671da177e4SLinus Torvalds
1681da177e4SLinus Torvalds; Common Sections -------------------------------------------------
1691da177e4SLinus Torvalds
1701da177e4SLinus Torvalds[RNDIS_AddReg_Common]
1711da177e4SLinus TorvaldsHKR, NDI\params\NetworkAddress, ParamDesc,  0, %NetworkAddress%
1721da177e4SLinus TorvaldsHKR, NDI\params\NetworkAddress, type,       0, "edit"
1731da177e4SLinus TorvaldsHKR, NDI\params\NetworkAddress, LimitText,  0, "12"
1741da177e4SLinus TorvaldsHKR, NDI\params\NetworkAddress, UpperCase,  0, "1"
1751da177e4SLinus TorvaldsHKR, NDI\params\NetworkAddress, default,    0, " "
1761da177e4SLinus TorvaldsHKR, NDI\params\NetworkAddress, optional,   0, "1"
1771da177e4SLinus Torvalds
1781da177e4SLinus Torvalds[SourceDisksNames]
1791da177e4SLinus Torvalds1=%SourceDisk%,,1
1801da177e4SLinus Torvalds
1811da177e4SLinus Torvalds[SourceDisksFiles]
1821da177e4SLinus Torvaldsusb8023m.sys=1
1831da177e4SLinus Torvaldsrndismpm.sys=1
1841da177e4SLinus Torvaldsusb8023w.sys=1
1851da177e4SLinus Torvaldsrndismpw.sys=1
1861da177e4SLinus Torvaldsusb8023k.sys=1
1871da177e4SLinus Torvaldsrndismpk.sys=1
1881da177e4SLinus Torvalds
1891da177e4SLinus Torvalds[DestinationDirs]
1901da177e4SLinus TorvaldsRNDIS_CopyFiles_98    = 10, system32/drivers
1911da177e4SLinus TorvaldsRNDIS_CopyFiles_ME    = 10, system32/drivers
1921da177e4SLinus TorvaldsRNDIS_CopyFiles_NT    = 12
1931da177e4SLinus Torvalds
1941da177e4SLinus Torvalds[Strings]
1951da177e4SLinus TorvaldsServiceDisplayName    = "USB Remote NDIS Network Device Driver"
1961da177e4SLinus TorvaldsNetworkAddress        = "Network Address"
1971da177e4SLinus TorvaldsLinux                 = "Linux Developer Community"
1981da177e4SLinus TorvaldsLinuxDevice           = "Linux USB Ethernet/RNDIS Gadget"
1991da177e4SLinus TorvaldsSourceDisk            = "Ethernet/RNDIS Gadget Driver Install Disk"
2001da177e4SLinus Torvalds
201