[deb_xorg-server.git] / hw / xfree86 / doc / Registry

This is the XFree86 driver/module registry.  To avoid name space clashes and
to maintain some consistency between drivers the important name spaces are
maintained here.

1. Module Names.

Each module is required to have a unique name.  Registered names are:

GLcore
acecad
afb
apm
ark
ati
atimisc
bitmap
bt8xx
calcomp
cfb
cfb16
cfb24
cfb32
chips
cirrus
citron
cyrix
dbe
ddc
digitaledge
dmc
dri
drm
dynapro
elo2300
elographics
extmod
fb
fbdev
fbdevhw
fi12x6
freetype
glide
glint
glx
hyperpen
i128
i2c
i740
i810
imstt
int10
joystick
keyboard
layer
magellan
magictouch
mfb
mga
microtouch
mouse
msp34xx
mutouch
neomagic
newport
nv
pcidata
penmount
pex5
r128
radeon
rac
ramdac
record
rendition
s3
s3virge
savage
shadow
shadowfb
siliconmotion
sis
spaceorb
speedo
summa
sunbw2
suncg14
suncg3
suncg6
sunffb
sunleo
suntcx
tdfx
tga
trident
tseng
type1
v4l
vbe
vesa
vga
vgahw
vmware
void
wacom
xaa
xf1bpp
xf24_32bpp
xf4bpp
xf8_16bpp
xf8_32bpp
xf8_32wid
xie
xtrap
xtt

2. External Module Object Symbols.

Each module is required to use a unique prefix or prefixes for all of
its externally visible symbols. They should be unique without regard to
case.  Registered prefixes are:

ati
bt8xx
cfb
chips
fi12x6
glide
glint
mfb
mga
msp34xx
neo
permedia
tseng
vga
vgahw
vmware
xaa
xf1bpp
xf4bpp

3. Chipset Names.

Each video driver is required to use a unique set of chipset names.  Case,
white space and underscore characters are ignored when comparing chipset
names.  All names listed here are in lower case with all white space and
underscores removed.  Registered chipset names are:

ati
ativga
ct64200
ct64300
ct65520
ct65525
ct65530
ct65535
ct65540
ct65545
ct65546
ct65548
ct65550
ct65554
ct65555
ct68554
ct69000
et4000
et4000w32
et4000w32i
et4000w32p
et6000
et6100
generic
ibmvga
ibm8514
mach32
mach64
mach8
mga2064w
mga1064sg
mga2164w
mga2164wagp
neo2070
neo2090
neo2093
neo2097
neo2160
neo2200
tipm2
vgawonder
voodoo

4. Option Names.

Option names and their usage should be consistent between drivers.
Case, white space and underscore characters are ignored when comparing
option names.  The prefix "no" may be added or removed from boolean
option names.  All names listed here are in their preferred user-visible
form.  Some registered option names are:

Types are:  B = boolean, O = set/unset (no value), I = integer, S = string,
            A = optional string, F = floating point number Q = frequency

Scopes are: F = global flags, V = video driver, C = common (per screen),
            I = input drivers, X = XAA, Xv = Xv extension, M = misc.

Names currently in use:

Name                    Type  Scope      Description
----------------------------------------------------------------------------
AllowMouseOpenFail        B     F    ignore mouse dev open failure
AllowNonLocalModInDev     B     F    allow non-local mod of input devs
AllowNonLocalXvidtune     B     F    allow non-local VidMode connections
BlankTime                 I     F    Screen saver timeout (min)
DisableModInDev           B     F    disallow changing input devs
DisableVidModeExtension   B     F    disable VidMode extension
DontVTSwitch              B     F    disable Ctrl-Alt-Fn
DontZap                   B     F    disable Ctrl-Alt-BS sequence
DontZoom                  B     F    disable Ctrl-Alt-+/-
NoTrapSignals             B     F    don't trap signals
OffTime                   I     F    Time before DPMS off mode active (min)
PciProbe1                 O     F    use PCI probe algorithm 1
PciProbe2                 O     F    use PCI probe algorithm 2
PciForceConfig1           O     F    force PCI config type 1
PciForceConfig2           O     F    force PCI config type 2
Pixmap                    I     F    depth 24 pixmap size (24 or 32)
StandbyTime               I     F    Time before DPMS standby active (min)
SuspendTime               I     F    Time before DPMS suspend mode active (min)

