xref: /freebsd-11-stable/sys/dev/bktr/ioctl_meteor.h (revision 4ab2e064d7950be84256d671a7ae93f87cc6aa36)
1 /*-
2  * Copyright (c) 1995 Mark Tinguely and Jim Lowe
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by Mark Tinguely and Jim Lowe
16  * 4. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
23  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 /*
34  *	ioctl constants for Matrox Meteor Capture card.
35  */
36 
37 #ifndef	_DEV_BKTR_IOCTL_METEOR_H_
38 #define	_DEV_BKTR_IOCTL_METEOR_H_
39 
40 #ifndef _KERNEL
41 #include <sys/types.h>
42 #endif
43 #include <sys/ioccom.h>
44 
45 struct meteor_capframe {
46 	short	command;	/* see below for valid METEORCAPFRM commands */
47 	short	lowat;		/* start transfer if < this number */
48 	short	hiwat;		/* stop transfer if > this number */
49 } ;
50 
51 /* structure for METEOR[GS]ETGEO - get/set geometry  */
52 struct meteor_geomet {
53 	unsigned short		rows;
54 	unsigned short		columns;
55 	unsigned short		frames;
56 	unsigned long		oformat;
57 } ;
58 
59 /* structure for METEORGCOUNT-get count of frames, fifo errors and dma errors */
60 struct meteor_counts {
61 	unsigned long fifo_errors;	/* count of fifo errors since open */
62 	unsigned long dma_errors;	/* count of dma errors since open */
63 	unsigned long frames_captured;	/* count of frames captured since open */
64 	unsigned long even_fields_captured; /* count of even fields captured */
65 	unsigned long odd_fields_captured; /* count of odd fields captured */
66 } ;
67 
68 /* structure for getting and setting direct transfers to vram */
69 struct meteor_video {
70 	unsigned long	addr;		/* Address of location to dma to */
71 	unsigned long	width;		/* Width of memory area */
72 	unsigned long	banksize;	/* Size of Vram bank */
73 	unsigned long	ramsize;	/* Size of Vram */
74 };
75 
76 #define METEORCAPTUR _IOW('x', 1, int)			 /* capture a frame */
77 #define METEORCAPFRM _IOW('x', 2, struct meteor_capframe)  /* sync capture */
78 #define METEORSETGEO _IOW('x', 3, struct meteor_geomet)  /* set geometry */
79 #define METEORGETGEO _IOR('x', 4, struct meteor_geomet)  /* get geometry */
80 #define METEORSTATUS _IOR('x', 5, unsigned short)	/* get status */
81 #define METEORSHUE   _IOW('x', 6, signed char)		/* set hue */
82 #define METEORGHUE   _IOR('x', 6, signed char)		/* get hue */
83 #define METEORSFMT   _IOW('x', 7, unsigned long)	/* set format */
84 #define METEORGFMT   _IOR('x', 7, unsigned long)	/* get format */
85 #define METEORSINPUT _IOW('x', 8, unsigned long)	/* set input dev */
86 #define METEORGINPUT _IOR('x', 8, unsigned long)	/* get input dev */
87 #define	METEORSCHCV  _IOW('x', 9, unsigned char)	/* set uv gain */
88 #define	METEORGCHCV  _IOR('x', 9, unsigned char)	/* get uv gain */
89 #define	METEORSCOUNT _IOW('x',10, struct meteor_counts)
90 #define	METEORGCOUNT _IOR('x',10, struct meteor_counts)
91 #define METEORSFPS   _IOW('x',11, unsigned short)	/* set fps */
92 #define METEORGFPS   _IOR('x',11, unsigned short)	/* get fps */
93 #define METEORSSIGNAL _IOW('x', 12, unsigned int)	/* set signal */
94 #define METEORGSIGNAL _IOR('x', 12, unsigned int)	/* get signal */
95 #define	METEORSVIDEO _IOW('x', 13, struct meteor_video)	/* set video */
96 #define	METEORGVIDEO _IOR('x', 13, struct meteor_video)	/* get video */
97 #define	METEORSBRIG  _IOW('x', 14, unsigned char)	/* set brightness */
98 #define METEORGBRIG  _IOR('x', 14, unsigned char)	/* get brightness */
99 #define	METEORSCSAT  _IOW('x', 15, unsigned char)	/* set chroma sat */
100 #define METEORGCSAT  _IOR('x', 15, unsigned char)	/* get uv saturation */
101 #define	METEORSCONT  _IOW('x', 16, unsigned char)	/* set contrast */
102 #define	METEORGCONT  _IOR('x', 16, unsigned char)	/* get contrast */
103 #define METEORSBT254 _IOW('x', 17, unsigned short)	/* set Bt254 reg */
104 #define METEORGBT254 _IOR('x', 17, unsigned short)	/* get Bt254 reg */
105 #define METEORSHWS   _IOW('x', 18, unsigned char)	/* set hor start reg */
106 #define METEORGHWS   _IOR('x', 18, unsigned char)	/* get hor start reg */
107 #define METEORSVWS   _IOW('x', 19, unsigned char)	/* set vert start reg */
108 #define METEORGVWS   _IOR('x', 19, unsigned char)	/* get vert start reg */
109 #define	METEORSTS    _IOW('x', 20, unsigned char)	/* set time stamp */
110 #define	METEORGTS    _IOR('x', 20, unsigned char)	/* get time stamp */
111 
112 #define	METEOR_STATUS_ID_MASK	0xf000	/* ID of 7196 */
113 #define	METEOR_STATUS_DIR	0x0800	/* Direction of Expansion port YUV */
114 #define	METEOR_STATUS_OEF	0x0200	/* Field detected: Even/Odd */
115 #define	METEOR_STATUS_SVP	0x0100	/* State of VRAM Port:inactive/active */
116 #define	METEOR_STATUS_STTC	0x0080	/* Time Constant: TV/VCR */
117 #define	METEOR_STATUS_HCLK	0x0040	/* Horiz PLL: locked/unlocked */
118 #define	METEOR_STATUS_FIDT	0x0020	/* Field detect: 50/60hz */
119 #define	METEOR_STATUS_ALTD	0x0002	/* Line alt: no line alt/line alt */
120 #define METEOR_STATUS_CODE	0x0001	/* Colour info: no colour/colour */
121 
122 				/* METEORCAPTUR capture options */
123 #define METEOR_CAP_SINGLE	0x0001	/* capture one frame */
124 #define METEOR_CAP_CONTINOUS	0x0002	/* continuously capture */
125 #define METEOR_CAP_STOP_CONT	0x0004	/* stop the continuous capture */
126 
127 				/* METEORCAPFRM capture commands */
128 #define METEOR_CAP_N_FRAMES	0x0001	/* capture N frames */
129 #define METEOR_CAP_STOP_FRAMES	0x0002	/* stop capture N frames */
130 #define	METEOR_HALT_N_FRAMES	0x0003	/* halt of capture N frames */
131 #define METEOR_CONT_N_FRAMES	0x0004	/* continue after above halt */
132 
133 				/* valid video input formats:  */
134 #define METEOR_FMT_NTSC		0x00100	/* NTSC --  initialized default */
135 #define METEOR_FMT_PAL		0x00200	/* PAL */
136 #define METEOR_FMT_SECAM	0x00400	/* SECAM */
137 #define METEOR_FMT_AUTOMODE	0x00800 /* auto-mode */
138 #define METEOR_INPUT_DEV0	0x01000	/* camera input 0 -- default */
139 #define METEOR_INPUT_DEV_RCA	METEOR_INPUT_DEV0
140 #define METEOR_INPUT_DEV1	0x02000	/* camera input 1 */
141 #define METEOR_INPUT_DEV2	0x04000	/* camera input 2 */
142 #define METEOR_INPUT_DEV3	0x08000	/* camera input 3 */
143 #define METEOR_INPUT_DEV_RGB	0x0a000	/* for rgb version of meteor */
144 #define METEOR_INPUT_DEV_SVIDEO	0x06000 /* S-video input port */
145 
146 				/* valid video output formats:  */
147 #define METEOR_GEO_RGB16	0x0010000 /* packed -- initialized default */
148 #define METEOR_GEO_RGB24	0x0020000 /* RBG 24 bits packed */
149 					  /* internally stored in 32 bits */
150 #define METEOR_GEO_YUV_PACKED	0x0040000 /* 4-2-2 YUV 16 bits packed */
151 #define METEOR_GEO_YUV_PLANAR	0x0080000 /* 4-2-2 YUV 16 bits planer */
152 #define METEOR_GEO_YUV_PLANER	METEOR_GEO_YUV_PLANAR
153 #define METEOR_GEO_UNSIGNED	0x0400000 /* unsigned uv outputs */
154 #define METEOR_GEO_EVEN_ONLY	0x1000000 /* set for even only field capture */
155 #define METEOR_GEO_ODD_ONLY	0x2000000 /* set for odd only field capture */
156 #define METEOR_GEO_FIELD_MASK	0x3000000
157 #define METEOR_GEO_YUV_422	0x4000000 /* 4-2-2 YUV in Y-U-V combined */
158 #define METEOR_GEO_OUTPUT_MASK	0x40f0000
159 #define METEOR_GEO_YUV_12	0x10000000	/* YUV 12 format */
160 #define METEOR_GEO_YUV_9	0x40000000	/* YUV 9 format */
161 
162 #define	METEOR_FIELD_MODE	0x80000000	/* Field cap or Frame cap */
163 
164 #define	METEOR_SIG_MODE_MASK	0xffff0000
165 #define	METEOR_SIG_FRAME	0x00000000	/* signal every frame */
166 #define	METEOR_SIG_FIELD	0x00010000	/* signal every field */
167 
168 	/* following structure is used to coordinate the synchronous */
169 
170 struct meteor_mem {
171 		/* kernel write only  */
172 	int	frame_size;	 /* row*columns*depth */
173 	unsigned num_bufs;	 /* number of frames in buffer (1-32) */
174 		/* user and kernel change these */
175 	int	lowat;		 /* kernel starts capture if < this number */
176 	int	hiwat;		 /* kernel stops capture if > this number.
177 				    hiwat <= numbufs */
178 	unsigned active;	 /* bit mask of active frame buffers
179 				    kernel sets, user clears */
180 	int	num_active_bufs; /* count of active frame buffer
181 				    kernel increments, user decrements */
182 
183 		/* reference to mmapped data */
184 	caddr_t	buf;		 /* The real space (virtual addr) */
185 } ;
186 
187 #endif /* !_DEV_BKTR_IOCTL_METEOR_H_ */
188