Difference between revisions of "Wiki - New Device Copy & Paste Template"

From LinuxTVWiki
Jump to: navigation, search
(Backing out inappropriate changes ONE BY ONE (i.e wasting my time ... and moving them to the user's page)
m (minor descriptional fix)
 
(9 intermediate revisions by one user not shown)
Line 2: Line 2:
  
 
Usage:
 
Usage:
* Once you have logged in, simply click the edit tab at the top of this page
+
* Once you have logged in to the wiki, open another browser tab or window and, in which, start creating a new device article
* Then from within the editing box at the bottom of the editing page, copy the entire contents of this article
+
* Next, return to this article and click the "view source" tab at the top of the page.  Then, copy the entire contents from the box displaying this page's wiki source code
* From within the editing box at the bottom of the new device page you are creating, paste the copied content from the "new device copy and paste template"  
+
* Then switch back to the new device page you are creating and, within the editing box at the bottom of it's page, paste the entire page code contents that you've just copied from the "New Device Copy & Paste Template" article
* Proceed to fill in the information relevant for the device and delete the italic directional comment sections provided by the template (as well as this notice)}}  
+
* Proceed then to edit your new device article page by filling in the various sections, replacing the template examples, with information relevant for the new device you are adding to the wiki.  Be sure to delete ''<font color<nowiki>=</nowiki>"#009000">the green italic directional comment sections</font>'' provided by the template (as well as this notice)}} <br>
  
''First, if possible, we would like a good overall image of what the device looks like (Note: do NOT use proprietary images unless you have obtained permission to do so). Next, provide a brief summary of what the device is and by whom it is provided (include wiki links to the card type and the vendor -- and, ideally, after you have finished editing this page, you should add links from those pages back to this one). The last introductory piece of information is the all important indication of whether or not the device is supported under Linux.  Here's an example:''<br />
+
<span style="color:#009000"> ''First, if possible, we would like a good overall image of what the device looks like (Note: do NOT use proprietary images unless you have obtained permission to do so). <br>
 +
''Next, provide a brief summary of what the device is and by whom it is provided (include wiki links to the card type and the vendor -- and, ideally, after you have finished editing this page, you should add links from those pages back to this one).'' <br>
 +
''The last introductory piece of information is the all important indication of whether or not the device is supported under Linux.  Here's an example:''</span><br>
  
 
[[Image:Kworld_ATSC_115_front.jpg|right|thumb|200px|Example Image: Add a good overall image of what the device looks like here and perhaps a very brief description]]
 
[[Image:Kworld_ATSC_115_front.jpg|right|thumb|200px|Example Image: Add a good overall image of what the device looks like here and perhaps a very brief description]]
  
An [[ATSC]] [[ATSC PCI cards]] from [[KWORLD]].   
+
An [[ATSC]] [[ATSC PCI Cards|PCI Card]] from [[KWorld]].   
  
 
The ATSC 115 is supported under Linux since kernel 2.6.24.
 
The ATSC 115 is supported under Linux since kernel 2.6.24.
  
''Note: The page contents menu will automagically build itself, so you need not worry about it''
+
<span style="color:#009000">''Note: The page contents menu will automagically build itself, so you need not worry about it''</span>
  
 
==Overview/Features==
 
==Overview/Features==
''Discuss the features and facets of the device here. For example:''<br>
+
<span style="color:#009000">''Discuss the features and facets of the device here. For example:''</span><br>
  
 
*  PCI interface
 
*  PCI interface
Line 24: Line 26:
  
 
===Components Used===
 
===Components Used===
''List the hardware ICs and modules used by the device here. For example:''<br>
+
<span style="color:#009000">''List the hardware ICs used by the device here. For example:''</span><br>
 
* [[Quantek QT1010]] (tuner)
 
* [[Quantek QT1010]] (tuner)
 
* [[Zarlink MT352|Intel/Zarlink MT352]] (demodulator)
 
* [[Zarlink MT352|Intel/Zarlink MT352]] (demodulator)
Line 30: Line 32:
  
 
===Other Images===
 
===Other Images===
''Use the included code to insert other images if necessary. Add as many high resolution pictures as you can i.e the card, the original box, the remote and, when uploading the files to the wiki, give them detailed specific names. Note: only use images taken by yourself or those 3rd party images for which you have received express written consent (such as from a vendor) that permits their usage.  For example:''<br>
+
<span style="color:#009000">''Use the included code to insert other images if necessary. Add as many high resolution pictures as you can i.e the card, the original box, the remote and, when uploading the files to the wiki, give them detailed specific names. Note: only use images taken by yourself or those 3rd party images for which you have received express written consent (such as from a vendor) that permits their usage.  For example:''</span><br>
 
<gallery perrow=5>
 
<gallery perrow=5>
 
  Image:VideoMate_DVB-T220_box.jpg|VideoMate DVB-T220 Box
 
  Image:VideoMate_DVB-T220_box.jpg|VideoMate DVB-T220 Box