BackingStore              B     C    Enable backing store
DDC                       B     C    Enable/disable DDC
DDC1                      B     C    Enable/disable DDC1
DDC2                      B     C    Enable/disable DDC2
DPMS                      O     C    Enable DPMS
MTRR                      B     C    Enable/disable setting MTRRs

BaudRate                  I     I    Serial port baud rate
ButtonNumber              I     I    Button number (for touch screen?)
ButtonThreshold           I     I    ??
ClearDTR                  O     I    Clear serial port DTR
ClearRTS                  O     I    Clear serial port RTS
DataBits                  I     I    Serial port data bits
DemandLoad                O     I    ??
Device                    S     I    Device file name
DeviceName                S     I    Input device name
FlowControl               S     I    Serial flow control ("xon", "none")
Floating                  B     I    Device initialised as floating
HistorySize               I     I    ??
MaxX                      I     I    Maximum X coordinate
MaxY                      I     I    Maximum Y coordinate
MinX                      I     I    Minimum X coordinate
MinY                      I     I    Minimum Y coordinate
Parity                    S     I    Serial port parity ("odd", "even", "none")
ReportDelay               I     I    ??
ReportingMode             S     I    may be "raw" or "scaled"
ScreenNumber              I     I    Screen number (for touch screen)
SendCoreEvents            B     I    Send core events
StopBits                  I     I    Serial port stop bits
SwapXY                    B     I    Swap the X and Y axes
UntouchDelay              I     I    ??
Vmin                      I     I    Tty VMIN
Vtime                     I     I    Tty VTIME


18BitBus                  B     V    ??
8Plus16                   B     V    Enable depth 8 + depth 16 with overlay
8Plus24                   B     V    Enable depth 8 + depth 24 with overlay
BlockWrite                B     V    Enable/disable block write
ColorKey                  I     V    Set the color key for overlay modes
CompositeSync             B     V    Composite sync
CRTDisplay                B     V    Force display on CRT, not LCD
CRTScreen                 B     V    Display on CRT, not LCD (Obsolete)
EarlyRasPrecharge         O     V    Early RAS pre-charge
FastDRAM                  O     V    Fast DRAM
FifoAggressive            O     V    Aggressive FIFO setting
FifoConservative          O     V    Conservative FIFO setting
FifoModerate              O     V    Moderate FIFO setting
FireGL3000                B     V    Card is Diamond FireGL3000
FixPanelSize              B     V    ??
FPClock8                  Q     V    Flat panel clock for 8bpp fb (MHz)
FPClock16                 Q     V    Flat panel clock for 16bpp fb (MHz)
FPClock24                 Q     V    Flat panel clock for 24bpp fb (MHz)
FPClock32                 Q     V    Flat panel clock for 32bpp fb (MHz)
FPMVRAM                   O     V    Fast page mode VRAM
FramebufferWC             B     V    Enable/disable WC for the framebuffer
GlideDevice               I     V    Selects which Voodoo board to use
HiBitHigh                 O     V    High clock bit default to set
HiBitLow                  O     V    High clock bit default to cleared
HWClocks                  B     V    Enable/disable HW clocks
HWCursor                  B     V    Enable/disable HW cursor
LateRasPrecharge          O     V    Late RAS pre-charge
Legend                    O     V    Card is Legend ET4000
LCDCenter                 B     V    Enable/disable centering for LCD displays
Linear                    B     V    Enable/disable linear framebuffer
MCLK                      Q     V    Specify the current MCLK value (MHz)
MedDRAM                   B     V    Medium speed DRAM
MemCfg1                   I     V    ??
MemCfg2                   I     V    ??
MGASDRAM                  B     V    Mga card has SDRAM
MMIO                      B     V    Enable/disable memory mapped I/O
MMIOCache                 B     V    Enable/Disable MMIO cache
MuxThreshold              I     V    Multiplexing threshold (kHz)
NoAccel                   B     V    Disable/enable acceleration
NoClockChip               B     V    ??
NoStretch                 B     V    Disable/enable stretching for LCD displays
OnAtExit                  B     V    Leave video signal on when exiting server
OverclockMem              B     V    Enable memory overclocking
Overlay                   A     V    Enable multi-depth/overlay.  An optional
                                     string "M,N" may be specified, where
                                     M, N are the depths.
