1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DCAM1394 7D "May 19, 2004"
7 .SH NAME
8 dcam1394 \- 1394-based digital camera (IIDC) driver
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB#include <sys/dcam/dcam1394_io.h>\fR
13 .fi
14
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBdcam1394\fR driver supports devices implementing the \fI1394 Trade
19 Association Digital Camera Specification\fR (also referred to as the IIDC
20 specification). Only a subset of the specification is supported.
21 .SH READING DATA
22 .sp
23 .LP
24 Isochronous data is read from the driver frame-by-frame and is maintained
25 within the driver in a ring buffer.
26 .sp
27 .LP
28 Video frames are read from the isochronous input device using \fBread\fR(2).
29 .sp
30 .LP
31 The \fBdcam1394_frame_t\fR structure describes the frame layout and is defined
32 as follows:
33 .sp
34 .in +2
35 .nf
36 struct {
37 unsigned int vid_mode;
38 unsigned int seq_num;
39 hrtime_t timestamp;
40 unsigned char *buff;
41 };
42 .fi
43 .in -2
44
45 .sp
46 .LP
47 The size to allocate for the structure is determined by the video mode for
48 which the camera is configured. Possible values for the vid_mode field are
49 listed under DCAM1394_PARAM_VID_MODE below.
50 .SH IOCTL REQUESTS
51 .sp
52 .LP
53 The following ioctl requests are supported:
54 .sp
55 .ne 2
56 .na
57 \fBDCAM1394_CMD_CAM_RESET\fR
58 .ad
59 .sp .6
60 .RS 4n
61 Reset the device.
62 .RE
63
64 .sp
65 .ne 2
66 .na
67 \fBDCAM1394_CMD_REG_READ\fR
68 .ad
69 .sp .6
70 .RS 4n
71 Read the indicated dcam/IIDC register. The argument is a pointer to a
72 \fBdcam1394_reg_io_t\fR structure, which is defined as follows:
99 \fBdcam1394_reg_io_t\fR structure (described above).
100 .sp
101 The offs field should be set to the offset of the register from which to read.
102 The register offset values are defined in the \fI1394 Trade Association Digital
103 Camera Specification\fR.
104 .sp
105 The val field should be set to the value to be written to the camera register.
106 .RE
107
108 .sp
109 .ne 2
110 .na
111 \fBDCAM1394_CMD_PARAM_GET\fR
112 .ad
113 .sp .6
114 .RS 4n
115 Gets a list of parameters associated with a camera. The argument is a pointer
116 to a \fBdcam1394_param_list_t\fR structure (described below). The parameter
117 list is accessed through macros defined below.
118 .sp
119 The paramter list only supports Format 1 video formats.
120 .RE
121
122 .sp
123 .ne 2
124 .na
125 \fBDCAM1394_CMD_PARAM_SET\fR
126 .ad
127 .sp .6
128 .RS 4n
129 Sets a list of parameters associated with a camera. The argument is a pointer
130 to a \fBdcam1394_param_list_t structure\fR (described below). The parameter
131 list is accessed through macros defined below.
132 .sp
133 The paramter list only supports Format 1 video formats.
134 .RE
135
136 .sp
137 .ne 2
138 .na
139 \fBDCAM1394_CMD_FRAME_RCV_START\fR
140 .ad
141 .sp .6
142 .RS 4n
143 Start receiving video frames from the camera.
144 .sp
145 The contents of the ring buffer may be accessed by reading the isochronous
146 stream device.
147 .RE
148
149 .sp
150 .ne 2
151 .na
152 \fBDCAM1394_CMD_FRAME_RCV_STOP\fR
153 .ad
160 .ne 2
161 .na
162 \fBDCAM1394_CMD_RING_BUFF_FLUSH\fR
163 .ad
164 .sp .6
165 .RS 4n
166 Flush the frames in the ring buffer.
167 .RE
168
169 .sp
170 .ne 2
171 .na
172 \fBDCAM1394_CMD_FRAME_SEQ_NUM_COUNT_RESET\fR
173 .ad
174 .sp .6
175 .RS 4n
176 Reset frame sequence number.
177 .RE
178
179 .SH PARAMETER LIST ACCESS
180 .sp
181 .LP
182 The parameter list is initialized and access through macros. The data type for
183 the parameter list is \fBdcam1394_param_list_t\fR.
184 .sp
185 .LP
186 The following macros are used to access the parameter list:
187 .sp
188 .ne 2
189 .na
190 \fBPARAM_LIST_INIT(param_list)\fR
191 .ad
192 .sp .6
193 .RS 4n
194 Initialize the parameter list.
195 .RE
196
197 .sp
198 .ne 2
199 .na
200 \fBPARAM_LIST_ADD(param_list, param, subparam)\fR
201 .ad
232 .sp .6
233 .RS 4n
234 Value of a specified parameter.
235 .RE
236
237 .sp
238 .ne 2
239 .na
240 \fBPARAM_ERR(param_list, param, subparam)\fR
241 .ad
242 .sp .6
243 .RS 4n
244 Indicates if a specific parameter is successfully set.
245 .RE
246
247 .sp
248 .LP
249 When no subparam value is required, the value DCAM1394_SUBPARAM_NONE may be
250 used.
251 .SH PARAMETERS
252 .sp
253 .LP
254 The following parameters may appear in the list:
255 .sp
256 .ne 2
257 .na
258 \fBDCAM1394_PARAM_CAP_POWER_CTRL\fR
259 .ad
260 .sp .6
261 .RS 4n
262 Queries if the camera can be turned off and on through software. The subparam
263 value is ignored.
264 .RE
265
266 .sp
267 .ne 2
268 .na
269 \fBDCAM1394_PARAM_POWER\fR
270 .ad
271 .sp .6
272 .RS 4n
273 Controls or queries if the camera is powered up. Verify this feature using
879 .sp .6
880 .RS 4n
881 Query or control a camera feature. This feature queries or controls the pan of
882 the camera. The subparams supported by this feature are described under
883 DCAM1394_PARAM_BRIGHTNESS.
884 .RE
885
886 .sp
887 .ne 2
888 .na
889 \fBDCAM1394_PARAM_TILT\fR
890 .ad
891 .sp .6
892 .RS 4n
893 Query or control a camera feature. This feature queries or controls the tilt of
894 the camera.The subparams supported by this feature are described under
895 DCAM1394_PARAM_BRIGHTNESS.
896 .RE
897
898 .SH DEVICE SPECIAL FILES
899 .sp
900 .ne 2
901 .na
902 \fB\fB/dev/dcam\fIN\fR\fR\fR
903 .ad
904 .RS 17n
905 Device node for isochronous input from camera.
906 .RE
907
908 .sp
909 .ne 2
910 .na
911 \fB\fB/dev/dcamctl\fIN\fR\fR\fR
912 .ad
913 .RS 17n
914 Device node for camera control.
915 .RE
916
917 .SH FILES
918 .sp
919 .ne 2
920 .na
921 \fB\fBkernel/drv/sparcv9/dcam1394\fR\fR
922 .ad
923 .sp .6
924 .RS 4n
925 64-bit ELF kernel module.
926 .RE
927
928 .sp
929 .ne 2
930 .na
931 \fB\fBkernel/drv/dcam1394\fR\fR
932 .ad
933 .sp .6
934 .RS 4n
935 32-bit ELF kernel module.
936 .RE
937
938 .SH ATTRIBUTES
939 .sp
940 .LP
941 See \fBattributes\fR(5) for descriptions of the following attributes:
942 .sp
943
944 .sp
945 .TS
946 box;
947 c | c
948 l | l .
949 ATTRIBUTE TYPE ATTRIBUTE VALUE
950 _
951 Interface Stability Evolving
952 .TE
953
954 .SH SEE ALSO
955 .sp
956 .LP
957 \fBattributes\fR(5), \fBhci1394\fR(7D)
958 .sp
959 .LP
960 \fI1394 Trade Association Digital Camera Specification, Version 1.04 - 1996\fR
961 .sp
962 .LP
963 \fIIEEE Std 1394-2000 Standard for a High Performance Serial Bus - 2000\fR
|
1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DCAM1394 7D "Jan 10, 2020"
7 .SH NAME
8 dcam1394 \- 1394-based digital camera (IIDC) driver
9 .SH SYNOPSIS
10 .nf
11 \fB#include <sys/dcam/dcam1394_io.h>\fR
12 .fi
13
14 .SH DESCRIPTION
15 The \fBdcam1394\fR driver supports devices implementing the \fI1394 Trade
16 Association Digital Camera Specification\fR (also referred to as the IIDC
17 specification). Only a subset of the specification is supported.
18 .SH READING DATA
19 Isochronous data is read from the driver frame-by-frame and is maintained
20 within the driver in a ring buffer.
21 .sp
22 .LP
23 Video frames are read from the isochronous input device using \fBread\fR(2).
24 .sp
25 .LP
26 The \fBdcam1394_frame_t\fR structure describes the frame layout and is defined
27 as follows:
28 .sp
29 .in +2
30 .nf
31 struct {
32 unsigned int vid_mode;
33 unsigned int seq_num;
34 hrtime_t timestamp;
35 unsigned char *buff;
36 };
37 .fi
38 .in -2
39
40 .sp
41 .LP
42 The size to allocate for the structure is determined by the video mode for
43 which the camera is configured. Possible values for the vid_mode field are
44 listed under DCAM1394_PARAM_VID_MODE below.
45 .SH IOCTL REQUESTS
46 The following ioctl requests are supported:
47 .sp
48 .ne 2
49 .na
50 \fBDCAM1394_CMD_CAM_RESET\fR
51 .ad
52 .sp .6
53 .RS 4n
54 Reset the device.
55 .RE
56
57 .sp
58 .ne 2
59 .na
60 \fBDCAM1394_CMD_REG_READ\fR
61 .ad
62 .sp .6
63 .RS 4n
64 Read the indicated dcam/IIDC register. The argument is a pointer to a
65 \fBdcam1394_reg_io_t\fR structure, which is defined as follows:
92 \fBdcam1394_reg_io_t\fR structure (described above).
93 .sp
94 The offs field should be set to the offset of the register from which to read.
95 The register offset values are defined in the \fI1394 Trade Association Digital
96 Camera Specification\fR.
97 .sp
98 The val field should be set to the value to be written to the camera register.
99 .RE
100
101 .sp
102 .ne 2
103 .na
104 \fBDCAM1394_CMD_PARAM_GET\fR
105 .ad
106 .sp .6
107 .RS 4n
108 Gets a list of parameters associated with a camera. The argument is a pointer
109 to a \fBdcam1394_param_list_t\fR structure (described below). The parameter
110 list is accessed through macros defined below.
111 .sp
112 The parameter list only supports Format 1 video formats.
113 .RE
114
115 .sp
116 .ne 2
117 .na
118 \fBDCAM1394_CMD_PARAM_SET\fR
119 .ad
120 .sp .6
121 .RS 4n
122 Sets a list of parameters associated with a camera. The argument is a pointer
123 to a \fBdcam1394_param_list_t structure\fR (described below). The parameter
124 list is accessed through macros defined below.
125 .sp
126 The parameter list only supports Format 1 video formats.
127 .RE
128
129 .sp
130 .ne 2
131 .na
132 \fBDCAM1394_CMD_FRAME_RCV_START\fR
133 .ad
134 .sp .6
135 .RS 4n
136 Start receiving video frames from the camera.
137 .sp
138 The contents of the ring buffer may be accessed by reading the isochronous
139 stream device.
140 .RE
141
142 .sp
143 .ne 2
144 .na
145 \fBDCAM1394_CMD_FRAME_RCV_STOP\fR
146 .ad
153 .ne 2
154 .na
155 \fBDCAM1394_CMD_RING_BUFF_FLUSH\fR
156 .ad
157 .sp .6
158 .RS 4n
159 Flush the frames in the ring buffer.
160 .RE
161
162 .sp
163 .ne 2
164 .na
165 \fBDCAM1394_CMD_FRAME_SEQ_NUM_COUNT_RESET\fR
166 .ad
167 .sp .6
168 .RS 4n
169 Reset frame sequence number.
170 .RE
171
172 .SH PARAMETER LIST ACCESS
173 The parameter list is initialized and access through macros. The data type for
174 the parameter list is \fBdcam1394_param_list_t\fR.
175 .sp
176 .LP
177 The following macros are used to access the parameter list:
178 .sp
179 .ne 2
180 .na
181 \fBPARAM_LIST_INIT(param_list)\fR
182 .ad
183 .sp .6
184 .RS 4n
185 Initialize the parameter list.
186 .RE
187
188 .sp
189 .ne 2
190 .na
191 \fBPARAM_LIST_ADD(param_list, param, subparam)\fR
192 .ad
223 .sp .6
224 .RS 4n
225 Value of a specified parameter.
226 .RE
227
228 .sp
229 .ne 2
230 .na
231 \fBPARAM_ERR(param_list, param, subparam)\fR
232 .ad
233 .sp .6
234 .RS 4n
235 Indicates if a specific parameter is successfully set.
236 .RE
237
238 .sp
239 .LP
240 When no subparam value is required, the value DCAM1394_SUBPARAM_NONE may be
241 used.
242 .SH PARAMETERS
243 The following parameters may appear in the list:
244 .sp
245 .ne 2
246 .na
247 \fBDCAM1394_PARAM_CAP_POWER_CTRL\fR
248 .ad
249 .sp .6
250 .RS 4n
251 Queries if the camera can be turned off and on through software. The subparam
252 value is ignored.
253 .RE
254
255 .sp
256 .ne 2
257 .na
258 \fBDCAM1394_PARAM_POWER\fR
259 .ad
260 .sp .6
261 .RS 4n
262 Controls or queries if the camera is powered up. Verify this feature using
868 .sp .6
869 .RS 4n
870 Query or control a camera feature. This feature queries or controls the pan of
871 the camera. The subparams supported by this feature are described under
872 DCAM1394_PARAM_BRIGHTNESS.
873 .RE
874
875 .sp
876 .ne 2
877 .na
878 \fBDCAM1394_PARAM_TILT\fR
879 .ad
880 .sp .6
881 .RS 4n
882 Query or control a camera feature. This feature queries or controls the tilt of
883 the camera.The subparams supported by this feature are described under
884 DCAM1394_PARAM_BRIGHTNESS.
885 .RE
886
887 .SH DEVICE SPECIAL FILES
888 .ne 2
889 .na
890 \fB/dev/dcam\fIN\fR\fR
891 .ad
892 .RS 17n
893 Device node for isochronous input from camera.
894 .RE
895
896 .sp
897 .ne 2
898 .na
899 \fB/dev/dcamctl\fIN\fR\fR
900 .ad
901 .RS 17n
902 Device node for camera control.
903 .RE
904
905 .SH FILES
906 .ne 2
907 .na
908 \fB/kernel/drv/sparcv9/dcam1394\fR
909 .ad
910 .sp .6
911 .RS 4n
912 Device driver (SPARC)
913 .RE
914
915 .sp
916 .ne 2
917 .na
918 \fB/kernel/drv/amd64/dcam1394\fR
919 .ad
920 .sp .6
921 .RS 4n
922 Device driver (x86)
923 .RE
924
925 .SH ATTRIBUTES
926 See \fBattributes\fR(5) for descriptions of the following attributes:
927 .sp
928
929 .sp
930 .TS
931 box;
932 c | c
933 l | l .
934 ATTRIBUTE TYPE ATTRIBUTE VALUE
935 _
936 Interface Stability Evolving
937 .TE
938
939 .SH SEE ALSO
940 \fBattributes\fR(5), \fBhci1394\fR(7D)
941 .sp
942 .LP
943 \fI1394 Trade Association Digital Camera Specification, Version 1.04 - 1996\fR
944 .sp
945 .LP
946 \fIIEEE Std 1394-2000 Standard for a High Performance Serial Bus - 2000\fR
|