Line 37: Line 39:
  
 
===Identification===
 
===Identification===
''Provide here, for PCI/PCIe devices, the relevant output of <code>lspci -vnn</code> or, in the case of USB devices, <code>lsusb -v </code>. We're particularly interested in the subsystem ID's. To make a code block simply make the first character of each line a space.  For example:''<br>
+
<span style="color:#009000">''Provide here, for PCI/PCIe devices, the relevant output of <code>lspci -vnn</code> or, in the case of USB devices, <code>lsusb -v </code>. We're particularly interested in the subsystem ID's. To make a code block simply make the first character of each line a space.  For example:''</span><br>
 
  # lspci -vvvnn
 
  # lspci -vvvnn
 
  04:03.0 Multimedia controller [0480]: Philips Semiconductors SAA7130 Video Broadcast Decoder [1131:7130] (rev 01)
 
  04:03.0 Multimedia controller [0480]: Philips Semiconductors SAA7130 Video Broadcast Decoder [1131:7130] (rev 01)
Line 51: Line 53:
  
 
==Making it Work==
 
==Making it Work==
''Is it supported under Linux?  Are there experimental drivers? Does it partially work or identify as another card? (if yes, add this information below)''
+
<span style="color:#009000">''Is it supported under Linux?  Are there experimental drivers? Does it partially work or identify as another card? (if yes, add this information below)''</span>
  
 
===Firmware===
 
===Firmware===
''Is there any firmware specific information for this device? if so, list it here. If your device doesn't require a firmware, simply mention that this is the case.''
+
<span style="color:#009000">''Is there any firmware specific information for this device? if so, list it here. If your device doesn't require a firmware, simply mention that this is the case.''</span>
  
 
===Drivers===
 
===Drivers===
''Provide the details of where the drivers and patches and necessary tools are available.''
+
<span style="color:#009000">''Discuss the kernel driver modules used by the device here. Provide the details of where the drivers, any patches, and any other necessary tools are available.''</span> 
  
 
===Sample Kernel Output===
 
===Sample Kernel Output===
''Provide the '''relevant''' portion of dmesg here.  For example:''<br>
+
<span style="color:#009000">''Provide the '''relevant''' portion of dmesg here.  For example:''</span><br>
 
  # dmesg
 
  # dmesg
 
  [  45.569669] saa7130/34: v4l2 driver version 0.2.14 loaded
 
  [  45.569669] saa7130/34: v4l2 driver version 0.2.14 loaded
Line 83: Line 85:
  
 
===Remote Control Support===
 
===Remote Control Support===
''Discuss support for the remote control here.''
+
<span style="color:#009000">''Discuss support for the remote control here.''</span>
  
 +
===An Appropriate Title===
 +
<span style="color:#009000">''If deemed necessary, create an additional heading (using an appropriate title) and add anything else that you think might be relevant''</span>
  
 
==External Links==
 
==External Links==
''Provide a link to the vendor's product page here along with any other external link to information that is generally helpful in relation to the device. For example:''<br>
+
<span style="color:#009000">''Provide a link to the vendor's product page here along with any other external link to information that is generally helpful in relation to the device. For example:''</span><br>
 
