lib/libcam/cam.3

   1 .\"
   2 .\" Copyright (c) 1998 Kenneth D. Merry.
   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. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd March 11, 2017
  31 .Dt CAM 3
  32 .Os
  33 .Sh NAME
  34 .Nm cam_open_device ,
  35 .Nm cam_open_spec_device ,
  36 .Nm cam_open_btl ,
  37 .Nm cam_open_pass ,
  38 .Nm cam_close_device ,
  39 .Nm cam_close_spec_device ,
  40 .Nm cam_getccb ,
  41 .Nm cam_send_ccb ,
  42 .Nm cam_freeccb ,
  43 .Nm cam_path_string ,
  44 .Nm cam_device_dup ,
  45 .Nm cam_device_copy ,
  46 .Nm cam_get_device
  47 .Nd CAM user library
  48 .Sh LIBRARY
  49 .Lb libcam
  50 .Sh SYNOPSIS
  51 .In stdio.h
  52 .In camlib.h
  53 .Ft struct cam_device *
  54 .Fo cam_open_device
  55 .Fa "const char *path"
  56 .Fa "int flags"
  57 .Fc
  58 .Ft struct cam_device *
  59 .Fo cam_open_spec_device
  60 .Fa "const char *dev_name"
  61 .Fa "int unit"
  62 .Fa "int flags"
  63 .Fa "struct cam_device *device"
  64 .Fc
  65 .Ft struct cam_device *
  66 .Fo cam_open_btl
  67 .Fa "path_id_t path_id"
  68 .Fa "target_id_t target_id"
  69 .Fa "lun_id_t target_lun"
  70 .Fa "int flags"
  71 .Fa "struct cam_device *device"
  72 .Fc
  73 .Ft struct cam_device *
  74 .Fo cam_open_pass
  75 .Fa "const char *path"
  76 .Fa "int flags"
  77 .Fa "struct cam_device *device"
  78 .Fc
  79 .Ft void
  80 .Fo cam_close_device
  81 .Fa "struct cam_device *dev"
  82 .Fc
  83 .Ft void
  84 .Fo cam_close_spec_device
  85 .Fa "struct cam_device *dev"
  86 .Fc
  87 .Ft union ccb *
  88 .Fo cam_getccb
  89 .Fa "struct cam_device *dev"
  90 .Fc
  91 .Ft int
  92 .Fo cam_send_ccb
  93 .Fa "struct cam_device *device"
  94 .Fa "union ccb *ccb"
  95 .Fc
  96 .Ft void
  97 .Fo cam_freeccb
  98 .Fa "union ccb *ccb"
  99 .Fc
 100 .Ft char *
 101 .Fo cam_path_string
 102 .Fa "struct cam_device *dev"
 103 .Fa "char *str"
 104 .Fa "int len"
 105 .Fc
 106 .Ft struct cam_device *
 107 .Fo cam_device_dup
 108 .Fa "struct cam_device *device"
 109 .Fc
 110 .Ft void
 111 .Fo cam_device_copy
 112 .Fa "struct cam_device *src"
 113 .Fa "struct cam_device *dst"
 114 .Fc
 115 .Ft int
 116 .Fo cam_get_device
 117 .Fa "const char *path"
 118 .Fa "char *dev_name"
 119 .Fa "int devnamelen"
 120 .Fa "int *unit"
 121 .Fc
 122 .Sh DESCRIPTION
 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
 126 library functions.
 127 More functions are documented in the man pages listed
 128 below.
 129 .Pp
 130 Many of the CAM library functions use the
 131 .Va cam_device
 132 structure:
 133 .Bd -literal
 134 struct cam_device {
 135         char            device_path[MAXPATHLEN+1];/*
 136                                                    * Pathname of the
 137                                                    * device given by the
 138                                                    * user. This may be
 139                                                    * null if the user
 140                                                    * states the device
 141                                                    * name and unit number
 142                                                    * separately.
 143                                                    */
 144         char            given_dev_name[DEV_IDLEN+1];/*
 145                                                      * Device name given by
 146                                                      * the user.
 147                                                      */
 148         uint32_t        given_unit_number;          /*
 149                                                      * Unit number given by
 150                                                      * the user.
 151                                                      */
 152         char            device_name[DEV_IDLEN+1];/*
 153                                                   * Name of the device,
 154                                                   * e.g., 'pass'
 155                                                   */
 156         uint32_t        dev_unit_num;   /* Unit number of the passthrough
 157                                          * device associated with this
 158                                          * particular device.
 159                                          */
 160
 161         char            sim_name[SIM_IDLEN+1];/*
 162                                                * Controller name, e.g., 'ahc'
 163                                                */
 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 */
 177 };
 178 .Ed
 179 .Pp
 180 .Fn cam_open_device
 181 takes as arguments a string describing the device it is to open, and
 182 .Ar flags
 183 suitable for passing to
 184 .Xr open 2 .
 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
 188 .Fn cam_get_device
 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.
 193 .Pp
 194 .Fn cam_open_spec_device
 195 opens the
 196 .Xr pass 4
 197 device that corresponds to the device name and unit number passed in.
 198 The
 199 .Ar flags
 200 should be flags suitable for passing to
 201 .Xr open 2 .
 202 The
 203 .Ar device
 204 argument is optional.
 205 The user may supply pre-allocated space for the
 206 .Va cam_device
 207 structure.
 208 If the
 209 .Ar device
 210 argument is
 211 .Dv NULL ,
 212 .Fn cam_open_spec_device
 213 will allocate space for the
 214 .Va cam_device
 215 structure using
 216 .Xr malloc 3 .
 217 .Pp
 218 .Fn cam_open_btl
 219 is similar to
 220 .Fn cam_open_spec_device ,
 221 except that it takes a
 222 .Tn SCSI
 223 bus, target and logical unit instead of a device name and unit number as
 224 arguments.
 225 The
 226 .Va path_id
 227 argument is the CAM equivalent of a
 228 .Tn SCSI
 229 bus number.
 230 It represents the logical bus number in the system.
 231 The
 232 .Ar flags
 233 should be flags suitable for passing to
 234 .Xr open 2 .
 235 As with
 236 .Fn cam_open_spec_device ,
 237 the
 238 .Fa device
 239 argument is optional.
 240 .Pp
 241 .Fn cam_open_pass
 242 takes as an argument the
 243 .Fa path
 244 of a
 245 .Xr pass 4
 246 device to open.
 247 No translation or lookup is performed, so the path passed
 248 in must be that of a CAM
 249 .Xr pass 4
 250 device.
 251 The
 252 .Fa flags
 253 should be flags suitable for passing to
 254 .Xr open 2 .
 255 The
 256 .Fa device
 257 argument, as with
 258 .Fn cam_open_spec_device
 259 and
 260 .Fn cam_open_btl ,
 261 should be
 262 .Dv NULL
 263 if the user wants the CAM library to allocate space for the
 264 .Va cam_device
 265 structure.
 266 .Fn cam_close_device
 267 frees the
 268 .Va cam_device
 269 structure allocated by one of the above open() calls, and closes the file
 270 descriptor to the passthrough device.
 271 This routine should not be called if
 272 the user allocated space for the
 273 .Va cam_device
 274 structure.
 275 Instead, the user should call
 276 .Fn cam_close_spec_device .
 277 .Pp
 278 .Fn cam_close_spec_device
 279 merely closes the file descriptor opened in one of the open() routines
 280 described above.
 281 This function should be called when the
 282 .Va cam_device
 283 structure was allocated by the caller, rather than the CAM library.
 284 .Pp
 285 .Fn cam_getccb
 286 allocates a CCB
 287 using
 288 .Xr malloc 3
 289 and sets fields in the CCB header using values from the
 290 .Va cam_device
 291 structure.
 292 .Pp
 293 .Fn cam_send_ccb
 294 sends the given
 295 .Va ccb
 296 to the
 297 .Fa device
 298 described in the
 299 .Va cam_device
 300 structure.
 301 .Pp
 302 .Fn cam_freeccb
 303 frees CCBs allocated by
 304 .Fn cam_getccb .
 305 If
 306 .Va ccb
 307 is
 308 .Dv NULL ,
 309 no action is taken.
 310 .Pp
 311 .Fn cam_path_string
 312 takes as arguments a
 313 .Va cam_device
 314 structure, and a string with length
 315 .Fa len .
 316 It creates a colon-terminated printing prefix string similar to the ones
 317 used by the kernel.
 318 e.g.: "(cd0:ahc1:0:4:0): ".
 319 .Fn cam_path_string
 320 will place at most
 321 .Fa len Ns \-1
 322 characters into
 323 .Ar str .
 324 The
 325 .Ar len Ns 'th
 326 character will be the terminating
 327 .Ql \e0 .
 328 .Pp
 329 .Fn cam_device_dup
 330 operates in a fashion similar to
 331 .Xr strdup 3 .
 332 It allocates space for a
 333 .Va cam_device
 334 structure and copies the contents of the passed-in
 335 .Fa device
 336 structure to the newly allocated structure.
 337 .Pp
 338 .Fn cam_device_copy
 339 copies the
 340 .Fa src
 341 structure to
 342 .Fa dst .
 343 .Pp
 344 .Fn cam_get_device
 345 takes a
 346 .Fa path
 347 argument containing a string with a device name followed by a unit number.
 348 It then breaks the string down into a device name and unit number, and
 349 passes them back in
 350 .Fa dev_name
 351 and
 352 .Fa unit ,
 353 respectively.
 354 .Fn cam_get_device
 355 can handle strings of the following forms, at least:
 356 .Pp
 357 .Bl -tag -width 1234 -compact
 358 .It /dev/foo1
 359 .It foo0
 360 .It nsa2
 361 .El
 362 .Pp
 363 .Fn cam_get_device
 364 is provided as a convenience function for applications that need to provide
 365 functionality similar to
 366 .Fn cam_open_device .
 367 .Sh RETURN VALUES
 368 .Fn cam_open_device ,
 369 .Fn cam_open_spec_device ,
 370 .Fn cam_open_btl ,
 371 and
 372 .Fn cam_open_pass
 373 return a pointer to a
 374 .Va cam_device
 375 structure, or
 376 .Dv NULL
 377 if there was an error.
 378 .Pp
 379 .Fn cam_getccb
 380 returns an allocated and partially initialized CCB, or
 381 .Dv NULL
 382 if allocation of the CCB failed.
 383 .Pp
 384 .Fn cam_send_ccb
 385 returns a value of -1 if an error occurred, and
 386 .Va errno
 387 is set to indicate the error.
 388 .Pp
 389 .Fn cam_path_string
 390 returns a filled printing prefix string as a convenience.
 391 This is the same
 392 .Fa str
 393 that is passed into
 394 .Fn cam_path_string .
 395 .Pp
 396 .Fn cam_device_dup
 397 returns a copy of the
 398 .Va device
 399 passed in, or
 400 .Dv NULL
 401 if an error occurred.
 402 .Pp
 403 .Fn cam_get_device
 404 returns 0 for success, and -1 to indicate failure.
 405 .Pp
 406 If an error is returned from one of the base CAM library functions
 407 described here, the reason for the error is generally printed in the global
 408 string
 409 .Va cam_errbuf
 410 which is
 411 .Dv CAM_ERRBUF_SIZE
 412 characters long.
 413 .Sh SEE ALSO
 414 .Xr cam_cdbparse 3 ,
 415 .Xr pass 4 ,
 416 .Xr camcontrol 8
 417 .Sh HISTORY
 418 The CAM library first appeared in
 419 .Fx 3.0 .
 420 .Sh AUTHORS
 421 .An Kenneth Merry Aq ken@FreeBSD.org
 422 .Sh BUGS
 423 .Fn cam_open_device
 424 does not check to see if the
 425 .Fa path
 426 passed in is a symlink to something.
 427 It also does not check to see if the
 428 .Fa path
 429 passed in is an actual
 430 .Xr pass 4
 431 device.
 432 The former would be rather easy to implement, but the latter would
 433 require a definitive way to identify a device node as a
 434 .Xr pass 4
 435 device.
 436 .Pp
 437 Some of the functions are possibly misnamed or poorly named.