[mirror_ubuntu-artful-kernel.git] / Documentation / video4linux / bttv / Insmod-options


Note: "modinfo <module>" prints various informations about a kernel
module, among them a complete and up-to-date list of insmod options.
This list tends to be outdated because it is updated manually ...

==========================================================================

bttv.o
	the bt848/878 (grabber chip) driver

	insmod args:
		card=n		card type, see CARDLIST for a list.
		tuner=n		tuner type, see CARDLIST for a list.
		radio=0/1	card supports radio
		pll=0/1/2	pll settings
			0: don't use PLL
			1: 28 MHz crystal installed
			2: 35 MHz crystal installed

		triton1=0/1     for Triton1 (+others) compatibility
		vsfx=0/1	yet another chipset bug compatibility bit
				see README.quirks for details on these two.

		bigendian=n	Set the endianness of the gfx framebuffer.
				Default is native endian.
		fieldnr=0/1	Count fields.  Some TV descrambling software
				needs this, for others it only generates
				50 useless IRQs/sec.  default is 0 (off).
		autoload=0/1	autoload helper modules (tuner, audio).
				default is 1 (on).
		bttv_verbose=0/1/2  verbose level (at insmod time, while
				looking at the hardware).  default is 1.
		bttv_debug=0/1	debug messages (for capture).
				default is 0 (off).
		irq_debug=0/1	irq handler debug messages.
				default is 0 (off).
		gbuffers=2-32	number of capture buffers for mmap'ed capture.
				default is 4.
		gbufsize=	size of capture buffers. default and
				maximum value is 0x208000 (~2MB)
		no_overlay=0	Enable overlay on broken hardware.  There
				are some chipsets (SIS for example) which
				are known to have problems with the PCI DMA
				push used by bttv.  bttv will disable overlay
				by default on this hardware to avoid crashes.
				With this insmod option you can override this.
		no_overlay=1	Disable overlay. It should be used by broken
				hardware that doesn't support PCI2PCI direct
				transfers.
		automute=0/1	Automatically mutes the sound if there is
				no TV signal, on by default.  You might try
				to disable this if you have bad input signal
				quality which leading to unwanted sound
				dropouts.
		chroma_agc=0/1	AGC of chroma signal, off by default.
		adc_crush=0/1	Luminance ADC crush, on by default.
		i2c_udelay=     Allow reduce I2C speed. Default is 5 usecs
				(meaning 66,67 Kbps). The default is the
				maximum supported speed by kernel bitbang
				algorithm. You may use lower numbers, if I2C
				messages are lost (16 is known to work on
				all supported cards).

		bttv_gpio=0/1
		gpiomask=
		audioall=
		audiomux=
				See Sound-FAQ for a detailed description.

	remap, card, radio and pll accept up to four comma-separated arguments
	(for multiple boards).

tuner.o
	The tuner driver.  You need this unless you want to use only
	with a camera or external tuner ...

	insmod args:
		debug=1		print some debug info to the syslog
		type=n		type of the tuner chip. n as follows:
				see CARDLIST for a complete list.
		pal=[bdgil]	select PAL variant (used for some tuners
				only, important for the audio carrier).

tvmixer.o
	registers a mixer device for the TV card's volume/bass/treble
	controls (requires a i2c audio control chip like the msp3400).

	insmod args:
		debug=1		print some debug info to the syslog.
		devnr=n		allocate device #n (0 == /dev/mixer,
				1 = /dev/mixer1, ...), default is to
				use the first free one.

tvaudio.o
	new, experimental module which is supported to provide a single
	driver for all simple i2c audio control chips (tda/tea*).

	insmod args:
		tda8425  = 1	enable/disable the support for the
		tda9840  = 1	various chips.
		tda9850  = 1	The tea6300 can't be autodetected and is
		tda9855  = 1	therefore off by default, if you have
		tda9873  = 1	this one on your card (STB uses these)
		tda9874a = 1	you have to enable it explicitly.
		tea6300  = 0	The two tda985x chips use the same i2c
		tea6420  = 1	address and can't be disturgished from
		pic16c54 = 1	each other, you might have to disable
				the wrong one.
		debug = 1	print debug messages

	insmod args for tda9874a:
		tda9874a_SIF=1/2	select sound IF input pin (1 or 2)
					(default is pin 1)
		tda9874a_AMSEL=0/1	auto-mute select for NICAM (default=0)
					Please read note 3 below!
		tda9874a_STD=n		select TV sound standard (0..8):
					0 - A2, B/G
					1 - A2, M (Korea)
					2 - A2, D/K (1)
					3 - A2, D/K (2)
					4 - A2, D/K (3)
					5 - NICAM, I
					6 - NICAM, B/G
					7 - NICAM, D/K (default)
					8 - NICAM, L

	Note 1: tda9874a supports both tda9874h (old) and tda9874a (new) chips.
	Note 2: tda9874h/a and tda9875 (which is supported separately by
	tda9875.o) use the same i2c address so both modules should not be
	used at the same time.
	Note 3: Using tda9874a_AMSEL option depends on your TV card design!
		AMSEL=0: auto-mute will switch between NICAM sound
			 and the sound on 1st carrier (i.e. FM mono or AM).
		AMSEL=1: auto-mute will switch between NICAM sound
			 and the analog mono input (MONOIN pin).
	If tda9874a decoder on your card has MONOIN pin not connected, then
	use only tda9874_AMSEL=0 or don't specify this option at all.
	For example:
	  card=65 (FlyVideo 2000S) - set AMSEL=1 or AMSEL=0
	  card=72 (Prolink PV-BT878P rev.9B) - set AMSEL=0 only

