scsi/aic7xxx/aiclib.h

0001 /*
0002  * Largely written by Julian Elischer (julian@tfs.com)
0003  * for TRW Financial Systems.
0004  *
0005  * TRW Financial Systems, in accordance with their agreement with Carnegie
0006  * Mellon University, makes this software available to CMU to distribute
0007  * or use in any manner that they see fit as long as this message is kept with
0008  * the software. For this reason TFS also grants any other persons or
0009  * organisations permission to use or modify this software.
0010  *
0011  * TFS supplies this software to be publicly redistributed
0012  * on the understanding that TFS is not responsible for the correct
0013  * functioning of this software in any circumstances.
0014  *
0015  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
0016  *
0017  * $FreeBSD: src/sys/cam/scsi/scsi_all.h,v 1.21 2002/10/08 17:12:44 ken Exp $
0018  *
0019  * Copyright (c) 2003 Adaptec Inc.
0020  * All rights reserved.
0021  *
0022  * Redistribution and use in source and binary forms, with or without
0023  * modification, are permitted provided that the following conditions
0024  * are met:
0025  * 1. Redistributions of source code must retain the above copyright
0026  *    notice, this list of conditions, and the following disclaimer,
0027  *    without modification.
0028  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0029  *    substantially similar to the "NO WARRANTY" disclaimer below
0030  *    ("Disclaimer") and any redistribution must be conditioned upon
0031  *    including a substantially similar Disclaimer requirement for further
0032  *    binary redistribution.
0033  * 3. Neither the names of the above-listed copyright holders nor the names
0034  *    of any contributors may be used to endorse or promote products derived
0035  *    from this software without specific prior written permission.
0036  *
0037  * Alternatively, this software may be distributed under the terms of the
0038  * GNU General Public License ("GPL") version 2 as published by the Free
0039  * Software Foundation.
0040  *
0041  * NO WARRANTY
0042  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0043  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0044  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
0045  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0046  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
0047  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
0048  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
0049  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
0050  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
0051  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0052  * POSSIBILITY OF SUCH DAMAGES.
0053  *
0054  * $Id$
0055  */
0056
0057 #ifndef _AICLIB_H
0058 #define _AICLIB_H
0059
0060 struct scsi_sense
0061 {
0062     uint8_t opcode;
0063     uint8_t byte2;
0064     uint8_t unused[2];
0065     uint8_t length;
0066     uint8_t control;
0067 };
0068
0069 #define     SCSI_REV_0      0
0070 #define     SCSI_REV_CCS        1
0071 #define     SCSI_REV_2      2
0072 #define     SCSI_REV_SPC        3
0073 #define     SCSI_REV_SPC2       4
0074
0075 struct scsi_sense_data
0076 {
0077     uint8_t error_code;
0078 #define SSD_ERRCODE         0x7F
0079 #define     SSD_CURRENT_ERROR   0x70
0080 #define     SSD_DEFERRED_ERROR  0x71
0081 #define SSD_ERRCODE_VALID   0x80
0082     uint8_t segment;
0083     uint8_t flags;
0084 #define SSD_KEY             0x0F
0085 #define     SSD_KEY_NO_SENSE    0x00
0086 #define     SSD_KEY_RECOVERED_ERROR 0x01
0087 #define     SSD_KEY_NOT_READY   0x02
0088 #define     SSD_KEY_MEDIUM_ERROR    0x03
0089 #define     SSD_KEY_HARDWARE_ERROR  0x04
0090 #define     SSD_KEY_ILLEGAL_REQUEST 0x05
0091 #define     SSD_KEY_UNIT_ATTENTION  0x06
0092 #define     SSD_KEY_DATA_PROTECT    0x07
0093 #define     SSD_KEY_BLANK_CHECK 0x08
0094 #define     SSD_KEY_Vendor_Specific 0x09
0095 #define     SSD_KEY_COPY_ABORTED    0x0a
0096 #define     SSD_KEY_ABORTED_COMMAND 0x0b
0097 #define     SSD_KEY_EQUAL       0x0c
0098 #define     SSD_KEY_VOLUME_OVERFLOW 0x0d
0099 #define     SSD_KEY_MISCOMPARE  0x0e
0100 #define     SSD_KEY_RESERVED    0x0f
0101 #define SSD_ILI     0x20
0102 #define SSD_EOM     0x40
0103 #define SSD_FILEMARK    0x80
0104     uint8_t info[4];
0105     uint8_t extra_len;
0106     uint8_t cmd_spec_info[4];
0107     uint8_t add_sense_code;
0108     uint8_t add_sense_code_qual;
0109     uint8_t fru;
0110     uint8_t sense_key_spec[3];
0111 #define SSD_SCS_VALID       0x80
0112 #define SSD_FIELDPTR_CMD    0x40
0113 #define SSD_BITPTR_VALID    0x08
0114 #define SSD_BITPTR_VALUE    0x07
0115 #define SSD_MIN_SIZE 18
0116     uint8_t extra_bytes[14];
0117 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
0118 };
0119
0120 /************************* Large Disk Handling ********************************/
0121 static inline int
0122 aic_sector_div(sector_t capacity, int heads, int sectors)
0123 {
0124     /* ugly, ugly sector_div calling convention.. */
0125     sector_div(capacity, (heads * sectors));
0126     return (int)capacity;
0127 }
0128
0129 static inline uint32_t
0130 scsi_4btoul(uint8_t *bytes)
0131 {
0132     uint32_t rv;
0133
0134     rv = (bytes[0] << 24) |
0135          (bytes[1] << 16) |
0136          (bytes[2] << 8) |
0137          bytes[3];
0138     return (rv);
0139 }
0140
0141 /* Macros for generating the elements of the PCI ID tables. */
0142
0143 #define GETID(v, s) (unsigned)(((v) >> (s)) & 0xFFFF ?: PCI_ANY_ID)
0144
0145 #define ID_C(x, c)                      \
0146 {                               \
0147     GETID(x,32), GETID(x,48), GETID(x,0), GETID(x,16),  \
0148     (c) << 8, 0xFFFF00, 0                   \
0149 }
0150
0151 #define ID2C(x)                          \
0152     ID_C(x, PCI_CLASS_STORAGE_SCSI), \
0153     ID_C(x, PCI_CLASS_STORAGE_RAID)
0154
0155 #define IDIROC(x)  ((x) | ~ID_ALL_IROC_MASK)
0156
0157 /* Generate IDs for all 16 possibilites.
0158  * The argument has already masked out
0159  * the 4 least significant bits of the device id.
0160  * (e.g., mask: ID_9005_GENERIC_MASK).
0161  */
0162 #define ID16(x)                          \
0163     ID(x),                           \
0164     ID((x) | 0x0001000000000000ull), \
0165     ID((x) | 0x0002000000000000ull), \
0166     ID((x) | 0x0003000000000000ull), \
0167     ID((x) | 0x0004000000000000ull), \
0168     ID((x) | 0x0005000000000000ull), \
0169     ID((x) | 0x0006000000000000ull), \
0170     ID((x) | 0x0007000000000000ull), \
0171     ID((x) | 0x0008000000000000ull), \
0172     ID((x) | 0x0009000000000000ull), \
0173     ID((x) | 0x000A000000000000ull), \
0174     ID((x) | 0x000B000000000000ull), \
0175     ID((x) | 0x000C000000000000ull), \
0176     ID((x) | 0x000D000000000000ull), \
0177     ID((x) | 0x000E000000000000ull), \
0178     ID((x) | 0x000F000000000000ull)
0179
0180 #endif /*_AICLIB_H */