PanelDisplay              B     V    Force display on LCD
PciBurst                  B     V    Enable/disable PCI burst mode
PciRetry                  B     V    Enable/disable PCI retries
ProbeClocks               B     V    Force probe for non-programmable clocks
ReferenceClock            Q     V    Clock generator reference frequency
RGBbits                   I     V    Number of significant bits per rgb
Rotate                    S     V    Rotate the virtual display (CW or CCW)
SetLCDClk                 Q     V    Set LCD clock (MHz)
SetMclk                   Q     V    Set Memory Clock (MHz)
ShadowFB                  B     V    Enable shadow framebuffer layer
ShowCache                 B     V    Enable viewing of offscreen memory
ShowOverscan              O     V    Set the overscan area to a visible colour
SlowDRAM                  O     V    Slow DRAM
SlowEDODRAM               O     V    Slow EDO DRAM
STN                       B     V    STN screen type (??)
SWCursor                  B     V    Enable/disable SW cursor
SuspendHack               B     V    ??
SyncOnGreen               B     V    Enable/disable sync on green
TurboQueue                B     V    Enable/disable turbo queue
UseFBDev                  B     V    Use the fbdev driver interface
UseModeLine               B     V    Use Modeline (??)
W32Interleave             B     V    ??

Buffers			  I	Xv   Number of buffers
Device			  S	Xv   Device file name
Expose                    B     Xv   Disable occlusion clipping (see DESIGN)
FramesPerSec		  I	Xv   Max. refresh frequency

XAA options.  All are of type "O" and scope "X", and are self-explanatory

XaaNoColor8x8PatternFillRect
XaaNoColor8x8PatternFillTrap
XaaNoCPUToScreenColorExpandFill
XaaNoDashedBresenhamLine
XaaNoDashedTwoPointLine
XaaNoScreenToScreenCopy
XaaNoImageReadRect
XaaNoImageWriteRect
XaaNoMono8x8PatternFillRect
XaaNoMono8x8PatternFillTrap
XaaNoOffscreenPixmaps
XaaNoPixmapCache
XaaNoScanlineCPUToScreenColorExpandFill
XaaNoScanlineImageWriteRect
XaaNoScreenToScreenColorExpandFill
XaaNoSolidBresenhamLine
XaaNoSolidFillRect
XaaNoSolidFillTrap
XaaNoSolidHorVertLine
XaaNoSolidTwoPointLine


Names used in previous versions:

16Clocks
8Clocks
ClkDiv2
EDO VRAM
ExternDisp
ExtFramBuf
FastVRAM
FavorBitBlt
InternDisp
NoBitBlt
NoFontCache
NoImageBlt
NoMemAccess
NoPciDisconnect
NoPixmapCache
NoProgramClocks
NoSplitXfer
OverrideBIOS
OverrideValidateMode
ProgLcdModeRegs
ProgLcdModeStretch
SlowDRAMrefresh
SlowVRAM
SwapHiBit


5. Ramdac Names.

Ramdac names should be consistent between drivers.  Case, white space
and underscore characters are ignored when comparing ramdac names.  All
names listed here are in lower case with all white space and underscores
removed.


6. Clock Chip Names.

Clock chip names should be consistent between drivers.  Case, white
space and underscore characters are ignored when comparing clock chip
names.  All names listed here are in lower case with all white space
and underscores removed.


