ATMEL: scsi_decoder.h Source File

00001 /*This file has been prepared for Doxygen automatic documentation generation.*/
00013 
00014 /* Copyright (c) 2007, Atmel Corporation All rights reserved.
00015  *
00016  * Redistribution and use in source and binary forms, with or without
00017  * modification, are permitted provided that the following conditions are met:
00018  *
00019  * 1. Redistributions of source code must retain the above copyright notice,
00020  * this list of conditions and the following disclaimer.
00021  *
00022  * 2. Redistributions in binary form must reproduce the above copyright notice,
00023  * this list of conditions and the following disclaimer in the documentation
00024  * and/or other materials provided with the distribution.
00025  *
00026  * 3. The name of ATMEL may not be used to endorse or promote products derived
00027  * from this software without specific prior written permission.
00028  *
00029  * THIS SOFTWARE IS PROVIDED BY ATMEL ``AS IS'' AND ANY EXPRESS OR IMPLIED
00030  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00031  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY AND
00032  * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
00033  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00034  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00035  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00036  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00037  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00038  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00039  */
00040 #ifndef _SCSI_DECODER_H_
00041 #define _SCSI_DECODER_H_
00042 
00043 //_____ M A C R O S ________________________________________________________
00044 
00045 typedef struct
00046 {
00047   U8      key;
00048   U8      asc;
00049   U8      ascq;
00050 } s_scsi_sense;
00051 
00052 
00053 //_____ D E C L A R A T I O N S ____________________________________________
00054 
00055 Bool scsi_decode_command  (void);
00056 
00057 /****************************************************************************/
00058 /* Command for all SCSI device types                                        */
00059 /****************************************************************************/
00060 
00061 #define SBC_CMD_TEST_UNIT_READY                   (0x00)
00062 #define SBC_CMD_REQUEST_SENSE                     (0x03)
00063 #define SBC_CMD_FORMAT_UNIT                       (0x04)
00064 #define SBC_CMD_READ_6                            (0x08)
00065 #define SBC_CMD_INQUIRY                           (0x12)
00066 #define SBC_CMD_MODE_SELECT_6                     (0x15)
00067 #define SBC_CMD_READ_FORMAT_CAPACITY              (0x23)
00068 #define SBC_CMD_MODE_SENSE_6                      (0x1A)
00069 #define SBC_CMD_START_STOP_UNIT                   (0x1B)
00070 #define SBC_CMD_RECEIVE_DIAGNOSTICS               (0x1C)
00071 #define SBC_CMD_SEND_DIAGNOSTIC                   (0x1D)
00072 #define SBC_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL      (0x1E)
00073 #define SBC_CMD_READ_LONG                         (0x23)
00074 #define SBC_CMD_READ_CAPACITY                     (0x25)
00075 #define SBC_CMD_READ_CD_ROM_CAPACITY              (0x25)
00076 #define SBC_CMD_READ_10                           (0x28)
00077 #define SBC_CMD_WRITE_10                          (0x2A)
00078 #define SBC_CMD_VERIFY_10                         (0x2F)
00079 #define SBC_CMD_SYNCHRONIZE_CACHE                 (0x35)
00080 #define SBC_CMD_WRITE_BUFFER                      (0x3B)
00081 #define SBC_CMD_CHANGE_DEFINITION                 (0x40)
00082 #define SBC_CMD_READ_TOC                          (0x43)
00083 #define SBC_CMD_MODE_SELECT_10                    (0x55)
00084 #define SBC_CMD_RESERVE_10                        (0x56)
00085 #define SBC_CMD_RELEASE_10                        (0x57)
00086 #define SBC_CMD_MODE_SENSE_10                     (0x5A)
00087 
00088 #define SBC_CONTROL_BYTE                          (0x00)
00089 #define SBC_CMD_DIR_IN                            (0x80)
00090 #define SBC_CMD_DIR_OUT                           (0x00)
00091 
00092 
00093 /****************************************************************************/
00094 /* Sense Key Code                                                           */
00095 /****************************************************************************/
00096 #define SBC_SENSE_KEY_NO_SENSE                        (0x00)
00097 #define SBC_SENSE_KEY_RECOVERED_ERROR                 (0x01)
00098 #define SBC_SENSE_KEY_NOT_READY                       (0x02)
00099 #define SBC_SENSE_KEY_MEDIUM_ERROR                    (0x03)
00100 #define SBC_SENSE_KEY_HARDWARE_ERROR                  (0x04)
00101 #define SBC_SENSE_KEY_ILLEGAL_REQUEST                 (0x05)
00102 #define SBC_SENSE_KEY_UNIT_ATTENTION                  (0x06)
00103 #define SBC_SENSE_KEY_DATA_PROTECT                    (0x07)
00104 #define SBC_SENSE_KEY_BLANK_CHECK                     (0x08)
00105 #define SBC_SENSE_KEY_VENDOR_SPECIFIC                 (0x09)
00106 #define SBC_SENSE_KEY_COPY_ABORTED                    (0x0A)
00107 #define SBC_SENSE_KEY_ABORTED_COMMAND                 (0x0B)
00108 #define SBC_SENSE_KEY_VOLUME_OVERFLOW                 (0x0D)
00109 #define SBC_SENSE_KEY_MISCOMPARE                      (0x0E)
00110 
00111 /****************************************************************************/
00112 /* ASC code assignments                                                     */
00113 /****************************************************************************/
00114 #define SBC_ASC_NO_ADDITIONAL_SENSE_INFORMATION       (0x00)
00115 #define SBC_ASC_LOGICAL_UNIT_NOT_READY                (0x04)
00116 #define SBC_ASC_INVALID_FIELD_IN_CDB                  (0x24)
00117 #define SBC_ASC_WRITE_PROTECTED                       (0x27)
00118 #define SBC_ASC_FORMAT_ERROR                          (0x31)
00119 #define SBC_ASC_INVALID_COMMAND_OPERATION_CODE        (0x20)
00120 #define SBC_ASC_NOT_READY_TO_READY_CHANGE             (0x28)
00121 #define SBC_ASC_MEDIUM_NOT_PRESENT                    (0x3A)
00122 
00123 /****************************************************************************/
00124 /* ASCQ code assignments                                                    */
00125 /****************************************************************************/
00126 #define SBC_ASCQ_FORMAT_COMMAND_FAILED                (0x01)
00127 #define SBC_ASCQ_INITIALIZING_COMMAND_REQUIRED        (0x02)
00128 #define SBC_ASCQ_OPERATION_IN_PROGRESS                (0x07)
00129 
00130 
00131 /****************************************************************************/
00132 /* REQUEST SENSE PARAMETERS                                                 */
00133 /****************************************************************************/
00134 #define SBC_RESPONSE_CODE_SENSE                       (0x70)
00135 #define SBC_ADDITIONAL_SENSE_LENGTH                   (0x0A)
00136 #define SBC_COMMAND_SPECIFIC_INFORMATION_3            (0x00)
00137 #define SBC_COMMAND_SPECIFIC_INFORMATION_2            (0x00)
00138 #define SBC_COMMAND_SPECIFIC_INFORMATION_1            (0x00)
00139 #define SBC_COMMAND_SPECIFIC_INFORMATION_0            (0x00)
00140 #define SBC_FIELD_REPLACEABLE_UNIT_CODE               (0x00)
00141 #define SBC_SENSE_KEY_SPECIFIC_2                      (0x00)
00142 #define SBC_SENSE_KEY_SPECIFIC_1                      (0x00)
00143 #define SBC_SENSE_KEY_SPECIFIC_0                      (0x00)
00144 
00145 /******* number of bytes of READ CAPACITY response *********/
00146 #define SBC_READ_CAPACITY_LENGTH                      (0x08)
00147 
00148 
00149 /****************************************************************************/
00150 /*MODE SENSE and REQUEST SENSE DEFINITIONS                                  */
00151 /****************************************************************************/
00152 
00153 /*************** Direct access medium type ****************/
00154 #define SBC_DEFAULT_MEDIUM_TYPE                       (0x00)
00155 #define SBC_FLEXIBLE_DISK_SINGLE_SIDED_UNSPECIFIED    (0x01)
00156 #define SBC_FLEXIBLE_DISK_DOUBLE_SIDED_UNSPECIFIED    (0x02)
00157 
00158 #define SBC_MEDIUM_TYPE                               SBC_DEFAULT_MEDIUM_TYPE
00159 
00160 #define SBC_DEV_SPEC_PARAM_WR_ENABLE                  (0x00)
00161 #define SBC_DEV_SPEC_PARAM_WR_PROTECT                 (0x80)
00162 #define SBC_BLOCK_DESCRIPTOR_LENGTH                   (0x00)
00163 
00164 #define SBC_MSK_DBD                                   (0x08)
00165 #define SBC_MSK_PAGE_CONTROL                          (0xC0)
00166 #define SBC_MSK_PAGE_CODE                             (0x3F)
00167 
00168 
00169 /************ General Page Code paramaters *****************/
00170 #define SBC_PAGE_CODE_READ_WRITE_ERROR_RECOVERY       (0x01)
00171 #define SBC_PAGE_CODE_FORMAT_DEVICE                   (0x03)
00172 #define SBC_PAGE_CODE_FLEXIBLE_DISK                   (0x05)
00173 #define SBC_PAGE_CODE_INFORMATIONAL_EXCEPTIONS        (0x1C)
00174 #define SBC_PAGE_CODE_ALL                             (0x3F)
00175 
00176 
00177 #define SBC_PAGE_LENGTH_INFORMATIONAL_EXCEPTIONS      (0x0A)
00178 #define SBC_PAGE_LENGTH_READ_WRITE_ERROR_RECOVERY     (0x0A)
00179 #define SBC_PAGE_LENGTH_FLEXIBLE_DISK                 (0x1E)
00180 #define SBC_PAGE_LENGTH_FORMAT_DEVICE                 (0x16)
00181 
00182 
00183 
00184 #define SBC_MODE_DATA_LENGTH_INFORMATIONAL_EXCEPTIONS   (SBC_PAGE_LENGTH_INFORMATIONAL_EXCEPTIONS + 2 + 3)
00185 #define SBC_MODE_DATA_LENGTH_READ_WRITE_ERROR_RECOVERY  (SBC_PAGE_LENGTH_READ_WRITE_ERROR_RECOVERY + 2 + 3 )
00186 #define SBC_MODE_DATA_LENGTH_FLEXIBLE_DISK              (SBC_PAGE_LENGTH_FLEXIBLE_DISK + 2 + 3 )
00187 #define SBC_MODE_DATA_LENGTH_FORMAT_DEVICE              (SBC_PAGE_LENGTH_FORMAT_DEVICE + 2 + 3 )
00188 /*SBC_PAGE_LENGTH_FLEXIBLE_DISK + 2  + \*/
00189 #define SBC_MODE_DATA_LENGTH_CODE_ALL                 (SBC_PAGE_LENGTH_READ_WRITE_ERROR_RECOVERY + 2 + \
00190                                                        SBC_PAGE_LENGTH_INFORMATIONAL_EXCEPTIONS + 2 + \
00191                                                        SBC_BLOCK_DESCRIPTOR_LENGTH + \
00192                                                        + 3 )
00193 
00194 /*                                                       SBC_MODE_DATA_LENGTH_FORMAT_DEVICE + 2 + \*/
00195 /****** Information exceptions control page parameters *****/
00196 #define SBC_MRIE                                      (0x05)
00197 
00198 /*************** Format device page parameters *************/
00199 #define SBC_TRACK_PER_ZONE_MSB                        (0x00)
00200 #define SBC_TRACK_PER_ZONE_LSB                        (0x00)
00201 #define SBC_ALTERNATE_SECTORS_PER_ZONE_MSB            (0x00)
00202 #define SBC_ALTERNATE_SECTORS_PER_ZONE_LSB            (0x00)
00203 #define SBC_ALTERNATE_TRACK_PER_ZONE_MSB              (0x00)
00204 #define SBC_ALTERNATE_TRACK_PER_ZONE_LSB              (0x00)
00205 #define SBC_ALTERNATE_TRACK_PER_LU_MSB                (0x00)
00206 #define SBC_ALTERNATE_TRACK_PER_LU_LSB                (0x00)
00207 
00208 /************* Flexible Disk page Parameters ***************/
00209 #define SBC_TRANSFER_RATE_MSB                         (0x13)
00210 #define SBC_TRANSFER_RATE_LSB                         (0x88)
00211 /* 1388h    5 Mbit/s   */
00212 /* 07D0h    2 Mbit/s   */
00213 /* 03E8h    1 Mbit/s   */
00214 /* 01F4h    500 kbit/s */
00215 /* 012Ch    300 kbit/s */
00216 /* 00FAh    250 kbit/s */
00217 
00218 #define SBC_NUMBER_OF_HEAD                            (0x04)
00219 #define SBC_SECTOR_PER_TRACK                          (0x20)
00220 #define SBC_DATA_BYTE_PER_SECTOR_MSB                  (0x02)
00221 #define SBC_DATA_BYTE_PER_SECTOR_LSB                  (0x00)
00222 #define SBC_NUMBER_OF_CYLINDERS_MSB                   (0x01)
00223 #define SBC_NUMBER_OF_CYLINDERS_LSB                   (0xE9)
00224 #define SBC_STARTING_CYLINDER_WRITE_COMPENSATION_MSB  (0x00)
00225 #define SBC_STARTING_CYLINDER_WRITE_COMPENSATION_LSB  (0x00)
00226 #define SBC_STARTING_CYLINDER_REDUCED_WRITE_MSB       (0x00)
00227 #define SBC_STARTING_CYLINDER_REDUCED_WRITE_LSB       (0x00)
00228 #define SBC_DEVICE_STEP_RATE_MSB                      (0x00)
00229 #define SBC_DEVICE_STEP_RATE_LSB                      (0x00)
00230 #define SBC_DEVICE_STEP_PULSE_WIDTH                   (0x00)
00231 #define SBC_HEAD_SETTLE_DELAY_MSB                     (0x00)
00232 #define SBC_HEAD_SETTLE_DELAY_LSB                     (0x00)
00233 #define SBC_MOTOR_ON_DELAY                            (0x00)
00234 #define SBC_MOTOR_OFF_DELAY                           (0x00)
00235 #define SBC_STEP_PULSE_PER_CYLINDER                   (0x00)
00236 #define SBC_WRITE_COMPENSATION                        (0x00)
00237 #define SBC_HEAD_LOAD_DELAY                           (0x00)
00238 #define SBC_HEAD_UNLOAD_DELAY                         (0x00)
00239 #define SBC_PIN34_PIN2                                (0x00)
00240 #define SBC_PIN4_PIN1                                 (0x00)
00241 #define SBC_MEDIUM_ROTATION_RATE_MSB                  (0x00)
00242 #define SBC_MEDIUM_ROTATION_RATE_LSB                  (0x00)
00243 
00244 /************ Read/Write Error Recovery parameters**********/
00245 #define SBC_READ_RETRY_COUNT                          (0x03)
00246 #define SBC_WRITE_RETRY_COUNT                         (0x80)
00247 #define SBC_CORRECTION_SPAN                           (0x00)
00248 #define SBC_HEAD_OFFSET_COUNT                         (0x00)
00249 #define SBC_DATA_STROBE_OFFSET                        (0x00)
00250 #define SBC_RECOVERY_LIMIT_MSB                        (0x00)
00251 #define SBC_RECOVERY_LIMIT_LSB                        (0x00)
00252 
00253 
00254 /*_____ D E F I N I T I O N ________________________________________________*/
00255 
00256 #define SBC_MAX_INQUIRY_DATA                          (0x60) // value ?
00257 
00258 struct sbc_st_std_inquiry_data
00259 {
00260   Byte    DeviceType : 5;
00261   Byte    PeripheralQualifier : 3;
00262 
00263   Byte    Reserved1 : 7;
00264   Byte    RemovableMedia : 1;
00265 
00266   Byte    Version;
00267 
00268   Byte    Reserved3 : 5;
00269   Byte    NormACA : 1;
00270   Byte    Obsolete0 : 1;
00271   Byte    AERC : 1;
00272 
00273   Byte    Reserved4[3];
00274 
00275   Byte    SoftReset : 1;
00276   Byte    CommandQueue : 1;
00277   Byte    Reserved5 : 1;
00278   Byte    LinkedCommands : 1;
00279   Byte    Synchronous : 1;
00280   Byte    Wide16Bit : 1;
00281   Byte    Wide32Bit : 1;
00282   Byte    RelativeAddressing : 1;
00283 };
00284 
00285 
00286 //_____ D E C L A R A T I O N S ____________________________________________
00287 
00288 #define Sbc_send_failed()                    (g_scsi_status = COMMAND_FAILED)
00289 #define Sbc_send_check_condition()           (g_scsi_status = CHECK_CONDITION)
00290 #define Sbc_send_good()                      (g_scsi_status = COMMAND_PASSED)
00291 #define Sbc_build_sense(skey, sasc, sascq)   ( g_scsi_sense.key  = skey, \
00292                                                g_scsi_sense.asc  = sasc, \
00293                                                g_scsi_sense.ascq = sascq )
00294 #define Sbc_valid_write_usb(length)          ( Usb_send_in(), \
00295                                                g_scsi_data_remaining -= length )
00296 
00297 
00298 #define COMMAND_PASSED                0x00
00299 #define COMMAND_FAILED                0x01
00300 #define CHECK_CONDITION               0x02
00301 #define PHASE_ERROR                   0x02
00302 
00303 
00304 Bool  sbc_inquiry                      (void);
00305 Bool  sbc_mode_sense                   ( Bool sense_10 );
00306 Bool  sbc_mode_select_6                (void);
00307 Bool  sbc_request_sense                (void);
00308 Bool  sbc_format                       (void);
00309 Bool  sbc_write_10                     (void);
00310 Bool  sbc_read_10                      (void);
00311 Bool  sbc_test_unit_ready              (void);
00312 Bool  sbc_read_capacity                (void);
00313 Bool  sbc_prevent_allow_medium_removal (void);
00314 
00315 void  sbc_lun_status_is_good           (void);
00316 void  sbc_lun_status_is_busy_or_change (void);
00317 void  sbc_lun_status_is_not_present    (void);
00318 void  sbc_lun_status_is_fail           (void);
00319 void  sbc_lun_status_is_protected      (void);
00320 void  sbc_lun_status_is_cdb_field      (void);
00321 
00322 #endif // _SCSI_DECODER_H_
00323