2 * Remote VUB300 SDIO/SDmem Host Controller Driver
4 * Copyright (C) 2010 Elan Digital Systems Limited
6 * based on USB Skeleton driver - 2.2
8 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation, version 2
14 * VUB300: is a USB 2.0 client device with a single SDIO/SDmem/MMC slot
15 * Any SDIO/SDmem/MMC device plugged into the VUB300 will appear,
16 * by virtue of this driver, to have been plugged into a local
17 * SDIO host controller, similar to, say, a PCI Ricoh controller
18 * This is because this kernel device driver is both a USB 2.0
19 * client device driver AND an MMC host controller driver. Thus
20 * if there is an existing driver for the inserted SDIO/SDmem/MMC
21 * device then that driver will be used by the kernel to manage
22 * the device in exactly the same fashion as if it had been
23 * directly plugged into, say, a local pci bus Ricoh controller
25 * RANT: this driver was written using a display 128x48 - converting it
26 * to a line width of 80 makes it very difficult to support. In
27 * particular functions have been broken down into sub functions
28 * and the original meaningful names have been shortened into
30 * The problem is that executing a fragment of code subject to
31 * two conditions means an indentation of 24, thus leaving only
32 * 56 characters for a C statement. And that is quite ridiculous!
34 * Data types: data passed to/from the VUB300 is fixed to a number of
35 * bits and driver data fields reflect that limit by using
38 #include <linux/kernel.h>
39 #include <linux/errno.h>
40 #include <linux/init.h>
41 #include <linux/slab.h>
42 #include <linux/module.h>
43 #include <linux/kref.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/mutex.h>
47 #include <linux/mmc/host.h>
48 #include <linux/mmc/card.h>
49 #include <linux/mmc/sdio_func.h>
50 #include <linux/mmc/sdio_ids.h>
51 #include <linux/workqueue.h>
52 #include <linux/ctype.h>
53 #include <linux/firmware.h>
54 #include <linux/scatterlist.h>
56 struct host_controller_info {
62 #define FIRMWARE_BLOCK_BOUNDARY 1024
63 struct sd_command_header {
67 u8 command_type; /* Bit7 - Rd/Wr */
69 u8 transfer_size[4]; /* ReadSize + ReadSize */
75 u8 reserved[44]; /* to pad out to 64 bytes */
78 struct sd_irqpoll_header {
82 u8 command_type; /* Bit7 - Rd/Wr */
83 u8 padding[16]; /* don't ask why !! */
86 u8 reserved[42]; /* to pad out to 64 bytes */
89 struct sd_common_header {
95 struct sd_response_header {
101 u8 command_response[0];
104 struct sd_status_header {
110 u16 host_header_size;
111 u16 func_header_size;
112 u16 ctrl_header_size;
115 struct sd_error_header {
122 struct sd_interrupt_header {
128 struct offload_registers_access {
133 #define INTERRUPT_REGISTER_ACCESSES 15
134 struct sd_offloaded_interrupt {
138 struct offload_registers_access reg[INTERRUPT_REGISTER_ACCESSES];
141 struct sd_register_header {
147 u8 command_response[6];
150 #define PIGGYBACK_REGISTER_ACCESSES 14
151 struct sd_offloaded_piggyback {
152 struct sd_register_header sdio;
153 struct offload_registers_access reg[PIGGYBACK_REGISTER_ACCESSES];
157 struct sd_common_header common;
158 struct sd_status_header status;
159 struct sd_error_header error;
160 struct sd_interrupt_header interrupt;
161 struct sd_response_header response;
162 struct sd_offloaded_interrupt irq;
163 struct sd_offloaded_piggyback pig;
167 struct sd_command_header head;
168 struct sd_irqpoll_header poll;
171 enum SD_RESPONSE_TYPE {
172 SDRT_UNSPECIFIED = 0,
185 #define RESPONSE_INTERRUPT 0x01
186 #define RESPONSE_ERROR 0x02
187 #define RESPONSE_STATUS 0x03
188 #define RESPONSE_IRQ_DISABLED 0x05
189 #define RESPONSE_IRQ_ENABLED 0x06
190 #define RESPONSE_PIGGYBACKED 0x07
191 #define RESPONSE_NO_INTERRUPT 0x08
192 #define RESPONSE_PIG_DISABLED 0x09
193 #define RESPONSE_PIG_ENABLED 0x0A
194 #define SD_ERROR_1BIT_TIMEOUT 0x01
195 #define SD_ERROR_4BIT_TIMEOUT 0x02
196 #define SD_ERROR_1BIT_CRC_WRONG 0x03
197 #define SD_ERROR_4BIT_CRC_WRONG 0x04
198 #define SD_ERROR_1BIT_CRC_ERROR 0x05
199 #define SD_ERROR_4BIT_CRC_ERROR 0x06
200 #define SD_ERROR_NO_CMD_ENDBIT 0x07
201 #define SD_ERROR_NO_1BIT_DATEND 0x08
202 #define SD_ERROR_NO_4BIT_DATEND 0x09
203 #define SD_ERROR_1BIT_UNEXPECTED_TIMEOUT 0x0A
204 #define SD_ERROR_4BIT_UNEXPECTED_TIMEOUT 0x0B
205 #define SD_ERROR_ILLEGAL_COMMAND 0x0C
206 #define SD_ERROR_NO_DEVICE 0x0D
207 #define SD_ERROR_TRANSFER_LENGTH 0x0E
208 #define SD_ERROR_1BIT_DATA_TIMEOUT 0x0F
209 #define SD_ERROR_4BIT_DATA_TIMEOUT 0x10
210 #define SD_ERROR_ILLEGAL_STATE 0x11
211 #define SD_ERROR_UNKNOWN_ERROR 0x12
212 #define SD_ERROR_RESERVED_ERROR 0x13
213 #define SD_ERROR_INVALID_FUNCTION 0x14
214 #define SD_ERROR_OUT_OF_RANGE 0x15
215 #define SD_ERROR_STAT_CMD 0x16
216 #define SD_ERROR_STAT_DATA 0x17
217 #define SD_ERROR_STAT_CMD_TIMEOUT 0x18
218 #define SD_ERROR_SDCRDY_STUCK 0x19
219 #define SD_ERROR_UNHANDLED 0x1A
220 #define SD_ERROR_OVERRUN 0x1B
221 #define SD_ERROR_PIO_TIMEOUT 0x1C
223 #define FUN(c) (0x000007 & (c->arg>>28))
224 #define REG(c) (0x01FFFF & (c->arg>>9))
226 static bool limit_speed_to_24_MHz;
227 module_param(limit_speed_to_24_MHz, bool, 0644);
228 MODULE_PARM_DESC(limit_speed_to_24_MHz, "Limit Max SDIO Clock Speed to 24 MHz");
230 static bool pad_input_to_usb_pkt;
231 module_param(pad_input_to_usb_pkt, bool, 0644);
232 MODULE_PARM_DESC(pad_input_to_usb_pkt,
233 "Pad USB data input transfers to whole USB Packet");
235 static bool disable_offload_processing;
236 module_param(disable_offload_processing, bool, 0644);
237 MODULE_PARM_DESC(disable_offload_processing, "Disable Offload Processing");
239 static bool force_1_bit_data_xfers;
240 module_param(force_1_bit_data_xfers, bool, 0644);
241 MODULE_PARM_DESC(force_1_bit_data_xfers,
242 "Force SDIO Data Transfers to 1-bit Mode");
244 static bool force_polling_for_irqs;
245 module_param(force_polling_for_irqs, bool, 0644);
246 MODULE_PARM_DESC(force_polling_for_irqs, "Force Polling for SDIO interrupts");
248 static int firmware_irqpoll_timeout = 1024;
249 module_param(firmware_irqpoll_timeout, int, 0644);
250 MODULE_PARM_DESC(firmware_irqpoll_timeout, "VUB300 firmware irqpoll timeout");
252 static int force_max_req_size = 128;
253 module_param(force_max_req_size, int, 0644);
254 MODULE_PARM_DESC(force_max_req_size, "set max request size in kBytes");
256 #ifdef SMSC_DEVELOPMENT_BOARD
257 static int firmware_rom_wait_states = 0x04;
259 static int firmware_rom_wait_states = 0x1C;
262 module_param(firmware_rom_wait_states, int, 0644);
263 MODULE_PARM_DESC(firmware_rom_wait_states,
264 "ROM wait states byte=RRRIIEEE (Reserved Internal External)");
266 #define ELAN_VENDOR_ID 0x2201
267 #define VUB300_VENDOR_ID 0x0424
268 #define VUB300_PRODUCT_ID 0x012C
269 static struct usb_device_id vub300_table[] = {
270 {USB_DEVICE(ELAN_VENDOR_ID, VUB300_PRODUCT_ID)},
271 {USB_DEVICE(VUB300_VENDOR_ID, VUB300_PRODUCT_ID)},
272 {} /* Terminating entry */
274 MODULE_DEVICE_TABLE(usb, vub300_table);
276 static struct workqueue_struct *cmndworkqueue;
277 static struct workqueue_struct *pollworkqueue;
278 static struct workqueue_struct *deadworkqueue;
280 static inline int interface_to_InterfaceNumber(struct usb_interface *interface)
284 if (!interface->cur_altsetting)
286 return interface->cur_altsetting->desc.bInterfaceNumber;
289 struct sdio_register {
291 unsigned sdio_reg:17;
296 unsigned sparebit:26;
299 struct vub300_mmc_host {
300 struct usb_device *udev;
301 struct usb_interface *interface;
303 struct mutex cmd_mutex;
304 struct mutex irq_mutex;
305 char vub_name[3 + (9 * 8) + 4 + 1]; /* max of 7 sdio fn's */
306 u8 cmnd_out_ep; /* EndPoint for commands */
307 u8 cmnd_res_ep; /* EndPoint for responses */
308 u8 data_out_ep; /* EndPoint for out data */
309 u8 data_inp_ep; /* EndPoint for inp data */
313 bool large_usb_packets;
314 bool app_spec; /* ApplicationSpecific */
315 bool irq_enabled; /* by the MMC CORE */
316 bool irq_disabled; /* in the firmware */
317 unsigned bus_width:4;
318 u8 total_offload_count;
319 u8 dynamic_register_count;
323 int usb_transport_fail;
326 struct sdio_register sdio_register[16];
327 struct offload_interrupt_function_register {
329 #define MAXREGS (1<<MAXREGBITS)
330 #define MAXREGMASK (MAXREGS-1)
333 struct offload_registers_access reg[MAXREGS];
335 u16 fbs[8]; /* Function Block Size */
336 struct mmc_command *cmd;
337 struct mmc_request *req;
338 struct mmc_data *data;
339 struct mmc_host *mmc;
341 struct urb *command_out_urb;
342 struct urb *command_res_urb;
343 struct completion command_complete;
344 struct completion irqpoll_complete;
345 union sd_command cmnd;
346 union sd_response resp;
347 struct timer_list sg_transfer_timer;
348 struct usb_sg_request sg_request;
349 struct timer_list inactivity_timer;
350 struct work_struct deadwork;
351 struct work_struct cmndwork;
352 struct delayed_work pollwork;
353 struct host_controller_info hc_info;
354 struct sd_status_header system_port_status;
355 u8 padded_buffer[64];
358 #define kref_to_vub300_mmc_host(d) container_of(d, struct vub300_mmc_host, kref)
359 #define SET_TRANSFER_PSEUDOCODE 21
360 #define SET_INTERRUPT_PSEUDOCODE 20
361 #define SET_FAILURE_MODE 18
362 #define SET_ROM_WAIT_STATES 16
363 #define SET_IRQ_ENABLE 13
364 #define SET_CLOCK_SPEED 11
365 #define SET_FUNCTION_BLOCK_SIZE 9
366 #define SET_SD_DATA_MODE 6
367 #define SET_SD_POWER 4
368 #define ENTER_DFU_MODE 3
369 #define GET_HC_INF0 1
370 #define GET_SYSTEM_PORT_STATUS 0
372 static void vub300_delete(struct kref *kref)
373 { /* kref callback - softirq */
374 struct vub300_mmc_host *vub300 = kref_to_vub300_mmc_host(kref);
375 struct mmc_host *mmc = vub300->mmc;
376 usb_free_urb(vub300->command_out_urb);
377 vub300->command_out_urb = NULL;
378 usb_free_urb(vub300->command_res_urb);
379 vub300->command_res_urb = NULL;
380 usb_put_dev(vub300->udev);
383 * and hence also frees vub300
384 * which is contained at the end of struct mmc
388 static void vub300_queue_cmnd_work(struct vub300_mmc_host *vub300)
390 kref_get(&vub300->kref);
391 if (queue_work(cmndworkqueue, &vub300->cmndwork)) {
393 * then the cmndworkqueue was not previously
394 * running and the above get ref is obvious
395 * required and will be put when the thread
396 * terminates by a specific call
400 * the cmndworkqueue was already running from
401 * a previous invocation and thus to keep the
402 * kref counts correct we must undo the get
404 kref_put(&vub300->kref, vub300_delete);
408 static void vub300_queue_poll_work(struct vub300_mmc_host *vub300, int delay)
410 kref_get(&vub300->kref);
411 if (queue_delayed_work(pollworkqueue, &vub300->pollwork, delay)) {
413 * then the pollworkqueue was not previously
414 * running and the above get ref is obvious
415 * required and will be put when the thread
416 * terminates by a specific call
420 * the pollworkqueue was already running from
421 * a previous invocation and thus to keep the
422 * kref counts correct we must undo the get
424 kref_put(&vub300->kref, vub300_delete);
428 static void vub300_queue_dead_work(struct vub300_mmc_host *vub300)
430 kref_get(&vub300->kref);
431 if (queue_work(deadworkqueue, &vub300->deadwork)) {
433 * then the deadworkqueue was not previously
434 * running and the above get ref is obvious
435 * required and will be put when the thread
436 * terminates by a specific call
440 * the deadworkqueue was already running from
441 * a previous invocation and thus to keep the
442 * kref counts correct we must undo the get
444 kref_put(&vub300->kref, vub300_delete);
448 static void irqpoll_res_completed(struct urb *urb)
449 { /* urb completion handler - hardirq */
450 struct vub300_mmc_host *vub300 = (struct vub300_mmc_host *)urb->context;
452 vub300->usb_transport_fail = urb->status;
453 complete(&vub300->irqpoll_complete);
456 static void irqpoll_out_completed(struct urb *urb)
457 { /* urb completion handler - hardirq */
458 struct vub300_mmc_host *vub300 = (struct vub300_mmc_host *)urb->context;
460 vub300->usb_transport_fail = urb->status;
461 complete(&vub300->irqpoll_complete);
466 usb_rcvbulkpipe(vub300->udev, vub300->cmnd_res_ep);
467 usb_fill_bulk_urb(vub300->command_res_urb, vub300->udev, pipe,
468 &vub300->resp, sizeof(vub300->resp),
469 irqpoll_res_completed, vub300);
470 vub300->command_res_urb->actual_length = 0;
471 ret = usb_submit_urb(vub300->command_res_urb, GFP_ATOMIC);
473 vub300->usb_transport_fail = ret;
474 complete(&vub300->irqpoll_complete);
480 static void send_irqpoll(struct vub300_mmc_host *vub300)
482 /* cmd_mutex is held by vub300_pollwork_thread */
484 int timeout = 0xFFFF & (0x0001FFFF - firmware_irqpoll_timeout);
485 vub300->cmnd.poll.header_size = 22;
486 vub300->cmnd.poll.header_type = 1;
487 vub300->cmnd.poll.port_number = 0;
488 vub300->cmnd.poll.command_type = 2;
489 vub300->cmnd.poll.poll_timeout_lsb = 0xFF & (unsigned)timeout;
490 vub300->cmnd.poll.poll_timeout_msb = 0xFF & (unsigned)(timeout >> 8);
491 usb_fill_bulk_urb(vub300->command_out_urb, vub300->udev,
492 usb_sndbulkpipe(vub300->udev, vub300->cmnd_out_ep)
493 , &vub300->cmnd, sizeof(vub300->cmnd)
494 , irqpoll_out_completed, vub300);
495 retval = usb_submit_urb(vub300->command_out_urb, GFP_KERNEL);
497 vub300->usb_transport_fail = retval;
498 vub300_queue_poll_work(vub300, 1);
499 complete(&vub300->irqpoll_complete);
506 static void new_system_port_status(struct vub300_mmc_host *vub300)
508 int old_card_present = vub300->card_present;
509 int new_card_present =
510 (0x0001 & vub300->system_port_status.port_flags) ? 1 : 0;
512 (0x0010 & vub300->system_port_status.port_flags) ? 1 : 0;
513 if (new_card_present && !old_card_present) {
514 dev_info(&vub300->udev->dev, "card just inserted\n");
515 vub300->card_present = 1;
516 vub300->bus_width = 0;
517 if (disable_offload_processing)
518 strncpy(vub300->vub_name, "EMPTY Processing Disabled",
519 sizeof(vub300->vub_name));
521 vub300->vub_name[0] = 0;
522 mmc_detect_change(vub300->mmc, 1);
523 } else if (!new_card_present && old_card_present) {
524 dev_info(&vub300->udev->dev, "card just ejected\n");
525 vub300->card_present = 0;
526 mmc_detect_change(vub300->mmc, 0);
532 static void __add_offloaded_reg_to_fifo(struct vub300_mmc_host *vub300,
533 struct offload_registers_access
534 *register_access, u8 func)
536 u8 r = vub300->fn[func].offload_point + vub300->fn[func].offload_count;
537 memcpy(&vub300->fn[func].reg[MAXREGMASK & r], register_access,
538 sizeof(struct offload_registers_access));
539 vub300->fn[func].offload_count += 1;
540 vub300->total_offload_count += 1;
543 static void add_offloaded_reg(struct vub300_mmc_host *vub300,
544 struct offload_registers_access *register_access)
546 u32 Register = ((0x03 & register_access->command_byte[0]) << 15)
547 | ((0xFF & register_access->command_byte[1]) << 7)
548 | ((0xFE & register_access->command_byte[2]) >> 1);
549 u8 func = ((0x70 & register_access->command_byte[0]) >> 4);
550 u8 regs = vub300->dynamic_register_count;
552 while (0 < regs-- && 1 == vub300->sdio_register[i].activate) {
553 if (vub300->sdio_register[i].func_num == func &&
554 vub300->sdio_register[i].sdio_reg == Register) {
555 if (vub300->sdio_register[i].prepared == 0)
556 vub300->sdio_register[i].prepared = 1;
557 vub300->sdio_register[i].response =
558 register_access->Respond_Byte[2];
559 vub300->sdio_register[i].regvalue =
560 register_access->Respond_Byte[3];
567 __add_offloaded_reg_to_fifo(vub300, register_access, func);
570 static void check_vub300_port_status(struct vub300_mmc_host *vub300)
573 * cmd_mutex is held by vub300_pollwork_thread,
574 * vub300_deadwork_thread or vub300_cmndwork_thread
578 usb_control_msg(vub300->udev, usb_rcvctrlpipe(vub300->udev, 0),
579 GET_SYSTEM_PORT_STATUS,
580 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
581 0x0000, 0x0000, &vub300->system_port_status,
582 sizeof(vub300->system_port_status), HZ);
583 if (sizeof(vub300->system_port_status) == retval)
584 new_system_port_status(vub300);
587 static void __vub300_irqpoll_response(struct vub300_mmc_host *vub300)
589 /* cmd_mutex is held by vub300_pollwork_thread */
590 if (vub300->command_res_urb->actual_length == 0)
593 switch (vub300->resp.common.header_type) {
594 case RESPONSE_INTERRUPT:
595 mutex_lock(&vub300->irq_mutex);
596 if (vub300->irq_enabled)
597 mmc_signal_sdio_irq(vub300->mmc);
599 vub300->irqs_queued += 1;
600 vub300->irq_disabled = 1;
601 mutex_unlock(&vub300->irq_mutex);
604 if (vub300->resp.error.error_code == SD_ERROR_NO_DEVICE)
605 check_vub300_port_status(vub300);
607 case RESPONSE_STATUS:
608 vub300->system_port_status = vub300->resp.status;
609 new_system_port_status(vub300);
610 if (!vub300->card_present)
611 vub300_queue_poll_work(vub300, HZ / 5);
613 case RESPONSE_IRQ_DISABLED:
615 int offloaded_data_length = vub300->resp.common.header_size - 3;
616 int register_count = offloaded_data_length >> 3;
618 while (register_count--) {
619 add_offloaded_reg(vub300, &vub300->resp.irq.reg[ri]);
622 mutex_lock(&vub300->irq_mutex);
623 if (vub300->irq_enabled)
624 mmc_signal_sdio_irq(vub300->mmc);
626 vub300->irqs_queued += 1;
627 vub300->irq_disabled = 1;
628 mutex_unlock(&vub300->irq_mutex);
631 case RESPONSE_IRQ_ENABLED:
633 int offloaded_data_length = vub300->resp.common.header_size - 3;
634 int register_count = offloaded_data_length >> 3;
636 while (register_count--) {
637 add_offloaded_reg(vub300, &vub300->resp.irq.reg[ri]);
640 mutex_lock(&vub300->irq_mutex);
641 if (vub300->irq_enabled)
642 mmc_signal_sdio_irq(vub300->mmc);
644 vub300->irqs_queued += 1;
645 vub300->irq_disabled = 0;
646 mutex_unlock(&vub300->irq_mutex);
649 case RESPONSE_NO_INTERRUPT:
650 vub300_queue_poll_work(vub300, 1);
657 static void __do_poll(struct vub300_mmc_host *vub300)
659 /* cmd_mutex is held by vub300_pollwork_thread */
660 unsigned long commretval;
661 mod_timer(&vub300->inactivity_timer, jiffies + HZ);
662 init_completion(&vub300->irqpoll_complete);
663 send_irqpoll(vub300);
664 commretval = wait_for_completion_timeout(&vub300->irqpoll_complete,
665 msecs_to_jiffies(500));
666 if (vub300->usb_transport_fail) {
667 /* no need to do anything */
668 } else if (commretval == 0) {
669 vub300->usb_timed_out = 1;
670 usb_kill_urb(vub300->command_out_urb);
671 usb_kill_urb(vub300->command_res_urb);
672 } else { /* commretval > 0 */
673 __vub300_irqpoll_response(vub300);
677 /* this thread runs only when the driver
678 * is trying to poll the device for an IRQ
680 static void vub300_pollwork_thread(struct work_struct *work)
682 struct vub300_mmc_host *vub300 = container_of(work,
683 struct vub300_mmc_host, pollwork.work);
684 if (!vub300->interface) {
685 kref_put(&vub300->kref, vub300_delete);
688 mutex_lock(&vub300->cmd_mutex);
690 vub300_queue_poll_work(vub300, 1);
691 } else if (!vub300->card_present) {
692 /* no need to do anything */
693 } else { /* vub300->card_present */
694 mutex_lock(&vub300->irq_mutex);
695 if (!vub300->irq_enabled) {
696 mutex_unlock(&vub300->irq_mutex);
697 } else if (vub300->irqs_queued) {
698 vub300->irqs_queued -= 1;
699 mmc_signal_sdio_irq(vub300->mmc);
700 mod_timer(&vub300->inactivity_timer, jiffies + HZ);
701 mutex_unlock(&vub300->irq_mutex);
702 } else { /* NOT vub300->irqs_queued */
703 mutex_unlock(&vub300->irq_mutex);
707 mutex_unlock(&vub300->cmd_mutex);
708 kref_put(&vub300->kref, vub300_delete);
711 static void vub300_deadwork_thread(struct work_struct *work)
713 struct vub300_mmc_host *vub300 =
714 container_of(work, struct vub300_mmc_host, deadwork);
715 if (!vub300->interface) {
716 kref_put(&vub300->kref, vub300_delete);
719 mutex_lock(&vub300->cmd_mutex);
722 * a command got in as the inactivity
723 * timer expired - so we just let the
724 * processing of the command show if
727 } else if (vub300->card_present) {
728 check_vub300_port_status(vub300);
729 } else if (vub300->mmc && vub300->mmc->card) {
731 * the MMC core must not have responded
732 * to the previous indication - lets
733 * hope that it eventually does so we
734 * will just ignore this for now
737 check_vub300_port_status(vub300);
739 mod_timer(&vub300->inactivity_timer, jiffies + HZ);
740 mutex_unlock(&vub300->cmd_mutex);
741 kref_put(&vub300->kref, vub300_delete);
744 static void vub300_inactivity_timer_expired(unsigned long data)
746 struct vub300_mmc_host *vub300 = (struct vub300_mmc_host *)data;
747 if (!vub300->interface) {
748 kref_put(&vub300->kref, vub300_delete);
749 } else if (vub300->cmd) {
750 mod_timer(&vub300->inactivity_timer, jiffies + HZ);
752 vub300_queue_dead_work(vub300);
753 mod_timer(&vub300->inactivity_timer, jiffies + HZ);
757 static int vub300_response_error(u8 error_code)
759 switch (error_code) {
760 case SD_ERROR_PIO_TIMEOUT:
761 case SD_ERROR_1BIT_TIMEOUT:
762 case SD_ERROR_4BIT_TIMEOUT:
764 case SD_ERROR_STAT_DATA:
765 case SD_ERROR_OVERRUN:
766 case SD_ERROR_STAT_CMD:
767 case SD_ERROR_STAT_CMD_TIMEOUT:
768 case SD_ERROR_SDCRDY_STUCK:
769 case SD_ERROR_UNHANDLED:
770 case SD_ERROR_1BIT_CRC_WRONG:
771 case SD_ERROR_4BIT_CRC_WRONG:
772 case SD_ERROR_1BIT_CRC_ERROR:
773 case SD_ERROR_4BIT_CRC_ERROR:
774 case SD_ERROR_NO_CMD_ENDBIT:
775 case SD_ERROR_NO_1BIT_DATEND:
776 case SD_ERROR_NO_4BIT_DATEND:
777 case SD_ERROR_1BIT_DATA_TIMEOUT:
778 case SD_ERROR_4BIT_DATA_TIMEOUT:
779 case SD_ERROR_1BIT_UNEXPECTED_TIMEOUT:
780 case SD_ERROR_4BIT_UNEXPECTED_TIMEOUT:
784 case SD_ERROR_ILLEGAL_COMMAND:
786 case SD_ERROR_NO_DEVICE:
793 static void command_res_completed(struct urb *urb)
794 { /* urb completion handler - hardirq */
795 struct vub300_mmc_host *vub300 = (struct vub300_mmc_host *)urb->context;
797 /* we have to let the initiator handle the error */
798 } else if (vub300->command_res_urb->actual_length == 0) {
800 * we have seen this happen once or twice and
801 * we suspect a buggy USB host controller
803 } else if (!vub300->data) {
804 /* this means that the command (typically CMD52) succeeded */
805 } else if (vub300->resp.common.header_type != 0x02) {
807 * this is an error response from the VUB300 chip
808 * and we let the initiator handle it
810 } else if (vub300->urb) {
812 vub300_response_error(vub300->resp.error.error_code);
813 usb_unlink_urb(vub300->urb);
816 vub300_response_error(vub300->resp.error.error_code);
817 usb_sg_cancel(&vub300->sg_request);
819 complete(&vub300->command_complete); /* got_response_in */
822 static void command_out_completed(struct urb *urb)
823 { /* urb completion handler - hardirq */
824 struct vub300_mmc_host *vub300 = (struct vub300_mmc_host *)urb->context;
826 complete(&vub300->command_complete);
830 usb_rcvbulkpipe(vub300->udev, vub300->cmnd_res_ep);
831 usb_fill_bulk_urb(vub300->command_res_urb, vub300->udev, pipe,
832 &vub300->resp, sizeof(vub300->resp),
833 command_res_completed, vub300);
834 vub300->command_res_urb->actual_length = 0;
835 ret = usb_submit_urb(vub300->command_res_urb, GFP_ATOMIC);
838 * the urb completion handler will call
839 * our completion handler
843 * and thus we only call it directly
844 * when it will not be called
846 complete(&vub300->command_complete);
852 * the STUFF bits are masked out for the comparisons
854 static void snoop_block_size_and_bus_width(struct vub300_mmc_host *vub300,
857 if ((0xFBFFFE00 & cmd_arg) == 0x80022200)
858 vub300->fbs[1] = (cmd_arg << 8) | (0x00FF & vub300->fbs[1]);
859 else if ((0xFBFFFE00 & cmd_arg) == 0x80022000)
860 vub300->fbs[1] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[1]);
861 else if ((0xFBFFFE00 & cmd_arg) == 0x80042200)
862 vub300->fbs[2] = (cmd_arg << 8) | (0x00FF & vub300->fbs[2]);
863 else if ((0xFBFFFE00 & cmd_arg) == 0x80042000)
864 vub300->fbs[2] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[2]);
865 else if ((0xFBFFFE00 & cmd_arg) == 0x80062200)
866 vub300->fbs[3] = (cmd_arg << 8) | (0x00FF & vub300->fbs[3]);
867 else if ((0xFBFFFE00 & cmd_arg) == 0x80062000)
868 vub300->fbs[3] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[3]);
869 else if ((0xFBFFFE00 & cmd_arg) == 0x80082200)
870 vub300->fbs[4] = (cmd_arg << 8) | (0x00FF & vub300->fbs[4]);
871 else if ((0xFBFFFE00 & cmd_arg) == 0x80082000)
872 vub300->fbs[4] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[4]);
873 else if ((0xFBFFFE00 & cmd_arg) == 0x800A2200)
874 vub300->fbs[5] = (cmd_arg << 8) | (0x00FF & vub300->fbs[5]);
875 else if ((0xFBFFFE00 & cmd_arg) == 0x800A2000)
876 vub300->fbs[5] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[5]);
877 else if ((0xFBFFFE00 & cmd_arg) == 0x800C2200)
878 vub300->fbs[6] = (cmd_arg << 8) | (0x00FF & vub300->fbs[6]);
879 else if ((0xFBFFFE00 & cmd_arg) == 0x800C2000)
880 vub300->fbs[6] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[6]);
881 else if ((0xFBFFFE00 & cmd_arg) == 0x800E2200)
882 vub300->fbs[7] = (cmd_arg << 8) | (0x00FF & vub300->fbs[7]);
883 else if ((0xFBFFFE00 & cmd_arg) == 0x800E2000)
884 vub300->fbs[7] = (0xFF & cmd_arg) | (0xFF00 & vub300->fbs[7]);
885 else if ((0xFBFFFE03 & cmd_arg) == 0x80000E00)
886 vub300->bus_width = 1;
887 else if ((0xFBFFFE03 & cmd_arg) == 0x80000E02)
888 vub300->bus_width = 4;
891 static void send_command(struct vub300_mmc_host *vub300)
893 /* cmd_mutex is held by vub300_cmndwork_thread */
894 struct mmc_command *cmd = vub300->cmd;
895 struct mmc_data *data = vub300->data;
899 if (vub300->app_spec) {
900 switch (cmd->opcode) {
902 response_type = SDRT_1;
903 vub300->resp_len = 6;
904 if (0x00000000 == (0x00000003 & cmd->arg))
905 vub300->bus_width = 1;
906 else if (0x00000002 == (0x00000003 & cmd->arg))
907 vub300->bus_width = 4;
909 dev_err(&vub300->udev->dev,
910 "unexpected ACMD6 bus_width=%d\n",
911 0x00000003 & cmd->arg);
914 response_type = SDRT_1;
915 vub300->resp_len = 6;
918 response_type = SDRT_1;
919 vub300->resp_len = 6;
922 response_type = SDRT_1;
923 vub300->resp_len = 6;
926 response_type = SDRT_3;
927 vub300->resp_len = 6;
930 response_type = SDRT_1;
931 vub300->resp_len = 6;
934 response_type = SDRT_1;
935 vub300->resp_len = 6;
938 response_type = SDRT_1;
939 vub300->resp_len = 6;
942 vub300->resp_len = 0;
943 cmd->error = -EINVAL;
944 complete(&vub300->command_complete);
947 vub300->app_spec = 0;
949 switch (cmd->opcode) {
951 response_type = SDRT_NONE;
952 vub300->resp_len = 0;
955 response_type = SDRT_3;
956 vub300->resp_len = 6;
959 response_type = SDRT_2;
960 vub300->resp_len = 17;
963 response_type = SDRT_6;
964 vub300->resp_len = 6;
967 response_type = SDRT_NONE;
968 vub300->resp_len = 0;
971 response_type = SDRT_4;
972 vub300->resp_len = 6;
975 response_type = SDRT_1;
976 vub300->resp_len = 6;
979 response_type = SDRT_1B;
980 vub300->resp_len = 6;
983 response_type = SDRT_7;
984 vub300->resp_len = 6;
987 response_type = SDRT_2;
988 vub300->resp_len = 17;
991 response_type = SDRT_2;
992 vub300->resp_len = 17;
995 response_type = SDRT_1B;
996 vub300->resp_len = 6;
999 response_type = SDRT_1;
1000 vub300->resp_len = 6;
1003 response_type = SDRT_NONE;
1004 vub300->resp_len = 0;
1007 for (i = 0; i < ARRAY_SIZE(vub300->fbs); i++)
1008 vub300->fbs[i] = 0xFFFF & cmd->arg;
1009 response_type = SDRT_1;
1010 vub300->resp_len = 6;
1017 response_type = SDRT_1;
1018 vub300->resp_len = 6;
1022 response_type = SDRT_1B;
1023 vub300->resp_len = 6;
1028 response_type = SDRT_1;
1029 vub300->resp_len = 6;
1032 response_type = SDRT_1B;
1033 vub300->resp_len = 6;
1036 response_type = SDRT_1;
1037 vub300->resp_len = 6;
1040 response_type = SDRT_5;
1041 vub300->resp_len = 6;
1042 snoop_block_size_and_bus_width(vub300, cmd->arg);
1045 response_type = SDRT_5;
1046 vub300->resp_len = 6;
1049 response_type = SDRT_1;
1050 vub300->resp_len = 6;
1051 vub300->app_spec = 1;
1054 response_type = SDRT_1;
1055 vub300->resp_len = 6;
1058 vub300->resp_len = 0;
1059 cmd->error = -EINVAL;
1060 complete(&vub300->command_complete);
1065 * it is a shame that we can not use "sizeof(struct sd_command_header)"
1066 * this is because the packet _must_ be padded to 64 bytes
1068 vub300->cmnd.head.header_size = 20;
1069 vub300->cmnd.head.header_type = 0x00;
1070 vub300->cmnd.head.port_number = 0; /* "0" means port 1 */
1071 vub300->cmnd.head.command_type = 0x00; /* standard read command */
1072 vub300->cmnd.head.response_type = response_type;
1073 vub300->cmnd.head.command_index = cmd->opcode;
1074 vub300->cmnd.head.arguments[0] = cmd->arg >> 24;
1075 vub300->cmnd.head.arguments[1] = cmd->arg >> 16;
1076 vub300->cmnd.head.arguments[2] = cmd->arg >> 8;
1077 vub300->cmnd.head.arguments[3] = cmd->arg >> 0;
1078 if (cmd->opcode == 52) {
1079 int fn = 0x7 & (cmd->arg >> 28);
1080 vub300->cmnd.head.block_count[0] = 0;
1081 vub300->cmnd.head.block_count[1] = 0;
1082 vub300->cmnd.head.block_size[0] = (vub300->fbs[fn] >> 8) & 0xFF;
1083 vub300->cmnd.head.block_size[1] = (vub300->fbs[fn] >> 0) & 0xFF;
1084 vub300->cmnd.head.command_type = 0x00;
1085 vub300->cmnd.head.transfer_size[0] = 0;
1086 vub300->cmnd.head.transfer_size[1] = 0;
1087 vub300->cmnd.head.transfer_size[2] = 0;
1088 vub300->cmnd.head.transfer_size[3] = 0;
1090 vub300->cmnd.head.block_count[0] = 0;
1091 vub300->cmnd.head.block_count[1] = 0;
1092 vub300->cmnd.head.block_size[0] = (vub300->fbs[0] >> 8) & 0xFF;
1093 vub300->cmnd.head.block_size[1] = (vub300->fbs[0] >> 0) & 0xFF;
1094 vub300->cmnd.head.command_type = 0x00;
1095 vub300->cmnd.head.transfer_size[0] = 0;
1096 vub300->cmnd.head.transfer_size[1] = 0;
1097 vub300->cmnd.head.transfer_size[2] = 0;
1098 vub300->cmnd.head.transfer_size[3] = 0;
1099 } else if (cmd->opcode == 53) {
1100 int fn = 0x7 & (cmd->arg >> 28);
1101 if (0x08 & vub300->cmnd.head.arguments[0]) { /* BLOCK MODE */
1102 vub300->cmnd.head.block_count[0] =
1103 (data->blocks >> 8) & 0xFF;
1104 vub300->cmnd.head.block_count[1] =
1105 (data->blocks >> 0) & 0xFF;
1106 vub300->cmnd.head.block_size[0] =
1107 (data->blksz >> 8) & 0xFF;
1108 vub300->cmnd.head.block_size[1] =
1109 (data->blksz >> 0) & 0xFF;
1110 } else { /* BYTE MODE */
1111 vub300->cmnd.head.block_count[0] = 0;
1112 vub300->cmnd.head.block_count[1] = 0;
1113 vub300->cmnd.head.block_size[0] =
1114 (vub300->datasize >> 8) & 0xFF;
1115 vub300->cmnd.head.block_size[1] =
1116 (vub300->datasize >> 0) & 0xFF;
1118 vub300->cmnd.head.command_type =
1119 (MMC_DATA_READ & data->flags) ? 0x00 : 0x80;
1120 vub300->cmnd.head.transfer_size[0] =
1121 (vub300->datasize >> 24) & 0xFF;
1122 vub300->cmnd.head.transfer_size[1] =
1123 (vub300->datasize >> 16) & 0xFF;
1124 vub300->cmnd.head.transfer_size[2] =
1125 (vub300->datasize >> 8) & 0xFF;
1126 vub300->cmnd.head.transfer_size[3] =
1127 (vub300->datasize >> 0) & 0xFF;
1128 if (vub300->datasize < vub300->fbs[fn]) {
1129 vub300->cmnd.head.block_count[0] = 0;
1130 vub300->cmnd.head.block_count[1] = 0;
1133 vub300->cmnd.head.block_count[0] = (data->blocks >> 8) & 0xFF;
1134 vub300->cmnd.head.block_count[1] = (data->blocks >> 0) & 0xFF;
1135 vub300->cmnd.head.block_size[0] = (data->blksz >> 8) & 0xFF;
1136 vub300->cmnd.head.block_size[1] = (data->blksz >> 0) & 0xFF;
1137 vub300->cmnd.head.command_type =
1138 (MMC_DATA_READ & data->flags) ? 0x00 : 0x80;
1139 vub300->cmnd.head.transfer_size[0] =
1140 (vub300->datasize >> 24) & 0xFF;
1141 vub300->cmnd.head.transfer_size[1] =
1142 (vub300->datasize >> 16) & 0xFF;
1143 vub300->cmnd.head.transfer_size[2] =
1144 (vub300->datasize >> 8) & 0xFF;
1145 vub300->cmnd.head.transfer_size[3] =
1146 (vub300->datasize >> 0) & 0xFF;
1147 if (vub300->datasize < vub300->fbs[0]) {
1148 vub300->cmnd.head.block_count[0] = 0;
1149 vub300->cmnd.head.block_count[1] = 0;
1152 if (vub300->cmnd.head.block_size[0] || vub300->cmnd.head.block_size[1]) {
1153 u16 block_size = vub300->cmnd.head.block_size[1] |
1154 (vub300->cmnd.head.block_size[0] << 8);
1155 u16 block_boundary = FIRMWARE_BLOCK_BOUNDARY -
1156 (FIRMWARE_BLOCK_BOUNDARY % block_size);
1157 vub300->cmnd.head.block_boundary[0] =
1158 (block_boundary >> 8) & 0xFF;
1159 vub300->cmnd.head.block_boundary[1] =
1160 (block_boundary >> 0) & 0xFF;
1162 vub300->cmnd.head.block_boundary[0] = 0;
1163 vub300->cmnd.head.block_boundary[1] = 0;
1165 usb_fill_bulk_urb(vub300->command_out_urb, vub300->udev,
1166 usb_sndbulkpipe(vub300->udev, vub300->cmnd_out_ep),
1167 &vub300->cmnd, sizeof(vub300->cmnd),
1168 command_out_completed, vub300);
1169 retval = usb_submit_urb(vub300->command_out_urb, GFP_KERNEL);
1171 cmd->error = retval;
1172 complete(&vub300->command_complete);
1180 * timer callback runs in atomic mode
1181 * so it cannot call usb_kill_urb()
1183 static void vub300_sg_timed_out(unsigned long data)
1185 struct vub300_mmc_host *vub300 = (struct vub300_mmc_host *)data;
1186 vub300->usb_timed_out = 1;
1187 usb_sg_cancel(&vub300->sg_request);
1188 usb_unlink_urb(vub300->command_out_urb);
1189 usb_unlink_urb(vub300->command_res_urb);
1192 static u16 roundup_to_multiple_of_64(u16 number)
1194 return 0xFFC0 & (0x3F + number);
1198 * this is a separate function to solve the 80 column width restriction
1200 static void __download_offload_pseudocode(struct vub300_mmc_host *vub300,
1201 const struct firmware *fw)
1203 u8 register_count = 0;
1205 u16 interrupt_size = 0;
1206 const u8 *data = fw->data;
1207 int size = fw->size;
1209 dev_info(&vub300->udev->dev, "using %s for SDIO offload processing\n",
1213 } while (size-- && c); /* skip comment */
1214 dev_info(&vub300->udev->dev, "using offload firmware %s %s\n", fw->data,
1217 dev_err(&vub300->udev->dev,
1218 "corrupt offload pseudocode in firmware %s\n",
1220 strncpy(vub300->vub_name, "corrupt offload pseudocode",
1221 sizeof(vub300->vub_name));
1224 interrupt_size += *data++;
1226 interrupt_size <<= 8;
1227 interrupt_size += *data++;
1229 if (interrupt_size < size) {
1230 u16 xfer_length = roundup_to_multiple_of_64(interrupt_size);
1231 u8 *xfer_buffer = kmalloc(xfer_length, GFP_KERNEL);
1234 memcpy(xfer_buffer, data, interrupt_size);
1235 memset(xfer_buffer + interrupt_size, 0,
1236 xfer_length - interrupt_size);
1237 size -= interrupt_size;
1238 data += interrupt_size;
1240 usb_control_msg(vub300->udev,
1241 usb_sndctrlpipe(vub300->udev, 0),
1242 SET_INTERRUPT_PSEUDOCODE,
1243 USB_DIR_OUT | USB_TYPE_VENDOR |
1244 USB_RECIP_DEVICE, 0x0000, 0x0000,
1245 xfer_buffer, xfer_length, HZ);
1248 strncpy(vub300->vub_name,
1249 "SDIO pseudocode download failed",
1250 sizeof(vub300->vub_name));
1254 dev_err(&vub300->udev->dev,
1255 "not enough memory for xfer buffer to send"
1256 " INTERRUPT_PSEUDOCODE for %s %s\n", fw->data,
1258 strncpy(vub300->vub_name,
1259 "SDIO interrupt pseudocode download failed",
1260 sizeof(vub300->vub_name));
1264 dev_err(&vub300->udev->dev,
1265 "corrupt interrupt pseudocode in firmware %s %s\n",
1266 fw->data, vub300->vub_name);
1267 strncpy(vub300->vub_name, "corrupt interrupt pseudocode",
1268 sizeof(vub300->vub_name));
1277 u16 xfer_length = roundup_to_multiple_of_64(ts);
1278 u8 *xfer_buffer = kmalloc(xfer_length, GFP_KERNEL);
1281 memcpy(xfer_buffer, data, ts);
1282 memset(xfer_buffer + ts, 0,
1287 usb_control_msg(vub300->udev,
1288 usb_sndctrlpipe(vub300->udev, 0),
1289 SET_TRANSFER_PSEUDOCODE,
1290 USB_DIR_OUT | USB_TYPE_VENDOR |
1291 USB_RECIP_DEVICE, 0x0000, 0x0000,
1292 xfer_buffer, xfer_length, HZ);
1295 strncpy(vub300->vub_name,
1296 "SDIO pseudocode download failed",
1297 sizeof(vub300->vub_name));
1301 dev_err(&vub300->udev->dev,
1302 "not enough memory for xfer buffer to send"
1303 " TRANSFER_PSEUDOCODE for %s %s\n", fw->data,
1305 strncpy(vub300->vub_name,
1306 "SDIO transfer pseudocode download failed",
1307 sizeof(vub300->vub_name));
1311 dev_err(&vub300->udev->dev,
1312 "corrupt transfer pseudocode in firmware %s %s\n",
1313 fw->data, vub300->vub_name);
1314 strncpy(vub300->vub_name, "corrupt transfer pseudocode",
1315 sizeof(vub300->vub_name));
1318 register_count += *data++;
1320 if (register_count * 4 == size) {
1321 int I = vub300->dynamic_register_count = register_count;
1324 unsigned int func_num = 0;
1325 vub300->sdio_register[i].func_num = *data++;
1327 func_num += *data++;
1330 func_num += *data++;
1333 func_num += *data++;
1335 vub300->sdio_register[i].sdio_reg = func_num;
1336 vub300->sdio_register[i].activate = 1;
1337 vub300->sdio_register[i].prepared = 0;
1340 dev_info(&vub300->udev->dev,
1341 "initialized %d dynamic pseudocode registers\n",
1342 vub300->dynamic_register_count);
1345 dev_err(&vub300->udev->dev,
1346 "corrupt dynamic registers in firmware %s\n",
1348 strncpy(vub300->vub_name, "corrupt dynamic registers",
1349 sizeof(vub300->vub_name));
1355 * if the binary containing the EMPTY PseudoCode can not be found
1356 * vub300->vub_name is set anyway in order to prevent an automatic retry
1358 static void download_offload_pseudocode(struct vub300_mmc_host *vub300)
1360 struct mmc_card *card = vub300->mmc->card;
1361 int sdio_funcs = card->sdio_funcs;
1362 const struct firmware *fw = NULL;
1363 int l = snprintf(vub300->vub_name, sizeof(vub300->vub_name),
1364 "vub_%04X%04X", card->cis.vendor, card->cis.device);
1367 for (n = 0; n < sdio_funcs; n++) {
1368 struct sdio_func *sf = card->sdio_func[n];
1369 l += snprintf(vub300->vub_name + l,
1370 sizeof(vub300->vub_name) - l, "_%04X%04X",
1371 sf->vendor, sf->device);
1373 snprintf(vub300->vub_name + l, sizeof(vub300->vub_name) - l, ".bin");
1374 dev_info(&vub300->udev->dev, "requesting offload firmware %s\n",
1376 retval = request_firmware(&fw, vub300->vub_name, &card->dev);
1378 strncpy(vub300->vub_name, "vub_default.bin",
1379 sizeof(vub300->vub_name));
1380 retval = request_firmware(&fw, vub300->vub_name, &card->dev);
1382 strncpy(vub300->vub_name,
1383 "no SDIO offload firmware found",
1384 sizeof(vub300->vub_name));
1386 __download_offload_pseudocode(vub300, fw);
1387 release_firmware(fw);
1390 __download_offload_pseudocode(vub300, fw);
1391 release_firmware(fw);
1395 static void vub300_usb_bulk_msg_completion(struct urb *urb)
1396 { /* urb completion handler - hardirq */
1397 complete((struct completion *)urb->context);
1400 static int vub300_usb_bulk_msg(struct vub300_mmc_host *vub300,
1401 unsigned int pipe, void *data, int len,
1402 int *actual_length, int timeout_msecs)
1404 /* cmd_mutex is held by vub300_cmndwork_thread */
1405 struct usb_device *usb_dev = vub300->udev;
1406 struct completion done;
1408 vub300->urb = usb_alloc_urb(0, GFP_KERNEL);
1411 usb_fill_bulk_urb(vub300->urb, usb_dev, pipe, data, len,
1412 vub300_usb_bulk_msg_completion, NULL);
1413 init_completion(&done);
1414 vub300->urb->context = &done;
1415 vub300->urb->actual_length = 0;
1416 retval = usb_submit_urb(vub300->urb, GFP_KERNEL);
1417 if (unlikely(retval))
1419 if (!wait_for_completion_timeout
1420 (&done, msecs_to_jiffies(timeout_msecs))) {
1421 retval = -ETIMEDOUT;
1422 usb_kill_urb(vub300->urb);
1424 retval = vub300->urb->status;
1427 *actual_length = vub300->urb->actual_length;
1428 usb_free_urb(vub300->urb);
1433 static int __command_read_data(struct vub300_mmc_host *vub300,
1434 struct mmc_command *cmd, struct mmc_data *data)
1436 /* cmd_mutex is held by vub300_cmndwork_thread */
1437 int linear_length = vub300->datasize;
1438 int padded_length = vub300->large_usb_packets ?
1439 ((511 + linear_length) >> 9) << 9 :
1440 ((63 + linear_length) >> 6) << 6;
1441 if ((padded_length == linear_length) || !pad_input_to_usb_pkt) {
1444 pipe = usb_rcvbulkpipe(vub300->udev, vub300->data_inp_ep);
1445 result = usb_sg_init(&vub300->sg_request, vub300->udev,
1447 data->sg_len, 0, GFP_KERNEL);
1449 usb_unlink_urb(vub300->command_out_urb);
1450 usb_unlink_urb(vub300->command_res_urb);
1451 cmd->error = result;
1452 data->bytes_xfered = 0;
1455 vub300->sg_transfer_timer.expires =
1456 jiffies + msecs_to_jiffies(2000 +
1457 (linear_length / 16384));
1458 add_timer(&vub300->sg_transfer_timer);
1459 usb_sg_wait(&vub300->sg_request);
1460 del_timer(&vub300->sg_transfer_timer);
1461 if (vub300->sg_request.status < 0) {
1462 cmd->error = vub300->sg_request.status;
1463 data->bytes_xfered = 0;
1466 data->bytes_xfered = vub300->datasize;
1467 return linear_length;
1471 u8 *buf = kmalloc(padded_length, GFP_KERNEL);
1474 unsigned pipe = usb_rcvbulkpipe(vub300->udev,
1475 vub300->data_inp_ep);
1476 int actual_length = 0;
1477 result = vub300_usb_bulk_msg(vub300, pipe, buf,
1478 padded_length, &actual_length,
1479 2000 + (padded_length / 16384));
1481 cmd->error = result;
1482 data->bytes_xfered = 0;
1485 } else if (actual_length < linear_length) {
1486 cmd->error = -EREMOTEIO;
1487 data->bytes_xfered = 0;
1491 sg_copy_from_buffer(data->sg, data->sg_len, buf,
1494 data->bytes_xfered = vub300->datasize;
1495 return linear_length;
1498 cmd->error = -ENOMEM;
1499 data->bytes_xfered = 0;
1505 static int __command_write_data(struct vub300_mmc_host *vub300,
1506 struct mmc_command *cmd, struct mmc_data *data)
1508 /* cmd_mutex is held by vub300_cmndwork_thread */
1509 unsigned pipe = usb_sndbulkpipe(vub300->udev, vub300->data_out_ep);
1510 int linear_length = vub300->datasize;
1511 int modulo_64_length = linear_length & 0x003F;
1512 int modulo_512_length = linear_length & 0x01FF;
1513 if (linear_length < 64) {
1516 sg_copy_to_buffer(data->sg, data->sg_len,
1517 vub300->padded_buffer,
1518 sizeof(vub300->padded_buffer));
1519 memset(vub300->padded_buffer + linear_length, 0,
1520 sizeof(vub300->padded_buffer) - linear_length);
1521 result = vub300_usb_bulk_msg(vub300, pipe, vub300->padded_buffer,
1522 sizeof(vub300->padded_buffer),
1523 &actual_length, 2000 +
1524 (sizeof(vub300->padded_buffer) /
1527 cmd->error = result;
1528 data->bytes_xfered = 0;
1530 data->bytes_xfered = vub300->datasize;
1532 } else if ((!vub300->large_usb_packets && (0 < modulo_64_length)) ||
1533 (vub300->large_usb_packets && (64 > modulo_512_length))
1534 ) { /* don't you just love these work-rounds */
1535 int padded_length = ((63 + linear_length) >> 6) << 6;
1536 u8 *buf = kmalloc(padded_length, GFP_KERNEL);
1540 sg_copy_to_buffer(data->sg, data->sg_len, buf,
1542 memset(buf + linear_length, 0,
1543 padded_length - linear_length);
1545 vub300_usb_bulk_msg(vub300, pipe, buf,
1546 padded_length, &actual_length,
1547 2000 + padded_length / 16384);
1550 cmd->error = result;
1551 data->bytes_xfered = 0;
1553 data->bytes_xfered = vub300->datasize;
1556 cmd->error = -ENOMEM;
1557 data->bytes_xfered = 0;
1559 } else { /* no data padding required */
1561 unsigned char buf[64 * 4];
1562 sg_copy_to_buffer(data->sg, data->sg_len, buf, sizeof(buf));
1563 result = usb_sg_init(&vub300->sg_request, vub300->udev,
1565 data->sg_len, 0, GFP_KERNEL);
1567 usb_unlink_urb(vub300->command_out_urb);
1568 usb_unlink_urb(vub300->command_res_urb);
1569 cmd->error = result;
1570 data->bytes_xfered = 0;
1572 vub300->sg_transfer_timer.expires =
1573 jiffies + msecs_to_jiffies(2000 +
1574 linear_length / 16384);
1575 add_timer(&vub300->sg_transfer_timer);
1576 usb_sg_wait(&vub300->sg_request);
1578 data->bytes_xfered = 0;
1580 del_timer(&vub300->sg_transfer_timer);
1581 if (vub300->sg_request.status < 0) {
1582 cmd->error = vub300->sg_request.status;
1583 data->bytes_xfered = 0;
1585 data->bytes_xfered = vub300->datasize;
1590 return linear_length;
1593 static void __vub300_command_response(struct vub300_mmc_host *vub300,
1594 struct mmc_command *cmd,
1595 struct mmc_data *data, int data_length)
1597 /* cmd_mutex is held by vub300_cmndwork_thread */
1599 int msec_timeout = 1000 + data_length / 4;
1601 wait_for_completion_timeout(&vub300->command_complete,
1602 msecs_to_jiffies(msec_timeout));
1603 if (respretval == 0) { /* TIMED OUT */
1604 /* we don't know which of "out" and "res" if any failed */
1606 vub300->usb_timed_out = 1;
1607 usb_kill_urb(vub300->command_out_urb);
1608 usb_kill_urb(vub300->command_res_urb);
1609 cmd->error = -ETIMEDOUT;
1610 result = usb_lock_device_for_reset(vub300->udev,
1613 result = usb_reset_device(vub300->udev);
1614 usb_unlock_device(vub300->udev);
1616 } else if (respretval < 0) {
1617 /* we don't know which of "out" and "res" if any failed */
1618 usb_kill_urb(vub300->command_out_urb);
1619 usb_kill_urb(vub300->command_res_urb);
1620 cmd->error = respretval;
1621 } else if (cmd->error) {
1623 * the error occurred sending the command
1624 * or receiving the response
1626 } else if (vub300->command_out_urb->status) {
1627 vub300->usb_transport_fail = vub300->command_out_urb->status;
1628 cmd->error = -EPROTO == vub300->command_out_urb->status ?
1629 -ESHUTDOWN : vub300->command_out_urb->status;
1630 } else if (vub300->command_res_urb->status) {
1631 vub300->usb_transport_fail = vub300->command_res_urb->status;
1632 cmd->error = -EPROTO == vub300->command_res_urb->status ?
1633 -ESHUTDOWN : vub300->command_res_urb->status;
1634 } else if (vub300->resp.common.header_type == 0x00) {
1636 * the command completed successfully
1637 * and there was no piggybacked data
1639 } else if (vub300->resp.common.header_type == RESPONSE_ERROR) {
1641 vub300_response_error(vub300->resp.error.error_code);
1643 usb_sg_cancel(&vub300->sg_request);
1644 } else if (vub300->resp.common.header_type == RESPONSE_PIGGYBACKED) {
1645 int offloaded_data_length =
1646 vub300->resp.common.header_size -
1647 sizeof(struct sd_register_header);
1648 int register_count = offloaded_data_length >> 3;
1650 while (register_count--) {
1651 add_offloaded_reg(vub300, &vub300->resp.pig.reg[ri]);
1654 vub300->resp.common.header_size =
1655 sizeof(struct sd_register_header);
1656 vub300->resp.common.header_type = 0x00;
1658 } else if (vub300->resp.common.header_type == RESPONSE_PIG_DISABLED) {
1659 int offloaded_data_length =
1660 vub300->resp.common.header_size -
1661 sizeof(struct sd_register_header);
1662 int register_count = offloaded_data_length >> 3;
1664 while (register_count--) {
1665 add_offloaded_reg(vub300, &vub300->resp.pig.reg[ri]);
1668 mutex_lock(&vub300->irq_mutex);
1669 if (vub300->irqs_queued) {
1670 vub300->irqs_queued += 1;
1671 } else if (vub300->irq_enabled) {
1672 vub300->irqs_queued += 1;
1673 vub300_queue_poll_work(vub300, 0);
1675 vub300->irqs_queued += 1;
1677 vub300->irq_disabled = 1;
1678 mutex_unlock(&vub300->irq_mutex);
1679 vub300->resp.common.header_size =
1680 sizeof(struct sd_register_header);
1681 vub300->resp.common.header_type = 0x00;
1683 } else if (vub300->resp.common.header_type == RESPONSE_PIG_ENABLED) {
1684 int offloaded_data_length =
1685 vub300->resp.common.header_size -
1686 sizeof(struct sd_register_header);
1687 int register_count = offloaded_data_length >> 3;
1689 while (register_count--) {
1690 add_offloaded_reg(vub300, &vub300->resp.pig.reg[ri]);
1693 mutex_lock(&vub300->irq_mutex);
1694 if (vub300->irqs_queued) {
1695 vub300->irqs_queued += 1;
1696 } else if (vub300->irq_enabled) {
1697 vub300->irqs_queued += 1;
1698 vub300_queue_poll_work(vub300, 0);
1700 vub300->irqs_queued += 1;
1702 vub300->irq_disabled = 0;
1703 mutex_unlock(&vub300->irq_mutex);
1704 vub300->resp.common.header_size =
1705 sizeof(struct sd_register_header);
1706 vub300->resp.common.header_type = 0x00;
1709 cmd->error = -EINVAL;
1713 static void construct_request_response(struct vub300_mmc_host *vub300,
1714 struct mmc_command *cmd)
1716 int resp_len = vub300->resp_len;
1717 int less_cmd = (17 == resp_len) ? resp_len : resp_len - 1;
1718 int bytes = 3 & less_cmd;
1719 int words = less_cmd >> 2;
1720 u8 *r = vub300->resp.response.command_response;
1722 cmd->resp[words] = (r[1 + (words << 2)] << 24)
1723 | (r[2 + (words << 2)] << 16)
1724 | (r[3 + (words << 2)] << 8);
1725 } else if (bytes == 2) {
1726 cmd->resp[words] = (r[1 + (words << 2)] << 24)
1727 | (r[2 + (words << 2)] << 16);
1728 } else if (bytes == 1) {
1729 cmd->resp[words] = (r[1 + (words << 2)] << 24);
1731 while (words-- > 0) {
1732 cmd->resp[words] = (r[1 + (words << 2)] << 24)
1733 | (r[2 + (words << 2)] << 16)
1734 | (r[3 + (words << 2)] << 8)
1735 | (r[4 + (words << 2)] << 0);
1737 if ((cmd->opcode == 53) && (0x000000FF & cmd->resp[0]))
1738 cmd->resp[0] &= 0xFFFFFF00;
1741 /* this thread runs only when there is an upper level command req outstanding */
1742 static void vub300_cmndwork_thread(struct work_struct *work)
1744 struct vub300_mmc_host *vub300 =
1745 container_of(work, struct vub300_mmc_host, cmndwork);
1746 if (!vub300->interface) {
1747 kref_put(&vub300->kref, vub300_delete);
1750 struct mmc_request *req = vub300->req;
1751 struct mmc_command *cmd = vub300->cmd;
1752 struct mmc_data *data = vub300->data;
1754 mutex_lock(&vub300->cmd_mutex);
1755 init_completion(&vub300->command_complete);
1756 if (likely(vub300->vub_name[0]) || !vub300->mmc->card) {
1758 * the name of the EMPTY Pseudo firmware file
1759 * is used as a flag to indicate that the file
1760 * has been already downloaded to the VUB300 chip
1762 } else if (0 == vub300->mmc->card->sdio_funcs) {
1763 strncpy(vub300->vub_name, "SD memory device",
1764 sizeof(vub300->vub_name));
1766 download_offload_pseudocode(vub300);
1768 send_command(vub300);
1771 else if (MMC_DATA_READ & data->flags)
1772 data_length = __command_read_data(vub300, cmd, data);
1774 data_length = __command_write_data(vub300, cmd, data);
1775 __vub300_command_response(vub300, cmd, data, data_length);
1778 vub300->data = NULL;
1780 if (cmd->error == -ENOMEDIUM)
1781 check_vub300_port_status(vub300);
1782 mutex_unlock(&vub300->cmd_mutex);
1783 mmc_request_done(vub300->mmc, req);
1784 kref_put(&vub300->kref, vub300_delete);
1787 construct_request_response(vub300, cmd);
1788 vub300->resp_len = 0;
1789 mutex_unlock(&vub300->cmd_mutex);
1790 kref_put(&vub300->kref, vub300_delete);
1791 mmc_request_done(vub300->mmc, req);
1797 static int examine_cyclic_buffer(struct vub300_mmc_host *vub300,
1798 struct mmc_command *cmd, u8 Function)
1800 /* cmd_mutex is held by vub300_mmc_request */
1801 u8 cmd0 = 0xFF & (cmd->arg >> 24);
1802 u8 cmd1 = 0xFF & (cmd->arg >> 16);
1803 u8 cmd2 = 0xFF & (cmd->arg >> 8);
1804 u8 cmd3 = 0xFF & (cmd->arg >> 0);
1805 int first = MAXREGMASK & vub300->fn[Function].offload_point;
1806 struct offload_registers_access *rf = &vub300->fn[Function].reg[first];
1807 if (cmd0 == rf->command_byte[0] &&
1808 cmd1 == rf->command_byte[1] &&
1809 cmd2 == rf->command_byte[2] &&
1810 cmd3 == rf->command_byte[3]) {
1812 cmd->resp[1] = checksum << 24;
1813 cmd->resp[0] = (rf->Respond_Byte[0] << 24)
1814 | (rf->Respond_Byte[1] << 16)
1815 | (rf->Respond_Byte[2] << 8)
1816 | (rf->Respond_Byte[3] << 0);
1817 vub300->fn[Function].offload_point += 1;
1818 vub300->fn[Function].offload_count -= 1;
1819 vub300->total_offload_count -= 1;
1822 int delta = 1; /* because it does not match the first one */
1823 u8 register_count = vub300->fn[Function].offload_count - 1;
1824 u32 register_point = vub300->fn[Function].offload_point + 1;
1825 while (0 < register_count) {
1826 int point = MAXREGMASK & register_point;
1827 struct offload_registers_access *r =
1828 &vub300->fn[Function].reg[point];
1829 if (cmd0 == r->command_byte[0] &&
1830 cmd1 == r->command_byte[1] &&
1831 cmd2 == r->command_byte[2] &&
1832 cmd3 == r->command_byte[3]) {
1834 cmd->resp[1] = checksum << 24;
1835 cmd->resp[0] = (r->Respond_Byte[0] << 24)
1836 | (r->Respond_Byte[1] << 16)
1837 | (r->Respond_Byte[2] << 8)
1838 | (r->Respond_Byte[3] << 0);
1839 vub300->fn[Function].offload_point += delta;
1840 vub300->fn[Function].offload_count -= delta;
1841 vub300->total_offload_count -= delta;
1844 register_point += 1;
1845 register_count -= 1;
1854 static int satisfy_request_from_offloaded_data(struct vub300_mmc_host *vub300,
1855 struct mmc_command *cmd)
1857 /* cmd_mutex is held by vub300_mmc_request */
1858 u8 regs = vub300->dynamic_register_count;
1862 while (0 < regs--) {
1863 if ((vub300->sdio_register[i].func_num == func) &&
1864 (vub300->sdio_register[i].sdio_reg == reg)) {
1865 if (!vub300->sdio_register[i].prepared) {
1867 } else if ((0x80000000 & cmd->arg) == 0x80000000) {
1869 * a write to a dynamic register
1870 * nullifies our offloaded value
1872 vub300->sdio_register[i].prepared = 0;
1878 u8 rsp2 = vub300->sdio_register[i].response;
1879 u8 rsp3 = vub300->sdio_register[i].regvalue;
1880 vub300->sdio_register[i].prepared = 0;
1881 cmd->resp[1] = checksum << 24;
1882 cmd->resp[0] = (rsp0 << 24)
1893 if (vub300->total_offload_count == 0)
1895 else if (vub300->fn[func].offload_count == 0)
1898 return examine_cyclic_buffer(vub300, cmd, func);
1901 static void vub300_mmc_request(struct mmc_host *mmc, struct mmc_request *req)
1903 struct mmc_command *cmd = req->cmd;
1904 struct vub300_mmc_host *vub300 = mmc_priv(mmc);
1905 if (!vub300->interface) {
1906 cmd->error = -ESHUTDOWN;
1907 mmc_request_done(mmc, req);
1910 struct mmc_data *data = req->data;
1911 if (!vub300->card_powered) {
1912 cmd->error = -ENOMEDIUM;
1913 mmc_request_done(mmc, req);
1916 if (!vub300->card_present) {
1917 cmd->error = -ENOMEDIUM;
1918 mmc_request_done(mmc, req);
1921 if (vub300->usb_transport_fail) {
1922 cmd->error = vub300->usb_transport_fail;
1923 mmc_request_done(mmc, req);
1926 if (!vub300->interface) {
1927 cmd->error = -ENODEV;
1928 mmc_request_done(mmc, req);
1931 kref_get(&vub300->kref);
1932 mutex_lock(&vub300->cmd_mutex);
1933 mod_timer(&vub300->inactivity_timer, jiffies + HZ);
1935 * for performance we have to return immediately
1936 * if the requested data has been offloaded
1938 if (cmd->opcode == 52 &&
1939 satisfy_request_from_offloaded_data(vub300, cmd)) {
1941 mutex_unlock(&vub300->cmd_mutex);
1942 kref_put(&vub300->kref, vub300_delete);
1943 mmc_request_done(mmc, req);
1948 vub300->data = data;
1950 vub300->datasize = data->blksz * data->blocks;
1952 vub300->datasize = 0;
1953 vub300_queue_cmnd_work(vub300);
1954 mutex_unlock(&vub300->cmd_mutex);
1955 kref_put(&vub300->kref, vub300_delete);
1957 * the kernel lock diagnostics complain
1958 * if the cmd_mutex * is "passed on"
1959 * to the cmndwork thread,
1960 * so we must release it now
1961 * and re-acquire it in the cmndwork thread
1967 static void __set_clock_speed(struct vub300_mmc_host *vub300, u8 buf[8],
1968 struct mmc_ios *ios)
1970 int buf_array_size = 8; /* ARRAY_SIZE(buf) does not work !!! */
1973 if (ios->clock >= 48000000)
1975 else if (ios->clock >= 24000000)
1977 else if (ios->clock >= 20000000)
1979 else if (ios->clock >= 15000000)
1981 else if (ios->clock >= 200000)
1988 for (i = 0; i < buf_array_size; i++) {
1994 usb_control_msg(vub300->udev, usb_sndctrlpipe(vub300->udev, 0),
1996 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1997 0x00, 0x00, buf, buf_array_size, HZ);
1999 dev_err(&vub300->udev->dev, "SET_CLOCK_SPEED"
2000 " %dkHz failed with retval=%d\n", kHzClock, retval);
2002 dev_dbg(&vub300->udev->dev, "SET_CLOCK_SPEED"
2003 " %dkHz\n", kHzClock);
2007 static void vub300_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
2009 struct vub300_mmc_host *vub300 = mmc_priv(mmc);
2010 if (!vub300->interface)
2012 kref_get(&vub300->kref);
2013 mutex_lock(&vub300->cmd_mutex);
2014 if ((ios->power_mode == MMC_POWER_OFF) && vub300->card_powered) {
2015 vub300->card_powered = 0;
2016 usb_control_msg(vub300->udev, usb_sndctrlpipe(vub300->udev, 0),
2018 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
2019 0x0000, 0x0000, NULL, 0, HZ);
2020 /* must wait for the VUB300 u-proc to boot up */
2022 } else if ((ios->power_mode == MMC_POWER_UP) && !vub300->card_powered) {
2023 usb_control_msg(vub300->udev, usb_sndctrlpipe(vub300->udev, 0),
2025 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
2026 0x0001, 0x0000, NULL, 0, HZ);
2028 vub300->card_powered = 1;
2029 } else if (ios->power_mode == MMC_POWER_ON) {
2030 u8 *buf = kmalloc(8, GFP_KERNEL);
2032 __set_clock_speed(vub300, buf, ios);
2036 /* this should mean no change of state */
2038 mutex_unlock(&vub300->cmd_mutex);
2039 kref_put(&vub300->kref, vub300_delete);
2042 static int vub300_mmc_get_ro(struct mmc_host *mmc)
2044 struct vub300_mmc_host *vub300 = mmc_priv(mmc);
2045 return vub300->read_only;
2048 static void vub300_enable_sdio_irq(struct mmc_host *mmc, int enable)
2050 struct vub300_mmc_host *vub300 = mmc_priv(mmc);
2051 if (!vub300->interface)
2053 kref_get(&vub300->kref);
2055 mutex_lock(&vub300->irq_mutex);
2056 if (vub300->irqs_queued) {
2057 vub300->irqs_queued -= 1;
2058 mmc_signal_sdio_irq(vub300->mmc);
2059 } else if (vub300->irq_disabled) {
2060 vub300->irq_disabled = 0;
2061 vub300->irq_enabled = 1;
2062 vub300_queue_poll_work(vub300, 0);
2063 } else if (vub300->irq_enabled) {
2064 /* this should not happen, so we will just ignore it */
2066 vub300->irq_enabled = 1;
2067 vub300_queue_poll_work(vub300, 0);
2069 mutex_unlock(&vub300->irq_mutex);
2071 vub300->irq_enabled = 0;
2073 kref_put(&vub300->kref, vub300_delete);
2076 static void vub300_init_card(struct mmc_host *mmc, struct mmc_card *card)
2078 struct vub300_mmc_host *vub300 = mmc_priv(mmc);
2079 dev_info(&vub300->udev->dev, "NO host QUIRKS for this card\n");
2082 static struct mmc_host_ops vub300_mmc_ops = {
2083 .request = vub300_mmc_request,
2084 .set_ios = vub300_mmc_set_ios,
2085 .get_ro = vub300_mmc_get_ro,
2086 .enable_sdio_irq = vub300_enable_sdio_irq,
2087 .init_card = vub300_init_card,
2090 static int vub300_probe(struct usb_interface *interface,
2091 const struct usb_device_id *id)
2093 struct vub300_mmc_host *vub300;
2094 struct usb_host_interface *iface_desc;
2095 struct usb_device *udev = usb_get_dev(interface_to_usbdev(interface));
2097 int retval = -ENOMEM;
2098 struct urb *command_out_urb;
2099 struct urb *command_res_urb;
2100 struct mmc_host *mmc;
2101 char manufacturer[48];
2103 char serial_number[32];
2104 usb_string(udev, udev->descriptor.iManufacturer, manufacturer,
2105 sizeof(manufacturer));
2106 usb_string(udev, udev->descriptor.iProduct, product, sizeof(product));
2107 usb_string(udev, udev->descriptor.iSerialNumber, serial_number,
2108 sizeof(serial_number));
2109 dev_info(&udev->dev, "probing VID:PID(%04X:%04X) %s %s %s\n",
2110 udev->descriptor.idVendor, udev->descriptor.idProduct,
2111 manufacturer, product, serial_number);
2112 command_out_urb = usb_alloc_urb(0, GFP_KERNEL);
2113 if (!command_out_urb) {
2117 command_res_urb = usb_alloc_urb(0, GFP_KERNEL);
2118 if (!command_res_urb) {
2122 /* this also allocates memory for our VUB300 mmc host device */
2123 mmc = mmc_alloc_host(sizeof(struct vub300_mmc_host), &udev->dev);
2126 dev_err(&udev->dev, "not enough memory for the mmc_host\n");
2129 /* MMC core transfer sizes tunable parameters */
2131 if (!force_1_bit_data_xfers)
2132 mmc->caps |= MMC_CAP_4_BIT_DATA;
2133 if (!force_polling_for_irqs)
2134 mmc->caps |= MMC_CAP_SDIO_IRQ;
2135 mmc->caps &= ~MMC_CAP_NEEDS_POLL;
2137 * MMC_CAP_NEEDS_POLL causes core.c:mmc_rescan() to poll
2138 * for devices which results in spurious CMD7's being
2139 * issued which stops some SDIO cards from working
2141 if (limit_speed_to_24_MHz) {
2142 mmc->caps |= MMC_CAP_MMC_HIGHSPEED;
2143 mmc->caps |= MMC_CAP_SD_HIGHSPEED;
2144 mmc->f_max = 24000000;
2145 dev_info(&udev->dev, "limiting SDIO speed to 24_MHz\n");
2147 mmc->caps |= MMC_CAP_MMC_HIGHSPEED;
2148 mmc->caps |= MMC_CAP_SD_HIGHSPEED;
2149 mmc->f_max = 48000000;
2151 mmc->f_min = 200000;
2152 mmc->max_blk_count = 511;
2153 mmc->max_blk_size = 512;
2154 mmc->max_segs = 128;
2155 if (force_max_req_size)
2156 mmc->max_req_size = force_max_req_size * 1024;
2158 mmc->max_req_size = 64 * 1024;
2159 mmc->max_seg_size = mmc->max_req_size;
2161 mmc->ocr_avail |= MMC_VDD_165_195;
2162 mmc->ocr_avail |= MMC_VDD_20_21;
2163 mmc->ocr_avail |= MMC_VDD_21_22;
2164 mmc->ocr_avail |= MMC_VDD_22_23;
2165 mmc->ocr_avail |= MMC_VDD_23_24;
2166 mmc->ocr_avail |= MMC_VDD_24_25;
2167 mmc->ocr_avail |= MMC_VDD_25_26;
2168 mmc->ocr_avail |= MMC_VDD_26_27;
2169 mmc->ocr_avail |= MMC_VDD_27_28;
2170 mmc->ocr_avail |= MMC_VDD_28_29;
2171 mmc->ocr_avail |= MMC_VDD_29_30;
2172 mmc->ocr_avail |= MMC_VDD_30_31;
2173 mmc->ocr_avail |= MMC_VDD_31_32;
2174 mmc->ocr_avail |= MMC_VDD_32_33;
2175 mmc->ocr_avail |= MMC_VDD_33_34;
2176 mmc->ocr_avail |= MMC_VDD_34_35;
2177 mmc->ocr_avail |= MMC_VDD_35_36;
2178 mmc->ops = &vub300_mmc_ops;
2179 vub300 = mmc_priv(mmc);
2181 vub300->card_powered = 0;
2182 vub300->bus_width = 0;
2183 vub300->cmnd.head.block_size[0] = 0x00;
2184 vub300->cmnd.head.block_size[1] = 0x00;
2185 vub300->app_spec = 0;
2186 mutex_init(&vub300->cmd_mutex);
2187 mutex_init(&vub300->irq_mutex);
2188 vub300->command_out_urb = command_out_urb;
2189 vub300->command_res_urb = command_res_urb;
2190 vub300->usb_timed_out = 0;
2191 vub300->dynamic_register_count = 0;
2193 for (i = 0; i < ARRAY_SIZE(vub300->fn); i++) {
2194 vub300->fn[i].offload_point = 0;
2195 vub300->fn[i].offload_count = 0;
2198 vub300->total_offload_count = 0;
2199 vub300->irq_enabled = 0;
2200 vub300->irq_disabled = 0;
2201 vub300->irqs_queued = 0;
2203 for (i = 0; i < ARRAY_SIZE(vub300->sdio_register); i++)
2204 vub300->sdio_register[i++].activate = 0;
2206 vub300->udev = udev;
2207 vub300->interface = interface;
2208 vub300->cmnd_res_ep = 0;
2209 vub300->cmnd_out_ep = 0;
2210 vub300->data_inp_ep = 0;
2211 vub300->data_out_ep = 0;
2213 for (i = 0; i < ARRAY_SIZE(vub300->fbs); i++)
2214 vub300->fbs[i] = 512;
2217 * set up the endpoint information
2219 * use the first pair of bulk-in and bulk-out
2220 * endpoints for Command/Response+Interrupt
2222 * use the second pair of bulk-in and bulk-out
2223 * endpoints for Data In/Out
2225 vub300->large_usb_packets = 0;
2226 iface_desc = interface->cur_altsetting;
2227 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
2228 struct usb_endpoint_descriptor *endpoint =
2229 &iface_desc->endpoint[i].desc;
2230 dev_info(&vub300->udev->dev,
2231 "vub300 testing %s EndPoint(%d) %02X\n",
2232 usb_endpoint_is_bulk_in(endpoint) ? "BULK IN" :
2233 usb_endpoint_is_bulk_out(endpoint) ? "BULK OUT" :
2234 "UNKNOWN", i, endpoint->bEndpointAddress);
2235 if (endpoint->wMaxPacketSize > 64)
2236 vub300->large_usb_packets = 1;
2237 if (usb_endpoint_is_bulk_in(endpoint)) {
2238 if (!vub300->cmnd_res_ep) {
2239 vub300->cmnd_res_ep =
2240 endpoint->bEndpointAddress;
2241 } else if (!vub300->data_inp_ep) {
2242 vub300->data_inp_ep =
2243 endpoint->bEndpointAddress;
2245 dev_warn(&vub300->udev->dev,
2247 " unexpected bulk_in endpoint");
2249 } else if (usb_endpoint_is_bulk_out(endpoint)) {
2250 if (!vub300->cmnd_out_ep) {
2251 vub300->cmnd_out_ep =
2252 endpoint->bEndpointAddress;
2253 } else if (!vub300->data_out_ep) {
2254 vub300->data_out_ep =
2255 endpoint->bEndpointAddress;
2257 dev_warn(&vub300->udev->dev,
2259 " unexpected bulk_out endpoint");
2262 dev_warn(&vub300->udev->dev,
2263 "vub300 ignoring EndPoint(%d) %02X", i,
2264 endpoint->bEndpointAddress);
2267 if (vub300->cmnd_res_ep && vub300->cmnd_out_ep &&
2268 vub300->data_inp_ep && vub300->data_out_ep) {
2269 dev_info(&vub300->udev->dev,
2271 " using EndPoints %02X %02X %02X %02X\n",
2272 vub300->large_usb_packets ? "LARGE" : "SMALL",
2273 vub300->cmnd_out_ep, vub300->cmnd_res_ep,
2274 vub300->data_out_ep, vub300->data_inp_ep);
2275 /* we have the expected EndPoints */
2277 dev_err(&vub300->udev->dev,
2278 "Could not find two sets of bulk-in/out endpoint pairs\n");
2283 usb_control_msg(vub300->udev, usb_rcvctrlpipe(vub300->udev, 0),
2285 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
2286 0x0000, 0x0000, &vub300->hc_info,
2287 sizeof(vub300->hc_info), HZ);
2291 usb_control_msg(vub300->udev, usb_rcvctrlpipe(vub300->udev, 0),
2292 SET_ROM_WAIT_STATES,
2293 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
2294 firmware_rom_wait_states, 0x0000, NULL, 0, HZ);
2297 dev_info(&vub300->udev->dev,
2298 "operating_mode = %s %s %d MHz %s %d byte USB packets\n",
2299 (mmc->caps & MMC_CAP_SDIO_IRQ) ? "IRQs" : "POLL",
2300 (mmc->caps & MMC_CAP_4_BIT_DATA) ? "4-bit" : "1-bit",
2301 mmc->f_max / 1000000,
2302 pad_input_to_usb_pkt ? "padding input data to" : "with",
2303 vub300->large_usb_packets ? 512 : 64);
2305 usb_control_msg(vub300->udev, usb_rcvctrlpipe(vub300->udev, 0),
2306 GET_SYSTEM_PORT_STATUS,
2307 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
2308 0x0000, 0x0000, &vub300->system_port_status,
2309 sizeof(vub300->system_port_status), HZ);
2312 } else if (sizeof(vub300->system_port_status) == retval) {
2313 vub300->card_present =
2314 (0x0001 & vub300->system_port_status.port_flags) ? 1 : 0;
2316 (0x0010 & vub300->system_port_status.port_flags) ? 1 : 0;
2320 usb_set_intfdata(interface, vub300);
2321 INIT_DELAYED_WORK(&vub300->pollwork, vub300_pollwork_thread);
2322 INIT_WORK(&vub300->cmndwork, vub300_cmndwork_thread);
2323 INIT_WORK(&vub300->deadwork, vub300_deadwork_thread);
2324 kref_init(&vub300->kref);
2325 init_timer(&vub300->sg_transfer_timer);
2326 vub300->sg_transfer_timer.data = (unsigned long)vub300;
2327 vub300->sg_transfer_timer.function = vub300_sg_timed_out;
2328 kref_get(&vub300->kref);
2329 init_timer(&vub300->inactivity_timer);
2330 vub300->inactivity_timer.data = (unsigned long)vub300;
2331 vub300->inactivity_timer.function = vub300_inactivity_timer_expired;
2332 vub300->inactivity_timer.expires = jiffies + HZ;
2333 add_timer(&vub300->inactivity_timer);
2334 if (vub300->card_present)
2335 dev_info(&vub300->udev->dev,
2336 "USB vub300 remote SDIO host controller[%d]"
2337 "connected with SD/SDIO card inserted\n",
2338 interface_to_InterfaceNumber(interface));
2340 dev_info(&vub300->udev->dev,
2341 "USB vub300 remote SDIO host controller[%d]"
2342 "connected with no SD/SDIO card inserted\n",
2343 interface_to_InterfaceNumber(interface));
2349 * and hence also frees vub300
2350 * which is contained at the end of struct mmc
2353 usb_free_urb(command_res_urb);
2355 usb_free_urb(command_out_urb);
2361 static void vub300_disconnect(struct usb_interface *interface)
2363 struct vub300_mmc_host *vub300 = usb_get_intfdata(interface);
2364 if (!vub300 || !vub300->mmc) {
2367 struct mmc_host *mmc = vub300->mmc;
2371 int ifnum = interface_to_InterfaceNumber(interface);
2372 usb_set_intfdata(interface, NULL);
2373 /* prevent more I/O from starting */
2374 vub300->interface = NULL;
2375 kref_put(&vub300->kref, vub300_delete);
2376 mmc_remove_host(mmc);
2377 pr_info("USB vub300 remote SDIO host controller[%d]"
2378 " now disconnected", ifnum);
2385 static int vub300_suspend(struct usb_interface *intf, pm_message_t message)
2390 static int vub300_resume(struct usb_interface *intf)
2395 #define vub300_suspend NULL
2396 #define vub300_resume NULL
2398 static int vub300_pre_reset(struct usb_interface *intf)
2400 struct vub300_mmc_host *vub300 = usb_get_intfdata(intf);
2401 mutex_lock(&vub300->cmd_mutex);
2405 static int vub300_post_reset(struct usb_interface *intf)
2407 struct vub300_mmc_host *vub300 = usb_get_intfdata(intf);
2408 /* we are sure no URBs are active - no locking needed */
2409 vub300->errors = -EPIPE;
2410 mutex_unlock(&vub300->cmd_mutex);
2414 static struct usb_driver vub300_driver = {
2416 .probe = vub300_probe,
2417 .disconnect = vub300_disconnect,
2418 .suspend = vub300_suspend,
2419 .resume = vub300_resume,
2420 .pre_reset = vub300_pre_reset,
2421 .post_reset = vub300_post_reset,
2422 .id_table = vub300_table,
2423 .supports_autosuspend = 1,
2426 static int __init vub300_init(void)
2430 pr_info("VUB300 Driver rom wait states = %02X irqpoll timeout = %04X",
2431 firmware_rom_wait_states, 0x0FFFF & firmware_irqpoll_timeout);
2432 cmndworkqueue = create_singlethread_workqueue("kvub300c");
2433 if (!cmndworkqueue) {
2434 pr_err("not enough memory for the REQUEST workqueue");
2438 pollworkqueue = create_singlethread_workqueue("kvub300p");
2439 if (!pollworkqueue) {
2440 pr_err("not enough memory for the IRQPOLL workqueue");
2444 deadworkqueue = create_singlethread_workqueue("kvub300d");
2445 if (!deadworkqueue) {
2446 pr_err("not enough memory for the EXPIRED workqueue");
2450 result = usb_register(&vub300_driver);
2452 pr_err("usb_register failed. Error number %d", result);
2457 destroy_workqueue(deadworkqueue);
2459 destroy_workqueue(pollworkqueue);
2461 destroy_workqueue(cmndworkqueue);
2466 static void __exit vub300_exit(void)
2468 usb_deregister(&vub300_driver);
2469 flush_workqueue(cmndworkqueue);
2470 flush_workqueue(pollworkqueue);
2471 flush_workqueue(deadworkqueue);
2472 destroy_workqueue(cmndworkqueue);
2473 destroy_workqueue(pollworkqueue);
2474 destroy_workqueue(deadworkqueue);
2477 module_init(vub300_init);
2478 module_exit(vub300_exit);
2480 MODULE_AUTHOR("Tony Olech <tony.olech@elandigitalsystems.com>");
2481 MODULE_DESCRIPTION("VUB300 USB to SD/MMC/SDIO adapter driver");
2482 MODULE_LICENSE("GPL");