linux/drivers/scsi/ps3rom.c
<<
>>
Prefs
   1/*
   2 * PS3 BD/DVD/CD-ROM Storage Driver
   3 *
   4 * Copyright (C) 2007 Sony Computer Entertainment Inc.
   5 * Copyright 2007 Sony Corp.
   6 *
   7 * This program is free software; you can redistribute it and/or modify it
   8 * under the terms of the GNU General Public License as published
   9 * by the Free Software Foundation; version 2 of the License.
  10 *
  11 * This program is distributed in the hope that it will be useful, but
  12 * WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 * General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License along
  17 * with this program; if not, write to the Free Software Foundation, Inc.,
  18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21#include <linux/cdrom.h>
  22#include <linux/highmem.h>
  23#include <linux/module.h>
  24#include <linux/slab.h>
  25
  26#include <scsi/scsi.h>
  27#include <scsi/scsi_cmnd.h>
  28#include <scsi/scsi_dbg.h>
  29#include <scsi/scsi_device.h>
  30#include <scsi/scsi_host.h>
  31#include <scsi/scsi_eh.h>
  32
  33#include <asm/lv1call.h>
  34#include <asm/ps3stor.h>
  35
  36
  37#define DEVICE_NAME                     "ps3rom"
  38
  39#define BOUNCE_SIZE                     (64*1024)
  40
  41#define PS3ROM_MAX_SECTORS              (BOUNCE_SIZE >> 9)
  42
  43
  44struct ps3rom_private {
  45        struct ps3_storage_device *dev;
  46        struct scsi_cmnd *curr_cmd;
  47};
  48
  49
  50#define LV1_STORAGE_SEND_ATAPI_COMMAND  (1)
  51
  52struct lv1_atapi_cmnd_block {
  53        u8      pkt[32];        /* packet command block           */
  54        u32     pktlen;         /* should be 12 for ATAPI 8020    */
  55        u32     blocks;
  56        u32     block_size;
  57        u32     proto;          /* transfer mode                  */
  58        u32     in_out;         /* transfer direction             */
  59        u64     buffer;         /* parameter except command block */
  60        u32     arglen;         /* length above                   */
  61};
  62
  63enum lv1_atapi_proto {
  64        NON_DATA_PROTO     = 0,
  65        PIO_DATA_IN_PROTO  = 1,
  66        PIO_DATA_OUT_PROTO = 2,
  67        DMA_PROTO = 3
  68};
  69
  70enum lv1_atapi_in_out {
  71        DIR_WRITE = 0,          /* memory -> device */
  72        DIR_READ = 1            /* device -> memory */
  73};
  74
  75
  76static int ps3rom_slave_configure(struct scsi_device *scsi_dev)
  77{
  78        struct ps3rom_private *priv = shost_priv(scsi_dev->host);
  79        struct ps3_storage_device *dev = priv->dev;
  80
  81        dev_dbg(&dev->sbd.core, "%s:%u: id %u, lun %u, channel %u\n", __func__,
  82                __LINE__, scsi_dev->id, scsi_dev->lun, scsi_dev->channel);
  83
  84        /*
  85         * ATAPI SFF8020 devices use MODE_SENSE_10,
  86         * so we can prohibit MODE_SENSE_6
  87         */
  88        scsi_dev->use_10_for_ms = 1;
  89
  90        /* we don't support {READ,WRITE}_6 */
  91        scsi_dev->use_10_for_rw = 1;
  92
  93        return 0;
  94}
  95
  96static int ps3rom_atapi_request(struct ps3_storage_device *dev,
  97                                struct scsi_cmnd *cmd)
  98{
  99        struct lv1_atapi_cmnd_block atapi_cmnd;
 100        unsigned char opcode = cmd->cmnd[0];
 101        int res;
 102        u64 lpar;
 103
 104        dev_dbg(&dev->sbd.core, "%s:%u: send ATAPI command 0x%02x\n", __func__,
 105                __LINE__, opcode);
 106
 107        memset(&atapi_cmnd, 0, sizeof(struct lv1_atapi_cmnd_block));
 108        memcpy(&atapi_cmnd.pkt, cmd->cmnd, 12);
 109        atapi_cmnd.pktlen = 12;
 110        atapi_cmnd.block_size = 1; /* transfer size is block_size * blocks */
 111        atapi_cmnd.blocks = atapi_cmnd.arglen = scsi_bufflen(cmd);
 112        atapi_cmnd.buffer = dev->bounce_lpar;
 113
 114        switch (cmd->sc_data_direction) {
 115        case DMA_FROM_DEVICE:
 116                if (scsi_bufflen(cmd) >= CD_FRAMESIZE)
 117                        atapi_cmnd.proto = DMA_PROTO;
 118                else
 119                        atapi_cmnd.proto = PIO_DATA_IN_PROTO;
 120                atapi_cmnd.in_out = DIR_READ;
 121                break;
 122
 123        case DMA_TO_DEVICE:
 124                if (scsi_bufflen(cmd) >= CD_FRAMESIZE)
 125                        atapi_cmnd.proto = DMA_PROTO;
 126                else
 127                        atapi_cmnd.proto = PIO_DATA_OUT_PROTO;
 128                atapi_cmnd.in_out = DIR_WRITE;
 129                scsi_sg_copy_to_buffer(cmd, dev->bounce_buf, dev->bounce_size);
 130                break;
 131
 132        default:
 133                atapi_cmnd.proto = NON_DATA_PROTO;
 134                break;
 135        }
 136
 137        lpar = ps3_mm_phys_to_lpar(__pa(&atapi_cmnd));
 138        res = lv1_storage_send_device_command(dev->sbd.dev_id,
 139                                              LV1_STORAGE_SEND_ATAPI_COMMAND,
 140                                              lpar, sizeof(atapi_cmnd),
 141                                              atapi_cmnd.buffer,
 142                                              atapi_cmnd.arglen, &dev->tag);
 143        if (res == LV1_DENIED_BY_POLICY) {
 144                dev_dbg(&dev->sbd.core,
 145                        "%s:%u: ATAPI command 0x%02x denied by policy\n",
 146                        __func__, __LINE__, opcode);
 147                return DID_ERROR << 16;
 148        }
 149
 150        if (res) {
 151                dev_err(&dev->sbd.core,
 152                        "%s:%u: ATAPI command 0x%02x failed %d\n", __func__,
 153                        __LINE__, opcode, res);
 154                return DID_ERROR << 16;
 155        }
 156
 157        return 0;
 158}
 159
 160static inline unsigned int srb10_lba(const struct scsi_cmnd *cmd)
 161{
 162        return cmd->cmnd[2] << 24 | cmd->cmnd[3] << 16 | cmd->cmnd[4] << 8 |
 163               cmd->cmnd[5];
 164}
 165
 166static inline unsigned int srb10_len(const struct scsi_cmnd *cmd)
 167{
 168        return cmd->cmnd[7] << 8 | cmd->cmnd[8];
 169}
 170
 171static int ps3rom_read_request(struct ps3_storage_device *dev,
 172                               struct scsi_cmnd *cmd, u32 start_sector,
 173                               u32 sectors)
 174{
 175        int res;
 176
 177        dev_dbg(&dev->sbd.core, "%s:%u: read %u sectors starting at %u\n",
 178                __func__, __LINE__, sectors, start_sector);
 179
 180        res = lv1_storage_read(dev->sbd.dev_id,
 181                               dev->regions[dev->region_idx].id, start_sector,
 182                               sectors, 0, dev->bounce_lpar, &dev->tag);
 183        if (res) {
 184                dev_err(&dev->sbd.core, "%s:%u: read failed %d\n", __func__,
 185                        __LINE__, res);
 186                return DID_ERROR << 16;
 187        }
 188
 189        return 0;
 190}
 191
 192static int ps3rom_write_request(struct ps3_storage_device *dev,
 193                                struct scsi_cmnd *cmd, u32 start_sector,
 194                                u32 sectors)
 195{
 196        int res;
 197
 198        dev_dbg(&dev->sbd.core, "%s:%u: write %u sectors starting at %u\n",
 199                __func__, __LINE__, sectors, start_sector);
 200
 201        scsi_sg_copy_to_buffer(cmd, dev->bounce_buf, dev->bounce_size);
 202
 203        res = lv1_storage_write(dev->sbd.dev_id,
 204                                dev->regions[dev->region_idx].id, start_sector,
 205                                sectors, 0, dev->bounce_lpar, &dev->tag);
 206        if (res) {
 207                dev_err(&dev->sbd.core, "%s:%u: write failed %d\n", __func__,
 208                        __LINE__, res);
 209                return DID_ERROR << 16;
 210        }
 211
 212        return 0;
 213}
 214
 215static int ps3rom_queuecommand_lck(struct scsi_cmnd *cmd,
 216                               void (*done)(struct scsi_cmnd *))
 217{
 218        struct ps3rom_private *priv = shost_priv(cmd->device->host);
 219        struct ps3_storage_device *dev = priv->dev;
 220        unsigned char opcode;
 221        int res;
 222
 223#ifdef DEBUG
 224        scsi_print_command(cmd);
 225#endif
 226
 227        priv->curr_cmd = cmd;
 228        cmd->scsi_done = done;
 229
 230        opcode = cmd->cmnd[0];
 231        /*
 232         * While we can submit READ/WRITE SCSI commands as ATAPI commands,
 233         * it's recommended for various reasons (performance, error handling,
 234         * ...) to use lv1_storage_{read,write}() instead
 235         */
 236        switch (opcode) {
 237        case READ_10:
 238                res = ps3rom_read_request(dev, cmd, srb10_lba(cmd),
 239                                          srb10_len(cmd));
 240                break;
 241
 242        case WRITE_10:
 243                res = ps3rom_write_request(dev, cmd, srb10_lba(cmd),
 244                                           srb10_len(cmd));
 245                break;
 246
 247        default:
 248                res = ps3rom_atapi_request(dev, cmd);
 249                break;
 250        }
 251
 252        if (res) {
 253                memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
 254                cmd->result = res;
 255                cmd->sense_buffer[0] = 0x70;
 256                cmd->sense_buffer[2] = ILLEGAL_REQUEST;
 257                priv->curr_cmd = NULL;
 258                cmd->scsi_done(cmd);
 259        }
 260
 261        return 0;
 262}
 263
 264static DEF_SCSI_QCMD(ps3rom_queuecommand)
 265
 266static int decode_lv1_status(u64 status, unsigned char *sense_key,
 267                             unsigned char *asc, unsigned char *ascq)
 268{
 269        if (((status >> 24) & 0xff) != SAM_STAT_CHECK_CONDITION)
 270                return -1;
 271
 272        *sense_key = (status >> 16) & 0xff;
 273        *asc       = (status >>  8) & 0xff;
 274        *ascq      =  status        & 0xff;
 275        return 0;
 276}
 277
 278static irqreturn_t ps3rom_interrupt(int irq, void *data)
 279{
 280        struct ps3_storage_device *dev = data;
 281        struct Scsi_Host *host;
 282        struct ps3rom_private *priv;
 283        struct scsi_cmnd *cmd;
 284        int res;
 285        u64 tag, status;
 286        unsigned char sense_key, asc, ascq;
 287
 288        res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
 289        /*
 290         * status = -1 may mean that ATAPI transport completed OK, but
 291         * ATAPI command itself resulted CHECK CONDITION
 292         * so, upper layer should issue REQUEST_SENSE to check the sense data
 293         */
 294
 295        if (tag != dev->tag)
 296                dev_err(&dev->sbd.core,
 297                        "%s:%u: tag mismatch, got %llx, expected %llx\n",
 298                        __func__, __LINE__, tag, dev->tag);
 299
 300        if (res) {
 301                dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
 302                        __func__, __LINE__, res, status);
 303                return IRQ_HANDLED;
 304        }
 305
 306        host = ps3_system_bus_get_drvdata(&dev->sbd);
 307        priv = shost_priv(host);
 308        cmd = priv->curr_cmd;
 309
 310        if (!status) {
 311                /* OK, completed */
 312                if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
 313                        int len;
 314
 315                        len = scsi_sg_copy_from_buffer(cmd,
 316                                                       dev->bounce_buf,
 317                                                       dev->bounce_size);
 318
 319                        scsi_set_resid(cmd, scsi_bufflen(cmd) - len);
 320                }
 321                cmd->result = DID_OK << 16;
 322                goto done;
 323        }
 324
 325        if (cmd->cmnd[0] == REQUEST_SENSE) {
 326                /* SCSI spec says request sense should never get error */
 327                dev_err(&dev->sbd.core, "%s:%u: end error without autosense\n",
 328                        __func__, __LINE__);
 329                cmd->result = DID_ERROR << 16 | SAM_STAT_CHECK_CONDITION;
 330                goto done;
 331        }
 332
 333        if (decode_lv1_status(status, &sense_key, &asc, &ascq)) {
 334                cmd->result = DID_ERROR << 16;
 335                goto done;
 336        }
 337
 338        scsi_build_sense_buffer(0, cmd->sense_buffer, sense_key, asc, ascq);
 339        cmd->result = SAM_STAT_CHECK_CONDITION;
 340
 341done:
 342        priv->curr_cmd = NULL;
 343        cmd->scsi_done(cmd);
 344        return IRQ_HANDLED;
 345}
 346
 347static struct scsi_host_template ps3rom_host_template = {
 348        .name =                 DEVICE_NAME,
 349        .slave_configure =      ps3rom_slave_configure,
 350        .queuecommand =         ps3rom_queuecommand,
 351        .can_queue =            1,
 352        .this_id =              7,
 353        .sg_tablesize =         SG_ALL,
 354        .cmd_per_lun =          1,
 355        .emulated =             1,              /* only sg driver uses this */
 356        .max_sectors =          PS3ROM_MAX_SECTORS,
 357        .use_clustering =       ENABLE_CLUSTERING,
 358        .module =               THIS_MODULE,
 359};
 360
 361
 362static int ps3rom_probe(struct ps3_system_bus_device *_dev)
 363{
 364        struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
 365        int error;
 366        struct Scsi_Host *host;
 367        struct ps3rom_private *priv;
 368
 369        if (dev->blk_size != CD_FRAMESIZE) {
 370                dev_err(&dev->sbd.core,
 371                        "%s:%u: cannot handle block size %llu\n", __func__,
 372                        __LINE__, dev->blk_size);
 373                return -EINVAL;
 374        }
 375
 376        dev->bounce_size = BOUNCE_SIZE;
 377        dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
 378        if (!dev->bounce_buf)
 379                return -ENOMEM;
 380
 381        error = ps3stor_setup(dev, ps3rom_interrupt);
 382        if (error)
 383                goto fail_free_bounce;
 384
 385        host = scsi_host_alloc(&ps3rom_host_template,
 386                               sizeof(struct ps3rom_private));
 387        if (!host) {
 388                dev_err(&dev->sbd.core, "%s:%u: scsi_host_alloc failed\n",
 389                        __func__, __LINE__);
 390                goto fail_teardown;
 391        }
 392
 393        priv = shost_priv(host);
 394        ps3_system_bus_set_drvdata(&dev->sbd, host);
 395        priv->dev = dev;
 396
 397        /* One device/LUN per SCSI bus */
 398        host->max_id = 1;
 399        host->max_lun = 1;
 400
 401        error = scsi_add_host(host, &dev->sbd.core);
 402        if (error) {
 403                dev_err(&dev->sbd.core, "%s:%u: scsi_host_alloc failed %d\n",
 404                        __func__, __LINE__, error);
 405                error = -ENODEV;
 406                goto fail_host_put;
 407        }
 408
 409        scsi_scan_host(host);
 410        return 0;
 411
 412fail_host_put:
 413        scsi_host_put(host);
 414        ps3_system_bus_set_drvdata(&dev->sbd, NULL);
 415fail_teardown:
 416        ps3stor_teardown(dev);
 417fail_free_bounce:
 418        kfree(dev->bounce_buf);
 419        return error;
 420}
 421
 422static int ps3rom_remove(struct ps3_system_bus_device *_dev)
 423{
 424        struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
 425        struct Scsi_Host *host = ps3_system_bus_get_drvdata(&dev->sbd);
 426
 427        scsi_remove_host(host);
 428        ps3stor_teardown(dev);
 429        scsi_host_put(host);
 430        ps3_system_bus_set_drvdata(&dev->sbd, NULL);
 431        kfree(dev->bounce_buf);
 432        return 0;
 433}
 434
 435static struct ps3_system_bus_driver ps3rom = {
 436        .match_id       = PS3_MATCH_ID_STOR_ROM,
 437        .core.name      = DEVICE_NAME,
 438        .core.owner     = THIS_MODULE,
 439        .probe          = ps3rom_probe,
 440        .remove         = ps3rom_remove
 441};
 442
 443
 444static int __init ps3rom_init(void)
 445{
 446        return ps3_system_bus_driver_register(&ps3rom);
 447}
 448
 449static void __exit ps3rom_exit(void)
 450{
 451        ps3_system_bus_driver_unregister(&ps3rom);
 452}
 453
 454module_init(ps3rom_init);
 455module_exit(ps3rom_exit);
 456
 457MODULE_LICENSE("GPL");
 458MODULE_DESCRIPTION("PS3 BD/DVD/CD-ROM Storage Driver");
 459MODULE_AUTHOR("Sony Corporation");
 460MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_ROM);
 461
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.