$XFree86: xc/programs/Xserver/hw/xfree86/Registry,v 1.18 2002/04/06 18:31:09 tsi Exp $
Commit	Line	Data
a09e091a JB	1	This is the XFree86 driver/module registry. To avoid name space clashes and
	2	to maintain some consistency between drivers the important name spaces are
	3	maintained here.
	4
	5	1. Module Names.
	6
	7	Each module is required to have a unique name. Registered names are:
	8
	9	GLcore
	10	acecad
	11	afb
	12	apm
	13	ark
	14	ati
	15	atimisc
	16	bitmap
	17	bt8xx
	18	calcomp
	19	cfb
	20	cfb16
	21	cfb24
	22	cfb32
	23	chips
	24	cirrus
	25	citron
	26	cyrix
	27	dbe
	28	ddc
	29	digitaledge
	30	dmc
	31	dri
	32	drm
	33	dynapro
	34	elo2300
	35	elographics
	36	extmod
	37	fb
	38	fbdev
	39	fbdevhw
	40	fi12x6
	41	freetype
	42	glide
	43	glint
	44	glx
	45	hyperpen
	46	i128
	47	i2c
	48	i740
	49	i810
	50	imstt
	51	int10
	52	joystick
	53	keyboard
	54	layer
	55	magellan
	56	magictouch
	57	mfb
	58	mga
	59	microtouch
	60	mouse
	61	msp34xx
	62	mutouch
	63	neomagic
	64	newport
