rbutil/ipodpatcher/ipodio-posix.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2006-2007 Dave Chapman
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22
  23 #include <stdio.h>
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <sys/ioctl.h>
  31 #include <errno.h>
  32
  33 #include "ipodio.h"
  34
  35 #if defined(linux) || defined (__linux)
  36 #include <sys/mount.h>
  37 #include <linux/hdreg.h>
  38 #include <scsi/scsi_ioctl.h>
  39 #include <scsi/sg.h>
  40
  41 #define IPOD_SECTORSIZE_IOCTL BLKSSZGET
  42
  43 static void get_geometry(struct ipod_t* ipod)
  44 {
  45     struct hd_geometry geometry;
  46
  47     if (!ioctl(ipod->dh, HDIO_GETGEO, &geometry)) {
  48         /* never use geometry.cylinders - it is truncated */
  49         ipod->num_heads = geometry.heads;
  50         ipod->sectors_per_track = geometry.sectors;
  51     } else {
  52         ipod->num_heads = 0;
  53         ipod->sectors_per_track = 0;
  54     }
  55 }
  56
  57 /* Linux SCSI Inquiry code based on the documentation and example code from
  58    http://www.ibm.com/developerworks/linux/library/l-scsi-api/index.html
  59 */
  60
  61 int ipod_scsi_inquiry(struct ipod_t* ipod, int page_code,
  62                       unsigned char* buf, int bufsize)
  63 {
  64     unsigned char cdb[6];
  65     struct sg_io_hdr hdr;
  66     unsigned char sense_buffer[255];
  67
  68     memset(&hdr, 0, sizeof(hdr));
  69
  70     hdr.interface_id = 'S'; /* this is the only choice we have! */
  71     hdr.flags = SG_FLAG_LUN_INHIBIT; /* this would put the LUN to 2nd byte of cdb*/
  72
  73     /* Set xfer data */
  74     hdr.dxferp = buf;
  75     hdr.dxfer_len = bufsize;
  76
  77     /* Set sense data */
  78     hdr.sbp = sense_buffer;
  79     hdr.mx_sb_len = sizeof(sense_buffer);
  80
  81     /* Set the cdb format */
  82     cdb[0] = 0x12;
  83     cdb[1] = 1;   /* Enable Vital Product Data (EVPD) */
  84     cdb[2] = page_code & 0xff;
  85     cdb[3] = 0;
  86     cdb[4] = 0xff;
  87     cdb[5] = 0; /* For control filed, just use 0 */
  88
  89     hdr.dxfer_direction = SG_DXFER_FROM_DEV;
  90     hdr.cmdp = cdb;
  91     hdr.cmd_len = 6;
  92
  93     int ret = ioctl(ipod->dh, SG_IO, &hdr);
  94
  95     if (ret < 0) {
  96         return -1;
  97     } else {
  98         return 0;
  99     }
 100 }
 101
 102 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) \
 103       || defined(__bsdi__) || defined(__DragonFly__)
 104 #include <sys/disk.h>
 105 #define IPOD_SECTORSIZE_IOCTL DIOCGSECTORSIZE
 106
 107 /* TODO: Implement this function for BSD */
 108 static void get_geometry(struct ipod_t* ipod)
 109 {
 110     /* Are these universal for all ipods? */
 111     ipod->num_heads = 255;
 112     ipod->sectors_per_track = 63;
 113 }
 114
 115 int ipod_scsi_inquiry(struct ipod_t* ipod, int page_code,
 116                       unsigned char* buf, int bufsize)
 117 {
 118     /* TODO: Implement for BSD */
 119     (void)ipod;
 120     (void)page_code;
 121     (void)buf;
 122     (void)bufsize;
 123     return -1;
 124 }
 125
 126 #elif defined(__APPLE__) && defined(__MACH__)
 127 /* OS X IOKit includes don't like VERSION being defined! */
 128 #undef VERSION
 129 #include <sys/disk.h>
 130 #include <CoreFoundation/CoreFoundation.h>
 131 #include <IOKit/IOKitLib.h>
 132 #include <IOKit/scsi-commands/SCSITaskLib.h>
 133 #include <IOKit/scsi-commands/SCSICommandOperationCodes.h>
 134 #define IPOD_SECTORSIZE_IOCTL DKIOCGETBLOCKSIZE
 135
 136 /* TODO: Implement this function for Mac OS X */
 137 static void get_geometry(struct ipod_t* ipod)
 138 {
 139     /* Are these universal for all ipods? */
 140     ipod->num_heads = 255;
 141     ipod->sectors_per_track = 63;
 142 }
 143
 144 int ipod_scsi_inquiry(struct ipod_t* ipod, int page_code,
 145                       unsigned char* buf, int bufsize)
 146 {
 147     /* OS X doesn't allow to simply send out a SCSI inquiry request but
 148      * requires registering an interface handler first.
 149      * Currently this is done on each inquiry request which is somewhat
 150      * inefficient but the current ipodpatcher API doesn't really fit here.
 151      * Based on the documentation in Apple's document
 152      * "SCSI Architecture Model Device Interface Guide".
 153      *
 154      * WARNING: this code currently doesn't take the selected device into
 155      *          account. It simply looks for an Ipod on the system and uses
 156      *          the first match.
 157      */
 158     (void)ipod;
 159     int result = 0;
 160     /* first, create a dictionary to match the device. This is needed to get the
 161      * service. */
 162     CFMutableDictionaryRef match_dict;
 163     match_dict = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, NULL, NULL);
 164     if(match_dict == NULL)
 165         return -1;
 166
 167     /* set value to match. In case of the Ipod this is "iPodUserClientDevice". */
 168     CFMutableDictionaryRef sub_dict;
 169     sub_dict = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, NULL, NULL);
 170     if(sub_dict == NULL)
 171         return -1;
 172     CFDictionarySetValue(sub_dict, CFSTR(kIOPropertySCSITaskDeviceCategory),
 173                          CFSTR("iPodUserClientDevice"));
 174     CFDictionarySetValue(match_dict, CFSTR(kIOPropertyMatchKey), sub_dict);
 175
 176     /* get an iterator for searching for the service. */
 177     kern_return_t kr;
 178     io_iterator_t iterator = IO_OBJECT_NULL;
 179     /* get matching services from IO registry. Consumes one reference to
 180      * the dictionary, so no need to release that. */
 181     kr = IOServiceGetMatchingServices(kIOMasterPortDefault, match_dict, &iterator);
 182
 183     if(!iterator | (kr != kIOReturnSuccess))
 184         return -1;
 185
 186     /* get interface and obtain exclusive access */
 187     SInt32 score;
 188     HRESULT herr;
 189     kern_return_t err;
 190     IOCFPlugInInterface **plugin_interface = NULL;
 191     SCSITaskDeviceInterface **interface = NULL;
 192     io_service_t device = IO_OBJECT_NULL;
 193     device = IOIteratorNext(iterator);
 194
 195     err = IOCreatePlugInInterfaceForService(device, kIOSCSITaskDeviceUserClientTypeID,
 196                                             kIOCFPlugInInterfaceID, &plugin_interface,
 197                                             &score);
 198
 199     if(err != noErr) {
 200         return -1;
 201     }
 202     /* query the plugin interface for task interface */
 203     herr = (*plugin_interface)->QueryInterface(plugin_interface,
 204                             CFUUIDGetUUIDBytes(kIOSCSITaskDeviceInterfaceID), (LPVOID*)&interface);
 205     if(herr != S_OK) {
 206         IODestroyPlugInInterface(plugin_interface);
 207         return -1;
 208     }
 209
 210     err = (*interface)->ObtainExclusiveAccess(interface);
 211     if(err != noErr) {
 212         (*interface)->Release(interface);
 213         IODestroyPlugInInterface(plugin_interface);
 214         return -1;
 215     }
 216
 217     /* do the inquiry */
 218     SCSITaskInterface **task = NULL;
 219
 220     task = (*interface)->CreateSCSITask(interface);
 221     if(task != NULL) {
 222         kern_return_t err;
 223         SCSITaskStatus task_status;
 224         IOVirtualRange* range;
 225         SCSI_Sense_Data sense_data;
 226         SCSICommandDescriptorBlock cdb;
 227         UInt64 transfer_count = 0;
 228         memset(buf, 0, bufsize);
 229         /* allocate virtual range for buffer. */
 230         range = (IOVirtualRange*) malloc(sizeof(IOVirtualRange));
 231         memset(&sense_data, 0, sizeof(sense_data));
 232         memset(cdb, 0, sizeof(cdb));
 233         /* set up range. address is buffer address, length is request size. */
 234         range->address = (IOVirtualAddress)buf;
 235         range->length = bufsize;
 236         /* setup CDB */
 237         cdb[0] = 0x12; /* inquiry */
 238         cdb[1] = 1;
 239         cdb[2] = page_code;
 240         cdb[4] = bufsize;
 241
 242         /* set cdb in task */
 243         err = (*task)->SetCommandDescriptorBlock(task, cdb, kSCSICDBSize_6Byte);
 244         if(err != kIOReturnSuccess) {
 245             result = -1;
 246             goto cleanup;
 247         }
 248         err = (*task)->SetScatterGatherEntries(task, range, 1, bufsize,
 249                 kSCSIDataTransfer_FromTargetToInitiator);
 250         if(err != kIOReturnSuccess) {
 251             result = -1;
 252             goto cleanup;
 253         }
 254         /* set timeout */
 255         err = (*task)->SetTimeoutDuration(task, 10000);
 256         if(err != kIOReturnSuccess) {
 257             result = -1;
 258             goto cleanup;
 259         }
 260
 261         /* request data */
 262         err = (*task)->ExecuteTaskSync(task, &sense_data, &task_status, &transfer_count);
 263         if(err != kIOReturnSuccess) {
 264             result = -1;
 265             goto cleanup;
 266         }
 267         /* cleanup */
 268         free(range);
 269
 270         /* release task interface */
 271         (*task)->Release(task);
 272     }
 273     else {
 274         result = -1;
 275     }
 276 cleanup:
 277     /* cleanup interface */
 278     (*interface)->ReleaseExclusiveAccess(interface);
 279     (*interface)->Release(interface);
 280     IODestroyPlugInInterface(plugin_interface);
 281
 282     return result;
 283 }
 284
 285 #else
 286     #error No sector-size detection implemented for this platform
 287 #endif
 288
 289 #if defined(__APPLE__) && defined(__MACH__)
 290 static int ipod_unmount(struct ipod_t* ipod)
 291 {
 292     char cmd[4096];
 293     int res;
 294
 295     sprintf(cmd, "/usr/sbin/diskutil unmount \"%ss2\"",ipod->diskname);
 296     fprintf(stderr,"[INFO] ");
 297     res = system(cmd);
 298
 299     if (res==0) {
 300         return 0;
 301     } else {
 302         perror("Unmount failed");
 303         return -1;
 304     }
 305 }
 306 #endif
 307
 308 void ipod_print_error(char* msg)
 309 {
 310     perror(msg);
 311 }
 312
 313 int ipod_open(struct ipod_t* ipod, int silent)
 314 {
 315     ipod->dh=open(ipod->diskname,O_RDONLY);
 316     if (ipod->dh < 0) {
 317         if (!silent) perror(ipod->diskname);
 318         if(errno == EACCES) return -2;
 319         else return -1;
 320     }
 321
 322     /* Read information about the disk */
 323
 324     if(ioctl(ipod->dh,IPOD_SECTORSIZE_IOCTL,&ipod->sector_size) < 0) {
 325         ipod->sector_size=512;
 326         if (!silent) {
 327             fprintf(stderr,"[ERR] ioctl() call to get sector size failed, defaulting to %d\n"
 328                    ,ipod->sector_size);
 329         }
 330     }
 331
 332     get_geometry(ipod);
 333
 334     return 0;
 335 }
 336
 337
 338 int ipod_reopen_rw(struct ipod_t* ipod)
 339 {
 340 #if defined(__APPLE__) && defined(__MACH__)
 341     if (ipod_unmount(ipod) < 0)
 342         return -1;
 343 #endif
 344
 345     close(ipod->dh);
 346     ipod->dh=open(ipod->diskname,O_RDWR);
 347     if (ipod->dh < 0) {
 348         perror(ipod->diskname);
 349         return -1;
 350     }
 351     return 0;
 352 }
 353
 354 int ipod_close(struct ipod_t* ipod)
 355 {
 356     close(ipod->dh);
 357     return 0;
 358 }
 359
 360 int ipod_alloc_buffer(unsigned char** sectorbuf, int bufsize)
 361 {
 362     *sectorbuf=malloc(bufsize);
 363     if (*sectorbuf == NULL) {
 364         return -1;
 365     }
 366     return 0;
 367 }
 368
 369 int ipod_seek(struct ipod_t* ipod, unsigned long pos)
 370 {
 371     off_t res;
 372
 373     res = lseek(ipod->dh, pos, SEEK_SET);
 374
 375     if (res == -1) {
 376        return -1;
 377     }
 378     return 0;
 379 }
 380
 381 ssize_t ipod_read(struct ipod_t* ipod, unsigned char* buf, int nbytes)
 382 {
 383     return read(ipod->dh, buf, nbytes);
 384 }
 385
 386 ssize_t ipod_write(struct ipod_t* ipod, unsigned char* buf, int nbytes)
 387 {
 388     return write(ipod->dh, buf, nbytes);
 389 }
 390