libbrasero-media/scsi-sense-data.c

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
   2 /*
   3  * Brasero
   4  * Copyright (C) Philippe Rouquier 2005-2009 <bonfire-app@wanadoo.fr>
   5  *
   6  * Libbrasero-media is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * The Libbrasero-media authors hereby grant permission for non-GPL compatible
  12  * GStreamer plugins to be used and distributed together with GStreamer
  13  * and Libbrasero-media. This permission is above and beyond the permissions granted
  14  * by the GPL license by which Libbrasero-media is covered. If you modify this code
  15  * you may extend this exception to your version of the code, but you are not
  16  * obligated to do so. If you do not wish to do so, delete this exception
  17  * statement from your version.
  18  *
  19  * Libbrasero-media is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to:
  26  *      The Free Software Foundation, Inc.,
  27  *      51 Franklin Street, Fifth Floor
  28  *      Boston, MA  02110-1301, USA.
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 #  include <config.h>
  33 #endif
  34
  35 #include <errno.h>
  36 #include <stdio.h>
  37
  38 #include "brasero-media-private.h"
  39
  40 #include "scsi-error.h"
  41 #include "scsi-utils.h"
  42 #include "scsi-base.h"
  43 #include "scsi-sense-data.h"
  44
  45 /**
  46  * defines to interpret sense data (returned after SENSE REQUEST)
  47  * (defined in SCSI Primary command 3 / SPC specs)
  48  **/
  49
  50 #define SENSE_DATA_KEY(sense)                   ((sense) ? (sense) [2] & 0x0F : 0x00)                   /* Sense code itself */
  51 #define SENSE_DATA_ASC(sense)                   ((sense) ? (sense) [12] : 0x00)                         /* Additional Sense Code */
  52 #define SENSE_DATA_ASCQ(sense)                  ((sense) ? (sense) [13] : 0x00)                         /* Additional Sense Code Qualifier */
  53 #define SENSE_DATA_ASC_ASCQ(sense)              ((sense) ? (sense) [12] << 8 | (sense) [13] : 0x00)     /* ASC and ASCQ combined */
  54
  55 #define SENSE_CODE_NOT_READY                            0x02
  56 #define SENSE_CODE_ILLEGAL_REQUEST                      0x05
  57 #define SENSE_CODE_UNIT_ATTENTION                       0x06
  58
  59 #define ASC_CODE_NOT_READY                              0x04
  60 #define ASC_CODE_NO_MEDIUM                      0x3A
  61 #define ASC_CODE_PARAMETER                              0x26
  62 #define ASC_CODE_PROTECTION_KEY                         0x6F
  63
  64 #define ASC_ASCQ_CODE_INVALID_COMMAND                   0x2000
  65 #define ASC_ASCQ_CODE_OUTRANGE_ADDRESS                  0x2100
  66 #define ASC_ASCQ_CODE_INVALID_ADDRESS                   0x2101
  67 #define ASC_ASCQ_CODE_INVALID_FIELD_IN_PARAM            0x2600
  68 #define ASC_ASCQ_CODE_INVALID_FIELD_IN_CDB              0x2400
  69 #define ASC_ASCQ_CODE_INSUFFICIENT_TIME_FOR_OPERATION   0x2E00
  70 #define ASC_ASCQ_CODE_KEY_NOT_ESTABLISHED               0x6F02
  71 #define ASC_ASCQ_CODE_SCRAMBLED_SECTOR                  0x6F03
  72 #define ASC_ASCQ_CODE_INVALID_TRACK_MODE                0x6400
  73 #define ASC_ASCQ_CODE_MEDIUM_CHANGED                    0x2800
  74
  75 /**
  76  * error processing
  77  */
  78
  79 static void
  80 brasero_sense_data_print (uchar *sense_data)
  81 {
  82         int i;
  83
  84         if (!sense_data)
  85                 return;
  86
  87         /* Print that in a more sensible way */
  88         BRASERO_MEDIA_LOG ("SK=0x%02x ASC=0x%02x ASCQ=0x%02x",
  89                            SENSE_DATA_KEY (sense_data),
  90                            SENSE_DATA_ASC (sense_data),
  91                            SENSE_DATA_ASCQ (sense_data));
  92
  93         printf ("Sense key: 0x%02x ", sense_data [0]);
  94         for (i = 1; i < BRASERO_SENSE_DATA_SIZE; i ++)
  95                 printf ("0x%02x ", sense_data [i]);
  96
  97         printf ("\n");
  98 }
  99
 100 static BraseroScsiResult
 101 brasero_sense_data_unknown (uchar *sense_data, BraseroScsiErrCode *err)
 102 {
 103         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_ERR_UNKNOWN);
 104         brasero_sense_data_print (sense_data);
 105
 106         return BRASERO_SCSI_FAILURE;
 107 }
 108
 109 static BraseroScsiResult
 110 brasero_sense_data_not_ready (uchar *sense_data, BraseroScsiErrCode *err)
 111 {
 112         BraseroScsiResult res = BRASERO_SCSI_FAILURE;
 113
 114         switch (SENSE_DATA_ASC (sense_data)) {
 115                 case ASC_CODE_NO_MEDIUM:
 116                         /* No need to use BRASERO_SCSI_SET_ERRCODE
 117                          * as this is not necessarily an error */
 118                         *err = BRASERO_SCSI_NO_MEDIUM;
 119                         break;
 120                 case ASC_CODE_NOT_READY:
 121                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_NOT_READY);
 122                         break;
 123
 124                 default:
 125                         res = brasero_sense_data_unknown (sense_data, err);
 126                         break;
 127         }
 128
 129         return res;
 130 }
 131
 132 static BraseroScsiResult
 133 brasero_sense_data_illegal_request (uchar *sense_data, BraseroScsiErrCode *err)
 134 {
 135         BraseroScsiResult res = BRASERO_SCSI_FAILURE;
 136
 137         switch (SENSE_DATA_ASC_ASCQ (sense_data)) {
 138                 case ASC_ASCQ_CODE_INVALID_COMMAND:
 139                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_INVALID_COMMAND);
 140                         break;
 141
 142                 case ASC_ASCQ_CODE_OUTRANGE_ADDRESS:
 143                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_OUTRANGE_ADDRESS);
 144                         break;
 145
 146                 case ASC_ASCQ_CODE_INVALID_ADDRESS:
 147                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_INVALID_ADDRESS);
 148                         break;
 149
 150                 case ASC_ASCQ_CODE_INVALID_FIELD_IN_PARAM:
 151                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_INVALID_PARAMETER);
 152                         break;
 153
 154                 case ASC_ASCQ_CODE_INVALID_FIELD_IN_CDB:
 155                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_INVALID_FIELD);
 156                         break;
 157
 158                 case ASC_ASCQ_CODE_KEY_NOT_ESTABLISHED:
 159                 case ASC_ASCQ_CODE_SCRAMBLED_SECTOR:
 160                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_KEY_NOT_ESTABLISHED);
 161                         break;
 162
 163                 case ASC_ASCQ_CODE_INVALID_TRACK_MODE:
 164                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_INVALID_TRACK_MODE);
 165                         break;
 166
 167                 default:
 168                         res = brasero_sense_data_unknown (sense_data, err);
 169                         break;
 170         }
 171
 172         return res;
 173 }
 174
 175 static BraseroScsiResult
 176 brasero_sense_data_unit_attention (uchar *sense_data,
 177                                    BraseroScsiErrCode *err)
 178 {
 179         BraseroScsiResult res = BRASERO_SCSI_FAILURE;
 180
 181         switch (SENSE_DATA_ASC_ASCQ (sense_data)) {
 182                 case ASC_ASCQ_CODE_INSUFFICIENT_TIME_FOR_OPERATION:
 183                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_TIMEOUT);
 184                         break;
 185
 186                 case ASC_ASCQ_CODE_MEDIUM_CHANGED:
 187                         BRASERO_SCSI_SET_ERRCODE (err, BRASERO_SCSI_NOT_READY);
 188                         break;
 189
 190                 default:
 191                         res = brasero_sense_data_unknown (sense_data, err);
 192                         break;
 193         }
 194
 195         return res;
 196 }
 197
 198 BraseroScsiResult
 199 brasero_sense_data_process (uchar *sense_data,
 200                             BraseroScsiErrCode *err)
 201 {
 202         BraseroScsiResult res = BRASERO_SCSI_FAILURE;
 203
 204         errno = EIO;
 205
 206         /* see if something was written to the sense buffer and if we
 207          * can interpret more precisely what went wrong */
 208         switch (SENSE_DATA_KEY (sense_data)) {
 209                 case SENSE_CODE_NOT_READY:
 210                         res = brasero_sense_data_not_ready (sense_data, err);
 211                         break;
 212
 213                 case SENSE_CODE_ILLEGAL_REQUEST:
 214                         res = brasero_sense_data_illegal_request (sense_data, err);
 215                         break;
 216
 217                 case SENSE_CODE_UNIT_ATTENTION:
 218                         res = brasero_sense_data_unit_attention (sense_data, err);
 219                         break;
 220
 221                 default:
 222                         res = brasero_sense_data_unknown (sense_data, err);
 223                         break;
 224         }
 225
 226         return res;
 227 }