65	nv
66	pcidata
67	penmount
68	pex5
69	r128
70	radeon
71	rac
72	ramdac
73	record
74	rendition
75	s3
76	s3virge
77	savage
78	shadow
79	shadowfb
80	siliconmotion
81	sis
82	spaceorb
83	speedo
84	summa
85	sunbw2
86	suncg14
87	suncg3
88	suncg6
89	sunffb
90	sunleo
91	suntcx
92	tdfx
93	tga
94	trident
95	tseng
96	type1
97	v4l
98	vbe
99	vesa
100	vga
101	vgahw
102	vmware
103	void
104	wacom
105	xaa
106	xf1bpp
107	xf24_32bpp
108	xf4bpp
109	xf8_16bpp
110	xf8_32bpp
111	xf8_32wid
112	xie
113	xtrap
114	xtt
115
116	2. External Module Object Symbols.
117
118	Each module is required to use a unique prefix or prefixes for all of
119	its externally visible symbols. They should be unique without regard to
120	case. Registered prefixes are:
121
122	ati
123	bt8xx
124	cfb
125	chips
126	fi12x6
127	glide
128	glint
129	mfb
130	mga
131	msp34xx
132	neo
133	permedia
134	tseng
135	vga
136	vgahw
137	vmware
138	xaa
139	xf1bpp
140	xf4bpp
141
142	3. Chipset Names.
143
144	Each video driver is required to use a unique set of chipset names. Case,
145	white space and underscore characters are ignored when comparing chipset
146	names. All names listed here are in lower case with all white space and
147	underscores removed. Registered chipset names are:
148
149	ati
150	ativga
151	ct64200
152	ct64300
153	ct65520
154	ct65525
155	ct65530
156	ct65535
157	ct65540
158	ct65545
159	ct65546
160	ct65548
161	ct65550
162	ct65554
163	ct65555
164	ct68554
165	ct69000
166	et4000
167	et4000w32
168	et4000w32i
169	et4000w32p
170	et6000
171	et6100
172	generic
173	ibmvga
174	ibm8514
175	mach32
176	mach64
177	mach8
178	mga2064w
179	mga1064sg
180	mga2164w
181	mga2164wagp
182	neo2070
183	neo2090
184	neo2093
185	neo2097
186	neo2160
187	neo2200
188	tipm2
189	vgawonder
190	voodoo
191
192	4. Option Names.
193
194	Option names and their usage should be consistent between drivers.
195	Case, white space and underscore characters are ignored when comparing
196	option names. The prefix "no" may be added or removed from boolean
197	option names. All names listed here are in their preferred user-visible
198	form. Some registered option names are:
199
200	Types are: B = boolean, O = set/unset (no value), I = integer, S = string,
201	A = optional string, F = floating point number Q = frequency
202
203	Scopes are: F = global flags, V = video driver, C = common (per screen),
204	I = input drivers, X = XAA, Xv = Xv extension, M = misc.
205
206	Names currently in use:
207
208	Name Type Scope Description
209	----------------------------------------------------------------------------
210	AllowMouseOpenFail B F ignore mouse dev open failure
211	AllowNonLocalModInDev B F allow non-local mod of input devs
212	AllowNonLocalXvidtune B F allow non-local VidMode connections
213	BlankTime I F Screen saver timeout (min)
214	DisableModInDev B F disallow changing input devs
215	DisableVidModeExtension B F disable VidMode extension
216	DontVTSwitch B F disable Ctrl-Alt-Fn
217	DontZap B F disable Ctrl-Alt-BS sequence
218	DontZoom B F disable Ctrl-Alt-+/-
219	NoTrapSignals B F don't trap signals
220	OffTime I F Time before DPMS off mode active (min)
221	PciProbe1 O F use PCI probe algorithm 1
222	PciProbe2 O F use PCI probe algorithm 2
223	PciForceConfig1 O F force PCI config type 1
224	PciForceConfig2 O F force PCI config type 2
225	Pixmap I F depth 24 pixmap size (24 or 32)
226	StandbyTime I F Time before DPMS standby active (min)
227	SuspendTime I F Time before DPMS suspend mode active (min)
228
229	BackingStore B C Enable backing store
230	DDC B C Enable/disable DDC
231	DDC1 B C Enable/disable DDC1
232	DDC2 B C Enable/disable DDC2
233	DPMS O C Enable DPMS
234	MTRR B C Enable/disable setting MTRRs
235
236	BaudRate I I Serial port baud rate
237	ButtonNumber I I Button number (for touch screen?)
238	ButtonThreshold I I ??
239	ClearDTR O I Clear serial port DTR
240	ClearRTS O I Clear serial port RTS
241	DataBits I I Serial port data bits
242	DemandLoad O I ??
243	Device S I Device file name
244	DeviceName S I Input device name
245	FlowControl S I Serial flow control ("xon", "none")
246	Floating B I Device initialised as floating
247	HistorySize I I ??
248	MaxX I I Maximum X coordinate
249	MaxY I I Maximum Y coordinate
250	MinX I I Minimum X coordinate
251	MinY I I Minimum Y coordinate
252	Parity S I Serial port parity ("odd", "even", "none")
253	ReportDelay I I ??
254	ReportingMode S I may be "raw" or "scaled"
255	ScreenNumber I I Screen number (for touch screen)
256	SendCoreEvents B I Send core events
257	StopBits I I Serial port stop bits
258	SwapXY B I Swap the X and Y axes
259	UntouchDelay I I ??
260	Vmin I I Tty VMIN
261	Vtime I I Tty VTIME
262
263
264	18BitBus B V ??
265	8Plus16 B V Enable depth 8 + depth 16 with overlay
266	8Plus24 B V Enable depth 8 + depth 24 with overlay
267	BlockWrite B V Enable/disable block write
268	ColorKey I V Set the color key for overlay modes
269	CompositeSync B V Composite sync
270	CRTDisplay B V Force display on CRT, not LCD
271	CRTScreen B V Display on CRT, not LCD (Obsolete)
272	EarlyRasPrecharge O V Early RAS pre-charge
273	FastDRAM O V Fast DRAM
274	FifoAggressive O V Aggressive FIFO setting
275	FifoConservative O V Conservative FIFO setting
276	FifoModerate O V Moderate FIFO setting
277	FireGL3000 B V Card is Diamond FireGL3000
278	FixPanelSize B V ??
279	FPClock8 Q V Flat panel clock for 8bpp fb (MHz)
280	FPClock16 Q V Flat panel clock for 16bpp fb (MHz)
281	FPClock24 Q V Flat panel clock for 24bpp fb (MHz)
282	FPClock32 Q V Flat panel clock for 32bpp fb (MHz)
283	FPMVRAM O V Fast page mode VRAM
284	FramebufferWC B V Enable/disable WC for the framebuffer
285	GlideDevice I V Selects which Voodoo board to use
286	HiBitHigh O V High clock bit default to set
287	HiBitLow O V High clock bit default to cleared
288	HWClocks B V Enable/disable HW clocks
289	HWCursor B V Enable/disable HW cursor
290	LateRasPrecharge O V Late RAS pre-charge
291	Legend O V Card is Legend ET4000
292	LCDCenter B V Enable/disable centering for LCD displays
293	Linear B V Enable/disable linear framebuffer
294	MCLK Q V Specify the current MCLK value (MHz)
295	MedDRAM B V Medium speed DRAM
296	MemCfg1 I V ??
297	MemCfg2 I V ??
298	MGASDRAM B V Mga card has SDRAM
299	MMIO B V Enable/disable memory mapped I/O
300	MMIOCache B V Enable/Disable MMIO cache
301	MuxThreshold I V Multiplexing threshold (kHz)
302	NoAccel B V Disable/enable acceleration
303	NoClockChip B V ??
304	NoStretch B V Disable/enable stretching for LCD displays
305	OnAtExit B V Leave video signal on when exiting server
306	OverclockMem B V Enable memory overclocking
307	Overlay A V Enable multi-depth/overlay. An optional
308	string "M,N" may be specified, where
309	M, N are the depths.
310	PanelDisplay B V Force display on LCD
311	PciBurst B V Enable/disable PCI burst mode
312	PciRetry B V Enable/disable PCI retries
313	ProbeClocks B V Force probe for non-programmable clocks
314	ReferenceClock Q V Clock generator reference frequency
315	RGBbits I V Number of significant bits per rgb
316	Rotate S V Rotate the virtual display (CW or CCW)
317	SetLCDClk Q V Set LCD clock (MHz)
318	SetMclk Q V Set Memory Clock (MHz)
319	ShadowFB B V Enable shadow framebuffer layer
320	ShowCache B V Enable viewing of offscreen memory
321	ShowOverscan O V Set the overscan area to a visible colour
322	SlowDRAM O V Slow DRAM
323	SlowEDODRAM O V Slow EDO DRAM
324	STN B V STN screen type (??)
325	SWCursor B V Enable/disable SW cursor
326	SuspendHack B V ??
327	SyncOnGreen B V Enable/disable sync on green
328	TurboQueue B V Enable/disable turbo queue
329	UseFBDev B V Use the fbdev driver interface
330	UseModeLine B V Use Modeline (??)
331	W32Interleave B V ??
332
333	Buffers I Xv Number of buffers
334	Device S Xv Device file name
335	Expose B Xv Disable occlusion clipping (see DESIGN)
336	FramesPerSec I Xv Max. refresh frequency
337
338	XAA options. All are of type "O" and scope "X", and are self-explanatory
339
340	XaaNoColor8x8PatternFillRect
341	XaaNoColor8x8PatternFillTrap
342	XaaNoCPUToScreenColorExpandFill
343	XaaNoDashedBresenhamLine
344	XaaNoDashedTwoPointLine
345	XaaNoScreenToScreenCopy
346	XaaNoImageReadRect
347	XaaNoImageWriteRect
348	XaaNoMono8x8PatternFillRect
349	XaaNoMono8x8PatternFillTrap
350	XaaNoOffscreenPixmaps
351	XaaNoPixmapCache
352	XaaNoScanlineCPUToScreenColorExpandFill
353	XaaNoScanlineImageWriteRect
354	XaaNoScreenToScreenColorExpandFill
355	XaaNoSolidBresenhamLine
356	XaaNoSolidFillRect
357	XaaNoSolidFillTrap
358	XaaNoSolidHorVertLine
359	XaaNoSolidTwoPointLine
360
361
362	Names used in previous versions:
363
364	16Clocks
365	8Clocks
366	ClkDiv2
367	EDO VRAM
368	ExternDisp
369	ExtFramBuf
370	FastVRAM
371	FavorBitBlt
372	InternDisp
373	NoBitBlt
374	NoFontCache
375	NoImageBlt
376	NoMemAccess
377	NoPciDisconnect
378	NoPixmapCache
379	NoProgramClocks
380	NoSplitXfer
381	OverrideBIOS
382	OverrideValidateMode
383	ProgLcdModeRegs
384	ProgLcdModeStretch
385	SlowDRAMrefresh
386	SlowVRAM
387	SwapHiBit
388
389
390	5. Ramdac Names.
391
392	Ramdac names should be consistent between drivers. Case, white space
393	and underscore characters are ignored when comparing ramdac names. All
394	names listed here are in lower case with all white space and underscores
395	removed.
396
397
398	6. Clock Chip Names.
399
400	Clock chip names should be consistent between drivers. Case, white
401	space and underscore characters are ignored when comparing clock chip
402	names. All names listed here are in lower case with all white space
403	and underscores removed.
404
405
406
407
408
409	$XFree86: xc/programs/Xserver/hw/xfree86/Registry,v 1.18 2002/04/06 18:31:09 tsi Exp $