2 .\" Copyright (c) 1998 Kenneth D. Merry.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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. The name of the author may not be used to endorse or promote products
14 .\" derived from this software without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nm cam_open_spec_device ,
38 .Nm cam_close_device ,
39 .Nm cam_close_spec_device ,
53 .Ft struct cam_device *
55 .Fa "const char *path"
58 .Ft struct cam_device *
59 .Fo cam_open_spec_device
60 .Fa "const char *dev_name"
63 .Fa "struct cam_device *device"
65 .Ft struct cam_device *
67 .Fa "path_id_t path_id"
68 .Fa "target_id_t target_id"
69 .Fa "lun_id_t target_lun"
71 .Fa "struct cam_device *device"
73 .Ft struct cam_device *
75 .Fa "const char *path"
77 .Fa "struct cam_device *device"
81 .Fa "struct cam_device *dev"
84 .Fo cam_close_spec_device
85 .Fa "struct cam_device *dev"
89 .Fa "struct cam_device *dev"
93 .Fa "struct cam_device *device"
102 .Fa "struct cam_device *dev"
106 .Ft struct cam_device *
108 .Fa "struct cam_device *device"
112 .Fa "struct cam_device *src"
113 .Fa "struct cam_device *dst"
117 .Fa "const char *path"
123 The CAM library consists of a number of functions designed to aid in
124 programming with the CAM subsystem.
125 This man page covers the basic set of
127 More functions are documented in the man pages listed
130 Many of the CAM library functions use the
135 char device_path[MAXPATHLEN+1];/*
137 * device given by the
141 * name and unit number
144 char given_dev_name[DEV_IDLEN+1];/*
145 * Device name given by
148 uint32_t given_unit_number; /*
149 * Unit number given by
152 char device_name[DEV_IDLEN+1];/*
153 * Name of the device,
156 uint32_t dev_unit_num; /* Unit number of the passthrough
157 * device associated with this
161 char sim_name[SIM_IDLEN+1];/*
162 * Controller name, e.g.'ahc'
164 uint32_t sim_unit_number; /* Controller unit number */
165 uint32_t bus_id; /* Controller bus number */
166 lun_id_t target_lun; /* Logical Unit Number */
167 target_id_t target_id; /* Target ID */
168 path_id_t path_id; /* System SCSI bus number */
169 uint16_t pd_type; /* type of peripheral device */
170 struct scsi_inquiry_data inq_data; /* SCSI Inquiry data */
171 uint8_t serial_num[252]; /* device serial number */
172 uint8_t serial_num_len; /* length of the serial number */
173 uint8_t sync_period; /* Negotiated sync period */
174 uint8_t sync_offset; /* Negotiated sync offset */
175 uint8_t bus_width; /* Negotiated bus width */
176 int fd; /* file descriptor for device */
181 takes as arguments a string describing the device it is to open, and
183 suitable for passing to
185 The "path" passed in may actually be most any type of string that contains
186 a device name and unit number to be opened.
187 The string will be parsed by
189 into a device name and unit number.
190 Once the device name and unit number
191 are determined, a lookup is performed to determine the passthrough device
192 that corresponds to the given device.
194 .Fn cam_open_spec_device
197 device that corresponds to the device name and unit number passed in.
200 should be flags suitable for passing to
204 argument is optional.
205 The user may supply pre-allocated space for the
212 .Fn cam_open_spec_device
213 will allocate space for the
220 .Fn cam_open_spec_device ,
221 except that it takes a
223 bus, target and logical unit instead of a device name and unit number as
227 argument is the CAM equivalent of a
230 It represents the logical bus number in the system.
233 should be flags suitable for passing to
236 .Fn cam_open_spec_device ,
239 argument is optional.
242 takes as an argument the
247 No translation or lookup is performed, so the path passed
248 in must be that of a CAM
253 should be flags suitable for passing to
258 .Fn cam_open_spec_device
261 should be NULL if the user wants the CAM library to allocate space for the
267 structure allocated by one of the above open() calls, and closes the file
268 descriptor to the passthrough device.
269 This routine should not be called if
270 the user allocated space for the
273 Instead, the user should call
274 .Fn cam_close_spec_device .
276 .Fn cam_close_spec_device
277 merely closes the file descriptor opened in one of the open() routines
279 This function should be called when the
281 structure was allocated by the caller, rather than the CAM library.
287 and sets fields in the CCB header using values from the
301 frees CCBs allocated by
307 structure, and a string with length
309 It creates a colon-terminated printing prefix string similar to the ones
311 e.g.: "(cd0:ahc1:0:4:0): ".
319 character will be the terminating
323 operates in a fashion similar to
325 It allocates space for a
327 structure and copies the contents of the passed-in
329 structure to the newly allocated structure.
340 argument containing a string with a device name followed by a unit number.
341 It then breaks the string down into a device name and unit number, and
348 can handle strings of the following forms, at least:
350 .Bl -tag -width 1234 -compact
357 is provided as a convenience function for applications that need to provide
358 functionality similar to
359 .Fn cam_open_device .
361 .Fn cam_open_device ,
362 .Fn cam_open_spec_device ,
366 return a pointer to a
368 structure, or NULL if there was an error.
371 returns an allocated and partially initialized CCB, or NULL if allocation
375 returns a value of -1 if an error occurred, and
377 is set to indicate the error.
380 returns a filled printing prefix string as a convenience.
384 .Fn cam_path_string .
387 returns a copy of the
389 passed in, or NULL if an error occurred.
392 returns 0 for success, and -1 to indicate failure.
394 If an error is returned from one of the base CAM library functions
395 described here, the reason for the error is generally printed in the global
406 The CAM library first appeared in
409 .An Kenneth Merry Aq ken@FreeBSD.org
412 does not check to see if the
414 passed in is a symlink to something.
415 It also does not check to see if the
417 passed in is an actual
420 The former would be rather easy to implement, but the latter would
421 require a definitive way to identify a device node as a
425 Some of the functions are possibly mis-named or poorly named.