2 * PS3 BD/DVD/CD-ROM Storage Driver
4 * Copyright (C) 2007 Sony Computer Entertainment Inc.
5 * Copyright 2007 Sony Corp.
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.
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.
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.
21 #include <linux/cdrom.h>
22 #include <linux/highmem.h>
24 #include <scsi/scsi.h>
25 #include <scsi/scsi_cmnd.h>
26 #include <scsi/scsi_dbg.h>
27 #include <scsi/scsi_device.h>
28 #include <scsi/scsi_host.h>
30 #include <asm/lv1call.h>
31 #include <asm/ps3stor.h>
34 #define DEVICE_NAME "ps3rom"
36 #define BOUNCE_SIZE (64*1024)
38 #define PS3ROM_MAX_SECTORS (BOUNCE_SIZE >> 9)
41 struct ps3rom_private {
42 struct ps3_storage_device *dev;
43 struct scsi_cmnd *curr_cmd;
47 #define LV1_STORAGE_SEND_ATAPI_COMMAND (1)
49 struct lv1_atapi_cmnd_block {
50 u8 pkt[32]; /* packet command block */
51 u32 pktlen; /* should be 12 for ATAPI 8020 */
54 u32 proto; /* transfer mode */
55 u32 in_out; /* transfer direction */
56 u64 buffer; /* parameter except command block */
57 u32 arglen; /* length above */
60 enum lv1_atapi_proto {
62 PIO_DATA_IN_PROTO = 1,
63 PIO_DATA_OUT_PROTO = 2,
67 enum lv1_atapi_in_out {
68 DIR_WRITE = 0, /* memory -> device */
69 DIR_READ = 1 /* device -> memory */
73 static int ps3rom_slave_configure(struct scsi_device *scsi_dev)
75 struct ps3rom_private *priv = shost_priv(scsi_dev->host);
76 struct ps3_storage_device *dev = priv->dev;
78 dev_dbg(&dev->sbd.core, "%s:%u: id %u, lun %u, channel %u\n", __func__,
79 __LINE__, scsi_dev->id, scsi_dev->lun, scsi_dev->channel);
82 * ATAPI SFF8020 devices use MODE_SENSE_10,
83 * so we can prohibit MODE_SENSE_6
85 scsi_dev->use_10_for_ms = 1;
87 /* we don't support {READ,WRITE}_6 */
88 scsi_dev->use_10_for_rw = 1;
93 static int ps3rom_atapi_request(struct ps3_storage_device *dev,
94 struct scsi_cmnd *cmd)
96 struct lv1_atapi_cmnd_block atapi_cmnd;
97 unsigned char opcode = cmd->cmnd[0];
101 dev_dbg(&dev->sbd.core, "%s:%u: send ATAPI command 0x%02x\n", __func__,
104 memset(&atapi_cmnd, 0, sizeof(struct lv1_atapi_cmnd_block));
105 memcpy(&atapi_cmnd.pkt, cmd->cmnd, 12);
106 atapi_cmnd.pktlen = 12;
107 atapi_cmnd.block_size = 1; /* transfer size is block_size * blocks */
108 atapi_cmnd.blocks = atapi_cmnd.arglen = scsi_bufflen(cmd);
109 atapi_cmnd.buffer = dev->bounce_lpar;
111 switch (cmd->sc_data_direction) {
112 case DMA_FROM_DEVICE:
113 if (scsi_bufflen(cmd) >= CD_FRAMESIZE)
114 atapi_cmnd.proto = DMA_PROTO;
116 atapi_cmnd.proto = PIO_DATA_IN_PROTO;
117 atapi_cmnd.in_out = DIR_READ;
121 if (scsi_bufflen(cmd) >= CD_FRAMESIZE)
122 atapi_cmnd.proto = DMA_PROTO;
124 atapi_cmnd.proto = PIO_DATA_OUT_PROTO;
125 atapi_cmnd.in_out = DIR_WRITE;
126 scsi_sg_copy_to_buffer(cmd, dev->bounce_buf, dev->bounce_size);
130 atapi_cmnd.proto = NON_DATA_PROTO;
134 lpar = ps3_mm_phys_to_lpar(__pa(&atapi_cmnd));
135 res = lv1_storage_send_device_command(dev->sbd.dev_id,
136 LV1_STORAGE_SEND_ATAPI_COMMAND,
137 lpar, sizeof(atapi_cmnd),
139 atapi_cmnd.arglen, &dev->tag);
140 if (res == LV1_DENIED_BY_POLICY) {
141 dev_dbg(&dev->sbd.core,
142 "%s:%u: ATAPI command 0x%02x denied by policy\n",
143 __func__, __LINE__, opcode);
144 return DID_ERROR << 16;
148 dev_err(&dev->sbd.core,
149 "%s:%u: ATAPI command 0x%02x failed %d\n", __func__,
150 __LINE__, opcode, res);
151 return DID_ERROR << 16;
157 static inline unsigned int srb10_lba(const struct scsi_cmnd *cmd)
159 return cmd->cmnd[2] << 24 | cmd->cmnd[3] << 16 | cmd->cmnd[4] << 8 |
163 static inline unsigned int srb10_len(const struct scsi_cmnd *cmd)
165 return cmd->cmnd[7] << 8 | cmd->cmnd[8];
168 static int ps3rom_read_request(struct ps3_storage_device *dev,
169 struct scsi_cmnd *cmd, u32 start_sector,
174 dev_dbg(&dev->sbd.core, "%s:%u: read %u sectors starting at %u\n",
175 __func__, __LINE__, sectors, start_sector);
177 res = lv1_storage_read(dev->sbd.dev_id,
178 dev->regions[dev->region_idx].id, start_sector,
179 sectors, 0, dev->bounce_lpar, &dev->tag);
181 dev_err(&dev->sbd.core, "%s:%u: read failed %d\n", __func__,
183 return DID_ERROR << 16;
189 static int ps3rom_write_request(struct ps3_storage_device *dev,
190 struct scsi_cmnd *cmd, u32 start_sector,
195 dev_dbg(&dev->sbd.core, "%s:%u: write %u sectors starting at %u\n",
196 __func__, __LINE__, sectors, start_sector);
198 scsi_sg_copy_to_buffer(cmd, dev->bounce_buf, dev->bounce_size);
200 res = lv1_storage_write(dev->sbd.dev_id,
201 dev->regions[dev->region_idx].id, start_sector,
202 sectors, 0, dev->bounce_lpar, &dev->tag);
204 dev_err(&dev->sbd.core, "%s:%u: write failed %d\n", __func__,
206 return DID_ERROR << 16;
212 static int ps3rom_queuecommand(struct scsi_cmnd *cmd,
213 void (*done)(struct scsi_cmnd *))
215 struct ps3rom_private *priv = shost_priv(cmd->device->host);
216 struct ps3_storage_device *dev = priv->dev;
217 unsigned char opcode;
221 scsi_print_command(cmd);
224 priv->curr_cmd = cmd;
225 cmd->scsi_done = done;
227 opcode = cmd->cmnd[0];
229 * While we can submit READ/WRITE SCSI commands as ATAPI commands,
230 * it's recommended for various reasons (performance, error handling,
231 * ...) to use lv1_storage_{read,write}() instead
235 res = ps3rom_read_request(dev, cmd, srb10_lba(cmd),
240 res = ps3rom_write_request(dev, cmd, srb10_lba(cmd),
245 res = ps3rom_atapi_request(dev, cmd);
250 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
252 cmd->sense_buffer[0] = 0x70;
253 cmd->sense_buffer[2] = ILLEGAL_REQUEST;
254 priv->curr_cmd = NULL;
261 static int decode_lv1_status(u64 status, unsigned char *sense_key,
262 unsigned char *asc, unsigned char *ascq)
264 if (((status >> 24) & 0xff) != SAM_STAT_CHECK_CONDITION)
267 *sense_key = (status >> 16) & 0xff;
268 *asc = (status >> 8) & 0xff;
269 *ascq = status & 0xff;
273 static irqreturn_t ps3rom_interrupt(int irq, void *data)
275 struct ps3_storage_device *dev = data;
276 struct Scsi_Host *host;
277 struct ps3rom_private *priv;
278 struct scsi_cmnd *cmd;
281 unsigned char sense_key, asc, ascq;
283 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
285 * status = -1 may mean that ATAPI transport completed OK, but
286 * ATAPI command itself resulted CHECK CONDITION
287 * so, upper layer should issue REQUEST_SENSE to check the sense data
291 dev_err(&dev->sbd.core,
292 "%s:%u: tag mismatch, got %lx, expected %lx\n",
293 __func__, __LINE__, tag, dev->tag);
296 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%lx\n",
297 __func__, __LINE__, res, status);
301 host = dev->sbd.core.driver_data;
302 priv = shost_priv(host);
303 cmd = priv->curr_cmd;
307 if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
310 len = scsi_sg_copy_from_buffer(cmd,
314 scsi_set_resid(cmd, scsi_bufflen(cmd) - len);
316 cmd->result = DID_OK << 16;
320 if (cmd->cmnd[0] == REQUEST_SENSE) {
321 /* SCSI spec says request sense should never get error */
322 dev_err(&dev->sbd.core, "%s:%u: end error without autosense\n",
324 cmd->result = DID_ERROR << 16 | SAM_STAT_CHECK_CONDITION;
328 if (decode_lv1_status(status, &sense_key, &asc, &ascq)) {
329 cmd->result = DID_ERROR << 16;
333 cmd->sense_buffer[0] = 0x70;
334 cmd->sense_buffer[2] = sense_key;
335 cmd->sense_buffer[7] = 16 - 6;
336 cmd->sense_buffer[12] = asc;
337 cmd->sense_buffer[13] = ascq;
338 cmd->result = SAM_STAT_CHECK_CONDITION;
341 priv->curr_cmd = NULL;
346 static struct scsi_host_template ps3rom_host_template = {
348 .slave_configure = ps3rom_slave_configure,
349 .queuecommand = ps3rom_queuecommand,
352 .sg_tablesize = SG_ALL,
354 .emulated = 1, /* only sg driver uses this */
355 .max_sectors = PS3ROM_MAX_SECTORS,
356 .use_clustering = ENABLE_CLUSTERING,
357 .module = THIS_MODULE,
361 static int __devinit ps3rom_probe(struct ps3_system_bus_device *_dev)
363 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
365 struct Scsi_Host *host;
366 struct ps3rom_private *priv;
368 if (dev->blk_size != CD_FRAMESIZE) {
369 dev_err(&dev->sbd.core,
370 "%s:%u: cannot handle block size %lu\n", __func__,
371 __LINE__, dev->blk_size);
375 dev->bounce_size = BOUNCE_SIZE;
376 dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
377 if (!dev->bounce_buf)
380 error = ps3stor_setup(dev, ps3rom_interrupt);
382 goto fail_free_bounce;
384 host = scsi_host_alloc(&ps3rom_host_template,
385 sizeof(struct ps3rom_private));
387 dev_err(&dev->sbd.core, "%s:%u: scsi_host_alloc failed\n",
392 priv = shost_priv(host);
393 dev->sbd.core.driver_data = host;
396 /* One device/LUN per SCSI bus */
400 error = scsi_add_host(host, &dev->sbd.core);
402 dev_err(&dev->sbd.core, "%s:%u: scsi_host_alloc failed %d\n",
403 __func__, __LINE__, error);
408 scsi_scan_host(host);
413 dev->sbd.core.driver_data = NULL;
415 ps3stor_teardown(dev);
417 kfree(dev->bounce_buf);
421 static int ps3rom_remove(struct ps3_system_bus_device *_dev)
423 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
424 struct Scsi_Host *host = dev->sbd.core.driver_data;
426 scsi_remove_host(host);
427 ps3stor_teardown(dev);
429 dev->sbd.core.driver_data = NULL;
430 kfree(dev->bounce_buf);
434 static struct ps3_system_bus_driver ps3rom = {
435 .match_id = PS3_MATCH_ID_STOR_ROM,
436 .core.name = DEVICE_NAME,
437 .core.owner = THIS_MODULE,
438 .probe = ps3rom_probe,
439 .remove = ps3rom_remove
443 static int __init ps3rom_init(void)
445 return ps3_system_bus_driver_register(&ps3rom);
448 static void __exit ps3rom_exit(void)
450 ps3_system_bus_driver_unregister(&ps3rom);
453 module_init(ps3rom_init);
454 module_exit(ps3rom_exit);
456 MODULE_LICENSE("GPL");
457 MODULE_DESCRIPTION("PS3 BD/DVD/CD-ROM Storage Driver");
458 MODULE_AUTHOR("Sony Corporation");
459 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_ROM);