* [http://www.comprousa.com/en/product/t100t220/t220.html Compro T-220 product page]
 
* [http://www.comprousa.com/en/product/t100t220/t220.html Compro T-220 product page]
  
''Finally, add anything else that you think might be relevant under an appropriate heading.''
 
  
''Very last thing is add a catergory. (Remove the nowiki tags). For example''<br>
+
<span style="color:#009000">''Finally, the very last thing is to add a category. (Remove the nowiki tags). For example''</span><br>
 
<nowiki>[[Category:DVB-T PCI Devices]]</nowiki>
 
<nowiki>[[Category:DVB-T PCI Devices]]</nowiki>

Latest revision as of 22:02, 14 August 2012

Note: In essence, this page is a "copy and paste" template which users should use when establishing a new device article within the wiki. Its intended purpose is to serve as the basis for the format/layout of device articles; thereby striving to establish a general consistency throughout the wiki.

Usage:

  • Once you have logged in to the wiki, open another browser tab or window and, in which, start creating a new device article
  • Next, return to this article and click the "view source" tab at the top of the page. Then, copy the entire contents from the box displaying this page's wiki source code
  • Then switch back to the new device page you are creating and, within the editing box at the bottom of it's page, paste the entire page code contents that you've just copied from the "New Device Copy & Paste Template" article
  • Proceed then to edit your new device article page by filling in the various sections, replacing the template examples, with information relevant for the new device you are adding to the wiki. Be sure to delete the green italic directional comment sections provided by the template (as well as this notice)

First, if possible, we would like a good overall image of what the device looks like (Note: do NOT use proprietary images unless you have obtained permission to do so).
Next, provide a brief summary of what the device is and by whom it is provided (include wiki links to the card type and the vendor -- and, ideally, after you have finished editing this page, you should add links from those pages back to this one).
The last introductory piece of information is the all important indication of whether or not the device is supported under Linux. Here's an example:

Example Image: Add a good overall image of what the device looks like here and perhaps a very brief description

An ATSC PCI Card from KWorld.

The ATSC 115 is supported under Linux since kernel 2.6.24.

Note: The page contents menu will automagically build itself, so you need not worry about it

Overview/Features

Discuss the features and facets of the device here. For example:

  • PCI interface
  • Inputs: Antenna (Composite), Remote and S-Video In

Components Used

List the hardware ICs used by the device here. For example:

Other Images

Use the included code to insert other images if necessary. Add as many high resolution pictures as you can i.e the card, the original box, the remote and, when uploading the files to the wiki, give them detailed specific names. Note: only use images taken by yourself or those 3rd party images for which you have received express written consent (such as from a vendor) that permits their usage. For example:

Identification

Provide here, for PCI/PCIe devices, the relevant output of lspci -vnn or, in the case of USB devices, lsusb -v . We're particularly interested in the subsystem ID's. To make a code block simply make the first character of each line a space. For example:

# lspci -vvvnn
04:03.0 Multimedia controller [0480]: Philips Semiconductors SAA7130 Video Broadcast Decoder [1131:7130] (rev 01)
	Subsystem: Compro Technology, Inc. Videomate DVB-T200 [185b:c901]
	Control: I/O- Mem+ BusMaster+ SpecCycle- MemWINV- VGASnoop- ParErr- Stepping- SERR- FastB2B-
	Status: Cap+ 66MHz- UDF- FastB2B+ ParErr- DEVSEL=medium >TAbort- <TAbort- <MAbort- >SERR- <PERR-
	Latency: 84 (21000ns min, 8000ns max)
	Interrupt: pin A routed to IRQ 20
	Region 0: Memory at fdcfe000 (32-bit, non-prefetchable) [size=1K]
	Capabilities: [40] Power Management version 1
		Flags: PMEClk- DSI- D1+ D2+ AuxCurrent=0mA PME(D0-,D1-,D2-,D3hot-,D3cold-)
		Status: D0 PME-Enable- DSel=0 DScale=1 PME-

Making it Work

Is it supported under Linux? Are there experimental drivers? Does it partially work or identify as another card? (if yes, add this information below)

Firmware

Is there any firmware specific information for this device? if so, list it here. If your device doesn't require a firmware, simply mention that this is the case.

Drivers

Discuss the kernel driver modules used by the device here. Provide the details of where the drivers, any patches, and any other necessary tools are available.

Sample Kernel Output

Provide the relevant portion of dmesg here. For example:

# dmesg
[   45.569669] saa7130/34: v4l2 driver version 0.2.14 loaded
[   45.569739] saa7130[0]: found at 0000:04:03.0, rev: 1, irq: 20, latency: 84, mmio: 0xfdcfe000
[   45.569745] saa7130[0]: subsystem: 185b:c901, board: Compro Videomate DVB-T200 [card=71,autodetected]
[   45.569753] saa7130[0]: board init: gpio is 843f00
[   45.569809] input: saa7134 IR (Compro Videomate DV as /devices/pci0000:00/0000:00:1e.0/0000:04:03.0/input/input7
[   45.755429] saa7130[0]: i2c eeprom 00: 5b 18 01 c9 54 20 1c 00 43 43 a9 1c 55 d2 b2 92
[   45.755437] saa7130[0]: i2c eeprom 10: 00 ff 86 0f ff 20 ff ff ff ff ff ff ff ff ff ff
[   45.755443] saa7130[0]: i2c eeprom 20: 01 40 01 03 03 ff 03 01 08 ff 00 88 ff ff ff ff
[   45.755449] saa7130[0]: i2c eeprom 30: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
[   45.755454] saa7130[0]: i2c eeprom 40: ff d5 00 c4 86 1e ff ff ff ff ff ff ff ff ff ff
[   45.755460] saa7130[0]: i2c eeprom 50: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff cb
[   45.755466] saa7130[0]: i2c eeprom 60: 30 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
[   45.755471] saa7130[0]: i2c eeprom 70: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
[   45.755478] saa7130[0]: Unexpected tuner type info: d5 in eeprom
[   45.755532] saa7130[0]: registered device video0 [v4l2]
[   45.755550] saa7130[0]: registered device vbi0
[   45.873425] saa7134 ALSA driver for DMA sound loaded
[   45.873448] saa7130[0]/alsa: saa7130[0] at 0xfdcfe000 irq 20 registered as card -2
[   45.943354] saa7130[0]/dvb: frontend initialization failed

Remote Control Support

Discuss support for the remote control here.

An Appropriate Title

If deemed necessary, create an additional heading (using an appropriate title) and add anything else that you think might be relevant

External Links

Provide a link to the vendor's product page here along with any other external link to information that is generally helpful in relation to the device. For example:


Finally, the very last thing is to add a category. (Remove the nowiki tags). For example
[[Category:DVB-T PCI Devices]]