1 // SPDX-License-Identifier: GPL-2.0-only
3 * Remote VUB300 SDIO/SDmem Host Controller Driver
5 * Copyright (C) 2010 Elan Digital Systems Limited
7 * based on USB Skeleton driver - 2.2
9 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
11 * VUB300: is a USB 2.0 client device with a single SDIO/SDmem/MMC slot
12 * Any SDIO/SDmem/MMC device plugged into the VUB300 will appear,
13 * by virtue of this driver, to have been plugged into a local
14 * SDIO host controller, similar to, say, a PCI Ricoh controller
15 * This is because this kernel device driver is both a USB 2.0
16 * client device driver AND an MMC host controller driver. Thus
17 * if there is an existing driver for the inserted SDIO/SDmem/MMC
18 * device then that driver will be used by the kernel to manage
19 * the device in exactly the same fashion as if it had been
20 * directly plugged into, say, a local pci bus Ricoh controller
22 * RANT: this driver was written using a display 128x48 - converting it
23 * to a line width of 80 makes it very difficult to support. In
24 * particular functions have been broken down into sub functions
25 * and the original meaningful names have been shortened into
27 * The problem is that executing a fragment of code subject to
28 * two conditions means an indentation of 24, thus leaving only
29 * 56 characters for a C statement. And that is quite ridiculous!
31 * Data types: data passed to/from the VUB300 is fixed to a number of
32 * bits and driver data fields reflect that limit by using
35 #include <linux/kernel.h>
36 #include <linux/errno.h>
37 #include <linux/init.h>
38 #include <linux/slab.h>
39 #include <linux/module.h>
40 #include <linux/kref.h>
41 #include <linux/uaccess.h>
42 #include <linux/usb.h>
43 #include <linux/mutex.h>
44 #include <linux/mmc/host.h>
45 #include <linux/mmc/card.h>
46 #include <linux/mmc/sdio_func.h>
47 #include <linux/mmc/sdio_ids.h>
48 #include <linux/workqueue.h>
49 #include <linux/ctype.h>
50 #include <linux/firmware.h>
51 #include <linux/scatterlist.h>
53 struct host_controller_info
{
59 #define FIRMWARE_BLOCK_BOUNDARY 1024
60 struct sd_command_header
{
64 u8 command_type
; /* Bit7 - Rd/Wr */
66 u8 transfer_size
[4]; /* ReadSize + ReadSize */
72 u8 reserved
[44]; /* to pad out to 64 bytes */
75 struct sd_irqpoll_header
{
79 u8 command_type
; /* Bit7 - Rd/Wr */
80 u8 padding
[16]; /* don't ask why !! */
83 u8 reserved
[42]; /* to pad out to 64 bytes */
86 struct sd_common_header
{
92 struct sd_response_header
{
98 u8 command_response
[];
101 struct sd_status_header
{
107 u16 host_header_size
;
108 u16 func_header_size
;
109 u16 ctrl_header_size
;
112 struct sd_error_header
{
119 struct sd_interrupt_header
{
125 struct offload_registers_access
{
130 #define INTERRUPT_REGISTER_ACCESSES 15
131 struct sd_offloaded_interrupt
{
135 struct offload_registers_access reg
[INTERRUPT_REGISTER_ACCESSES
];
138 struct sd_register_header
{
144 u8 command_response
[6];
147 #define PIGGYBACK_REGISTER_ACCESSES 14
148 struct sd_offloaded_piggyback
{
149 struct sd_register_header sdio
;
150 struct offload_registers_access reg
[PIGGYBACK_REGISTER_ACCESSES
];
154 struct sd_common_header common
;
155 struct sd_status_header status
;
156 struct sd_error_header error
;
157 struct sd_interrupt_header interrupt
;
158 struct sd_response_header response
;
159 struct sd_offloaded_interrupt irq
;
160 struct sd_offloaded_piggyback pig
;
164 struct sd_command_header head
;
165 struct sd_irqpoll_header poll
;
168 enum SD_RESPONSE_TYPE
{
169 SDRT_UNSPECIFIED
= 0,
182 #define RESPONSE_INTERRUPT 0x01
183 #define RESPONSE_ERROR 0x02
184 #define RESPONSE_STATUS 0x03
185 #define RESPONSE_IRQ_DISABLED 0x05
186 #define RESPONSE_IRQ_ENABLED 0x06
187 #define RESPONSE_PIGGYBACKED 0x07
188 #define RESPONSE_NO_INTERRUPT 0x08
189 #define RESPONSE_PIG_DISABLED 0x09
190 #define RESPONSE_PIG_ENABLED 0x0A
191 #define SD_ERROR_1BIT_TIMEOUT 0x01
192 #define SD_ERROR_4BIT_TIMEOUT 0x02
193 #define SD_ERROR_1BIT_CRC_WRONG 0x03
194 #define SD_ERROR_4BIT_CRC_WRONG 0x04
195 #define SD_ERROR_1BIT_CRC_ERROR 0x05
196 #define SD_ERROR_4BIT_CRC_ERROR 0x06
197 #define SD_ERROR_NO_CMD_ENDBIT 0x07
198 #define SD_ERROR_NO_1BIT_DATEND 0x08
199 #define SD_ERROR_NO_4BIT_DATEND 0x09
200 #define SD_ERROR_1BIT_UNEXPECTED_TIMEOUT 0x0A
201 #define SD_ERROR_4BIT_UNEXPECTED_TIMEOUT 0x0B
202 #define SD_ERROR_ILLEGAL_COMMAND 0x0C
203 #define SD_ERROR_NO_DEVICE 0x0D
204 #define SD_ERROR_TRANSFER_LENGTH 0x0E
205 #define SD_ERROR_1BIT_DATA_TIMEOUT 0x0F
206 #define SD_ERROR_4BIT_DATA_TIMEOUT 0x10
207 #define SD_ERROR_ILLEGAL_STATE 0x11
208 #define SD_ERROR_UNKNOWN_ERROR 0x12
209 #define SD_ERROR_RESERVED_ERROR 0x13
210 #define SD_ERROR_INVALID_FUNCTION 0x14
211 #define SD_ERROR_OUT_OF_RANGE 0x15
212 #define SD_ERROR_STAT_CMD 0x16
213 #define SD_ERROR_STAT_DATA 0x17
214 #define SD_ERROR_STAT_CMD_TIMEOUT 0x18
215 #define SD_ERROR_SDCRDY_STUCK 0x19
216 #define SD_ERROR_UNHANDLED 0x1A
217 #define SD_ERROR_OVERRUN 0x1B
218 #define SD_ERROR_PIO_TIMEOUT 0x1C
220 #define FUN(c) (0x000007 & (c->arg>>28))
221 #define REG(c) (0x01FFFF & (c->arg>>9))
223 static bool limit_speed_to_24_MHz
;
224 module_param(limit_speed_to_24_MHz
, bool, 0644);
225 MODULE_PARM_DESC(limit_speed_to_24_MHz
, "Limit Max SDIO Clock Speed to 24 MHz");
227 static bool pad_input_to_usb_pkt
;
228 module_param(pad_input_to_usb_pkt
, bool, 0644);
229 MODULE_PARM_DESC(pad_input_to_usb_pkt
,
230 "Pad USB data input transfers to whole USB Packet");
232 static bool disable_offload_processing
;
233 module_param(disable_offload_processing
, bool, 0644);
234 MODULE_PARM_DESC(disable_offload_processing
, "Disable Offload Processing");
236 static bool force_1_bit_data_xfers
;
237 module_param(force_1_bit_data_xfers
, bool, 0644);
238 MODULE_PARM_DESC(force_1_bit_data_xfers
,
239 "Force SDIO Data Transfers to 1-bit Mode");
241 static bool force_polling_for_irqs
;
242 module_param(force_polling_for_irqs
, bool, 0644);
243 MODULE_PARM_DESC(force_polling_for_irqs
, "Force Polling for SDIO interrupts");
245 static int firmware_irqpoll_timeout
= 1024;
246 module_param(firmware_irqpoll_timeout
, int, 0644);
247 MODULE_PARM_DESC(firmware_irqpoll_timeout
, "VUB300 firmware irqpoll timeout");
249 static int force_max_req_size
= 128;
250 module_param(force_max_req_size
, int, 0644);
251 MODULE_PARM_DESC(force_max_req_size
, "set max request size in kBytes");
253 #ifdef SMSC_DEVELOPMENT_BOARD
254 static int firmware_rom_wait_states
= 0x04;
256 static int firmware_rom_wait_states
= 0x1C;
259 module_param(firmware_rom_wait_states
, int, 0644);
260 MODULE_PARM_DESC(firmware_rom_wait_states
,
261 "ROM wait states byte=RRRIIEEE (Reserved Internal External)");
263 #define ELAN_VENDOR_ID 0x2201
264 #define VUB300_VENDOR_ID 0x0424
265 #define VUB300_PRODUCT_ID 0x012C
266 static const struct usb_device_id vub300_table
[] = {
267 {USB_DEVICE(ELAN_VENDOR_ID
, VUB300_PRODUCT_ID
)},
268 {USB_DEVICE(VUB300_VENDOR_ID
, VUB300_PRODUCT_ID
)},
269 {} /* Terminating entry */
271 MODULE_DEVICE_TABLE(usb
, vub300_table
);
273 static struct workqueue_struct
*cmndworkqueue
;
274 static struct workqueue_struct
*pollworkqueue
;
275 static struct workqueue_struct
*deadworkqueue
;
277 static inline int interface_to_InterfaceNumber(struct usb_interface
*interface
)
281 if (!interface
->cur_altsetting
)
283 return interface
->cur_altsetting
->desc
.bInterfaceNumber
;
286 struct sdio_register
{
288 unsigned sdio_reg
:17;
293 unsigned sparebit
:26;
296 struct vub300_mmc_host
{
297 struct usb_device
*udev
;
298 struct usb_interface
*interface
;
300 struct mutex cmd_mutex
;
301 struct mutex irq_mutex
;
302 char vub_name
[3 + (9 * 8) + 4 + 1]; /* max of 7 sdio fn's */
303 u8 cmnd_out_ep
; /* EndPoint for commands */
304 u8 cmnd_res_ep
; /* EndPoint for responses */
305 u8 data_out_ep
; /* EndPoint for out data */
306 u8 data_inp_ep
; /* EndPoint for inp data */
310 bool large_usb_packets
;
311 bool app_spec
; /* ApplicationSpecific */
312 bool irq_enabled
; /* by the MMC CORE */
313 bool irq_disabled
; /* in the firmware */
314 unsigned bus_width
:4;
315 u8 total_offload_count
;
316 u8 dynamic_register_count
;
320 int usb_transport_fail
;
323 struct sdio_register sdio_register
[16];
324 struct offload_interrupt_function_register
{
326 #define MAXREGS (1<<MAXREGBITS)
327 #define MAXREGMASK (MAXREGS-1)
330 struct offload_registers_access reg
[MAXREGS
];
332 u16 fbs
[8]; /* Function Block Size */
333 struct mmc_command
*cmd
;
334 struct mmc_request
*req
;
335 struct mmc_data
*data
;
336 struct mmc_host
*mmc
;
338 struct urb
*command_out_urb
;
339 struct urb
*command_res_urb
;
340 struct completion command_complete
;
341 struct completion irqpoll_complete
;
342 union sd_command cmnd
;
343 union sd_response resp
;
344 struct timer_list sg_transfer_timer
;
345 struct usb_sg_request sg_request
;
346 struct timer_list inactivity_timer
;
347 struct work_struct deadwork
;
348 struct work_struct cmndwork
;
349 struct delayed_work pollwork
;
350 struct host_controller_info hc_info
;
351 struct sd_status_header system_port_status
;
352 u8 padded_buffer
[64];
355 #define kref_to_vub300_mmc_host(d) container_of(d, struct vub300_mmc_host, kref)
356 #define SET_TRANSFER_PSEUDOCODE 21
357 #define SET_INTERRUPT_PSEUDOCODE 20
358 #define SET_FAILURE_MODE 18
359 #define SET_ROM_WAIT_STATES 16
360 #define SET_IRQ_ENABLE 13
361 #define SET_CLOCK_SPEED 11
362 #define SET_FUNCTION_BLOCK_SIZE 9
363 #define SET_SD_DATA_MODE 6
364 #define SET_SD_POWER 4
365 #define ENTER_DFU_MODE 3
366 #define GET_HC_INF0 1
367 #define GET_SYSTEM_PORT_STATUS 0
369 static void vub300_delete(struct kref
*kref
)
370 { /* kref callback - softirq */
371 struct vub300_mmc_host
*vub300
= kref_to_vub300_mmc_host(kref
);
372 struct mmc_host
*mmc
= vub300
->mmc
;
373 usb_free_urb(vub300
->command_out_urb
);
374 vub300
->command_out_urb
= NULL
;
375 usb_free_urb(vub300
->command_res_urb
);
376 vub300
->command_res_urb
= NULL
;
377 usb_put_dev(vub300
->udev
);
380 * and hence also frees vub300
381 * which is contained at the end of struct mmc
385 static void vub300_queue_cmnd_work(struct vub300_mmc_host
*vub300
)
387 kref_get(&vub300
->kref
);
388 if (queue_work(cmndworkqueue
, &vub300
->cmndwork
)) {
390 * then the cmndworkqueue was not previously
391 * running and the above get ref is obvious
392 * required and will be put when the thread
393 * terminates by a specific call
397 * the cmndworkqueue was already running from
398 * a previous invocation and thus to keep the
399 * kref counts correct we must undo the get
401 kref_put(&vub300
->kref
, vub300_delete
);
405 static void vub300_queue_poll_work(struct vub300_mmc_host
*vub300
, int delay
)
407 kref_get(&vub300
->kref
);
408 if (queue_delayed_work(pollworkqueue
, &vub300
->pollwork
, delay
)) {
410 * then the pollworkqueue was not previously
411 * running and the above get ref is obvious
412 * required and will be put when the thread
413 * terminates by a specific call
417 * the pollworkqueue was already running from
418 * a previous invocation and thus to keep the
419 * kref counts correct we must undo the get
421 kref_put(&vub300
->kref
, vub300_delete
);
425 static void vub300_queue_dead_work(struct vub300_mmc_host
*vub300
)
427 kref_get(&vub300
->kref
);
428 if (queue_work(deadworkqueue
, &vub300
->deadwork
)) {
430 * then the deadworkqueue was not previously
431 * running and the above get ref is obvious
432 * required and will be put when the thread
433 * terminates by a specific call
437 * the deadworkqueue was already running from
438 * a previous invocation and thus to keep the
439 * kref counts correct we must undo the get
441 kref_put(&vub300
->kref
, vub300_delete
);
445 static void irqpoll_res_completed(struct urb
*urb
)
446 { /* urb completion handler - hardirq */
447 struct vub300_mmc_host
*vub300
= (struct vub300_mmc_host
*)urb
->context
;
449 vub300
->usb_transport_fail
= urb
->status
;
450 complete(&vub300
->irqpoll_complete
);
453 static void irqpoll_out_completed(struct urb
*urb
)
454 { /* urb completion handler - hardirq */
455 struct vub300_mmc_host
*vub300
= (struct vub300_mmc_host
*)urb
->context
;
457 vub300
->usb_transport_fail
= urb
->status
;
458 complete(&vub300
->irqpoll_complete
);
463 usb_rcvbulkpipe(vub300
->udev
, vub300
->cmnd_res_ep
);
464 usb_fill_bulk_urb(vub300
->command_res_urb
, vub300
->udev
, pipe
,
465 &vub300
->resp
, sizeof(vub300
->resp
),
466 irqpoll_res_completed
, vub300
);
467 vub300
->command_res_urb
->actual_length
= 0;
468 ret
= usb_submit_urb(vub300
->command_res_urb
, GFP_ATOMIC
);
470 vub300
->usb_transport_fail
= ret
;
471 complete(&vub300
->irqpoll_complete
);
477 static void send_irqpoll(struct vub300_mmc_host
*vub300
)
479 /* cmd_mutex is held by vub300_pollwork_thread */
481 int timeout
= 0xFFFF & (0x0001FFFF - firmware_irqpoll_timeout
);
482 vub300
->cmnd
.poll
.header_size
= 22;
483 vub300
->cmnd
.poll
.header_type
= 1;
484 vub300
->cmnd
.poll
.port_number
= 0;
485 vub300
->cmnd
.poll
.command_type
= 2;
486 vub300
->cmnd
.poll
.poll_timeout_lsb
= 0xFF & (unsigned)timeout
;
487 vub300
->cmnd
.poll
.poll_timeout_msb
= 0xFF & (unsigned)(timeout
>> 8);
488 usb_fill_bulk_urb(vub300
->command_out_urb
, vub300
->udev
,
489 usb_sndbulkpipe(vub300
->udev
, vub300
->cmnd_out_ep
)
490 , &vub300
->cmnd
, sizeof(vub300
->cmnd
)
491 , irqpoll_out_completed
, vub300
);
492 retval
= usb_submit_urb(vub300
->command_out_urb
, GFP_KERNEL
);
494 vub300
->usb_transport_fail
= retval
;
495 vub300_queue_poll_work(vub300
, 1);
496 complete(&vub300
->irqpoll_complete
);
503 static void new_system_port_status(struct vub300_mmc_host
*vub300
)
505 int old_card_present
= vub300
->card_present
;
506 int new_card_present
=
507 (0x0001 & vub300
->system_port_status
.port_flags
) ? 1 : 0;
509 (0x0010 & vub300
->system_port_status
.port_flags
) ? 1 : 0;
510 if (new_card_present
&& !old_card_present
) {
511 dev_info(&vub300
->udev
->dev
, "card just inserted\n");
512 vub300
->card_present
= 1;
513 vub300
->bus_width
= 0;
514 if (disable_offload_processing
)
515 strscpy(vub300
->vub_name
, "EMPTY Processing Disabled",
516 sizeof(vub300
->vub_name
));
518 vub300
->vub_name
[0] = 0;
519 mmc_detect_change(vub300
->mmc
, 1);
520 } else if (!new_card_present
&& old_card_present
) {
521 dev_info(&vub300
->udev
->dev
, "card just ejected\n");
522 vub300
->card_present
= 0;
523 mmc_detect_change(vub300
->mmc
, 0);
529 static void __add_offloaded_reg_to_fifo(struct vub300_mmc_host
*vub300
,
530 struct offload_registers_access
531 *register_access
, u8 func
)
533 u8 r
= vub300
->fn
[func
].offload_point
+ vub300
->fn
[func
].offload_count
;
534 memcpy(&vub300
->fn
[func
].reg
[MAXREGMASK
& r
], register_access
,
535 sizeof(struct offload_registers_access
));
536 vub300
->fn
[func
].offload_count
+= 1;
537 vub300
->total_offload_count
+= 1;
540 static void add_offloaded_reg(struct vub300_mmc_host
*vub300
,
541 struct offload_registers_access
*register_access
)
543 u32 Register
= ((0x03 & register_access
->command_byte
[0]) << 15)
544 | ((0xFF & register_access
->command_byte
[1]) << 7)
545 | ((0xFE & register_access
->command_byte
[2]) >> 1);
546 u8 func
= ((0x70 & register_access
->command_byte
[0]) >> 4);
547 u8 regs
= vub300
->dynamic_register_count
;
549 while (0 < regs
-- && 1 == vub300
->sdio_register
[i
].activate
) {
550 if (vub300
->sdio_register
[i
].func_num
== func
&&
551 vub300
->sdio_register
[i
].sdio_reg
== Register
) {
552 if (vub300
->sdio_register
[i
].prepared
== 0)
553 vub300
->sdio_register
[i
].prepared
= 1;
554 vub300
->sdio_register
[i
].response
=
555 register_access
->Respond_Byte
[2];
556 vub300
->sdio_register
[i
].regvalue
=
557 register_access
->Respond_Byte
[3];
564 __add_offloaded_reg_to_fifo(vub300
, register_access
, func
);
567 static void check_vub300_port_status(struct vub300_mmc_host
*vub300
)
570 * cmd_mutex is held by vub300_pollwork_thread,
571 * vub300_deadwork_thread or vub300_cmndwork_thread
575 usb_control_msg(vub300
->udev
, usb_rcvctrlpipe(vub300
->udev
, 0),
576 GET_SYSTEM_PORT_STATUS
,
577 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
578 0x0000, 0x0000, &vub300
->system_port_status
,
579 sizeof(vub300
->system_port_status
), 1000);
580 if (sizeof(vub300
->system_port_status
) == retval
)
581 new_system_port_status(vub300
);
584 static void __vub300_irqpoll_response(struct vub300_mmc_host
*vub300
)
586 /* cmd_mutex is held by vub300_pollwork_thread */
587 if (vub300
->command_res_urb
->actual_length
== 0)
590 switch (vub300
->resp
.common
.header_type
) {
591 case RESPONSE_INTERRUPT
:
592 mutex_lock(&vub300
->irq_mutex
);
593 if (vub300
->irq_enabled
)
594 mmc_signal_sdio_irq(vub300
->mmc
);
596 vub300
->irqs_queued
+= 1;
597 vub300
->irq_disabled
= 1;
598 mutex_unlock(&vub300
->irq_mutex
);
601 if (vub300
->resp
.error
.error_code
== SD_ERROR_NO_DEVICE
)
602 check_vub300_port_status(vub300
);
604 case RESPONSE_STATUS
:
605 vub300
->system_port_status
= vub300
->resp
.status
;
606 new_system_port_status(vub300
);
607 if (!vub300
->card_present
)
608 vub300_queue_poll_work(vub300
, HZ
/ 5);
610 case RESPONSE_IRQ_DISABLED
:
612 int offloaded_data_length
= vub300
->resp
.common
.header_size
- 3;
613 int register_count
= offloaded_data_length
>> 3;
615 while (register_count
--) {
616 add_offloaded_reg(vub300
, &vub300
->resp
.irq
.reg
[ri
]);
619 mutex_lock(&vub300
->irq_mutex
);
620 if (vub300
->irq_enabled
)
621 mmc_signal_sdio_irq(vub300
->mmc
);
623 vub300
->irqs_queued
+= 1;
624 vub300
->irq_disabled
= 1;
625 mutex_unlock(&vub300
->irq_mutex
);
628 case RESPONSE_IRQ_ENABLED
:
630 int offloaded_data_length
= vub300
->resp
.common
.header_size
- 3;
631 int register_count
= offloaded_data_length
>> 3;
633 while (register_count
--) {
634 add_offloaded_reg(vub300
, &vub300
->resp
.irq
.reg
[ri
]);
637 mutex_lock(&vub300
->irq_mutex
);
638 if (vub300
->irq_enabled
)
639 mmc_signal_sdio_irq(vub300
->mmc
);
641 vub300
->irqs_queued
+= 1;
642 vub300
->irq_disabled
= 0;
643 mutex_unlock(&vub300
->irq_mutex
);
646 case RESPONSE_NO_INTERRUPT
:
647 vub300_queue_poll_work(vub300
, 1);
654 static void __do_poll(struct vub300_mmc_host
*vub300
)
656 /* cmd_mutex is held by vub300_pollwork_thread */
657 unsigned long commretval
;
658 mod_timer(&vub300
->inactivity_timer
, jiffies
+ HZ
);
659 init_completion(&vub300
->irqpoll_complete
);
660 send_irqpoll(vub300
);
661 commretval
= wait_for_completion_timeout(&vub300
->irqpoll_complete
,
662 msecs_to_jiffies(500));
663 if (vub300
->usb_transport_fail
) {
664 /* no need to do anything */
665 } else if (commretval
== 0) {
666 vub300
->usb_timed_out
= 1;
667 usb_kill_urb(vub300
->command_out_urb
);
668 usb_kill_urb(vub300
->command_res_urb
);
669 } else { /* commretval > 0 */
670 __vub300_irqpoll_response(vub300
);
674 /* this thread runs only when the driver
675 * is trying to poll the device for an IRQ
677 static void vub300_pollwork_thread(struct work_struct
*work
)
679 struct vub300_mmc_host
*vub300
= container_of(work
,
680 struct vub300_mmc_host
, pollwork
.work
);
681 if (!vub300
->interface
) {
682 kref_put(&vub300
->kref
, vub300_delete
);
685 mutex_lock(&vub300
->cmd_mutex
);
687 vub300_queue_poll_work(vub300
, 1);
688 } else if (!vub300
->card_present
) {
689 /* no need to do anything */
690 } else { /* vub300->card_present */
691 mutex_lock(&vub300
->irq_mutex
);
692 if (!vub300
->irq_enabled
) {
693 mutex_unlock(&vub300
->irq_mutex
);
694 } else if (vub300
->irqs_queued
) {
695 vub300
->irqs_queued
-= 1;
696 mmc_signal_sdio_irq(vub300
->mmc
);
697 mod_timer(&vub300
->inactivity_timer
, jiffies
+ HZ
);
698 mutex_unlock(&vub300
->irq_mutex
);
699 } else { /* NOT vub300->irqs_queued */
700 mutex_unlock(&vub300
->irq_mutex
);
704 mutex_unlock(&vub300
->cmd_mutex
);
705 kref_put(&vub300
->kref
, vub300_delete
);
708 static void vub300_deadwork_thread(struct work_struct
*work
)
710 struct vub300_mmc_host
*vub300
=
711 container_of(work
, struct vub300_mmc_host
, deadwork
);
712 if (!vub300
->interface
) {
713 kref_put(&vub300
->kref
, vub300_delete
);
716 mutex_lock(&vub300
->cmd_mutex
);
719 * a command got in as the inactivity
720 * timer expired - so we just let the
721 * processing of the command show if
724 } else if (vub300
->card_present
) {
725 check_vub300_port_status(vub300
);
726 } else if (vub300
->mmc
&& vub300
->mmc
->card
) {
728 * the MMC core must not have responded
729 * to the previous indication - lets
730 * hope that it eventually does so we
731 * will just ignore this for now
734 check_vub300_port_status(vub300
);
736 mod_timer(&vub300
->inactivity_timer
, jiffies
+ HZ
);
737 mutex_unlock(&vub300
->cmd_mutex
);
738 kref_put(&vub300
->kref
, vub300_delete
);
741 static void vub300_inactivity_timer_expired(struct timer_list
*t
)
743 struct vub300_mmc_host
*vub300
= from_timer(vub300
, t
,
745 if (!vub300
->interface
) {
746 kref_put(&vub300
->kref
, vub300_delete
);
747 } else if (vub300
->cmd
) {
748 mod_timer(&vub300
->inactivity_timer
, jiffies
+ HZ
);
750 vub300_queue_dead_work(vub300
);
751 mod_timer(&vub300
->inactivity_timer
, jiffies
+ HZ
);
755 static int vub300_response_error(u8 error_code
)
757 switch (error_code
) {
758 case SD_ERROR_PIO_TIMEOUT
:
759 case SD_ERROR_1BIT_TIMEOUT
:
760 case SD_ERROR_4BIT_TIMEOUT
:
762 case SD_ERROR_STAT_DATA
:
763 case SD_ERROR_OVERRUN
:
764 case SD_ERROR_STAT_CMD
:
765 case SD_ERROR_STAT_CMD_TIMEOUT
:
766 case SD_ERROR_SDCRDY_STUCK
:
767 case SD_ERROR_UNHANDLED
:
768 case SD_ERROR_1BIT_CRC_WRONG
:
769 case SD_ERROR_4BIT_CRC_WRONG
:
770 case SD_ERROR_1BIT_CRC_ERROR
:
771 case SD_ERROR_4BIT_CRC_ERROR
:
772 case SD_ERROR_NO_CMD_ENDBIT
:
773 case SD_ERROR_NO_1BIT_DATEND
:
774 case SD_ERROR_NO_4BIT_DATEND
:
775 case SD_ERROR_1BIT_DATA_TIMEOUT
:
776 case SD_ERROR_4BIT_DATA_TIMEOUT
:
777 case SD_ERROR_1BIT_UNEXPECTED_TIMEOUT
:
778 case SD_ERROR_4BIT_UNEXPECTED_TIMEOUT
:
782 case SD_ERROR_ILLEGAL_COMMAND
:
784 case SD_ERROR_NO_DEVICE
:
791 static void command_res_completed(struct urb
*urb
)
792 { /* urb completion handler - hardirq */
793 struct vub300_mmc_host
*vub300
= (struct vub300_mmc_host
*)urb
->context
;
795 /* we have to let the initiator handle the error */
796 } else if (vub300
->command_res_urb
->actual_length
== 0) {
798 * we have seen this happen once or twice and
799 * we suspect a buggy USB host controller
801 } else if (!vub300
->data
) {
802 /* this means that the command (typically CMD52) succeeded */
803 } else if (vub300
->resp
.common
.header_type
!= 0x02) {
805 * this is an error response from the VUB300 chip
806 * and we let the initiator handle it
808 } else if (vub300
->urb
) {
810 vub300_response_error(vub300
->resp
.error
.error_code
);
811 usb_unlink_urb(vub300
->urb
);
814 vub300_response_error(vub300
->resp
.error
.error_code
);
815 usb_sg_cancel(&vub300
->sg_request
);
817 complete(&vub300
->command_complete
); /* got_response_in */
820 static void command_out_completed(struct urb
*urb
)
821 { /* urb completion handler - hardirq */
822 struct vub300_mmc_host
*vub300
= (struct vub300_mmc_host
*)urb
->context
;
824 complete(&vub300
->command_complete
);
828 usb_rcvbulkpipe(vub300
->udev
, vub300
->cmnd_res_ep
);
829 usb_fill_bulk_urb(vub300
->command_res_urb
, vub300
->udev
, pipe
,
830 &vub300
->resp
, sizeof(vub300
->resp
),
831 command_res_completed
, vub300
);
832 vub300
->command_res_urb
->actual_length
= 0;
833 ret
= usb_submit_urb(vub300
->command_res_urb
, GFP_ATOMIC
);
836 * the urb completion handler will call
837 * our completion handler
841 * and thus we only call it directly
842 * when it will not be called
844 complete(&vub300
->command_complete
);
850 * the STUFF bits are masked out for the comparisons
852 static void snoop_block_size_and_bus_width(struct vub300_mmc_host
*vub300
,
855 if ((0xFBFFFE00 & cmd_arg
) == 0x80022200)
856 vub300
->fbs
[1] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[1]);
857 else if ((0xFBFFFE00 & cmd_arg
) == 0x80022000)
858 vub300
->fbs
[1] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[1]);
859 else if ((0xFBFFFE00 & cmd_arg
) == 0x80042200)
860 vub300
->fbs
[2] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[2]);
861 else if ((0xFBFFFE00 & cmd_arg
) == 0x80042000)
862 vub300
->fbs
[2] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[2]);
863 else if ((0xFBFFFE00 & cmd_arg
) == 0x80062200)
864 vub300
->fbs
[3] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[3]);
865 else if ((0xFBFFFE00 & cmd_arg
) == 0x80062000)
866 vub300
->fbs
[3] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[3]);
867 else if ((0xFBFFFE00 & cmd_arg
) == 0x80082200)
868 vub300
->fbs
[4] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[4]);
869 else if ((0xFBFFFE00 & cmd_arg
) == 0x80082000)
870 vub300
->fbs
[4] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[4]);
871 else if ((0xFBFFFE00 & cmd_arg
) == 0x800A2200)
872 vub300
->fbs
[5] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[5]);
873 else if ((0xFBFFFE00 & cmd_arg
) == 0x800A2000)
874 vub300
->fbs
[5] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[5]);
875 else if ((0xFBFFFE00 & cmd_arg
) == 0x800C2200)
876 vub300
->fbs
[6] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[6]);
877 else if ((0xFBFFFE00 & cmd_arg
) == 0x800C2000)
878 vub300
->fbs
[6] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[6]);
879 else if ((0xFBFFFE00 & cmd_arg
) == 0x800E2200)
880 vub300
->fbs
[7] = (cmd_arg
<< 8) | (0x00FF & vub300
->fbs
[7]);
881 else if ((0xFBFFFE00 & cmd_arg
) == 0x800E2000)
882 vub300
->fbs
[7] = (0xFF & cmd_arg
) | (0xFF00 & vub300
->fbs
[7]);
883 else if ((0xFBFFFE03 & cmd_arg
) == 0x80000E00)
884 vub300
->bus_width
= 1;
885 else if ((0xFBFFFE03 & cmd_arg
) == 0x80000E02)
886 vub300
->bus_width
= 4;
889 static void send_command(struct vub300_mmc_host
*vub300
)
891 /* cmd_mutex is held by vub300_cmndwork_thread */
892 struct mmc_command
*cmd
= vub300
->cmd
;
893 struct mmc_data
*data
= vub300
->data
;
897 if (vub300
->app_spec
) {
898 switch (cmd
->opcode
) {
900 response_type
= SDRT_1
;
901 vub300
->resp_len
= 6;
902 if (0x00000000 == (0x00000003 & cmd
->arg
))
903 vub300
->bus_width
= 1;
904 else if (0x00000002 == (0x00000003 & cmd
->arg
))
905 vub300
->bus_width
= 4;
907 dev_err(&vub300
->udev
->dev
,
908 "unexpected ACMD6 bus_width=%d\n",
909 0x00000003 & cmd
->arg
);
912 response_type
= SDRT_1
;
913 vub300
->resp_len
= 6;
916 response_type
= SDRT_1
;
917 vub300
->resp_len
= 6;
920 response_type
= SDRT_1
;
921 vub300
->resp_len
= 6;
924 response_type
= SDRT_3
;
925 vub300
->resp_len
= 6;
928 response_type
= SDRT_1
;
929 vub300
->resp_len
= 6;
932 response_type
= SDRT_1
;
933 vub300
->resp_len
= 6;
936 response_type
= SDRT_1
;
937 vub300
->resp_len
= 6;
940 vub300
->resp_len
= 0;
941 cmd
->error
= -EINVAL
;
942 complete(&vub300
->command_complete
);
945 vub300
->app_spec
= 0;
947 switch (cmd
->opcode
) {
949 response_type
= SDRT_NONE
;
950 vub300
->resp_len
= 0;
953 response_type
= SDRT_3
;
954 vub300
->resp_len
= 6;
957 response_type
= SDRT_2
;
958 vub300
->resp_len
= 17;
961 response_type
= SDRT_6
;
962 vub300
->resp_len
= 6;
965 response_type
= SDRT_NONE
;
966 vub300
->resp_len
= 0;
969 response_type
= SDRT_4
;
970 vub300
->resp_len
= 6;
973 response_type
= SDRT_1
;
974 vub300
->resp_len
= 6;
977 response_type
= SDRT_1B
;
978 vub300
->resp_len
= 6;
981 response_type
= SDRT_7
;
982 vub300
->resp_len
= 6;
985 response_type
= SDRT_2
;
986 vub300
->resp_len
= 17;
989 response_type
= SDRT_2
;
990 vub300
->resp_len
= 17;
993 response_type
= SDRT_1B
;
994 vub300
->resp_len
= 6;
997 response_type
= SDRT_1
;
998 vub300
->resp_len
= 6;
1001 response_type
= SDRT_NONE
;
1002 vub300
->resp_len
= 0;
1005 for (i
= 0; i
< ARRAY_SIZE(vub300
->fbs
); i
++)
1006 vub300
->fbs
[i
] = 0xFFFF & cmd
->arg
;
1007 response_type
= SDRT_1
;
1008 vub300
->resp_len
= 6;
1015 response_type
= SDRT_1
;
1016 vub300
->resp_len
= 6;
1020 response_type
= SDRT_1B
;
1021 vub300
->resp_len
= 6;
1026 response_type
= SDRT_1
;
1027 vub300
->resp_len
= 6;
1030 response_type
= SDRT_1B
;
1031 vub300
->resp_len
= 6;
1034 response_type
= SDRT_1
;
1035 vub300
->resp_len
= 6;
1038 response_type
= SDRT_5
;
1039 vub300
->resp_len
= 6;
1040 snoop_block_size_and_bus_width(vub300
, cmd
->arg
);
1043 response_type
= SDRT_5
;
1044 vub300
->resp_len
= 6;
1047 response_type
= SDRT_1
;
1048 vub300
->resp_len
= 6;
1049 vub300
->app_spec
= 1;
1052 response_type
= SDRT_1
;
1053 vub300
->resp_len
= 6;
1056 vub300
->resp_len
= 0;
1057 cmd
->error
= -EINVAL
;
1058 complete(&vub300
->command_complete
);
1063 * it is a shame that we can not use "sizeof(struct sd_command_header)"
1064 * this is because the packet _must_ be padded to 64 bytes
1066 vub300
->cmnd
.head
.header_size
= 20;
1067 vub300
->cmnd
.head
.header_type
= 0x00;
1068 vub300
->cmnd
.head
.port_number
= 0; /* "0" means port 1 */
1069 vub300
->cmnd
.head
.command_type
= 0x00; /* standard read command */
1070 vub300
->cmnd
.head
.response_type
= response_type
;
1071 vub300
->cmnd
.head
.command_index
= cmd
->opcode
;
1072 vub300
->cmnd
.head
.arguments
[0] = cmd
->arg
>> 24;
1073 vub300
->cmnd
.head
.arguments
[1] = cmd
->arg
>> 16;
1074 vub300
->cmnd
.head
.arguments
[2] = cmd
->arg
>> 8;
1075 vub300
->cmnd
.head
.arguments
[3] = cmd
->arg
>> 0;
1076 if (cmd
->opcode
== 52) {
1077 int fn
= 0x7 & (cmd
->arg
>> 28);
1078 vub300
->cmnd
.head
.block_count
[0] = 0;
1079 vub300
->cmnd
.head
.block_count
[1] = 0;
1080 vub300
->cmnd
.head
.block_size
[0] = (vub300
->fbs
[fn
] >> 8) & 0xFF;
1081 vub300
->cmnd
.head
.block_size
[1] = (vub300
->fbs
[fn
] >> 0) & 0xFF;
1082 vub300
->cmnd
.head
.command_type
= 0x00;
1083 vub300
->cmnd
.head
.transfer_size
[0] = 0;
1084 vub300
->cmnd
.head
.transfer_size
[1] = 0;
1085 vub300
->cmnd
.head
.transfer_size
[2] = 0;
1086 vub300
->cmnd
.head
.transfer_size
[3] = 0;
1088 vub300
->cmnd
.head
.block_count
[0] = 0;
1089 vub300
->cmnd
.head
.block_count
[1] = 0;
1090 vub300
->cmnd
.head
.block_size
[0] = (vub300
->fbs
[0] >> 8) & 0xFF;
1091 vub300
->cmnd
.head
.block_size
[1] = (vub300
->fbs
[0] >> 0) & 0xFF;
1092 vub300
->cmnd
.head
.command_type
= 0x00;
1093 vub300
->cmnd
.head
.transfer_size
[0] = 0;
1094 vub300
->cmnd
.head
.transfer_size
[1] = 0;
1095 vub300
->cmnd
.head
.transfer_size
[2] = 0;
1096 vub300
->cmnd
.head
.transfer_size
[3] = 0;
1097 } else if (cmd
->opcode
== 53) {
1098 int fn
= 0x7 & (cmd
->arg
>> 28);
1099 if (0x08 & vub300
->cmnd
.head
.arguments
[0]) { /* BLOCK MODE */
1100 vub300
->cmnd
.head
.block_count
[0] =
1101 (data
->blocks
>> 8) & 0xFF;
1102 vub300
->cmnd
.head
.block_count
[1] =
1103 (data
->blocks
>> 0) & 0xFF;
1104 vub300
->cmnd
.head
.block_size
[0] =
1105 (data
->blksz
>> 8) & 0xFF;
1106 vub300
->cmnd
.head
.block_size
[1] =
1107 (data
->blksz
>> 0) & 0xFF;
1108 } else { /* BYTE MODE */
1109 vub300
->cmnd
.head
.block_count
[0] = 0;
1110 vub300
->cmnd
.head
.block_count
[1] = 0;
1111 vub300
->cmnd
.head
.block_size
[0] =
1112 (vub300
->datasize
>> 8) & 0xFF;
1113 vub300
->cmnd
.head
.block_size
[1] =
1114 (vub300
->datasize
>> 0) & 0xFF;
1116 vub300
->cmnd
.head
.command_type
=
1117 (MMC_DATA_READ
& data
->flags
) ? 0x00 : 0x80;
1118 vub300
->cmnd
.head
.transfer_size
[0] =
1119 (vub300
->datasize
>> 24) & 0xFF;
1120 vub300
->cmnd
.head
.transfer_size
[1] =
1121 (vub300
->datasize
>> 16) & 0xFF;
1122 vub300
->cmnd
.head
.transfer_size
[2] =
1123 (vub300
->datasize
>> 8) & 0xFF;
1124 vub300
->cmnd
.head
.transfer_size
[3] =
1125 (vub300
->datasize
>> 0) & 0xFF;
1126 if (vub300
->datasize
< vub300
->fbs
[fn
]) {
1127 vub300
->cmnd
.head
.block_count
[0] = 0;
1128 vub300
->cmnd
.head
.block_count
[1] = 0;
1131 vub300
->cmnd
.head
.block_count
[0] = (data
->blocks
>> 8) & 0xFF;
1132 vub300
->cmnd
.head
.block_count
[1] = (data
->blocks
>> 0) & 0xFF;
1133 vub300
->cmnd
.head
.block_size
[0] = (data
->blksz
>> 8) & 0xFF;
1134 vub300
->cmnd
.head
.block_size
[1] = (data
->blksz
>> 0) & 0xFF;
1135 vub300
->cmnd
.head
.command_type
=
1136 (MMC_DATA_READ
& data
->flags
) ? 0x00 : 0x80;
1137 vub300
->cmnd
.head
.transfer_size
[0] =
1138 (vub300
->datasize
>> 24) & 0xFF;
1139 vub300
->cmnd
.head
.transfer_size
[1] =
1140 (vub300
->datasize
>> 16) & 0xFF;
1141 vub300
->cmnd
.head
.transfer_size
[2] =
1142 (vub300
->datasize
>> 8) & 0xFF;
1143 vub300
->cmnd
.head
.transfer_size
[3] =
1144 (vub300
->datasize
>> 0) & 0xFF;
1145 if (vub300
->datasize
< vub300
->fbs
[0]) {
1146 vub300
->cmnd
.head
.block_count
[0] = 0;
1147 vub300
->cmnd
.head
.block_count
[1] = 0;
1150 if (vub300
->cmnd
.head
.block_size
[0] || vub300
->cmnd
.head
.block_size
[1]) {
1151 u16 block_size
= vub300
->cmnd
.head
.block_size
[1] |
1152 (vub300
->cmnd
.head
.block_size
[0] << 8);
1153 u16 block_boundary
= FIRMWARE_BLOCK_BOUNDARY
-
1154 (FIRMWARE_BLOCK_BOUNDARY
% block_size
);
1155 vub300
->cmnd
.head
.block_boundary
[0] =
1156 (block_boundary
>> 8) & 0xFF;
1157 vub300
->cmnd
.head
.block_boundary
[1] =
1158 (block_boundary
>> 0) & 0xFF;
1160 vub300
->cmnd
.head
.block_boundary
[0] = 0;
1161 vub300
->cmnd
.head
.block_boundary
[1] = 0;
1163 usb_fill_bulk_urb(vub300
->command_out_urb
, vub300
->udev
,
1164 usb_sndbulkpipe(vub300
->udev
, vub300
->cmnd_out_ep
),
1165 &vub300
->cmnd
, sizeof(vub300
->cmnd
),
1166 command_out_completed
, vub300
);
1167 retval
= usb_submit_urb(vub300
->command_out_urb
, GFP_KERNEL
);
1169 cmd
->error
= retval
;
1170 complete(&vub300
->command_complete
);
1178 * timer callback runs in atomic mode
1179 * so it cannot call usb_kill_urb()
1181 static void vub300_sg_timed_out(struct timer_list
*t
)
1183 struct vub300_mmc_host
*vub300
= from_timer(vub300
, t
,
1185 vub300
->usb_timed_out
= 1;
1186 usb_sg_cancel(&vub300
->sg_request
);
1187 usb_unlink_urb(vub300
->command_out_urb
);
1188 usb_unlink_urb(vub300
->command_res_urb
);
1191 static u16
roundup_to_multiple_of_64(u16 number
)
1193 return 0xFFC0 & (0x3F + number
);
1197 * this is a separate function to solve the 80 column width restriction
1199 static void __download_offload_pseudocode(struct vub300_mmc_host
*vub300
,
1200 const struct firmware
*fw
)
1202 u8 register_count
= 0;
1204 u16 interrupt_size
= 0;
1205 const u8
*data
= fw
->data
;
1206 int size
= fw
->size
;
1208 dev_info(&vub300
->udev
->dev
, "using %s for SDIO offload processing\n",
1212 } while (size
-- && c
); /* skip comment */
1213 dev_info(&vub300
->udev
->dev
, "using offload firmware %s %s\n", fw
->data
,
1216 dev_err(&vub300
->udev
->dev
,
1217 "corrupt offload pseudocode in firmware %s\n",
1219 strscpy(vub300
->vub_name
, "corrupt offload pseudocode",
1220 sizeof(vub300
->vub_name
));
1223 interrupt_size
+= *data
++;
1225 interrupt_size
<<= 8;
1226 interrupt_size
+= *data
++;
1228 if (interrupt_size
< size
) {
1229 u16 xfer_length
= roundup_to_multiple_of_64(interrupt_size
);
1230 u8
*xfer_buffer
= kmalloc(xfer_length
, GFP_KERNEL
);
1233 memcpy(xfer_buffer
, data
, interrupt_size
);
1234 memset(xfer_buffer
+ interrupt_size
, 0,
1235 xfer_length
- interrupt_size
);
1236 size
-= interrupt_size
;
1237 data
+= interrupt_size
;
1239 usb_control_msg(vub300
->udev
,
1240 usb_sndctrlpipe(vub300
->udev
, 0),
1241 SET_INTERRUPT_PSEUDOCODE
,
1242 USB_DIR_OUT
| USB_TYPE_VENDOR
|
1243 USB_RECIP_DEVICE
, 0x0000, 0x0000,
1244 xfer_buffer
, xfer_length
, 1000);
1247 goto copy_error_message
;
1249 dev_err(&vub300
->udev
->dev
,
1250 "not enough memory for xfer buffer to send"
1251 " INTERRUPT_PSEUDOCODE for %s %s\n", fw
->data
,
1253 strscpy(vub300
->vub_name
,
1254 "SDIO interrupt pseudocode download failed",
1255 sizeof(vub300
->vub_name
));
1259 dev_err(&vub300
->udev
->dev
,
1260 "corrupt interrupt pseudocode in firmware %s %s\n",
1261 fw
->data
, vub300
->vub_name
);
1262 strscpy(vub300
->vub_name
, "corrupt interrupt pseudocode",
1263 sizeof(vub300
->vub_name
));
1272 u16 xfer_length
= roundup_to_multiple_of_64(ts
);
1273 u8
*xfer_buffer
= kmalloc(xfer_length
, GFP_KERNEL
);
1276 memcpy(xfer_buffer
, data
, ts
);
1277 memset(xfer_buffer
+ ts
, 0,
1282 usb_control_msg(vub300
->udev
,
1283 usb_sndctrlpipe(vub300
->udev
, 0),
1284 SET_TRANSFER_PSEUDOCODE
,
1285 USB_DIR_OUT
| USB_TYPE_VENDOR
|
1286 USB_RECIP_DEVICE
, 0x0000, 0x0000,
1287 xfer_buffer
, xfer_length
, 1000);
1290 goto copy_error_message
;
1292 dev_err(&vub300
->udev
->dev
,
1293 "not enough memory for xfer buffer to send"
1294 " TRANSFER_PSEUDOCODE for %s %s\n", fw
->data
,
1296 strscpy(vub300
->vub_name
,
1297 "SDIO transfer pseudocode download failed",
1298 sizeof(vub300
->vub_name
));
1302 dev_err(&vub300
->udev
->dev
,
1303 "corrupt transfer pseudocode in firmware %s %s\n",
1304 fw
->data
, vub300
->vub_name
);
1305 strscpy(vub300
->vub_name
, "corrupt transfer pseudocode",
1306 sizeof(vub300
->vub_name
));
1309 register_count
+= *data
++;
1311 if (register_count
* 4 == size
) {
1312 int I
= vub300
->dynamic_register_count
= register_count
;
1315 unsigned int func_num
= 0;
1316 vub300
->sdio_register
[i
].func_num
= *data
++;
1318 func_num
+= *data
++;
1321 func_num
+= *data
++;
1324 func_num
+= *data
++;
1326 vub300
->sdio_register
[i
].sdio_reg
= func_num
;
1327 vub300
->sdio_register
[i
].activate
= 1;
1328 vub300
->sdio_register
[i
].prepared
= 0;
1331 dev_info(&vub300
->udev
->dev
,
1332 "initialized %d dynamic pseudocode registers\n",
1333 vub300
->dynamic_register_count
);
1336 dev_err(&vub300
->udev
->dev
,
1337 "corrupt dynamic registers in firmware %s\n",
1339 strscpy(vub300
->vub_name
, "corrupt dynamic registers",
1340 sizeof(vub300
->vub_name
));
1345 strscpy(vub300
->vub_name
, "SDIO pseudocode download failed",
1346 sizeof(vub300
->vub_name
));
1350 * if the binary containing the EMPTY PseudoCode can not be found
1351 * vub300->vub_name is set anyway in order to prevent an automatic retry
1353 static void download_offload_pseudocode(struct vub300_mmc_host
*vub300
)
1355 struct mmc_card
*card
= vub300
->mmc
->card
;
1356 int sdio_funcs
= card
->sdio_funcs
;
1357 const struct firmware
*fw
= NULL
;
1358 int l
= snprintf(vub300
->vub_name
, sizeof(vub300
->vub_name
),
1359 "vub_%04X%04X", card
->cis
.vendor
, card
->cis
.device
);
1362 for (n
= 0; n
< sdio_funcs
; n
++) {
1363 struct sdio_func
*sf
= card
->sdio_func
[n
];
1364 l
+= scnprintf(vub300
->vub_name
+ l
,
1365 sizeof(vub300
->vub_name
) - l
, "_%04X%04X",
1366 sf
->vendor
, sf
->device
);
1368 snprintf(vub300
->vub_name
+ l
, sizeof(vub300
->vub_name
) - l
, ".bin");
1369 dev_info(&vub300
->udev
->dev
, "requesting offload firmware %s\n",
1371 retval
= request_firmware(&fw
, vub300
->vub_name
, &card
->dev
);
1373 strscpy(vub300
->vub_name
, "vub_default.bin",
1374 sizeof(vub300
->vub_name
));
1375 retval
= request_firmware(&fw
, vub300
->vub_name
, &card
->dev
);
1377 strscpy(vub300
->vub_name
,
1378 "no SDIO offload firmware found",
1379 sizeof(vub300
->vub_name
));
1381 __download_offload_pseudocode(vub300
, fw
);
1382 release_firmware(fw
);
1385 __download_offload_pseudocode(vub300
, fw
);
1386 release_firmware(fw
);
1390 static void vub300_usb_bulk_msg_completion(struct urb
*urb
)
1391 { /* urb completion handler - hardirq */
1392 complete((struct completion
*)urb
->context
);
1395 static int vub300_usb_bulk_msg(struct vub300_mmc_host
*vub300
,
1396 unsigned int pipe
, void *data
, int len
,
1397 int *actual_length
, int timeout_msecs
)
1399 /* cmd_mutex is held by vub300_cmndwork_thread */
1400 struct usb_device
*usb_dev
= vub300
->udev
;
1401 struct completion done
;
1403 vub300
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1406 usb_fill_bulk_urb(vub300
->urb
, usb_dev
, pipe
, data
, len
,
1407 vub300_usb_bulk_msg_completion
, NULL
);
1408 init_completion(&done
);
1409 vub300
->urb
->context
= &done
;
1410 vub300
->urb
->actual_length
= 0;
1411 retval
= usb_submit_urb(vub300
->urb
, GFP_KERNEL
);
1412 if (unlikely(retval
))
1414 if (!wait_for_completion_timeout
1415 (&done
, msecs_to_jiffies(timeout_msecs
))) {
1416 retval
= -ETIMEDOUT
;
1417 usb_kill_urb(vub300
->urb
);
1419 retval
= vub300
->urb
->status
;
1422 *actual_length
= vub300
->urb
->actual_length
;
1423 usb_free_urb(vub300
->urb
);
1428 static int __command_read_data(struct vub300_mmc_host
*vub300
,
1429 struct mmc_command
*cmd
, struct mmc_data
*data
)
1431 /* cmd_mutex is held by vub300_cmndwork_thread */
1432 int linear_length
= vub300
->datasize
;
1433 int padded_length
= vub300
->large_usb_packets
?
1434 ((511 + linear_length
) >> 9) << 9 :
1435 ((63 + linear_length
) >> 6) << 6;
1436 if ((padded_length
== linear_length
) || !pad_input_to_usb_pkt
) {
1439 pipe
= usb_rcvbulkpipe(vub300
->udev
, vub300
->data_inp_ep
);
1440 result
= usb_sg_init(&vub300
->sg_request
, vub300
->udev
,
1442 data
->sg_len
, 0, GFP_KERNEL
);
1444 usb_unlink_urb(vub300
->command_out_urb
);
1445 usb_unlink_urb(vub300
->command_res_urb
);
1446 cmd
->error
= result
;
1447 data
->bytes_xfered
= 0;
1450 vub300
->sg_transfer_timer
.expires
=
1451 jiffies
+ msecs_to_jiffies(2000 +
1452 (linear_length
/ 16384));
1453 add_timer(&vub300
->sg_transfer_timer
);
1454 usb_sg_wait(&vub300
->sg_request
);
1455 del_timer(&vub300
->sg_transfer_timer
);
1456 if (vub300
->sg_request
.status
< 0) {
1457 cmd
->error
= vub300
->sg_request
.status
;
1458 data
->bytes_xfered
= 0;
1461 data
->bytes_xfered
= vub300
->datasize
;
1462 return linear_length
;
1466 u8
*buf
= kmalloc(padded_length
, GFP_KERNEL
);
1469 unsigned pipe
= usb_rcvbulkpipe(vub300
->udev
,
1470 vub300
->data_inp_ep
);
1471 int actual_length
= 0;
1472 result
= vub300_usb_bulk_msg(vub300
, pipe
, buf
,
1473 padded_length
, &actual_length
,
1474 2000 + (padded_length
/ 16384));
1476 cmd
->error
= result
;
1477 data
->bytes_xfered
= 0;
1480 } else if (actual_length
< linear_length
) {
1481 cmd
->error
= -EREMOTEIO
;
1482 data
->bytes_xfered
= 0;
1486 sg_copy_from_buffer(data
->sg
, data
->sg_len
, buf
,
1489 data
->bytes_xfered
= vub300
->datasize
;
1490 return linear_length
;
1493 cmd
->error
= -ENOMEM
;
1494 data
->bytes_xfered
= 0;
1500 static int __command_write_data(struct vub300_mmc_host
*vub300
,
1501 struct mmc_command
*cmd
, struct mmc_data
*data
)
1503 /* cmd_mutex is held by vub300_cmndwork_thread */
1504 unsigned pipe
= usb_sndbulkpipe(vub300
->udev
, vub300
->data_out_ep
);
1505 int linear_length
= vub300
->datasize
;
1506 int modulo_64_length
= linear_length
& 0x003F;
1507 int modulo_512_length
= linear_length
& 0x01FF;
1508 if (linear_length
< 64) {
1511 sg_copy_to_buffer(data
->sg
, data
->sg_len
,
1512 vub300
->padded_buffer
,
1513 sizeof(vub300
->padded_buffer
));
1514 memset(vub300
->padded_buffer
+ linear_length
, 0,
1515 sizeof(vub300
->padded_buffer
) - linear_length
);
1516 result
= vub300_usb_bulk_msg(vub300
, pipe
, vub300
->padded_buffer
,
1517 sizeof(vub300
->padded_buffer
),
1518 &actual_length
, 2000 +
1519 (sizeof(vub300
->padded_buffer
) /
1522 cmd
->error
= result
;
1523 data
->bytes_xfered
= 0;
1525 data
->bytes_xfered
= vub300
->datasize
;
1527 } else if ((!vub300
->large_usb_packets
&& (0 < modulo_64_length
)) ||
1528 (vub300
->large_usb_packets
&& (64 > modulo_512_length
))
1529 ) { /* don't you just love these work-rounds */
1530 int padded_length
= ((63 + linear_length
) >> 6) << 6;
1531 u8
*buf
= kmalloc(padded_length
, GFP_KERNEL
);
1535 sg_copy_to_buffer(data
->sg
, data
->sg_len
, buf
,
1537 memset(buf
+ linear_length
, 0,
1538 padded_length
- linear_length
);
1540 vub300_usb_bulk_msg(vub300
, pipe
, buf
,
1541 padded_length
, &actual_length
,
1542 2000 + padded_length
/ 16384);
1545 cmd
->error
= result
;
1546 data
->bytes_xfered
= 0;
1548 data
->bytes_xfered
= vub300
->datasize
;
1551 cmd
->error
= -ENOMEM
;
1552 data
->bytes_xfered
= 0;
1554 } else { /* no data padding required */
1556 unsigned char buf
[64 * 4];
1557 sg_copy_to_buffer(data
->sg
, data
->sg_len
, buf
, sizeof(buf
));
1558 result
= usb_sg_init(&vub300
->sg_request
, vub300
->udev
,
1560 data
->sg_len
, 0, GFP_KERNEL
);
1562 usb_unlink_urb(vub300
->command_out_urb
);
1563 usb_unlink_urb(vub300
->command_res_urb
);
1564 cmd
->error
= result
;
1565 data
->bytes_xfered
= 0;
1567 vub300
->sg_transfer_timer
.expires
=
1568 jiffies
+ msecs_to_jiffies(2000 +
1569 linear_length
/ 16384);
1570 add_timer(&vub300
->sg_transfer_timer
);
1571 usb_sg_wait(&vub300
->sg_request
);
1573 data
->bytes_xfered
= 0;
1575 del_timer(&vub300
->sg_transfer_timer
);
1576 if (vub300
->sg_request
.status
< 0) {
1577 cmd
->error
= vub300
->sg_request
.status
;
1578 data
->bytes_xfered
= 0;
1580 data
->bytes_xfered
= vub300
->datasize
;
1585 return linear_length
;
1588 static void __vub300_command_response(struct vub300_mmc_host
*vub300
,
1589 struct mmc_command
*cmd
,
1590 struct mmc_data
*data
, int data_length
)
1592 /* cmd_mutex is held by vub300_cmndwork_thread */
1594 int msec_timeout
= 1000 + data_length
/ 4;
1596 wait_for_completion_timeout(&vub300
->command_complete
,
1597 msecs_to_jiffies(msec_timeout
));
1598 if (respretval
== 0) { /* TIMED OUT */
1599 /* we don't know which of "out" and "res" if any failed */
1601 vub300
->usb_timed_out
= 1;
1602 usb_kill_urb(vub300
->command_out_urb
);
1603 usb_kill_urb(vub300
->command_res_urb
);
1604 cmd
->error
= -ETIMEDOUT
;
1605 result
= usb_lock_device_for_reset(vub300
->udev
,
1608 result
= usb_reset_device(vub300
->udev
);
1609 usb_unlock_device(vub300
->udev
);
1611 } else if (respretval
< 0) {
1612 /* we don't know which of "out" and "res" if any failed */
1613 usb_kill_urb(vub300
->command_out_urb
);
1614 usb_kill_urb(vub300
->command_res_urb
);
1615 cmd
->error
= respretval
;
1616 } else if (cmd
->error
) {
1618 * the error occurred sending the command
1619 * or receiving the response
1621 } else if (vub300
->command_out_urb
->status
) {
1622 vub300
->usb_transport_fail
= vub300
->command_out_urb
->status
;
1623 cmd
->error
= -EPROTO
== vub300
->command_out_urb
->status
?
1624 -ESHUTDOWN
: vub300
->command_out_urb
->status
;
1625 } else if (vub300
->command_res_urb
->status
) {
1626 vub300
->usb_transport_fail
= vub300
->command_res_urb
->status
;
1627 cmd
->error
= -EPROTO
== vub300
->command_res_urb
->status
?
1628 -ESHUTDOWN
: vub300
->command_res_urb
->status
;
1629 } else if (vub300
->resp
.common
.header_type
== 0x00) {
1631 * the command completed successfully
1632 * and there was no piggybacked data
1634 } else if (vub300
->resp
.common
.header_type
== RESPONSE_ERROR
) {
1636 vub300_response_error(vub300
->resp
.error
.error_code
);
1638 usb_sg_cancel(&vub300
->sg_request
);
1639 } else if (vub300
->resp
.common
.header_type
== RESPONSE_PIGGYBACKED
) {
1640 int offloaded_data_length
=
1641 vub300
->resp
.common
.header_size
-
1642 sizeof(struct sd_register_header
);
1643 int register_count
= offloaded_data_length
>> 3;
1645 while (register_count
--) {
1646 add_offloaded_reg(vub300
, &vub300
->resp
.pig
.reg
[ri
]);
1649 vub300
->resp
.common
.header_size
=
1650 sizeof(struct sd_register_header
);
1651 vub300
->resp
.common
.header_type
= 0x00;
1653 } else if (vub300
->resp
.common
.header_type
== RESPONSE_PIG_DISABLED
) {
1654 int offloaded_data_length
=
1655 vub300
->resp
.common
.header_size
-
1656 sizeof(struct sd_register_header
);
1657 int register_count
= offloaded_data_length
>> 3;
1659 while (register_count
--) {
1660 add_offloaded_reg(vub300
, &vub300
->resp
.pig
.reg
[ri
]);
1663 mutex_lock(&vub300
->irq_mutex
);
1664 if (vub300
->irqs_queued
) {
1665 vub300
->irqs_queued
+= 1;
1666 } else if (vub300
->irq_enabled
) {
1667 vub300
->irqs_queued
+= 1;
1668 vub300_queue_poll_work(vub300
, 0);
1670 vub300
->irqs_queued
+= 1;
1672 vub300
->irq_disabled
= 1;
1673 mutex_unlock(&vub300
->irq_mutex
);
1674 vub300
->resp
.common
.header_size
=
1675 sizeof(struct sd_register_header
);
1676 vub300
->resp
.common
.header_type
= 0x00;
1678 } else if (vub300
->resp
.common
.header_type
== RESPONSE_PIG_ENABLED
) {
1679 int offloaded_data_length
=
1680 vub300
->resp
.common
.header_size
-
1681 sizeof(struct sd_register_header
);
1682 int register_count
= offloaded_data_length
>> 3;
1684 while (register_count
--) {
1685 add_offloaded_reg(vub300
, &vub300
->resp
.pig
.reg
[ri
]);
1688 mutex_lock(&vub300
->irq_mutex
);
1689 if (vub300
->irqs_queued
) {
1690 vub300
->irqs_queued
+= 1;
1691 } else if (vub300
->irq_enabled
) {
1692 vub300
->irqs_queued
+= 1;
1693 vub300_queue_poll_work(vub300
, 0);
1695 vub300
->irqs_queued
+= 1;
1697 vub300
->irq_disabled
= 0;
1698 mutex_unlock(&vub300
->irq_mutex
);
1699 vub300
->resp
.common
.header_size
=
1700 sizeof(struct sd_register_header
);
1701 vub300
->resp
.common
.header_type
= 0x00;
1704 cmd
->error
= -EINVAL
;
1708 static void construct_request_response(struct vub300_mmc_host
*vub300
,
1709 struct mmc_command
*cmd
)
1711 int resp_len
= vub300
->resp_len
;
1712 int less_cmd
= (17 == resp_len
) ? resp_len
: resp_len
- 1;
1713 int bytes
= 3 & less_cmd
;
1714 int words
= less_cmd
>> 2;
1715 u8
*r
= vub300
->resp
.response
.command_response
;
1720 cmd
->resp
[words
] = (r
[1 + (words
<< 2)] << 24)
1721 | (r
[2 + (words
<< 2)] << 16)
1722 | (r
[3 + (words
<< 2)] << 8);
1723 } else if (bytes
== 2) {
1724 cmd
->resp
[words
] = (r
[1 + (words
<< 2)] << 24)
1725 | (r
[2 + (words
<< 2)] << 16);
1726 } else if (bytes
== 1) {
1727 cmd
->resp
[words
] = (r
[1 + (words
<< 2)] << 24);
1729 while (words
-- > 0) {
1730 cmd
->resp
[words
] = (r
[1 + (words
<< 2)] << 24)
1731 | (r
[2 + (words
<< 2)] << 16)
1732 | (r
[3 + (words
<< 2)] << 8)
1733 | (r
[4 + (words
<< 2)] << 0);
1735 if ((cmd
->opcode
== 53) && (0x000000FF & cmd
->resp
[0]))
1736 cmd
->resp
[0] &= 0xFFFFFF00;
1739 /* this thread runs only when there is an upper level command req outstanding */
1740 static void vub300_cmndwork_thread(struct work_struct
*work
)
1742 struct vub300_mmc_host
*vub300
=
1743 container_of(work
, struct vub300_mmc_host
, cmndwork
);
1744 if (!vub300
->interface
) {
1745 kref_put(&vub300
->kref
, vub300_delete
);
1748 struct mmc_request
*req
= vub300
->req
;
1749 struct mmc_command
*cmd
= vub300
->cmd
;
1750 struct mmc_data
*data
= vub300
->data
;
1752 mutex_lock(&vub300
->cmd_mutex
);
1753 init_completion(&vub300
->command_complete
);
1754 if (likely(vub300
->vub_name
[0]) || !vub300
->mmc
->card
) {
1756 * the name of the EMPTY Pseudo firmware file
1757 * is used as a flag to indicate that the file
1758 * has been already downloaded to the VUB300 chip
1760 } else if (0 == vub300
->mmc
->card
->sdio_funcs
) {
1761 strscpy(vub300
->vub_name
, "SD memory device",
1762 sizeof(vub300
->vub_name
));
1764 download_offload_pseudocode(vub300
);
1766 send_command(vub300
);
1769 else if (MMC_DATA_READ
& data
->flags
)
1770 data_length
= __command_read_data(vub300
, cmd
, data
);
1772 data_length
= __command_write_data(vub300
, cmd
, data
);
1773 __vub300_command_response(vub300
, cmd
, data
, data_length
);
1776 vub300
->data
= NULL
;
1778 if (cmd
->error
== -ENOMEDIUM
)
1779 check_vub300_port_status(vub300
);
1780 mutex_unlock(&vub300
->cmd_mutex
);
1781 mmc_request_done(vub300
->mmc
, req
);
1782 kref_put(&vub300
->kref
, vub300_delete
);
1785 construct_request_response(vub300
, cmd
);
1786 vub300
->resp_len
= 0;
1787 mutex_unlock(&vub300
->cmd_mutex
);
1788 kref_put(&vub300
->kref
, vub300_delete
);
1789 mmc_request_done(vub300
->mmc
, req
);
1795 static int examine_cyclic_buffer(struct vub300_mmc_host
*vub300
,
1796 struct mmc_command
*cmd
, u8 Function
)
1798 /* cmd_mutex is held by vub300_mmc_request */
1799 u8 cmd0
= 0xFF & (cmd
->arg
>> 24);
1800 u8 cmd1
= 0xFF & (cmd
->arg
>> 16);
1801 u8 cmd2
= 0xFF & (cmd
->arg
>> 8);
1802 u8 cmd3
= 0xFF & (cmd
->arg
>> 0);
1803 int first
= MAXREGMASK
& vub300
->fn
[Function
].offload_point
;
1804 struct offload_registers_access
*rf
= &vub300
->fn
[Function
].reg
[first
];
1805 if (cmd0
== rf
->command_byte
[0] &&
1806 cmd1
== rf
->command_byte
[1] &&
1807 cmd2
== rf
->command_byte
[2] &&
1808 cmd3
== rf
->command_byte
[3]) {
1810 cmd
->resp
[1] = checksum
<< 24;
1811 cmd
->resp
[0] = (rf
->Respond_Byte
[0] << 24)
1812 | (rf
->Respond_Byte
[1] << 16)
1813 | (rf
->Respond_Byte
[2] << 8)
1814 | (rf
->Respond_Byte
[3] << 0);
1815 vub300
->fn
[Function
].offload_point
+= 1;
1816 vub300
->fn
[Function
].offload_count
-= 1;
1817 vub300
->total_offload_count
-= 1;
1820 int delta
= 1; /* because it does not match the first one */
1821 u8 register_count
= vub300
->fn
[Function
].offload_count
- 1;
1822 u32 register_point
= vub300
->fn
[Function
].offload_point
+ 1;
1823 while (0 < register_count
) {
1824 int point
= MAXREGMASK
& register_point
;
1825 struct offload_registers_access
*r
=
1826 &vub300
->fn
[Function
].reg
[point
];
1827 if (cmd0
== r
->command_byte
[0] &&
1828 cmd1
== r
->command_byte
[1] &&
1829 cmd2
== r
->command_byte
[2] &&
1830 cmd3
== r
->command_byte
[3]) {
1832 cmd
->resp
[1] = checksum
<< 24;
1833 cmd
->resp
[0] = (r
->Respond_Byte
[0] << 24)
1834 | (r
->Respond_Byte
[1] << 16)
1835 | (r
->Respond_Byte
[2] << 8)
1836 | (r
->Respond_Byte
[3] << 0);
1837 vub300
->fn
[Function
].offload_point
+= delta
;
1838 vub300
->fn
[Function
].offload_count
-= delta
;
1839 vub300
->total_offload_count
-= delta
;
1842 register_point
+= 1;
1843 register_count
-= 1;
1852 static int satisfy_request_from_offloaded_data(struct vub300_mmc_host
*vub300
,
1853 struct mmc_command
*cmd
)
1855 /* cmd_mutex is held by vub300_mmc_request */
1856 u8 regs
= vub300
->dynamic_register_count
;
1860 while (0 < regs
--) {
1861 if ((vub300
->sdio_register
[i
].func_num
== func
) &&
1862 (vub300
->sdio_register
[i
].sdio_reg
== reg
)) {
1863 if (!vub300
->sdio_register
[i
].prepared
) {
1865 } else if ((0x80000000 & cmd
->arg
) == 0x80000000) {
1867 * a write to a dynamic register
1868 * nullifies our offloaded value
1870 vub300
->sdio_register
[i
].prepared
= 0;
1876 u8 rsp2
= vub300
->sdio_register
[i
].response
;
1877 u8 rsp3
= vub300
->sdio_register
[i
].regvalue
;
1878 vub300
->sdio_register
[i
].prepared
= 0;
1879 cmd
->resp
[1] = checksum
<< 24;
1880 cmd
->resp
[0] = (rsp0
<< 24)
1891 if (vub300
->total_offload_count
== 0)
1893 else if (vub300
->fn
[func
].offload_count
== 0)
1896 return examine_cyclic_buffer(vub300
, cmd
, func
);
1899 static void vub300_mmc_request(struct mmc_host
*mmc
, struct mmc_request
*req
)
1901 struct mmc_command
*cmd
= req
->cmd
;
1902 struct vub300_mmc_host
*vub300
= mmc_priv(mmc
);
1903 if (!vub300
->interface
) {
1904 cmd
->error
= -ESHUTDOWN
;
1905 mmc_request_done(mmc
, req
);
1908 struct mmc_data
*data
= req
->data
;
1909 if (!vub300
->card_powered
) {
1910 cmd
->error
= -ENOMEDIUM
;
1911 mmc_request_done(mmc
, req
);
1914 if (!vub300
->card_present
) {
1915 cmd
->error
= -ENOMEDIUM
;
1916 mmc_request_done(mmc
, req
);
1919 if (vub300
->usb_transport_fail
) {
1920 cmd
->error
= vub300
->usb_transport_fail
;
1921 mmc_request_done(mmc
, req
);
1924 if (!vub300
->interface
) {
1925 cmd
->error
= -ENODEV
;
1926 mmc_request_done(mmc
, req
);
1929 kref_get(&vub300
->kref
);
1930 mutex_lock(&vub300
->cmd_mutex
);
1931 mod_timer(&vub300
->inactivity_timer
, jiffies
+ HZ
);
1933 * for performance we have to return immediately
1934 * if the requested data has been offloaded
1936 if (cmd
->opcode
== 52 &&
1937 satisfy_request_from_offloaded_data(vub300
, cmd
)) {
1939 mutex_unlock(&vub300
->cmd_mutex
);
1940 kref_put(&vub300
->kref
, vub300_delete
);
1941 mmc_request_done(mmc
, req
);
1946 vub300
->data
= data
;
1948 vub300
->datasize
= data
->blksz
* data
->blocks
;
1950 vub300
->datasize
= 0;
1951 vub300_queue_cmnd_work(vub300
);
1952 mutex_unlock(&vub300
->cmd_mutex
);
1953 kref_put(&vub300
->kref
, vub300_delete
);
1955 * the kernel lock diagnostics complain
1956 * if the cmd_mutex * is "passed on"
1957 * to the cmndwork thread,
1958 * so we must release it now
1959 * and re-acquire it in the cmndwork thread
1965 static void __set_clock_speed(struct vub300_mmc_host
*vub300
, u8 buf
[8],
1966 struct mmc_ios
*ios
)
1968 int buf_array_size
= 8; /* ARRAY_SIZE(buf) does not work !!! */
1971 if (ios
->clock
>= 48000000)
1973 else if (ios
->clock
>= 24000000)
1975 else if (ios
->clock
>= 20000000)
1977 else if (ios
->clock
>= 15000000)
1979 else if (ios
->clock
>= 200000)
1986 for (i
= 0; i
< buf_array_size
; i
++) {
1992 usb_control_msg(vub300
->udev
, usb_sndctrlpipe(vub300
->udev
, 0),
1994 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
1995 0x00, 0x00, buf
, buf_array_size
, 1000);
1997 dev_err(&vub300
->udev
->dev
, "SET_CLOCK_SPEED"
1998 " %dkHz failed with retval=%d\n", kHzClock
, retval
);
2000 dev_dbg(&vub300
->udev
->dev
, "SET_CLOCK_SPEED"
2001 " %dkHz\n", kHzClock
);
2005 static void vub300_mmc_set_ios(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
2007 struct vub300_mmc_host
*vub300
= mmc_priv(mmc
);
2008 if (!vub300
->interface
)
2010 kref_get(&vub300
->kref
);
2011 mutex_lock(&vub300
->cmd_mutex
);
2012 if ((ios
->power_mode
== MMC_POWER_OFF
) && vub300
->card_powered
) {
2013 vub300
->card_powered
= 0;
2014 usb_control_msg(vub300
->udev
, usb_sndctrlpipe(vub300
->udev
, 0),
2016 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
2017 0x0000, 0x0000, NULL
, 0, 1000);
2018 /* must wait for the VUB300 u-proc to boot up */
2020 } else if ((ios
->power_mode
== MMC_POWER_UP
) && !vub300
->card_powered
) {
2021 usb_control_msg(vub300
->udev
, usb_sndctrlpipe(vub300
->udev
, 0),
2023 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
2024 0x0001, 0x0000, NULL
, 0, 1000);
2026 vub300
->card_powered
= 1;
2027 } else if (ios
->power_mode
== MMC_POWER_ON
) {
2028 u8
*buf
= kmalloc(8, GFP_KERNEL
);
2030 __set_clock_speed(vub300
, buf
, ios
);
2034 /* this should mean no change of state */
2036 mutex_unlock(&vub300
->cmd_mutex
);
2037 kref_put(&vub300
->kref
, vub300_delete
);
2040 static int vub300_mmc_get_ro(struct mmc_host
*mmc
)
2042 struct vub300_mmc_host
*vub300
= mmc_priv(mmc
);
2043 return vub300
->read_only
;
2046 static void vub300_enable_sdio_irq(struct mmc_host
*mmc
, int enable
)
2048 struct vub300_mmc_host
*vub300
= mmc_priv(mmc
);
2049 if (!vub300
->interface
)
2051 kref_get(&vub300
->kref
);
2053 set_current_state(TASK_RUNNING
);
2054 mutex_lock(&vub300
->irq_mutex
);
2055 if (vub300
->irqs_queued
) {
2056 vub300
->irqs_queued
-= 1;
2057 mmc_signal_sdio_irq(vub300
->mmc
);
2058 } else if (vub300
->irq_disabled
) {
2059 vub300
->irq_disabled
= 0;
2060 vub300
->irq_enabled
= 1;
2061 vub300_queue_poll_work(vub300
, 0);
2062 } else if (vub300
->irq_enabled
) {
2063 /* this should not happen, so we will just ignore it */
2065 vub300
->irq_enabled
= 1;
2066 vub300_queue_poll_work(vub300
, 0);
2068 mutex_unlock(&vub300
->irq_mutex
);
2069 set_current_state(TASK_INTERRUPTIBLE
);
2071 vub300
->irq_enabled
= 0;
2073 kref_put(&vub300
->kref
, vub300_delete
);
2076 static const struct mmc_host_ops vub300_mmc_ops
= {
2077 .request
= vub300_mmc_request
,
2078 .set_ios
= vub300_mmc_set_ios
,
2079 .get_ro
= vub300_mmc_get_ro
,
2080 .enable_sdio_irq
= vub300_enable_sdio_irq
,
2083 static int vub300_probe(struct usb_interface
*interface
,
2084 const struct usb_device_id
*id
)
2086 struct vub300_mmc_host
*vub300
;
2087 struct usb_host_interface
*iface_desc
;
2088 struct usb_device
*udev
= usb_get_dev(interface_to_usbdev(interface
));
2090 int retval
= -ENOMEM
;
2091 struct urb
*command_out_urb
;
2092 struct urb
*command_res_urb
;
2093 struct mmc_host
*mmc
;
2094 char manufacturer
[48];
2096 char serial_number
[32];
2097 usb_string(udev
, udev
->descriptor
.iManufacturer
, manufacturer
,
2098 sizeof(manufacturer
));
2099 usb_string(udev
, udev
->descriptor
.iProduct
, product
, sizeof(product
));
2100 usb_string(udev
, udev
->descriptor
.iSerialNumber
, serial_number
,
2101 sizeof(serial_number
));
2102 dev_info(&udev
->dev
, "probing VID:PID(%04X:%04X) %s %s %s\n",
2103 le16_to_cpu(udev
->descriptor
.idVendor
),
2104 le16_to_cpu(udev
->descriptor
.idProduct
),
2105 manufacturer
, product
, serial_number
);
2106 command_out_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2107 if (!command_out_urb
) {
2111 command_res_urb
= usb_alloc_urb(0, GFP_KERNEL
);
2112 if (!command_res_urb
) {
2116 /* this also allocates memory for our VUB300 mmc host device */
2117 mmc
= mmc_alloc_host(sizeof(struct vub300_mmc_host
), &udev
->dev
);
2120 dev_err(&udev
->dev
, "not enough memory for the mmc_host\n");
2123 /* MMC core transfer sizes tunable parameters */
2125 if (!force_1_bit_data_xfers
)
2126 mmc
->caps
|= MMC_CAP_4_BIT_DATA
;
2127 if (!force_polling_for_irqs
)
2128 mmc
->caps
|= MMC_CAP_SDIO_IRQ
;
2129 mmc
->caps
&= ~MMC_CAP_NEEDS_POLL
;
2131 * MMC_CAP_NEEDS_POLL causes core.c:mmc_rescan() to poll
2132 * for devices which results in spurious CMD7's being
2133 * issued which stops some SDIO cards from working
2135 if (limit_speed_to_24_MHz
) {
2136 mmc
->caps
|= MMC_CAP_MMC_HIGHSPEED
;
2137 mmc
->caps
|= MMC_CAP_SD_HIGHSPEED
;
2138 mmc
->f_max
= 24000000;
2139 dev_info(&udev
->dev
, "limiting SDIO speed to 24_MHz\n");
2141 mmc
->caps
|= MMC_CAP_MMC_HIGHSPEED
;
2142 mmc
->caps
|= MMC_CAP_SD_HIGHSPEED
;
2143 mmc
->f_max
= 48000000;
2145 mmc
->f_min
= 200000;
2146 mmc
->max_blk_count
= 511;
2147 mmc
->max_blk_size
= 512;
2148 mmc
->max_segs
= 128;
2149 if (force_max_req_size
)
2150 mmc
->max_req_size
= force_max_req_size
* 1024;
2152 mmc
->max_req_size
= 64 * 1024;
2153 mmc
->max_seg_size
= mmc
->max_req_size
;
2155 mmc
->ocr_avail
|= MMC_VDD_165_195
;
2156 mmc
->ocr_avail
|= MMC_VDD_20_21
;
2157 mmc
->ocr_avail
|= MMC_VDD_21_22
;
2158 mmc
->ocr_avail
|= MMC_VDD_22_23
;
2159 mmc
->ocr_avail
|= MMC_VDD_23_24
;
2160 mmc
->ocr_avail
|= MMC_VDD_24_25
;
2161 mmc
->ocr_avail
|= MMC_VDD_25_26
;
2162 mmc
->ocr_avail
|= MMC_VDD_26_27
;
2163 mmc
->ocr_avail
|= MMC_VDD_27_28
;
2164 mmc
->ocr_avail
|= MMC_VDD_28_29
;
2165 mmc
->ocr_avail
|= MMC_VDD_29_30
;
2166 mmc
->ocr_avail
|= MMC_VDD_30_31
;
2167 mmc
->ocr_avail
|= MMC_VDD_31_32
;
2168 mmc
->ocr_avail
|= MMC_VDD_32_33
;
2169 mmc
->ocr_avail
|= MMC_VDD_33_34
;
2170 mmc
->ocr_avail
|= MMC_VDD_34_35
;
2171 mmc
->ocr_avail
|= MMC_VDD_35_36
;
2172 mmc
->ops
= &vub300_mmc_ops
;
2173 vub300
= mmc_priv(mmc
);
2175 vub300
->card_powered
= 0;
2176 vub300
->bus_width
= 0;
2177 vub300
->cmnd
.head
.block_size
[0] = 0x00;
2178 vub300
->cmnd
.head
.block_size
[1] = 0x00;
2179 vub300
->app_spec
= 0;
2180 mutex_init(&vub300
->cmd_mutex
);
2181 mutex_init(&vub300
->irq_mutex
);
2182 vub300
->command_out_urb
= command_out_urb
;
2183 vub300
->command_res_urb
= command_res_urb
;
2184 vub300
->usb_timed_out
= 0;
2185 vub300
->dynamic_register_count
= 0;
2187 for (i
= 0; i
< ARRAY_SIZE(vub300
->fn
); i
++) {
2188 vub300
->fn
[i
].offload_point
= 0;
2189 vub300
->fn
[i
].offload_count
= 0;
2192 vub300
->total_offload_count
= 0;
2193 vub300
->irq_enabled
= 0;
2194 vub300
->irq_disabled
= 0;
2195 vub300
->irqs_queued
= 0;
2197 for (i
= 0; i
< ARRAY_SIZE(vub300
->sdio_register
); i
++)
2198 vub300
->sdio_register
[i
++].activate
= 0;
2200 vub300
->udev
= udev
;
2201 vub300
->interface
= interface
;
2202 vub300
->cmnd_res_ep
= 0;
2203 vub300
->cmnd_out_ep
= 0;
2204 vub300
->data_inp_ep
= 0;
2205 vub300
->data_out_ep
= 0;
2207 for (i
= 0; i
< ARRAY_SIZE(vub300
->fbs
); i
++)
2208 vub300
->fbs
[i
] = 512;
2211 * set up the endpoint information
2213 * use the first pair of bulk-in and bulk-out
2214 * endpoints for Command/Response+Interrupt
2216 * use the second pair of bulk-in and bulk-out
2217 * endpoints for Data In/Out
2219 vub300
->large_usb_packets
= 0;
2220 iface_desc
= interface
->cur_altsetting
;
2221 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
2222 struct usb_endpoint_descriptor
*endpoint
=
2223 &iface_desc
->endpoint
[i
].desc
;
2224 dev_info(&vub300
->udev
->dev
,
2225 "vub300 testing %s EndPoint(%d) %02X\n",
2226 usb_endpoint_is_bulk_in(endpoint
) ? "BULK IN" :
2227 usb_endpoint_is_bulk_out(endpoint
) ? "BULK OUT" :
2228 "UNKNOWN", i
, endpoint
->bEndpointAddress
);
2229 if (endpoint
->wMaxPacketSize
> 64)
2230 vub300
->large_usb_packets
= 1;
2231 if (usb_endpoint_is_bulk_in(endpoint
)) {
2232 if (!vub300
->cmnd_res_ep
) {
2233 vub300
->cmnd_res_ep
=
2234 endpoint
->bEndpointAddress
;
2235 } else if (!vub300
->data_inp_ep
) {
2236 vub300
->data_inp_ep
=
2237 endpoint
->bEndpointAddress
;
2239 dev_warn(&vub300
->udev
->dev
,
2241 " unexpected bulk_in endpoint");
2243 } else if (usb_endpoint_is_bulk_out(endpoint
)) {
2244 if (!vub300
->cmnd_out_ep
) {
2245 vub300
->cmnd_out_ep
=
2246 endpoint
->bEndpointAddress
;
2247 } else if (!vub300
->data_out_ep
) {
2248 vub300
->data_out_ep
=
2249 endpoint
->bEndpointAddress
;
2251 dev_warn(&vub300
->udev
->dev
,
2253 " unexpected bulk_out endpoint");
2256 dev_warn(&vub300
->udev
->dev
,
2257 "vub300 ignoring EndPoint(%d) %02X", i
,
2258 endpoint
->bEndpointAddress
);
2261 if (vub300
->cmnd_res_ep
&& vub300
->cmnd_out_ep
&&
2262 vub300
->data_inp_ep
&& vub300
->data_out_ep
) {
2263 dev_info(&vub300
->udev
->dev
,
2265 " using EndPoints %02X %02X %02X %02X\n",
2266 vub300
->large_usb_packets
? "LARGE" : "SMALL",
2267 vub300
->cmnd_out_ep
, vub300
->cmnd_res_ep
,
2268 vub300
->data_out_ep
, vub300
->data_inp_ep
);
2269 /* we have the expected EndPoints */
2271 dev_err(&vub300
->udev
->dev
,
2272 "Could not find two sets of bulk-in/out endpoint pairs\n");
2277 usb_control_msg(vub300
->udev
, usb_rcvctrlpipe(vub300
->udev
, 0),
2279 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
2280 0x0000, 0x0000, &vub300
->hc_info
,
2281 sizeof(vub300
->hc_info
), 1000);
2285 usb_control_msg(vub300
->udev
, usb_sndctrlpipe(vub300
->udev
, 0),
2286 SET_ROM_WAIT_STATES
,
2287 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
2288 firmware_rom_wait_states
, 0x0000, NULL
, 0, 1000);
2291 dev_info(&vub300
->udev
->dev
,
2292 "operating_mode = %s %s %d MHz %s %d byte USB packets\n",
2293 (mmc
->caps
& MMC_CAP_SDIO_IRQ
) ? "IRQs" : "POLL",
2294 (mmc
->caps
& MMC_CAP_4_BIT_DATA
) ? "4-bit" : "1-bit",
2295 mmc
->f_max
/ 1000000,
2296 pad_input_to_usb_pkt
? "padding input data to" : "with",
2297 vub300
->large_usb_packets
? 512 : 64);
2299 usb_control_msg(vub300
->udev
, usb_rcvctrlpipe(vub300
->udev
, 0),
2300 GET_SYSTEM_PORT_STATUS
,
2301 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
2302 0x0000, 0x0000, &vub300
->system_port_status
,
2303 sizeof(vub300
->system_port_status
), 1000);
2306 } else if (sizeof(vub300
->system_port_status
) == retval
) {
2307 vub300
->card_present
=
2308 (0x0001 & vub300
->system_port_status
.port_flags
) ? 1 : 0;
2310 (0x0010 & vub300
->system_port_status
.port_flags
) ? 1 : 0;
2315 usb_set_intfdata(interface
, vub300
);
2316 INIT_DELAYED_WORK(&vub300
->pollwork
, vub300_pollwork_thread
);
2317 INIT_WORK(&vub300
->cmndwork
, vub300_cmndwork_thread
);
2318 INIT_WORK(&vub300
->deadwork
, vub300_deadwork_thread
);
2319 kref_init(&vub300
->kref
);
2320 timer_setup(&vub300
->sg_transfer_timer
, vub300_sg_timed_out
, 0);
2321 kref_get(&vub300
->kref
);
2322 timer_setup(&vub300
->inactivity_timer
,
2323 vub300_inactivity_timer_expired
, 0);
2324 vub300
->inactivity_timer
.expires
= jiffies
+ HZ
;
2325 add_timer(&vub300
->inactivity_timer
);
2326 if (vub300
->card_present
)
2327 dev_info(&vub300
->udev
->dev
,
2328 "USB vub300 remote SDIO host controller[%d]"
2329 "connected with SD/SDIO card inserted\n",
2330 interface_to_InterfaceNumber(interface
));
2332 dev_info(&vub300
->udev
->dev
,
2333 "USB vub300 remote SDIO host controller[%d]"
2334 "connected with no SD/SDIO card inserted\n",
2335 interface_to_InterfaceNumber(interface
));
2336 retval
= mmc_add_host(mmc
);
2342 del_timer_sync(&vub300
->inactivity_timer
);
2346 * and hence also frees vub300
2347 * which is contained at the end of struct mmc
2350 usb_free_urb(command_res_urb
);
2352 usb_free_urb(command_out_urb
);
2358 static void vub300_disconnect(struct usb_interface
*interface
)
2360 struct vub300_mmc_host
*vub300
= usb_get_intfdata(interface
);
2361 if (!vub300
|| !vub300
->mmc
) {
2364 struct mmc_host
*mmc
= vub300
->mmc
;
2368 int ifnum
= interface_to_InterfaceNumber(interface
);
2369 usb_set_intfdata(interface
, NULL
);
2370 /* prevent more I/O from starting */
2371 vub300
->interface
= NULL
;
2372 kref_put(&vub300
->kref
, vub300_delete
);
2373 mmc_remove_host(mmc
);
2374 pr_info("USB vub300 remote SDIO host controller[%d]"
2375 " now disconnected", ifnum
);
2382 static int vub300_suspend(struct usb_interface
*intf
, pm_message_t message
)
2387 static int vub300_resume(struct usb_interface
*intf
)
2392 #define vub300_suspend NULL
2393 #define vub300_resume NULL
2395 static int vub300_pre_reset(struct usb_interface
*intf
)
2397 struct vub300_mmc_host
*vub300
= usb_get_intfdata(intf
);
2398 mutex_lock(&vub300
->cmd_mutex
);
2402 static int vub300_post_reset(struct usb_interface
*intf
)
2404 struct vub300_mmc_host
*vub300
= usb_get_intfdata(intf
);
2405 /* we are sure no URBs are active - no locking needed */
2406 vub300
->errors
= -EPIPE
;
2407 mutex_unlock(&vub300
->cmd_mutex
);
2411 static struct usb_driver vub300_driver
= {
2413 .probe
= vub300_probe
,
2414 .disconnect
= vub300_disconnect
,
2415 .suspend
= vub300_suspend
,
2416 .resume
= vub300_resume
,
2417 .pre_reset
= vub300_pre_reset
,
2418 .post_reset
= vub300_post_reset
,
2419 .id_table
= vub300_table
,
2420 .supports_autosuspend
= 1,
2423 static int __init
vub300_init(void)
2427 pr_info("VUB300 Driver rom wait states = %02X irqpoll timeout = %04X",
2428 firmware_rom_wait_states
, 0x0FFFF & firmware_irqpoll_timeout
);
2429 cmndworkqueue
= create_singlethread_workqueue("kvub300c");
2430 if (!cmndworkqueue
) {
2431 pr_err("not enough memory for the REQUEST workqueue");
2435 pollworkqueue
= create_singlethread_workqueue("kvub300p");
2436 if (!pollworkqueue
) {
2437 pr_err("not enough memory for the IRQPOLL workqueue");
2441 deadworkqueue
= create_singlethread_workqueue("kvub300d");
2442 if (!deadworkqueue
) {
2443 pr_err("not enough memory for the EXPIRED workqueue");
2447 result
= usb_register(&vub300_driver
);
2449 pr_err("usb_register failed. Error number %d", result
);
2454 destroy_workqueue(deadworkqueue
);
2456 destroy_workqueue(pollworkqueue
);
2458 destroy_workqueue(cmndworkqueue
);
2463 static void __exit
vub300_exit(void)
2465 usb_deregister(&vub300_driver
);
2466 flush_workqueue(cmndworkqueue
);
2467 flush_workqueue(pollworkqueue
);
2468 flush_workqueue(deadworkqueue
);
2469 destroy_workqueue(cmndworkqueue
);
2470 destroy_workqueue(pollworkqueue
);
2471 destroy_workqueue(deadworkqueue
);
2474 module_init(vub300_init
);
2475 module_exit(vub300_exit
);
2477 MODULE_AUTHOR("Tony Olech <tony.olech@elandigitalsystems.com>");
2478 MODULE_DESCRIPTION("VUB300 USB to SD/MMC/SDIO adapter driver");
2479 MODULE_LICENSE("GPL");