Development: How to develop drivers for USB based devices - Revision history

CityK: add cat.

2009-01-15T23:49:17Z

add cat.

← Older revision		Revision as of 23:49, 15 January 2009
Line 36:		Line 36:
	* [[usbreplay]] - allows one to replay parsed usbsnoop log files on a Linux system		* [[usbreplay]] - allows one to replay parsed usbsnoop log files on a Linux system
	* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]		* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]
		+
		+	[[Category:Development]]

CityK: add links

2009-01-15T23:47:17Z

add links

← Older revision		Revision as of 23:47, 15 January 2009
Line 9:		Line 9:

	==Familiarizing yourself with a USB driver==		==Familiarizing yourself with a USB driver==
-	To start with, there are some great Linux USB tutorials on Linux Journal:	+	To start with:
		+	* For general references on how to develop a Linux kernel driver module, take a look at the [http://jungla.dit.upm.es/%7Ejmseyas/linux/kernel/hackers-docs.html Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel].
		+	As for USB drivers specifically, there are some great Linux USB tutorials on Linux Journal:
	{{Note\|It's likely that these Linux Journal articles contain a fair measure of outdated information (e.g. Hot Plug etc have been replaced by [[Wikipedia:Udev\|udev]]). Nonetheless, they may still contain plenty of other quality information, so it may be well worth a perusal through them}}		{{Note\|It's likely that these Linux Journal articles contain a fair measure of outdated information (e.g. Hot Plug etc have been replaced by [[Wikipedia:Udev\|udev]]). Nonetheless, they may still contain plenty of other quality information, so it may be well worth a perusal through them}}

Line 19:		Line 21:
	In addition, get the source code for the [http://www.linuxtv.org/repo/ LinuxTV V4L-DVB driver set]. You will find that USB based DVB drivers are contained within the ''./v4l-dvb/linux/drivers/media/dvb/dvb-usb'' directory. Have a bit of a browse through them while you're reading through the first article listed above, and try to get a feel for how the driver is put together (note: there is also a procedure about this that is described in a thread found [http://www.ubuntuforums.org/showthread.php?p=1067326 here]). Sometimes you can get a good head start in your own development efforts by attempting to leverage parts of earlier released code -- that which may have been written specifically for the exact same chip as contained in your own device or via code for a near similar chip, such as say from a previous production generation. Simply, modifying existing code to suite your own endeavour can greatly expediate the process of driver development.		In addition, get the source code for the [http://www.linuxtv.org/repo/ LinuxTV V4L-DVB driver set]. You will find that USB based DVB drivers are contained within the ''./v4l-dvb/linux/drivers/media/dvb/dvb-usb'' directory. Have a bit of a browse through them while you're reading through the first article listed above, and try to get a feel for how the driver is put together (note: there is also a procedure about this that is described in a thread found [http://www.ubuntuforums.org/showthread.php?p=1067326 here]). Sometimes you can get a good head start in your own development efforts by attempting to leverage parts of earlier released code -- that which may have been written specifically for the exact same chip as contained in your own device or via code for a near similar chip, such as say from a previous production generation. Simply, modifying existing code to suite your own endeavour can greatly expediate the process of driver development.

-	There is also a small amount of information in the "[[DVB via USB\|General Information Regarding DVB via USB]]" article.	+	There is also a small amount of information in the "[[DVB via USB\|General Information Regarding DVB via USB]]" article. Likewise, the "[[Development: Reverse Engineering USB Webcams\|Reverse Engineering USB Webcams]]" article may contain information of interest.

	==Some useful USB related tools==		==Some useful USB related tools==

Mauro Carvalho Chehab: /* Initial Steps */

2009-01-02T15:21:02Z

Initial Steps

← Older revision		Revision as of 15:21, 2 January 2009
Line 5:		Line 5:

	The next logical step would be to try to obtain technical datasheets on the component ICs. Many [[List_of_Chipset_Vendors\|chip manufacturers]] make this documentation directly readily available. In other cases, the datasheets are available, but it will take the likes of a google search to find (i.e. using the chip's part or model number can quickly track down multiple sources for such documentation ... Note: some "datasheet archive" websites ask you to log in or pay in order to obtain the information, however, be advised that the documentation will almost always be available elsewhere completely free of such restrictions). When no information whatsoever exists, or has been freely released by the chip vendor, if you are still serious about developing driver support for your device, you may wish to contact the vendor directly to see if they will agree to releasing such information to you (which most likely will come in the form of being under a [[NDA]]). In the very worst instances, particularly those cases of complex chips that also contain DRM (digital rights management) type engines for conditional access purposes, it is unlikely you, as an individual, will be able to obtain help or information from the vendor.		The next logical step would be to try to obtain technical datasheets on the component ICs. Many [[List_of_Chipset_Vendors\|chip manufacturers]] make this documentation directly readily available. In other cases, the datasheets are available, but it will take the likes of a google search to find (i.e. using the chip's part or model number can quickly track down multiple sources for such documentation ... Note: some "datasheet archive" websites ask you to log in or pay in order to obtain the information, however, be advised that the documentation will almost always be available elsewhere completely free of such restrictions). When no information whatsoever exists, or has been freely released by the chip vendor, if you are still serious about developing driver support for your device, you may wish to contact the vendor directly to see if they will agree to releasing such information to you (which most likely will come in the form of being under a [[NDA]]). In the very worst instances, particularly those cases of complex chips that also contain DRM (digital rights management) type engines for conditional access purposes, it is unlikely you, as an individual, will be able to obtain help or information from the vendor.
		+
		+	If you couldn't get enough info, you may try identify what commands are sent to the device by [http://www.linuxtv.org/wiki/index.php/Bus_snooping/sniffing Snooping the device bus]. This procedure is generally simpler with USB devices.

	==Familiarizing yourself with a USB driver==		==Familiarizing yourself with a USB driver==

CityK: /* Linux */ set usbreplay link

2008-12-21T23:45:28Z

Linux: set usbreplay link

← Older revision		Revision as of 23:45, 21 December 2008
Line 30:		Line 30:
	** [http://www.wireshark.org/ Wireshark] - can interface with usbmon's output; see the Wireshark wiki page's regarding USB: [http://wiki.wireshark.org/USB here] and [http://wiki.wireshark.org/CaptureSetup/USB here]		** [http://www.wireshark.org/ Wireshark] - can interface with usbmon's output; see the Wireshark wiki page's regarding USB: [http://wiki.wireshark.org/USB here] and [http://wiki.wireshark.org/CaptureSetup/USB here]
	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge output log files produced by usbsnoop/SniffUSB		* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge output log files produced by usbsnoop/SniffUSB
-	* [~~http://mcentral.de/wiki/index.php5/Usbreplay~~ usbreplay] - allows one to replay parsed usbsnoop log files on a Linux system	+	* [[usbreplay]] - allows one to replay parsed usbsnoop log files on a Linux system
	* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]		* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]

CityK: some minor edits

2008-12-21T23:34:34Z

some minor edits

CityK: some minor description changes

2008-12-21T23:26:27Z

some minor description changes

← Older revision		Revision as of 23:26, 21 December 2008
Line 25:		Line 25:

	===Linux===		===Linux===
-	* [[usbmon]] -	+	* [[usbmon]] - a Linux kernel module which can snoop and output USB communications traffic
-	** [[Usbmon2usbsnoop]] - a script that converts the output from usbmon to usbsnoop log format, thereby making the captured data compatible for use with usbreplay	+	** [[Usbmon2usbsnoop]] - a script that converts the output from usbmon to usbsnoop log format, thereby making the captured data compatible for use with usbreplay (see below)
-	* [http://www.wireshark.org/ Wireshark] -	+	** [http://www.wireshark.org/ Wireshark] - can interface with usbmon's output; see the Wireshark wiki page's regarding USB: [http://wiki.wireshark.org/USB here] and [http://wiki.wireshark.org/CaptureSetup/USB here]
-	** [http://wiki.wireshark.org/USB ~~Wireshark~~ wiki]	+	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge output log files produced by usbsnoop/SniffUSB
-	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge ~~usbsnoop/usbsniff~~ output log ~~file~~	+
	* [http://mcentral.de/wiki/index.php5/Usbreplay usbreplay] - allows one to replay parsed usbsnoop log files on a Linux system		* [http://mcentral.de/wiki/index.php5/Usbreplay usbreplay] - allows one to replay parsed usbsnoop log files on a Linux system
-	* ~~usb-robot~~ [http://usb-robot.sourceforge.net/] [http://sourceforge.net/projects/usb-robot/] - can play back a log file captured with [[usbsnoop\|USB Snoopy]]	+	* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]

CityK: some additions/rearrangements/headings

2008-12-21T20:26:13Z

some additions/rearrangements/headings

← Older revision		Revision as of 20:26, 21 December 2008
Line 15:		Line 15:
	In addition, get the source code for the [http://www.linuxtv.org/repo/ LinuxTV V4L-DVB driver set]. You will find that USB based DVB drivers are contained within the ''./v4l-dvb/linux/drivers/media/dvb/dvb-usb'' directory. Have a bit of a browse through them while you're reading through the first article listed above, and try to get a feel for how the driver is put together (note: there is also a procedure about this that is described in a thread found [http://www.ubuntuforums.org/showthread.php?p=1067326 here]). Sometimes you can get a good head start in your own development efforts by attempting to leverage parts of earlier released code -- that which may have been written specifically for the exact same chip as contained in your own device or via code for a near similar chip, such as say from a previous production generation. Simply, modifying existing code to suite your own endeavour can greatly expediate the process of driver development.		In addition, get the source code for the [http://www.linuxtv.org/repo/ LinuxTV V4L-DVB driver set]. You will find that USB based DVB drivers are contained within the ''./v4l-dvb/linux/drivers/media/dvb/dvb-usb'' directory. Have a bit of a browse through them while you're reading through the first article listed above, and try to get a feel for how the driver is put together (note: there is also a procedure about this that is described in a thread found [http://www.ubuntuforums.org/showthread.php?p=1067326 here]). Sometimes you can get a good head start in your own development efforts by attempting to leverage parts of earlier released code -- that which may have been written specifically for the exact same chip as contained in your own device or via code for a near similar chip, such as say from a previous production generation. Simply, modifying existing code to suite your own endeavour can greatly expediate the process of driver development.

-	~~===Some useful tools===~~	+	There is also a small amount of information in the "[[DVB via USB\|General Information Regarding DVB via USB]]" article.
-	* [[usbsnoop]]- a ~~Windows USB sniffer utility~~	+
-	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the ~~huge usbsniff log file~~	+
-	* [~~http://mcentral.de/wiki/index.php5/Usbreplay~~ USB ~~Replay] - allows one to replay parsed usbsnoop logfiles on a Linux system~~	+
-	** also see this [[ULi_M920x_parse\|~~M920x specific script~~]] ~~for some ideas~~	+
-	* USBmon	+
-	* [[Usbmon2usbsnoop]] - a script that converts the output from usbmon to a format that is compatible with USB Replay	+

-	==~~Also See~~==	+	==Some useful USB related tools==
-	* [[~~DVB via~~ USB\|~~General Information Regarding DVB via~~ USB]]	+	===Windows===
		+	* [[usbsnoop]] - a Windows based utility for sniffing/monitoring communications traffic for a USB device
		+	** In case usbsniff/usbsnoop doesn't work for you, here are a few others that will work under Vista:
		+	*** [http://www.hhdsoftware.com/Family/usb-monitor.html USB Monitor] - 14-day trial period
		+	*** [http://www.usblyzer.com/ USBlyzer] - fully functional evaluation version for 33 days
		+
		+	===Linux===
		+	* [[usbmon]] -
		+	** [[Usbmon2usbsnoop]] - a script that converts the output from usbmon to usbsnoop log format, thereby making the captured data compatible for use with usbreplay
		+	* [http://www.wireshark.org/ Wireshark] -
		+	** [http://wiki.wireshark.org/USB Wireshark wiki]
		+	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge usbsnoop/usbsniff output log file
		+	* [http://mcentral.de/wiki/index.php5/Usbreplay usbreplay] - allows one to replay parsed usbsnoop log files on a Linux system
		+	* usb-robot [http://usb-robot.sourceforge.net/] [http://sourceforge.net/projects/usb-robot/] - can play back a log file captured with [[usbsnoop\|USB Snoopy]]

CityK: set usbsnoop link, add udev note

2008-12-21T17:27:06Z

set usbsnoop link, add udev note

← Older revision		Revision as of 17:27, 21 December 2008
Line 10:		Line 10:
	* start here: [http://www.linuxjournal.com/article/4786 How to Write a Linux USB Device Driver]		* start here: [http://www.linuxjournal.com/article/4786 How to Write a Linux USB Device Driver]
	* then here: [http://www.linuxjournal.com/article/7353 Writing a Simple USB Driver]		* then here: [http://www.linuxjournal.com/article/7353 Writing a Simple USB Driver]
-	* here: [http://www.linuxjournal.com/article/5604 Hot Plug]	+	* here: [http://www.linuxjournal.com/article/5604 Hot Plug] .... Note: hot plug etc have been replaced by [[Wikipedia:Udev\|udev]]
	* and then here: [http://www.linuxjournal.com/article/7582 Snooping the USB Data Stream]		* and then here: [http://www.linuxjournal.com/article/7582 Snooping the USB Data Stream]

Line 16:		Line 16:

	===Some useful tools===		===Some useful tools===
-	* [~~http://benoit.papillault.free.fr/usbsnoop/~~ usbsnoop] - a Windows USB sniffer ~~utilitly, which adheres to the WDM architecture~~	+	* [[usbsnoop]]- a Windows USB sniffer utility
-	** also see [http://www.pcausa.com/Utilities/UsbSnoop/default.htm SniffUSB 2.0] - a usbsnoop derivative	+
	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge usbsniff log file		* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge usbsniff log file
	* [http://mcentral.de/wiki/index.php5/Usbreplay USB Replay] - allows one to replay parsed usbsnoop logfiles on a Linux system		* [http://mcentral.de/wiki/index.php5/Usbreplay USB Replay] - allows one to replay parsed usbsnoop logfiles on a Linux system

Andywebsdale: /* Some useful tools */

2008-07-06T00:00:08Z

Some useful tools

← Older revision		Revision as of 00:00, 6 July 2008
Line 18:		Line 18:
	* [http://benoit.papillault.free.fr/usbsnoop/ usbsnoop] - a Windows USB sniffer utilitly, which adheres to the WDM architecture		* [http://benoit.papillault.free.fr/usbsnoop/ usbsnoop] - a Windows USB sniffer utilitly, which adheres to the WDM architecture
	** also see [http://www.pcausa.com/Utilities/UsbSnoop/default.htm SniffUSB 2.0] - a usbsnoop derivative		** also see [http://www.pcausa.com/Utilities/UsbSnoop/default.htm SniffUSB 2.0] - a usbsnoop derivative
-	* parser.pl - a script for parsing the huge usbsniff log file	+	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge usbsniff log file
	* [http://mcentral.de/wiki/index.php5/Usbreplay USB Replay] - allows one to replay parsed usbsnoop logfiles on a Linux system		* [http://mcentral.de/wiki/index.php5/Usbreplay USB Replay] - allows one to replay parsed usbsnoop logfiles on a Linux system
	** also see this [[ULi_M920x_parse\|M920x specific script]] for some ideas		** also see this [[ULi_M920x_parse\|M920x specific script]] for some ideas

CityK: /* Initial Steps */ minor fixes and additons

2008-02-04T18:36:11Z

Initial Steps: minor fixes and additons

← Older revision		Revision as of 18:36, 4 February 2008
Line 2:		Line 2:

	==Initial Steps==		==Initial Steps==
-	The very first thing you would want to do is to identify the components used in your device~~. Refer~~ to the section entitled "[[Supported_Hardware#Gathering Information About Your Unidentified/Unsupported Device\|Gathering Information About Your Unidentified/Unsupported Device]]" for ~~some clues on how to proceed with that task~~.	+	The very first thing you would want to do is to identify the components used in your device as well as determine the device's subsystem ID; refer to the section entitled "[[Supported_Hardware#Gathering Information About Your Unidentified/Unsupported Device\|Gathering Information About Your Unidentified/Unsupported Device]]" for details.

-	The next logical step would be to try to obtain technical datasheets on the ~~components~~. Many chip manufacturers make this documentation ~~readiablily~~ available~~, while in~~ other cases a google search ~~for~~ the chip's part or model number ~~is necessary to~~ track down ~~other~~ sources for such documentation.	+	The next logical step would be to try to obtain technical datasheets on the component ICs. Many [[List_of_Chipset_Vendors\|chip manufacturers]] make this documentation directly readily available. In other cases, the datasheets are available, but it will take the likes of a google search to find (i.e. using the chip's part or model number can quickly track down multiple sources for such documentation ... Note: some "datasheet archive" websites ask you to log in or pay in order to obtain the information, however, be advised that the documentation will almost always be available elsewhere completely free of such restrictions). When no information whatsoever exists, or has been freely released by the chip vendor, if you are still serious about developing driver support for your device, you may wish to contact the vendor directly to see if they will agree to releasing such information to you (which most likely will come in the form of being under a [[NDA]]). In the very worst instances, particularly those cases of complex chips that also contain DRM (digital rights management) type engines for conditional access purposes, it is unlikely you, as an individual, will be able to obtain help or information from the vendor.

	==Familiarizing yourself with a USB driver==		==Familiarizing yourself with a USB driver==

← Older revision		Revision as of 23:34, 21 December 2008
Line 8:		Line 8:
	==Familiarizing yourself with a USB driver==		==Familiarizing yourself with a USB driver==
	To start with, there are some great Linux USB tutorials on Linux Journal:		To start with, there are some great Linux USB tutorials on Linux Journal:
		+	{{Note\|It's likely that these Linux Journal articles contain a fair measure of outdated information (e.g. Hot Plug etc have been replaced by [[Wikipedia:Udev\|udev]]). Nonetheless, they may still contain plenty of other quality information, so it may be well worth a perusal through them}}
		+
	* start here: [http://www.linuxjournal.com/article/4786 How to Write a Linux USB Device Driver]		* start here: [http://www.linuxjournal.com/article/4786 How to Write a Linux USB Device Driver]
	* then here: [http://www.linuxjournal.com/article/7353 Writing a Simple USB Driver]		* then here: [http://www.linuxjournal.com/article/7353 Writing a Simple USB Driver]
-	* here: [http://www.linuxjournal.com/article/5604 Hot Plug~~] .... Note: hot plug etc have been replaced by [[Wikipedia:Udev\|udev]~~]	+	* here: [http://www.linuxjournal.com/article/5604 Hot Plug]
	* and then here: [http://www.linuxjournal.com/article/7582 Snooping the USB Data Stream]		* and then here: [http://www.linuxjournal.com/article/7582 Snooping the USB Data Stream]

Line 19:		Line 21:
	==Some useful USB related tools==		==Some useful USB related tools==
	===Windows===		===Windows===
-	* [[usbsnoop]] - a Windows based utility for sniffing/monitoring communications traffic for a USB device	+	* [[usbsnoop]] - a Windows based utility for sniffing/monitoring communications traffic for a USB device. Note: In case usbsnoop/SniffUSB doesn't work for you, here are a few time limited apps that should work under Vista:
-	** In case ~~usbsniff~~/~~usbsnoop~~ doesn't work for you, here are a few ~~others~~ that ~~will~~ work under Vista:	+	** [http://www.hhdsoftware.com/Family/usb-monitor.html USB Monitor] - 14-day trial period
-	*** [http://www.hhdsoftware.com/Family/usb-monitor.html USB Monitor] - 14-day trial period	+	** [http://www.usblyzer.com/ USBlyzer] - fully functional evaluation version for 33 days
-	*** [http://www.usblyzer.com/ USBlyzer] - fully functional evaluation version for 33 days	+

	===Linux===		===Linux===
	* [[usbmon]] - a Linux kernel module which can snoop and output USB communications traffic		* [[usbmon]] - a Linux kernel module which can snoop and output USB communications traffic
-	** [[Usbmon2usbsnoop]] - a script that converts the output from usbmon to usbsnoop log format, thereby making the captured data compatible for use with usbreplay (see below)	+	** [[Usbmon2usbsnoop]] - a script that converts the output from usbmon to usbsnoop log format, thereby making the captured data compatible for use with usbreplay (see description below)
	** [http://www.wireshark.org/ Wireshark] - can interface with usbmon's output; see the Wireshark wiki page's regarding USB: [http://wiki.wireshark.org/USB here] and [http://wiki.wireshark.org/CaptureSetup/USB here]		** [http://www.wireshark.org/ Wireshark] - can interface with usbmon's output; see the Wireshark wiki page's regarding USB: [http://wiki.wireshark.org/USB here] and [http://wiki.wireshark.org/CaptureSetup/USB here]
	* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge output log files produced by usbsnoop/SniffUSB		* [http://mcentral.de/hg/~mrec/usbreplay/archive/tip.tar.gz parser.pl] - a script for parsing the huge output log files produced by usbsnoop/SniffUSB
	* [http://mcentral.de/wiki/index.php5/Usbreplay usbreplay] - allows one to replay parsed usbsnoop log files on a Linux system		* [http://mcentral.de/wiki/index.php5/Usbreplay usbreplay] - allows one to replay parsed usbsnoop log files on a Linux system
	* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]		* [http://usb-robot.sourceforge.net/ usb-robot] (also see [http://sourceforge.net/projects/usb-robot/]) - can play back a log file captured with [[usbsnoop\|USB Snoopy]]