msp3400.o
	The driver for the msp34xx sound processor chips. If you have a
	stereo card, you probably want to insmod this one.

	insmod args:
		debug=1/2	print some debug info to the syslog,
				2 is more verbose.
		simple=1	Use the "short programming" method.  Newer
				msp34xx versions support this.  You need this
				for dbx stereo.  Default is on if supported by
				the chip.
		once=1		Don't check the TV-stations Audio mode
				every few seconds, but only once after
				channel switches.
		amsound=1	Audio carrier is AM/NICAM at 6.5 Mhz.  This
				should improve things for french people, the
				carrier autoscan seems to work with FM only...

tea6300.o - OBSOLETE (use tvaudio instead)
	The driver for the tea6300 fader chip.  If you have a stereo
	card and the msp3400.o doesn't work, you might want to try this
	one.  This chip is seen on most STB TV/FM cards (usually from
	Gateway OEM sold surplus on auction sites).

	insmod args:
		debug=1		print some debug info to the syslog.

tda8425.o - OBSOLETE (use tvaudio instead)
	The driver for the tda8425 fader chip.  This driver used to be
	part of bttv.c, so if your sound used to work but does not
	anymore, try loading this module.

	insmod args:
		debug=1		print some debug info to the syslog.

tda985x.o - OBSOLETE (use tvaudio instead)
	The driver for the tda9850/55 audio chips.

	insmod args:
		debug=1		print some debug info to the syslog.
		chip=9850/9855	set the chip type.
Commit	Line	Data
1da177e4 LT	1
	2	Note: "modinfo <module>" prints various informations about a kernel
	3	module, among them a complete and up-to-date list of insmod options.
	4	This list tends to be outdated because it is updated manually ...
	5
	6	==========================================================================
	7
	8	bttv.o
	9	the bt848/878 (grabber chip) driver
	10
	11	insmod args:
	12	card=n card type, see CARDLIST for a list.
	13	tuner=n tuner type, see CARDLIST for a list.
	14	radio=0/1 card supports radio
	15	pll=0/1/2 pll settings
	16	0: don't use PLL
	17	1: 28 MHz crystal installed
	18	2: 35 MHz crystal installed
	19
	20	triton1=0/1 for Triton1 (+others) compatibility
	21	vsfx=0/1 yet another chipset bug compatibility bit
	22	see README.quirks for details on these two.
	23
	24	bigendian=n Set the endianness of the gfx framebuffer.
	25	Default is native endian.
	26	fieldnr=0/1 Count fields. Some TV descrambling software
	27	needs this, for others it only generates
	28	50 useless IRQs/sec. default is 0 (off).
	29	autoload=0/1 autoload helper modules (tuner, audio).
	30	default is 1 (on).
	31	bttv_verbose=0/1/2 verbose level (at insmod time, while
	32	looking at the hardware). default is 1.
	33	bttv_debug=0/1 debug messages (for capture).
	34	default is 0 (off).
	35	irq_debug=0/1 irq handler debug messages.
	36	default is 0 (off).
	37	gbuffers=2-32 number of capture buffers for mmap'ed capture.
	38	default is 4.
	39	gbufsize= size of capture buffers. default and
	40	maximum value is 0x208000 (~2MB)
	41	no_overlay=0 Enable overlay on broken hardware. There
	42	are some chipsets (SIS for example) which
	43	are known to have problems with the PCI DMA
	44	push used by bttv. bttv will disable overlay
	45	by default on this hardware to avoid crashes.
	46	With this insmod option you can override this.
4dcef524 MCC	47	no_overlay=1 Disable overlay. It should be used by broken
	48	hardware that doesn't support PCI2PCI direct
	49	transfers.
1da177e4 LT	50	automute=0/1 Automatically mutes the sound if there is
	51	no TV signal, on by default. You might try
	52	to disable this if you have bad input signal
	53	quality which leading to unwanted sound
	54	dropouts.
	55	chroma_agc=0/1 AGC of chroma signal, off by default.
	56	adc_crush=0/1 Luminance ADC crush, on by default.
141276b5 MCC	57	i2c_udelay= Allow reduce I2C speed. Default is 5 usecs
	58	(meaning 66,67 Kbps). The default is the
	59	maximum supported speed by kernel bitbang
