Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 | // SPDX-License-Identifier: GPL-2.0-only /* * Sony MemoryStick support * * Copyright (C) 2007 Alex Dubov <oakad@yahoo.com> * * Special thanks to Carlos Corbacho for providing various MemoryStick cards * that made this driver possible. */ #include <linux/memstick.h> #include <linux/idr.h> #include <linux/fs.h> #include <linux/delay.h> #include <linux/slab.h> #include <linux/module.h> #include <linux/pm_runtime.h> #define DRIVER_NAME "memstick" static unsigned int cmd_retries = 3; module_param(cmd_retries, uint, 0644); static struct workqueue_struct *workqueue; static DEFINE_IDR(memstick_host_idr); static DEFINE_SPINLOCK(memstick_host_lock); static int memstick_dev_match(struct memstick_dev *card, struct memstick_device_id *id) { if (id->match_flags & MEMSTICK_MATCH_ALL) { if ((id->type == card->id.type) && (id->category == card->id.category) && (id->class == card->id.class)) return 1; } return 0; } static int memstick_bus_match(struct device *dev, struct device_driver *drv) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); struct memstick_driver *ms_drv = container_of(drv, struct memstick_driver, driver); struct memstick_device_id *ids = ms_drv->id_table; if (ids) { while (ids->match_flags) { if (memstick_dev_match(card, ids)) return 1; ++ids; } } return 0; } static int memstick_uevent(struct device *dev, struct kobj_uevent_env *env) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); if (add_uevent_var(env, "MEMSTICK_TYPE=%02X", card->id.type)) return -ENOMEM; if (add_uevent_var(env, "MEMSTICK_CATEGORY=%02X", card->id.category)) return -ENOMEM; if (add_uevent_var(env, "MEMSTICK_CLASS=%02X", card->id.class)) return -ENOMEM; return 0; } static int memstick_device_probe(struct device *dev) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); struct memstick_driver *drv = container_of(dev->driver, struct memstick_driver, driver); int rc = -ENODEV; if (dev->driver && drv->probe) { rc = drv->probe(card); if (!rc) get_device(dev); } return rc; } static void memstick_device_remove(struct device *dev) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); struct memstick_driver *drv = container_of(dev->driver, struct memstick_driver, driver); if (dev->driver && drv->remove) { drv->remove(card); card->dev.driver = NULL; } put_device(dev); } #ifdef CONFIG_PM static int memstick_device_suspend(struct device *dev, pm_message_t state) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); struct memstick_driver *drv = container_of(dev->driver, struct memstick_driver, driver); if (dev->driver && drv->suspend) return drv->suspend(card, state); return 0; } static int memstick_device_resume(struct device *dev) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); struct memstick_driver *drv = container_of(dev->driver, struct memstick_driver, driver); if (dev->driver && drv->resume) return drv->resume(card); return 0; } #else #define memstick_device_suspend NULL #define memstick_device_resume NULL #endif /* CONFIG_PM */ #define MEMSTICK_ATTR(name, format) \ static ssize_t name##_show(struct device *dev, struct device_attribute *attr, \ char *buf) \ { \ struct memstick_dev *card = container_of(dev, struct memstick_dev, \ dev); \ return sprintf(buf, format, card->id.name); \ } \ static DEVICE_ATTR_RO(name); MEMSTICK_ATTR(type, "%02X"); MEMSTICK_ATTR(category, "%02X"); MEMSTICK_ATTR(class, "%02X"); static struct attribute *memstick_dev_attrs[] = { &dev_attr_type.attr, &dev_attr_category.attr, &dev_attr_class.attr, NULL, }; ATTRIBUTE_GROUPS(memstick_dev); static struct bus_type memstick_bus_type = { .name = "memstick", .dev_groups = memstick_dev_groups, .match = memstick_bus_match, .uevent = memstick_uevent, .probe = memstick_device_probe, .remove = memstick_device_remove, .suspend = memstick_device_suspend, .resume = memstick_device_resume }; static void memstick_free(struct device *dev) { struct memstick_host *host = container_of(dev, struct memstick_host, dev); kfree(host); } static struct class memstick_host_class = { .name = "memstick_host", .dev_release = memstick_free }; static void memstick_free_card(struct device *dev) { struct memstick_dev *card = container_of(dev, struct memstick_dev, dev); kfree(card); } static int memstick_dummy_check(struct memstick_dev *card) { return 0; } /** * memstick_detect_change - schedule media detection on memstick host * @host - host to use */ void memstick_detect_change(struct memstick_host *host) { queue_work(workqueue, &host->media_checker); } EXPORT_SYMBOL(memstick_detect_change); /** * memstick_next_req - called by host driver to obtain next request to process * @host - host to use * @mrq - pointer to stick the request to * * Host calls this function from idle state (*mrq == NULL) or after finishing * previous request (*mrq should point to it). If previous request was * unsuccessful, it is retried for predetermined number of times. Return value * of 0 means that new request was assigned to the host. */ int memstick_next_req(struct memstick_host *host, struct memstick_request **mrq) { int rc = -ENXIO; if ((*mrq) && (*mrq)->error && host->retries) { (*mrq)->error = rc; host->retries--; return 0; } if (host->card && host->card->next_request) rc = host->card->next_request(host->card, mrq); if (!rc) host->retries = cmd_retries > 1 ? cmd_retries - 1 : 1; else *mrq = NULL; return rc; } EXPORT_SYMBOL(memstick_next_req); /** * memstick_new_req - notify the host that some requests are pending * @host - host to use */ void memstick_new_req(struct memstick_host *host) { if (host->card) { host->retries = cmd_retries; reinit_completion(&host->card->mrq_complete); host->request(host); } } EXPORT_SYMBOL(memstick_new_req); /** * memstick_init_req_sg - set request fields needed for bulk data transfer * @mrq - request to use * @tpc - memstick Transport Protocol Command * @sg - TPC argument */ void memstick_init_req_sg(struct memstick_request *mrq, unsigned char tpc, const struct scatterlist *sg) { mrq->tpc = tpc; if (tpc & 8) mrq->data_dir = WRITE; else mrq->data_dir = READ; mrq->sg = *sg; mrq->long_data = 1; if (tpc == MS_TPC_SET_CMD || tpc == MS_TPC_EX_SET_CMD) mrq->need_card_int = 1; else mrq->need_card_int = 0; } EXPORT_SYMBOL(memstick_init_req_sg); /** * memstick_init_req - set request fields needed for short data transfer * @mrq - request to use * @tpc - memstick Transport Protocol Command * @buf - TPC argument buffer * @length - TPC argument size * * The intended use of this function (transfer of data items several bytes * in size) allows us to just copy the value between request structure and * user supplied buffer. */ void memstick_init_req(struct memstick_request *mrq, unsigned char tpc, const void *buf, size_t length) { mrq->tpc = tpc; if (tpc & 8) mrq->data_dir = WRITE; else mrq->data_dir = READ; mrq->data_len = length > sizeof(mrq->data) ? sizeof(mrq->data) : length; if (mrq->data_dir == WRITE) memcpy(mrq->data, buf, mrq->data_len); mrq->long_data = 0; if (tpc == MS_TPC_SET_CMD || tpc == MS_TPC_EX_SET_CMD) mrq->need_card_int = 1; else mrq->need_card_int = 0; } EXPORT_SYMBOL(memstick_init_req); /* * Functions prefixed with "h_" are protocol callbacks. They can be called from * interrupt context. Return value of 0 means that request processing is still * ongoing, while special error value of -EAGAIN means that current request is * finished (and request processor should come back some time later). */ static int h_memstick_read_dev_id(struct memstick_dev *card, struct memstick_request **mrq) { struct ms_id_register id_reg; if (!(*mrq)) { memstick_init_req(&card->current_mrq, MS_TPC_READ_REG, &id_reg, sizeof(struct ms_id_register)); *mrq = &card->current_mrq; return 0; } if (!(*mrq)->error) { memcpy(&id_reg, (*mrq)->data, sizeof(id_reg)); card->id.match_flags = MEMSTICK_MATCH_ALL; card->id.type = id_reg.type; card->id.category = id_reg.category; card->id.class = id_reg.class; dev_dbg(&card->dev, "if_mode = %02x\n", id_reg.if_mode); } complete(&card->mrq_complete); return -EAGAIN; } static int h_memstick_set_rw_addr(struct memstick_dev *card, struct memstick_request **mrq) { if (!(*mrq)) { memstick_init_req(&card->current_mrq, MS_TPC_SET_RW_REG_ADRS, (char *)&card->reg_addr, sizeof(card->reg_addr)); *mrq = &card->current_mrq; return 0; } else { complete(&card->mrq_complete); return -EAGAIN; } } /** * memstick_set_rw_addr - issue SET_RW_REG_ADDR request and wait for it to * complete * @card - media device to use */ int memstick_set_rw_addr(struct memstick_dev *card) { card->next_request = h_memstick_set_rw_addr; memstick_new_req(card->host); wait_for_completion(&card->mrq_complete); return card->current_mrq.error; } EXPORT_SYMBOL(memstick_set_rw_addr); static struct memstick_dev *memstick_alloc_card(struct memstick_host *host) { struct memstick_dev *card = kzalloc(sizeof(struct memstick_dev), GFP_KERNEL); struct memstick_dev *old_card = host->card; struct ms_id_register id_reg; if (card) { card->host = host; dev_set_name(&card->dev, "%s", dev_name(&host->dev)); card->dev.parent = &host->dev; card->dev.bus = &memstick_bus_type; card->dev.release = memstick_free_card; card->check = memstick_dummy_check; card->reg_addr.r_offset = offsetof(struct ms_register, id); card->reg_addr.r_length = sizeof(id_reg); card->reg_addr.w_offset = offsetof(struct ms_register, id); card->reg_addr.w_length = sizeof(id_reg); init_completion(&card->mrq_complete); host->card = card; if (memstick_set_rw_addr(card)) goto err_out; card->next_request = h_memstick_read_dev_id; memstick_new_req(host); wait_for_completion(&card->mrq_complete); if (card->current_mrq.error) goto err_out; } host->card = old_card; return card; err_out: host->card = old_card; kfree_const(card->dev.kobj.name); kfree(card); return NULL; } static int memstick_power_on(struct memstick_host *host) { int rc = host->set_param(host, MEMSTICK_POWER, MEMSTICK_POWER_ON); if (!rc) rc = host->set_param(host, MEMSTICK_INTERFACE, MEMSTICK_SERIAL); return rc; } static void memstick_check(struct work_struct *work) { struct memstick_host *host = container_of(work, struct memstick_host, media_checker); struct memstick_dev *card; dev_dbg(&host->dev, "memstick_check started\n"); pm_runtime_get_noresume(host->dev.parent); mutex_lock(&host->lock); if (!host->card) { if (memstick_power_on(host)) goto out_power_off; } else if (host->card->stop) host->card->stop(host->card); if (host->removing) goto out_power_off; card = memstick_alloc_card(host); if (!card) { if (host->card) { device_unregister(&host->card->dev); host->card = NULL; } } else { dev_dbg(&host->dev, "new card %02x, %02x, %02x\n", card->id.type, card->id.category, card->id.class); if (host->card) { if (memstick_set_rw_addr(host->card) || !memstick_dev_match(host->card, &card->id) || !(host->card->check(host->card))) { device_unregister(&host->card->dev); host->card = NULL; } else if (host->card->start) host->card->start(host->card); } if (!host->card) { host->card = card; if (device_register(&card->dev)) { put_device(&card->dev); host->card = NULL; } } else { kfree_const(card->dev.kobj.name); kfree(card); } } out_power_off: if (!host->card) host->set_param(host, MEMSTICK_POWER, MEMSTICK_POWER_OFF); mutex_unlock(&host->lock); pm_runtime_put(host->dev.parent); dev_dbg(&host->dev, "memstick_check finished\n"); } /** * memstick_alloc_host - allocate a memstick_host structure * @extra: size of the user private data to allocate * @dev: parent device of the host */ struct memstick_host *memstick_alloc_host(unsigned int extra, struct device *dev) { struct memstick_host *host; host = kzalloc(sizeof(struct memstick_host) + extra, GFP_KERNEL); if (host) { mutex_init(&host->lock); INIT_WORK(&host->media_checker, memstick_check); host->dev.class = &memstick_host_class; host->dev.parent = dev; device_initialize(&host->dev); } return host; } EXPORT_SYMBOL(memstick_alloc_host); /** * memstick_add_host - start request processing on memstick host * @host - host to use */ int memstick_add_host(struct memstick_host *host) { int rc; idr_preload(GFP_KERNEL); spin_lock(&memstick_host_lock); rc = idr_alloc(&memstick_host_idr, host, 0, 0, GFP_NOWAIT); if (rc >= 0) host->id = rc; spin_unlock(&memstick_host_lock); idr_preload_end(); if (rc < 0) return rc; dev_set_name(&host->dev, "memstick%u", host->id); rc = device_add(&host->dev); if (rc) { spin_lock(&memstick_host_lock); idr_remove(&memstick_host_idr, host->id); spin_unlock(&memstick_host_lock); return rc; } host->set_param(host, MEMSTICK_POWER, MEMSTICK_POWER_OFF); memstick_detect_change(host); return 0; } EXPORT_SYMBOL(memstick_add_host); /** * memstick_remove_host - stop request processing on memstick host * @host - host to use */ void memstick_remove_host(struct memstick_host *host) { host->removing = 1; flush_workqueue(workqueue); mutex_lock(&host->lock); if (host->card) device_unregister(&host->card->dev); host->card = NULL; host->set_param(host, MEMSTICK_POWER, MEMSTICK_POWER_OFF); mutex_unlock(&host->lock); spin_lock(&memstick_host_lock); idr_remove(&memstick_host_idr, host->id); spin_unlock(&memstick_host_lock); device_del(&host->dev); } EXPORT_SYMBOL(memstick_remove_host); /** * memstick_free_host - free memstick host * @host - host to use */ void memstick_free_host(struct memstick_host *host) { mutex_destroy(&host->lock); put_device(&host->dev); } EXPORT_SYMBOL(memstick_free_host); /** * memstick_suspend_host - notify bus driver of host suspension * @host - host to use */ void memstick_suspend_host(struct memstick_host *host) { mutex_lock(&host->lock); host->set_param(host, MEMSTICK_POWER, MEMSTICK_POWER_OFF); mutex_unlock(&host->lock); } EXPORT_SYMBOL(memstick_suspend_host); /** * memstick_resume_host - notify bus driver of host resumption * @host - host to use */ void memstick_resume_host(struct memstick_host *host) { int rc = 0; mutex_lock(&host->lock); if (host->card) rc = memstick_power_on(host); mutex_unlock(&host->lock); if (!rc) memstick_detect_change(host); } EXPORT_SYMBOL(memstick_resume_host); int memstick_register_driver(struct memstick_driver *drv) { drv->driver.bus = &memstick_bus_type; return driver_register(&drv->driver); } EXPORT_SYMBOL(memstick_register_driver); void memstick_unregister_driver(struct memstick_driver *drv) { driver_unregister(&drv->driver); } EXPORT_SYMBOL(memstick_unregister_driver); static int __init memstick_init(void) { int rc; workqueue = create_freezable_workqueue("kmemstick"); if (!workqueue) return -ENOMEM; rc = bus_register(&memstick_bus_type); if (rc) goto error_destroy_workqueue; rc = class_register(&memstick_host_class); if (rc) goto error_bus_unregister; return 0; error_bus_unregister: bus_unregister(&memstick_bus_type); error_destroy_workqueue: destroy_workqueue(workqueue); return rc; } static void __exit memstick_exit(void) { class_unregister(&memstick_host_class); bus_unregister(&memstick_bus_type); destroy_workqueue(workqueue); idr_destroy(&memstick_host_idr); } module_init(memstick_init); module_exit(memstick_exit); MODULE_AUTHOR("Alex Dubov"); MODULE_LICENSE("GPL"); MODULE_DESCRIPTION("Sony MemoryStick core driver"); |