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