sys/bus/cam/scsi/scsi_targetio.h

   1 /*
   2  * Ioctl definitions for the SCSI Target Driver
   3  *
   4  * Copyright (c) 2002 Nate Lawson.
   5  * Copyright (c) 1998 Justin T. Gibbs.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions, and the following disclaimer,
  13  *    without modification, immediately at the beginning of the file.
  14  * 2. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: src/sys/cam/scsi/scsi_targetio.h,v 1.5.2.3 2003/02/18 22:07:10 njl Exp $
  30  * $DragonFly: src/sys/bus/cam/scsi/scsi_targetio.h,v 1.3 2003/08/07 21:16:45 dillon Exp $
  31  */
  32
  33 #ifndef _CAM_SCSI_SCSI_TARGETIO_H_
  34 #define _CAM_SCSI_SCSI_TARGETIO_H_
  35 #ifndef _KERNEL
  36 #include <sys/types.h>
  37 #endif
  38 #include <sys/ioccom.h>
  39
  40 #include "../cam.h"
  41 #include "../cam_ccb.h"
  42
  43 /*
  44  * CCBs (ATIO, CTIO, INOT, REL_SIMQ) are sent to the kernel driver
  45  * by writing one or more pointers.  The user receives notification
  46  * of CCB completion through poll/select/kqueue and then calls
  47  * read(2) which outputs pointers to the completed CCBs.
  48  */
  49
  50 /*
  51  * Enable and disable a target mode instance.  For enabling, the path_id,
  52  * target_id, and lun_id fields must be set.  The grp6/7_len fields
  53  * specify the length of vendor-specific CDBs the target expects and
  54  * should normally be set to 0.  On successful completion
  55  * of enable, the specified target instance will answer selection.
  56  * Disable causes the target instance to abort any outstanding commands
  57  * and stop accepting new ones.  The aborted CCBs will be returned to
  58  * the user via read(2) or discarded if the user closes the device.
  59  * The user can then re-enable the device for a new path.
  60  */
  61 struct ioc_enable_lun {
  62         path_id_t       path_id;
  63         target_id_t     target_id;
  64         lun_id_t        lun_id;
  65         int             grp6_len;
  66         int             grp7_len;
  67 };
  68 #define TARGIOCENABLE   _IOW('C', 5, struct ioc_enable_lun)
  69 #define TARGIOCDISABLE   _IO('C', 6)
  70
  71 /*
  72  * Set/clear debugging for this target mode instance
  73  */
  74 #define TARGIOCDEBUG    _IOW('C', 7, int)
  75
  76 TAILQ_HEAD(ccb_queue, ccb_hdr);
  77
  78 #endif /* _CAM_SCSI_SCSI_TARGETIO_H_ */