d08df601	60	algorithm. You may use lower numbers, if I2C
141276b5 MCC	61	messages are lost (16 is known to work on
141276b5 MCC	62	all supported cards).
1da177e4 LT	63
	64	bttv_gpio=0/1
	65	gpiomask=
	66	audioall=
	67	audiomux=
	68	See Sound-FAQ for a detailed description.
	69
	70	remap, card, radio and pll accept up to four comma-separated arguments
	71	(for multiple boards).
	72
	73	tuner.o
	74	The tuner driver. You need this unless you want to use only
	75	with a camera or external tuner ...
	76
	77	insmod args:
	78	debug=1 print some debug info to the syslog
	79	type=n type of the tuner chip. n as follows:
	80	see CARDLIST for a complete list.
	81	pal=[bdgil] select PAL variant (used for some tuners
	82	only, important for the audio carrier).
	83
	84	tvmixer.o
	85	registers a mixer device for the TV card's volume/bass/treble
	86	controls (requires a i2c audio control chip like the msp3400).
	87
	88	insmod args:
	89	debug=1 print some debug info to the syslog.
	90	devnr=n allocate device #n (0 == /dev/mixer,
	91	1 = /dev/mixer1, ...), default is to
	92	use the first free one.
	93
	94	tvaudio.o
	95	new, experimental module which is supported to provide a single
	96	driver for all simple i2c audio control chips (tda/tea*).
	97
	98	insmod args:
	99	tda8425 = 1 enable/disable the support for the
	100	tda9840 = 1 various chips.
	101	tda9850 = 1 The tea6300 can't be autodetected and is
	102	tda9855 = 1 therefore off by default, if you have
	103	tda9873 = 1 this one on your card (STB uses these)
	104	tda9874a = 1 you have to enable it explicitly.
	105	tea6300 = 0 The two tda985x chips use the same i2c
	106	tea6420 = 1 address and can't be disturgished from
	107	pic16c54 = 1 each other, you might have to disable
	108	the wrong one.
	109	debug = 1 print debug messages
	110
	111	insmod args for tda9874a:
	112	tda9874a_SIF=1/2 select sound IF input pin (1 or 2)
	113	(default is pin 1)
	114	tda9874a_AMSEL=0/1 auto-mute select for NICAM (default=0)
	115	Please read note 3 below!
	116	tda9874a_STD=n select TV sound standard (0..8):
	117	0 - A2, B/G
	118	1 - A2, M (Korea)
	119	2 - A2, D/K (1)
	120	3 - A2, D/K (2)
	121	4 - A2, D/K (3)
	122	5 - NICAM, I
	123	6 - NICAM, B/G
	124	7 - NICAM, D/K (default)
	125	8 - NICAM, L
	126
127	Note 1: tda9874a supports both tda9874h (old) and tda9874a (new) chips.
128	Note 2: tda9874h/a and tda9875 (which is supported separately by
129	tda9875.o) use the same i2c address so both modules should not be
130	used at the same time.
131	Note 3: Using tda9874a_AMSEL option depends on your TV card design!
132	AMSEL=0: auto-mute will switch between NICAM sound
133	and the sound on 1st carrier (i.e. FM mono or AM).
134	AMSEL=1: auto-mute will switch between NICAM sound
135	and the analog mono input (MONOIN pin).
136	If tda9874a decoder on your card has MONOIN pin not connected, then
137	use only tda9874_AMSEL=0 or don't specify this option at all.
138	For example:
139	card=65 (FlyVideo 2000S) - set AMSEL=1 or AMSEL=0
140	card=72 (Prolink PV-BT878P rev.9B) - set AMSEL=0 only
141
142	msp3400.o
143	The driver for the msp34xx sound processor chips. If you have a
144	stereo card, you probably want to insmod this one.
145
146	insmod args:
147	debug=1/2 print some debug info to the syslog,
148	2 is more verbose.
149	simple=1 Use the "short programming" method. Newer
150	msp34xx versions support this. You need this
151	for dbx stereo. Default is on if supported by
152	the chip.
153	once=1 Don't check the TV-stations Audio mode
154	every few seconds, but only once after
155	channel switches.
156	amsound=1 Audio carrier is AM/NICAM at 6.5 Mhz. This
157	should improve things for french people, the
158	carrier autoscan seems to work with FM only...
159
160	tea6300.o - OBSOLETE (use tvaudio instead)
161	The driver for the tea6300 fader chip. If you have a stereo
162	card and the msp3400.o doesn't work, you might want to try this
163	one. This chip is seen on most STB TV/FM cards (usually from
164	Gateway OEM sold surplus on auction sites).
165
166	insmod args:
167	debug=1 print some debug info to the syslog.
168
169	tda8425.o - OBSOLETE (use tvaudio instead)
170	The driver for the tda8425 fader chip. This driver used to be
171	part of bttv.c, so if your sound used to work but does not
172	anymore, try loading this module.
173
174	insmod args:
175	debug=1 print some debug info to the syslog.
176
177	tda985x.o - OBSOLETE (use tvaudio instead)
178	The driver for the tda9850/55 audio chips.
179
180	insmod args:
181	debug=1 print some debug info to the syslog.
182	chip=9850/9855 set the chip type.