xref: /dragonfly/sys/dev/video/meteor/ioctl_meteor.h (revision 6b5ed54a38712b1725eb2d5c74e794f76780dace)
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: src/sys/dev/bktr/ioctl_meteor.h,v 1.15 2003/12/20 17:12:25 obrien Exp $
32  */
33 
34 /*
35  *        ioctl constants for Matrox Meteor Capture card.
36  */
37 
38 #ifndef   _DEV_BKTR_IOCTL_METEOR_H_
39 #define   _DEV_BKTR_IOCTL_METEOR_H_
40 
41 #ifndef _KERNEL
42 #include <sys/types.h>
43 #endif
44 #include <sys/ioccom.h>
45 
46 /* structure for METEOR[GS]ETGEO - get/set geometry  */
47 struct meteor_geomet {
48           u_short             rows;
49           u_short             columns;
50           u_short             frames;
51           u_long              oformat;
52 } ;
53 
54 /* structure for METEORGCOUNT-get count of frames, fifo errors and dma errors */
55 struct meteor_counts {
56           u_long fifo_errors; /* count of fifo errors since open */
57           u_long dma_errors;  /* count of dma errors since open */
58           u_long frames_captured;       /* count of frames captured since open */
59           u_long even_fields_captured; /* count of even fields captured */
60           u_long odd_fields_captured; /* count of odd fields captured */
61 } ;
62 
63 /* structure for getting and setting direct transfers to vram */
64 struct meteor_video {
65           u_long    addr;     /* Address of location to dma to */
66           u_long    width;    /* Width of memory area */
67           u_long    banksize; /* Size of Vram bank */
68           u_long    ramsize;  /* Size of Vram */
69 };
70 
71 #define METEORCAPTUR _IOW('x', 1, int)                       /* capture a frame */
72 #define METEORSETGEO _IOW('x', 3, struct meteor_geomet)  /* set geometry */
73 #define METEORSTATUS _IOR('x', 5, unsigned short) /* get status */
74 #define METEORSHUE   _IOW('x', 6, signed char)              /* set hue */
75 #define METEORGHUE   _IOR('x', 6, signed char)              /* get hue */
76 #define METEORSFMT   _IOW('x', 7, unsigned long)  /* set format */
77 #define METEORGFMT   _IOR('x', 7, unsigned long)  /* get format */
78 #define METEORSINPUT _IOW('x', 8, unsigned long)  /* set input dev */
79 #define METEORGINPUT _IOR('x', 8, unsigned long)  /* get input dev */
80 #define   METEORSCOUNT _IOW('x',10, struct meteor_counts)
81 #define   METEORGCOUNT _IOR('x',10, struct meteor_counts)
82 #define METEORSFPS   _IOW('x',11, unsigned short) /* set fps */
83 #define METEORGFPS   _IOR('x',11, unsigned short) /* get fps */
84 #define METEORSSIGNAL _IOW('x', 12, unsigned int) /* set signal */
85 #define METEORGSIGNAL _IOR('x', 12, unsigned int) /* get signal */
86 #define   METEORSVIDEO _IOW('x', 13, struct meteor_video)   /* set video */
87 #define   METEORGVIDEO _IOR('x', 13, struct meteor_video)   /* get video */
88 #define   METEORSBRIG  _IOW('x', 14, unsigned char)         /* set brightness */
89 #define METEORGBRIG  _IOR('x', 14, unsigned char) /* get brightness */
90 #define   METEORSCSAT  _IOW('x', 15, unsigned char)         /* set chroma sat */
91 #define METEORGCSAT  _IOR('x', 15, unsigned char) /* get uv saturation */
92 #define   METEORSCONT  _IOW('x', 16, unsigned char)         /* set contrast */
93 #define   METEORGCONT  _IOR('x', 16, unsigned char)         /* get contrast */
94 
95 #define   METEOR_STATUS_ID_MASK         0xf000    /* ID of 7196 */
96 #define   METEOR_STATUS_DIR   0x0800    /* Direction of Expansion port YUV */
97 #define   METEOR_STATUS_OEF   0x0200    /* Field detected: Even/Odd */
98 #define   METEOR_STATUS_SVP   0x0100    /* State of VRAM Port:inactive/active */
99 #define   METEOR_STATUS_STTC  0x0080    /* Time Constant: TV/VCR */
100 #define   METEOR_STATUS_HCLK  0x0040    /* Horiz PLL: locked/unlocked */
101 #define   METEOR_STATUS_FIDT  0x0020    /* Field detect: 50/60hz */
102 #define   METEOR_STATUS_ALTD  0x0002    /* Line alt: no line alt/line alt */
103 #define METEOR_STATUS_CODE    0x0001    /* Colour info: no colour/colour */
104 
105                                         /* METEORCAPTUR capture options */
106 #define METEOR_CAP_SINGLE     0x0001    /* capture one frame */
107 #define METEOR_CAP_CONTINOUS  0x0002    /* continuously capture */
108 #define METEOR_CAP_STOP_CONT  0x0004    /* stop the continuous capture */
109 
110                                         /* METEORCAPFRM capture commands */
111 #define METEOR_CAP_N_FRAMES   0x0001    /* capture N frames */
112 #define METEOR_CAP_STOP_FRAMES          0x0002    /* stop capture N frames */
113 #define   METEOR_HALT_N_FRAMES          0x0003    /* halt of capture N frames */
114 #define METEOR_CONT_N_FRAMES  0x0004    /* continue after above halt */
115 
116                                         /* valid video input formats:  */
117 #define METEOR_FMT_NTSC                 0x00100   /* NTSC --  initialized default */
118 #define METEOR_FMT_PAL                  0x00200   /* PAL */
119 #define METEOR_FMT_SECAM      0x00400   /* SECAM */
120 #define METEOR_FMT_AUTOMODE   0x00800 /* auto-mode */
121 #define METEOR_INPUT_DEV0     0x01000   /* camera input 0 -- default */
122 #define METEOR_INPUT_DEV_RCA  METEOR_INPUT_DEV0
123 #define METEOR_INPUT_DEV1     0x02000   /* camera input 1 */
124 #define METEOR_INPUT_DEV2     0x04000   /* camera input 2 */
125 #define METEOR_INPUT_DEV3     0x08000   /* camera input 3 */
126 #define METEOR_INPUT_DEV_RGB  0x0a000   /* for rgb version of meteor */
127 #define METEOR_INPUT_DEV_SVIDEO         0x06000 /* S-video input port */
128 
129                                         /* valid video output formats:  */
130 #define METEOR_GEO_RGB16      0x0010000 /* packed -- initialized default */
131 #define METEOR_GEO_RGB24      0x0020000 /* RBG 24 bits packed */
132                                                     /* internally stored in 32 bits */
133 #define METEOR_GEO_YUV_PACKED 0x0040000 /* 4-2-2 YUV 16 bits packed */
134 #define METEOR_GEO_YUV_PLANAR 0x0080000 /* 4-2-2 YUV 16 bits planer */
135 #define METEOR_GEO_YUV_PLANER METEOR_GEO_YUV_PLANAR
136 #define METEOR_GEO_UNSIGNED   0x0400000 /* unsigned uv outputs */
137 #define METEOR_GEO_EVEN_ONLY  0x1000000 /* set for even only field capture */
138 #define METEOR_GEO_ODD_ONLY   0x2000000 /* set for odd only field capture */
139 #define METEOR_GEO_FIELD_MASK 0x3000000
140 #define METEOR_GEO_YUV_422    0x4000000 /* 4-2-2 YUV in Y-U-V combined */
141 #define METEOR_GEO_OUTPUT_MASK          0x40f0000
142 #define METEOR_GEO_YUV_12     0x10000000          /* YUV 12 format */
143 #define METEOR_GEO_YUV_9      0x40000000          /* YUV 9 format */
144 
145 #define   METEOR_FIELD_MODE   0x80000000          /* Field cap or Frame cap */
146 
147 #define   METEOR_SIG_MODE_MASK          0xffff0000
148 #define   METEOR_SIG_FRAME    0x00000000          /* signal every frame */
149 #define   METEOR_SIG_FIELD    0x00010000          /* signal every field */
150 
151           /* following structure is used to coordinate the synchronous */
152 
153 struct meteor_mem {
154                     /* kernel write only  */
155           int       frame_size;          /* row*columns*depth */
156           unsigned num_bufs;   /* number of frames in buffer (1-32) */
157                     /* user and kernel change these */
158           int       lowat;               /* kernel starts capture if < this number */
159           int       hiwat;               /* kernel stops capture if > this number.
160                                             hiwat <= numbufs */
161           unsigned active;     /* bit mask of active frame buffers
162                                             kernel sets, user clears */
163           int       num_active_bufs; /* count of active frame buffer
164                                             kernel increments, user decrements */
165 
166                     /* reference to mmapped data */
167           caddr_t   buf;                 /* The real space (virtual addr) */
168 } ;
169 
170 #endif /* !_DEV_BKTR_IOCTL_METEOR_H_ */
171