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;
94 * copy data from device into scatter/gather buffer
96 static int fill_from_dev_buffer(struct scsi_cmnd *cmd, const void *buf)
98 int k, req_len, len, fin;
100 struct scatterlist *sgpnt;
103 buflen = scsi_bufflen(cmd);
107 if (!scsi_sglist(cmd))
111 scsi_for_each_sg(cmd, sgpnt, scsi_sg_count(cmd), k) {
112 kaddr = kmap_atomic(sg_page(sgpnt), KM_IRQ0);
114 if ((req_len + len) > buflen) {
115 len = buflen - req_len;
118 memcpy(kaddr + sgpnt->offset, buf + req_len, len);
119 flush_kernel_dcache_page(sg_page(sgpnt));
120 kunmap_atomic(kaddr, KM_IRQ0);
125 scsi_set_resid(cmd, buflen - req_len);
130 * copy data from scatter/gather into device's buffer
132 static int fetch_to_dev_buffer(struct scsi_cmnd *cmd, void *buf)
134 int k, req_len, len, fin;
136 struct scatterlist *sgpnt;
139 buflen = scsi_bufflen(cmd);
143 if (!scsi_sglist(cmd))
147 scsi_for_each_sg(cmd, sgpnt, scsi_sg_count(cmd), k) {
148 kaddr = kmap_atomic(sg_page(sgpnt), KM_IRQ0);
150 if ((req_len + len) > buflen) {
151 len = buflen - req_len;
154 memcpy(buf + req_len, kaddr + sgpnt->offset, len);
155 kunmap_atomic(kaddr, KM_IRQ0);
157 return req_len + len;
158 req_len += sgpnt->length;
163 static int ps3rom_atapi_request(struct ps3_storage_device *dev,
164 struct scsi_cmnd *cmd)
166 struct lv1_atapi_cmnd_block atapi_cmnd;
167 unsigned char opcode = cmd->cmnd[0];
171 dev_dbg(&dev->sbd.core, "%s:%u: send ATAPI command 0x%02x\n", __func__,
174 memset(&atapi_cmnd, 0, sizeof(struct lv1_atapi_cmnd_block));
175 memcpy(&atapi_cmnd.pkt, cmd->cmnd, 12);
176 atapi_cmnd.pktlen = 12;
177 atapi_cmnd.block_size = 1; /* transfer size is block_size * blocks */
178 atapi_cmnd.blocks = atapi_cmnd.arglen = scsi_bufflen(cmd);
179 atapi_cmnd.buffer = dev->bounce_lpar;
181 switch (cmd->sc_data_direction) {
182 case DMA_FROM_DEVICE:
183 if (scsi_bufflen(cmd) >= CD_FRAMESIZE)
184 atapi_cmnd.proto = DMA_PROTO;
186 atapi_cmnd.proto = PIO_DATA_IN_PROTO;
187 atapi_cmnd.in_out = DIR_READ;
191 if (scsi_bufflen(cmd) >= CD_FRAMESIZE)
192 atapi_cmnd.proto = DMA_PROTO;
194 atapi_cmnd.proto = PIO_DATA_OUT_PROTO;
195 atapi_cmnd.in_out = DIR_WRITE;
196 res = fetch_to_dev_buffer(cmd, dev->bounce_buf);
198 return DID_ERROR << 16;
202 atapi_cmnd.proto = NON_DATA_PROTO;
206 lpar = ps3_mm_phys_to_lpar(__pa(&atapi_cmnd));
207 res = lv1_storage_send_device_command(dev->sbd.dev_id,
208 LV1_STORAGE_SEND_ATAPI_COMMAND,
209 lpar, sizeof(atapi_cmnd),
211 atapi_cmnd.arglen, &dev->tag);
212 if (res == LV1_DENIED_BY_POLICY) {
213 dev_dbg(&dev->sbd.core,
214 "%s:%u: ATAPI command 0x%02x denied by policy\n",
215 __func__, __LINE__, opcode);
216 return DID_ERROR << 16;
220 dev_err(&dev->sbd.core,
221 "%s:%u: ATAPI command 0x%02x failed %d\n", __func__,
222 __LINE__, opcode, res);
223 return DID_ERROR << 16;
229 static inline unsigned int srb10_lba(const struct scsi_cmnd *cmd)
231 return cmd->cmnd[2] << 24 | cmd->cmnd[3] << 16 | cmd->cmnd[4] << 8 |
235 static inline unsigned int srb10_len(const struct scsi_cmnd *cmd)
237 return cmd->cmnd[7] << 8 | cmd->cmnd[8];
240 static int ps3rom_read_request(struct ps3_storage_device *dev,
241 struct scsi_cmnd *cmd, u32 start_sector,
246 dev_dbg(&dev->sbd.core, "%s:%u: read %u sectors starting at %u\n",
247 __func__, __LINE__, sectors, start_sector);
249 res = lv1_storage_read(dev->sbd.dev_id,
250 dev->regions[dev->region_idx].id, start_sector,
251 sectors, 0, dev->bounce_lpar, &dev->tag);
253 dev_err(&dev->sbd.core, "%s:%u: read failed %d\n", __func__,
255 return DID_ERROR << 16;
261 static int ps3rom_write_request(struct ps3_storage_device *dev,
262 struct scsi_cmnd *cmd, u32 start_sector,
267 dev_dbg(&dev->sbd.core, "%s:%u: write %u sectors starting at %u\n",
268 __func__, __LINE__, sectors, start_sector);
270 res = fetch_to_dev_buffer(cmd, dev->bounce_buf);
272 return DID_ERROR << 16;
274 res = lv1_storage_write(dev->sbd.dev_id,
275 dev->regions[dev->region_idx].id, start_sector,
276 sectors, 0, dev->bounce_lpar, &dev->tag);
278 dev_err(&dev->sbd.core, "%s:%u: write failed %d\n", __func__,
280 return DID_ERROR << 16;
286 static int ps3rom_queuecommand(struct scsi_cmnd *cmd,
287 void (*done)(struct scsi_cmnd *))
289 struct ps3rom_private *priv = shost_priv(cmd->device->host);
290 struct ps3_storage_device *dev = priv->dev;
291 unsigned char opcode;
295 scsi_print_command(cmd);
298 priv->curr_cmd = cmd;
299 cmd->scsi_done = done;
301 opcode = cmd->cmnd[0];
303 * While we can submit READ/WRITE SCSI commands as ATAPI commands,
304 * it's recommended for various reasons (performance, error handling,
305 * ...) to use lv1_storage_{read,write}() instead
309 res = ps3rom_read_request(dev, cmd, srb10_lba(cmd),
314 res = ps3rom_write_request(dev, cmd, srb10_lba(cmd),
319 res = ps3rom_atapi_request(dev, cmd);
324 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
326 cmd->sense_buffer[0] = 0x70;
327 cmd->sense_buffer[2] = ILLEGAL_REQUEST;
328 priv->curr_cmd = NULL;
335 static int decode_lv1_status(u64 status, unsigned char *sense_key,
336 unsigned char *asc, unsigned char *ascq)
338 if (((status >> 24) & 0xff) != SAM_STAT_CHECK_CONDITION)
341 *sense_key = (status >> 16) & 0xff;
342 *asc = (status >> 8) & 0xff;
343 *ascq = status & 0xff;
347 static irqreturn_t ps3rom_interrupt(int irq, void *data)
349 struct ps3_storage_device *dev = data;
350 struct Scsi_Host *host;
351 struct ps3rom_private *priv;
352 struct scsi_cmnd *cmd;
355 unsigned char sense_key, asc, ascq;
357 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
359 * status = -1 may mean that ATAPI transport completed OK, but
360 * ATAPI command itself resulted CHECK CONDITION
361 * so, upper layer should issue REQUEST_SENSE to check the sense data
365 dev_err(&dev->sbd.core,
366 "%s:%u: tag mismatch, got %lx, expected %lx\n",
367 __func__, __LINE__, tag, dev->tag);
370 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%lx\n",
371 __func__, __LINE__, res, status);
375 host = dev->sbd.core.driver_data;
376 priv = shost_priv(host);
377 cmd = priv->curr_cmd;
381 if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
382 res = fill_from_dev_buffer(cmd, dev->bounce_buf);
384 cmd->result = DID_ERROR << 16;
388 cmd->result = DID_OK << 16;
392 if (cmd->cmnd[0] == REQUEST_SENSE) {
393 /* SCSI spec says request sense should never get error */
394 dev_err(&dev->sbd.core, "%s:%u: end error without autosense\n",
396 cmd->result = DID_ERROR << 16 | SAM_STAT_CHECK_CONDITION;
400 if (decode_lv1_status(status, &sense_key, &asc, &ascq)) {
401 cmd->result = DID_ERROR << 16;
405 cmd->sense_buffer[0] = 0x70;
406 cmd->sense_buffer[2] = sense_key;
407 cmd->sense_buffer[7] = 16 - 6;
408 cmd->sense_buffer[12] = asc;
409 cmd->sense_buffer[13] = ascq;
410 cmd->result = SAM_STAT_CHECK_CONDITION;
413 priv->curr_cmd = NULL;
418 static struct scsi_host_template ps3rom_host_template = {
420 .slave_configure = ps3rom_slave_configure,
421 .queuecommand = ps3rom_queuecommand,
424 .sg_tablesize = SG_ALL,
426 .emulated = 1, /* only sg driver uses this */
427 .max_sectors = PS3ROM_MAX_SECTORS,
428 .use_clustering = DISABLE_CLUSTERING,
429 .module = THIS_MODULE,
433 static int __devinit ps3rom_probe(struct ps3_system_bus_device *_dev)
435 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
437 struct Scsi_Host *host;
438 struct ps3rom_private *priv;
440 if (dev->blk_size != CD_FRAMESIZE) {
441 dev_err(&dev->sbd.core,
442 "%s:%u: cannot handle block size %lu\n", __func__,
443 __LINE__, dev->blk_size);
447 dev->bounce_size = BOUNCE_SIZE;
448 dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
449 if (!dev->bounce_buf)
452 error = ps3stor_setup(dev, ps3rom_interrupt);
454 goto fail_free_bounce;
456 host = scsi_host_alloc(&ps3rom_host_template,
457 sizeof(struct ps3rom_private));
459 dev_err(&dev->sbd.core, "%s:%u: scsi_host_alloc failed\n",
464 priv = shost_priv(host);
465 dev->sbd.core.driver_data = host;
468 /* One device/LUN per SCSI bus */
472 error = scsi_add_host(host, &dev->sbd.core);
474 dev_err(&dev->sbd.core, "%s:%u: scsi_host_alloc failed %d\n",
475 __func__, __LINE__, error);
480 scsi_scan_host(host);
485 dev->sbd.core.driver_data = NULL;
487 ps3stor_teardown(dev);
489 kfree(dev->bounce_buf);
493 static int ps3rom_remove(struct ps3_system_bus_device *_dev)
495 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
496 struct Scsi_Host *host = dev->sbd.core.driver_data;
498 scsi_remove_host(host);
499 ps3stor_teardown(dev);
501 dev->sbd.core.driver_data = NULL;
502 kfree(dev->bounce_buf);
506 static struct ps3_system_bus_driver ps3rom = {
507 .match_id = PS3_MATCH_ID_STOR_ROM,
508 .core.name = DEVICE_NAME,
509 .core.owner = THIS_MODULE,
510 .probe = ps3rom_probe,
511 .remove = ps3rom_remove
515 static int __init ps3rom_init(void)
517 return ps3_system_bus_driver_register(&ps3rom);
520 static void __exit ps3rom_exit(void)
522 ps3_system_bus_driver_unregister(&ps3rom);
525 module_init(ps3rom_init);
526 module_exit(ps3rom_exit);
528 MODULE_LICENSE("GPL");
529 MODULE_DESCRIPTION("PS3 BD/DVD/CD-ROM Storage Driver");
530 MODULE_AUTHOR("Sony Corporation");
531 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_ROM);