sys/cam/ctl/ctl_error.h

   1 /*-
   2  * Copyright (c) 2003 Silicon Graphics International Corp.
   3  * Copyright (c) 2014-2015 Alexander Motin <mav@FreeBSD.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer,
  11  *    without modification.
  12  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  13  *    substantially similar to the "NO WARRANTY" disclaimer below
  14  *    ("Disclaimer") and any redistribution must be conditioned upon
  15  *    including a substantially similar Disclaimer requirement for further
  16  *    binary redistribution.
  17  *
  18  * NO WARRANTY
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR 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
  28  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGES.
  30  *
  31  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_error.h#1 $
  32  * $FreeBSD$
  33  */
  34 /*
  35  * Function definitions for various error reporting routines used both
  36  * within CTL and various CTL clients.
  37  *
  38  * Author: Ken Merry <ken@FreeBSD.org>
  39  */
  40
  41 #include <machine/stdarg.h>
  42
  43 #ifndef _CTL_ERROR_H_
  44 #define _CTL_ERROR_H_
  45
  46 struct ctl_lun;
  47
  48 void ctl_set_sense_data_va(struct scsi_sense_data *sense_data, void *lun,
  49                            scsi_sense_data_type sense_format, int current_error,
  50                            int sense_key, int asc, int ascq, va_list ap);
  51 void ctl_set_sense_data(struct scsi_sense_data *sense_data, void *lun,
  52                         scsi_sense_data_type sense_format, int current_error,
  53                         int sense_key, int asc, int ascq, ...);
  54 void ctl_set_sense(struct ctl_scsiio *ctsio, int current_error, int sense_key,
  55                    int asc, int ascq, ...);
  56 void ctl_sense_to_desc(struct scsi_sense_data_fixed *sense_src,
  57                       struct scsi_sense_data_desc *sense_dest);
  58 void ctl_sense_to_fixed(struct scsi_sense_data_desc *sense_src,
  59                         struct scsi_sense_data_fixed *sense_dest);
  60 void ctl_set_ua(struct ctl_scsiio *ctsio, int asc, int ascq);
  61 ctl_ua_type ctl_build_qae(struct ctl_lun *lun, uint32_t initidx, uint8_t *resp);
  62 ctl_ua_type ctl_build_ua(struct ctl_lun *lun, uint32_t initidx,
  63     struct scsi_sense_data *sense, scsi_sense_data_type sense_format);
  64 void ctl_set_overlapped_cmd(struct ctl_scsiio *ctsio);
  65 void ctl_set_overlapped_tag(struct ctl_scsiio *ctsio, uint8_t tag);
  66 void ctl_set_invalid_field(struct ctl_scsiio *ctsio, int sks_valid, int command,
  67                            int field, int bit_valid, int bit);
  68 void ctl_set_invalid_opcode(struct ctl_scsiio *ctsio);
  69 void ctl_set_param_len_error(struct ctl_scsiio *ctsio);
  70 void ctl_set_already_locked(struct ctl_scsiio *ctsio);
  71 void ctl_set_unsupported_lun(struct ctl_scsiio *ctsio);
  72 void ctl_set_lun_transit(struct ctl_scsiio *ctsio);
  73 void ctl_set_lun_standby(struct ctl_scsiio *ctsio);
  74 void ctl_set_lun_unavail(struct ctl_scsiio *ctsio);
  75 void ctl_set_internal_failure(struct ctl_scsiio *ctsio, int sks_valid,
  76                               uint16_t retry_count);
  77 void ctl_set_medium_error(struct ctl_scsiio *ctsio, int read);
  78 void ctl_set_aborted(struct ctl_scsiio *ctsio);
  79 void ctl_set_lba_out_of_range(struct ctl_scsiio *ctsio);
  80 void ctl_set_lun_stopped(struct ctl_scsiio *ctsio);
  81 void ctl_set_lun_int_reqd(struct ctl_scsiio *ctsio);
  82 void ctl_set_lun_ejected(struct ctl_scsiio *ctsio);
  83 void ctl_set_lun_no_media(struct ctl_scsiio *ctsio);
  84 void ctl_set_illegal_pr_release(struct ctl_scsiio *ctsio);
  85 void ctl_set_medium_format_corrupted(struct ctl_scsiio *ctsio);
  86 void ctl_set_medium_magazine_inaccessible(struct ctl_scsiio *ctsio);
  87 void ctl_set_data_phase_error(struct ctl_scsiio *ctsio);
  88 void ctl_set_reservation_conflict(struct ctl_scsiio *ctsio);
  89 void ctl_set_queue_full(struct ctl_scsiio *ctsio);
  90 void ctl_set_busy(struct ctl_scsiio *ctsio);
  91 void ctl_set_task_aborted(struct ctl_scsiio *ctsio);
  92 void ctl_set_hw_write_protected(struct ctl_scsiio *ctsio);
  93 void ctl_set_space_alloc_fail(struct ctl_scsiio *ctsio);
  94 void ctl_set_success(struct ctl_scsiio *ctsio);
  95
  96 #endif  /* _CTL_ERROR_H_ */